[web_tests][resultdb] add summary_html in TestResultSink

Please find the context at https://crbug.com/1148921#c3.

R=robertma@chromium.org
CC=chanli@chromium.org,nodir@chromium.org

Change-Id: I2b037dd6c3fdc4d0e4adb322d5f3bc1fcee100ab
Bug: 1148921
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2553532
Commit-Queue: Scott Lee <ddoman@chromium.org>
Reviewed-by: Robert Ma <robertma@chromium.org>
Reviewed-by: Chan Li <chanli@chromium.org>
Cr-Commit-Position: refs/heads/master@{#830593}

third_party/blink/tools/blinkpy/web_tests/controllers/test_result_sink.py

@@ -127,11 +127,14 @@ class TestResultSink(object):
 
         Args:
             result: The TestResult object to look for the artifacts of.
+            summaries: A list of strings to be included in the summary html.
         Returns:
+            A list of artifact HTML tags to be added into the summary html
             A dict of artifacts, where the key is the artifact ID and
             the value is a dict with the absolute file path.
         """
         ret = {}
+        summaries = []
         base_dir = self._port.results_directory()
         for name, paths in result.artifacts.artifacts.iteritems():
             for p in paths:
@@ -144,8 +147,27 @@ class TestResultSink(object):
                 ret[art_id] = {
                     'filePath': self._port.host.filesystem.join(base_dir, p),
                 }
-
-        return ret
+                # Web tests generate the same artifact names for text-diff(s)
+                # and image diff(s).
+                # - {actual,expected}_text, {text,pretty_text}_diff
+                # - {actual,expected}_image, {image,pretty_image}_diff
+                # - reference_file_{mismatch,match}
+                #
+                # Milo recognizes the names and auto generates a summary html
+                # to render them with <text-diff-artifact> or
+                # <img-diff-artifact>.
+                #
+                # stderr and crash_log are the only artifact names that are
+                # not included in the auto-generated summary. This uses
+                # <text-artifact> to render them in the summary_html section
+                # of each test.
+                if name in ['stderr', 'crash_log']:
+                    summaries.append(
+                        '<h3>%s</h3>'
+                        '<p><text-artifact artifact-id="%s" /></p>' %
+                        (art_id, art_id))
+
+        return summaries, ret
 
     def sink(self, expected, result):
         """Reports the test result to ResultSink.
@@ -166,9 +188,10 @@ class TestResultSink(object):
 
         # The structure and member definitions of this dict can be found at
         # https://chromium.googlesource.com/infra/luci/luci-go/+/refs/heads/master/resultdb/proto/sink/v1/test_result.proto
-        locFileName = '//%s%s' % (RELATIVE_WEB_TESTS, result.test_name)
+        loc_file_name = '//%s%s' % (RELATIVE_WEB_TESTS, result.test_name)
+        summaries, artifacts = self._artifacts(result)
         r = {
-            'artifacts': self._artifacts(result),
+            'artifacts': artifacts,
             'duration': '%ss' % result.total_run_time,
             # device failures are never expected.
             'expected': not result.device_failed and expected,
@@ -186,11 +209,14 @@ class TestResultSink(object):
                 # and disabled-test dashboards.
                 'location': {
                     'repo': 'https://chromium.googlesource.com/chromium/src',
-                    'fileName': locFileName,
+                    'fileName': loc_file_name,
                     # skip: 'line'
                 },
             },
         }
+        if summaries:
+            r['summaryHtml'] = '\n'.join(summaries)
+
         self._send({'testResults': [r]})
 
     def close(self):

third_party/blink/tools/blinkpy/web_tests/controllers/test_result_sink_unittest.py

@@ -5,6 +5,7 @@
 import contextlib
 import json
 import mock
+import re
 import requests
 import sys
 import unittest
@@ -172,3 +173,15 @@ class TestResultSinkMessage(TestResultSinkTestBase):
                     'filePath': '/tmp/bar'
                 }
             })
+
+    def test_summary_html(self):
+        tr = test_results.TestResult(test_name='test-name')
+        tr.artifacts.AddArtifact('stderr', '/tmp/foo', False)
+        tr.artifacts.AddArtifact('crash_log', '/tmp/bar', False)
+
+        sent_data = self.sink(True, tr)
+        p = re.compile('<text-artifact artifact-id="(stderr|crash_log)" />')
+        self.assertSetEqual(
+            set(p.findall(sent_data['summaryHtml'])),
+            set(['stderr', 'crash_log']),
+        )