@sk8metal/michi-cli 0.5.0 → 0.8.0

package/scripts/utils/__tests__/multi-repo-validator.test.ts

@@ -0,0 +1,335 @@
+/**
+ * Multi-Repo バリデーション関数のテスト
+ * Task 1.2: バリデーション関数の実装
+ */
+
+import { describe, it, expect } from 'vitest';
+import {
+  validateProjectName,
+  validateJiraKey,
+  validateRepositoryUrl,
+} from '../multi-repo-validator';
+
+describe('validateProjectName', () => {
+  describe('正常ケース', () => {
+    it('有効なプロジェクト名を受け入れる', () => {
+      const validNames = [
+        'my-project',
+        'プロジェクト名',
+        'project_v2',
+        'My Project 123',
+        'a',
+        'a'.repeat(100),
+      ];
+
+      validNames.forEach((name) => {
+        const result = validateProjectName(name);
+        expect(result.isValid).toBe(true);
+        expect(result.errors).toHaveLength(0);
+      });
+    });
+  });
+
+  describe('パストラバーサル対策', () => {
+    it('スラッシュ（/）を含む場合はエラー', () => {
+      const result = validateProjectName('project/name');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain path traversal characters (/, \\)',
+      );
+    });
+
+    it('バックスラッシュ（\\）を含む場合はエラー', () => {
+      const result = validateProjectName('project\\name');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain path traversal characters (/, \\)',
+      );
+    });
+
+    it('../を含む場合はエラー', () => {
+      const result = validateProjectName('../etc/passwd');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain path traversal characters (/, \\)',
+      );
+    });
+
+    it('/を含む場合はエラー', () => {
+      const result = validateProjectName('/etc/passwd');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain path traversal characters (/, \\)',
+      );
+    });
+  });
+
+  describe('相対パス対策', () => {
+    it('ドット（.）単独の場合はエラー', () => {
+      const result = validateProjectName('.');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not be relative path components (., ..)',
+      );
+    });
+
+    it('ダブルドット（..）単独の場合はエラー', () => {
+      const result = validateProjectName('..');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not be relative path components (., ..)',
+      );
+    });
+  });
+
+  describe('制御文字対策', () => {
+    it('ヌル文字（\\x00）を含む場合はエラー', () => {
+      const result = validateProjectName('project\x00name');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+
+    it('タブ文字（\\t）を含む場合はエラー', () => {
+      const result = validateProjectName('project\tname');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+
+    it('改行文字（\\n）を含む場合はエラー', () => {
+      const result = validateProjectName('project\nname');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+
+    it('改行文字（\\r）を含む場合はエラー', () => {
+      const result = validateProjectName('project\rname');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+
+    it('エスケープ文字（\\x1B）を含む場合はエラー', () => {
+      const result = validateProjectName('project\x1Bname');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+
+    it('削除文字（\\x7F）を含む場合はエラー', () => {
+      const result = validateProjectName('project\x7Fname');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must not contain control characters',
+      );
+    });
+  });
+
+  describe('長さチェック', () => {
+    it('101文字以上の場合はエラー', () => {
+      const longName = 'a'.repeat(101);
+      const result = validateProjectName(longName);
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must be between 1 and 100 characters',
+      );
+    });
+
+    it('空文字列の場合はエラー', () => {
+      const result = validateProjectName('');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Project name must be between 1 and 100 characters',
+      );
+    });
+
+    it('100文字の場合は正常', () => {
+      const name = 'a'.repeat(100);
+      const result = validateProjectName(name);
+      expect(result.isValid).toBe(true);
+    });
+
+    it('1文字の場合は正常', () => {
+      const result = validateProjectName('a');
+      expect(result.isValid).toBe(true);
+    });
+  });
+});
+
+describe('validateJiraKey', () => {
+  describe('正常ケース', () => {
+    it('2-10文字の大文字英字を受け入れる', () => {
+      const validKeys = ['AB', 'PROJ', 'TICKET', 'ABCDEFGHIJ'];
+
+      validKeys.forEach((key) => {
+        const result = validateJiraKey(key);
+        expect(result.isValid).toBe(true);
+        expect(result.errors).toHaveLength(0);
+      });
+    });
+  });
+
+  describe('異常ケース', () => {
+    it('小文字を含む場合はエラー', () => {
+      const result = validateJiraKey('abc');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('1文字の場合はエラー', () => {
+      const result = validateJiraKey('A');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('11文字以上の場合はエラー', () => {
+      const result = validateJiraKey('ABCDEFGHIJK');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('数字を含む場合はエラー', () => {
+      const result = validateJiraKey('ABC123');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('空文字列の場合はエラー', () => {
+      const result = validateJiraKey('');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('ハイフンを含む場合はエラー', () => {
+      const result = validateJiraKey('ABC-DEF');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+
+    it('スペースを含む場合はエラー', () => {
+      const result = validateJiraKey('ABC DEF');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'JIRA key must be 2-10 uppercase letters',
+      );
+    });
+  });
+});
+
+describe('validateRepositoryUrl', () => {
+  describe('正常ケース', () => {
+    it('有効なGitHub HTTPS URLを受け入れる', () => {
+      const validUrls = [
+        'https://github.com/owner/repo',
+        'https://github.com/my-org/my-repo',
+        'https://github.com/user123/project-name',
+      ];
+
+      validUrls.forEach((url) => {
+        const result = validateRepositoryUrl(url);
+        expect(result.isValid).toBe(true);
+        expect(result.errors).toHaveLength(0);
+      });
+    });
+  });
+
+  describe('異常ケース', () => {
+    it('GitLab URLの場合はエラー', () => {
+      const result = validateRepositoryUrl(
+        'https://gitlab.com/owner/repo',
+      );
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Repository URL must be in GitHub format: https://github.com/{owner}/{repo}',
+      );
+    });
+
+    it('HTTP URLの場合はエラー', () => {
+      const result = validateRepositoryUrl('http://github.com/owner/repo');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Repository URL must use HTTPS protocol',
+      );
+    });
+
+    it('SSH URLの場合はエラー', () => {
+      const result = validateRepositoryUrl('git@github.com:owner/repo.git');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Repository URL must be in GitHub format: https://github.com/{owner}/{repo}',
+      );
+    });
+
+    it('不完全なURLの場合はエラー', () => {
+      const result = validateRepositoryUrl('https://github.com/owner');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Repository URL must be in GitHub format: https://github.com/{owner}/{repo}',
+      );
+    });
+
+    it('空文字列の場合はエラー', () => {
+      const result = validateRepositoryUrl('');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain('Repository URL is empty');
+    });
+
+    it('無効なURL形式の場合はエラー', () => {
+      const result = validateRepositoryUrl('not-a-url');
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain('Repository URL format is invalid');
+    });
+
+    it('.git拡張子を含む場合はエラー', () => {
+      const result = validateRepositoryUrl(
+        'https://github.com/owner/repo.git',
+      );
+      expect(result.isValid).toBe(false);
+      expect(result.errors).toContain(
+        'Repository URL must not include .git extension',
+      );
+    });
+  });
+
+  describe('プレースホルダー検出', () => {
+    it('プレースホルダーURLの場合はエラー', () => {
+      const placeholders = [
+        'https://github.com/your-org/your-repo',
+        'https://github.com/owner/repo-name',
+      ];
+
+      placeholders.forEach((url) => {
+        const result = validateRepositoryUrl(url);
+        if (
+          url.includes('your-org') ||
+          url.includes('your-repo') ||
+          url.includes('repo-name')
+        ) {
+          expect(result.isValid).toBe(false);
+          expect(result.errors).toContain(
+            'Repository URL contains placeholder values',
+          );
+        }
+      });
+    });
+  });
+});

package/scripts/utils/config-loader.ts

@@ -3,12 +3,19 @@
  * デフォルト設定 + プロジェクト固有設定をマージ
  */
 
-import { readFileSync, existsSync, statSync } from 'fs';
-import { resolve, relative, isAbsolute } from 'path';
+import { readFileSync, writeFileSync, existsSync, statSync, renameSync, unlinkSync, mkdirSync } from 'fs';
+import { resolve, relative, isAbsolute, dirname } from 'path';
 import { fileURLToPath } from 'url';
 import { homedir } from 'os';
 import { config, parse as dotenvParse } from 'dotenv';
-import { AppConfigSchema, type AppConfig } from '../config/config-schema.js';
+import {
+  AppConfigSchema,
+  MultiRepoProjectSchema,
+  RepositorySchema,
+  type AppConfig,
+  type MultiRepoProject,
+  type Repository,
+} from '../config/config-schema.js';
 
 // 環境変数読み込み
 config();
@@ -612,3 +619,190 @@ export function getConfigPath(projectRoot: string = process.cwd()): string {
   return resolveConfigPath(projectRoot);
 }
 
+/**
+ * Multi-Repo管理関数
+ */
+
+/**
+ * 設定ファイルをアトミックに保存
+ * 一時ファイルに書き込んでからrenameすることでアトミック性を保証
+ */
+function saveConfig(
+  config: Partial<AppConfig>,
+  projectRoot: string = process.cwd(),
+): void {
+  const configPath = resolveConfigPath(projectRoot);
+  const tempPath = `${configPath}.tmp`;
+
+  try {
+    // .michiディレクトリが存在しない場合は作成
+    const configDir = dirname(configPath);
+    if (!existsSync(configDir)) {
+      mkdirSync(configDir, { recursive: true });
+    }
+
+    // 一時ファイルに書き込み
+    writeFileSync(tempPath, JSON.stringify(config, null, 2), 'utf-8');
+
+    // アトミックにリネーム
+    renameSync(tempPath, configPath);
+
+    // キャッシュをクリア
+    clearConfigCache();
+  } catch (error) {
+    // エラー時は一時ファイルを削除
+    if (existsSync(tempPath)) {
+      try {
+        unlinkSync(tempPath);
+      } catch {
+        // 削除失敗は無視
+      }
+    }
+    throw error;
+  }
+}
+
+/**
+ * プロジェクト名でMulti-Repoプロジェクトを検索
+ */
+export function findProject(
+  projectName: string,
+  projectRoot: string = process.cwd(),
+): MultiRepoProject | null {
+  const configPath = resolveConfigPath(projectRoot);
+
+  if (!existsSync(configPath)) {
+    return null;
+  }
+
+  try {
+    const config = loadProjectConfig(projectRoot);
+    if (!config?.multiRepoProjects) {
+      return null;
+    }
+
+    const project = config.multiRepoProjects.find(
+      (p) => p.name === projectName,
+    );
+    return project || null;
+  } catch {
+    return null;
+  }
+}
+
+/**
+ * Multi-Repoプロジェクトを追加
+ */
+export function addMultiRepoProject(
+  project: MultiRepoProject,
+  projectRoot: string = process.cwd(),
+): { success: boolean; project?: MultiRepoProject; error?: string } {
+  try {
+    // Zodスキーマでバリデーション
+    const validatedProject = MultiRepoProjectSchema.parse(project);
+
+    // 既存の設定を読み込み
+    const existingConfig = loadProjectConfig(projectRoot) || {};
+    const multiRepoProjects = existingConfig.multiRepoProjects || [];
+
+    // 重複チェック
+    const existingProject = multiRepoProjects.find(
+      (p) => p.name === validatedProject.name,
+    );
+    if (existingProject) {
+      return {
+        success: false,
+        error: `Project "${validatedProject.name}" already exists`,
+      };
+    }
+
+    // プロジェクトを追加
+    const updatedConfig = {
+      ...existingConfig,
+      multiRepoProjects: [...multiRepoProjects, validatedProject],
+    };
+
+    // 設定を保存
+    saveConfig(updatedConfig, projectRoot);
+
+    return {
+      success: true,
+      project: validatedProject,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : 'Unknown error',
+    };
+  }
+}
+
+/**
+ * Multi-Repoプロジェクトにリポジトリを追加
+ */
+export function addRepositoryToProject(
+  projectName: string,
+  repository: Repository,
+  projectRoot: string = process.cwd(),
+): { success: boolean; repository?: Repository; error?: string } {
+  try {
+    // Zodスキーマでバリデーション
+    const validatedRepo = RepositorySchema.parse(repository);
+
+    // 既存の設定を読み込み
+    const existingConfig = loadProjectConfig(projectRoot) || {};
+    const multiRepoProjects = existingConfig.multiRepoProjects || [];
+
+    // プロジェクトを検索
+    const projectIndex = multiRepoProjects.findIndex(
+      (p) => p.name === projectName,
+    );
+    if (projectIndex === -1) {
+      return {
+        success: false,
+        error: `Project "${projectName}" not found`,
+      };
+    }
+
+    const project = multiRepoProjects[projectIndex];
+
+    // 重複チェック
+    const existingRepo = project.repositories.find(
+      (r) => r.name === validatedRepo.name,
+    );
+    if (existingRepo) {
+      return {
+        success: false,
+        error: `Repository "${validatedRepo.name}" already exists in project "${projectName}"`,
+      };
+    }
+
+    // リポジトリを追加
+    const updatedProject = {
+      ...project,
+      repositories: [...project.repositories, validatedRepo],
+    };
+
+    // プロジェクト配列を更新
+    const updatedProjects = [...multiRepoProjects];
+    updatedProjects[projectIndex] = updatedProject;
+
+    // 設定を保存
+    const updatedConfig = {
+      ...existingConfig,
+      multiRepoProjects: updatedProjects,
+    };
+    saveConfig(updatedConfig, projectRoot);
+
+    return {
+      success: true,
+      repository: validatedRepo,
+    };
+  } catch (error) {
+    return {
+      success: false,
+      error: error instanceof Error ? error.message : 'Unknown error',
+    };
+  }
+}
+

package/scripts/utils/multi-repo-validator.ts

@@ -0,0 +1,141 @@
+/**
+ * multi-repo-validator.ts
+ * Multi-Repo機能のバリデーションユーティリティ
+ *
+ * プロジェクト名、JIRAキー、リポジトリURLのバリデーションとセキュリティチェックを行います。
+ */
+
+/**
+ * バリデーション結果
+ */
+export interface ValidationResult {
+  isValid: boolean;
+  errors: string[];
+  warnings: string[];
+}
+
+/**
+ * プロジェクト名のバリデーション
+ * セキュリティ対策: パストラバーサル、相対パス、制御文字をチェック
+ */
+export function validateProjectName(name: string): ValidationResult {
+  const errors: string[] = [];
+  const warnings: string[] = [];
+
+  // 長さチェック: 1-100文字
+  if (name.length < 1 || name.length > 100) {
+    errors.push('Project name must be between 1 and 100 characters');
+  }
+
+  // パストラバーサル対策: '/', '\' 禁止
+  if (name.includes('/') || name.includes('\\')) {
+    errors.push(
+      'Project name must not contain path traversal characters (/, \\)',
+    );
+  }
+
+  // 相対パス対策: '.', '..' 禁止
+  if (name === '.' || name === '..') {
+    errors.push(
+      'Project name must not be relative path components (., ..)',
+    );
+  }
+
+  // 制御文字対策: \x00-\x1F, \x7F 禁止
+  // eslint-disable-next-line no-control-regex
+  const controlCharRegex = /[\x00-\x1F\x7F]/;
+  if (controlCharRegex.test(name)) {
+    errors.push('Project name must not contain control characters');
+  }
+
+  return {
+    isValid: errors.length === 0,
+    errors,
+    warnings,
+  };
+}
+
+/**
+ * JIRAキーのバリデーション
+ * 2-10文字の大文字英字のみ許可
+ */
+export function validateJiraKey(key: string): ValidationResult {
+  const errors: string[] = [];
+  const warnings: string[] = [];
+
+  // 正規表現: 2-10文字の大文字英字
+  const jiraKeyRegex = /^[A-Z]{2,10}$/;
+
+  if (!jiraKeyRegex.test(key)) {
+    errors.push('JIRA key must be 2-10 uppercase letters');
+  }
+
+  return {
+    isValid: errors.length === 0,
+    errors,
+    warnings,
+  };
+}
+
+/**
+ * リポジトリURLのバリデーション
+ * GitHub HTTPS URL形式のみ許可
+ */
+export function validateRepositoryUrl(url: string): ValidationResult {
+  const errors: string[] = [];
+  const warnings: string[] = [];
+
+  // 空文字列チェック
+  if (!url || url.trim() === '') {
+    errors.push('Repository URL is empty');
+    return { isValid: false, errors, warnings };
+  }
+
+  // SSH URL検出（git@github.com:形式）
+  if (url.startsWith('git@')) {
+    errors.push(
+      'Repository URL must be in GitHub format: https://github.com/{owner}/{repo}',
+    );
+    return { isValid: false, errors, warnings };
+  }
+
+  // URL形式チェック
+  try {
+    const parsedUrl = new URL(url);
+
+    // HTTPSプロトコルチェック
+    if (parsedUrl.protocol !== 'https:') {
+      errors.push('Repository URL must use HTTPS protocol');
+    }
+
+    // GitHub URL形式チェック: https://github.com/{owner}/{repo}
+    const githubPattern = /^https:\/\/github\.com\/[^/]+\/[^/]+$/;
+    if (!githubPattern.test(url)) {
+      errors.push(
+        'Repository URL must be in GitHub format: https://github.com/{owner}/{repo}',
+      );
+    }
+
+    // .git拡張子チェック
+    if (url.endsWith('.git')) {
+      errors.push('Repository URL must not include .git extension');
+    }
+
+    // プレースホルダー検出
+    if (
+      url.includes('your-org') ||
+      url.includes('your-repo') ||
+      url.includes('repo-name')
+    ) {
+      errors.push('Repository URL contains placeholder values');
+    }
+  } catch (_error) {
+    errors.push('Repository URL format is invalid');
+  }
+
+  return {
+    isValid: errors.length === 0,
+    errors,
+    warnings,
+  };
+}