Add android_webview to products

crbug.com/992947

Author: Changwan Ryu

tools/wpt/browser.py

@@ -581,25 +581,25 @@ def version(self, binary=None, webdriver_binary=None):
         return m.group(1)
 
 
-class ChromeAndroid(Browser):
-    """Chrome-specific interface for Android.
+class ChromeAndroidBase(Browser):
+    """A base class for ChromeAndroid and AndroidWebView.
 
+    On Android, WebView is based on Chromium open source project, and on some
+    versions of Android we share the library with Chrome. Therefore, we have
+    a very similar WPT runner implementation.
     Includes webdriver installation.
     """
-
-    product = "chrome_android"
-    requirements = "requirements_chrome_android.txt"
+    __metaclass__ = ABCMeta  # This is an abstract class.
 
     def __init__(self, logger):
-        super(ChromeAndroid, self).__init__(logger)
+        super(ChromeAndroidBase, self).__init__(logger)
 
     def install(self, dest=None, channel=None):
         raise NotImplementedError
 
+    @abstractmethod
     def find_binary(self, venv_path=None, channel=None):
-        if channel in ("beta", "dev", "canary"):
-            return "com.chrome." + channel
-        return "com.android.chrome"
+        raise NotImplementedError
 
     def find_webdriver(self, channel=None):
         return find_executable("chromedriver")
@@ -629,6 +629,49 @@ def version(self, binary=None, webdriver_binary=None):
         return match.group(1)
 
 
+class ChromeAndroid(ChromeAndroidBase):
+    """Chrome-specific interface for Android.
+    """
+
+    product = "chrome_android"
+    requirements = "requirements_chrome_android.txt"
+
+    def find_binary(self, venv_path=None, channel=None):
+        if channel in ("beta", "dev", "canary"):
+            return "com.chrome." + channel
+        return "com.android.chrome"
+
+
+class AndroidWebview(ChromeAndroidBase):
+    """Webview-specific interface for Android.
+
+    Design doc:
+    https://docs.google.com/document/d/19cGz31lzCBdpbtSC92svXlhlhn68hrsVwSB7cfZt54o/view
+    """
+
+    product = "android_webview"
+    requirements = "requirements_android_webview.txt"
+
+    def find_binary(self, venv_path=None, channel=None):
+        # Just get the current package name of the WebView provider.
+        # For WebView, it is not trivial to change the WebView provider, so
+        # we will just grab whatever is available.
+        # https://chromium.googlesource.com/chromium/src/+/HEAD/android_webview/docs/channels.md
+        command = ['adb', 'shell', 'dumpsys', 'webviewupdate']
+        try:
+            output = call(*command)
+        except (subprocess.CalledProcessError, OSError):
+            self.logger.warning("Failed to call %s" % " ".join(command))
+            return None
+        m = re.search(r'^\s*Current WebView package \(name, version\): \((.*), ([0-9.]*)\)$',
+                      output, re.M)
+        if m is None:
+            self.logger.warning("Unable to find current WebView package in dumpsys output")
+            return None
+        self.logger.warning("Final package name: " + m.group(1))
+        return m.group(1)
+
+
 class ChromeiOS(Browser):
     """Chrome-specific interface for iOS.
     """

tools/wpt/run.py

@@ -341,6 +341,29 @@ def setup_kwargs(self, kwargs):
             raise WptrunError("Unable to locate or install chromedriver binary")
 
 
+class AndroidWebview(BrowserSetup):
+    name = "android_webview"
+    browser_cls = browser.AndroidWebview
+
+    def setup_kwargs(self, kwargs):
+        if kwargs["webdriver_binary"] is None:
+            webdriver_binary = self.browser.find_webdriver()
+
+            if webdriver_binary is None:
+                install = self.prompt_install("chromedriver")
+
+                if install:
+                    logger.info("Downloading chromedriver")
+                    webdriver_binary = self.browser.install_webdriver(dest=self.venv.bin_path)
+            else:
+                logger.info("Using webdriver binary %s" % webdriver_binary)
+
+            if webdriver_binary:
+                kwargs["webdriver_binary"] = webdriver_binary
+            else:
+                raise WptrunError("Unable to locate or install chromedriver binary")
+
+
 class Opera(BrowserSetup):
     name = "opera"
     browser_cls = browser.Opera
@@ -532,6 +555,7 @@ def setup_kwargs(self, kwargs):
 
 
 product_setup = {
+    "android_webview": AndroidWebview,
     "firefox": Firefox,
     "firefox_android": FirefoxAndroid,
     "chrome": Chrome,

tools/wptrunner/requirements_android_webview.txt

@@ -0,0 +1 @@
+mozprocess==1.0.0

tools/wptrunner/wptrunner/browsers/__init__.py

@@ -22,7 +22,8 @@
 module global scope.
 """
 
