Add test runner script

Author: schmidt-sebastian

packages/firestore/exp-types/index.d.ts

@@ -374,9 +374,7 @@ export function getDocFromServer<T>(
   reference: DocumentReference<T>
 ): Promise<DocumentSnapshot<T>>;
 export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
-export function getDocsFromCache<T>(
-  query: Query<T>
-): Promise<QuerySnapshot<T>>;
+export function getDocsFromCache<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 export function getDocsFromServer<T>(
   query: Query<T>
 ): Promise<QuerySnapshot<T>>;

packages/firestore/package.json

@@ -23,22 +23,22 @@
     "gendeps:exp": "../../scripts/exp/extract-deps.sh --types ./exp-types/index.d.ts --bundle ./dist/exp/tmp.js --output ./exp/dependencies.json",
     "pregendeps:lite": "node scripts/build-bundle.js --input ./lite/index.ts --output ./dist/lite/tmp.js",
     "gendeps:lite": "../../scripts/exp/extract-deps.sh --types ./lite-types/index.d.ts --bundle ./dist/lite/tmp.js --output ./lite/dependencies.json",
-    "test:lite": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'lite/test/**/*.test.ts' --require ts-node/register --file lite/index.ts --config ../../config/mocharc.node.js",
+    "test:lite":"node ./scripts/run-tests.js --emulator --main=lite/index.ts  'lite/test/**/*.test.ts'",
     "test:lite:browser": "karma start --single-run --lite",
     "test:lite:browser:debug": "karma start --single-run --lite --auto-watch",
-    "test:exp": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/integration/api/*.test.ts' --file exp/index.ts --config ../../config/mocharc.node.js",
-    "test:exp:persistence": "USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/integration/api/*.test.ts' --require ts-node/register --require exp/index.ts --require test/util/node_persistence.ts  --config ../../config/mocharc.node.js",
+    "test:exp": "node ./scripts/run-tests.js --emulator --main=exp/index.ts test/integration/api/*.test.ts",
+    "test:exp:persistence":"node ./scripts/run-tests.js --emulator --persistence --main=exp/index.ts test/integration/api/*.test.ts",
     "test:exp:browser": "karma start --single-run --exp",
     "test:exp:browser:debug": "karma start --single-run --exp --auto-watch",
     "test": "run-s lint test:all",
     "test:ci": "node ../../scripts/run_tests_in_ci.js",
     "test:all": "run-p test:browser test:lite:browser test:exp:browser test:travis test:minified test:exp test:lite",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
-    "test:node": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --config ../../config/mocharc.node.js",
-    "test:node:prod": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --config ../../config/mocharc.node.js",
-    "test:node:persistence": "FIRESTORE_EMULATOR_PORT=8080 FIRESTORE_EMULATOR_PROJECT_ID=test-emulator USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --config ../../config/mocharc.node.js",
-    "test:node:persistence:prod": "USE_MOCK_PERSISTENCE=YES TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --require ts-node/register --require index.node.ts --require test/util/node_persistence.ts --config ../../config/mocharc.node.js",
+    "test:node": "node ./scripts/run-tests.js  --main=index.node.ts  --emulator 'test/{,!(browser)/**/}*.test.ts'",
+    "test:node:prod": "node ./scripts/run-tests.js --main=index.node.ts 'test/{,!(browser)/**/}*.test.ts'",
+    "test:node:persistence": "node ./scripts/run-tests.js  --main=index.node.ts --persistence --emulator 'test/{,!(browser)/**/}*.test.ts'",
+    "test:node:persistence:prod": "node ./scripts/run-tests.js --main=index.node.ts --persistence 'test/{,!(browser)/**/}*.test.ts'",
     "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
     "test:minified": "(cd ../../integration/firestore ; yarn test)",
     "prepare": "yarn build:release"

packages/firestore/scripts/build-bundle.js

@@ -154,7 +154,7 @@ var rollup_1 = require('rollup');
 var typescriptPlugin = require('rollup-plugin-typescript2');
 var alias = require('@rollup/plugin-alias');
 var json = require('rollup-plugin-json');
-var rollup_shared_1 = require('../rollup.shared');
+var util = require('../rollup.shared');
 var argv = yargs.options({
   input: {
     type: 'string',
@@ -185,18 +185,18 @@ function buildBundle(input, output) {
             rollup_1.rollup({
               input: input,
               plugins: [
-                alias(rollup_shared_1.generateAliasConfig('node')),
+                alias(util.generateAliasConfig('node')),
                 typescriptPlugin({
                   tsconfigOverride: {
                     compilerOptions: {
                       target: 'es2017'
                     }
                   },
-                  transformers: rollup_shared_1.removeAssertTransformer
+                  transformers: util.removeAssertTransformer
                 }),
                 json({ preferConst: true })
               ],
-              external: rollup_shared_1.resolveNodeExterns
+              external: util.resolveNodeExterns
             })
           ];
         case 1:
@@ -209,4 +209,5 @@ function buildBundle(input, output) {
     });
   });
 }
+// eslint-disable-next-line @typescript-eslint/no-floating-promises
 buildBundle(argv.input, argv.output);

