@sk8metal/michi-cli 0.4.0 → 0.7.0

package/scripts/__tests__/test-script-runner.test.ts

@@ -0,0 +1,217 @@
+/**
+ * Tests for TestScriptRunner
+ */
+
+import { describe, it, expect, vi, beforeEach, afterEach } from 'vitest';
+import { TestScriptRunner } from '../test-script-runner.js';
+import * as child_process from 'child_process';
+
+vi.mock('child_process');
+
+// カスタムエラー型の定義
+interface ExecError extends Error {
+  status?: number;
+  code?: string;
+  stderr?: Buffer;
+}
+
+describe('TestScriptRunner', () => {
+  let runner: TestScriptRunner;
+
+  beforeEach(() => {
+    vi.clearAllMocks();
+    runner = new TestScriptRunner();
+    vi.useFakeTimers();
+  });
+
+  afterEach(() => {
+    vi.restoreAllMocks();
+    vi.useRealTimers();
+  });
+
+  describe('正常ケース', () => {
+    it('テストスクリプト実行が成功（終了コード0）', async () => {
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Test passed'));
+
+      const startTime = Date.now();
+      vi.setSystemTime(startTime);
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.success).toBe(true);
+      expect(result.exitCode).toBe(0);
+      expect(result.executionTime).toBeGreaterThanOrEqual(0);
+      expect(result.outputPath).toContain('docs/michi/my-project/tests/results/e2e-');
+      expect(result.error).toBeUndefined();
+    });
+
+    it('統合テスト実行が成功', async () => {
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Integration test passed'));
+
+      const result = await runner.runTestScript('my-project', 'integration');
+
+      expect(result.success).toBe(true);
+      expect(result.exitCode).toBe(0);
+      expect(result.outputPath).toContain('integration-');
+    });
+
+    it('パフォーマンステスト実行が成功', async () => {
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Performance test passed'));
+
+      const result = await runner.runTestScript('my-project', 'performance');
+
+      expect(result.success).toBe(true);
+      expect(result.exitCode).toBe(0);
+      expect(result.outputPath).toContain('performance-');
+    });
+
+    it('実行時間を正しく計測', async () => {
+      const startTime = Date.now();
+      vi.setSystemTime(startTime);
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        // 5秒後に完了をシミュレート
+        vi.setSystemTime(startTime + 5000);
+        return Buffer.from('Test passed');
+      });
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.executionTime).toBeCloseTo(5, 1);
+    });
+  });
+
+  describe('テスト失敗ケース', () => {
+    it('テストスクリプト実行が失敗（終了コード非0）', async () => {
+      const error: ExecError = new Error('Command failed');
+      error.status = 1;
+      error.stderr = Buffer.from('Test failed: assertion error');
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.success).toBe(false);
+      expect(result.exitCode).toBe(1);
+      expect(result.error).toContain('Test failed');
+    });
+
+    it('終了コード2のテスト失敗', async () => {
+      const error: ExecError = new Error('Command failed');
+      error.status = 2;
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      const result = await runner.runTestScript('my-project', 'integration');
+
+      expect(result.success).toBe(false);
+      expect(result.exitCode).toBe(2);
+    });
+  });
+
+  describe('エラーハンドリング', () => {
+    it('スクリプト実行タイムアウトの場合はエラー', async () => {
+      const error: ExecError = new Error('Timeout');
+      error.code = 'ETIMEDOUT';
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain('Timeout');
+    });
+
+    it('パーミッションエラーの場合はエラー', async () => {
+      const error: ExecError = new Error('Permission denied');
+      error.code = 'EACCES';
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain('Permission denied');
+    });
+
+    it('スクリプト未存在エラーの場合はエラー', async () => {
+      const error: ExecError = new Error('Script not found');
+      error.code = 'ENOENT';
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      const result = await runner.runTestScript('my-project', 'e2e');
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain('Script not found');
+    });
+  });
+
+  describe('カスタムプロジェクトルート', () => {
+    it('カスタムプロジェクトルートを指定できる', async () => {
+      const customRoot = '/custom/path';
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Test passed'));
+
+      const result = await runner.runTestScript('my-project', 'e2e', customRoot);
+
+      expect(result.success).toBe(true);
+      expect(child_process.execSync).toHaveBeenCalledWith(
+        expect.stringContaining(`${customRoot}/docs/michi/my-project/tests/scripts/run-e2e.sh`),
+        expect.any(Object)
+      );
+    });
+  });
+
+  describe('ログ出力', () => {
+    it('実行前にログを出力', async () => {
+      const consoleSpy = vi.spyOn(console, 'log');
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Test passed'));
+
+      await runner.runTestScript('my-project', 'e2e');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('🚀 テストスクリプトを実行中')
+      );
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('テストタイプ: e2e')
+      );
+    });
+
+    it('成功時に成功メッセージを表示', async () => {
+      const consoleSpy = vi.spyOn(console, 'log');
+      vi.spyOn(child_process, 'execSync').mockReturnValue(Buffer.from('Test passed'));
+
+      await runner.runTestScript('my-project', 'e2e');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('✅ テスト実行が成功しました')
+      );
+    });
+
+    it('失敗時に失敗メッセージを表示', async () => {
+      const consoleSpy = vi.spyOn(console, 'log');
+      const error: ExecError = new Error('Command failed');
+      error.status = 1;
+
+      vi.spyOn(child_process, 'execSync').mockImplementation(() => {
+        throw error;
+      });
+
+      await runner.runTestScript('my-project', 'e2e');
+
+      expect(consoleSpy).toHaveBeenCalledWith(
+        expect.stringContaining('❌ テスト実行が失敗しました')
+      );
+    });
+  });
+});

