Make running against the emulator the default for Firestore integration tests (#1995)

Author: Brian Chen

packages/firestore/CONTRIBUTING.md

@@ -5,7 +5,9 @@ contributing to the Firebase JavaScript SDK (including Cloud Firestore).
 Follow instructions there to install dependencies, build the SDK, and set up
 the testing environment.
 
-## Setting up a project for testing
+## Integration Testing
+
+### Setting up a project for testing
 
 You will need a production project to test the Firestore SDK. You can create
 a new project by visiting the 
@@ -16,10 +18,28 @@ See
 [Automated Setup](https://github.com/firebase/firebase-js-sdk#automated-setup) 
 for more details.
 
+### Setting up the Firestore emulator
+
+The integration tests require that the Firestore emulator is running
+on port 8080, which is default when running it via CLI.
+
+  * [Install the Firebase CLI](https://firebase.google.com/docs/cli/).
+    ```
+    npm install -g firebase-tools
+    ```
+  * [Install the Firestore
+    emulator](https://firebase.google.com/docs/firestore/security/test-rules-emulator#install_the_emulator).
+    ```
+    firebase setup:emulators:firestore
+    ```
+  * Run the emulator
+    ```
+    firebase serve --only firestore
+    ```
 
-## Running Firestore Tests
+### Running Firestore Tests
 
-All commands must be run from this `packages/firestore/` directory.
+All commands must be run from the `packages/firestore/` directory. 
 
 ```
 # Come up to date on dependencies after performing git pull
@@ -43,7 +63,14 @@ yarn test:browser --integration
 # localhost:8080.
 yarn test:browser --integration --local
 
+# Run all node tests once (unit and integration) against the emulator.
+yarn test:node
+
 # Run a subset of tests whose names match a filter.
 yarn test:browser --grep 'SortedSet keeps elements in the right order'
 yarn test:node --grep 'SortedSet keeps elements in the right order'
+
+# Run tests against the production backend.
+yarn test:node:prod
+yarn test:node:persistence:prod
 ```

packages/firestore/package.json

@@ -11,12 +11,14 @@
     "lint:fix": "eslint --fix -c .eslintrc.json '**/*.ts' --ignore-path '../../.gitignore'",
     "prettier": "prettier --write 'src/**/*.js' 'test/**/*.js' 'src/**/*.ts' 'test/**/*.ts'",
     "test": "run-s lint test:all",
-    "test:all": "run-p test:browser test:emulator",
+    "test:all": "run-p test:browser test:travis",
     "test:browser": "karma start --single-run",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
-    "test:node": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
-    "test:node:persistence": "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 --opts ../../config/mocha.node.opts",
-    "test:emulator": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
+    "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 --opts ../../config/mocha.node.opts",
+    "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 --opts ../../config/mocha.node.opts",
+    "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 --opts ../../config/mocha.node.opts",
+    "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 --opts ../../config/mocha.node.opts",
+    "test:travis": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/firestore-test-runner.ts",
     "prepare": "yarn build"
   },
   "main": "dist/index.node.cjs.js",

scripts/emulator-testing/firestore-test-runner.ts

@@ -35,7 +35,8 @@ function runTest(port: number, projectId: string): ChildProcessPromise {
   };
   // TODO(b/113267261): Include browser test once WebChannel support is
   // ready in Firestore emulator.
-  return spawn('yarn', ['test:node'], options);
+  // Use test:node:prod to allow runner's env var overrides to work.
+  return spawn('yarn', ['test:node:prod'], options);
 }
 
 async function run(): Promise<void> {