Merge pull request #3649 from christiantjl:runtime_tests

copybara-github · copybara-github · commit 68b87f75eba4 · 2020-08-11T09:29:01.000-07:00
PiperOrigin-RevId: 326036575
diff --git a/package.json b/package.json
@@ -1,10 +1,31 @@
 {
   "name": "closure-compiler",
+  "config": {
+    "runtime_tests_dir": "./test/com/google/javascript/jscomp/runtime_tests"
+  },
   "version": "1.0.0",
   "repository": "git@github.com:google/closure-compiler.git",
   "license": "Apache-2",
   "private": true,
   "devDependencies": {
     "closure-compiler-npm": "google/closure-compiler-npm"
+  },
+  "dependencies": {
+    "chalk": "^4.1.0",
+    "future-event": "^1.5.0",
+    "glob": "^7.1.6",
+    "google-closure-library": "^20200719.0.0",
+    "jest": "^26.1.0",
+    "jsdom": "^16.3.0"
+  },
+  "scripts": {
+    "build": "clean && mvn -DskipTests",
+    "build:fast": "mvn -DskipTests -pl externs/pom.xml,pom-main.xml,pom-main-shaded.xml",
+    "clean": "yarn runtime_tests:clean && mvn clean",
+    "runtime_tests:build": "$npm_package_config_runtime_tests_dir/utils/build.sh",
+    "runtime_tests:clean": "rm -rf $npm_package_config_runtime_tests_dir/**/build/*",
+    "runtime_tests:run": "jest --testRegex $npm_package_config_runtime_tests_dir/utils/test/* --verbose=true",
+    "runtime_tests": "yarn runtime_tests:clean && yarn run --silent runtime_tests:build && yarn run --silent runtime_tests:run",
+    "test": "mvn test"
   }
 }
