@geekmidas/cli 9.0.2 → 10.0.0-alpha.1

package/src/__tests__/openapi.spec.ts

@@ -1,625 +0,0 @@
-import { existsSync, realpathSync } from 'node:fs';
-import { mkdir, readFile, rm } from 'node:fs/promises';
-import { join } from 'node:path';
-import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
-import type { GkmConfig } from '../types';
-import {
-	cleanupDir,
-	createMockEndpointFile,
-	createTempDir,
-	createTestFile,
-} from './test-helpers';
-
-const spawnCalls: Array<{ cmd: string; args: string[]; cwd: string }> = [];
-let mockSpawnExitCode = 0;
-
-vi.mock('node:child_process', async (importOriginal) => {
-	const actual = await importOriginal<typeof import('node:child_process')>();
-	return {
-		...actual,
-		spawn: vi.fn((cmd: string, args: string[], opts: any) => {
-			spawnCalls.push({ cmd, args: args ?? [], cwd: opts?.cwd ?? '' });
-			const child: any = {
-				on(event: string, cb: (code?: number) => void) {
-					if (event === 'close') queueMicrotask(() => cb(mockSpawnExitCode));
-					return child;
-				},
-			};
-			return child;
-		}),
-	};
-});
-
-const {
-	generateOpenApi,
-	OPENAPI_OUTPUT_PATH,
-	openapiCommand,
-	resolveOpenApiConfig,
-} = await import('../openapi');
-
-describe('resolveOpenApiConfig', () => {
-	const baseConfig: GkmConfig = {
-		routes: './src/endpoints/**/*.ts',
-		envParser: './src/config/env#envParser',
-		logger: './src/config/logger#logger',
-	};
-
-	it('should return disabled when openapi is false', () => {
-		const result = resolveOpenApiConfig({ ...baseConfig, openapi: false });
-		expect(result).toEqual({ enabled: false });
-	});
-
-	it('should return enabled with defaults when openapi is true', () => {
-		const result = resolveOpenApiConfig({ ...baseConfig, openapi: true });
-		expect(result).toEqual({
-			enabled: true,
-			title: 'API Documentation',
-			version: '1.0.0',
-			description: 'Auto-generated API documentation from endpoints',
-		});
-	});
-
-	it('should return enabled by default when openapi is undefined', () => {
-		const result = resolveOpenApiConfig({ ...baseConfig });
-		expect(result.enabled).toBe(true);
-	});
-
-	it('should use custom config values when provided', () => {
-		const result = resolveOpenApiConfig({
-			...baseConfig,
-			openapi: {
-				enabled: true,
-				title: 'My API',
-				version: '2.0.0',
-				description: 'Custom description',
-			},
-		});
-		expect(result).toEqual({
-			enabled: true,
-			title: 'My API',
-			version: '2.0.0',
-			description: 'Custom description',
-		});
-	});
-
-	it('should use defaults for missing optional config values', () => {
-		const result = resolveOpenApiConfig({
-			...baseConfig,
-			openapi: { enabled: true },
-		});
-		expect(result).toEqual({
-			enabled: true,
-			title: 'API Documentation',
-			version: '1.0.0',
-			description: 'Auto-generated API documentation from endpoints',
-		});
-	});
-
-	it('should be enabled by default when object provided without enabled field', () => {
-		const result = resolveOpenApiConfig({
-			...baseConfig,
-			openapi: { title: 'Custom Title' },
-		});
-		expect(result.enabled).toBe(true);
-	});
-});
-
-describe('generateOpenApi', () => {
-	let tempDir: string;
-	const originalCwd = process.cwd();
-
-	beforeEach(async () => {
-		tempDir = realpathSync(await createTempDir('openapi-gen-'));
-		// Change to temp dir so output goes there
-		process.chdir(tempDir);
-	});
-
-	afterEach(async () => {
-		process.chdir(originalCwd);
-		await cleanupDir(tempDir);
-		vi.restoreAllMocks();
-	});
-
-	it('should return null when openapi is disabled', async () => {
-		const config: GkmConfig = {
-			routes: './src/endpoints/**/*.ts',
-			envParser: './src/config/env#envParser',
-			logger: './src/config/logger#logger',
-			openapi: false,
-		};
-
-		const result = await generateOpenApi(config);
-		expect(result).toBeNull();
-	});
-
-	it('should return null when no endpoints are found', async () => {
-		const config: GkmConfig = {
-			routes: './src/endpoints/**/*.ts', // Path doesn't exist
-			envParser: './src/config/env#envParser',
-			logger: './src/config/logger#logger',
-		};
-
-		const result = await generateOpenApi(config);
-		expect(result).toBeNull();
-	});
-
-	it('should generate to fixed .gkm/openapi.ts path', async () => {
-		await createMockEndpointFile(tempDir, 'test.ts', 'test', '/test', 'GET');
-
-		const config: GkmConfig = {
-			routes: `${tempDir}/**/*.ts`,
-			envParser: './src/config/env#envParser',
-			logger: './src/config/logger#logger',
-			openapi: { enabled: true },
-		};
-
-		const result = await generateOpenApi(config, { silent: true });
-
-		expect(result).not.toBeNull();
-		expect(result?.endpointCount).toBe(1);
-		expect(result?.outputPath).toBe(join(tempDir, OPENAPI_OUTPUT_PATH));
-		expect(existsSync(join(tempDir, OPENAPI_OUTPUT_PATH))).toBe(true);
-	});
-
-	it('should generate TypeScript content', async () => {
-		await createMockEndpointFile(tempDir, 'test.ts', 'test', '/test', 'GET');
-
-		const config: GkmConfig = {
-			routes: `${tempDir}/**/*.ts`,
-			envParser: './src/config/env#envParser',
-			logger: './src/config/logger#logger',
-			openapi: { enabled: true },
-		};
-
-		await generateOpenApi(config, { silent: true });
-
-		const content = await readFile(join(tempDir, OPENAPI_OUTPUT_PATH), 'utf-8');
-		expect(content).toContain('// Auto-generated by @geekmidas/cli');
-		expect(content).toContain('export const securitySchemes');
-		expect(content).toContain('export interface paths');
-	});
-
-	it('should log no endpoints message when none found', async () => {
-		const config: GkmConfig = {
-			routes: `${tempDir}/nonexistent/**/*.ts`,
-			envParser: './src/config/env#envParser',
-			logger: './src/config/logger#logger',
-			openapi: { enabled: true },
-		};
-
-		const consoleSpy = vi.spyOn(console, 'log');
-		const result = await generateOpenApi(config);
-
-		expect(result).toBeNull();
-		expect(consoleSpy).toHaveBeenCalledWith(
-			'No valid endpoints found for OpenAPI generation',
-		);
-	});
-});
-
-describe('openapiCommand', () => {
-	let tempDir: string;
-	const originalCwd = process.cwd();
-
-	beforeEach(async () => {
-		tempDir = realpathSync(await createTempDir('openapi-cmd-'));
-	});
-
-	afterEach(async () => {
-		process.chdir(originalCwd);
-		// Clean up any generated .gkm folder in current directory
-		await rm(join(originalCwd, '.gkm'), { recursive: true, force: true });
-		await cleanupDir(tempDir);
-		vi.restoreAllMocks();
-	});
-
-	it('should generate OpenAPI client to .gkm/openapi.ts', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'test.ts',
-			'testEndpoint',
-			'/test',
-			'GET',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		// Change to temp dir so output goes there
-		process.chdir(tempDir);
-
-		await openapiCommand({ cwd: tempDir });
-
-		const outputPath = join(tempDir, OPENAPI_OUTPUT_PATH);
-		expect(existsSync(outputPath)).toBe(true);
-
-		const content = await readFile(outputPath, 'utf-8');
-		expect(content).toContain('// Auto-generated by @geekmidas/cli');
-	});
-
-	it('should enable openapi with defaults when not configured', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'test.ts',
-			'testEndpoint',
-			'/test',
-			'GET',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-			}),
-		);
-
-		process.chdir(tempDir);
-		const consoleSpy = vi.spyOn(console, 'log');
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(consoleSpy).toHaveBeenCalledWith(
-			expect.stringContaining('Found 1 endpoints'),
-		);
-		expect(existsSync(join(tempDir, OPENAPI_OUTPUT_PATH))).toBe(true);
-	});
-
-	it('should include endpoint auth map', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'getUser.ts',
-			'getUser',
-			'/users/:id',
-			'GET',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-
-		await openapiCommand({ cwd: tempDir });
-
-		const content = await readFile(join(tempDir, OPENAPI_OUTPUT_PATH), 'utf-8');
-		expect(content).toContain('endpointAuth');
-		expect(content).toContain("'GET /users/{id}'");
-	});
-
-	it('should handle no endpoints found', async () => {
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/nonexistent/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-		const consoleSpy = vi.spyOn(console, 'log');
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(consoleSpy).toHaveBeenCalledWith(
-			'No valid endpoints found for OpenAPI generation',
-		);
-	});
-
-	it('should generate with multiple endpoints', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'getUsers.ts',
-			'getUsers',
-			'/users',
-			'GET',
-		);
-		await createMockEndpointFile(
-			tempDir,
-			'createUser.ts',
-			'createUser',
-			'/users',
-			'POST',
-		);
-		await createMockEndpointFile(
-			tempDir,
-			'deleteUser.ts',
-			'deleteUser',
-			'/users/:id',
-			'DELETE',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-		const consoleSpy = vi.spyOn(console, 'log');
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(consoleSpy).toHaveBeenCalledWith(
-			expect.stringContaining('Found 3 endpoints'),
-		);
-	});
-
-	it('should create .gkm directory if it does not exist', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'endpoint.ts',
-			'testEndpoint',
-			'/test',
-			'GET',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(existsSync(join(tempDir, '.gkm'))).toBe(true);
-		expect(existsSync(join(tempDir, OPENAPI_OUTPUT_PATH))).toBe(true);
-	});
-
-	it('should throw error when config loading fails', async () => {
-		process.chdir(tempDir);
-
-		await expect(openapiCommand({ cwd: tempDir })).rejects.toThrow(
-			/OpenAPI generation failed/,
-		);
-	});
-
-	it('should throw error for invalid TypeScript files', async () => {
-		await createTestFile(
-			tempDir,
-			'invalid.ts',
-			'this is not valid typescript {[}]',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-
-		await expect(openapiCommand({ cwd: tempDir })).rejects.toThrow(
-			/OpenAPI generation failed/,
-		);
-	});
-
-	it('should log generation success', async () => {
-		await createMockEndpointFile(
-			tempDir,
-			'endpoint.ts',
-			'testEndpoint',
-			'/test',
-			'GET',
-		);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-		const consoleSpy = vi.spyOn(console, 'log');
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(consoleSpy).toHaveBeenCalledWith(
-			expect.stringContaining('OpenAPI client generated'),
-		);
-		expect(consoleSpy).toHaveBeenCalledWith(
-			expect.stringContaining('Found 1 endpoints'),
-		);
-	});
-
-	it('should handle endpoints with complex schemas', async () => {
-		const complexEndpointContent = `
-import { e } from '@geekmidas/constructs/endpoints';
-import { z } from 'zod';
-
-export const complexEndpoint = e
-  .post('/complex')
-  .body(z.object({
-    user: z.object({
-      name: z.string(),
-      email: z.string().email(),
-      age: z.number().optional(),
-    }),
-    tags: z.array(z.string()),
-  }))
-  .output(z.object({
-    id: z.string(),
-    status: z.enum(['active', 'inactive']),
-  }))
-  .handle(async () => ({ id: '123', status: 'active' as const }));
-`;
-
-		await createTestFile(tempDir, 'complex.ts', complexEndpointContent);
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				routes: [`${tempDir}/**/*.ts`],
-				openapi: { enabled: true },
-			}),
-		);
-
-		process.chdir(tempDir);
-
-		await openapiCommand({ cwd: tempDir });
-
-		const content = await readFile(join(tempDir, OPENAPI_OUTPUT_PATH), 'utf-8');
-		expect(content).toContain('export interface paths');
-	});
-});
-
-describe('openapiCommand - workspace mode', () => {
-	let tempDir: string;
-	const originalCwd = process.cwd();
-
-	beforeEach(async () => {
-		tempDir = realpathSync(await createTempDir('openapi-workspace-'));
-	});
-
-	afterEach(async () => {
-		process.chdir(originalCwd);
-		await cleanupDir(tempDir);
-		vi.restoreAllMocks();
-	});
-
-	it('should generate OpenAPI for a single app via --app flag', async () => {
-		// Create workspace structure
-		const apiDir = join(tempDir, 'apps/api');
-		await mkdir(apiDir, { recursive: true });
-
-		// Create endpoint in backend app
-		await createMockEndpointFile(
-			apiDir,
-			'src/endpoints/users.ts',
-			'getUsers',
-			'/users',
-			'GET',
-		);
-
-		// Create workspace config (gkm.config.json)
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				name: 'test-workspace',
-				apps: {
-					api: {
-						type: 'backend',
-						path: 'apps/api',
-						port: 3000,
-						routes: './src/endpoints/**/*.ts',
-						openapi: { enabled: true },
-					},
-				},
-			}),
-		);
-
-		// Subprocess invocation simulated: CWD = appPath, --app passed
-		process.chdir(apiDir);
-		const consoleSpy = vi.spyOn(console, 'log');
-
-		await openapiCommand({ cwd: tempDir, app: 'api' });
-
-		// Should generate OpenAPI in the backend app's .gkm folder
-		const outputPath = join(apiDir, OPENAPI_OUTPUT_PATH);
-		expect(existsSync(outputPath)).toBe(true);
-
-		const content = await readFile(outputPath, 'utf-8');
-		expect(content).toContain('export interface paths');
-		expect(content).toContain("'/users'");
-
-		expect(consoleSpy).toHaveBeenCalledWith(
-			expect.stringContaining('[api] Generated OpenAPI'),
-		);
-	});
-
-	it('should throw when --app references unknown app', async () => {
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				name: 'test-workspace',
-				apps: {
-					api: {
-						type: 'backend',
-						path: 'apps/api',
-						port: 3000,
-						routes: './src/endpoints/**/*.ts',
-						openapi: { enabled: true },
-					},
-				},
-			}),
-		);
-
-		await expect(
-			openapiCommand({ cwd: tempDir, app: 'missing' }),
-		).rejects.toThrow(/App "missing" not found/);
-	});
-
-	it('should spawn one subprocess per backend app in multi-app mode', async () => {
-		// Create workspace with two backend apps
-		const apiDir = join(tempDir, 'apps/api');
-		const adminDir = join(tempDir, 'apps/admin');
-		await mkdir(apiDir, { recursive: true });
-		await mkdir(adminDir, { recursive: true });
-
-		await createTestFile(
-			tempDir,
-			'gkm.config.json',
-			JSON.stringify({
-				name: 'test-workspace',
-				apps: {
-					api: {
-						type: 'backend',
-						path: 'apps/api',
-						port: 3000,
-						routes: './src/endpoints/**/*.ts',
-						openapi: { enabled: true },
-					},
-					admin: {
-						type: 'backend',
-						path: 'apps/admin',
-						port: 3001,
-						routes: './src/endpoints/**/*.ts',
-						openapi: { enabled: true },
-					},
-				},
-			}),
-		);
-
-		spawnCalls.length = 0;
-		mockSpawnExitCode = 0;
-
-		await openapiCommand({ cwd: tempDir });
-
-		expect(spawnCalls).toHaveLength(2);
-		expect(spawnCalls[0]?.cwd).toBe(apiDir);
-		expect(spawnCalls[0]?.args).toContain('--app');
-		expect(spawnCalls[0]?.args).toContain('api');
-		expect(spawnCalls[1]?.cwd).toBe(adminDir);
-		expect(spawnCalls[1]?.args).toContain('--app');
-		expect(spawnCalls[1]?.args).toContain('admin');
-	});
-});