@kya-os/create-mcpi-app 1.7.19 → 1.7.20

package/src/__tests__/helpers/validate-project-structure.test.ts

@@ -0,0 +1,467 @@
+/**
+ * Validate Project Structure Tests
+ *
+ * Tests for project structure validation, file existence checks,
+ * package.json validation, and error messages.
+ */
+
+import { describe, it, expect, beforeEach, afterEach, vi } from 'vitest';
+import {
+  validateProjectStructure,
+  ensureLockfile,
+  type ProjectStructureValidation
+} from '../../helpers/validate-project-structure';
+import fs from 'fs-extra';
+import path from 'path';
+
+describe('validateProjectStructure', () => {
+  let tempDir: string;
+
+  beforeEach(() => {
+    tempDir = path.join(process.cwd(), 'test-temp', `validate-test-${Date.now()}-${Math.random().toString(36).substring(7)}`);
+    fs.ensureDirSync(tempDir);
+  });
+
+  afterEach(() => {
+    if (fs.existsSync(tempDir)) {
+      fs.removeSync(tempDir);
+    }
+    if (fs.existsSync(path.join(process.cwd(), 'test-temp'))) {
+      const testTempContents = fs.readdirSync(path.join(process.cwd(), 'test-temp'));
+      if (testTempContents.length === 0) {
+        fs.removeSync(path.join(process.cwd(), 'test-temp'));
+      }
+    }
+  });
+
+  describe('Project structure validation', () => {
+    it('should validate identity-enabled project structure correctly', () => {
+      // Create identity-enabled project structure
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js',
+          init: 'tsx src/init.ts',
+          register: 'tsx src/register.ts',
+          'keys:rotate': 'tsx src/rotate-keys.ts',
+          'identity:clean': 'tsx src/clean-identity.ts',
+          status: 'tsx src/status.ts'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), '.mcpi/\nnode_modules/');
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(true);
+      expect(result.issues.length).toBe(0);
+    });
+
+    it('should validate vanilla project structure correctly', () => {
+      // Create vanilla project structure
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/');
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(true);
+      expect(result.issues.length).toBe(0);
+    });
+
+    it('should detect missing package.json', () => {
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('package.json not found');
+    });
+
+    it('should detect incorrect script count for identity project', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc'
+          // Missing required scripts
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues.length).toBeGreaterThan(0);
+      expect(result.issues.some(issue => issue.includes('Expected exactly 8 scripts'))).toBe(true);
+    });
+
+    it('should detect incorrect script count for vanilla project', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts'
+          // Missing build and start
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues.some(issue => issue.includes('Expected exactly 3 scripts'))).toBe(true);
+    });
+
+    it('should detect missing required scripts', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js',
+          init: 'tsx src/init.ts',
+          register: 'tsx src/register.ts',
+          'keys:rotate': 'tsx src/rotate-keys.ts',
+          'identity:clean': 'tsx src/clean-identity.ts'
+          // Missing 'status' script
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('Missing required script: status');
+    });
+  });
+
+  describe('File existence checks', () => {
+    it('should detect missing greet.ts file', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      // greet.ts is missing
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/');
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('Missing required file: src/tools/greet.ts');
+    });
+
+    it('should detect missing .gitignore file', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      // .gitignore is missing
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('Missing required file: .gitignore');
+    });
+
+    it('should detect missing xmcp.config.ts file', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/');
+      // xmcp.config.ts is missing
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('Missing required file: xmcp.config.ts');
+    });
+
+    it('should validate all required files exist', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/');
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(true);
+      expect(result.issues.length).toBe(0);
+    });
+  });
+
+  describe('package.json validation', () => {
+    it('should handle package.json without scripts', () => {
+      const packageJson = {
+        name: 'test-project',
+        version: '1.0.0'
+        // No scripts property
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues.length).toBeGreaterThan(0);
+    });
+
+    it('should handle package.json with empty scripts', () => {
+      const packageJson = {
+        scripts: {}
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues.length).toBeGreaterThan(0);
+    });
+
+    it('should validate correct number of scripts', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js',
+          init: 'tsx src/init.ts',
+          register: 'tsx src/register.ts',
+          'keys:rotate': 'tsx src/rotate-keys.ts',
+          'identity:clean': 'tsx src/clean-identity.ts',
+          status: 'tsx src/status.ts'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), '.mcpi/\nnode_modules/');
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(true);
+    });
+  });
+
+  describe('Error messages', () => {
+    it('should provide clear error messages for missing scripts', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts'
+          // Missing scripts
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.issues.length).toBeGreaterThan(0);
+      result.issues.forEach(issue => {
+        expect(typeof issue).toBe('string');
+        expect(issue.length).toBeGreaterThan(0);
+      });
+    });
+
+    it('should provide clear error messages for missing files', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      // Missing required files
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.issues.length).toBeGreaterThan(0);
+      result.issues.forEach(issue => {
+        expect(issue).toMatch(/Missing required (file|script)/);
+      });
+    });
+
+    it('should include file path in error messages', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      // greet.ts is missing
+
+      const result = validateProjectStructure(tempDir, false);
+
+      const greetIssue = result.issues.find(issue => issue.includes('greet.ts'));
+      expect(greetIssue).toBeDefined();
+      expect(greetIssue).toContain('src/tools/greet.ts');
+    });
+  });
+
+  describe('.gitignore validation for identity projects', () => {
+    it('should require .mcpi/ in .gitignore for identity projects', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js',
+          init: 'tsx src/init.ts',
+          register: 'tsx src/register.ts',
+          'keys:rotate': 'tsx src/rotate-keys.ts',
+          'identity:clean': 'tsx src/clean-identity.ts',
+          status: 'tsx src/status.ts'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/'); // Missing .mcpi/
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, true);
+
+      expect(result.valid).toBe(false);
+      expect(result.issues).toContain('.gitignore should include .mcpi/ directory');
+    });
+
+    it('should not require .mcpi/ in .gitignore for vanilla projects', () => {
+      const packageJson = {
+        scripts: {
+          dev: 'tsx src/index.ts',
+          build: 'tsc',
+          start: 'node dist/index.js'
+        }
+      };
+
+      fs.writeJsonSync(path.join(tempDir, 'package.json'), packageJson);
+      fs.ensureDirSync(path.join(tempDir, 'src', 'tools'));
+      fs.writeFileSync(path.join(tempDir, 'src', 'tools', 'greet.ts'), '// greet tool');
+      fs.writeFileSync(path.join(tempDir, '.gitignore'), 'node_modules/'); // No .mcpi/ required
+      fs.writeFileSync(path.join(tempDir, 'xmcp.config.ts'), '// config');
+
+      const result = validateProjectStructure(tempDir, false);
+
+      expect(result.valid).toBe(true);
+      expect(result.issues.length).toBe(0);
+    });
+  });
+
+  describe('ensureLockfile', () => {
+    it('should detect npm lockfile', () => {
+      fs.writeFileSync(path.join(tempDir, 'package-lock.json'), '{}');
+      const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
+
+      ensureLockfile(tempDir, 'npm');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Lockfile created')
+      );
+
+      consoleSpy.mockRestore();
+    });
+
+    it('should detect yarn lockfile', () => {
+      fs.writeFileSync(path.join(tempDir, 'yarn.lock'), '# yarn lock');
+      const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
+
+      ensureLockfile(tempDir, 'yarn');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Lockfile created')
+      );
+
+      consoleSpy.mockRestore();
+    });
+
+    it('should detect pnpm lockfile', () => {
+      fs.writeFileSync(path.join(tempDir, 'pnpm-lock.yaml'), '# pnpm lock');
+      const consoleSpy = vi.spyOn(console, 'log').mockImplementation(() => {});
+
+      ensureLockfile(tempDir, 'pnpm');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Lockfile created')
+      );
+
+      consoleSpy.mockRestore();
+    });
+
+    it('should warn when lockfile not found', () => {
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+      ensureLockfile(tempDir, 'npm');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Lockfile not found')
+      );
+
+      consoleSpy.mockRestore();
+    });
+
+    it('should handle unknown package manager', () => {
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {});
+
+      ensureLockfile(tempDir, 'unknown' as any);
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('Unknown package manager')
+      );
+
+      consoleSpy.mockRestore();
+    });
+  });
+});
+