Merge pull request #20055 from mozilla/fxa-12621

fxa-12621: Migrate 14 Mocha integration tests to Jest

Author: vbudhram

packages/fxa-auth-server/jest.integration.config.js

@@ -20,6 +20,7 @@ module.exports = {
   ],
 
   testTimeout: 120000,
+  maxWorkers: 4,
 
   globalSetup: '<rootDir>/test/support/jest-global-setup.ts',
   globalTeardown: '<rootDir>/test/support/jest-global-teardown.ts',

packages/fxa-auth-server/package.json

@@ -45,7 +45,7 @@
     "test-unit": "VERIFIER_VERSION=0 TEST_TYPE=unit scripts/test-ci.sh",
     "test-integration": "VERIFIER_VERSION=0 TEST_TYPE=integration scripts/test-ci.sh",
     "test-integration-v2": "VERIFIER_VERSION=0 TEST_TYPE=integration-v2 scripts/test-ci.sh",
-    "test-integration-jest": "JEST_JUNIT_OUTPUT_DIR='../../artifacts/tests/fxa-auth-server' JEST_JUNIT_OUTPUT_NAME='jest-integration-results.xml' npx jest --config jest.integration.config.js --forceExit --ci --reporters=default --reporters=jest-junit",
+    "test-integration-jest": "VERIFIER_VERSION=0 TEST_TYPE=integration-jest scripts/test-ci.sh",
     "populate-firestore-customers": "CONFIG_FILES='config/secrets.json' node -r esbuild-register ./scripts/populate-firestore-customers.ts",
     "populate-vat-taxes": "CONFIG_FILES='config/secrets.json' node -r esbuild-register ./scripts/populate-vat-taxes.ts",
     "paypal-processor": "CONFIG_FILES='config/secrets.json' node -r esbuild-register ./scripts/paypal-processor.ts",

packages/fxa-auth-server/scripts/test-ci.sh

@@ -12,20 +12,23 @@ if [ "$TEST_TYPE" == 'integration' ]; then GREP_TESTS="--grep /#integration\s-/"
 if [ "$TEST_TYPE" == 'integration-v2' ]; then GREP_TESTS="--grep /#integrationV2\s-/"; fi;
 
 
-TESTS=(local oauth remote scripts)
-if [ -z "$1" ]; then
+# Skip mocha tests for integration-jest — only run Jest tests
+if [ "$TEST_TYPE" != 'integration-jest' ]; then
   TESTS=(local oauth remote scripts)
-else
-  TESTS=($1)
+  if [ -z "$1" ]; then
+    TESTS=(local oauth remote scripts)
+  else
+    TESTS=($1)
+  fi
+
+  for t in "${TESTS[@]}"; do
+    echo -e "\n\nTesting: $t"
+
+    #./scripts/mocha-coverage.js $DEFAULT_ARGS $GREP_TESTS --reporter-options mochaFile="../../artifacts/tests/fxa-auth-server/$t/test-results.xml" "test/$t"
+    MOCHA_FILE=../../artifacts/tests/$npm_package_name/fxa-auth-server-mocha-$TEST_TYPE-$t-results.xml mocha $DEFAULT_ARGS $GREP_TESTS test/$t
+  done
 fi
 
-for t in "${TESTS[@]}"; do
-  echo -e "\n\nTesting: $t"
-
-  #./scripts/mocha-coverage.js $DEFAULT_ARGS $GREP_TESTS --reporter-options mochaFile="../../artifacts/tests/fxa-auth-server/$t/test-results.xml" "test/$t"
-  MOCHA_FILE=../../artifacts/tests/$npm_package_name/fxa-auth-server-mocha-$TEST_TYPE-$t-results.xml mocha $DEFAULT_ARGS $GREP_TESTS test/$t
-done
-
 if [ "$TEST_TYPE" == 'integration' ]; then
   yarn run clean-up-old-ci-stripe-customers;
 fi;
@@ -42,6 +45,16 @@ elif [ "$TEST_TYPE" == 'integration' ]; then
   JEST_JUNIT_OUTPUT_DIR="../../artifacts/tests/fxa-auth-server" \
   JEST_JUNIT_OUTPUT_NAME="fxa-auth-server-jest-integration-results.xml" \
   npx jest --coverage --forceExit --ci --reporters=default --reporters=jest-junit --testPathPattern='verification-reminders'
+elif [ "$TEST_TYPE" == 'integration-jest' ]; then
+  echo -e "\n\nRunning Jest verification-reminders tests"
+  JEST_JUNIT_OUTPUT_DIR="../../artifacts/tests/fxa-auth-server" \
+  JEST_JUNIT_OUTPUT_NAME="fxa-auth-server-jest-verification-reminders-results.xml" \
+  npx jest --coverage --forceExit --ci --reporters=default --reporters=jest-junit --testPathPattern='verification-reminders'
+
+  echo -e "\n\nRunning Jest migrated integration tests"
+  JEST_JUNIT_OUTPUT_DIR="../../artifacts/tests/fxa-auth-server" \
+  JEST_JUNIT_OUTPUT_NAME="fxa-auth-server-jest-integration-jest-results.xml" \
+  npx jest --config jest.integration.config.js --forceExit --ci --reporters=default --reporters=jest-junit
 elif [ -z "$TEST_TYPE" ]; then
   echo -e "\n\nRunning all Jest tests"
   JEST_JUNIT_OUTPUT_DIR="../../artifacts/tests/fxa-auth-server" \

