testlens-playwright-reporter 0.1.0

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,238 @@
+````markdown
+# TestLens Playwright Reporter
+
+A modern, feature-rich Playwright reporter that works with both TypeScript and JavaScript projects, integrating seamlessly with your TestLens dashboard.
+
+## 🚀 Features
+
+- ✅ **Universal Compatibility** - Works with both TypeScript and JavaScript Playwright projects
+- 🔄 **Real-time Streaming** - Live test results streaming to TestLens dashboard
+- 📊 **Comprehensive Reporting** - Test results, artifacts, and detailed metrics
+- 🌿 **Git Integration** - Automatic collection of Git information (branch, commit, author, etc.)
+- 📝 **Code Block Extraction** - Intelligent extraction of test code for better debugging
+- 🔄 **Retry Logic** - Robust error handling and retry mechanisms
+- 🎯 **Artifact Support** - Screenshots, videos, traces, and custom attachments with S3 storage
+- ☁️ **S3 Integration** - Automatic upload of artifacts to Amazon S3 for persistent storage
+
+## 📦 Installation
+
+### Option 1: npm install (Recommended)
+
+```bash
+# Install the TestLens Playwright Reporter
+npm install @testlens/playwright-reporter --save-dev
+
+# Install the TestLens Playwright Reporter uisng the file locally
+npm install --save-dev ./testlens-playwright-reporter-x.y.z.tgz
+
+# Or using yarn
+yarn add @testlens/playwright-reporter --dev
+
+# Or using pnpm
+pnpm add -D @testlens/playwright-reporter
+```
+
+### Option 2: Use from centralized location
+
+```bash
+# Clone or copy the testlens-reporter to a central location
+git clone https://github.com/alternative-path/testlens-reporter.git D:\Experiment\AP\testlens-reporter
+
+# Install dependencies
+cd D:\Experiment\AP\testlens-reporter
+npm install
+
+# Reference from your Playwright projects using absolute path or environment variable
+```
+
+## ⚙️ Configuration
+
+### 1. Environment Variables
+
+No environment file is required! All configuration is embedded in the package. However, you can still override settings if needed by creating a `.env` file:
+
+```env
+# Optional: TestLens API endpoint (defaults to embedded configuration)
+TEST_API_ENDPOINT=http://localhost:3001/api/v1/webhook/playwright
+```
+
+**Note**: 
+- S3 configuration is pre-configured and embedded in the package. No additional S3 setup is required.
+- API key must be provided directly in your Playwright configuration file, not in environment variables.
+
+### 2. Playwright Configuration
+
+#### For JavaScript projects (`playwright.config.js`):
+
+```javascript
+// @ts-check
+const { defineConfig } = require('@playwright/test');
+
+module.exports = defineConfig({
+  // ... your existing config
+  
+  reporter: [
+    ['list'], // Keep the default console reporter
+    ['@testlens/playwright-reporter', {
+      // API key is required - provide it directly in config
+      apiKey: 'your-api-key-here', // Required: Your TestLens API key
+      // Optional overrides (these have embedded defaults)
+      apiEndpoint: 'http://localhost:3001/api/v1/webhook/playwright',
+      enableRealTimeStream: true,
+      enableGitInfo: true,
+      enableArtifacts: true,
+      enableS3Upload: true, // S3 configuration is embedded
+      retryAttempts: 3,
+      timeout: 30000
+    }]
+  ],
+  
+  // ... rest of your config
+});
+```
+
+#### For TypeScript projects (`playwright.config.ts`):
+
+```typescript
+import { defineConfig } from '@playwright/test';
+
+export default defineConfig({
+  // ... your existing config
+  
+  reporter: [
+    ['list'], // Keep the default console reporter
+    ['@testlens/playwright-reporter', {
+      // API key is required - provide it directly in config
+      apiKey: 'your-api-key-here', // Required: Your TestLens API key
+      // Optional overrides (these have embedded defaults)
+      apiEndpoint: 'http://localhost:3001/api/v1/webhook/playwright',
+      enableRealTimeStream: true,
+      enableGitInfo: true,
+      enableArtifacts: true,
+      enableS3Upload: true, // S3 configuration is embedded
+      retryAttempts: 3,
+      timeout: 30000
+    }]
+  ],
+  
+  // ... rest of your config
+});
+```
+
+## 🔧 Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiEndpoint` | string | `process.env.TEST_API_ENDPOINT` | **Required.** TestLens API endpoint URL |
+| `apiKey` | string | *none* | **Required.** API key for authentication - must be provided in config |
+| `enableRealTimeStream` | boolean | `true` | Enable real-time streaming of test events |
+| `enableGitInfo` | boolean | `true` | Enable Git information collection |
+| `enableArtifacts` | boolean | `true` | Enable artifact processing (screenshots, videos, etc.) |
+| `enableS3Upload` | boolean | `true` | Enable S3 upload for artifacts (S3 configuration is embedded in the package) |
+| `batchSize` | number | `10` | Batch size for API requests |
+| `flushInterval` | number | `5000` | Flush interval in milliseconds |
+| `retryAttempts` | number | `3` | Number of retry attempts for failed API calls |
+| `timeout` | number | `30000` | Request timeout in milliseconds |
+
+## 🚦 Usage
+
+Once configured, simply run your Playwright tests as usual:
+
+```bash
+# Run all tests
+npx playwright test
+
+# Run specific test file
+npx playwright test tests/login.spec.ts
+
+# Run tests in headed mode
+npx playwright test --headed
+
+# Run tests with specific reporter only
+npx playwright test --reporter=./testlens-reporter
+```
+
+## 📊 What Gets Reported
+
+### Test Execution Data
+- ✅ Test results (passed/failed/skipped)
+- ⏱️ Test duration and timing
+- 🔄 Retry attempts and status
+- 📝 Error messages and stack traces
+- 🏷️ Test annotations and tags
+
+### System Information
+- 🌿 Git branch, commit, author, and message
+- 💻 OS and Node.js version
+- 🎭 Playwright version
+- 🌍 Environment information
+
+### Artifacts
+- 📸 Screenshots
+- 🎥 Videos  
+- 🔍 Traces
+- 📎 Custom attachments
+- ☁️ **S3 Storage** - Automatic upload to Amazon S3 with presigned URLs for access
+
+### Code Blocks
+- 🧪 Extracted test code blocks
+- 📝 Test structure and context
+- 🔍 Searchable test content
+
+## 🐛 Troubleshooting
+
+### Common Issues
+
+#### 1. "TEST_API_ENDPOINT is required" error
+Make sure you have set the `TEST_API_ENDPOINT` environment variable or passed it as a configuration option.
+
+#### 2. Connection errors
+- Verify that your TestLens backend is running and accessible
+- Check firewall settings and network connectivity
+- Ensure the API endpoint URL is correct
+
+#### 3. Git information not collected
+- Ensure you're running tests from within a Git repository
+- Check that Git is installed and accessible from the command line
+- Git information collection can be disabled with `enableGitInfo: false`
+
+### Debug Mode
+
+Enable debug logging by setting environment variable:
+
+```bash
+DEBUG=testlens:* npx playwright test
+```
+
+## 🤝 Integration with TestLens Dashboard
+
+This reporter integrates with your TestLens dashboard to provide:
+
+- 📊 **Real-time Test Results** - See tests as they run
+- 📈 **Historical Trends** - Track test performance over time
+- 🔍 **Code Block Visualization** - View actual test code in the dashboard
+- 🌿 **Git Integration** - Link test results to commits and branches
+- 📱 **Artifact Gallery** - Browse screenshots, videos, and traces
+
+## 📄 License
+
+MIT License - see LICENSE file for details.
+
+## 🤝 Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## 📞 Support
+
+For issues and questions:
+- 🐛 [Report bugs](https://github.com/alternative-path/testlens/issues)
+- 💬 [Discussions](https://github.com/alternative-path/testlens/discussions)
+- 📧 [Email support](mailto:support@testlens.io)
+
+````
+node build-embed-env.js
+npm pack

package/index.d.ts

@@ -0,0 +1,76 @@
+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 S3 upload for artifacts */
+  enableS3Upload?: 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 S3 upload for artifacts */
+  enableS3Upload?: 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;
+  commitMessage: string;
+  commitTimestamp: string;
+  isDirty: boolean;
+  remoteName: string;
+  remoteUrl: string;
+}
+
+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>;
+}