Skip to content

Commit

Permalink
[WPT Import Notifier] Tweak documentation to be clearer
Browse files Browse the repository at this point in the history
This adds a paragraph explaining what action we have actually taken
(adding the tests to expectations/adding a baseline file), and what
action the bug recipient should undertake (investigate/triage).

Bug: 1140476#c7
Change-Id: I20d2c1bb50ab6bf46c6430416599e24fee4b8a94
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2495011
Commit-Queue: Stephen McGruer <smcgruer@chromium.org>
Reviewed-by: Nicolás Peña Moreno <npm@chromium.org>
Reviewed-by: Robert Ma <robertma@chromium.org>
Cr-Commit-Position: refs/heads/master@{#820382}
  • Loading branch information
stephenmcgruer authored and Commit Bot committed Oct 23, 2020
1 parent 853074c commit 540c555
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions third_party/blink/tools/blinkpy/w3c/import_notifier.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Copyright 2017 The Chromium Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Sends notifications after automatic imports (WIP).
"""Sends notifications after automatic imports from web-platform-tests (WPT).
Automatically file bugs for new failures caused by WPT imports for opted-in
directories.
Design doc: https://docs.google.com/document/d/1W3V81l94slAC_rPcTKWXgv3YxRxtlSIAxi3yj6NsbBw/edit?usp=sharing
During the implementation phase, we do not open bugs but log everything instead.
"""

from collections import defaultdict
Expand Down Expand Up @@ -216,12 +214,20 @@ def create_bugs_from_new_failures(self, wpt_revision_start,
for failure in failures:
failure_list += str(failure) + '\n'

epilogue = '\nThis import contains upstream changes from {} to {}:\n'.format(
expectations_statement = (
'\nExpectations or baseline files [0] have been automatically '
'added for the failing results to keep the bots green. Please '
'investigate the new failures and triage as appropriate.\n')

range_statement = '\nThis import contains upstream changes from {} to {}:\n'.format(
wpt_revision_start, wpt_revision_end)
commit_list = self.format_commit_list(imported_commits,
full_directory)

description = prologue + failure_list + epilogue + commit_list
links_list = '\n[0]: https://chromium.googlesource.com/chromium/src/+/HEAD/docs/testing/web_test_expectations.md\n'

description = (prologue + failure_list + expectations_statement +
range_statement + commit_list + links_list)

bug = MonorailIssue.new_chromium_issue(summary,
description,
Expand Down

0 comments on commit 540c555

Please sign in to comment.