test(signature-v4-multi-region): move testing to vitest

Author: siddsriv

packages/signature-v4-multi-region/jest.config.e2e.js

@@ -9,9 +9,9 @@
     "build:types": "tsc -p tsconfig.types.json",
     "build:types:downlevel": "downlevel-dts dist-types dist-types/ts3.4",
     "clean": "rimraf ./dist-* && rimraf *.tsbuildinfo",
-    "test": "jest",
-    "test:e2e": "jest -c jest.config.e2e.js",
-    "test:browser": "karma start karma.conf.js"
+    "test": "vitest run",
+    "test:e2e": "vitest run --config vitest.config.e2e.js",
+    "test:browser": "vitest run --config vitest.config.browser.js"
   },
   "main": "./dist-cjs/index.js",
   "module": "./dist-es/index.js",
@@ -34,7 +34,12 @@
     "concurrently": "7.0.0",
     "downlevel-dts": "0.10.1",
     "rimraf": "3.0.2",
-    "typescript": "~4.9.5"
+    "typescript": "~4.9.5",
+    "vitest": "^2.1.9",
+    "@vitest/browser": "^1.0.0",
+    "@vitest/coverage-v8": "^1.0.0",
+    "chai": "^4.3.7",
+    "chai-as-promised": "^7.1.1"
   },
   "engines": {
     "node": ">=16.0.0"

packages/signature-v4-multi-region/jest.config.js

@@ -1,8 +1,9 @@
 import { HttpRequest } from "@smithy/protocol-http";
+import { beforeEach, describe, expect, it, vi } from "vitest";
 
-jest.mock("@smithy/signature-v4");
-jest.mock("@aws-sdk/signature-v4-crt");
-jest.mock("@smithy/signature-v4a");
+vi.mock("@smithy/signature-v4");
+vi.mock("@aws-sdk/signature-v4-crt");
+vi.mock("@smithy/signature-v4a");
 
 import { CrtSignerV4 } from "@aws-sdk/signature-v4-crt";
 import { SignatureV4 } from "@smithy/signature-v4";
@@ -31,49 +32,43 @@ describe("SignatureV4MultiRegion", () => {
   beforeEach(() => {
     signatureV4CrtContainer.CrtSignerV4 = CrtSignerV4 as any;
     signatureV4aContainer.SignatureV4a = SignatureV4a as any;
-    jest.clearAllMocks();
+    vi.clearAllMocks();
   });
 
   it("should sign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.sign(minimalRequest);
-    //@ts-ignore
-    expect(SignatureV4.mock.instances[0].sign).toBeCalledTimes(1);
+    expect(SignatureV4.prototype.sign).toBeCalledTimes(1);
   });
 
   it("should presign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest);
-    //@ts-ignore
-    expect(SignatureV4.mock.instances[0].presign).toBeCalledTimes(1);
+    expect(SignatureV4.prototype.presign).toBeCalledTimes(1);
   });
 
   it("should sign with SigV4a signer if mult_region option is set", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest, { signingRegion: "*" });
-    //@ts-ignore
-    expect(CrtSignerV4.mock.instances[0].presign).toBeCalledTimes(1);
+    expect(CrtSignerV4.prototype.presign).toBeCalledTimes(1);
   });
 
   it("should presign with SigV4 signer", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest, { signingRegion: "*" });
