testlens-playwright-reporter 0.3.3 → 0.3.4

package/cross-env.js

@@ -0,0 +1,24 @@
+#!/usr/bin/env node
+/**
+ * Cross-platform wrapper for cross-env
+ * 
+ * This wrapper allows users to set environment variables in a cross-platform way
+ * without needing to install cross-env separately.
+ * 
+ * Platform Support:
+ * - Windows (PowerShell, CMD)
+ * - macOS (bash, zsh, etc.)
+ * - Linux (bash, sh, etc.)
+ * - Any platform that runs Node.js
+ * 
+ * Usage:
+ *   npx testlens-cross-env VAR1=value1 VAR2=value2 command args...
+ * 
+ * Example:
+ *   npx testlens-cross-env testlensApiKey="abc123" playwright test
+ */
+
+const crossEnv = require('cross-env');
+
+// Pass all command-line arguments to cross-env
+crossEnv(process.argv.slice(2));

package/index.d.ts

@@ -1,120 +1,191 @@
-import { Reporter } from '@playwright/test/reporter';
-
-export interface TestLensReporterConfig {
-  /** TestLens API endpoint URL */
-  apiEndpoint?: string;
-  /** API key for authentication - required, must be provided in config */
-  apiKey: string;
-  /** Enable real-time streaming of test events */
-  enableRealTimeStream?: boolean;
-  /** Enable Git information collection */
-  enableGitInfo?: boolean;
-  /** Enable artifact processing */
-  enableArtifacts?: boolean;
-  /** Enable video capture - defaults to true */
-  enableVideo?: boolean;
-  /** Enable screenshot capture - defaults to true */
-  enableScreenshot?: boolean;
-  /** Batch size for API requests */
-  batchSize?: number;
-  /** Flush interval in milliseconds */
-  flushInterval?: number;
-  /** Number of retry attempts for failed API calls */
-  retryAttempts?: number;
-  /** Request timeout in milliseconds */
-  timeout?: number;
-  /** SSL certificate validation - set to false to disable SSL verification */
-  rejectUnauthorized?: boolean;
-  /** Alternative SSL option - set to true to ignore SSL certificate errors */
-  ignoreSslErrors?: boolean;
-}
-
-export interface TestLensReporterOptions {
-  /** TestLens API endpoint URL */
-  apiEndpoint?: string;
-  /** API key for authentication - required, must be provided in config */
-  apiKey: string;
-  /** Enable real-time streaming of test events */
-  enableRealTimeStream?: boolean;
-  /** Enable Git information collection */
-  enableGitInfo?: boolean;
-  /** Enable artifact processing */
-  enableArtifacts?: boolean;
-  /** Enable video capture - defaults to true */
-  enableVideo?: boolean;
-  /** Enable screenshot capture - defaults to true */
-  enableScreenshot?: boolean;
-  /** Batch size for API requests */
-  batchSize?: number;
-  /** Flush interval in milliseconds */
-  flushInterval?: number;
-  /** Number of retry attempts for failed API calls */
-  retryAttempts?: number;
-  /** Request timeout in milliseconds */
-  timeout?: number;
-  /** SSL certificate validation - set to false to disable SSL verification */
-  rejectUnauthorized?: boolean;
-  /** Alternative SSL option - set to true to ignore SSL certificate errors */
-  ignoreSslErrors?: boolean;
-}
-
-export interface GitInfo {
-  branch: string;
-  commit: string;
-  shortCommit: string;
-  author: string;
-  message: string;
-  timestamp: string;
-  isDirty: boolean;
-  remoteName: string;
-  remoteUrl: string;
-}
-
-/** Rich error details from Playwright */
-export interface TestError {
-  message: string;
-  stack?: string;
-  location?: {
-    file: string;
-    line: number;
-    column: number;
-  };
-  snippet?: string;
-  expected?: string;
-  actual?: string;
-  diff?: string;
-  matcherName?: string;
-  timeout?: number;
-}
-
-export interface TestData {
-  id: string;
-  name: string;
-  status: string;
-  originalStatus?: string;
-  duration: number;
-  startTime: string;
-  endTime: string;
-  errorMessages: string[];
-  errors?: TestError[];
-  retryAttempts: number;
-  currentRetry: number;
-  annotations: Array<{ type: string; description?: string }>;
-  projectName: string;
-  workerIndex?: number;
-  parallelIndex?: number;
-  location?: {
-    file: string;
-    line: number;
-    column: number;
-  };
-}
-
-export default class TestLensReporter implements Reporter {
-  constructor(options: TestLensReporterOptions);
-  
-  onBegin?(config: import('@playwright/test/reporter').FullConfig, suite: import('@playwright/test/reporter').Suite): void;
-  onTestBegin?(test: import('@playwright/test/reporter').TestCase, result: import('@playwright/test/reporter').TestResult): void;
-  onTestEnd?(test: import('@playwright/test/reporter').TestCase, result: import('@playwright/test/reporter').TestResult): void;
-  onEnd?(result: import('@playwright/test/reporter').FullResult): Promise<void>;
-}
+import type { Reporter, TestCase, TestResult, FullConfig, Suite } from '@playwright/test/reporter';
+export interface TestLensReporterConfig {
+    /** TestLens API endpoint URL */
+    apiEndpoint?: string;
+    /** API key for authentication - can be provided in config or via TESTLENS_API_KEY environment variable */
+    apiKey?: string;
+    /** Enable real-time streaming of test events */
+    enableRealTimeStream?: boolean;
+    /** Enable Git information collection */
+    enableGitInfo?: boolean;
+    /** Enable artifact processing */
+    enableArtifacts?: boolean;
+    /** Enable video capture - defaults to true */
+    enableVideo?: boolean;
+    /** Enable screenshot capture - defaults to true */
+    enableScreenshot?: boolean;
+    /** Batch size for API requests */
+    batchSize?: number;
+    /** Flush interval in milliseconds */
+    flushInterval?: number;
+    /** Number of retry attempts for failed API calls */
+    retryAttempts?: number;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** SSL certificate validation - set to false to disable SSL verification */
+    rejectUnauthorized?: boolean;
+    /** Alternative SSL option - set to true to ignore SSL certificate errors */
+    ignoreSslErrors?: boolean;
+    /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
+    customMetadata?: Record<string, string>;
+}
+export interface TestLensReporterOptions {
+    /** TestLens API endpoint URL */
+    apiEndpoint?: string;
+    /** API key for authentication - can be provided in config or via TESTLENS_API_KEY environment variable */
+    apiKey?: string;
+    /** Enable real-time streaming of test events */
+    enableRealTimeStream?: boolean;
+    /** Enable Git information collection */
+    enableGitInfo?: boolean;
+    /** Enable artifact processing */
+    enableArtifacts?: boolean;
+    /** Enable video capture - defaults to true */
+    enableVideo?: boolean;
+    /** Enable screenshot capture - defaults to true */
+    enableScreenshot?: boolean;
+    /** Batch size for API requests */
+    batchSize?: number;
+    /** Flush interval in milliseconds */
+    flushInterval?: number;
+    /** Number of retry attempts for failed API calls */
+    retryAttempts?: number;
+    /** Request timeout in milliseconds */
+    timeout?: number;
+    /** SSL certificate validation - set to false to disable SSL verification */
+    rejectUnauthorized?: boolean;
+    /** Alternative SSL option - set to true to ignore SSL certificate errors */
+    ignoreSslErrors?: boolean;
+    /** Custom metadata from CLI arguments (automatically parsed from --key=value arguments) */
+    customMetadata?: Record<string, string>;
+}
+export interface GitInfo {
+    branch: string;
+    commit: string;
+    shortCommit: string;
+    author: string;
+    message: string;
+    timestamp: string;
+    isDirty: boolean;
+    remoteName: string;
+    remoteUrl: string;
+}
+export interface CodeBlock {
+    type: 'test' | 'describe';
+    name: string;
+    content: string;
+    summary?: string;
+    describe?: string;
+    startLine?: number;
+    endLine?: number;
+}
+export interface RunMetadata {
+    id: string;
+    startTime: string;
+    endTime?: string;
+    duration?: number;
+    environment: string;
+    browser: string;
+    os: string;
+    playwrightVersion: string;
+    nodeVersion: string;
+    gitInfo?: GitInfo | null;
+    shardInfo?: {
+        current: number;
+        total: number;
+    };
+    totalTests?: number;
+    passedTests?: number;
+    failedTests?: number;
+    skippedTests?: number;
+    status?: string;
+    testlensBuildName?: string;
+    customMetadata?: Record<string, string>;
+}
+export interface TestError {
+    message: string;
+    stack?: string;
+    location?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+    snippet?: string;
+    expected?: string;
+    actual?: string;
+    diff?: string;
+    matcherName?: string;
+    timeout?: number;
+}
+export interface TestData {
+    id: string;
+    name: string;
+    status: string;
+    originalStatus?: string;
+    duration: number;
+    startTime: string;
+    endTime: string;
+    errorMessages: string[];
+    errors?: TestError[];
+    retryAttempts: number;
+    currentRetry: number;
+    annotations: Array<{
+        type: string;
+        description?: string;
+    }>;
+    projectName: string;
+    workerIndex?: number;
+    parallelIndex?: number;
+    location?: {
+        file: string;
+        line: number;
+        column: number;
+    };
+}
+export interface SpecData {
+    filePath: string;
+    testSuiteName: string;
+    tags?: string[];
+    startTime: string;
+    endTime?: string;
+    status: string;
+}
+export declare class TestLensReporter implements Reporter {
+    private config;
+    private axiosInstance;
+    private runId;
+    private runMetadata;
+    private specMap;
+    private testMap;
+    private runCreationFailed;
+    /**
+     * Parse custom metadata from environment variables
+     * Checks for common metadata environment variables
+     */
+    private static parseCustomArgs;
+    constructor(options: TestLensReporterOptions);
+    private initializeRunMetadata;
+    private getPlaywrightVersion;
+    private normalizeTestStatus;
+    private normalizeRunStatus;
+    onBegin(config: FullConfig, suite: Suite): Promise<void>;
+    onTestBegin(test: TestCase, result: TestResult): Promise<void>;
+    onTestEnd(test: TestCase, result: TestResult): Promise<void>;
+    onEnd(result: {
+        status: string;
+    }): Promise<void>;
+    private sendToApi;
+    private processArtifacts;
+    private sendSpecCodeBlocks;
+    private extractTestBlocks;
+    private collectGitInfo;
+    private getArtifactType;
+    private extractTags;
+    private getTestId;
+    private uploadArtifactToS3;
+    private getContentType;
+    private generateS3Key;
+    private sanitizeForS3;
+    private getFileSize;
+}
+export default TestLensReporter;