Migrate testing to rules-unit-testing

.github/CODEOWNERS

@@ -59,7 +59,7 @@ packages/auth  @bojeil-google @avolkovi @samhorlbeck @scottcrossen @firebase/jss
 packages/auth-types  @bojeil-google @avolkovi @samhorlbeck @scottcrossen @firebase/jssdk-global-approvers
 
 # Testing Code
-packages/testing  @avolkovi @samhorlbeck @scottcrossen @yuchenshi @firebase/jssdk-global-approvers
+packages/rules-unit-testing  @avolkovi @samhorlbeck @scottcrossen @yuchenshi @firebase/jssdk-global-approvers
 
 # RxFire Code
 packages/rxfire @davideast @jamesdaniels @firebase/jssdk-global-approvers

packages/testing/README.md → packages/rules-unit-testing/README.md

@@ -1,9 +1,9 @@
-# @firebase/testing
+# @firebase/rules-unit-testing
 
 A set of utilities useful for testing Security Rules with the Realtime Database or Cloud Firestore
 emulators.
 
 See:
 
   * [Test your Cloud Firestore Security Rules](https://firebase.google.com/docs/firestore/security/test-rules-emulator)
-  * [Testing Security Rules with the Realtime Database Emulator](https://firebase.google.com/docs/database/security/test-rules-emulator)
+  * [Testing Security Rules with the Realtime Database Emulator](https://firebase.google.com/docs/database/security/test-rules-emulator)

packages/testing/index.ts → packages/rules-unit-testing/index.ts

@@ -18,7 +18,7 @@
 /*
  * The testing module does not need to be registered since it should not ever
  * come by default. The only way to use the testing module is by explicitly
- * creating a dependency on @firebase/testing.
+ * creating a dependency on @firebase/rules-unit-testing.
  */
 
 export {

packages/testing/package.json → packages/rules-unit-testing/package.json

@@ -1,6 +1,6 @@
 {
-  "name": "@firebase/testing",
-  "version": "0.20.6",
+  "name": "@firebase/rules-unit-testing",
+  "version": "0.30.0",
   "description": "",
   "author": "Firebase <[email protected]> (https://firebase.google.com/)",
   "main": "dist/index.cjs.js",
@@ -10,7 +10,7 @@
   "files": ["dist"],
   "scripts": {
     "build": "rollup -c",
-    "build:deps": "lerna run --scope @firebase/testing --include-dependencies build",
+    "build:deps": "lerna run --scope @firebase/rules-unit-testing --include-dependencies build",
     "dev": "rollup -c -w",
     "test:nyc": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --config ../../config/mocharc.node.js",
     "test": "firebase emulators:exec 'yarn test:nyc'",
@@ -26,12 +26,16 @@
   },
   "devDependencies": {
     "@types/request": "2.48.5",
-    "firebase-tools": "8.5.0",
+    "firebase-tools": "^8.5.0",
+    "firebase-admin": "^9.0.0",
     "rollup": "2.21.0",
     "rollup-plugin-typescript2": "0.27.1"
   },
+  "peerDependencies": {
+    "firebase-admin": "^9.0.0"
+  },
   "repository": {
-    "directory": "packages/testing",
+    "directory": "packages/rules-unit-testing",
     "type": "git",
     "url": "https://github.com/firebase/firebase-js-sdk.git"
   },

packages/testing/src/api/index.ts → packages/rules-unit-testing/src/api/index.ts

@@ -26,28 +26,21 @@ import { Component, ComponentType } from '@firebase/component';
 export { database, firestore } from 'firebase';
 
 /** If this environment variable is set, use it for the database emulator's address. */
-const DATABASE_ADDRESS_ENV: string = 'FIREBASE_DATABASE_EMULATOR_ADDRESS';
+const DATABASE_ADDRESS_ENV: string = 'FIREBASE_DATABASE_EMULATOR_HOST';
 /** The default address for the local database emulator. */
 const DATABASE_ADDRESS_DEFAULT: string = 'localhost:9000';
-/** The actual address for the database emulator */
-const DATABASE_ADDRESS: string =
-  process.env[DATABASE_ADDRESS_ENV] || DATABASE_ADDRESS_DEFAULT;
 
 /** If any of environment variable is set, use it for the Firestore emulator. */
-const FIRESTORE_ADDRESS_ENVS: string[] = [
-  'FIRESTORE_EMULATOR_HOST',
-  'FIREBASE_FIRESTORE_EMULATOR_ADDRESS'
-];
+const FIRESTORE_ADDRESS_ENV: string = 'FIRESTORE_EMULATOR_HOST';
 /** The default address for the local Firestore emulator. */
 const FIRESTORE_ADDRESS_DEFAULT: string = 'localhost:8080';
+
+/** The actual address for the database emulator */
+let _databaseHost: string | undefined = undefined;
+
 /** The actual address for the Firestore emulator */
-const FIRESTORE_ADDRESS: string = FIRESTORE_ADDRESS_ENVS.reduce(
-  (addr, name) => process.env[name] || addr,
-  FIRESTORE_ADDRESS_DEFAULT
-);
+let _firestoreHost: string | undefined = undefined;
 
-/** Passing this in tells the emulator to treat you as an admin. */
-const ADMIN_TOKEN = 'owner';
 /** Create an unsecured JWT for the given auth payload. See https://tools.ietf.org/html/rfc7519#section-6. */
 function createUnsecuredJwt(auth: object): string {
   // Unsecured JWTs use "none" as the algorithm.
@@ -95,23 +88,84 @@ export type AdminAppOptions = {
 };
 /** Construct an App authenticated as an admin user. */
 export function initializeAdminApp(options: AdminAppOptions): firebase.app.App {
-  return initializeApp(ADMIN_TOKEN, options.databaseName, options.projectId);
+  const admin = require('firebase-admin');
+
+  const app = admin.initializeApp(
+    getAppOptions(options.databaseName, options.projectId),
+    getRandomAppName()
+  );
+
+  if (options.projectId) {
+    app.firestore().settings({
+      host: getFirestoreHost(),
+      ssl: false
+    });
+  }
+
+  return app;
 }
 
-function initializeApp(
-  accessToken?: string,
+function getDatabaseHost() {
+  if (!_databaseHost) {
+    const fromEnv = process.env[DATABASE_ADDRESS_ENV];
+    if (fromEnv) {
+      _databaseHost = fromEnv;
+    } else {
+      console.warn(
+        `Warning: ${DATABASE_ADDRESS_ENV} not set, using default value ${DATABASE_ADDRESS_DEFAULT}`
+      );
+      _databaseHost = DATABASE_ADDRESS_DEFAULT;
+    }
+  }
+
+  return _databaseHost;
+}
+
+function getFirestoreHost() {
+  if (!_firestoreHost) {
+    const fromEnv = process.env[FIRESTORE_ADDRESS_ENV];
+    if (fromEnv) {
+      _firestoreHost = fromEnv;
+    } else {
+      console.warn(
+        `Warning: ${FIRESTORE_ADDRESS_ENV} not set, using default value ${FIRESTORE_ADDRESS_DEFAULT}`
+      );
+      _firestoreHost = FIRESTORE_ADDRESS_DEFAULT;
+    }
+  }
+
+  return _firestoreHost;
+}
+
+function getRandomAppName(): string {
+  return 'app-' + new Date().getTime() + '-' + Math.random();
+}
+
+function getAppOptions(
   databaseName?: string,
   projectId?: string
-): firebase.app.App {
+): { [key: string]: string } {
   let appOptions: { [key: string]: string } = {};
+
   if (databaseName) {
-    appOptions['databaseURL'] = `http://${DATABASE_ADDRESS}?ns=${databaseName}`;
+    appOptions[
+      'databaseURL'
+    ] = `http://${getDatabaseHost()}?ns=${databaseName}`;
   }
   if (projectId) {
     appOptions['projectId'] = projectId;
   }
-  const appName = 'app-' + new Date().getTime() + '-' + Math.random();
-  let app = firebase.initializeApp(appOptions, appName);
+
+  return appOptions;
+}
+
+function initializeApp(
+  accessToken?: string,
+  databaseName?: string,
+  projectId?: string
+): firebase.app.App {
+  const appOptions = getAppOptions(databaseName, projectId);
+  const app = firebase.initializeApp(appOptions, getRandomAppName());
   if (accessToken) {
     const mockAuthComponent = new Component(
       'auth-internal',
@@ -141,7 +195,7 @@ function initializeApp(
   }
   if (projectId) {
     app.firestore().settings({
-      host: FIRESTORE_ADDRESS,
+      host: getFirestoreHost(),
       ssl: false
     });
   }
@@ -171,7 +225,9 @@ export function loadDatabaseRules(
   return new Promise((resolve, reject) => {
     request.put(
       {
-        uri: `http://${DATABASE_ADDRESS}/.settings/rules.json?ns=${options.databaseName}`,
+        uri: `http://${getDatabaseHost()}/.settings/rules.json?ns=${
+          options.databaseName
+        }`,
         headers: { Authorization: 'Bearer owner' },
         body: options.rules
       },
@@ -206,7 +262,9 @@ export function loadFirestoreRules(
   return new Promise((resolve, reject) => {
     request.put(
       {
-        uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}:securityRules`,
+        uri: `http://${getFirestoreHost()}/emulator/v1/projects/${
+          options.projectId
+        }:securityRules`,
         body: JSON.stringify({
           rules: {
             files: [{ content: options.rules }]
@@ -240,7 +298,9 @@ export function clearFirestoreData(
   return new Promise((resolve, reject) => {
     request.delete(
       {
-        uri: `http://${FIRESTORE_ADDRESS}/emulator/v1/projects/${options.projectId}/databases/(default)/documents`,
+        uri: `http://${getFirestoreHost()}/emulator/v1/projects/${
+          options.projectId
+        }/databases/(default)/documents`,
         body: JSON.stringify({
           database: `projects/${options.projectId}/databases/(default)`
         })
@@ -261,9 +321,23 @@ export function clearFirestoreData(
 
 export function assertFails(pr: Promise<any>): any {
   return pr.then(
-    v =>
-      Promise.reject(new Error('Expected request to fail, but it succeeded.')),
-    err => err
+    (v: any) => {
+      return Promise.reject(
+        new Error('Expected request to fail, but it succeeded.')
+      );
+    },
+    (err: any) => {
+      const isPermissionDenied =
+        err && err.message && err.message.indexOf('PERMISSION_DENIED') >= 0;
+      if (!isPermissionDenied) {
+        return Promise.reject(
+          new Error(
+            `Expected PERMISSION_DENIED but got unexpected error: ${err}`
+          )
+        );
+      }
+      return err;
+    }
   );
 }
 

packages/testing/test/database.test.ts → packages/rules-unit-testing/test/database.test.ts

@@ -42,18 +42,29 @@ describe('Testing Module Tests', function () {
       .catch(() => {});
   });
 
-  it('assertFails() iff failure', async function () {
+  it('assertFails() iff PERMISSION_DENIED', async function () {
     const success = Promise.resolve('success');
-    const failure = Promise.reject('failure');
+    const permissionDenied = Promise.reject({
+      message: 'PERMISSION_DENIED'
+    });
+    const otherFailure = Promise.reject('failure');
     await firebase
       .assertFails(success)
       .then(() => {
         throw new Error('Expected success to fail.');
       })
       .catch(() => {});
-    await firebase.assertFails(failure).catch(() => {
-      throw new Error('Expected failure to succeed.');
+
+    await firebase.assertFails(permissionDenied).catch(() => {
+      throw new Error('Expected permissionDenied to succeed.');
     });
+
+    await firebase
+      .assertFails(otherFailure)
+      .then(() => {
+        throw new Error('Expected otherFailure to fail.');
+      })
+      .catch(() => {});
   });
 
   it('initializeTestApp() with auth=null does not set access token', async function () {