[WIP] onUpdate, onDelete & onCreate tests in .ts

Author: jfocco

functions/.runtimeconfig.json

@@ -0,0 +1,13 @@
+{
+  "env": {
+    "testingConfig": {
+      "projectId": "react-firebase-admin-eeac2",
+      "serviceAccountKey": "../serviceAccountKey.json",
+      "storageBucket": "react-firebase-admin-eeac2.appspot.com",
+      "databaseURL": "https://react-firebase-admin-eeac2.firebaseio.com"
+    }
+  },
+  "signinlink": {
+    "url": "https://react-firebase-admin-eeac2.firebaseapp.com/login"
+  }
+}

functions/env.json

@@ -0,0 +1,8 @@
+{
+  "testingConfig": {
+    "databaseURL": "https://react-firebase-admin-eeac2.firebaseio.com",
+    "storageBucket": "react-firebase-admin-eeac2.appspot.com",
+    "projectId": "react-firebase-admin-eeac2",
+    "serviceAccountKey": "../serviceAccountKey.json"
+  }
+}

functions/package.json

@@ -9,7 +9,7 @@
     "deploy": "firebase deploy --only functions",
     "logs": "firebase functions:log",
     "setup-firebase": "node setupProject.js",
-    "test": "mocha --reporter spec  --timeout 10000"
+    "test": "mocha -r ts-node/register test/**/*.test.ts --timeout 10000"
   },
   "engines": {
     "node": "10"
@@ -26,7 +26,13 @@
     "camelcase": "^5.3.1"
   },
   "devDependencies": {
+    "@types/chai": "^4.2.11",
+    "@types/chai-as-promised": "^7.1.2",
+    "@types/mocha": "^7.0.2",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
     "mocha": "^7.2.0",
+    "ts-node": "^8.10.2",
     "tslint": "^5.12.0",
     "typescript": "^3.8.0"
   },

functions/test/createUser.test.ts

@@ -0,0 +1,39 @@
+import { test } from './util/admin';
+import { https } from 'firebase-functions';
+import * as chai from 'chai';
+import 'mocha';
+
+describe('onCreateUser', () => {
+  let onCreateUser: any;
+
+  before(async () => {
+    onCreateUser = require('../src/https/createUser.function');
+  });
+
+  it('should throw an error because the email is not provided', () => {
+    const wrapped = test.wrap(onCreateUser);
+
+    const data = {
+      email: '',
+      isAdmin: false
+    };
+
+    return wrapped(data).then(() => {
+      chai.expect(https.HttpsError, 'auth/invalid-email');
+    });
+  });
+
+  it('should create the user into the database', () => {
+    const wrapped = test.wrap(onCreateUser);
+
+    const data = {
+      uid: '1234',
+      email: 'user@example.com',
+      isAdmin: false
+    };
+
+    return wrapped(data).then((res: any) => {
+      chai.assert.equal(data.uid, res.uid);
+    });
+  });
+});

functions/test/index.test.js

@@ -0,0 +1,41 @@
+import { admin, test } from './util/admin';
+import * as chai from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+import 'mocha';
+
+chai.use(chaiAsPromised);
+
+describe('onDelete', () => {
+  let onDelete: any;
+  let userRecord: any;
+
+  before(async () => {
+    const user = {
+      uid: '1234',
+      email: 'user@example.com',
+      password: 'secretPassword'
+    };
+    onDelete = require('../src/db/users/onDelete.function');
+    userRecord = await admin.auth().createUser(user);
+  });
+
+  it('should delete the user from the authentication section', () => {
+    const wrapped = test.wrap(onDelete);
+
+    return wrapped(
+      {},
+      {
+        params: {
+          uid: userRecord.uid
+        }
+      }
+    ).then(async () => {
+      await chai
+        .expect(admin.auth().getUser(userRecord.uid))
+        .to.be.rejectedWith(
+          Error,
+          'There is no user record corresponding to the provided identifier.'
+        );
+    });
+  });
+});

functions/test/onDelete.test.ts

@@ -0,0 +1,56 @@
+import { admin, test } from './util/admin';
+import * as chai from 'chai';
+import 'mocha';
+
+describe('onUpdate', () => {
+  let onUpdate: any;
+  let userRecord: any;
+
+  before(async () => {
+    onUpdate = require('../src/db/users/onUpdate.function');
+
+    const user = {
+      uid: '1234',
+      email: 'user@example.com',
+      password: 'secretPassword'
+    };
+    const customClaims = {
+      isAdmin: false
+    };
+
+    userRecord = await admin.auth().createUser(user);
+    await admin.auth().setCustomUserClaims(userRecord.uid, customClaims);
+  });
+
+  after(async () => {
+    await admin.auth().deleteUser(userRecord.uid);
+  });
+
+  it('should update the user information in the database', () => {
+    const wrapped = test.wrap(onUpdate);
+
+    const beforeSnap = test.database.makeDataSnapshot(
+      { email: 'user@example.com', isAdmin: false },
+      `users/${userRecord.uid}`
+    );
+    const afterSnap = test.database.makeDataSnapshot(
+      { email: 'user@example.com', isAdmin: true },
+      `users/${userRecord.uid}`
+    );
+
+    const change = test.makeChange(beforeSnap, afterSnap);
+
+    return wrapped(change, {
+      params: {
+        uid: userRecord.uid
+      }
+    }).then(() => {
+      return admin
+        .auth()
+        .getUser(userRecord.uid)
+        .then(snap => {
+          chai.assert.isTrue(snap.customClaims!.isAdmin);
+        });
+    });
+  });
+});

functions/test/onUpdate.test.ts

@@ -0,0 +1,17 @@
+import * as functions from 'firebase-functions';
+import * as testConfig from 'firebase-functions-test';
+import * as admin from 'firebase-admin';
+
+const config = functions.config().env.testingConfig;
+
+const projectConfig = {
+  databaseURL: config.databaseURL,
+  storageBucket: config.storageBucket,
+  projectId: config.projectId
+};
+
+const test = testConfig(projectConfig, config.serviceAccountKey);
+
+admin.initializeApp();
+
+export { admin, test };