1059609 - Mozlog should expose the set of supported log actions

Status: RESOLVED FIXED

(Testing :: Mozbase, defect)

Description

[Chris Manchester (limited bugmail, email directly)]

This came up in mochitests and corredor and is probably generally useful for validation. logtypes.py has each log action run through it at import, so we could do this without manually maintaining the list.

Comment 1

[Chris Manchester (limited bugmail, email directly)]

Attachment: Provide enumeration of known log actions in mozlog.structured.

Comment 2

[James Graham [:jgraham]]

Comment on attachment 8482859 [details] [diff] [review]
Provide enumeration of known log actions in mozlog.structured.

Review of attachment 8482859 [details] [diff] [review]:
-----------------------------------------------------------------

I agree we should do this, but I think this isn't quite the right way to do it.

::: testing/mozbase/mozlog/mozlog/structured/logtypes.py
@@ +44,1 @@
>          convertor_registry[f.__name__] = self

Umm, isn't this just convertor_registry.keys()? Seems better to use that directly either via a helper like

def log_actions():
    return set(convertor_registry.keys())

or by setting log_actions = convertor_registry.keys()

I'm also not sure why this would be in logtypes.py which is basically an internal API rather than in structuredlog.py which is the external-facing code.

::: testing/mozbase/mozlog/tests/test_structured.py
@@ +638,5 @@
>          self.assertEquals(handler.action_1_count, 1)
>  
> +class TestActionEnumeration(unittest.TestCase):
> +
> +    def test_enumeration(self):

Is this test actually adding much value? I think it's just another thing to update when you add a new log action that you will probably forget. It's also much longer than the implementation, which is generally a bad sign.

Comment 3

[Chris Manchester (limited bugmail, email directly)]

Attachment: Provide enumeration of known log actions in mozlog.structured.

Comment 4

[Chris Manchester (limited bugmail, email directly)]

This is NPOTB

Comment 5

[Carsten Book [:Tomcat]]

Hi Chris,

the patch does not apply cleanly 

applying enumerate_actions.patch
patching file testing/mozbase/mozlog/mozlog/structured/structuredlog.py
Hunk #1 FAILED at 82
1 out of 1 hunks FAILED -- saving rejects to file testing/mozbase/mozlog/mozlog/structured/structuredlog.py.rej
patch failed, unable to continue (try -v)

could you take a look and maybe rebase? Thanks!

Comment 6

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/f7f7e8683a87

Comment 7

[Chris Manchester (limited bugmail, email directly)]

Looks like this was landed, thanks!

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/f7f7e8683a87