package/scripts/config/config-schema.ts

@@ -146,6 +146,92 @@ export const ValidationConfigSchema = z.object({
   weekendExclusion: z.boolean().default(true),
 });
 
+/**
+ * Atlassian設定スキーマ
+ */
+export const AtlassianConfigSchema = z.object({
+  url: z.string().optional(),
+  email: z.string().optional(),
+  apiToken: z.string().optional(),
+});
+
+/**
+ * プロジェクトメタデータスキーマ
+ */
+export const ProjectMetaSchema = z.object({
+  projectId: z.string().min(1),
+  projectName: z.string().min(1),
+  language: z.enum(['ja', 'en']).optional(),
+  jiraProjectKey: z.string().optional(),
+  confluenceLabels: z.array(z.string()).optional(),
+  status: z.string().optional(),
+  team: z.array(z.string()).optional(),
+  stakeholders: z.array(z.string()).optional(),
+  repository: z.string().optional(),
+  description: z.string().optional(),
+});
+
+/**
+ * Multi-Repo リポジトリスキーマ
+ */
+export const RepositorySchema = z.object({
+  name: z.string().min(1),
+  url: z
+    .string()
+    .url()
+    .regex(/^https:\/\/github\.com\/[^/]+\/[^/]+$/, {
+      message: 'GitHub URL must be in format: https://github.com/{owner}/{repo}',
+    }),
+  branch: z.string().default('main'),
+});
+
+/**
+ * Multi-Repo プロジェクトスキーマ
+ */
+export const MultiRepoProjectSchema = z.object({
+  name: z
+    .string()
+    .min(1, { message: 'Project name must be at least 1 character' })
+    .max(100, { message: 'Project name must be at most 100 characters' })
+    .refine(
+      (name) => {
+        // パストラバーサル対策: '/', '\' 禁止
+        if (name.includes('/') || name.includes('\\')) {
+          return false;
+        }
+        // 相対パス対策: '.', '..' 禁止
+        if (name === '.' || name === '..') {
+          return false;
+        }
+        // 制御文字対策: \x00-\x1F, \x7F 禁止
+        // eslint-disable-next-line no-control-regex
+        const controlCharRegex = /[\x00-\x1F\x7F]/;
+        if (controlCharRegex.test(name)) {
+          return false;
+        }
+        return true;
+      },
+      {
+        message:
+          'Project name must not contain path traversal characters (/, \\), relative path components (., ..), or control characters',
+      },
+    ),
+  jiraKey: z
+    .string()
+    .min(1)
+    .regex(/^[A-Z]{2,10}$/, {
+      message: 'JIRA key must be 2-10 uppercase letters',
+    }),
+  confluenceSpace: z.string().min(1, {
+    message: 'Confluence space must be a non-empty string',
+  }),
+  createdAt: z.string().datetime({
+    offset: true,
+    message: 'createdAt must be in ISO 8601 format',
+  }),
+  repositories: z.array(RepositorySchema).default([]),
+});
+
 /**
  * 全体設定スキーマ
  */
