qa360 2.1.7 → 2.2.1

package/core/src/types/pack-v2.ts

@@ -0,0 +1,525 @@
+/**
+ * QA360 Pack Configuration v2
+ *
+ * New version with test_files patterns and auth profiles.
+ * Maintains backward compatibility with v1 concepts while adding
+ * AI-generated code support and comprehensive authentication.
+ */
+
+/**
+ * Page Object Model configuration
+ */
+export interface PageObjectConfigV2 {
+  /**
+   * Directory containing page object files
+   */
+  directory?: string;
+
+  /**
+   * Glob pattern for page object files
+   */
+  pattern?: string;
+
+  /**
+   * Base URL for page objects (can be overridden per page)
+   */
+  baseUrl?: string;
+}
+
+/**
+ * Pack Configuration v2
+ */
+export interface PackConfigV2 {
+  version: 2;
+  name: string;
+  description?: string;
+  profile?: string;
+  /**
+   * Data fixtures to load for this pack
+   * Paths are relative to the pack file location
+   *
+   * @example
+   * fixtures:
+   *   - ./fixtures/users.yml
+   *   - ./fixtures/products.json
+   */
+  fixtures?: string[];
+  /**
+   * Page Object Model configuration
+   */
+  pageObjects?: PageObjectConfigV2;
+  auth?: AuthConfigV2;
+  gates: Record<string, GateConfigV2>;
+  hooks?: HooksConfig;
+  execution?: ExecutionConfigV2;
+  variables?: Record<string, string>;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * Authentication configuration (Pack v2)
+ */
+export interface AuthConfigV2 {
+  /**
+   * Default auth profile for API gates
+   */
+  api?: string;
+
+  /**
+   * Default auth profile for UI gates
+   */
+  ui?: string;
+
+  /**
+   * Named auth profiles
+   */
+  profiles?: Record<string, AuthProfile>;
+}
+
+/**
+ * Authentication profile definition (Pack v2)
+ */
+export interface AuthProfile {
+  /**
+   * Type of authentication
+   */
+  type: AuthTypeV2;
+
+  /**
+   * Configuration for this auth type
+   */
+  config: Record<string, unknown>;
+
+  /**
+   * Cache/refresh settings
+   */
+  cache?: AuthCacheConfig;
+}
+
+/**
+ * Authentication types (Pack v2)
+ */
+export type AuthTypeV2 =
+  | 'none'                    // No authentication
+  | 'jwt'                     // JWT bearer token
+  | 'oauth2'                  // OAuth2 client credentials
+  | 'api_key'                 // API key in header
+  | 'bearer'                  // Generic bearer token
+  | 'basic'                   // Basic auth
+  | 'totp'                    // TOTP-based auth
+  | 'ui_login'                // UI form-based login
+  | 'gcp_adc'                 // GCP Application Default Credentials
+  | 'aws_iam'                 // AWS IAM credentials
+  | 'azure_ad'                // Azure AD token;
+
+/**
+ * Auth cache configuration
+ */
+export interface AuthCacheConfig {
+  enabled?: boolean;
+  ttl?: number;  // Time to live in seconds
+}
+
+/**
+ * Gate Configuration v2
+ */
+export interface GateConfigV2 {
+  /**
+   * Adapter to use for this gate
+   */
+  adapter?: string;
+
+  /**
+   * Test files to execute (glob patterns)
+   * This is the primary way to specify tests in v2
+   */
+  test_files?: string[];
+
+  /**
+   * Legacy inline config (for backward compatibility)
+   */
+  config?: Record<string, unknown>;
+
+  /**
+   * Auth profile to use (overrides default)
+   */
+  auth?: string;
+
+  /**
+   * Budgets for this gate
+   */
+  budgets?: GateBudgets;
+
+  /**
+   * Execution options
+   */
+  options?: GateOptions;
+
+  /**
+   * Whether this gate is enabled
+   */
+  enabled?: boolean;
+
+  /**
+   * Dependencies on other gates
+   */
+  depends_on?: string[];
+
+  /**
+   * Parallel execution within this gate
+   */
+  parallel?: boolean;
+}
+
+/**
+ * Gate budgets
+ */
+export interface GateBudgets {
+  max_duration_ms?: number;
+  p95_ms?: number;
+  p99_ms?: number;
+  max_high?: number;
+  max_medium?: number;
+  max_critical?: number;
+  a11y_min?: number;
+  perf_min?: number;
+}
+
+/**
+ * Gate execution options
+ */
+export interface GateOptions {
+  timeout?: number;
+  retries?: number;
+  continue_on_failure?: boolean;
+  parallelism?: number;
+}
+
+/**
+ * Hooks configuration
+ */
+export interface HooksConfig {
+  beforeAll?: Hook[];
+  afterAll?: Hook[];
+  beforeEach?: Hook[];
+  afterEach?: Hook[];
+}
+
+/**
+ * Single hook definition
+ */
+export interface Hook {
+  /**
+   * Hook type
+   */
+  type: 'run' | 'wait_on' | 'script' | 'docker';
+
+  /**
+   * Command or script to run
+   */
+  command?: string;
+
+  /**
+   * Working directory
+   */
+  cwd?: string;
+
+  /**
+   * Timeout in milliseconds
+   */
+  timeout?: number;
+
+  /**
+   * Environment variables
+   */
+  env?: Record<string, string>;
+
+  /**
+   * Wait_on specific configuration
+   */
+  wait_for?: {
+    resource: string;
+    timeout?: number;
+  };
+
+  /**
+   * Docker compose specific
+   */
+  compose?: {
+    file?: string;
+    services?: string[];
+    command?: string;
+  };
+}
+
+/**
+ * Execution configuration v2
+ */
+export interface ExecutionConfigV2 {
+  /**
+   * Parallel gate execution
+   */
+  parallel?: boolean;
+
+  /**
+   * Maximum concurrency
+   */
+  max_concurrency?: number;
+
+  /**
+   * Default timeout
+   */
+  default_timeout?: number;
+
+  /**
+   * Default retries
+   */
+  default_retries?: number;
+
+  /**
+   * Behavior on failure
+   */
+  on_failure: 'stop' | 'continue' | 'proceed';
+
+  /**
+   * Resource limits
+   */
+  limits?: ResourceLimits;
+
+  /**
+   * Docker compose file for environment
+   */
+  compose_file?: string;
+
+  /**
+   * Hook timeout
+   */
+  hook_timeout_ms?: number;
+}
+
+/**
+ * Resource limits
+ */
+export interface ResourceLimits {
+  cpu?: string;
+  memory?: string;
+}
+
+/**
+ * Security budgets
+ */
+export interface SecurityBudgets {
+  sast?: {
+    max_critical?: number;
+    max_high?: number;
+    max_medium?: number;
+  };
+  dast?: {
+    max_critical?: number;
+    max_high?: number;
+    max_medium?: number;
+  };
+  secrets?: {
+    max_critical?: number;
+    max_high?: number;
+  };
+  deps?: {
+    max_critical?: number;
+    max_high?: number;
+    max_medium?: number;
+  };
+}
+
+/**
+ * Performance targets
+ */
+export interface PerformanceTargets {
+  p95_ms?: number;
+  p99_ms?: number;
+  throughput_rps?: number;
+  error_rate_percent?: number;
+}
+
+/**
+ * Auth type-specific configurations
+ */
+
+/**
+ * JWT configuration (Pack v2)
+ */
+export interface JWTAuthProfileV2 extends AuthProfile {
+  type: 'jwt';
+  config: {
+    issuer?: string;
+    audience?: string;
+    subject?: string;
+    client_id?: string;
+    client_secret?: string;
+    token_endpoint?: string;
+    scopes?: string[];
+    auto_refresh?: boolean;
+  };
+}
+
+/**
+ * OAuth2 configuration (Pack v2)
+ */
+export interface OAuth2AuthProfileV2 extends AuthProfile {
+  type: 'oauth2';
+  config: {
+    token_url: string;
+    client_id: string;
+    client_secret?: string;
+    scopes?: string[];
+    grant_type?: 'client_credentials' | 'authorization_code' | 'password';
+    username?: string;
+    password?: string;
+  };
+}
+
+/**
+ * UI Login configuration (Pack v2)
+ */
+export interface UILoginAuthProfileV2 extends AuthProfile {
+  type: 'ui_login';
+  config: {
+    url: string;
+    username?: string;
+    password?: string;
+    username_selector?: string;
+    password_selector?: string;
+    submit_selector?: string;
+    totp_secret?: string;
+    session_file?: string;
+  };
+}
+
+/**
+ * Cloud ADC configurations
+ */
+
+/**
+ * GCP Application Default Credentials (Pack v2)
+ */
+export interface GCPADCProfileV2 extends AuthProfile {
+  type: 'gcp_adc';
+  config: {
+    project_id?: string;
+    scopes?: string[];
+  };
+}
+
+/**
+ * AWS IAM configuration (Pack v2)
+ */
+export interface AWSIamProfileV2 extends AuthProfile {
+  type: 'aws_iam';
+  config: {
+    region?: string;
+    access_key_id?: string;
+    secret_access_key?: string;
+    session_token?: string;
+    role_arn?: string;
+    profile?: string;
+  };
+}
+
+/**
+ * Target configurations (for reference in test_files)
+ */
+export interface TargetConfig {
+  api?: ApiTarget;
+  web?: WebTarget;
+}
+
+/**
+ * API target configuration
+ */
+export interface ApiTarget {
+  baseUrl: string;
+  auth?: string;
+  headers?: Record<string, string>;
+  smoke?: string[];  // Legacy spec format
+  requests?: ApiRequest[];
+}
+
+/**
+ * Web target configuration
+ */
+export interface WebTarget {
+  baseUrl: string;
+  auth?: string;
+  pages?: WebPage[];
+}
+
+/**
+ * API request specification
+ */
+export interface ApiRequest {
+  method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+  path: string;
+  headers?: Record<string, string>;
+  body?: unknown;
+  expect?: {
+    status?: number | number[];
+    responseTime?: string;
+    body?: Record<string, unknown>;
+    headers?: string[];
+  };
+}
+
+/**
+ * Web page specification
+ */
+export interface WebPage {
+  url: string;
+  name?: string;
+  actions?: PageAction[];
+}
+
+/**
+ * Page action for UI tests
+ */
+export interface PageAction {
+  type: 'goto' | 'click' | 'fill' | 'select' | 'wait' | 'screenshot' | 'assert';
+  selector?: string;
+  value?: string;
+  options?: Record<string, unknown>;
+}
+
+/**
+ * Validation result for pack v2
+ */
+export interface PackValidationResultV2 {
+  valid: boolean;
+  version: 2;
+  errors: ValidationError[];
+  warnings: ValidationError[];
+  info?: {
+    totalTests?: number;
+    gatesCount?: number;
+    frameworks?: string[];
+  };
+}
+
+/**
+ * Validation error
+ */
+export interface ValidationError {
+  code: string;
+  message: string;
+  path?: string;
+  line?: number;
+  column?: number;
+  suggestion?: string;
+}
+
+/**
+ * Migrate v1 to v2 result
+ */
+export interface PackMigrationResultV2 {
+  success: boolean;
+  migrated: PackConfigV2;
+  changes: string[];
+  warnings: string[];
+}