qa360 2.1.2 → 2.1.4

package/cli/src/commands/init.ts

@@ -0,0 +1,763 @@
+/**
+ * QA360 Init Command - Interactive pack generator (v2)
+ *
+ * Usage:
+ *   qa360 init
+ *   qa360 init --template api-basic
+ *   qa360 init --output custom-pack.yml
+ *   qa360 init --beginner    # Guided mode for first-time users
+ */
+
+import { existsSync, writeFileSync, mkdirSync } from 'fs';
+import { join, resolve } from 'path';
+import { createRequire } from 'module';
+import chalk from 'chalk';
+import { dump } from 'js-yaml';
+
+// Use createRequire for CommonJS module inquirer
+const require = createRequire(import.meta.url);
+const inquirer = require('inquirer');
+
+// ============================================================
+// Type Definitions (Pack v2)
+// ============================================================
+
+export interface PackConfigV2 {
+  version: 2;
+  name: string;
+  description?: string;
+  profile?: string;
+  auth?: AuthConfigV2;
+  gates: Record<string, GateConfigV2>;
+  hooks?: HooksConfig;
+  execution?: ExecutionConfigV2;
+  variables?: Record<string, string>;
+  metadata?: Record<string, unknown>;
+}
+
+export interface AuthConfigV2 {
+  api?: string;
+  ui?: string;
+  profiles?: Record<string, AuthProfile>;
+}
+
+export interface AuthProfile {
+  type: string;
+  config: Record<string, unknown>;
+  cache?: { enabled?: boolean; ttl?: number };
+}
+
+export interface GateConfigV2 {
+  adapter?: string;
+  test_files?: string[];
+  config?: Record<string, unknown>;
+  auth?: string;
+  budgets?: Record<string, unknown>;
+  options?: { timeout?: number; retries?: number; continue_on_failure?: boolean };
+  enabled?: boolean;
+  depends_on?: string[];
+  parallel?: boolean;
+}
+
+export interface HooksConfig {
+  beforeAll?: Hook[];
+  afterAll?: Hook[];
+  beforeEach?: Hook[];
+  afterEach?: Hook[];
+}
+
+export interface Hook {
+  type: 'run' | 'wait_on' | 'script' | 'docker';
+  command?: string;
+  cwd?: string;
+  timeout?: number;
+  env?: Record<string, string>;
+  wait_for?: { resource: string; timeout?: number };
+  compose?: { file?: string; services?: string[]; command?: string };
+}
+
+export interface ExecutionConfigV2 {
+  parallel?: boolean;
+  max_concurrency?: number;
+  default_timeout?: number;
+  default_retries?: number;
+  on_failure: 'stop' | 'continue' | 'proceed';
+  limits?: { cpu?: string; memory?: string };
+  compose_file?: string;
+  hook_timeout_ms?: number;
+}
+
+// ============================================================
+// CLI options for init command
+// ============================================================
+
+export interface InitOptions {
+  template?: string;
+  output?: string;
+  force?: boolean;
+  yes?: boolean;
+  beginner?: boolean;
+}
+
+// ============================================================
+// Available templates (v2)
+// ============================================================
+
+export const TEMPLATES: Record<string, {
+  name: string;
+  description: string;
+  gates: string[];
+  icon: string;
+}> = {
+  'api-basic': {
+    name: 'API Basic',
+    description: 'Simple API smoke tests (REST/GraphQL)',
+    gates: ['api-smoke'],
+    icon: '🔌',
+  },
+  'ui-basic': {
+    name: 'UI Basic',
+    description: 'Basic UI/E2E browser tests',
+    gates: ['ui-smoke', 'a11y'],
+    icon: '🌐',
+  },
+  'fullstack': {
+    name: 'Full Stack',
+    description: 'API + UI + Performance tests',
+    gates: ['api-smoke', 'api-crud', 'ui-smoke', 'perf'],
+    icon: '🎯',
+  },
+  'security': {
+    name: 'Security',
+    description: 'SAST, DAST, secrets scanning',
+    gates: ['api-smoke', 'sast', 'dast', 'secrets'],
+    icon: '🛡️',
+  },
+  'complete': {
+    name: 'Complete',
+    description: 'All quality gates (API, UI, Performance, Security, Accessibility)',
+    gates: ['api-smoke', 'api-crud', 'ui-smoke', 'a11y', 'perf', 'sast', 'dast', 'secrets'],
+    icon: '✨',
+  },
+};
+
+// ============================================================
+// Gate descriptions with beginner-friendly explanations
+// ============================================================
+
+export const GATE_DESCRIPTIONS: Record<string, {
+  short: string;
+  beginner: string;
+  example: string;
+  icon: string;
+  adapter: string;
+}> = {
+  'api-smoke': {
+    short: 'API smoke tests (REST/GraphQL health checks)',
+    beginner: 'Tests if your API is alive and responds correctly. Like checking if the server is up.',
+    example: 'Checks if GET /api/health or GET /status/200 returns 200 OK',
+    icon: '🔌',
+    adapter: 'playwright-api',
+  },
+  'api-crud': {
+    short: 'API CRUD tests (Create, Read, Update, Delete)',
+    beginner: 'Tests the full lifecycle of your data operations.',
+    example: 'Tests POST /users, GET /users, PUT /users/1, DELETE /users/1',
+    icon: '🔧',
+    adapter: 'playwright-api',
+  },
+  'ui-smoke': {
+    short: 'UI/E2E tests (browser automation)',
+    beginner: 'Tests your website in a real browser. Checks if pages load and buttons work.',
+    example: 'Opens your site and verifies the login form appears',
+    icon: '🌐',
+    adapter: 'playwright-ui',
+  },
+  'a11y': {
+    short: 'Accessibility tests (WCAG compliance)',
+    beginner: 'Tests if your site is usable by people with disabilities (screen readers, color blindness).',
+    example: 'Checks if images have alt text for blind users',
+    icon: '♿',
+    adapter: 'playwright-ui',
+  },
+  'perf': {
+    short: 'Performance tests (load/stress testing)',
+    beginner: 'Tests if your site stays fast when many people visit at once.',
+    example: 'Simulates 100 users visiting simultaneously',
+    icon: '⚡',
+    adapter: 'k6-perf',
+  },
+  'sast': {
+    short: 'Static security analysis (code scanning)',
+    beginner: 'Analyzes your source code for security vulnerabilities without running it.',
+    example: 'Finds hardcoded passwords or unsafe functions',
+    icon: '🔍',
+    adapter: 'semgrep-sast',
+  },
+  'dast': {
+    short: 'Dynamic security testing (runtime scanning)',
+    beginner: 'Attacks your running application to find security weaknesses.',
+    example: 'Tries common attacks like SQL injection',
+    icon: '⚔️',
+    adapter: 'zap-dast',
+  },
+  'secrets': {
+    short: 'Secrets detection (credential scanning)',
+    beginner: 'Scans for accidentally committed passwords, API keys, or tokens.',
+    example: 'Finds AWS keys in your code',
+    icon: '🔑',
+    adapter: 'gitleaks-secrets',
+  },
+};
+
+// ============================================================
+// Helper: Create gate config
+// ============================================================
+
+function createGate(adapter: string, baseUrl: string, extraConfig: Record<string, unknown> = {}): GateConfigV2 {
+  return {
+    adapter,
+    enabled: true,
+    config: {
+      baseUrl,
+      ...extraConfig,
+    },
+    options: {
+      timeout: 30000,
+      retries: 2,
+    },
+  };
+}
+
+// ============================================================
+// Helper: Generate v2 pack from selected gates
+// ============================================================
+
+function generateV2Pack(name: string, gates: string[], apiTarget?: string, webTarget?: string): PackConfigV2 {
+  const pack: PackConfigV2 = {
+    version: 2,
+    name,
+    description: `QA360 test pack for ${name}`,
+    gates: {},
+    execution: {
+      default_timeout: 30000,
+      default_retries: 2,
+      on_failure: 'continue',
+      parallel: true,
+    },
+  };
+
+  const apiBaseUrl = apiTarget ? `\${BASE_URL:-${apiTarget}}` : '${BASE_URL:-https://api.example.com}';
+  const webBaseUrl = webTarget ? `\${BASE_URL:-${webTarget}}` : '${BASE_URL:-https://example.com}';
+
+  // Build gates
+  for (const gate of gates) {
+    const gateInfo = GATE_DESCRIPTIONS[gate];
+
+    if (!gateInfo) continue;
+
+    switch (gate) {
+      case 'api-smoke':
+        pack.gates['api-health'] = createGate('playwright-api', apiBaseUrl, {
+          smoke: [
+            'GET /status/200 -> 200',
+            'GET /get -> 200',
+            'GET /uuid -> 200',
+          ],
+        });
+        break;
+
+      case 'api-crud':
+        pack.gates['api-crud'] = createGate('playwright-api', apiBaseUrl, {
+          smoke: [
+            'GET /api/v1/users -> 200',
+            'POST /api/v1/users -> 201',
+            'PUT /api/v1/users/1 -> 200',
+            'DELETE /api/v1/users/1 -> 204',
+          ],
+        });
+        pack.gates['api-crud'].budgets = {
+          p95_ms: 1000,
+          error_rate: 0.01,
+        };
+        break;
+
+      case 'ui-smoke':
+        pack.gates['ui-smoke'] = createGate('playwright-ui', webBaseUrl, {
+          pages: [
+            {
+              url: '/',
+              expectedElements: ['body', 'main'],
+            },
+          ],
+        });
+        break;
+
+      case 'a11y':
+        pack.gates['a11y'] = {
+          adapter: 'playwright-ui',
+          enabled: true,
+          config: {
+            baseUrl: webBaseUrl,
+            pages: [
+              {
+                url: '/',
+                a11yRules: ['wcag2a', 'wcag2aa'],
+              },
+            ],
+          },
+          budgets: {
+            violations: 10,
+            a11y_score: 90,
+          },
+        };
+        break;
+
+      case 'perf':
+        pack.gates['perf'] = {
+          adapter: 'k6-perf',
+          enabled: true,
+          config: {
+            script: `import http from 'k6/http';
+import { check } from 'k6';
+
+export const options = {
+  stages: [
+    { duration: '10s', target: 10 },
+    { duration: '20s', target: 50 },
+    { duration: '10s', target: 0 },
+  ],
+};
+
+export default function () {
+  const res = http.get('${apiBaseUrl}/health');
+  check(res, {
+    'status is 200': (r) => r.status === 200,
+    'response time < 500ms': (r) => r.timings.duration < 500,
+  });
+}`,
+          },
+          budgets: {
+            p95_ms: 2000,
+            p99_ms: 5000,
+            error_rate: 0.05,
+          },
+          options: {
+            timeout: 60000,
+            retries: 1,
+          },
+        };
+        break;
+
+      case 'sast':
+        pack.gates['sast'] = {
+          adapter: 'semgrep-sast',
+          enabled: true,
+          config: {
+            rules: ['security', 'owasp-top-10'],
+            paths: ['src/', 'lib/'],
+          },
+          budgets: {
+            high_findings: 0,
+            medium_findings: 10,
+          },
+        };
+        break;
+
+      case 'dast':
+        pack.gates['dast'] = {
+          adapter: 'zap-dast',
+          enabled: true,
+          config: {
+            target: 'api',
+            profile: 'baseline',
+            url: apiBaseUrl,
+            scanType: 'baseline',
+          },
+          budgets: {
+            high_findings: 5,
+            medium_findings: 20,
+          },
+          options: {
+            timeout: 120000,
+          },
+        };
+        break;
+
+      case 'secrets':
+        pack.gates['secrets'] = {
+          adapter: 'gitleaks-secrets',
+          enabled: true,
+          config: {
+            paths: ['.', 'src/', 'config/'],
+          },
+          budgets: {
+            critical_findings: 0,
+          },
+        };
+        break;
+    }
+  }
+
+  // Add hooks if needed
+  if (gates.includes('perf') || gates.includes('dast')) {
+    pack.hooks = {
+      beforeAll: [
+        {
+          type: 'wait_on',
+          wait_for: {
+            resource: `${apiBaseUrl}/health`,
+            timeout: 30000,
+          },
+        },
+      ],
+    };
+  }
+
+  return pack;
+}
+
+// ============================================================
+// Beginner mode - Step by step guided experience
+// ============================================================
+
+async function beginnerMode(): Promise<PackConfigV2> {
+  console.log(chalk.bold.cyan('\n╔════════════════════════════════════════════════════════════╗'));
+  console.log(chalk.bold.cyan('║       👋 Welcome to QA360 - Your Quality Assistant!          ║'));
+  console.log(chalk.bold.cyan('║                                                              ║'));
+  console.log(chalk.bold.cyan('║   Let\'s create your first test pack together, step by step.    ║'));
+  console.log(chalk.bold.cyan('╚════════════════════════════════════════════════════════════╝\n'));
+
+  console.log(chalk.gray('📦 What is a "test pack"?'));
+  console.log(chalk.white('   A test pack defines WHAT to test (your API, website) and HOW (smoke tests, security scans).\n'));
+
+  // Step 1: Project name
+  console.log(chalk.bold('Step 1️⃣  - Project Name'));
+  console.log(chalk.gray('   Give your test pack a memorable name.\n'));
+
+  const { name } = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'name',
+      message: 'What should we call your test pack?',
+      default: 'my-first-tests',
+      validate: (input: string) => input.length > 0 || 'Name is required',
+    },
+  ]);
+
+  console.log(chalk.green(`   ✓ Great! Your test pack is called "${name}"\n`));
+
+  // Step 2: What to test?
+  console.log(chalk.bold('Step 2️⃣  - What do you want to test?'));
+  console.log(chalk.gray('   Select the type of application you want to test.\n'));
+
+  const { appType } = await inquirer.prompt([
+    {
+      type: 'list',
+      name: 'appType',
+      message: 'What type of application are you testing?',
+      choices: [
+        { name: '🔌 API / Backend - REST or GraphQL API', value: 'api-basic' },
+        { name: '🌐 Website / Frontend - Web application', value: 'ui-basic' },
+        { name: '🎯 Full Stack - Both API and Website', value: 'fullstack' },
+        { name: '🛡️ Security Scan - Check for vulnerabilities', value: 'security' },
+        { name: '✨ Everything - All tests enabled', value: 'complete' },
+      ],
+    },
+  ]);
+
+  console.log(chalk.green(`   ✓ You chose: ${TEMPLATES[appType].name}\n`));
+
+  // Step 3: Gates explanation and selection
+  const suggestedGates = TEMPLATES[appType].gates;
+
+  console.log(chalk.bold('Step 3️⃣  - Quality Gates'));
+  console.log(chalk.gray('   Gates are different types of tests. We\'ll suggest some based on your choice.\n'));
+
+  console.log(chalk.cyan('   Suggested gates for you:\n'));
+  for (const gate of suggestedGates) {
+    const info = GATE_DESCRIPTIONS[gate];
+    if (info) {
+      console.log(chalk.cyan(`     ${info.icon} ${gate}`));
+      console.log(chalk.gray(`       ${info.beginner}`));
+      console.log(chalk.gray(`       Example: ${info.example}\n`));
+    }
+  }
+
+  const { useSuggested } = await inquirer.prompt([
+    {
+      type: 'confirm',
+      name: 'useSuggested',
+      message: 'Use the suggested gates?',
+      default: true,
+    },
+  ]);
+
+  let gates = suggestedGates;
+  let apiTarget: string | undefined;
+  let webTarget: string | undefined;
+
+  if (!useSuggested) {
+    const { customGates } = await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'customGates',
+        message: 'Select the gates you want:',
+        choices: Object.entries(GATE_DESCRIPTIONS).map(([key, info]) => ({
+          name: `${info.icon} ${key} - ${info.short}`,
+          value: key,
+        })),
+        validate: (input: string[]) => input.length > 0 || 'Select at least one gate',
+      },
+    ]);
+    gates = customGates;
+  }
+
+  console.log(chalk.green(`   ✓ Selected gates: ${gates.join(', ')}\n`));
+
+  // Step 4: URLs
+  console.log(chalk.bold('Step 4️⃣  - Application URLs'));
+  console.log(chalk.gray('   Where is your application running?\n'));
+
+  const hasApiGates = gates.some((g: string) => ['api-smoke', 'api-crud', 'perf', 'dast'].includes(g));
+  const hasUiGates = gates.some((g: string) => ['ui-smoke', 'a11y'].includes(g));
+
+  if (hasApiGates) {
+    console.log(chalk.cyan('   📡 API Configuration'));
+    const apiAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'apiUrl',
+        message: 'What is your API base URL?',
+        default: 'https://api.example.com',
+        validate: (input: string) => input.startsWith('http') || 'Must start with http:// or https://',
+      },
+    ]);
+    apiTarget = apiAnswers.apiUrl;
+    console.log(chalk.green(`   ✓ API: ${apiTarget}\n`));
+  }
+
+  if (hasUiGates) {
+    console.log(chalk.cyan('   🌐 Website Configuration'));
+    const uiAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'webUrl',
+        message: 'What is your website URL?',
+        default: 'https://example.com',
+        validate: (input: string) => input.startsWith('http') || 'Must start with http:// or https://',
+      },
+    ]);
+    webTarget = uiAnswers.webUrl;
+    console.log(chalk.green(`   ✓ Website: ${webTarget}\n`));
+  }
+
+  // Build pack
+  const pack = generateV2Pack(name, gates, apiTarget, webTarget);
+
+  // Final summary
+  console.log(chalk.bold.cyan('\n✨ Almost done! Here\'s your test pack summary:\n'));
+  console.log(chalk.white(`   Name: ${chalk.bold(name)}`));
+  console.log(chalk.white(`   Gates: ${gates.map(g => `${GATE_DESCRIPTIONS[g]?.icon} ${g}`).join(', ')}`));
+  console.log(chalk.white(`   API: ${apiTarget || 'N/A'}`));
+  console.log(chalk.white(`   Website: ${webTarget || 'N/A'}`));
+
+  return pack;
+}
+
+// ============================================================
+// Interactive prompts
+// ============================================================
+
+async function promptForConfig(): Promise<PackConfigV2> {
+  const answers = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'name',
+      message: 'Pack name:',
+      default: 'my-qa360-tests',
+      validate: (input: string) => input.length > 0 || 'Name is required',
+    },
+    {
+      type: 'list',
+      name: 'template',
+      message: 'Choose a template:',
+      choices: Object.entries(TEMPLATES).map(([key, value]) => ({
+        name: `${value.icon} ${value.name} - ${value.description}`,
+        value: key,
+      })),
+    },
+    {
+      type: 'confirm',
+      name: 'customizeGates',
+      message: 'Customize quality gates?',
+      default: false,
+    },
+  ]);
+
+  let gates = TEMPLATES[answers.template].gates;
+
+  if (answers.customizeGates) {
+    const gateAnswers = await inquirer.prompt([
+      {
+        type: 'checkbox',
+        name: 'gates',
+        message: 'Select quality gates to enable:',
+        choices: Object.entries(GATE_DESCRIPTIONS).map(([key, desc]) => ({
+          name: `${desc.icon} ${key} - ${desc.short}`,
+          value: key,
+          checked: gates.includes(key),
+        })),
+        validate: (input: string[]) => input.length > 0 || 'Select at least one gate',
+      },
+    ]);
+    gates = gateAnswers.gates;
+  }
+
+  // Prompt for target URLs based on selected gates
+  const targets: { api?: string; web?: string } = {};
+
+  const hasApiGates = gates.some((g: string) => ['api-smoke', 'api-crud', 'perf', 'dast'].includes(g));
+  const hasUiGates = gates.some((g: string) => ['ui-smoke', 'a11y'].includes(g));
+
+  if (hasApiGates) {
+    const apiAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'apiUrl',
+        message: 'API base URL:',
+        default: 'https://api.example.com',
+        validate: (input: string) => input.startsWith('http') || 'Must be a valid URL',
+      },
+    ]);
+    targets.api = apiAnswers.apiUrl;
+  }
+
+  if (hasUiGates) {
+    const uiAnswers = await inquirer.prompt([
+      {
+        type: 'input',
+        name: 'webUrl',
+        message: 'Web application URL:',
+        default: 'https://example.com',
+        validate: (input: string) => input.startsWith('http') || 'Must be a valid URL',
+      },
+    ]);
+    targets.web = uiAnswers.webUrl;
+  }
+
+  return generateV2Pack(answers.name, gates, targets.api, targets.web);
+}
+
+// ============================================================
+// Generate pack from template
+// ============================================================
+
+function generateFromTemplate(templateKey: string, name?: string): PackConfigV2 {
+  const template = TEMPLATES[templateKey];
+
+  if (!template) {
+    throw new Error(`Unknown template: ${templateKey}`);
+  }
+
+  // Determine targets based on template
+  let apiTarget: string | undefined;
+  let webTarget: string | undefined;
+
+  const hasApiGates = template.gates.some((g: string) => ['api-smoke', 'api-crud', 'perf', 'dast'].includes(g));
+  const hasUiGates = template.gates.some((g: string) => ['ui-smoke', 'a11y'].includes(g));
+
+  if (hasApiGates) {
+    apiTarget = 'https://api.example.com';
+  }
+  if (hasUiGates) {
+    webTarget = 'https://example.com';
+  }
+
+  return generateV2Pack(name || `${templateKey}-tests`, template.gates, apiTarget, webTarget);
+}
+
+// ============================================================
+// Main init command
+// ============================================================
+
+export async function initCommand(options: InitOptions = {}): Promise<void> {
+  try {
+    console.log(chalk.bold.cyan('\n🚀 QA360 Pack Generator (v2)\n'));
+
+    // Determine output file
+    const outputFile = options.output
+      ? resolve(options.output)
+      : join(process.cwd(), 'qa360.yml');
+
+    // Check if file exists
+    if (existsSync(outputFile) && !options.force) {
+      const overwrite = await inquirer.prompt([
+        {
+          type: 'confirm',
+          name: 'overwrite',
+          message: `File ${outputFile} already exists. Overwrite?`,
+          default: false,
+        },
+      ]);
+
+      if (!overwrite.overwrite) {
+        console.log(chalk.yellow('\n⚠️  Aborted. Use --force to overwrite.'));
+        return;
+      }
+    }
+
+    // Generate pack config
+    let pack: PackConfigV2;
+
+    if (options.beginner) {
+      // Beginner guided mode
+      pack = await beginnerMode();
+    } else if (options.template) {
+      // Use template directly
+      pack = generateFromTemplate(options.template);
+      console.log(chalk.green(`✅ Using template: ${TEMPLATES[options.template]?.name || options.template}`));
+    } else if (options.yes) {
+      // Use default template (api-basic)
+      pack = generateFromTemplate('api-basic');
+      console.log(chalk.green('✅ Using default template: API Basic'));
+    } else {
+      // Interactive mode
+      pack = await promptForConfig();
+    }
+
+    // Convert to YAML
+    const yaml = dump(pack, {
+      indent: 2,
+      lineWidth: 120,
+      noRefs: true,
+      quotingType: '"',
+      forceQuotes: false,
+    });
+
+    // Ensure directory exists
+    const dir = resolve(outputFile, '..');
+    if (!existsSync(dir)) {
+      mkdirSync(dir, { recursive: true });
+    }
+
+    // Write file
+    writeFileSync(outputFile, yaml, 'utf-8');
+
+    console.log(chalk.green.bold('\n✅ Pack created successfully!'));
+    console.log(chalk.gray(`\n📄 File: ${outputFile}`));
+    console.log(chalk.gray(`📋 Gates: ${Object.keys(pack.gates).join(', ')}`));
+
+    console.log(chalk.cyan('\n📚 Next steps:'));
+    console.log(chalk.gray('   1. Edit the pack file to customize your tests'));
+    console.log(chalk.gray('   2. Run: qa360 run'));
+    console.log(chalk.gray('   3. View results: qa360 verify .qa360/runs/\n'));
+
+  } catch (error) {
+    console.error(chalk.red('\n❌ Init failed:'));
+    console.error(chalk.red(`   ${error instanceof Error ? error.message : 'Unknown error'}`));
+    process.exit(1);
+  }
+}
+
+export default initCommand;