@alternative-path/testlens-playwright-reporter 0.3.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 TestLens Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,163 @@
+# TestLens Playwright Reporter
+
+A Playwright reporter for [TestLens](https://testlens.qa-path.com) - real-time test monitoring dashboard.
+
+## Features
+
+- 🚀 **Real-time streaming** - Watch test results as they happen in the dashboard
+- 📸 **Artifact support** - Shows screenshots, videos, and traces
+- 🔄 **Retry tracking** - Monitor test retries and identify flaky tests
+- ⚡ **Cross-platform** - Works on Windows, macOS, and Linux
+
+## Installation
+
+```bash
+npm install testlens-playwright-reporter
+```
+
+## Configuration
+
+### Quick Start (Recommended)
+
+The simplest config - API key and metadata are passed via environment variables:
+
+**TypeScript (`playwright.config.ts`)**
+```typescript
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: {
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter']
+    // API key is auto-detected from TESTLENS_API_KEY env var
+    // Build metadata is auto-detected from testlensBuildName/testlensBuildTag env vars
+  ],
+});
+```
+
+**JavaScript (`playwright.config.js`)**
+```javascript
+const { defineConfig } = require('@playwright/test');
+
+module.exports = defineConfig({
+  use: {
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter']
+    // API key is auto-detected from TESTLENS_API_KEY env var
+    // Build metadata is auto-detected from testlensBuildName/testlensBuildTag env vars
+  ],
+});
+```
+
+### Advanced Configuration (Optional)
+
+If you prefer to set API key or metadata explicitly in config:
+
+**TypeScript (`playwright.config.ts`)**
+```typescript
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  use: {
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter', {
+      apiKey: process.env.TESTLENS_API_KEY || 'your-api-key-here',
+      
+      // Optional: explicitly forward build metadata from env vars
+      customMetadata: {
+        testlensBuildName: process.env.testlensBuildName,
+        testlensBuildTag: process.env.testlensBuildTag,
+      },
+    }]
+  ],
+});
+```
+
+**JavaScript (`playwright.config.js`)**
+```javascript
+const { defineConfig } = require('@playwright/test');
+
+module.exports = defineConfig({
+  use: {
+    screenshot: 'on',
+    video: 'on',
+    trace: 'on',
+  },
+  reporter: [
+    ['testlens-playwright-reporter', {
+      apiKey: process.env.TESTLENS_API_KEY || 'your-api-key-here',
+      
+      // Optional: explicitly forward build metadata from env vars
+      customMetadata: {
+        testlensBuildName: process.env.testlensBuildName,
+        testlensBuildTag: process.env.testlensBuildTag,
+      },
+    }]
+  ],
+});
+```
+
+## Run With Build Name & Tag (UI Mode)
+
+Use `testlens-cross-env` (bundled with this package) to set API key and metadata cross-platform, including Windows.
+
+### Command
+
+```bash
+npx testlens-cross-env TESTLENS_API_KEY="<your-api-key>" testlensBuildName="Testing Build Local Environment" testlensBuildTag="smoke" playwright test --ui
+```
+
+### What Gets Auto-Detected
+
+The reporter automatically reads these environment variables (no config changes needed):
+
+- **API Key**: `TESTLENS_API_KEY` (also checks: `testlens_api_key`, `TESTLENS_KEY`, `testlensApiKey`, `PLAYWRIGHT_API_KEY`, `PW_API_KEY`)
+- **Build Name**: `testlensBuildName` (also checks: `TESTLENS_BUILD_NAME`, `BUILDNAME`, `BUILD_NAME`)
+- **Build Tag**: `testlensBuildTag` (also checks: `TESTLENS_BUILD_TAG`, `BUILDTAG`, `BUILD_TAG`)
+
+### Notes
+
+- No config changes required - just pass env vars in the command
+- `testlensBuildName` and `testlensBuildTag` are sent to TestLens as run `custom_metadata`
+- Multiple tags: use comma-separated list `testlensBuildTag="smoke,regression"`
+
+> 💡 **Tip:** Keep `screenshot`, `video`, and `trace` set to `'on'` for better debugging experience. TestLens automatically uploads these artifacts for failed tests, making it easier to identify issues.
+
+### Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | `string` | **Required** | Your TestLens API key |
+
+## Artifacts
+
+TestLens automatically captures and uploads:
+
+| Artifact | Description |
+|----------|-------------|
+| **Screenshots** | Visual snapshots of test failures |
+| **Videos** | Full video recording of test execution |
+| **Traces** | Playwright trace files for step-by-step debugging |
+
+These artifacts are viewable directly in the TestLens dashboard for easy debugging.
+
+## Requirements
+
+- Node.js >= 16.0.0
+- Playwright >= 1.40.0
+
+## License
+
+MIT License

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

@@ -0,0 +1,192 @@
+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 | 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 | 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 | 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;
+    private cliArgs;
+    /**
+     * 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;