-    //@ts-ignore
-    expect(CrtSignerV4.mock.instances[0].presign).toBeCalledTimes(1);
+    expect(CrtSignerV4.prototype.presign).toBeCalledTimes(1);
   });
 
   it("should presign with SigV4a signer if signingRegion is '*'", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.presign(minimalRequest, { signingRegion: "*" });
-    //@ts-ignore
-    expect(SignatureV4a.mock.instances[0].presign).toBeCalledTimes(1);
+    expect(SignatureV4a.prototype.presign).toBeCalledTimes(1);
   });
 
   it("should sign with SigV4a signer if signingRegion is '*'", async () => {
     const signer = new SignatureV4MultiRegion(params);
     await signer.sign(minimalRequest, { signingRegion: "*" });
-    //@ts-ignore
-    expect(SignatureV4a.mock.instances[0].sign).toBeCalledTimes(1);
+    expect(SignatureV4a.prototype.sign).toBeCalledTimes(1);
   });
 
   it("should use CrtSignerV4 if available", async () => {

packages/signature-v4-multi-region/package.json

@@ -6,8 +6,10 @@ import { CloudFrontKeyValueStoreClient, DescribeKeyValueStoreCommand } from "@aw
 import { GetCallerIdentityCommand, STSClient } from "@aws-sdk/client-sts";
 import { SignatureV4MultiRegion } from "@aws-sdk/signature-v4-multi-region";
 import { HttpRequest } from "@smithy/protocol-http";
+import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
 
-jest.setTimeout(300000);
+// Setting timeout for tests
+const TEST_TIMEOUT = 300000;
 
 describe("CloudFront KeyValue Store with SignatureV4a (JS Implementation)", () => {
   let cfClient: CloudFrontClient;
@@ -18,6 +20,9 @@ describe("CloudFront KeyValue Store with SignatureV4a (JS Implementation)", () =
   let signer: SignatureV4MultiRegion;
 
   beforeAll(async () => {
+    // Set timeout for setup
+    vi.setConfig({ testTimeout: TEST_TIMEOUT });
+
     const stsClient = new STSClient({});
     const { Account } = await stsClient.send(new GetCallerIdentityCommand({}));
     const timestamp = Date.now();
@@ -53,6 +58,9 @@ describe("CloudFront KeyValue Store with SignatureV4a (JS Implementation)", () =
   });
 
   afterAll(async () => {
+    // Set timeout for teardown
+    vi.setConfig({ testTimeout: TEST_TIMEOUT });
+
     try {
       await cfClient.send(
         new DeleteKeyValueStoreCommand({
@@ -76,7 +84,7 @@ describe("CloudFront KeyValue Store with SignatureV4a (JS Implementation)", () =
       path: "/",
     });
 
-    const signSpy = jest.spyOn(signer, "sign");
+    const signSpy = vi.spyOn(signer, "sign");
 
     await signer.sign(mockRequest, { signingRegion: "*" });
 

packages/signature-v4-multi-region/src/SignatureV4MultiRegion.spec.ts

@@ -5,15 +5,20 @@ import { DeleteRuleCommand, DescribeRuleCommand, EventBridgeClient, PutRuleComma
 import { GetCallerIdentityCommand, STSClient } from "@aws-sdk/client-sts";
 import { SignatureV4MultiRegion } from "@aws-sdk/signature-v4-multi-region";
 import { HttpRequest } from "@smithy/protocol-http";
+import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
 
-jest.setTimeout(300000);
+// Setting timeout for tests
+const TEST_TIMEOUT = 300000;
 
 describe("EventBridge with SignatureV4a (JS Implementation)", () => {
   let ebClient: EventBridgeClient;
   let ruleName: string;
   let signer: SignatureV4MultiRegion;
 
   beforeAll(async () => {
+    // Set timeout for setup
+    vi.setConfig({ testTimeout: TEST_TIMEOUT });
+
     const stsClient = new STSClient({});
     const { Account } = await stsClient.send(new GetCallerIdentityCommand({}));
     const timestamp = Date.now();
@@ -37,6 +42,9 @@ describe("EventBridge with SignatureV4a (JS Implementation)", () => {
   });
 
   afterAll(async () => {
+    // Set timeout for teardown
+    vi.setConfig({ testTimeout: TEST_TIMEOUT });
+
     try {
       await ebClient.send(
         new DeleteRuleCommand({
@@ -59,7 +67,7 @@ describe("EventBridge with SignatureV4a (JS Implementation)", () => {
       path: "/",
     });
 
-    const signSpy = jest.spyOn(signer, "sign");
+    const signSpy = vi.spyOn(signer, "sign");
 
     await signer.sign(mockRequest, { signingRegion: "*" });
 

packages/signature-v4-multi-region/src/cloudfront-keyvaluestore-sigv4a.e2e.spec.ts

@@ -2,24 +2,26 @@ import "@smithy/signature-v4a";
 
 import { Sha256 } from "@aws-crypto/sha256-js";
 import {
-  S3Client,
   CreateBucketCommand,
   DeleteBucketCommand,
+  ListObjectsV2Command,
   PutObjectCommand,
-  ListObjectsV2Command
+  S3Client,
 } from "@aws-sdk/client-s3";
 import {
-  S3ControlClient,
   CreateMultiRegionAccessPointCommand,
   DeleteMultiRegionAccessPointCommand,
   DescribeMultiRegionAccessPointOperationCommand,
-  GetMultiRegionAccessPointCommand
+  GetMultiRegionAccessPointCommand,
+  S3ControlClient,
 } from "@aws-sdk/client-s3-control";
 import { GetCallerIdentityCommand, STSClient } from "@aws-sdk/client-sts";
 import { SignatureV4MultiRegion } from "@aws-sdk/signature-v4-multi-region";
 import { HttpRequest } from "@smithy/protocol-http";
+import { afterAll, beforeAll, describe, expect, it, vi } from "vitest";
 
-jest.setTimeout(1800000); // 30 minutes (MRAP operations can take a while)
+// Setting timeout for long-running tests
+const LONG_TIMEOUT = 1800000; // 30 minutes
 
 describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", () => {
   let s3Client: S3Client;
@@ -32,6 +34,9 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
   let mrapArn: string;
 
   beforeAll(async () => {
+    // Set timeout for setup
+    vi.setConfig({ testTimeout: LONG_TIMEOUT });
+
     const stsClient = new STSClient({});
     const { Account } = await stsClient.send(new GetCallerIdentityCommand({}));
     accountId = Account!;
@@ -63,8 +68,12 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
     });
 
     // Create buckets
-    await s3Client.send(new CreateBucketCommand({ Bucket: bucketName1, CreateBucketConfiguration: { LocationConstraint: "us-west-2" } }));
-    await s3Client.send(new CreateBucketCommand({ Bucket: bucketName2, CreateBucketConfiguration: { LocationConstraint: "us-east-2" } }));
+    await s3Client.send(
+      new CreateBucketCommand({ Bucket: bucketName1, CreateBucketConfiguration: { LocationConstraint: "us-west-2" } })
+    );
+    await s3Client.send(
+      new CreateBucketCommand({ Bucket: bucketName2, CreateBucketConfiguration: { LocationConstraint: "us-east-2" } })
+    );
 
     // Create MRAP
     const createResponse = await s3ControlClient.send(
@@ -101,7 +110,7 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
       if (describeResponse.AsyncOperation?.RequestStatus === "SUCCESS") {
         mrapReady = true;
       } else {
-        await new Promise(resolve => setTimeout(resolve, 30000)); // Wait for 30 seconds before retrying
+        await new Promise((resolve) => setTimeout(resolve, 30000)); // Wait for 30 seconds before retrying
         retries++;
       }
     }
@@ -120,14 +129,19 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
     mrapArn = getResponse.AccessPoint!.Alias!;
 
     // Upload a small file to one of the buckets
-    await s3Client.send(new PutObjectCommand({
-      Bucket: bucketName1,
-      Key: "testfile",
-      Body: Buffer.from("test", "utf-8")
-    }));
+    await s3Client.send(
+      new PutObjectCommand({
+        Bucket: bucketName1,
+        Key: "testfile",
+        Body: Buffer.from("test", "utf-8"),
+      })
+    );
   });
 
   afterAll(async () => {
+    // Set timeout for teardown
+    vi.setConfig({ testTimeout: LONG_TIMEOUT });
+
     // Delete MRAP
     try {
       await s3ControlClient.send(
@@ -163,7 +177,7 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
       path: "/",
     });
 
-    const signSpy = jest.spyOn(signer, "sign");
+    const signSpy = vi.spyOn(signer, "sign");
 
     await signer.sign(mockRequest, { signingRegion: "*" });
 
@@ -188,6 +202,6 @@ describe("S3 Multi-Region Access Point with SignatureV4a (JS Implementation)", (
 
     expect(response.Contents).toBeDefined();
     expect(response.Contents?.length).toBeGreaterThan(0);
-    expect(response.Contents?.some(object => object.Key === "testfile")).toBe(true);
+    expect(response.Contents?.some((object) => object.Key === "testfile")).toBe(true);
   });
-});
+});

packages/signature-v4-multi-region/src/eventbridge-sigv4a.e2e.spec.ts

@@ -6,9 +6,10 @@ import { SignatureV4MultiRegion } from "@aws-sdk/signature-v4-multi-region";
 import { HttpRequest } from "@smithy/protocol-http";
 import chai from "chai";
 import chaiAsPromised from "chai-as-promised";
+import { describe, expect, it } from "vitest";
 
 chai.use(chaiAsPromised);
-const { expect } = chai;
+const { expect: chaiExpect } = chai;
 
 const region = "*";
 const credentials = {
@@ -20,8 +21,9 @@ const credentials = {
 const s3MrapArn = (window as any).__env__.AWS_SMOKE_TEST_MRAP_ARN;
 const cfKvsArn = (window as any).__env__.AWS_SMOKE_TEST_CF_KVS_ARN;
 
-describe("SignatureV4a Browser Tests", function () {
-  this.timeout(30000); // Set timeout to 30 seconds
+describe("SignatureV4a Browser Tests", () => {
+  // Set timeout to 30 seconds
+  const TIMEOUT = 30000;
 
   const signer = new SignatureV4MultiRegion({
     credentials,
@@ -38,13 +40,16 @@ describe("SignatureV4a Browser Tests", function () {
     });
 
     it("should successfully list objects using MRAP", async () => {
+      // Using longer timeout for this test
+      vi.setConfig({ testTimeout: TIMEOUT });
+
       const command = new ListObjectsV2Command({
         Bucket: s3MrapArn,
       });
 
       const response = await s3Client.send(command);
-      expect(response.$metadata.httpStatusCode).to.equal(200);
-      expect(response.Contents).to.be.an("array");
+      chaiExpect(response.$metadata.httpStatusCode).to.equal(200);
+      chaiExpect(response.Contents).to.be.an("array");
     });
   });
 
@@ -56,11 +61,14 @@ describe("SignatureV4a Browser Tests", function () {
     });
 
     it("should successfully list rules using global endpoint", async () => {
+      // Using longer timeout for this test
+      vi.setConfig({ testTimeout: TIMEOUT });
+
       const command = new ListRulesCommand({});
 
       const response = await ebClient.send(command);
-      expect(response.$metadata.httpStatusCode).to.equal(200);
-      expect(response.Rules).to.be.an("array");
+      chaiExpect(response.$metadata.httpStatusCode).to.equal(200);
+      chaiExpect(response.Rules).to.be.an("array");
     });
   });
 
@@ -72,18 +80,24 @@ describe("SignatureV4a Browser Tests", function () {
     });
 
     it("should successfully describe a key-value store", async () => {
+      // Using longer timeout for this test
+      vi.setConfig({ testTimeout: TIMEOUT });
+
       const command = new DescribeKeyValueStoreCommand({
         KvsARN: cfKvsArn,
       });
 
       const response = await cfKvsClient.send(command);
-      expect(response.$metadata.httpStatusCode).to.equal(200);
-      expect(response.KvsARN).to.equal(cfKvsArn);
+      chaiExpect(response.$metadata.httpStatusCode).to.equal(200);
+      chaiExpect(response.KvsARN).to.equal(cfKvsArn);
     });
   });
 
   describe("SignatureV4MultiRegion", () => {
     it("should use SignatureV4a for '*' region", async () => {
+      // Using longer timeout for this test
+      vi.setConfig({ testTimeout: TIMEOUT });
+
       const mockRequest = new HttpRequest({
         method: "GET",
         protocol: "https:",
@@ -95,8 +109,8 @@ describe("SignatureV4a Browser Tests", function () {
       });
 
       const signedRequest = await signer.sign(mockRequest, { signingRegion: "*" });
-      expect(signedRequest.headers["x-amz-region-set"]).to.equal("*");
-      expect(signedRequest.headers["authorization"]).to.include("AWS4-ECDSA-P256-SHA256");
+      chaiExpect(signedRequest.headers["x-amz-region-set"]).to.equal("*");
+      chaiExpect(signedRequest.headers["authorization"]).to.include("AWS4-ECDSA-P256-SHA256");
     });
   });
 });