<!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>[184044] 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/184044">184044</a></dd>
<dt>Author</dt> <dd>rniwa@webkit.org</dd>
<dt>Date</dt> <dd>2015-05-09 23:46:33 -0700 (Sat, 09 May 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make arguments of run-benchmark more user friendly
https://bugs.webkit.org/show_bug.cgi?id=144835
Reviewed by Darin Adler.
Made --build-directory optional since I don't expect a typical WebKit developer to have a local build
of Chrome and Firefox. Also made --plan accept just a filename so that we can just say "speedometer"
instead of "Tools/Scripts/webkitpy/benchmark_runner/data/plans/speedometer.plan". Finally, removed
default values from --platform and --browser as they are required arguments.
* Scripts/run-benchmark:
(main): Made --build-directory optional, and removed default values from --platform and --browser.
Also added help text for --build-directory and --plan. In addition, the list of platforms and browsers
are not dynamically obtained via BrowserDriverFactory.
* Scripts/webkitpy/benchmark_runner/benchmark_runner.py:
(BenchmarkRunner.__init__): Raise when we can't find the plan file or the plan file is not a valid JSON
file instead of suppressing the error here and blowing up later mysteriously since we won't be able to
run any benchmark in that case.
(BenchmarkRunner._findPlanFile): Added. Look for the plan in webkitpy/benchmark_runner/data/plans if
the specified file isn't a valid relative or an absolute path.
* Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py:
(BrowserDriverFactory.available_platforms): Added. Used in main to provide the list of valid platforms
and browsers.
(BrowserDriverFactory.available_browsers): Ditto.
* Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py:
(OSXChromeDriver.launchUrl): browserBuildPath is never optional since BenchmarkRunner.execute always
calls launchUrl with this argument so removed the default value. Also added a fallback path for when
browserBuildPath was None.
* Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py:
(OSXSafariDriver.launchUrl): Ditto. We also fallback when the build directory doesn't contain Safari
so that we can use locally built WebKit to launch Safari.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptsrunbenchmark">trunk/Tools/Scripts/run-benchmark</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbenchmark_runnerpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverbrowser_driver_factorypy">trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_chrome_driverpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_safari_driverpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/ChangeLog 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -1,3 +1,37 @@
</span><ins>+2015-05-09 Ryosuke Niwa <rniwa@webkit.org>
+
+ Make arguments of run-benchmark more user friendly
+ https://bugs.webkit.org/show_bug.cgi?id=144835
+
+ Reviewed by Darin Adler.
+
+ Made --build-directory optional since I don't expect a typical WebKit developer to have a local build
+ of Chrome and Firefox. Also made --plan accept just a filename so that we can just say "speedometer"
+ instead of "Tools/Scripts/webkitpy/benchmark_runner/data/plans/speedometer.plan". Finally, removed
+ default values from --platform and --browser as they are required arguments.
+
+ * Scripts/run-benchmark:
+ (main): Made --build-directory optional, and removed default values from --platform and --browser.
+ Also added help text for --build-directory and --plan. In addition, the list of platforms and browsers
+ are not dynamically obtained via BrowserDriverFactory.
+ * Scripts/webkitpy/benchmark_runner/benchmark_runner.py:
+ (BenchmarkRunner.__init__): Raise when we can't find the plan file or the plan file is not a valid JSON
+ file instead of suppressing the error here and blowing up later mysteriously since we won't be able to
+ run any benchmark in that case.
+ (BenchmarkRunner._findPlanFile): Added. Look for the plan in webkitpy/benchmark_runner/data/plans if
+ the specified file isn't a valid relative or an absolute path.
+ * Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py:
+ (BrowserDriverFactory.available_platforms): Added. Used in main to provide the list of valid platforms
+ and browsers.
+ (BrowserDriverFactory.available_browsers): Ditto.
+ * Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py:
+ (OSXChromeDriver.launchUrl): browserBuildPath is never optional since BenchmarkRunner.execute always
+ calls launchUrl with this argument so removed the default value. Also added a fallback path for when
+ browserBuildPath was None.
+ * Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py:
+ (OSXSafariDriver.launchUrl): Ditto. We also fallback when the build directory doesn't contain Safari
+ so that we can use locally built WebKit to launch Safari.
+
</ins><span class="cx"> 2015-05-09 Yoav Weiss <yoav@yoav.ws>
</span><span class="cx">
</span><span class="cx"> Remove the PICTURE_SIZES build flag
</span></span></pre></div>
<a id="trunkToolsScriptsrunbenchmark"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/run-benchmark (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/run-benchmark 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/Scripts/run-benchmark 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -2,9 +2,11 @@
</span><span class="cx">
</span><span class="cx"> import argparse
</span><span class="cx"> import logging
</span><ins>+import platform
</ins><span class="cx"> import sys
</span><span class="cx">
</span><span class="cx"> from webkitpy.benchmark_runner.benchmark_runner import BenchmarkRunner
</span><ins>+from webkitpy.benchmark_runner.browser_driver.browser_driver_factory import BrowserDriverFactory
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx"> _log = logging.getLogger()
</span><span class="lines">@@ -18,14 +20,14 @@
</span><span class="cx"> def main():
</span><span class="cx"> parser = argparse.ArgumentParser(description='Automate the browser based performance benchmarks')
</span><span class="cx"> parser.add_argument('--output-file', dest='output', default=None)
</span><del>- parser.add_argument('--build-directory', dest='buildDir', required=True)
- parser.add_argument('--plan', dest='plan', required=True)
- parser.add_argument('--platform', dest='platform', default='osx', choices=['osx', 'ios', 'windows'], required=True)
</del><ins>+ parser.add_argument('--build-directory', dest='buildDir', help='Path to the browser executable. e.g. WebKitBuild/Release/')
+ parser.add_argument('--plan', dest='plan', required=True, help='Benchmark plan to run. e.g. speedometer, jetstream')
+ parser.add_argument('--platform', dest='platform', required=True, choices=BrowserDriverFactory.available_platforms())
</ins><span class="cx"> # FIXME: Should we add chrome as an option? Well, chrome uses webkit in iOS.
</span><del>- parser.add_argument('--browser', dest='browser', default='safari', choices=['safari', 'chrome'], required=True)
</del><ins>+ parser.add_argument('--browser', dest='browser', required=True, choices=BrowserDriverFactory.available_browsers())
</ins><span class="cx"> parser.add_argument('--debug', action='store_true')
</span><span class="cx"> args = parser.parse_args()
</span><del>-
</del><ins>+
</ins><span class="cx"> if args.debug:
</span><span class="cx"> _log.setLevel(logging.DEBUG)
</span><span class="cx"> _log.debug('Initializing program with following parameters')
</span><span class="lines">@@ -35,5 +37,6 @@
</span><span class="cx"> runner = BenchmarkRunner(args.plan, args.buildDir, args.output, args.platform, args.browser)
</span><span class="cx"> return runner.execute()
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> if __name__ == '__main__':
</span><span class="cx"> sys.exit(main())
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbenchmark_runnerpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -26,19 +26,31 @@
</span><span class="cx"> def __init__(self, planFile, buildDir, outputFile, platform, browser):
</span><span class="cx"> _log.info('Initializing benchmark running')
</span><span class="cx"> try:
</span><ins>+ planFile = self._findPlanFile(planFile)
</ins><span class="cx"> with open(planFile, 'r') as fp:
</span><span class="cx"> self.plan = json.load(fp)
</span><span class="cx"> self.browserDriver = BrowserDriverFactory.create([platform, browser])
</span><span class="cx"> self.httpServerDriver = HTTPServerDriverFactory.create([self.plan['http_server_driver']])
</span><del>- self.buildDir = os.path.abspath(buildDir)
</del><ins>+ self.buildDir = os.path.abspath(buildDir) if buildDir else None
</ins><span class="cx"> self.outputFile = outputFile
</span><span class="cx"> except IOError:
</span><span class="cx"> _log.error('Can not open plan file: %s' % planFile)
</span><ins>+ raise
</ins><span class="cx"> except ValueError:
</span><span class="cx"> _log.error('Plan file:%s may not follow JSON format' % planFile)
</span><del>- except:
</del><span class="cx"> raise
</span><span class="cx">
</span><ins>+ def _findPlanFile(self, planFile):
+ if not os.path.exists(planFile):
+ absPath = os.path.join(os.path.dirname(__file__), 'data/plans', planFile)
+ if os.path.exists(absPath):
+ return absPath
+ if not absPath.endswith('.plan'):
+ absPath += '.plan'
+ if os.path.exists(absPath):
+ return absPath
+ return planFile
+
</ins><span class="cx"> def execute(self):
</span><span class="cx"> _log.info('Start to execute the plan')
</span><span class="cx"> _log.info('Start a new benchmark')
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverbrowser_driver_factorypy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver_factory.py 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -14,3 +14,15 @@
</span><span class="cx"> class BrowserDriverFactory(GenericFactory):
</span><span class="cx">
</span><span class="cx"> products = loadJSONFromFile(os.path.join(os.path.dirname(__file__), driverFileName))
</span><ins>+
+ @classmethod
+ def available_platforms(cls):
+ return cls.products.keys()
+
+ @classmethod
+ def available_browsers(cls):
+ browsers = []
+ for platform in cls.products.values():
+ for browser in platform:
+ browsers.append(browser)
+ return browsers
</ins></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_chrome_driverpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_chrome_driver.py 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -19,7 +19,9 @@
</span><span class="cx"> self.closeBrowsers()
</span><span class="cx"> self.chromePreferences = []
</span><span class="cx">
</span><del>- def launchUrl(self, url, browserBuildPath=None):
</del><ins>+ def launchUrl(self, url, browserBuildPath):
+ if not browserBuildPath:
+ browserBuildPath = '/Applications/'
</ins><span class="cx"> _log.info('Launching chrome: %s with url: %s' % (os.path.join(browserBuildPath, 'Google Chrome.app'), url))
</span><span class="cx"> # FIXME: May need to be modified for develop build, such as setting up libraries
</span><span class="cx"> subprocess.Popen(['open', '-a', os.path.join(browserBuildPath, 'Google Chrome.app'), '--args', '--homepage', url] + self.chromePreferences).communicate()
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverosx_safari_driverpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py (184043 => 184044)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py 2015-05-10 03:58:20 UTC (rev 184043)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/osx_safari_driver.py 2015-05-10 06:46:33 UTC (rev 184044)
</span><span class="lines">@@ -23,11 +23,20 @@
</span><span class="cx"> forceRemove(os.path.join(os.path.expanduser('~'), 'Library/Safari/LastSession.plist'))
</span><span class="cx"> self.safariPreferences = ["-HomePage", "about:blank", "-WarnAboutFraudulentWebsites", "0", "-ExtensionsEnabled", "0", "-ShowStatusBar", "0", "-NewWindowBehavior", "1", "-NewTabBehavior", "1"]
</span><span class="cx">
</span><del>- def launchUrl(self, url, browserBuildPath=None):
- args = [os.path.join(browserBuildPath, 'Safari.app/Contents/MacOS/Safari')]
</del><ins>+ def launchUrl(self, url, browserBuildPath):
+ args = ['/Applications/Safari.app/Contents/MacOS/SafariForWebKitDevelopment']
+ env = {}
+ if browserBuildPath:
+ safariAppInBuildPath = os.path.join(browserBuildPath, 'Safari.app/Contents/MacOS/Safari')
+ if os.path.exists(safariAppInBuildPath):
+ args = [safariAppInBuildPath]
+ env = {'DYLD_FRAMEWORK_PATH': browserBuildPath, 'DYLD_LIBRARY_PATH': browserBuildPath}
+ else:
+ _log.info('Could not find Safari.app at %s, using the system SafariForWebKitDevelopment in /Applications instead' % safariAppInBuildPath)
+
</ins><span class="cx"> args.extend(self.safariPreferences)
</span><span class="cx"> _log.info('Launching safari: %s with url: %s' % (args[0], url))
</span><del>- self.safariProcess = subprocess.Popen(args, env={'DYLD_FRAMEWORK_PATH': browserBuildPath, 'DYLD_LIBRARY_PATH': browserBuildPath}, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
</del><ins>+ self.safariProcess = subprocess.Popen(args, env=env, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
</ins><span class="cx"> # Stop for initialization of the safari process, otherwise, open
</span><span class="cx"> # command may use the system safari.
</span><span class="cx"> time.sleep(3)
</span></span></pre>
</div>
</div>
</body>
</html>