CCM-10591: Lambda Boilerplate

Author: jamesthompson26-nhs

lambdas/example-lambda/src/__tests__/index.test.ts

@@ -1,10 +1,11 @@
 import { handler } from '../index';
+import type { Context } from 'aws-lambda';
 import { mockDeep } from 'jest-mock-extended';
 
 describe('event-logging Lambda', () => {
   it('logs the input event and returns 200', async () => {
     const event = { foo: 'bar' };
-    const context = mockDeep<any>();
+    const context = mockDeep<Context>();
     const callback = jest.fn();
     const result = await handler(event, context, callback);
 

lambdas/example-lambda/src/jest.config.js

@@ -0,0 +1,60 @@
+import type { Config } from 'jest';
+
+export const baseJestConfig: Config = {
+  preset: 'ts-jest',
+
+  // Automatically clear mock calls, instances, contexts and results before every test
+  clearMocks: true,
+
+  // Indicates whether the coverage information should be collected while executing the test
+  collectCoverage: true,
+
+  // The directory where Jest should output its coverage files
+  coverageDirectory: './.reports/unit/coverage',
+
+  // Indicates which provider should be used to instrument code for coverage
+  coverageProvider: 'babel',
+
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: -10,
+    },
+  },
+
+  coveragePathIgnorePatterns: ['/__tests__/'],
+  transform: { '^.+\\.ts$': '@swc/jest' },
+  testPathIgnorePatterns: ['.build'],
+  testMatch: ['**/?(*.)+(spec|test).[jt]s?(x)'],
+
+  // Use this configuration option to add custom reporters to Jest
+  reporters: [
+    'default',
+    [
+      'jest-html-reporter',
+      {
+        pageTitle: 'Test Report',
+        outputPath: './.reports/unit/test-report.html',
+        includeFailureMsg: true,
+      },
+    ],
+  ],
+
+  // The test environment that will be used for testing
+  testEnvironment: 'jsdom',
+};
+
+const utilsJestConfig = {
+  ...baseJestConfig,
+
+  testEnvironment: 'node',
+
+  coveragePathIgnorePatterns: [
+    ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
+    'zod-validators.ts',
+  ],
+};
+
+export default utilsJestConfig;