<!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>[188237] 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/188237">188237</a></dd>
<dt>Author</dt> <dd>commit-queue@webkit.org</dd>
<dt>Date</dt> <dd>2015-08-10 16:44:10 -0700 (Mon, 10 Aug 2015)</dd>
</dl>
<h3>Log Message</h3>
<pre>Make cleanup more robust and minor code cleaning in run benchmark script.
https://bugs.webkit.org/show_bug.cgi?id=147800
Patch by Dewei Zhu <dewei_zhu@apple.com> on 2015-08-10
Reviewed by Ryosuke Niwa.
Use 'finnaly' block to make sure cleanup code is always executed.
* Scripts/webkitpy/benchmark_runner/benchmark_runner.py:
(built_benchmark):
(built_benchmark.__init__):
(built_benchmark.__enter__):
(built_benchmark.__exit__):
(test_environment):
(test_environment.__init__):
(test_environment.__enter__):
(test_environment.__exit__):
(BenchmarkRunner.__init__):
(BenchmarkRunner.execute):
(BenchmarkRunner._dump):
(BenchmarkRunner._wrap):
(BenchmarkRunner): Deleted.
(BenchmarkRunner._cleanup): Deleted.
* Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py:
(BrowserDriver.close_browsers):
(BrowserDriver):
(BrowserDriver.restore_env):
* Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py:
(SimpleHTTPServerDriver.__init__): We do not actually need to know external ip address for now.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkToolsChangeLog">trunk/Tools/ChangeLog</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerbenchmark_builderpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_builder.py</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_driverpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py</a></li>
<li><a href="#trunkToolsScriptswebkitpybenchmark_runnerhttp_server_driversimple_http_server_driverpy">trunk/Tools/Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkToolsChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Tools/ChangeLog (188236 => 188237)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/ChangeLog 2015-08-10 23:40:40 UTC (rev 188236)
+++ trunk/Tools/ChangeLog 2015-08-10 23:44:10 UTC (rev 188237)
</span><span class="lines">@@ -1,3 +1,34 @@
</span><ins>+2015-08-10 Dewei Zhu <dewei_zhu@apple.com>
+
+ Make cleanup more robust and minor code cleaning in run benchmark script.
+ https://bugs.webkit.org/show_bug.cgi?id=147800
+
+ Reviewed by Ryosuke Niwa.
+
+ Use 'finnaly' block to make sure cleanup code is always executed.
+
+ * Scripts/webkitpy/benchmark_runner/benchmark_runner.py:
+ (built_benchmark):
+ (built_benchmark.__init__):
+ (built_benchmark.__enter__):
+ (built_benchmark.__exit__):
+ (test_environment):
+ (test_environment.__init__):
+ (test_environment.__enter__):
+ (test_environment.__exit__):
+ (BenchmarkRunner.__init__):
+ (BenchmarkRunner.execute):
+ (BenchmarkRunner._dump):
+ (BenchmarkRunner._wrap):
+ (BenchmarkRunner): Deleted.
+ (BenchmarkRunner._cleanup): Deleted.
+ * Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py:
+ (BrowserDriver.close_browsers):
+ (BrowserDriver):
+ (BrowserDriver.restore_env):
+ * Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py:
+ (SimpleHTTPServerDriver.__init__): We do not actually need to know external ip address for now.
+
</ins><span class="cx"> 2015-08-10 Youenn Fablet <youenn.fablet@crf.canon.fr>
</span><span class="cx">
</span><span class="cx"> Compile warning (-Wsign-compare) on 32-bits at WebCore/platform/FileSystem.cpp
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbenchmark_builderpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_builder.py (188236 => 188237)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_builder.py 2015-08-10 23:40:40 UTC (rev 188236)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_builder.py 2015-08-10 23:44:10 UTC (rev 188237)
</span><span class="lines">@@ -16,30 +16,36 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> class BenchmarkBuilder(object):
</span><del>- def prepare(self, name, plan):
</del><ins>+ def __init__(self, name, plan):
</ins><span class="cx"> self._name = name
</span><ins>+ self._plan = plan
+
+ def __enter__(self):
</ins><span class="cx"> self._web_root = tempfile.mkdtemp()
</span><span class="cx"> self._dest = os.path.join(self._web_root, self._name)
</span><del>- if 'local_copy' in plan:
- self._copy_benchmark_to_temp_dir(plan['local_copy'])
- elif 'remote_archive' in plan:
- self._fetch_remote_archive(plan['remote_archive'])
- elif 'svn_source' in plan:
- self._checkout_with_subversion(plan['svn_source'])
</del><ins>+ if 'local_copy' in self._plan:
+ self._copy_benchmark_to_temp_dir(self._plan['local_copy'])
+ elif 'remote_archive' in self._plan:
+ self._fetch_remote_archive(self._plan['remote_archive'])
+ elif 'svn_source' in self._plan:
+ self._checkout_with_subversion(self._plan['svn_source'])
</ins><span class="cx"> else:
</span><span class="cx"> raise Exception('The benchmark location was not specified')
</span><span class="cx">
</span><span class="cx"> _log.info('Copied the benchmark into: %s' % self._dest)
</span><span class="cx"> try:
</span><del>- if 'create_script' in plan:
</del><ins>+ if 'create_script' in self._plan:
</ins><span class="cx"> self._run_create_script(plan['create_script'])
</span><del>- if 'benchmark_patch' in plan:
- self._apply_patch(plan['benchmark_patch'])
</del><ins>+ if 'benchmark_patch' in self._plan:
+ self._apply_patch(self._plan['benchmark_patch'])
</ins><span class="cx"> return self._web_root
</span><span class="cx"> except Exception:
</span><del>- self.clean()
</del><ins>+ self._clean()
</ins><span class="cx"> raise
</span><span class="cx">
</span><ins>+ def __exit__(self, exc_type, exc_value, traceback):
+ self._clean()
+
</ins><span class="cx"> def _run_create_script(self, create_script):
</span><span class="cx"> old_working_directory = os.getcwd()
</span><span class="cx"> os.chdir(self._dest)
</span><span class="lines">@@ -92,7 +98,7 @@
</span><span class="cx"> if error_code:
</span><span class="cx"> raise Exception('Cannot apply patch, will skip current benchmark_path - Error: %s' % error_code)
</span><span class="cx">
</span><del>- def clean(self):
</del><ins>+ def _clean(self):
</ins><span class="cx"> _log.info('Cleaning Benchmark')
</span><span class="cx"> if self._web_root:
</span><span class="cx"> force_remove(self._web_root)
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbenchmark_runnerpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py (188236 => 188237)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py 2015-08-10 23:40:40 UTC (rev 188236)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/benchmark_runner.py 2015-08-10 23:44:10 UTC (rev 188237)
</span><span class="lines">@@ -41,10 +41,10 @@
</span><span class="cx"> self._output_file = output_file
</span><span class="cx"> self._device_id = device_id
</span><span class="cx"> except IOError as error:
</span><del>- _log.error('Can not open plan file: %s - Error %s' % (plan_file, error))
</del><ins>+ _log.error('Can not open plan file: {plan_file} - Error {error}'.format(plan_file=plan_file, error=error))
</ins><span class="cx"> raise error
</span><span class="cx"> except ValueError as error:
</span><del>- _log.error('Plan file: %s may not follow JSON format - Error %s' % (plan_file, error))
</del><ins>+ _log.error('Plan file: {plan_file} may not follow JSON format - Error {error}'.format(plan_file=plan_file, error=error))
</ins><span class="cx"> raise error
</span><span class="cx">
</span><span class="cx"> def _find_plan_file(self, plan_file):
</span><span class="lines">@@ -58,46 +58,33 @@
</span><span class="cx"> return absPath
</span><span class="cx"> return plan_file
</span><span class="cx">
</span><del>- def execute(self):
- _log.info('Start to execute the plan')
- _log.info('Start a new benchmark')
</del><ins>+ def _run_benchmark(self, count, web_root):
</ins><span class="cx"> results = []
</span><del>- self._benchmark_builder = BenchmarkBuilder()
-
- web_root = self._benchmark_builder.prepare(self._plan_name, self._plan)
- for x in xrange(int(self._plan['count'])):
- _log.info('Start the iteration %d of current benchmark' % (x + 1))
- self._http_server_driver.serve(web_root)
- self._browser_driver.prepare_env(self._device_id)
- url = urlparse.urljoin(self._http_server_driver.base_url(), self._plan_name + '/' + self._plan['entry_point'])
- self._browser_driver.launch_url(url, self._build_dir)
- result = None
</del><ins>+ for iteration in xrange(1, count + 1):
+ _log.info('Start the iteration {current_iteration} of current benchmark'.format(current_iteration=iteration))
</ins><span class="cx"> try:
</span><ins>+ result = None
+ self._http_server_driver.serve(web_root)
+ self._browser_driver.prepare_env(self._device_id)
+ url = urlparse.urljoin(self._http_server_driver.base_url(), self._plan_name + '/' + self._plan['entry_point'])
+ self._browser_driver.launch_url(url, self._build_dir)
</ins><span class="cx"> with timeout(self._plan['timeout']):
</span><span class="cx"> result = self._http_server_driver.fetch_result()
</span><del>- assert(not self._http_server_driver.get_return_code())
- assert(result)
- results.append(json.loads(result))
- except Exception as error:
- _log.error('No result or the server crashed. Something went wrong. Will skip current benchmark.\nError: %s, Server return code: %d, result: %s' % (error, self._http_server_driver.get_return_code(), result))
- self._cleanup()
- sys.exit(1)
</del><ins>+ assert(not self._http_server_driver.get_return_code())
+ assert(result)
+ results.append(json.loads(result))
</ins><span class="cx"> finally:
</span><ins>+ self._browser_driver.restore_env()
</ins><span class="cx"> self._browser_driver.close_browsers()
</span><del>- _log.info('End of %d iteration of current benchmark' % (x + 1))
</del><ins>+ self._http_server_driver.kill_server()
+ _log.info('End of {current_iteration} iteration of current benchmark'.format(current_iteration=iteration))
</ins><span class="cx"> results = self._wrap(results)
</span><span class="cx"> self._dump(results, self._output_file if self._output_file else self._plan['output_file'])
</span><span class="cx"> self._show_results(results)
</span><del>- self._benchmark_builder.clean()
- sys.exit()
</del><span class="cx">
</span><del>- def _cleanup(self):
- if self._browser_driver:
- self._browser_driver.close_browsers()
- if self._http_server_driver:
- self._http_server_driver.kill_server()
- if self._benchmark_builder:
- self._benchmark_builder.clean()
</del><ins>+ def execute(self):
+ with BenchmarkBuilder(self._plan_name, self._plan) as web_root:
+ self._run_benchmark(int(self._plan['count']), web_root)
</ins><span class="cx">
</span><span class="cx"> @classmethod
</span><span class="cx"> def _dump(cls, results, output_file):
</span><span class="lines">@@ -106,18 +93,18 @@
</span><span class="cx"> with open(output_file, 'w') as fp:
</span><span class="cx"> json.dump(results, fp)
</span><span class="cx"> except IOError as error:
</span><del>- _log.error('Cannot open output file: %s - Error: %s' % (output_file, error))
- _log.error('Results are:\n %s', json.dumps(results))
</del><ins>+ _log.error('Cannot open output file: {output_file} - Error: {error}'.format(output_file=output_file, error=error))
+ _log.error('Results are:\n {result}'.format(json.dumps(results)))
</ins><span class="cx">
</span><span class="cx"> @classmethod
</span><span class="cx"> def _wrap(cls, dicts):
</span><del>- _log.debug('Merging following results:\n%s', json.dumps(dicts))
</del><ins>+ _log.debug('Merging following results:\n{results}'.format(results=json.dumps(dicts)))
</ins><span class="cx"> if not dicts:
</span><span class="cx"> return None
</span><span class="cx"> ret = {}
</span><span class="cx"> for dic in dicts:
</span><span class="cx"> ret = cls._merge(ret, dic)
</span><del>- _log.debug('Results after merging:\n%s', json.dumps(ret))
</del><ins>+ _log.debug('Results after merging:\n{result}'.format(result=json.dumps(ret)))
</ins><span class="cx"> return ret
</span><span class="cx">
</span><span class="cx"> @classmethod
</span></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerbrowser_driverbrowser_driverpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py (188236 => 188237)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py 2015-08-10 23:40:40 UTC (rev 188236)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/browser_driver/browser_driver.py 2015-08-10 23:44:10 UTC (rev 188237)
</span><span class="lines">@@ -18,3 +18,7 @@
</span><span class="cx"> @abc.abstractmethod
</span><span class="cx"> def close_browsers(self):
</span><span class="cx"> pass
</span><ins>+
+ @abc.abstractmethod
+ def restore_env(self):
+ pass
</ins></span></pre></div>
<a id="trunkToolsScriptswebkitpybenchmark_runnerhttp_server_driversimple_http_server_driverpy"></a>
<div class="modfile"><h4>Modified: trunk/Tools/Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py (188236 => 188237)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Tools/Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py 2015-08-10 23:40:40 UTC (rev 188236)
+++ trunk/Tools/Scripts/webkitpy/benchmark_runner/http_server_driver/simple_http_server_driver.py 2015-08-10 23:44:10 UTC (rev 188237)
</span><span class="lines">@@ -24,14 +24,7 @@
</span><span class="cx"> def __init__(self):
</span><span class="cx"> self._server_process = None
</span><span class="cx"> self._server_port = 0
</span><del>- # FIXME: This may not be reliable.
- _log.info('Finding the IP address of current machine')
- try:
- self._ip = [ip for ip in socket.gethostbyname_ex(socket.gethostname())[2] if not ip.startswith("127.")][0]
- _log.info('IP of current machine is: %s' % self._ip)
- except Exception as error:
- _log.error('Cannot get the ip address of current machine - Error: %s' % error)
- raise
</del><ins>+ self._ip = '127.0.0.1'
</ins><span class="cx">
</span><span class="cx"> def serve(self, web_root):
</span><span class="cx"> _log.info('Launching an http server')
</span></span></pre>
</div>
</div>
</body>
</html>