CCM-12896: Add unit tests for typescript-schema-generator

Author: gareth-allan

package-lock.json

@@ -8,7 +8,7 @@ sonar.tests=tests/, src/asyncapigenerator/tests, src/cloudeventjekylldocs/tests,
 sonar.test.inclusions=tests/**, src/**/tests/**, src/**/__tests__/**, lambdas/**/src/__tests__/**, utils/utils/src/__tests__/**
 sonar.terraform.provider.aws.version=5.54.1
 sonar.cpd.exclusions=**.test.*
-sonar.coverage.exclusions=tests/**, src/**/tests/**, src/**/__tests__/**, **/*.dev.*, lambdas/**/src/__tests__/**, **/jest.config.ts, **/jest.config.cjs, scripts/**/*.*, docs/**/*.*, utils/utils/src/__tests__/**, src/asyncapigenerator/example_usage.py, src/asyncapigenerator/test_generator.py, src/eventcatalogasyncapiimporter/examples.py, src/typescript-schema-generator/**
+sonar.coverage.exclusions=tests/**, src/**/tests/**, src/**/__tests__/**, **/*.dev.*, lambdas/**/src/__tests__/**, **/jest.config.ts, **/jest.config.cjs, scripts/**/*.*, docs/**/*.*, utils/utils/src/__tests__/**, src/asyncapigenerator/example_usage.py, src/asyncapigenerator/test_generator.py, src/eventcatalogasyncapiimporter/examples.py
 
 sonar.python.coverage.reportPaths=src/asyncapigenerator/coverage.xml,src/cloudeventjekylldocs/coverage.xml,src/eventcatalogasyncapiimporter/coverage.xml
 sonar.javascript.lcov.reportPaths=lcov.info,src/cloudevents/coverage/lcov.info

scripts/config/sonar-scanner.properties

@@ -0,0 +1,12 @@
+import { baseJestConfig } from '../../jest.config.base';
+
+const config = {
+  ...baseJestConfig,
+  coveragePathIgnorePatterns: [
+    ...(baseJestConfig.coveragePathIgnorePatterns ?? []),
+    'src/generate-types-cli.ts',
+    'src/generate-validators-cli.ts',
+  ],
+};
+
+export default config;

src/typescript-schema-generator/jest.config.ts

@@ -6,7 +6,12 @@
   },
   "description": "Generate Typescript types and standalone validator functions for the application's event schemas.",
   "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/mock-fs": "^4.13.4",
+    "cross-env": "^10.1.0",
     "eslint": "^9.39.1",
+    "jest": "^29.7.0",
+    "mock-fs": "^5.5.0",
     "rimraf": "^5.0.10",
     "tsx": "^4.20.6"
   },
@@ -23,11 +28,11 @@
   "scripts": {
     "clean": "rimraf types validators",
     "generate-dependencies": "npm run generate-types && npm run generate-validators",
-    "generate-types": "tsx src/generate-types.ts",
-    "generate-validators": "tsx src/generate-validators.ts",
+    "generate-types": "tsx src/generate-types-cli.ts",
+    "generate-validators": "tsx src/generate-validators-cli.ts",
     "lint": "eslint src",
     "lint:fix": "eslint src --fix",
-    "test:unit": "echo \"No unit tests configured\"",
+    "test:unit": "cross-env NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\" jest",
     "typecheck": "tsc --noEmit"
   },
   "version": "0.0.1"

src/typescript-schema-generator/package.json

@@ -0,0 +1,56 @@
+/* eslint-disable security/detect-non-literal-fs-filename */
+
+import { eventSchemasDir } from 'file-utils';
+import { generateTypes } from 'generate-types';
+import { compile } from 'json-schema-to-typescript';
+import mockFs from 'mock-fs';
+import { readFileSync, readdirSync } from 'node:fs';
+import path from 'node:path';
+
+jest.mock('json-schema-to-typescript');
+
+describe('generate-types', () => {
+  const outputDir = path.resolve(__dirname, '..', '..', 'types');
+
+  beforeEach(() => {
+    mockFs({
+      [eventSchemasDir]: {
+        'one.flattened.schema.json': '{"title": "One"}',
+        'two.flattened.schema.json': '{"title": "Two"}',
+        'three.flattened.schema.json': '{"title": "Three"}',
+      },
+    });
+
+    jest.mocked(compile).mockResolvedValue('Some TS code');
+
+    jest.spyOn(console, 'log').mockImplementation(() => {});
+    jest.spyOn(console, 'group').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  it('should generate a type declaration file for each schema', async () => {
+    await generateTypes();
+
+    const typeDeclarationFiles = readdirSync(outputDir);
+
+    expect(typeDeclarationFiles.length).toBe(4); // 3 schemas + 1 index file
+    expect(typeDeclarationFiles).toEqual(
+      expect.arrayContaining(['One.d.ts', 'Two.d.ts', 'Three.d.ts']),
+    );
+  });
+
+  it('should create an index file exporting all generated types', async () => {
+    await generateTypes();
+
+    const indexFileContents = readFileSync(
+      path.join(outputDir, 'index.d.ts'),
+      'utf8',
+    );
+    expect(indexFileContents).toContain("export * from './One';");
+    expect(indexFileContents).toContain("export * from './Two';");
+    expect(indexFileContents).toContain("export * from './Three';");
+  });
+});

src/typescript-schema-generator/src/__tests__/generate-types.test.ts

@@ -0,0 +1,62 @@
+/* eslint-disable security/detect-non-literal-fs-filename */
+import standaloneCode from 'ajv/dist/standalone';
+import { eventSchemasDir } from 'file-utils';
+import { generateValidators } from 'generate-validators';
+import mockFs from 'mock-fs';
+import { readFileSync, readdirSync } from 'node:fs';
+import path from 'node:path';
+
+jest.mock('ajv/dist/2020');
+jest.mock('ajv/dist/standalone');
+
+describe('generate-validators', () => {
+  const outputDir = path.resolve(__dirname, '..', '..', 'validators');
+
+  beforeEach(() => {
+    mockFs({
+      [eventSchemasDir]: {
+        'one.flattened.schema.json': '{"title": "One"}',
+        'two.flattened.schema.json': '{"title": "Two"}',
+        'three.flattened.schema.json': '{"title": "Three"}',
+      },
+    });
+
+    jest.mocked(standaloneCode).mockReturnValue('Some validator code');
+
+    jest.spyOn(console, 'log').mockImplementation(() => {});
+    jest.spyOn(console, 'group').mockImplementation(() => {});
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  it('should generate a validator function file for each schema', () => {
+    generateValidators();
+
+    const validatorFunctionFiles = readdirSync(outputDir);
+
+    expect(validatorFunctionFiles.length).toBe(4); // 3 schemas + 1 index file
+    expect(validatorFunctionFiles).toEqual(
+      expect.arrayContaining(['One.js', 'Two.js', 'Three.js']),
+    );
+  });
+
+  it('should create an index file declaring modules for all generated files', () => {
+    generateValidators();
+
+    const indexFileContents = readFileSync(
+      path.join(outputDir, 'index.d.ts'),
+      'utf8',
+    );
+    expect(indexFileContents).toContain(
+      "declare module 'typescript-schema-generator/One.js';",
+    );
+    expect(indexFileContents).toContain(
+      "declare module 'typescript-schema-generator/Two.js';",
+    );
+    expect(indexFileContents).toContain(
+      "declare module 'typescript-schema-generator/Three.js';",
+    );
+  });
+});

src/typescript-schema-generator/src/__tests__/generate-validators.test.ts

@@ -0,0 +1,8 @@
+/* eslint-disable no-console */
+
+import { generateTypes } from 'generate-types';
+
+generateTypes().catch((error) => {
+  console.error('Error generating types:', error);
+  throw error;
+});

src/typescript-schema-generator/src/generate-types-cli.ts

@@ -10,10 +10,12 @@ import {
   writeTypesIndex,
 } from 'file-utils';
 
-const eventSchemaFilenames = listEventSchemas();
-const outputDir = createOutputDir('types');
+export async function generateTypes() {
+  const eventSchemaFilenames = listEventSchemas();
+  const outputDir = createOutputDir('types');
+  console.log(`Output directory created at ${outputDir}`);
 
-async function generateTypes() {
+  console.group('Writing type declaration files:');
   const indexLines: string[] = [];
   for (const eventSchemaFilename of eventSchemaFilenames) {
     const eventSchemaPath = path.join(eventSchemasDir, eventSchemaFilename);
@@ -25,16 +27,15 @@ async function generateTypes() {
     });
 
     // Write a .d.ts file named after the schema title or file.
-    writeFile(outputDir, `${typeName}.d.ts`, eventTs);
+    const typeDeclarationFilename = `${typeName}.d.ts`;
+    writeFile(outputDir, typeDeclarationFilename, eventTs);
+    console.log(typeDeclarationFilename);
 
     // Also create an export statement for this type.
     indexLines.push(`export * from './${typeName}';`);
   }
+  console.groupEnd();
 
   writeTypesIndex(outputDir, indexLines);
+  console.log('index.d.ts file written');
 }
-
-generateTypes().catch((error) => {
-  console.error('Error generating types:', error);
-  throw error;
-});

src/typescript-schema-generator/src/generate-types.ts

@@ -0,0 +1,3 @@
+import { generateValidators } from 'generate-validators';
+
+generateValidators();