1129495 - [mozlog] - Add optional path attribute to test_start

Status: RESOLVED FIXED

(Testing :: Mozbase, defect)

Description

[James Graham [:jgraham]]

This attribute is to hold the path of the file containing the test when it is known and different from the URL. The base of this path is undefined (it will typically be the root of the source tree).

Comment 1

[Andrew Halberstadt [:ahal]]

I was looking into this and seems like there's nothing to do other than update the documentation since afaict consumers can already add arbitrary keys to the log data. James is that correct?

Comment 2

[James Graham [:jgraham]]

I think a patch would look something like (totally untested, written in the last 2 minutes):

diff --git a/testing/mozbase/mozlog/mozlog/structured/structuredlog.py b/testing/mozbase/mozlog/mozlog/structured/structuredlog.py
index 4fadc9b..fe7ea2e 100644
--- a/testing/mozbase/mozlog/mozlog/structured/structuredlog.py
+++ b/testing/mozbase/mozlog/mozlog/structured/structuredlog.py
@@ -249,10 +249,12 @@ class StructuredLogger(object):
         self._log_data("suite_end")
 
     @log_action(TestId("test"))
+    @log_action(Unicode("path", default=None, optional=True))
     def test_start(self, data):
         """Log a test_start message
 
         :param test: Identifier of the test that will run.
+        :param path Path to the test relative to some base (typically the root of the source tree)
         """
         if not self._state.suite_started:
             self.error("Got test_start message before suite_start for test %s" %

Comment 3

[Andrew Halberstadt [:ahal]]

Thanks, I missed that. I'll test it out, update the docs and flag you for review.

Comment 4

[Andrew Halberstadt [:ahal]]

Attachment: MozReview Request: bz://1129495/ahal

/r/3679 - Bug 1129495 - [mozlog] Add optional 'path' attribute to test_start, r=jgraham

Pull down this commit:

hg pull review -r 4578472c6be3108787c90277c9fb1950ee66b311

Comment 5

[Andrew Halberstadt [:ahal]]

Comment on attachment 8562348 [details]
MozReview Request: bz://1129495/ahal

/r/3679 - Bug 1129495 - [mozlog] Add optional 'path' attribute to test_start, r=jgraham

Pull down this commit:

hg pull review -r 0c1ea4412649a5e2990b5ffad739fda22fa2c48f

Comment 6

[James Graham [:jgraham]]

Comment on attachment 8562348 [details]
MozReview Request: bz://1129495/ahal

https://reviewboard.mozilla.org/r/3677/#review2909

::: testing/mozbase/mozlog/mozlog/structured/structuredlog.py
(Diff revision 1)
>          :param test: Identifier of the test that will run.

Should probably be documented again here.

Comment 7

[Andrew Halberstadt [:ahal]]

https://reviewboard.mozilla.org/r/3677/#review2911

> Should probably be documented again here.

I did, make sure you have the full diff selected because I forgot to do this in my original push, but did a quick follow up immediately after.

Comment 8

[James Graham [:jgraham]]

Comment on attachment 8562348 [details]
MozReview Request: bz://1129495/ahal

https://reviewboard.mozilla.org/r/3677/#review2913

Ship It!

Comment 9

[Andrew Halberstadt [:ahal]]

Little try run:
https://treeherder.mozilla.org/#/jobs?repo=try&revision=57ef79ca8f38

Landed:
https://hg.mozilla.org/integration/mozilla-inbound/rev/bdc679c02e3b

Comment 10

[Ryan VanderMeulen [:RyanVM]]

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

Comment 12

[Andrew Halberstadt [:ahal]]

Attachment: MozReview Request: Bug 1129495 - [mozlog] Add optional 'path' attribute to test_start, r=jgraham