build: run saucelabs tests with bazel

Author: devversion

BUILD.bazel

@@ -27,3 +27,11 @@ genrule(
     outs = ["entry_points_manifest.json"],
     cmd = "echo '%s' > $@" % entryPoints,
 )
+
+genrule(
+    name = "saucelabs_tunnel_identifier",
+    outs = ["saucelabs_tunnel_identifier.txt"],
+    cmd = "$(execpath //scripts/saucelabs:extract-tunnel-identifier) > $@",
+    stamp = True,
+    tools = ["//scripts/saucelabs:extract-tunnel-identifier"],
+)

scripts/circleci/run-saucelabs-tests.sh

@@ -9,17 +9,20 @@ cd $(dirname ${0})/../..
 
 # Decode access token and make it accessible for child processes.
 export SAUCE_ACCESS_KEY=`echo ${SAUCE_ACCESS_KEY} | rev`
+export SAUCE_TUNNEL_IDENTIFIER="angular-material-${CIRCLE_BUILD_NUM}-${CIRCLE_NODE_INDEX}"
 
 # Start tunnel and wait for it being ready.
 ./scripts/saucelabs/start-tunnel.sh &
 ./scripts/saucelabs/wait-tunnel.sh
 
-# Setup the test platform environment variable that will be read
-# by the Karma configuration script.
-export TEST_PLATFORM="saucelabs"
+TEST_TARGETS=$(yarn -s bazel query --output label 'attr("tags", "saucelabs", //src/...)')
 
-# Run the unit tests on Saucelabs with Karma.
-yarn gulp ci:test
+# Run all Saucelabs test targets.
+yarn bazel test ${TEST_TARGETS} \
+  --workspace_status_command="echo SAUCE_TUNNEL_IDENTIFIER ${SAUCE_TUNNEL_IDENTIFIER}" \
+  --stamp \
+  --test_env=SAUCE_USERNAME \
+  --test_env=SAUCE_ACCESS_KEY
 
 # Kill the Saucelabs tunnel. This is necessary in order to avoid rate-limit
 # errors that cause the unit tests to be flaky.

scripts/saucelabs/BUILD.bazel

@@ -0,0 +1,6 @@
+package(default_visibility = ["//visibility:public"])
+
+sh_binary(
+    name = "extract-tunnel-identifier",
+    srcs = ["extract-tunnel-identifier.sh"],
+)

scripts/saucelabs/extract-tunnel-identifier.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+set -e -o pipefail
+
+volatile_status_key="bazel-out/volatile-status.txt"
+tunnel_key=$(cat ${volatile_status_key} | { grep SAUCE_TUNNEL_IDENTIFIER || echo ""; })
+
+if [[ -z "${tunnel_key}" ]]; then
+  echo "No tunnel identifier set as volatile status key."
+  exit 1
+fi
+
+echo ${tunnel_key} | cut -f2 -d ' '

scripts/saucelabs/start-tunnel.sh

@@ -29,8 +29,8 @@ rm ${tunnelFileName}
 # Command arguments that will be passed to sauce-connect.
 sauceArgs="--readyfile ${tunnelReadyFile} --pidfile ${tunnelPidFile}"
 
-if [ ! -z "${CIRCLE_BUILD_NUM}" ]; then
-  sauceArgs="${sauceArgs} --tunnel-identifier angular-material-${CIRCLE_BUILD_NUM}-${CIRCLE_NODE_INDEX}"
+if [ ! -z "${SAUCE_TUNNEL_IDENTIFIER}" ]; then
+  sauceArgs="${sauceArgs} --tunnel-identifier ${SAUCE_TUNNEL_IDENTIFIER}"
 fi
 
 echo "Starting Sauce Connect in the background. Passed arguments: ${sauceArgs}"

test/BUILD.bazel

@@ -3,7 +3,12 @@ load("//tools:defaults.bzl", "ts_library")
 
 package(default_visibility = ["//visibility:public"])
 
-exports_files(["bazel-karma-local-config.js"])
+exports_files([
+    "bazel-karma-local-config.js",
+    "karma-saucelabs.conf.js",
+    "browser-providers.js",
+    "karma-browsers.json",
+])
 
 # Common set-up for all Angular Material and CDK tests.
 ts_library(

test/karma-saucelabs.conf.js

@@ -0,0 +1,39 @@
+const {readFileSync} = require('fs');
+const {customLaunchers, platformMap} = require('./browser-providers');
+
+module.exports = karmaConfig => {
+  const config = {
+    plugins: [
+      require('karma-sauce-launcher')
+    ],
+    customLaunchers: customLaunchers,
+    sauceLabs: {
+      testName: 'Angular Material Unit Tests',
+      startConnect: false,
+      recordVideo: false,
+      recordScreenshots: false,
+      idleTimeout: 600,
+      commandTimeout: 600,
+      maxDuration: 5400,
+    },
+    browserNoActivityTimeout: 300000,
+    browserDisconnectTimeout: 180000,
+    browserDisconnectTolerance: 3,
+    captureTimeout: 180000,
+    browsers: platformMap.saucelabs,
+
+    // Try Websocket for a faster transmission first. Fallback to polling if necessary.
+    transports: ['websocket', 'polling'],
+  };
+
+  // The tunnel identifier has been written to a stamped genrule that access the tunnel
+  // identifier through a volatile status key. This ensures that test and build results
+  // are not invalidated whenever the tunnel identifier changes (which it does for each PR).
+  const tunnelIdentifier = readFileSync(
+      require.resolve('../saucelabs_tunnel_identifier.txt'), 'utf8');
+
+  config.sauceLabs.build = tunnelIdentifier;
+  config.sauceLabs.tunnelIdentifier = tunnelIdentifier;
+
+  karmaConfig.set(config);
+};

tools/defaults.bzl

@@ -182,6 +182,42 @@ def karma_web_test_suite(name, **kwargs):
         testonly = True,
     )
 
+    data = kwargs.get("data", [])
+    tags = kwargs.get("tags", [])
+
+    sauce_web_test_args = dict(**web_test_args)
+    sauce_web_test_args["data"] = sauce_web_test_args.get("data", []) + [
+      "//:saucelabs_tunnel_identifier",
+      "//test:browser-providers.js",
+      "//test:karma-browsers.json"
+    ]
+    sauce_web_test_args["deps"] = sauce_web_test_args.get("deps", []) + [
+      "@npm//karma-sauce-launcher"
+    ]
+
+    # Add a saucelabs target for these karma tests
+    _karma_web_test(
+        name = "%s_saucelabs_bin" % name,
+        timeout = "long",
+        config_file = "//test:karma-saucelabs.conf.js",
+        tags = ["manual"],
+        **sauce_web_test_args
+    )
+
+    # Workaround for: https://github.com/bazelbuild/rules_nodejs/issues/1429
+    native.sh_test(
+        name = "%s_saucelabs" % name,
+        srcs = ["%s_saucelabs_bin" % name],
+        tags = tags + [
+            "ibazel_notify_changes",
+            "exclusive",
+            "manual",
+            "no-remote-exec",
+            "saucelabs",
+        ],
+        testonly = True,
+    )
+
     # Default test suite with all configured browsers.
     _karma_web_test_suite(
         name = name,