Add Firestore Integration Tests (#163)

Author: abeisgoat

.npmrc

@@ -0,0 +1 @@
+package-lock=false

integration_test/firebase.json

@@ -1,5 +1,9 @@
 {
   "database": {
     "rules": "database.rules.json"
+  },
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
   }
 }

integration_test/firestore.indexes.json

@@ -0,0 +1,3 @@
+{
+  "indexes": []
+}

integration_test/firestore.rules

@@ -0,0 +1,7 @@
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /{document=**} {
+      allow read, write: if request.auth != null;
+    }
+  }
+}

integration_test/functions/.npmrc

@@ -0,0 +1 @@
+package-lock=false

integration_test/functions/package.json

@@ -8,9 +8,8 @@
     "@google-cloud/pubsub": "^0.6.0",
     "@types/lodash": "^4.14.41",
     "firebase": ">3.6.9",
-    "firebase-admin": ">4.1.1",
+    "firebase-admin": "https://storage.googleapis.com/functions-dev-preview/firebase-admin-5.4.0-rc5.tgz",
     "firebase-functions": "./firebase-functions.tgz",
-    "loadash": "^0.0.1",
     "lodash": "^4.17.2"
   },
   "main": "lib/index.js",

integration_test/functions/src/firestore-tests.ts

@@ -0,0 +1,31 @@
+import * as functions from 'firebase-functions';
+import { TestSuite, expectEq, expectDeepEq } from './testing';
+
+const testIdFieldName = 'documentId';
+
+export const firestoreTests: any = functions.firestore.document('tests/{documentId}').onCreate(receivedEvent => {
+  return new TestSuite('firestore document onWrite')
+
+    .it('should not have event.app', event => !event.app)
+
+    .it('should give refs write access', event =>
+      event.data.ref.set({ allowed: 1 }, {merge: true}).then(() => true))
+
+    .it('should have well-formatted resource', event => expectEq(
+      event.resource,
+      `projects/${process.env.GCLOUD_PROJECT}/databases/(default)/documents/tests/${event.params.documentId}`)
+    )
+
+    .it('should have the right eventType', event => expectEq(
+      event.eventType, 'providers/cloud.firestore/eventTypes/document.create'))
+
+    .it('should have eventId', event => event.eventId)
+
+    .it('should have timestamp', event => event.timestamp)
+
+    .it('should have the correct data', event => expectDeepEq(event.data.data(), {test: event.params.documentId}))
+
+    .it('previous should be null', event => expectEq(event.data.previous, null))
+
+    .run(receivedEvent.params[testIdFieldName], receivedEvent);
+});

integration_test/functions/src/index.ts

@@ -7,6 +7,7 @@ import { Request, Response } from 'express';
 export * from './pubsub-tests';
 export * from './database-tests';
 export * from './auth-tests';
+export * from './firestore-tests';
 const numTests = Object.keys(exports).length;  // Assumption: every exported function is its own test.
 
 firebase.initializeApp(_.omit(functions.config().firebase, 'credential'));  // Explicitly decline admin privileges.
@@ -16,7 +17,6 @@ export const integrationTests: any = functions.https.onRequest((req: Request, re
   let pubsub: any = require('@google-cloud/pubsub')();
 
   const testId = firebase.database().ref().push().key;
-
   return Promise.all([
     // A database write to trigger the Firebase Realtime Database tests.
     // The database write happens without admin privileges, so that the triggered function's "event.data.ref" also
@@ -33,6 +33,8 @@ export const integrationTests: any = functions.https.onRequest((req: Request, re
       // A user deletion to trigger the Firebase Auth user deletion tests.
       admin.auth().deleteUser(userRecord.uid);
     }),
+    // A firestore write to trigger the Cloud Firestore tests.
+    admin.firestore().collection('tests').doc(testId).set({test: testId}),
   ]).then(() => {
     // On test completion, check that all tests pass and reply "PASS", or provide further details.
     console.log('Waiting for all tests to report they pass...');

integration_test/functions/src/testing.ts

@@ -1,4 +1,5 @@
 import * as firebase from 'firebase-admin';
+import * as _ from 'lodash';
 
 export type TestCase = (event) => any
 export type TestCaseMap = { [key: string]: TestCase };
@@ -68,6 +69,12 @@ export function expectEq(left, right) {
     JSON.stringify(left) + ' does not equal ' + JSON.stringify(right));
 }
 
+export function expectDeepEq(left, right) {
+  return evaluate(
+    _.isEqual(left, right),
+    JSON.stringify(left) + ' does not equal ' + JSON.stringify(right));
+}
+
 export function expectMatches(input: string, regexp) {
   return evaluate(
     input.match(regexp),

integration_test/run_tests.sh

@@ -48,7 +48,8 @@ function deploy {
   announce "Deploying functions..."
   cd $DIR
   ./functions/node_modules/.bin/tsc -p functions/
-  firebase deploy --project=$PROJECT_ID --only functions,database
+  # Deploy functions, and security rules for database and Firestore
+  firebase deploy --project=$PROJECT_ID --only functions,database,firestore
 }
 
 function run_tests {