sandwich: Adds web page replay support for HTTP

tools/android/loading/device_setup.py

 # Copyright 2016 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 contextlib
 import logging
 import os
 import shutil
 import subprocess
 import sys
 import tempfile
 import time
 
 _SRC_DIR = os.path.abspath(os.path.join(
     os.path.dirname(__file__), '..', '..', '..'))
 
 sys.path.append(os.path.join(_SRC_DIR, 'third_party', 'catapult', 'devil'))
 from devil.android import device_utils
 from devil.android.sdk import intent
+from devil.android import forwarder

[Benoit L, 2016/02/10 13:58:27]

Wrong import ordering (move to line 19).

[gabadie, 2016/02/10 14:19:50]

Done.

 
 sys.path.append(os.path.join(_SRC_DIR, 'build', 'android'))
 from pylib import constants
 from pylib import flag_changer
 
+sys.path.append(os.path.join(_SRC_DIR, 'tools', 'perf'))
+from chrome_telemetry_build import chromium_config
+
+sys.path.append(chromium_config.GetTelemetryDir())
+from telemetry.internal.util import webpagereplay

[Benoit L, 2016/02/10 13:58:27]

Is webpagereplay in catapult now?

[gabadie, 2016/02/10 14:19:50]

Webpage replay it self is in its own third_party tools. But here I reused a
class from telemetry to avoid code effort:
https://code.google.com/p/chromium/codesearch#chromium/src/third_party/catapu...

+
 import devtools_monitor
 
 DEVTOOLS_PORT = 9222
 DEVTOOLS_HOSTNAME = 'localhost'
 DEFAULT_CHROME_PACKAGE = 'chrome'
 
 
 @contextlib.contextmanager
 def TemporaryDirectory():
   """Returns a freshly-created directory that gets automatically deleted after
@@ skipping 62 matching lines @@
     device.adb.ForwardRemove(local)
 
 
 def _SetUpDevice(device, package_info):
   """Enables root and closes Chrome on a device."""
   device.EnableRoot()
   device.KillAll(package_info.package, quiet=True)
 
 
 @contextlib.contextmanager
+def WprHost(device, wpr_archive_path, record=False):
+  """Launch web page replay host.

[Benoit L, 2016/02/10 13:58:27]

nit: Launches the

[gabadie, 2016/02/10 14:19:50]

Done.

+
+  Args:
+    device: Android device.
+    wpr_archive_path: host sided WPR archive's path.
+    record: Enables or disables WPR archive recording.
+
+  Returns:
+    Additional flags list that may be used for chromium to load web page through
+    the running web page replay host.
+  """
+  assert device
+  if wpr_archive_path == None:
+    yield []
+    return
+
+  wpr_server_args = ['--use_closest_match']
+  if record:
+    wpr_server_args.append('--record')
+    if os.path.exists(wpr_archive_path):
+      os.remove(wpr_archive_path)
+  else:
+    assert os.path.exists(wpr_archive_path)
+  wpr_server = webpagereplay.ReplayServer(wpr_archive_path,
+      '127.0.0.1', 0, 0, None, wpr_server_args)
+  ports = wpr_server.StartServer()[:-1]
+  host_http_port = ports[0]
+  host_https_port = ports[1]
+
+  forwarder.Forwarder.Map([(0, host_http_port), (0, host_https_port)], device)
+  device_http_port = forwarder.Forwarder.DevicePortForHostPort(host_http_port)
+  device_https_port = forwarder.Forwarder.DevicePortForHostPort(host_https_port)
+
+  try:
+    yield [

[mattcary, 2016/02/10 14:01:01]

This is fine for now. Note that if the WPR interface gets more complicated, it
might be nicer to have something like

class WprHostImpl(object):
  def __init__(self, flags):
    self.chrome_flags = flags

Then have this return a WprHostImpl instance rather than just a flag list. That
would make the context manager return value read a little more naturally.

But since all we have now are the flags I don't think we gain anything by
generalizing the interface.

[gabadie, 2016/02/10 14:19:50]

Acknowledged.

+      '--host-resolver-rules="MAP * 127.0.0.1,EXCLUDE localhost"',
+      '--testing-fixed-http-port={}'.format(device_http_port),
+      '--testing-fixed-https-port={}'.format(device_https_port)]
+  finally:
+    forwarder.Forwarder.UnmapAllDevicePorts(device)

[Benoit L, 2016/02/10 13:58:27]

I don't know whether that's relevant here, but this removes all mappings at
once, so wouldn't that conflict with other redirections, such as the devtools
one?

[gabadie, 2016/02/10 14:19:50]

Indeed but since there is a dependency, that is running fine. I'll remove only
the two port then. Done.

+    wpr_server.StopServer()
+
+@contextlib.contextmanager
 def DeviceConnection(device,
                      package=DEFAULT_CHROME_PACKAGE,
                      hostname=DEVTOOLS_HOSTNAME,
                      port=DEVTOOLS_PORT,
                      host_exe='out/Release/chrome',
-                     host_profile_dir=None):
+                     host_profile_dir=None,
+                     additional_flags=[]):
   """Context for starting recording on a device.
 
   Sets up and restores any device and tracing appropriately
 
   Args:
     device: Android device, or None for a local run (in which case chrome needs
       to have been started with --remote-debugging-port=XXX).
     package: The key for chrome package info.
     port: The port on which to enable remote debugging.
     host_exe: The binary to execute when running on the host.
     host_profile_dir: The profile dir to use when running on the host (if None,
       a fresh profile dir will be used).
+    additional_flags: Additional chromium arguments.
 
   Returns:
     A context manager type which evaluates to a DevToolsConnection.
   """
   package_info = constants.PACKAGE_INFO[package]
   command_line_path = '/data/local/chrome-command-line'
   new_flags = ['--disable-fre',
                '--enable-test-events',
-               '--remote-debugging-port=%d' % port]
+               '--remote-debugging-port=%d' % port] + additional_flags
   if device:
     _SetUpDevice(device, package_info)
   with FlagReplacer(device, command_line_path, new_flags):
     host_process = None
     if device:
       start_intent = intent.Intent(
           package=package_info.package, activity=package_info.activity,
           data='about:blank')
       device.StartActivity(start_intent, blocking=True)
     else:
@@ skipping 31 matching lines @@
     package: the key for chrome package info.
     fn: the function to execute that launches chrome and performs the
         appropriate instrumentation. The function will receive a
         DevToolsConnection as its sole parameter.
 
   Returns:
     As fn() returns.
   """
   with DeviceConnection(device, package) as connection:
     return fn(connection)