packages/firestore/scripts/extract-api.js

@@ -17,7 +17,6 @@
  */
 exports.__esModule = true;
 exports.extractPublicIdentifiers = void 0;
-// eslint-disable-next-line import/no-extraneous-dependencies
 var ts = require('typescript');
 var fs = require('fs');
 function extractIdentifiersFromNodeAndChildren(node, symbols) {

packages/firestore/scripts/remove-asserts.js

@@ -17,7 +17,6 @@
  */
 exports.__esModule = true;
 exports.removeAsserts = void 0;
-// eslint-disable-next-line import/no-extraneous-dependencies
 var ts = require('typescript');
 // Location of file that includes the asserts
 var ASSERT_LOCATION = 'packages/firestore/src/util/assert.ts';

packages/firestore/scripts/rename-internals.js

@@ -17,7 +17,6 @@
  */
 exports.__esModule = true;
 exports.renameInternals = void 0;
-// eslint-disable-next-line import/no-extraneous-dependencies
 var ts = require('typescript');
 // `undefined` is treated as an identifier by TSC, but not part of any externs.
 var blacklist = ['undefined'];

packages/firestore/scripts/run-tests.js

@@ -0,0 +1,86 @@
+'use strict';
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+var __assign =
+  (this && this.__assign) ||
+  function () {
+    __assign =
+      Object.assign ||
+      function (t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+          s = arguments[i];
+          for (var p in s)
+            if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+      };
+    return __assign.apply(this, arguments);
+  };
+exports.__esModule = true;
+var yargs = require('yargs');
+var path_1 = require('path');
+var child_process_promise_1 = require('child-process-promise');
+var argv = yargs.options({
+  main: {
+    type: 'string',
+    demandOption: true
+  },
+  emulator: {
+    type: 'boolean'
+  },
+  persistence: {
+    type: 'boolean'
+  }
+}).argv;
+var nyc = path_1.resolve(__dirname, '../../../node_modules/.bin/nyc');
+var mocha = path_1.resolve(__dirname, '../../../node_modules/.bin/mocha');
+var env = __assign(__assign({}, process.env), {
+  TS_NODE_CACHE: 'NO',
+  TS_NODE_COMPILER_OPTIONS: '{"module":"commonjs"}'
+});
+var args = [
+  mocha,
+  '--require',
+  'ts-node/register',
+  '--require',
+  argv.main,
+  '--config',
+  '../../config/mocharc.node.js'
+];
+if (argv.emulator) {
+  env.FIRESTORE_EMULATOR_PORT = '8080';
+  env.FIRESTORE_EMULATOR_PROJECT_ID = 'test-emulator';
+}
+if (argv.persistence) {
+  env.USE_MOCK_PERSISTENCE = 'YES';
+  args.push('--require', 'test/util/node_persistence.ts');
+}
+args = args.concat(argv._);
+var childProcess = child_process_promise_1.spawn(nyc, args, {
+  stdio: 'inherit',
+  env: env,
+  cwd: process.cwd()
+}).childProcess;
+process.once('exit', function () {
+  return childProcess.kill();
+});
+process.once('SIGINT', function () {
+  return childProcess.kill('SIGINT');
+});
+process.once('SIGTERM', function () {
+  return childProcess.kill('SIGTERM');
+});

packages/firestore/scripts/run-tests.ts

@@ -0,0 +1,74 @@
+/**
+ * @license
+ * Copyright 2020 Google LLC
+ *
+ * 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.
+ */
+
+import * as yargs from 'yargs';
+import { resolve } from 'path';
+import { spawn } from 'child-process-promise';
+
+const argv = yargs.options({
+  main: {
+    type: 'string',
+    demandOption: true
+  },
+  emulator: {
+    type: 'boolean'
+  },
+  persistence: {
+    type: 'boolean'
+  }
+}).argv;
+
+const nyc = resolve(__dirname, '../../../node_modules/.bin/nyc');
+const mocha = resolve(__dirname, '../../../node_modules/.bin/mocha');
+
+const env: { [key: string]: string } = {
+  ...process.env,
+  TS_NODE_CACHE: 'NO',
+  TS_NODE_COMPILER_OPTIONS: '{"module":"commonjs"}'
+};
+
+let args = [
+  mocha,
+  '--require',
+  'ts-node/register',
+  '--require',
+  argv.main,
+  '--config',
+  '../../config/mocharc.node.js'
+];
+
+if (argv.emulator) {
+  env.FIRESTORE_EMULATOR_PORT = '8080';
+  env.FIRESTORE_EMULATOR_PROJECT_ID = 'test-emulator';
+}
+
+if (argv.persistence) {
+  env.USE_MOCK_PERSISTENCE = 'YES';
+  args.push('--require', 'test/util/node_persistence.ts');
+}
+
+args = args.concat(argv._);
+
+const childProcess = spawn(nyc, args, {
+  stdio: 'inherit',
+  env,
+  cwd: process.cwd()
+}).childProcess;
+
+process.once('exit', () => childProcess.kill());
+process.once('SIGINT', () => childProcess.kill('SIGINT'));
+process.once('SIGTERM', () => childProcess.kill('SIGTERM'));