-product_list = ["chrome",
+product_list = ["android_webview",
+                "chrome",
                 "chrome_android",
                 "chrome_ios",
                 "edgechromium",

tools/wptrunner/wptrunner/browsers/android_webview.py

@@ -0,0 +1,124 @@
+import subprocess
+
+from .base import Browser, ExecutorBrowser, require_arg
+from .base import get_timeout_multiplier   # noqa: F401
+from .chrome import executor_kwargs as chrome_executor_kwargs
+from ..webdriver_server import ChromeDriverServer
+from ..executors.executorwebdriver import (WebDriverTestharnessExecutor,  # noqa: F401
+                                           WebDriverRefTestExecutor)  # noqa: F401
+from ..executors.executorchrome import ChromeDriverWdspecExecutor  # noqa: F401
+
+
+__wptrunner__ = {"product": "android_webview",
+                 "check_args": "check_args",
+                 "browser": "SystemWebViewShell",
+                 "executor": {"testharness": "WebDriverTestharnessExecutor",
+                              "reftest": "WebDriverRefTestExecutor",
+                              "wdspec": "ChromeDriverWdspecExecutor"},
+                 "browser_kwargs": "browser_kwargs",
+                 "executor_kwargs": "executor_kwargs",
+                 "env_extras": "env_extras",
+                 "env_options": "env_options",
+                 "timeout_multiplier": "get_timeout_multiplier"}
+
+_wptserve_ports = set()
+
+
+def check_args(**kwargs):
+    require_arg(kwargs, "webdriver_binary")
+
+
+def browser_kwargs(test_type, run_info_data, config, **kwargs):
+    return {"binary": kwargs["binary"],
+            "webdriver_binary": kwargs["webdriver_binary"],
+            "webdriver_args": kwargs.get("webdriver_args")}
+
+
+def executor_kwargs(test_type, server_config, cache_manager, run_info_data,
+                    **kwargs):
+    # Use update() to modify the global list in place.
+    _wptserve_ports.update(set(
+        server_config['ports']['http'] + server_config['ports']['https'] +
+        server_config['ports']['ws'] + server_config['ports']['wss']
+    ))
+
+    executor_kwargs = chrome_executor_kwargs(test_type, server_config,
+                                             cache_manager, run_info_data,
+                                             **kwargs)
+    del executor_kwargs["capabilities"]["goog:chromeOptions"]["prefs"]
+    del executor_kwargs["capabilities"]["goog:chromeOptions"]["useAutomationExtension"]
+    capabilities = executor_kwargs["capabilities"]
+    # Note that for WebView, we launch a test shell and have the test shell use WebView.
+    # https://chromium.googlesource.com/chromium/src/+/HEAD/android_webview/docs/webview-shell.md
+    capabilities["goog:chromeOptions"]["androidPackage"] = \
+        "org.chromium.webview_shell"
+    capabilities["goog:chromeOptions"]["androidActivity"] = ".WebPlatformTestsActivity"
+
+    # Workaround: driver.quit() cannot quit SystemWebViewShell.
+    executor_kwargs["pause_after_test"] = False
+    # Workaround: driver.close() is not supported.
+    executor_kwargs["restart_after_test"] = True
+    executor_kwargs["close_after_done"] = False
+    return executor_kwargs
+
+
+def env_extras(**kwargs):
+    return []
+
+
+def env_options():
+    return {}
+
+
+#TODO: refactor common elements of SystemWebViewShell and ChromeAndroidBrowser
+class SystemWebViewShell(Browser):
+    """Chrome is backed by chromedriver, which is supplied through
+    ``wptrunner.webdriver.ChromeDriverServer``.
+    """
+
+    def __init__(self, logger, binary, webdriver_binary="chromedriver",
+                 webdriver_args=None):
+        """Creates a new representation of Chrome.  The `binary` argument gives
+        the browser binary to use for testing."""
+        Browser.__init__(self, logger)
+        self.binary = binary
+        self.server = ChromeDriverServer(self.logger,
+                                         binary=webdriver_binary,
+                                         args=webdriver_args)
+        self.setup_adb_reverse()
+
+    def _adb_run(self, args):
+        self.logger.info('adb ' + ' '.join(args))
+        subprocess.check_call(['adb'] + args)
+
+    def setup_adb_reverse(self):
+        self._adb_run(['wait-for-device'])
+        self._adb_run(['forward', '--remove-all'])
+        self._adb_run(['reverse', '--remove-all'])
+        # "adb reverse" basically forwards network connection from device to
+        # host.
+        for port in _wptserve_ports:
+            self._adb_run(['reverse', 'tcp:%d' % port, 'tcp:%d' % port])
+
+    def start(self, **kwargs):
+        self.server.start(block=False)
+
+    def stop(self, force=False):
+        self.server.stop(force=force)
+
+    def pid(self):
+        return self.server.pid
+
+    def is_alive(self):
+        # TODO(ato): This only indicates the driver is alive,
+        # and doesn't say anything about whether a browser session
+        # is active.
+        return self.server.is_alive()
+
+    def cleanup(self):
+        self.stop()
+        self._adb_run(['forward', '--remove-all'])
+        self._adb_run(['reverse', '--remove-all'])
+
+    def executor_browser(self):
+        return ExecutorBrowser, {"webdriver_url": self.server.url}