@@ -154,6 +240,9 @@ export const AppConfigSchema = z.object({
   jira: JiraConfigSchema.optional(),
   workflow: WorkflowConfigSchema.optional(),
   validation: ValidationConfigSchema.optional(),
+  atlassian: AtlassianConfigSchema.optional(),
+  project: ProjectMetaSchema.optional(),
+  multiRepoProjects: z.array(MultiRepoProjectSchema).default([]),
 });
 
 /**
@@ -177,4 +266,19 @@ export type JiraStatusMapping = z.infer<typeof JiraStatusMappingSchema>;
 export type JiraConfig = z.infer<typeof JiraConfigSchema>;
 export type WorkflowConfig = z.infer<typeof WorkflowConfigSchema>;
 export type ValidationConfig = z.infer<typeof ValidationConfigSchema>;
+export type AtlassianConfig = z.infer<typeof AtlassianConfigSchema>;
+export type ProjectMeta = z.infer<typeof ProjectMetaSchema>;
+export type Repository = z.infer<typeof RepositorySchema>;
+export type MultiRepoProject = z.infer<typeof MultiRepoProjectSchema>;
 export type AppConfig = z.infer<typeof AppConfigSchema>;
+
+/**
+ * 設定の読み込み元
+ */
+export type ConfigSource =
+  | 'default'        // default-config.json
+  | 'global-env'     // ~/.michi/.env
+  | 'global-config'  // ~/.michi/config.json
+  | 'project-meta'   // .kiro/project.json
+  | 'project-config' // .michi/config.json
+  | 'project-env';   // .env

package/scripts/confluence-sync.ts

@@ -17,6 +17,20 @@ import { updateSpecJsonAfterConfluenceSync, loadSpecJson } from './utils/spec-up
 // 環境変数読み込み
 config();
 