…erver/test/remote/account_create.spec.ts …er/test/remote/account_create.in.spec.tspackages/fxa-auth-server/test/remote/account_create.spec.ts renamed to packages/fxa-auth-server/test/remote/account_create.in.spec.ts packages/fxa-auth-server/test/remote/account_create.spec.ts renamed to packages/fxa-auth-server/test/remote/account_create.in.spec.ts

@@ -2,22 +2,19 @@
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 
-import { createTestServer, TestServerInstance } from '../support/helpers/test-server';
 import crypto from 'crypto';
 
-interface AuthServerError extends Error {
-  errno: number;
-  code: number;
-  email: string;
-}
+import * as jwt from '../../lib/oauth/jwt';
+import { createTestServer, TestServerInstance } from '../support/helpers/test-server';
+import { AuthServerError, generateMetricsContext } from '../support/helpers/test-utils';
 
 interface TestConfig extends Record<string, unknown> {
   smtp: { syncUrl: string };
   publicUrl: string;
 }
 
+// eslint-disable-next-line @typescript-eslint/no-require-imports
 const Client = require('../client')();
-const mocks = require('../mocks');
 
 let server: TestServerInstance;
 let config: TestConfig;
@@ -167,7 +164,6 @@ describe.each(testVersions)(
 
       const stubResponse = await client.stubAccount('dcdb5ae7add825d2');
 
-      const jwt = require('../../lib/oauth/jwt');
       const setupToken = jwt.sign(
         { uid: stubResponse.uid, iat: Date.now() },
         { header: { typ: 'fin+JWT' } }
@@ -236,7 +232,6 @@ describe.each(testVersions)(
 
       const stubResponse = await client.stubAccount('dcdb5ae7add825d2');
 
-      const jwt = require('../../lib/oauth/jwt');
       const setupToken = jwt.sign(
         {
           uid: stubResponse.uid,
@@ -431,6 +426,195 @@ describe.each(testVersions)(
       }
     });
 
+    it('invalid entrypointExperiment', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: ';',
+          entrypointVariation: 'var',
+          utmCampaign: 'bar',
+          utmContent: 'baz',
+          utmMedium: 'qux',
+          utmSource: 'wibble',
+          utmTerm: 'blee',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid entrypointVariation', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: ';',
+          utmCampaign: 'bar',
+          utmContent: 'baz',
+          utmMedium: 'qux',
+          utmSource: 'wibble',
+          utmTerm: 'blee',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid utmCampaign', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: 'var',
+          utmCampaign: ';',
+          utmContent: 'bar',
+          utmMedium: 'baz',
+          utmSource: 'qux',
+          utmTerm: 'wibble',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid utmContent', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: 'var',
+          utmCampaign: 'bar',
+          utmContent: ';',
+          utmMedium: 'baz',
+          utmSource: 'qux',
+          utmTerm: 'wibble',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid utmMedium', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: 'var',
+          utmCampaign: 'bar',
+          utmContent: 'baz',
+          utmMedium: ';',
+          utmSource: 'qux',
+          utmTerm: 'wibble',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid utmSource', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: 'var',
+          utmCampaign: 'bar',
+          utmContent: 'baz',
+          utmMedium: 'qux',
+          utmSource: ';',
+          utmTerm: 'wibble',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
+    it('invalid utmTerm', async () => {
+      const api = new Client.Api(server.publicUrl, testOptions);
+      const email = server.uniqueEmail();
+      const authPW =
+        '0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF';
+      const options = {
+        ...testOptions,
+        metricsContext: {
+          entrypoint: 'foo',
+          entrypointExperiment: 'exp',
+          entrypointVariation: 'var',
+          utmCampaign: 'bar',
+          utmContent: 'baz',
+          utmMedium: 'qux',
+          utmSource: 'wibble',
+          utmTerm: ';',
+        },
+      };
+
+      try {
+        await api.accountCreate(email, authPW, options);
+        fail('should have thrown');
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
+      }
+    });
+
     it('create account with service query parameter', async () => {
       const email = server.uniqueEmail();
 
@@ -470,8 +654,8 @@ describe.each(testVersions)(
           },
         });
         fail('account creation should have failed');
-      } catch (err) {
-        expect(err).toBeTruthy();
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
       }
     });
 
@@ -488,16 +672,16 @@ describe.each(testVersions)(
           },
         });
         fail('account creation should have failed');
-      } catch (err) {
-        expect(err).toBeTruthy();
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
       }
     });
 
     it('account creation works with maximal metricsContext metadata', async () => {
       const email = server.uniqueEmail();
       const options = {
         ...testOptions,
-        metricsContext: mocks.generateMetricsContext(),
+        metricsContext: generateMetricsContext(),
       };
 
       const client = await Client.create(server.publicUrl, email, 'foo', options);
@@ -532,8 +716,8 @@ describe.each(testVersions)(
           },
         });
         fail('account creation should have failed');
-      } catch (err) {
-        expect(err).toBeTruthy();
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
       }
     });
 
@@ -548,8 +732,8 @@ describe.each(testVersions)(
           },
         });
         fail('account creation should have failed');
-      } catch (err) {
-        expect(err).toBeTruthy();
+      } catch (err: unknown) {
+        expect((err as AuthServerError).errno).toBe(107);
       }
     });