@supatest/playwright-reporter 0.0.6 → 0.0.8

package/README.md

@@ -19,12 +19,6 @@ export default defineConfig({
     ['@supatest/playwright-reporter', {
       apiKey: process.env.SUPATEST_API_KEY,
       projectId: process.env.SUPATEST_PROJECT_ID,
-      apiUrl: process.env.SUPATEST_API_URL, // optional, defaults to https://api.supatest.dev
-      uploadAssets: true, // optional, default true
-      maxConcurrentUploads: 5, // optional
-      retryAttempts: 3, // optional
-      timeoutMs: 30000, // optional
-      dryRun: false, // optional, for testing
     }]
   ]
 });
@@ -32,12 +26,12 @@ export default defineConfig({
 
 ## Environment Variables
 
-```bash
-SUPATEST_API_KEY=sk_live_...        # Required: API authentication key
-SUPATEST_PROJECT_ID=proj_123        # Required: Project identifier
-SUPATEST_API_URL=https://api.supatest.dev  # Optional: Custom API endpoint
-SUPATEST_DRY_RUN=true               # Optional: Test mode (no actual uploads)
-```
+| Variable | Description |
+|----------|-------------|
+| `SUPATEST_API_KEY` | **Required.** Your Supatest API key |
+| `SUPATEST_PROJECT_ID` | **Required.** Your project identifier for organizing test runs |
+| `SUPATEST_API_URL` | Optional. Custom API endpoint |
+| `SUPATEST_DRY_RUN` | Optional. Set to `true` to enable dry-run mode |
 
 ## Features
 
@@ -63,3 +57,65 @@ SUPATEST_DRY_RUN=true               # Optional: Test mode (no actual uploads)
 - **Retry Logic**: Exponential backoff with configurable attempts
 - **Error Handling**: Graceful degradation—reporting failures don't block tests
 - **Signed URL Uploads**: Direct S3 uploads via signed URLs from API
+
+## Development
+
+### Running Tests
+
+**Unit Tests:**
+```bash
+pnpm test              # Run tests in watch mode
+pnpm test:run          # Run tests once
+pnpm test:coverage     # Run tests with coverage
+```
+
+**Integration Tests (local build):**
+```bash
+pnpm test:integration  # Build reporter and run full E2E test suite
+```
+
+This will:
+1. Build the reporter package (`pnpm build`)
+2. Run the Playwright test suite in `reporter-test-suites/playwright-saucedemo/`
+3. Verify data flows to your local API (requires API running on `http://localhost:9090`)
+
+The test suite uses a `file:` reference (`file:../../playwright-reporter`) to install from the local build output. This simulates how end users install from npm and catches packaging issues that workspace symlinks would hide.
+
+**Testing a published version:**
+
+To verify the published npm package works, temporarily update `reporter-test-suites/playwright-saucedemo/package.json`:
+```json
+"@supatest/playwright-reporter": "^0.0.7"
+```
+Then run `cd reporter-test-suites/playwright-saucedemo && pnpm install && pnpm test`. Revert to the `file:` reference afterward.
+
+**Quick Development Loop:**
+```bash
+# Terminal 1: Start local API
+cd api && pnpm dev
+
+# Terminal 2: Build reporter, run integration tests
+cd playwright-reporter
+pnpm test:integration
+```
+
+### Test Suite Configuration
+
+The integration test suite uses `.env` configuration:
+
+```bash
+# reporter-test-suites/playwright-saucedemo/.env
+SUPATEST_API_URL=http://localhost:9090
+SUPATEST_API_KEY=sk_test_...
+SUPATEST_PROJECT_ID=proj_local_swaglabs
+SUPATEST_DRY_RUN=false
+```
+
+### Verifying Integration Tests
+
+After running `pnpm test:integration`, you should see:
+- `[supatest] Run <run-id> started (X tests across Y files, Z projects)`
+- `[supatest] Waiting for N pending uploads...`
+- `[supatest] Run <run-id> completed: passed/failed`
+
+Check your local API dashboard at `http://localhost:3000` to see the test results.