[DevTools] Adds support for Karma tests

Change-Id: I1ea19eee040360d3a73ffaa72ccf15bceff80317
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/1806858
Auto-Submit: Paul Lewis <aerotwist@google.com>
Reviewed-by: Yang Guo <yangguo@chromium.org>
Commit-Queue: Paul Lewis <aerotwist@google.com>
Cr-Commit-Position: refs/heads/master@{#696789}

third_party/blink/renderer/devtools/karma.conf.js

+// Copyright 2019 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.
+
+module.exports = function(config) {
+  const options = {
+    basePath: "",
+
+    files: [{
+      pattern: 'front_end/**/*.js',
+      included: false,
+      served: true
+    },{
+      pattern: 'tests/**/*.ts',
+      type: 'module'
+    }],
+
+    reporters: ["dots"],
+
+    preprocessors: {
+      './tests/**/*.ts': ['karma-typescript']
+    },
+
+    browsers: ["ChromeHeadless"],
+
+    frameworks: ["mocha", "chai", "karma-typescript"],
+
+    karmaTypescriptConfig: {
+      compilerOptions: {
+        target: "esnext",
+        module: "esnext",
+        typeRoots: ["./third_party/devtools-node-modules/third_party/node_modules/@types"]
+      },
+      coverageOptions: {
+        instrumentation: false
+      },
+      bundlerOptions: {
+        resolve: {
+          directories: ["./third_party/devtools-node-modules/third_party/node_modules"]
+        }
+      }
+    },
+
+    proxies: {
+      '/front_end': '/base/front_end',
+    },
+
+    plugins: [
+      "karma-chrome-launcher",
+      "karma-mocha",
+      "karma-chai",
+      "karma-typescript"
+    ],
+
+    singleRun: true
+  };
+
+  config.set(options);
+};

third_party/blink/renderer/devtools/readme.md

@@ -61,11 +61,11 @@ One-time setup:
 npm run setup-dtrun
 ```
 
-Now, you can use any of the following commands by simply doing: `dtrun test`. 
+Now, you can use any of the following commands by simply doing: `dtrun test`.
 
 In addition, you no longer need to pass double dashes (e.g. `--`) before you pass in the flags. So you can do: `dtrun test -d inspector/test.html`.
 
-#### `npm run format` 
+#### `npm run format`
 Formats your code using clang-format
 
 ### `npm run format-py`
@@ -85,8 +85,8 @@ npm test -- inspector/sources inspector/console
 
 # debug a specific test. Any one of:
 npm run debug-test inspector/cookie-resource-match.html
-npm test -- --debug-devtools inspector/cookie-resource-match.html 
-npm test -- -d inspector/cookie-resource-match.html 
+npm test -- --debug-devtools inspector/cookie-resource-match.html
+npm test -- -d inspector/cookie-resource-match.html
 
 # pass in additional flags to the test harness
 npm test -- -f --child-processes=16
@@ -99,15 +99,15 @@ npm test -- --time-out-ms=6000000 <test_path>
 
 #### `--fetch-content-shell`
 ```
-# If you're using a full chromium checkout and have a compiled content shell, 
-# this will fetch a pre-compiled content shell. This is useful if you 
+# If you're using a full chromium checkout and have a compiled content shell,
+# this will fetch a pre-compiled content shell. This is useful if you
 # haven't compiled your content shell recently
 npm test -- --fetch-content-shell
 ```
 
 #### `--target=SUB_DIRECTORY_NAME`
 ```
-# If you're using a build sub-directory that's not out/Release, 
+# If you're using a build sub-directory that's not out/Release,
 # such as out/Default, then use --target=SUB_DIRECTORY_NAME
 npm test -- --target=Default
 ```
@@ -127,3 +127,17 @@ npm test -- --target=Default
   [@ChromeDevTools]: http://twitter.com/ChromeDevTools
   [@DevToolsCommits]: http://twitter.com/DevToolsCommits
   [all open DevTools tickets]: https://bugs.chromium.org/p/chromium/issues/list?can=2&q=component%3APlatform%3EDevTools&sort=&groupby=&colspec=ID+Stars+Owner+Summary+Modified+Opened
+
+### Tests
+The tests are run through Karma.
+
+```
+python scripts/run_tests.py
+```
+
+You can also specify with which Chrome binary to run tests by setting the
+`chrome-binary` variable.
+
+```
+python scripts/run_tests.py --chrome-binary=/path/to/chromium/build/chromium
+```

third_party/blink/renderer/devtools/scripts/local_node.py

@@ -12,6 +12,8 @@ SCRIPTS_PATH = path.dirname(path.abspath(__file__))
 THIRD_PARTY_PATH = path.join(SCRIPTS_PATH, '..', '..', '..', '..')
 NODE_PATH = path.join(THIRD_PARTY_PATH, 'node')
 ESLINT_PATH = path.join(THIRD_PARTY_PATH, 'devtools-node-modules', 'third_party', 'node_modules', 'eslint', 'bin', 'eslint.js')
+KARMA_PATH = path.join(THIRD_PARTY_PATH, 'devtools-node-modules', 'third_party', 'node_modules', 'karma', 'bin', 'karma')
+NODE_MODULES_PATH = path.join(THIRD_PARTY_PATH, 'devtools-node-modules', 'third_party', 'node_modules')
 
 try:
     old_sys_path = sys.path[:]
@@ -27,3 +29,11 @@ def node_path():
 
 def eslint_path():
     return ESLINT_PATH
+
+
+def karma_path():
+    return KARMA_PATH
+
+
+def node_modules_path():
+    return NODE_MODULES_PATH

third_party/blink/renderer/devtools/scripts/run_tests.py

+#!/usr/bin/env python
+#
+# 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 os
+import re
+import subprocess
+import sys
+
+import local_node
+
+is_cygwin = sys.platform == "cygwin"
+chrome_binary = None
+
+if len(sys.argv) >= 2:
+    chrome_binary = re.sub(r"^\-\-chrome-binary=(.*)", "\\1", sys.argv[1])
+    is_executable = os.path.exists(chrome_binary) and os.path.isfile(chrome_binary) and os.access(chrome_binary, os.X_OK)
+    if not is_executable:
+        print("Unable to find a Chrome binary at \"%s\"" % chrome_binary)
+        sys.exit(1)
+
+
+def popen(arguments, cwd=None, env=None):
+    return subprocess.Popen(arguments, cwd=cwd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, env=env)
+
+
+def to_platform_path_exact(filepath):
+    if not is_cygwin:
+        return filepath
+    output, _ = popen(["cygpath", "-w", filepath]).communicate()
+    # pylint: disable=E1103
+    return output.strip().replace("\\", "\\\\")
+
+
+scripts_path = os.path.dirname(os.path.abspath(__file__))
+devtools_path = os.path.dirname(scripts_path)
+
+print("Running tests with Karma...")
+if (chrome_binary is not None):
+    print("Using custom Chrome Binary (%s)\n" % chrome_binary)
+else:
+    print("Using system Chrome")
+
+
+def run_tests():
+    karma_errors_found = False
+
+    karmaconfig_path = os.path.join(devtools_path, "karma.conf.js")
+    exec_command = [local_node.node_path(), local_node.karma_path(), "start", to_platform_path_exact(karmaconfig_path)]
+
+    env = {'NODE_PATH': local_node.node_modules_path()}
+    if (chrome_binary is not None):
+        env['CHROME_BIN'] = chrome_binary
+
+    karma_proc = popen(exec_command, cwd=devtools_path, env=env)
+
+    (karma_proc_out, _) = karma_proc.communicate()
+    if karma_proc.returncode != 0:
+        karma_errors_found = True
+    else:
+        print("Karma exited successfully")
+
+    print(karma_proc_out)
+    return karma_errors_found
+
+
+errors_found = run_tests()
+
+if errors_found:
+    print("ERRORS DETECTED")
+    sys.exit(1)

third_party/blink/renderer/devtools/tsconfig.json

+{
+  "compilerOptions": {
+    "typeRoots": ["../../../devtools-node-modules/third_party/node_modules/@types"]
+  }
+}