Bug 207026 – [ews] add build step to set custom build summary

• Status: RESOLVED
• Resolution: FIXED
• Component: Tools / Tests

[Aakash Jain]

[ews] add build step to set custom build summary based on a property which any previous step can set. 

Currently in order to set custom build summary we are using self.build.buildFinished(build_summary, result) method, but this method also finishes the build immediately whenever it's called. So if a step uses buildFinished(), no further build step can be run.

For example: Layout-test set custom build summary (e.g.: 'Passed layout tests', 'Found 1 pre-existing test failure: xyz'). In case commit-queue (or any factory) run layout-test step, layout-test will call self.build.buildFinished() and commit-queue (or that factory) would not be able to execute any subsequent build-step.

The fix is to avoid calling buildFinished() inside the regular build-steps, instead set a property in those build-steps, and at the end run a specific build-step (e.g.: SetBuildSummary) which would set the build summary based on that property.

[Aakash Jain]

Created attachment 389325 [details]
Patch

[Aakash Jain]

Sample runs:
https://ews-build.webkit-uat.org/#/builders/8/builds/102
https://ews-build.webkit-uat.org/#/builders/8/builds/103

[Jonathan Bedard]

Comment on attachment 389325 [details]
Patch

View in context: https://bugs.webkit.org/attachment.cgi?id=389325&action=review

> Tools/BuildSlaveSupport/ews-build/steps.py:2021
> +        self.build.buildFinished([build_summary], self.build.results)

What is self.build.results?

[Aakash Jain]

(In reply to Jonathan Bedard from comment #3)
> What is self.build.results?
results is a variable inside Build class https://github.com/buildbot/buildbot/blob/master/master/buildbot/process/build.py#L77

It stores the current result based on the steps which have executed. 

This I am trying SetBuildSummary to set the same overall build status which Buildbot would have set otherwise, based on the status of previously executed steps.

[Jonathan Bedard]

(In reply to Aakash Jain from comment #4)
> (In reply to Jonathan Bedard from comment #3)
> > What is self.build.results?
> results is a variable inside Build class
> https://github.com/buildbot/buildbot/blob/master/master/buildbot/process/
> build.py#L77
> 
> It stores the current result based on the steps which have executed. 
> 
> This I am trying SetBuildSummary to set the same overall build status which
> Buildbot would have set otherwise, based on the status of previously
> executed steps.

Can we contrive an example where Python 2 fails, but python 3 does not? I think this is right, but that's the only case we haven't tested.

[Aakash Jain]

(In reply to Jonathan Bedard from comment #5)
> Can we contrive an example where Python 2 fails, but python 3 does not? I think this is right, but that's the only case we haven't tested.
Will provide that in https://bugs.webkit.org/show_bug.cgi?id=207027

[Aakash Jain]

Comment on attachment 389325 [details]
Patch

Clearing flags on attachment: 389325

Committed r255506: <https://trac.webkit.org/changeset/255506>

[Aakash Jain]

All reviewed patches have been landed.  Closing bug.

[Radar WebKit Bug Importer]

<rdar://problem/59065405>