+/**
+ * セキュリティ: CQLクエリ文字列のエスケープ
+ * CQLインジェクション対策: バックスラッシュと引用符を適切にエスケープ
+ *
+ * @param str - エスケープする文字列
+ * @returns エスケープされた文字列
+ */
+function escapeCQL(str: string): string {
+  return str
+    .replace(/\\/g, '\\\\')  // バックスラッシュを先にエスケープ（重要: 最初に実行）
+    .replace(/"/g, '\\"')    // ダブルクォート
+    .replace(/'/g, '\\\'');  // シングルクォート
+}
+
 /**
  * Confluence APIページレスポンス
  */
@@ -133,8 +147,8 @@ class ConfluenceClient {
       // 親ページIDが指定されている場合、CQLクエリを使用して親ページの子ページのみを検索
       if (parentId) {
         // CQLクエリ: スペース、タイトル、親ページIDで検索
-        // タイトル内の特殊文字をエスケープ
-        const escapedTitle = title.replace(/"/g, '\\"');
+        // セキュリティ: CQLインジェクション対策 - タイトルを適切にエスケープ
+        const escapedTitle = escapeCQL(title);
         // ancestorの代わりにparentを使用（Confluence CQLの正しい構文）
         const cql = `space = ${spaceKey} AND title = "${escapedTitle}" AND parent = ${parentId}`;
         console.log(`  CQL Query: ${cql}`);

package/scripts/github-actions-client.ts

@@ -0,0 +1,258 @@
+/**
+ * GitHub Actions Client
+ * GitHub Actions APIへのアクセスを抽象化し、Workflow Runsの取得とレート制限対策を提供
+ */
+
+import { Octokit } from '@octokit/rest';
+
+/**
+ * GitHub Workflow Run情報
+ */
+export interface IGitHubWorkflowRun {
+  id: number;
+  name: string;
+  head_branch: string;
+  status: 'completed' | 'in_progress' | 'queued';
+  conclusion: 'success' | 'failure' | 'cancelled' | 'skipped' | null;
+  created_at: string;
+  updated_at: string;
+  html_url: string;
+}
+
+/**
+ * リポジトリのCI結果
+ */
+export interface IRepositoryCIStatus {
+  name: string;
+  url: string;
+  branch: string;
+  status: 'success' | 'failure' | 'running' | 'unknown';
+  testStatus: 'passed' | 'failed' | 'skipped' | 'unknown';
+  coverage?: number;
+  lastExecutionTime: Date;
+  failureDetails?: string;
+}
+
+/**
+ * GitHub APIエラー
+ */
+export type GitHubAPIError =
+  | { type: 'RATE_LIMIT_EXCEEDED'; retryAfter: number }
+  | { type: 'NOT_FOUND'; message: string }
+  | { type: 'UNAUTHORIZED'; message: string }
+  | { type: 'SERVER_ERROR'; message: string; statusCode: number };
+
+/**
+ * Octokit APIから返されるエラーオブジェクトの型
+ */
+interface OctokitError extends Error {
+  status?: number;
+  response?: {
+    url?: string;
+    status?: number;
+    headers?: Record<string, string>;
+    data?: unknown;
+  };
+}
+
+/**
+ * Result型
+ */
+export type Result<T, E> =
+  | { success: true; data: T }
+  | { success: false; error: E };
+
+/**
+ * GitHub Workflow Runを解析してCI結果に変換
+ * @param run GitHub Workflow Run情報
+ * @returns CI結果
+ */
+export function parseGitHubWorkflowRun(
+  run: IGitHubWorkflowRun
+): Omit<IRepositoryCIStatus, 'name' | 'url' | 'branch'> {
+  // statusマッピング
+  let status: 'success' | 'failure' | 'running' | 'unknown';
+  let testStatus: 'passed' | 'failed' | 'skipped' | 'unknown';
+
+  if (run.status === 'completed') {
+    if (run.conclusion === 'success') {
+      status = 'success';
+      testStatus = 'passed';
+    } else if (run.conclusion === 'failure') {
+      status = 'failure';
+      testStatus = 'failed';
+    } else if (run.conclusion === 'cancelled') {
+      status = 'unknown';
+      testStatus = 'skipped';
+    } else if (run.conclusion === 'skipped') {
+      status = 'unknown';
+      testStatus = 'skipped';
+    } else {
+      status = 'unknown';
+      testStatus = 'unknown';
+    }
+  } else if (run.status === 'in_progress' || run.status === 'queued') {
+    status = 'running';
+    testStatus = 'unknown';
+  } else {
+    status = 'unknown';
+    testStatus = 'unknown';
+  }
+
+  // 日時変換
+  const lastExecutionTime = new Date(run.updated_at);
+
+  // 失敗詳細
+  const failureDetails =
+    status === 'failure' ? run.html_url : undefined;
+
+  return {
+    status,
+    testStatus,
+    lastExecutionTime,
+    failureDetails,
+  };
+}
+
+/**
+ * Exponential Backoffで再試行
+ * @param fn 実行する関数
+ * @param maxRetries 最大再試行回数
+ * @returns 関数の実行結果
+ */
+async function exponentialBackoff<T>(
+  fn: () => Promise<T>,
+  maxRetries: number = 3
+): Promise<T> {
+  let lastError: OctokitError | undefined;
+
+  for (let attempt = 0; attempt < maxRetries; attempt++) {
+    try {
+      return await fn();
+    } catch (error) {
+      const octokitError = error as OctokitError;
+      lastError = octokitError;
+
+      // レート制限エラーでない場合は即座にスロー
+      if (octokitError.status !== 403 || !octokitError.response?.headers) {
+        throw octokitError;
+      }
+
+      // 最後の試行の場合はスロー
+      if (attempt === maxRetries - 1) {
+        throw octokitError;
+      }
+
+      // Exponential Backoff: 1秒、2秒、4秒
+      const waitTime = Math.pow(2, attempt) * 1000;
+      await new Promise((resolve) => setTimeout(resolve, waitTime));
+    }
+  }
+
+  throw lastError ?? new Error('Unexpected error in exponentialBackoff');
+}
+
+/**
+ * GitHub Actions Client
+ */
+export class GitHubActionsClient {
+  private octokit: Octokit;
+
+  constructor() {
+    const token = process.env.GITHUB_TOKEN;
+    if (!token) {
+      throw new Error('GITHUB_TOKENが設定されていません');
+    }
+
+    this.octokit = new Octokit({
+      auth: token,
+    });
+  }
+
+  /**
+   * リポジトリの最新Workflow Runを取得
+   * @param owner リポジトリオーナー
+   * @param repo リポジトリ名
+   * @param branch ブランチ名
+   * @returns Workflow Run情報（成功/失敗）
+   */
+  async getLatestWorkflowRun(
+    owner: string,
+    repo: string,
+    branch: string
+  ): Promise<Result<IGitHubWorkflowRun, GitHubAPIError>> {
+    try {
+      const response = await exponentialBackoff(async () => {
+        return await this.octokit.actions.listWorkflowRunsForRepo({
+          owner,
+          repo,
+          branch,
+          status: 'completed',
+          per_page: 1,
+        });
+      });
+
+      if (
+        !response.data.workflow_runs ||
+        response.data.workflow_runs.length === 0
+      ) {
+        return {
+          success: false,
+          error: {
+            type: 'NOT_FOUND',
+            message: `リポジトリ ${owner}/${repo} のWorkflow Runが見つかりません`,
+          },
+        };
+      }
+
+      const run = response.data.workflow_runs[0] as IGitHubWorkflowRun;
+      return {
+        success: true,
+        data: run,
+      };
+    } catch (error) {
+      // エラーハンドリング
+      const octokitError = error as OctokitError;
+      if (octokitError.status === 404) {
+        return {
+          success: false,
+          error: {
+            type: 'NOT_FOUND',
+            message: octokitError.message || 'リポジトリが見つかりません',
+          },
+        };
+      } else if (octokitError.status === 403) {
+        // レート制限
+        const resetTime = octokitError.response?.headers?.['x-ratelimit-reset'];
+        const retryAfter = resetTime
+          ? parseInt(resetTime, 10) - Math.floor(Date.now() / 1000)
+          : 3600;
+
+        return {
+          success: false,
+          error: {
+            type: 'RATE_LIMIT_EXCEEDED',
+            retryAfter: Math.max(retryAfter, 0),
+          },
+        };
+      } else if (octokitError.status === 401) {
+        return {
+          success: false,
+          error: {
+            type: 'UNAUTHORIZED',
+            message: octokitError.message || '認証エラー',
+          },
+        };
+      } else {
+        return {
+          success: false,
+          error: {
+            type: 'SERVER_ERROR',
+            message: octokitError.message || 'サーバーエラー',
+            statusCode: octokitError.status || 500,
+          },
+        };
+      }
+    }
+  }
+}