chore(batch): move tests to vitest

Author: dreamorosi

packages/batch/jest.config.cjs

@@ -10,9 +10,8 @@
     "access": "public"
   },
   "scripts": {
-    "test": "npm run test:unit",
-    "test:unit": "jest --group=unit --detectOpenHandles --coverage --verbose",
-    "jest": "jest --detectOpenHandles --verbose",
+    "test": "vitest --run",
+    "test:unit": "vitest --run",
     "test:e2e:nodejs18x": "echo 'Not Implemented'",
     "test:e2e:nodejs20x": "echo 'Not Implemented'",
     "test:e2e": "echo 'Not Implemented'",
@@ -75,4 +74,4 @@
   "devDependencies": {
     "@aws-lambda-powertools/testing-utils": "file:../testing"
   }
-}
+}

packages/batch/package.json

@@ -1,8 +1,4 @@
-/**
- * Test BasePartialBatchProcessor class
- *
- * @group unit/batch/class/basepartialbatchprocessor
- */
+import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest';
 import { BasePartialBatchProcessor, EventType } from '../../src/index.js';
 import type {
   BaseRecord,
@@ -16,8 +12,7 @@ describe('Class: BasePartialBatchProcessor', () => {
   const ENVIRONMENT_VARIABLES = process.env;
 
   beforeEach(() => {
-    jest.clearAllMocks();
-    jest.resetModules();
+    vi.clearAllMocks();
     process.env = { ...ENVIRONMENT_VARIABLES };
   });
 
@@ -46,19 +41,19 @@ describe('Class: BasePartialBatchProcessor', () => {
   }
 
   describe('create custom batch partial processor', () => {
-    it('should create a custom batch partial processor', () => {
+    it('creates a custom batch partial processor', () => {
       // Act
       const processor = new MyPartialProcessor();
 
       // Assess
       expect(processor).toBeInstanceOf(BasePartialBatchProcessor);
     });
 
-    it('should process a batch of records', () => {
+    it('processes a batch of records', () => {
       // Prepare
       const processor = new MyPartialProcessor();
       const records = [sqsRecordFactory('success')];
-      const consoleSpy = jest.spyOn(console, 'log');
+      const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
 
       // Act
       processor.register(records, sqsRecordHandler);

packages/batch/tests/helpers/populateEnvironmentVariables.ts

@@ -1,10 +1,6 @@
-/**
- * Test BatchProcessor class
- *
- * @group unit/batch/class/batchprocessor
- */
 import context from '@aws-lambda-powertools/testing-utils/context';
 import type { Context } from 'aws-lambda';
+import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   BatchProcessingError,
   BatchProcessor,
@@ -31,8 +27,7 @@ describe('Class: AsyncBatchProcessor', () => {
   };
 
   beforeEach(() => {
-    jest.clearAllMocks();
-    jest.resetModules();
+    vi.clearAllMocks();
     process.env = { ...ENVIRONMENT_VARIABLES };
   });
 
@@ -41,7 +36,7 @@ describe('Class: AsyncBatchProcessor', () => {
   });
 
   describe('Asynchronously processing SQS Records', () => {
-    test('Batch processing SQS records with no failures', async () => {
+    it('completes processing with no failures', async () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -59,7 +54,7 @@ describe('Class: AsyncBatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing SQS records with some failures', async () => {
+    it('completes processing with with some failures', async () => {
       // Prepare
       const firstRecord = sqsRecordFactory('failure');
       const secondRecord = sqsRecordFactory('success');
@@ -86,7 +81,7 @@ describe('Class: AsyncBatchProcessor', () => {
       });
     });
 
-    test('Batch processing SQS records with all failures', async () => {
+    it('completes processing with all failures', async () => {
       // Prepare
       const firstRecord = sqsRecordFactory('failure');
       const secondRecord = sqsRecordFactory('failure');
@@ -106,7 +101,7 @@ describe('Class: AsyncBatchProcessor', () => {
   });
 
   describe('Asynchronously processing Kinesis Records', () => {
-    test('Batch processing Kinesis records with no failures', async () => {
+    it('completes processing with no failures', async () => {
       // Prepare
       const firstRecord = kinesisRecordFactory('success');
       const secondRecord = kinesisRecordFactory('success');
@@ -124,7 +119,7 @@ describe('Class: AsyncBatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing Kinesis records with some failures', async () => {
+    it('completes processing with some failures', async () => {
       // Prepare
       const firstRecord = kinesisRecordFactory('failure');
       const secondRecord = kinesisRecordFactory('success');
@@ -151,7 +146,7 @@ describe('Class: AsyncBatchProcessor', () => {
       });
     });
 
-    test('Batch processing Kinesis records with all failures', async () => {
+    it('completes processing with all failures', async () => {
       // Prepare
       const firstRecord = kinesisRecordFactory('failure');
       const secondRecord = kinesisRecordFactory('failure');
@@ -171,7 +166,7 @@ describe('Class: AsyncBatchProcessor', () => {
   });
 
   describe('Asynchronously processing DynamoDB Records', () => {
-    test('Batch processing DynamoDB records with no failures', async () => {
+    it('completes processing with no failures', async () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('success');
       const secondRecord = dynamodbRecordFactory('success');
@@ -189,7 +184,7 @@ describe('Class: AsyncBatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing DynamoDB records with some failures', async () => {
+    it('completes processing with some failures', async () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('failure');
       const secondRecord = dynamodbRecordFactory('success');
@@ -216,7 +211,7 @@ describe('Class: AsyncBatchProcessor', () => {
       });
     });
 
-    test('Batch processing DynamoDB records with all failures', async () => {
+    it('completes processing with all failures', async () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('failure');
       const secondRecord = dynamodbRecordFactory('failure');
@@ -236,7 +231,7 @@ describe('Class: AsyncBatchProcessor', () => {
   });
 
   describe('Batch processing with Lambda context', () => {
-    test('Batch processing when context is provided and handler accepts', async () => {
+    it('passes the context to the record handler', async () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -254,25 +249,7 @@ describe('Class: AsyncBatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing when context is provided and handler does not accept', async () => {
-      // Prepare
-      const firstRecord = sqsRecordFactory('success');
-      const secondRecord = sqsRecordFactory('success');
-      const records = [firstRecord, secondRecord];
-      const processor = new BatchProcessor(EventType.SQS);
-
-      // Act
-      processor.register(records, asyncSqsRecordHandler, options);
-      const processedMessages = await processor.process();
-
-      // Assess
-      expect(processedMessages).toStrictEqual([
-        ['success', firstRecord.body, firstRecord],
-        ['success', secondRecord.body, secondRecord],
-      ]);
-    });
-
-    test('Batch processing when malformed context is provided and handler attempts to use', async () => {
+    it('throws an error when passing an invalid context object', async () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -289,7 +266,7 @@ describe('Class: AsyncBatchProcessor', () => {
     });
   });
 
-  test('When calling the sync process method, it should throw an error', () => {
+  it('throws an error when the sync process method is called', () => {
     // Prepare
     const processor = new BatchProcessor(EventType.SQS);
 

packages/batch/tests/unit/BasePartialProcessor.test.ts

@@ -1,10 +1,6 @@
-/**
- * Test BatchProcessorSync class
- *
- * @group unit/batch/class/batchprocessorsync
- */
 import context from '@aws-lambda-powertools/testing-utils/context';
 import type { Context } from 'aws-lambda';
+import { afterAll, beforeEach, describe, expect, it, vi } from 'vitest';
 import {
   BatchProcessingError,
   BatchProcessorSync,
@@ -31,8 +27,7 @@ describe('Class: BatchProcessor', () => {
   };
 
   beforeEach(() => {
-    jest.clearAllMocks();
-    jest.resetModules();
+    vi.clearAllMocks();
     process.env = { ...ENVIRONMENT_VARIABLES };
   });
 
@@ -41,7 +36,7 @@ describe('Class: BatchProcessor', () => {
   });
 
   describe('Synchronously processing SQS Records', () => {
-    test('Batch processing SQS records with no failures', () => {
+    it('Batch processing SQS records with no failures', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -59,7 +54,7 @@ describe('Class: BatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing SQS records with some failures', () => {
+    it('Batch processing SQS records with some failures', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('failure');
       const secondRecord = sqsRecordFactory('success');
@@ -86,7 +81,7 @@ describe('Class: BatchProcessor', () => {
       });
     });
 
-    test('Batch processing SQS records with all failures', () => {
+    it('Batch processing SQS records with all failures', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('failure');
       const secondRecord = sqsRecordFactory('failure');
@@ -102,7 +97,7 @@ describe('Class: BatchProcessor', () => {
   });
 
   describe('Synchronously processing Kinesis Records', () => {
-    test('Batch processing Kinesis records with no failures', () => {
+    it('Batch processing Kinesis records with no failures', () => {
       // Prepare
       const firstRecord = kinesisRecordFactory('success');
       const secondRecord = kinesisRecordFactory('success');
@@ -120,7 +115,7 @@ describe('Class: BatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing Kinesis records with some failures', () => {
+    it('Batch processing Kinesis records with some failures', () => {
       // Prepare
       const firstRecord = kinesisRecordFactory('failure');
       const secondRecord = kinesisRecordFactory('success');
@@ -147,7 +142,7 @@ describe('Class: BatchProcessor', () => {
       });
     });
 
-    test('Batch processing Kinesis records with all failures', () => {
+    it('Batch processing Kinesis records with all failures', () => {
       const firstRecord = kinesisRecordFactory('failure');
       const secondRecord = kinesisRecordFactory('failure');
       const thirdRecord = kinesisRecordFactory('fail');
@@ -164,7 +159,7 @@ describe('Class: BatchProcessor', () => {
   });
 
   describe('Synchronously processing DynamoDB Records', () => {
-    test('Batch processing DynamoDB records with no failures', () => {
+    it('Batch processing DynamoDB records with no failures', () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('success');
       const secondRecord = dynamodbRecordFactory('success');
@@ -182,7 +177,7 @@ describe('Class: BatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing DynamoDB records with some failures', () => {
+    it('Batch processing DynamoDB records with some failures', () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('failure');
       const secondRecord = dynamodbRecordFactory('success');
@@ -209,7 +204,7 @@ describe('Class: BatchProcessor', () => {
       });
     });
 
-    test('Batch processing DynamoDB records with all failures', () => {
+    it('Batch processing DynamoDB records with all failures', () => {
       // Prepare
       const firstRecord = dynamodbRecordFactory('failure');
       const secondRecord = dynamodbRecordFactory('failure');
@@ -227,7 +222,7 @@ describe('Class: BatchProcessor', () => {
   });
 
   describe('Batch processing with Lambda context', () => {
-    test('Batch processing when context is provided and handler accepts', () => {
+    it('Batch processing when context is provided and handler accepts', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -245,7 +240,7 @@ describe('Class: BatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing when context is provided and handler does not accept', () => {
+    it('Batch processing when context is provided and handler does not accept', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -263,7 +258,7 @@ describe('Class: BatchProcessor', () => {
       ]);
     });
 
-    test('Batch processing when malformed context is provided and handler attempts to use', () => {
+    it('Batch processing when malformed context is provided and handler attempts to use', () => {
       // Prepare
       const firstRecord = sqsRecordFactory('success');
       const secondRecord = sqsRecordFactory('success');
@@ -274,11 +269,13 @@ describe('Class: BatchProcessor', () => {
 
       // Act
       processor.register(records, handlerWithContext, badOptions);
+
+      // Assess
       expect(() => processor.processSync()).toThrowError(FullBatchFailureError);
     });
   });
 
-  test('When calling the async process method, it should throw an error', async () => {
+  it('throws an error when calling the async method', async () => {
     // Prepare
     const processor = new BatchProcessorSync(EventType.SQS);