[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 local_server
+from telemetry.core import platform as platform_module
 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 __init__(self, test, finder_options, user_story_set):
+    super(_SharedPywebsocketPageState, self).__init__(
+        test, finder_options, user_story_set)
+    self._pywebsocket_server = pywebsocket_server.PywebsocketServer()
+    platform_module.GetHostPlatform().StartLocalServer(

[nednguyen, 2015/04/23 15:29:19]

Does this benchmark work for the case browser runs on remote platform like
android & cros?

[hiroshige, 2015/04/24 08:15:44]

I tested and, no, this didn't work on android trybots...
(Patch Set 9 worked)

[nednguyen, 2015/04/24 15:04:37]

Then we should figure out patch 12 doesn't work on Android but patchset 9
worked. My suspicion is there are some extra steps to forward the host port to
the remote port that isn't wired up properly  in this limbo state.
Once we figure that out, you can decide whether to:
1) File a bug about it, and disable this benchmark on Android & Cros with
@benchmark.Disabled('android', 'chromeos') # crbug.com/...
2) Fix the problem in this patch.

[hiroshige, 2015/07/30 05:29:07]

This was because on Android platform.GetPlatformForDevice(device,
finder_options) should be used instead of platform_module.GetHostPlatform() on
Desktop.
In Patch Set 13, I use SharedPageState.platform (which obtains platform via
browser) and this works on Android.

+        self._pywebsocket_server)
+
+  def TearDownState(self, results):
+    super(_SharedPywebsocketPageState, self).TearDownState(results)
+    self._pywebsocket_server.Close()
+
+
 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)