add vitest to ami-housekeeper

Author: npalm

lambdas/functions/ami-housekeeper/aws-vitest-setup.ts

@@ -0,0 +1,2 @@
+// Setup AWS SDK client mock matchers
+import 'aws-sdk-client-mock-jest/vitest';

lambdas/functions/ami-housekeeper/convert-to-vitest.js

@@ -0,0 +1,152 @@
+#!/usr/bin/env node
+
+const fs = require('fs');
+const path = require('path');
+
+// Find all test files in the package
+const findTestFiles = (dir) => {
+  let results = [];
+  const files = fs.readdirSync(dir);
+  
+  for (const file of files) {
+    const filePath = path.join(dir, file);
+    const stat = fs.statSync(filePath);
+    
+    if (stat.isDirectory()) {
+      results = results.concat(findTestFiles(filePath));
+    } else if (file.endsWith('.test.ts')) {
+      results.push(filePath);
+    }
+  }
+  
+  return results;
+};
+
+// Convert Jest syntax to Vitest syntax
+const convertJestToVitest = (filePath) => {
+  console.log(`Converting ${filePath}`);
+  let content = fs.readFileSync(filePath, 'utf8');
+  
+  // Add import for Vitest functions if it doesn't already exist
+  if (!content.includes('import { describe, it, expect, beforeEach, vi } from \'vitest\';')) {
+    // Find the last import statement
+    const lastImportIndex = content.lastIndexOf('import ');
+    if (lastImportIndex !== -1) {
+      const endOfImportIndex = content.indexOf(';', lastImportIndex);
+      if (endOfImportIndex !== -1) {
+        content = 
+          content.slice(0, endOfImportIndex + 1) + 
+          '\nimport { describe, it, expect, beforeEach, vi } from \'vitest\';\n' + 
+          content.slice(endOfImportIndex + 1);
+      }
+    }
+  }
+  
+  // Replace Jest specific functions with Vitest equivalents
+  content = content.replace(/jest\./g, 'vi.');
+  content = content.replace(/jest\(/g, 'vi(');
+  
+  // Replace test() with it()
+  content = content.replace(/test\(/g, 'it(');
+  
+  // Replace mocked with vi.mocked
+  if (content.includes('import { mocked } from \'jest-mock\';')) {
+    content = content.replace('import { mocked } from \'jest-mock\';', '');
+    content = content.replace(/mocked\(/g, 'vi.mocked(');
+  }
+  
+  fs.writeFileSync(filePath, content, 'utf8');
+  console.log(`Converted ${filePath}`);
+};
+
+// Create a custom matcher utility function if it doesn't exist
+const createTestUtilsFile = () => {
+  const utilsPath = path.join(__dirname, 'src', 'test-utils.ts');
+  
+  // Check if directory exists, create if not
+  const dir = path.dirname(utilsPath);
+  if (!fs.existsSync(dir)) {
+    fs.mkdirSync(dir, { recursive: true });
+  }
+  
+  // If file doesn't exist, create it
+  if (!fs.existsSync(utilsPath)) {
+    console.log(`Creating test utilities file at ${utilsPath}`);
+    const content = `import { AwsClientStubSpy } from 'aws-sdk-client-mock';
+import { expect } from 'vitest';
+
+/**
+ * Helper function to check if a command was received with specific input.
+ * This provides similar functionality to toHaveReceivedCommandWith from aws-sdk-client-mock-jest.
+ */
+export function expectCommandCalledWith(mockClient: AwsClientStubSpy, command: any, expectedInput: any) {
+  const calls = mockClient.commandCalls(command);
+  expect(calls.length).toBeGreaterThan(0);
+  expect(calls[0].args[0].input).toEqual(expectedInput);
+}
+
+/**
+ * Helper function to check if a command was called a specific number of times.
+ * This provides similar functionality to toHaveReceivedCommandTimes from aws-sdk-client-mock-jest.
+ */
+export function expectCommandCalledTimes(mockClient: AwsClientStubSpy, command: any, times: number) {
+  const calls = mockClient.commandCalls(command);
+  expect(calls.length).toBe(times);
+}
+
+/**
+ * Helper function to check if a command was called at all.
+ * This provides similar functionality to toHaveReceivedCommand from aws-sdk-client-mock-jest.
+ */
+export function expectCommandCalled(mockClient: AwsClientStubSpy, command: any) {
+  const calls = mockClient.commandCalls(command);
+  expect(calls.length).toBeGreaterThan(0);
+}
+
+/**
+ * Helper function to check if a command was not called.
+ */
+export function expectCommandNotCalled(mockClient: AwsClientStubSpy, command: any) {
+  const calls = mockClient.commandCalls(command);
+  expect(calls.length).toBe(0);
+}`;
+    
+    fs.writeFileSync(utilsPath, content, 'utf8');
+    console.log(`Created test utilities file at ${utilsPath}`);
+  } else {
+    console.log(`Test utilities file already exists at ${utilsPath}`);
+  }
+  
+  return utilsPath;
+};
+
+// Main function
+const main = () => {
+  // Create test utilities file
+  createTestUtilsFile();
+  
+  const rootDir = path.join(__dirname, 'src');
+  const testFiles = findTestFiles(rootDir);
+  
+  console.log(`Found ${testFiles.length} test files to convert`);
+  
+  let processed = 0;
+  let failed = 0;
+  
+  for (const file of testFiles) {
+    try {
+      convertJestToVitest(file);
+      processed++;
+    } catch (error) {
+      console.error(`Error processing ${file}:`, error);
+      failed++;
+    }
+  }
+  
+  console.log(`\nSummary:`);
+  console.log(`- Total: ${testFiles.length} files`);
+  console.log(`- Processed: ${processed} files`);
+  console.log(`- Failed: ${failed} files`);
+};
+
+main();

lambdas/functions/ami-housekeeper/src/ami.test.ts

@@ -14,9 +14,10 @@ import {
   SSMClient,
 } from '@aws-sdk/client-ssm';
 import { mockClient } from 'aws-sdk-client-mock';
-import 'aws-sdk-client-mock-jest';
 
 import { AmiCleanupOptions, amiCleanup, defaultAmiCleanupOptions } from './ami';
+import { describe, it, expect, beforeEach, vi } from 'vitest';
+
 
 process.env.AWS_REGION = 'eu-east-1';
 const deleteAmisOlderThenDays = 30;
@@ -76,7 +77,7 @@ const ssmParameters: DescribeParametersCommandOutput = {
 
 describe("delete AMI's", () => {
   beforeEach(() => {
-    jest.resetAllMocks();
+    vi.resetAllMocks();
     mockEC2Client.reset();
     mockSSMClient.reset();
 

lambdas/functions/ami-housekeeper/src/lambda.test.ts

@@ -1,12 +1,14 @@
 import { logger } from '@aws-github-runner/aws-powertools-util';
 import { Context } from 'aws-lambda';
-import { mocked } from 'jest-mock';
+
 
 import { AmiCleanupOptions, amiCleanup } from './ami';
 import { handler } from './lambda';
+import { describe, it, expect, beforeEach, beforeAll, vi } from 'vitest';
+
 
-jest.mock('./ami');
-jest.mock('@aws-github-runner/aws-powertools-util');
+vi.mock('./ami');
+vi.mock('@aws-github-runner/aws-powertools-util');
 
 const amiCleanupOptions: AmiCleanupOptions = {
   minimumDaysOld: undefined,
@@ -42,11 +44,11 @@ const context: Context = {
 // Docs for testing async with jest: https://jestjs.io/docs/tutorial-async
 describe('Housekeeper ami', () => {
   beforeAll(() => {
-    jest.resetAllMocks();
+    vi.resetAllMocks();
   });
 
   it('should not throw or log in error.', async () => {
-    const mock = mocked(amiCleanup);
+    const mock = vi.mocked(amiCleanup);
     mock.mockImplementation(() => {
       return new Promise((resolve) => {
         resolve();
@@ -56,10 +58,10 @@ describe('Housekeeper ami', () => {
   });
 
   it('should not thow only log in error in case of an exception.', async () => {
-    const logSpy = jest.spyOn(logger, 'error');
+    const logSpy = vi.spyOn(logger, 'error');
 
     const error = new Error('An error.');
-    const mock = mocked(amiCleanup);
+    const mock = vi.mocked(amiCleanup);
     mock.mockRejectedValue(error);
     await expect(handler(undefined, context)).resolves.toBeUndefined();
 

lambdas/functions/ami-housekeeper/vitest.config.ts

@@ -0,0 +1,18 @@
+import { mergeConfig } from 'vitest/config';
+import defaultConfig from '../../vitest.base.config';
+
+export default mergeConfig(defaultConfig, {
+  test: {
+    setupFiles: ['./aws-vitest-setup.ts'],
+    coverage: {
+      include: ['src/**/*.ts'],
+      exclude: ['src/**/*.test.ts', 'src/**/*.d.ts'],
+      thresholds: {
+        statements: 100,
+        branches: 100,
+        functions: 100,
+        lines: 100,
+      }
+    },
+  },
+});