[Pywebsocket PerformanceTests 2/2] Add blink_perf.pywebsocket

tools/perf/benchmarks/blink_perf.py

 # Copyright 2013 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.
 
 import os
 
+from benchmarks import pywebsocket_server
 from telemetry import benchmark
 from telemetry.core import util
 from telemetry import page as page_module
 from telemetry.page import page_set
 from telemetry.page import page_test
+from telemetry.page import shared_page_state
 from telemetry.value import list_of_scalar_values
 
 
 BLINK_PERF_BASE_DIR = os.path.join(util.GetChromiumSrcDir(),
                                    'third_party', 'WebKit', 'PerformanceTests')
 SKIPPED_FILE = os.path.join(BLINK_PERF_BASE_DIR, 'Skipped')
 
 
-def CreatePageSetFromPath(path, skipped_file):
+def CreatePageSetFromPath(
+    path, skipped_file,
+    shared_page_state_class=shared_page_state.SharedPageState):
   assert os.path.exists(path)
 
   page_urls = []
   serving_dirs = set()
 
   def _AddPage(path):
     if not path.endswith('.html'):
       return
     if '../' in open(path, 'r').read():
       # If the page looks like it references its parent dir, include it.
@@ skipping 19 matching lines @@
         line = line.strip()
         if line and not line.startswith('#'):
           skipped_path = os.path.join(os.path.dirname(skipped_file), line)
           skipped.append(skipped_path.replace('/', os.sep))
     _AddDir(path, tuple(skipped))
   else:
     _AddPage(path)
   ps = page_set.PageSet(file_path=os.getcwd()+os.sep,
                         serving_dirs=serving_dirs)
   for url in page_urls:
-    ps.AddUserStory(page_module.Page(url, ps, ps.base_dir))
+    ps.AddUserStory(page_module.Page(
+        url, ps, ps.base_dir, shared_page_state_class=shared_page_state_class))
   return ps
 
 
 class _BlinkPerfMeasurement(page_test.PageTest):
   """Tuns a blink performance test and reports the results."""
   def __init__(self):
     super(_BlinkPerfMeasurement, self).__init__()
     with open(os.path.join(os.path.dirname(__file__),
                            'blink_perf.js'), 'r') as f:
       self._blink_perf_js = f.read()
@@ skipping 36 matching lines @@
     self._blink_perf_js += '\nwindow.fullFrameMeasurement = true;'
 
   def CustomizeBrowserOptions(self, options):
     super(_BlinkPerfFullFrameMeasurement, self).CustomizeBrowserOptions(
         options)
     # Full layout measurement needs content_shell with internals testing API.
     assert 'content-shell' in options.browser_type
     options.AppendExtraBrowserArgs(['--expose-internals-for-testing'])
 
 
+class _BlinkPerfPywebsocketMeasurement(_BlinkPerfMeasurement):
+  def CustomizeBrowserOptions(self, options):
+    super(_BlinkPerfPywebsocketMeasurement, self).CustomizeBrowserOptions(
+        options)
+    # Cross-origin accesses are needed to run benchmarks spanning two servers,
+    # the Telemetry's HTTP server and the pywebsocket server.
+    options.AppendExtraBrowserArgs(['--disable-web-security'])
+
+
+class _SharedPywebsocketPageState(shared_page_state.SharedPageState):
+  """Runs a pywebsocket server."""
+  def WillRunUserStory(self, page):
+    super(_SharedPywebsocketPageState, self).WillRunUserStory(page)
+
+    # Start a pywebsocket server if not already running.
+    if not self.browser.GetRunningLocalServer(
+        pywebsocket_server.PywebsocketServer, None):

[nednguyen, 2015/04/06 17:34:02]

Can you explain why we need this check?

[hiroshige, 2015/04/08 07:47:25]

This is to avoid multiple instances of pywebsocket servers to be started.
WillRunUserStory is called for every html page under
PerformanceTests/Pywebsocket, but pywebsocket should be started only once.
Similar logic is implemented in SetHTTPServerDirectories for HTTP server:
https://code.google.com/p/chromium/codesearch#chromium/src/tools/telemetry/te...

[nednguyen, 2015/04/08 15:08:26]

https://code.google.com/p/chromium/codesearch#chromium/src/tools/telemetry/te...

Ah, I see.
Then this functionality probably should go to the __init__ of
_SharedPywebsocketPageState.
See
https://code.google.com/p/chromium/codesearch#chromium/src/tools/telemetry/te...

You also want to add some clean up logic in TearDownState?

[aiolos (Not reviewing), 2015/04/08 17:32:56]

+1. You should only have logic that should be run prior to every user story/page
in WillRunUserStory. 

[hiroshige, 2015/04/09 09:11:42]

Done (I'm not sure this is correct way to get platform_backend though).

+      self.browser.StartLocalServer(pywebsocket_server.PywebsocketServer())
+
+
 class BlinkPerfAnimation(benchmark.Benchmark):
   tag = 'animation'
   test = _BlinkPerfMeasurement
 
   @classmethod
   def Name(cls):
     return 'blink_perf.animation'
 
   def CreatePageSet(self, options):
     path = os.path.join(BLINK_PERF_BASE_DIR, 'Animation')
@@ skipping 172 matching lines @@
   tag = 'xml_http_request'
   test = _BlinkPerfMeasurement
 
   @classmethod
   def Name(cls):
     return 'blink_perf.xml_http_request'
 
   def CreatePageSet(self, options):
     path = os.path.join(BLINK_PERF_BASE_DIR, 'XMLHttpRequest')
     return CreatePageSetFromPath(path, SKIPPED_FILE)
+
+
+class BlinkPerfPywebsocket(benchmark.Benchmark):
+  tag = 'pywebsocket'
+  test = _BlinkPerfPywebsocketMeasurement
+
+  @classmethod
+  def Name(cls):
+    return 'blink_perf.pywebsocket'
+
+  def CreatePageSet(self, options):
+    path = os.path.join(BLINK_PERF_BASE_DIR, 'Pywebsocket')
+    return CreatePageSetFromPath(path, SKIPPED_FILE,
+        shared_page_state_class=_SharedPywebsocketPageState)