OJ-3609: Move integration tests from jest to vitest

mikebeeby · mikebeeby · commit a3d74c07f4df · 2026-03-26T10:52:14.000Z
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -17,7 +17,6 @@ module.exports = {
   env: {
     node: true,
     es2022: true,
-    jest: true,
   },
   globals: {
     sinon: true,
diff --git a/.github/jest.config.ci.ts b/.github/jest.config.ci.ts
diff --git a/.github/workflows/run-apigw-tests.yml b/.github/workflows/run-apigw-tests.yml
@@ -45,4 +45,4 @@ jobs:
           AWS_REGION: ${{ inputs.aws-region }}
         with:
           working-directory: integration-tests
-          script: npm run test:api:e2e -- --config jest.config.ci.ts
+          script: npm run test:api:ci
diff --git a/README.md b/README.md
@@ -22,9 +22,6 @@ Then run the command:
 `AWS_PROFILE=YourProfileName npm run test:api --workspace integration-tests`
 
 This will run all tests in the `api-gateway` directory.
-or to run e2e api tests, use the following command
-
-`AWS_PROFILE=YourProfileName npm run test:api:e2e --workspace integration-tests`
 
 Where `YourProfileName` is your aws sso profile, created against the Check Hmrc CRI AWS Account
 
diff --git a/integration-tests/api-gateway/abandon/abandon-happy.test.ts b/integration-tests/api-gateway/abandon/abandon-happy.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import { AuditEvent } from "@govuk-one-login/cri-audit";
 import { pollTestHarnessForEvents } from "@govuk-one-login/cri-test-resources-helpers";
 import { clearAttemptsTable, clearItemsFromTables, getItemByKey } from "../../resources/dynamodb-helper";
@@ -11,7 +12,7 @@ import {
 } from "../endpoints";
 import { CLIENT_ID, NINO, REDIRECT_URL } from "../env-variables";
 
-jest.setTimeout(60_000); // 1 min
+vi.setConfig({ testTimeout: 60000 });
 
 describe("Given the session is valid and expecting to abandon the journey", () => {
   let sessionId: string;
diff --git a/integration-tests/api-gateway/abandon/abandon-unhappy.test.ts b/integration-tests/api-gateway/abandon/abandon-unhappy.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import {
   clearAttemptsTable,
   clearItemsFromTables,
@@ -11,7 +12,7 @@ import {
 } from "../endpoints";
 import { CLIENT_ID, NINO, REDIRECT_URL } from "../env-variables";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("Given the session is invalid and expecting to abandon the journey", () => {
   let sessionId: string;
diff --git a/integration-tests/api-gateway/audit.ts b/integration-tests/api-gateway/audit.ts
@@ -1,3 +1,4 @@
+import { expect } from "vitest";
 import type { UnixSecondsTimestamp } from "@govuk-one-login/cri-types";
 import { Evidence } from "../../lambdas/common/src/types/evidence";
 import { AuditEvent, AuditRestricted } from "@govuk-one-login/cri-audit";
diff --git a/integration-tests/api-gateway/authorization/authorization-happy.test.ts b/integration-tests/api-gateway/authorization/authorization-happy.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import {
   clearAttemptsTable,
   clearItemsFromTables,
@@ -11,7 +12,7 @@ import {
 } from "../endpoints";
 import { CLIENT_ID, NINO, REDIRECT_URL } from "../env-variables";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("Given the session is valid and expecting to be authorized", () => {
   let authCode: { value: string };
diff --git a/integration-tests/api-gateway/authorization/authorization-unhappy.test.ts b/integration-tests/api-gateway/authorization/authorization-unhappy.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import {
   clearAttemptsTable,
   clearItemsFromTables,
@@ -10,7 +11,7 @@ import {
 } from "../endpoints";
 import { CLIENT_ID, NINO, REDIRECT_URL } from "../env-variables";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("Given the session is invalid and expecting it not to be authorized", () => {
   let sessionId: string;
diff --git a/integration-tests/api-gateway/check/check-lambda-happy.test.ts b/integration-tests/api-gateway/check/check-lambda-happy.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import { ninoCheckEndpoint, createSession, getJarAuthorization } from "../endpoints";
 import { clearAttemptsTable, clearItemsFromTables } from "../../resources/dynamodb-helper";
 import { AUDIENCE, NINO } from "../env-variables";
@@ -13,7 +14,7 @@ import { testUser } from "../user";
 import { AuditEvent } from "@govuk-one-login/cri-audit";
 import { pollTestHarnessForEvents } from "@govuk-one-login/cri-test-resources-helpers";
 
-jest.setTimeout(60_000); // 1 min
+vi.setConfig({ testTimeout: 60000 });
 
 describe("Given the session and NINO is valid", () => {
   let sessionId: string;
diff --git a/integration-tests/api-gateway/check/check-lambda-retry.test.ts b/integration-tests/api-gateway/check/check-lambda-retry.test.ts
@@ -1,8 +1,9 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import { ninoCheckEndpoint, createSession, getJarAuthorization } from "../endpoints";
 import { clearAttemptsTable, clearItemsFromTables, queryItemsBySessionId } from "../../resources/dynamodb-helper";
 import { NINO } from "../env-variables";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("check-lambda retry logic", () => {
   const errorNino = "ER123456A";
diff --git a/integration-tests/api-gateway/check/check-lambda-unhappy.test.ts b/integration-tests/api-gateway/check/check-lambda-unhappy.test.ts
@@ -1,8 +1,9 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import { ninoCheckEndpoint, createSession, getJarAuthorization } from "../endpoints";
 import { clearAttemptsTable, clearItemsFromTables } from "../../resources/dynamodb-helper";
 import { NINO } from "../env-variables";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("Given the session and NINO is invalid", () => {
   let sessionId: string;
diff --git a/integration-tests/api-gateway/contract/credential-contract.test.ts b/integration-tests/api-gateway/contract/credential-contract.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, beforeAll, afterAll, describe, expect, it } from "vitest";
 import { Logger } from "@aws-lambda-powertools/logger";
 import { Verifier, VerifierOptions } from "@pact-foundation/pact";
 import { Constants } from "./utils/Constants";
@@ -47,6 +48,7 @@ describe("Pact Verification", () => {
       expect(errors.length).toBe(0);
     } catch (error) {
       logger.error("Pact verification failed :(", { error });
+      throw error;
     }
   }, 60000);
 });
diff --git a/integration-tests/api-gateway/cri-decrypt-verify/index.test.ts b/integration-tests/api-gateway/cri-decrypt-verify/index.test.ts
@@ -1,3 +1,4 @@
+import { beforeAll, afterEach, afterAll, describe, expect, it, vi } from "vitest";
 import { Logger } from "@aws-lambda-powertools/logger";
 import { stackOutputs } from "../../resources/cloudformation-helper";
 import { JweDecrypter } from "../crypto/jwe-decrypter";
@@ -70,7 +71,7 @@ describe.each([
       });
 
       it(`any KMS aliases succeeds in decryption ${description}`, async () => {
-        const decryptKeyWithKmsSpy = jest.spyOn(jweDecrypter, "decryptKeyWithKms");
+        const decryptKeyWithKmsSpy = vi.spyOn(jweDecrypter, "decryptKeyWithKms");
 
         await jweDecrypter.decryptJwe(jarRequest.request);
 
@@ -214,7 +215,7 @@ describe("Given there is a ./well-known/jwks with a key to encrypt claims - when
   });
 
   it("uses legacy KMS ID and throws error when decrypting JWE", async () => {
-    const decryptKeyWithKmsSpy = jest.spyOn(jweDecrypter, "decryptKeyWithKms");
+    const decryptKeyWithKmsSpy = vi.spyOn(jweDecrypter, "decryptKeyWithKms");
 
     await expect(jweDecrypter.decryptJwe(jarRequest.request)).rejects.toThrow(/Failed to decrypt with legacy key/);
 
diff --git a/integration-tests/api-gateway/e2e/e2e-happy-path.test.ts b/integration-tests/api-gateway/e2e/e2e-happy-path.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
 import { getSSMParameter } from "../../resources/ssm-param-helper";
 import { NINO, claimSet, environment, CLIENT_ID, REDIRECT_URL, AUDIENCE } from "../env-variables";
 import { decodeJwt, JWK } from "jose";
@@ -23,7 +24,7 @@ let authCode: { value: string };
 let privateApi: string;
 let publicApi: string;
 
-jest.setTimeout(180_000); // 3 mins
+vi.setConfig({ testTimeout: 180000 });
 
 describe("End to end happy path journey", () => {
   let state: string;
diff --git a/integration-tests/api-gateway/e2e/e2e-retry-path.test.ts b/integration-tests/api-gateway/e2e/e2e-retry-path.test.ts
@@ -1,3 +1,4 @@
+import { beforeEach, afterEach, beforeAll, describe, expect, it, vi } from "vitest";
 import { getSSMParameter } from "../../resources/ssm-param-helper";
 import { NINO, claimSet, environment, CLIENT_ID, REDIRECT_URL, AUDIENCE } from "../env-variables";
 import { decodeJwt, JWK } from "jose";
@@ -11,7 +12,7 @@ let authCode: { value: string };
 let privateApi: string;
 let publicApi: string;
 
-jest.setTimeout(35_000);
+vi.setConfig({ testTimeout: 35000 });
 
 const retryClaimSet = JSON.parse(JSON.stringify(claimSet));
 retryClaimSet.shared_claims.name[0].nameParts[0].value = "Error";
diff --git a/integration-tests/api-gateway/jest.config.ts b/integration-tests/api-gateway/jest.config.ts
diff --git a/integration-tests/api-gateway/jwks-endpoint/jwks-endpoint.test.ts b/integration-tests/api-gateway/jwks-endpoint/jwks-endpoint.test.ts
@@ -1,8 +1,9 @@
+import { beforeAll, describe, expect, it, vi } from "vitest";
 import { environment } from "../env-variables";
 
 let endpointURL: string;
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
 
 describe("/.well-known/jwks.json", () => {
   beforeAll(async () => {
diff --git a/integration-tests/api-gateway/session/session-happy.test.ts b/integration-tests/api-gateway/session/session-happy.test.ts
@@ -1,7 +1,9 @@
+import { beforeEach, afterEach, describe, expect, it, vi } from "vitest";
 import { createSession, getJarAuthorization } from "../endpoints";
 import { clearItemsFromTables } from "../../resources/dynamodb-helper";
 
-jest.setTimeout(30_000);
+vi.setConfig({ testTimeout: 30000 });
+
 describe("Given the session is valid", () => {
   let sessionId: string;
   let sessionTableName: string;
diff --git a/integration-tests/api-gateway/session/session-unhappy.test.ts b/integration-tests/api-gateway/session/session-unhappy.test.ts
@@ -1,5 +1,6 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
 import { createSession } from "../endpoints";
-jest.setTimeout(35_000);
+vi.setConfig({ testTimeout: 35000 });
 describe("Given the session is invalid", () => {
   let anInValidSession: Response;
 
diff --git a/integration-tests/jest.config.ci.ts b/integration-tests/jest.config.ci.ts
diff --git a/integration-tests/jest.config.ts b/integration-tests/jest.config.ts
diff --git a/integration-tests/package.json b/integration-tests/package.json
@@ -3,10 +3,10 @@
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "test:api": "jest --silent --select-projects integration-tests/api-gateway --testPathIgnorePatterns */contract/credential-contract.test.ts",
-    "test:api:e2e": "jest --silent integration-tests/api-gateway --testPathIgnorePatterns */contract/credential-contract.test.ts",
+    "test:api": "vitest run --config ./vitest.config.ts",
+    "test:api:ci": "vitest run --config ./vitest.config.ci.ts",
     "start:contract": "cd api-gateway/contract && ts-node ./app.ts",
-    "test:contract": "wait-on tcp:127.0.0.1:3000; jest --silent */contract/credential-contract.test.ts --runInBand",
+    "test:contract": "wait-on tcp:127.0.0.1:3000 && vitest run --config ./vitest.config.contract.ts",
     "test:contract:ci": "npm-run-all -p -r start:contract test:contract",
     "deploy": "../deploy.sh",
     "compile": "tsc"
diff --git a/integration-tests/tsconfig.json b/integration-tests/tsconfig.json
@@ -10,7 +10,7 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
-    "types": ["jest", "node", "aws-lambda"],
+    "types": ["vitest/globals", "node", "aws-lambda"],
     "outDir": "./build/",
     "noImplicitAny": true
   },
diff --git a/integration-tests/vitest.config.ci.ts b/integration-tests/vitest.config.ci.ts
@@ -0,0 +1,8 @@
+import { defineConfig, mergeConfig } from "vitest/config";
+import baseConfig from "./vitest.config";
+
+export default mergeConfig(baseConfig, defineConfig({
+  test: {
+    reporters: ["default", "github-actions"],
+  },
+}));
diff --git a/integration-tests/vitest.config.contract.ts b/integration-tests/vitest.config.contract.ts
@@ -0,0 +1,13 @@
+import { defineConfig, mergeConfig } from "vitest/config";
+import baseConfig from "../vitest.config.base";
+
+export default mergeConfig(baseConfig, defineConfig({
+  test: {
+    include: ["./api-gateway/contract/**/*.test.ts"],
+    exclude: [],
+    globalSetup: ["./globalStackOutputSetup.ts"],
+    environment: "node",
+    threads: false,
+    coverage: { enabled: false },
+  },
+}));
diff --git a/integration-tests/vitest.config.ts b/integration-tests/vitest.config.ts
@@ -0,0 +1,13 @@
+import { defineConfig, mergeConfig } from "vitest/config";
+import baseConfig from "../vitest.config.base";
+
+export default mergeConfig(baseConfig, defineConfig({
+  test: {
+    include: ["./api-gateway/**/*.test.ts"],
+    exclude: ["**/contract/**"],
+    globalSetup: ["./globalStackOutputSetup.ts"],
+    environment: "node",
+    threads: false,
+    coverage: { enabled: false }
+  },
+}));
diff --git a/jest.config.base.ts b/jest.config.base.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import { expect } from "vitest";`
`1`	`2`	`import type { UnixSecondsTimestamp } from "@govuk-one-login/cri-types";`
`2`	`3`	`import { Evidence } from "../../lambdas/common/src/types/evidence";`
`3`	`4`	`import { AuditEvent, AuditRestricted } from "@govuk-one-login/cri-audit";`