diff --git a/test/com/google/javascript/jscomp/runtime_tests/utils/build.sh b/test/com/google/javascript/jscomp/runtime_tests/utils/build.sh
@@ -0,0 +1,92 @@
+#!/bin/bash
+# Copyright 2020 Google Inc. All Rights Reserved
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+if [ -z $1 ]; then
+  COMPILATION_LEVEL="SIMPLE"
+else
+  COMPILATION_LEVEL=$1
+fi
+
+# This directory.
+THIS_DIR=$(dirname $0)
+
+# Location of project root.
+PROJECT_ROOT=$(readlink -f $THIS_DIR/../../../../../../..)
+
+# Get the location of the local compiler in this directory, if it exists.
+# If it doesn't, build it, then resume execution.
+LOCAL_COMPILER="$PROJECT_ROOT/target/closure-compiler-1.0-SNAPSHOT.jar"
+if [ ! -f "$LOCAL_COMPILER" ]; then
+  echo -e "\nCompiler JAR not built. Building...\n" && yarn build:fast
+fi
+
+# Build tests from the $TEST_DIR directory, where files like
+# `array_pattern_test.js` are stored.
+echo -e "\nBuilding runtime tests..."
+TEST_DIR="$THIS_DIR/.."
+
+# Get the absolute path of the test directory.
+ABS_PATH=$(readlink -f $TEST_DIR)
+
+compileRuntimeTests(){
+  local -i i=0
+  local file
+  for file in $@; do
+
+    # /path/to/file.js -> /path/to/file
+    local file_base=$(echo $file | rev | cut -f 2- -d '.' | rev)
+    # /path/to/file -> file
+    local test_name=$(basename $file_base)
+    # /path/to/file.ext -> /path/to
+    local test_loc=$(dirname $file)
+
+    # Make sure the build directory exists.
+    mkdir -p $test_loc/build
+
+    # Echo a percentage progress indicator.
+    ((i += 1))
+    echo " $((100 * $i / $#))% | $test_name"
+
+    # Output the test file, which will be executed in JSDOM.
+    cat > $test_loc/build/$test_name.html << EOF
+<html>
+<head>
+<title>$test_name</title>
+<script defer>
+$(
+  java -server -XX:+TieredCompilation \
+    -jar $LOCAL_COMPILER \
+    -O $COMPILATION_LEVEL \
+    --language_in ES_NEXT \
+    --language_out NO_TRANSPILE \
+    --process_common_js_modules \
+    --module_resolution NODE \
+    --dependency_mode PRUNE \
+    --js $PROJECT_ROOT/node_modules/google-closure-library/ \
+    --js $ABS_PATH/ \
+    --entry_point $file
+)
+</script>
+</head>
+</html>
+EOF
+
+  done
+}
+
+# build tests
+time(
+  compileRuntimeTests $(find $ABS_PATH -type f -name '*_test.js')
+)
diff --git a/test/com/google/javascript/jscomp/runtime_tests/utils/test/runAll.js b/test/com/google/javascript/jscomp/runtime_tests/utils/test/runAll.js
@@ -0,0 +1,140 @@
+/**
+ * @license MIT
+ *
+ * Copyright 2020 The Closure Compiler Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not
+ * use this file except in compliance with the License. You may obtain a copy of
+ * the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+ * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+ * License for the specific language governing permissions and limitations under
+ * the License.
+ */
+/**
+ * @fileoverview
+ * Crawl over all ../*_test.html files and execute them in a JSDOM context,
+ * fail the test if any do not succeed.
+ */
+
+const { JSDOM, VirtualConsole } = require('jsdom');
+const { fail } = require('assert');
+const chalk = require('chalk');
+const fs = require('fs');
+const FutureEvent = require('future-event');
+const glob = require('glob');
+const path = require('path');
+
+/**
+ * The absolute path of test.com.google.javascript.jscomp.runtime_tests.
+ */
+const RUNTIME_DIR = path.resolve(__dirname, '../..');
+
+/**
+ * All test files in the test.com.google.javascript.jscomp.runtime_tests.build
+ * directory.
+ */
+const TEST_FILES = glob.sync(
+    `${RUNTIME_DIR}/**/build/*_test.html`,
+);
+
+/**
+ * Iterate over all found test files and execute them in JSDOM.
+ */
+describe('Runtime tests', () => {
+  for (const testFile of TEST_FILES) {
+    const logs = [];
+    const passed = /PASSED/i;
+    const failed = /FAILED/i;
+
+    const allLogs = () => logs.join('\n');
+    const chalkMsg = (msg) => {
+      /**
+       * Check whether or not this message is a PASSED or FAILED message.
+       */
+      const isPass = passed.test(msg);
+      const isFail = failed.test(msg);
+
+      /**
+       * Highlight PASSED and FAILED in messages to help with accessibility.
+       */
+      return !(isPass || isFail)
+        ? msg
+        : msg
+            .replace(passed, chalk.green('PASSED'))
+            .replace(failed, chalk.red('FAILED'));
+    };
+
+    /**
+     * Get filename, i.e. /path/to/file.ext -> file.ext
+     */
+    const testName = path.basename(testFile);
+
+    /**
+     * A promise that will resolve when JSDOM is done executing.
+     */
+    const testIsFinished = new FutureEvent();
+
+    /**
+     * A virtual console which will receive messages from JSDOM's `console.log`.
+     */
+    const virtualConsole = new VirtualConsole()
+        .on('log', (msg) => {
+          logs.push(chalkMsg(msg));
+          if (/Tests complete/i.test(msg)) testIsFinished.ready(allLogs());
+          else if (/Tests failed/i.test(msg)) testIsFinished.cancel(allLogs());
+        });
+
+    /**
+     * Load the generated test file for consumption by the JSDOM environment.
+     * This will be a raw HTML document.
+     */
+    const testDocument = fs.readFileSync(
+        path.resolve(testFile),
+        'utf-8',
+    );
+
+    it(`should pass test suite ${path.basename(testFile)}`, async () => {
+      new JSDOM(testDocument, {
+        /**
+         * This does not actually run a server of any kind, it only informs the
+         * DOM what to put in `window.location.origin`. By default, this is
+         * `null`, which throws an "unsafe URL" error in the test suite. This is
+         * purely for accurately mocking a browser for `goog.testing.testsuite`
+         * tests, and any valid HTTPS URL will work here.
+         */
+        url: 'https://localhost:42',
+        /**
+         * This flag will allow the execution of `<script>` tags that are added
+         * to the DOM after the `onload` event, i.e., those that are added by
+         * `goog.module` and `goog.require`.
+         */
+        runScripts: 'dangerously',
+        /**
+         * Pipe `console.log` to our virtual console.
+         */
+        virtualConsole,
+      });
+
+      try {
+        /**
+         * Wait for test to finish, resume if no errors thrown.
+         */
+        await testIsFinished;
+      } catch (e) {
+        /**
+         * Print error and fail if any occurred.
+         */
+        fail(`Failed test in suite ${testName}: \n${e}\n`);
+      }
+      /**
+       * Otherwise, everything passed.
+       */
+      console.log(`Passed all tests in suite ${testName}`);
+    });
+  }
+});
diff --git a/travis_util/deploy_snapshot.sh b/travis_util/deploy_snapshot.sh
@@ -1,4 +1,17 @@
 #!/bin/bash
+# Copyright 2020 Google Inc. All Rights Reserved
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
 
 # see https://coderwall.com/p/9b_lfq
 
diff --git a/travis_util/test_npm.sh b/travis_util/test_npm.sh
@@ -1,4 +1,23 @@
 #!/bin/bash
+# Copyright 2020 Google Inc. All Rights Reserved
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS-IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Set build dir to current working dir if not set by Travis, just so it's easy
+# to locally run this script.
+if [ -z $TRAVIS_BUILD_DIR ]; then
+  TRAVIS_BUILD_DIR=`pwd`
+fi
 
 # Run yarn install so that dev dependencies are available
 yarn install && cd ${TRAVIS_BUILD_DIR}/node_modules/closure-compiler-npm && yarn install
