<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[286374] trunk/Tools</title>
</head>
<body>

<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt;  }
#msg dl a { font-weight: bold}
#msg dl a:link    { color:#fc3; }
#msg dl a:active  { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff  {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/286374">286374</a></dd>
<dt>Author</dt> <dd>wdx@apple.com</dd>
<dt>Date</dt> <dd>2021-12-01 11:23:32 -0800 (Wed, 01 Dec 2021)</dd>
</dl>

<h3>Log Message</h3>
<pre>[macOS] run-benchmark should take diagnostic screenshots upon test timeout
https://bugs.webkit.org/show_bug.cgi?id=232736

Reviewed by Dewei Zhu.

Added defaults for the --diagnose-directory flag depending on platform.
Added diagnose_test_failure method to OSXBrowserDriver to take screenshots and save to diagnostic directory.

* Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py:
(OSXBrowserDriver._save_screenshot_to_path):
(OSXBrowserDriver):
(OSXBrowserDriver.diagnose_test_failure):</pre>

<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_browser_driverpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerrun_benchmarkpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/run_benchmark.py</a></li>
</ul>

</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (286373 => 286374)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog    2021-12-01 19:14:23 UTC (rev 286373)
+++ trunk/Tools/ChangeLog       2021-12-01 19:23:32 UTC (rev 286374)
</span><span class="lines">@@ -1,3 +1,18 @@
</span><ins>+2021-12-01  W.D. Xiong  <wdx@apple.com>
+
+        [macOS] run-benchmark should take diagnostic screenshots upon test timeout
+        https://bugs.webkit.org/show_bug.cgi?id=232736
+
+        Reviewed by Dewei Zhu.
+
+        Added defaults for the --diagnose-directory flag depending on platform.
+        Added diagnose_test_failure method to OSXBrowserDriver to take screenshots and save to diagnostic directory.
+
+        * Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py:
+        (OSXBrowserDriver._save_screenshot_to_path):
+        (OSXBrowserDriver):
+        (OSXBrowserDriver.diagnose_test_failure):
+
</ins><span class="cx"> 2021-12-01  Jonathan Bedard  <jbedard@apple.com>
</span><span class="cx"> 
</span><span class="cx">         [webkitscmpy] Do not query remotes when determining branches containing commit
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_browser_driverpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py (286373 => 286374)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py       2021-12-01 19:14:23 UTC (rev 286373)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_browser_driver.py  2021-12-01 19:23:32 UTC (rev 286374)
</span><span class="lines">@@ -1,6 +1,7 @@
</span><span class="cx"> 
</span><span class="cx"> import logging
</span><span class="cx"> import os
</span><ins>+import shutil
</ins><span class="cx"> import subprocess
</span><span class="cx"> import time
</span><span class="cx"> 
</span><span class="lines">@@ -38,6 +39,36 @@
</span><span class="cx">     def close_browsers(self):
</span><span class="cx">         self._terminate_processes(self.process_name, self.bundle_id)
</span><span class="cx"> 
</span><ins>+    def _save_screenshot_to_path(self, output_directory, filename):
+        jpg_image_path = os.path.join(output_directory, filename)
+        try:
+            subprocess.call(['screencapture', jpg_image_path])
+            _log.info('Saved screenshot to "{}"'.format(jpg_image_path))
+        except subprocess.CalledProcessError as error:
+            _log.error('Failed to save screenshot - Error: {error}'.format(error=error))
+
+    def diagnose_test_failure(self, diagnose_directory, error):
+        _log.info('Diagnosing benchmark failure: "{}"'.format(error))
+
+        if not diagnose_directory:
+            _log.info('Diagnose directory is not specified, will skip diagnosing.')
+            return
+
+        if os.path.exists(diagnose_directory):
+            _log.info('Diagnose directory: "{}" already exists, cleaning it up'.format(diagnose_directory))
+            try:
+                if os.path.isdir(diagnose_directory):
+                    if len(os.listdir(diagnose_directory)):
+                        shutil.rmtree(diagnose_directory)
+                elif os.path.isfile(diagnose_directory):
+                    os.remove(diagnose_directory)
+            except Exception as error:
+                _log.error('Could not remove diagnose directory {} - error: {}'.format(diagnose_directory, error))
+        if not os.path.exists(diagnose_directory):
+            os.makedirs(diagnose_directory)
+
+        self._save_screenshot_to_path(diagnose_directory, 'test-failure-screenshot-{}.jpg'.format(int(time.time())))
+
</ins><span class="cx">     @classmethod
</span><span class="cx">     def _launch_process(cls, build_dir, app_name, url, args):
</span><span class="cx">         if not build_dir:
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerrun_benchmarkpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/run_benchmark.py (286373 => 286374)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/run_benchmark.py   2021-12-01 19:14:23 UTC (rev 286373)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/run_benchmark.py      2021-12-01 19:23:32 UTC (rev 286374)
</span><span class="lines">@@ -5,6 +5,7 @@
</span><span class="cx"> import logging
</span><span class="cx"> import os
</span><span class="cx"> import sys
</span><ins>+import time
</ins><span class="cx"> 
</span><span class="cx"> from webkitpy.benchmark_runner.browser_driver.browser_driver_factory import BrowserDriverFactory
</span><span class="cx"> from webkitpy.benchmark_runner.benchmark_runner import BenchmarkRunner
</span><span class="lines">@@ -31,6 +32,10 @@
</span><span class="cx">     return 'safari'
</span><span class="cx"> 
</span><span class="cx"> 
</span><ins>+def default_diagnose_dir():
+    return '/tmp/run-benchmark-diagnostics-{}/'.format(int(time.time()))
+
+
</ins><span class="cx"> def config_argument_parser():
</span><span class="cx">     parser = argparse.ArgumentParser(description='Run browser based performance benchmarks. To run a single benchmark in the recommended way, use run-benchmark --plan. To see the vailable benchmarks, use run-benchmark --list-plans. This script passes through the __XPC variables in its environment to the Safari process.')
</span><span class="cx">     mutual_group = parser.add_mutually_exclusive_group(required=True)
</span><span class="lines">@@ -46,7 +51,7 @@
</span><span class="cx">     parser.add_argument('--local-copy', help='Path to a local copy of the benchmark (e.g. PerformanceTests/SunSpider/).')
</span><span class="cx">     parser.add_argument('--device-id', default=None, help='Undocumented option for mobile device testing.')
</span><span class="cx">     parser.add_argument('--debug', action='store_true', help='Enable debug logging.')
</span><del>-    parser.add_argument('--diagnose-directory', dest='diagnose_dir', default=None, help='Directory for storing diagnose information on test failure. It\'s up to browser driver implementation when this option is not specified.')
</del><ins>+    parser.add_argument('--diagnose-directory', dest='diagnose_dir', default=default_diagnose_dir(), help='Directory for storing diagnose information on test failure. Defaults to {}.'.format(default_diagnose_dir()))
</ins><span class="cx">     parser.add_argument('--no-adjust-unit', dest='scale_unit', action='store_false', help="Don't convert to scientific notation.")
</span><span class="cx">     parser.add_argument('--show-iteration-values', dest='show_iteration_values', action='store_true', help="Show the measured value for each iteration in addition to averages.")
</span><span class="cx"> 
</span></span></pre>
</div>
</div>

</body>
</html>