Foundation for integration tests for auth-exp (#3453)

* Add integration test foundation

* Formatting

* Update to use a describe wrapper instead

* Formatting

* PR feedback

* Removed custom describe

* Formatting

Author: sam-gc

packages-exp/auth-exp/karma.conf.js

@@ -16,13 +16,12 @@
  */
 
 const karmaBase = require('../../config/karma.base');
-
-const files = ['src/**/*.test.ts', 'test/**/*.test.ts'];
+const { argv } = require('yargs');
 
 module.exports = function(config) {
   const karmaConfig = Object.assign({}, karmaBase, {
     // files to load into karma
-    files: files,
+    files: getTestFiles(argv),
     preprocessors: { '**/*.ts': ['webpack', 'sourcemap'] },
     // frameworks to use
     // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
@@ -32,4 +31,14 @@ module.exports = function(config) {
   config.set(karmaConfig);
 };
 
-module.exports.files = files;
+function getTestFiles(argv) {
+  if (argv.unit) {
+    return ['src/**/*.test.ts', 'test/helpers/**/*.test.ts'];
+  } else if (argv.integration) {
+    return ['test/integration/**/*.test.ts'];
+  } else {
+    return ['src/**/*.test.ts', 'test/**/*.test.ts'];
+  }
+}
+
+module.exports.files = getTestFiles(argv);

packages-exp/auth-exp/package.json

@@ -21,7 +21,9 @@
     "dev": "rollup -c -w",
     "test": "yarn type-check && run-p lint test:browser",
     "test:browser": "karma start --single-run",
-    "test:browser:debug": "karma start",
+    "test:browser:unit": "karma start --single-run --unit",
+    "test:browser:integration": "karma start --single-run --integration",
+    "test:browser:debug": "karma start --auto-watch",
     "test:node": "TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha src/**/*.test.* --opts ../../config/mocha.node.opts",
     "type-check": "tsc -p . --noEmit",
     "prepare": "yarn build",
@@ -40,8 +42,8 @@
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@rollup/plugin-strip": "^1.3.2",
     "@firebase/app-exp": "0.x",
+    "@rollup/plugin-strip": "^1.3.2",
     "rollup": "1.32.1",
     "rollup-plugin-json": "4.0.0",
     "rollup-plugin-replace": "2.2.0",

packages-exp/auth-exp/test/helpers/integration/helpers.ts

@@ -0,0 +1,88 @@
+/**
+ * @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 { deleteApp, initializeApp } from '@firebase/app-exp';
+import { initializeAuth } from '@firebase/auth-exp/index.browser';
+import { Auth, User } from '@firebase/auth-types-exp';
+
+import { _generateEventId } from '../../../src/core/util/event_id';
+
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const PROJECT_CONFIG = require('../../../../../config/project.json');
+
+export const PROJECT_ID = PROJECT_CONFIG.projectId;
+export const AUTH_DOMAIN = PROJECT_CONFIG.authDomain;
+export const API_KEY = PROJECT_CONFIG.apiKey;
+
+interface IntegrationTestAuth extends Auth {
+  cleanUp(): Promise<void>;
+}
+
+export function randomEmail(): string {
+  return `${_generateEventId('test.email.')}@test.com`;
+}
+
+export function getTestInstance(): Auth {
+  const app = initializeApp({
+    apiKey: API_KEY,
+    projectId: PROJECT_ID,
+    authDomain: AUTH_DOMAIN
+  });
+
+  const createdUsers: User[] = [];
+  const auth = initializeAuth(app) as IntegrationTestAuth;
+  auth.settings.appVerificationDisabledForTesting = true;
+
+  auth.onAuthStateChanged(user => {
+    if (user) {
+      createdUsers.push(user);
+    }
+  });
+
+  auth.cleanUp = async () => {
+    // Clear out any new users that were created in the course of the test
+    for (const user of createdUsers) {
+      try {
+        await user.delete();
+      } catch {
+        // Best effort. Maybe the test already deleted the user ¯\_(ツ)_/¯
+      }
+    }
+
+    await deleteApp(app);
+  };
+
+  return auth;
+}
+
+export async function cleanUpTestInstance(auth: Auth): Promise<void> {
+  await (auth as IntegrationTestAuth).cleanUp();
+}
+
+export function initIntegrationTestContext(): Auth {
+  const auth = getTestInstance();
+
+  afterEach(async () => {
+    await auth.signOut();
+  });
+
+  after(async () => {
+    await cleanUpTestInstance(auth);
+  });
+
+  return auth;
+}

packages-exp/auth-exp/test/integration/smoke_test.test.ts

@@ -0,0 +1,33 @@
+/**
+ * @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 { expect } from 'chai';
+
+import { signInAnonymously } from '@firebase/auth-exp/index.browser';
+import { OperationType } from '@firebase/auth-types-exp';
+
+import { initIntegrationTestContext } from '../helpers/integration/helpers';
+
+describe('smoke test', () => {
+  const auth = initIntegrationTestContext();
+
+  it('signs in anonymously', async () => {
+    const userCred = await signInAnonymously(auth);
+    expect(auth.currentUser).to.eq(userCred.user);
+    expect(userCred.operationType).to.eq(OperationType.SIGN_IN);
+  });
+});