@m00nsolutions/playwright-reporter 1.0.6 → 1.0.8

package/README.md

@@ -1,6 +1,6 @@
 # @m00nsolutions/playwright-reporter
 
-Official Playwright test reporter for [M00n Report](https://m00nreport.com) - a real-time test reporting dashboard.
+Official Playwright test reporter for [M00N Report](https://m00nreport.com) - a real-time test reporting dashboard.
 
 ## Features
 
@@ -58,13 +58,13 @@ export default defineConfig({
 npx playwright test
 ```
 
-That's it! Your test results will appear in the M00n Report dashboard in real-time.
+That's it! Your test results will appear in the M00N Report dashboard in real-time.
 
 ## Configuration Options
 
 | Option | Type | Default | Description |
 |--------|------|---------|-------------|
-| `serverUrl` | `string` | **required** | M00n Report ingest service URL |
+| `serverUrl` | `string` | **required** | M00N Report ingest service URL |
 | `apiKey` | `string` | **required** | Project API key (identifies org and project) |
 | `launch` | `string` | `'Run {date}'` | Title for this test run |
 | `tags` | `string[]` | `[]` | Tags to categorize the run |
@@ -81,6 +81,70 @@ M00N_LAUNCH="Nightly Build"
 M00N_TAGS=smoke,regression
 ```
 
+## CI/CD Auto-Detection
+
+The reporter **automatically detects** CI/CD environment variables from popular providers and includes them as run attributes. No configuration needed - just run your tests in CI and the dashboard will display branch, commit, build URL, and more.
+
+### Supported Providers
+
+| Provider | Detection Variable |
+|---|---|
+| **GitHub Actions** | `GITHUB_ACTIONS` |
+| **GitLab CI** | `GITLAB_CI` |
+| **Jenkins** | `JENKINS_URL` |
+| **Bitbucket Pipelines** | `BITBUCKET_PIPELINE_UUID` |
+| **Azure DevOps** | `TF_BUILD` |
+| **CircleCI** | `CIRCLECI` |
+| **Travis CI** | `TRAVIS` |
+
+### Auto-Detected Attributes
+
+The following attributes are automatically populated when running in a supported CI environment:
+
+| Attribute | Description | GitHub Actions | GitLab CI | Jenkins | Bitbucket | Azure DevOps | CircleCI | Travis CI |
+|---|---|---|---|---|---|---|---|---|
+| `ci_provider` | CI provider name | `GitHub Actions` | `GitLab CI` | `Jenkins` | `Bitbucket Pipelines` | `Azure DevOps` | `CircleCI` | `Travis CI` |
+| `branch` | Git branch | `GITHUB_REF_NAME` | `CI_COMMIT_REF_NAME` | `BRANCH_NAME` | `BITBUCKET_BRANCH` | `BUILD_SOURCEBRANCH` | `CIRCLE_BRANCH` | `TRAVIS_BRANCH` |
+| `commit` | Git commit SHA | `GITHUB_SHA` | `CI_COMMIT_SHA` | `GIT_COMMIT` | `BITBUCKET_COMMIT` | `BUILD_SOURCEVERSION` | `CIRCLE_SHA1` | `TRAVIS_COMMIT` |
+| `pipeline` | Pipeline/workflow name | `GITHUB_WORKFLOW` | `CI_PIPELINE_NAME` | `JOB_NAME` | - | `BUILD_DEFINITIONNAME` | `CIRCLE_WORKFLOW_JOB_NAME` | - |
+| `build_number` | Build number | `GITHUB_RUN_NUMBER` | `CI_PIPELINE_ID` | `BUILD_NUMBER` | `BITBUCKET_BUILD_NUMBER` | `BUILD_BUILDNUMBER` | `CIRCLE_BUILD_NUM` | `TRAVIS_BUILD_NUMBER` |
+| `build_url` | Link to build | Auto-composed | `CI_PIPELINE_URL` | `BUILD_URL` | Auto-composed | Auto-composed | `CIRCLE_BUILD_URL` | `TRAVIS_BUILD_WEB_URL` |
+| `trigger` | What triggered the build | `GITHUB_EVENT_NAME` | `CI_PIPELINE_SOURCE` | - | - | `BUILD_REASON` | - | `TRAVIS_EVENT_TYPE` |
+| `triggered_by` | User who triggered | `GITHUB_ACTOR` | `CI_GITLAB_USER_LOGIN` | - | - | - | `CIRCLE_USERNAME` | - |
+
+### Manual Override
+
+User-provided attributes always take precedence over auto-detected values. To override any auto-detected attribute, simply set it in the `attributes` config:
+
+```typescript
+reporter: [
+  ['@m00nsolutions/playwright-reporter', {
+    serverUrl: 'https://m00nreport.com',
+    apiKey: process.env.M00N_API_KEY,
+    attributes: {
+      branch: 'my-custom-branch',  // Overrides auto-detected branch
+      environment: 'staging',       // Custom attribute (not auto-detected)
+    },
+  }],
+],
+```
+
+### Custom CI Variables
+
+For unsupported CI providers or additional metadata, pass any key-value pairs via `attributes`:
+
+```typescript
+attributes: {
+  build_url: process.env.MY_CI_BUILD_URL,
+  branch: process.env.MY_CI_BRANCH,
+  commit: process.env.MY_CI_COMMIT,
+  environment: 'production',
+  region: 'us-east-1',
+},
+```
+
+The dashboard recognizes these attribute keys and displays them in the CI/CD banner: `branch`, `commit`, `pipeline`, `build_number`, `build_url`, `environment`, `trigger`.
+
 ## Usage Examples
 
 ### Basic Configuration
@@ -94,6 +158,33 @@ reporter: [
 ],
 ```
 
+### GitHub Actions Example
+
+```yaml
+# .github/workflows/tests.yml
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - run: npx playwright test
+        env:
+          M00N_API_KEY: ${{ secrets.M00N_API_KEY }}
+```
+
+The reporter will automatically capture `branch`, `commit`, `build_url`, `pipeline`, `build_number`, `trigger`, and `triggered_by` from GitHub Actions environment variables.
+
+### GitLab CI Example
+
+```yaml
+# .gitlab-ci.yml
+test:
+  script:
+    - npx playwright test
+  variables:
+    M00N_API_KEY: $M00N_API_KEY
+```
+
 ## Real-time Step Streaming
 
 When `realtime: true` (default), the reporter streams test steps to the dashboard as they execute. This allows you to:

package/index.mjs

@@ -1,4 +1,4 @@
-// M00n Reporter v2 - Simplified Playwright reporter for M00n Report dashboard
+// M00n Reporter v2 - Simplified Playwright reporter for M00N Report dashboard
 //
 // Key improvements over v1:
 // 1. Hybrid model - real-time step streaming + atomic final persistence
@@ -470,6 +470,84 @@ function parseTags(tags) {
   return [];
 }
 
+/**
+ * Auto-detect CI/CD environment variables from common providers.
+ * Returns a flat key-value object using attribute names that the
+ * M00N Report dashboard recognizes (branch, commit, pipeline, etc.).
+ * User-provided attributes always take precedence over auto-detected ones.
+ */
+function detectCIAttributes() {
+  const env = process.env;
+  const attrs = {};
+
+  if (env.GITHUB_ACTIONS) {
+    attrs.ci_provider = 'GitHub Actions';
+    if (env.GITHUB_WORKFLOW)    attrs.pipeline = env.GITHUB_WORKFLOW;
+    if (env.GITHUB_RUN_NUMBER)  attrs.build_number = env.GITHUB_RUN_NUMBER;
+    if (env.GITHUB_SHA)         attrs.commit = env.GITHUB_SHA;
+    if (env.GITHUB_REF_NAME)    attrs.branch = env.GITHUB_REF_NAME;
+    else if (env.GITHUB_REF)    attrs.branch = env.GITHUB_REF.replace(/^refs\/heads\//, '');
+    if (env.GITHUB_EVENT_NAME)  attrs.trigger = env.GITHUB_EVENT_NAME;
+    if (env.GITHUB_ACTOR)       attrs.triggered_by = env.GITHUB_ACTOR;
+    if (env.GITHUB_SERVER_URL && env.GITHUB_REPOSITORY && env.GITHUB_RUN_ID) {
+      attrs.build_url = `${env.GITHUB_SERVER_URL}/${env.GITHUB_REPOSITORY}/actions/runs/${env.GITHUB_RUN_ID}`;
+    }
+  } else if (env.GITLAB_CI) {
+    attrs.ci_provider = 'GitLab CI';
+    if (env.CI_PIPELINE_NAME)     attrs.pipeline = env.CI_PIPELINE_NAME;
+    if (env.CI_PIPELINE_ID)       attrs.build_number = env.CI_PIPELINE_ID;
+    if (env.CI_PIPELINE_URL)      attrs.build_url = env.CI_PIPELINE_URL;
+    if (env.CI_PIPELINE_SOURCE)   attrs.trigger = env.CI_PIPELINE_SOURCE;
+    if (env.CI_COMMIT_SHA)        attrs.commit = env.CI_COMMIT_SHA;
+    if (env.CI_COMMIT_REF_NAME)   attrs.branch = env.CI_COMMIT_REF_NAME;
+    if (env.CI_JOB_URL)           attrs.ci_job_url = env.CI_JOB_URL;
+    if (env.CI_GITLAB_USER_LOGIN) attrs.triggered_by = env.CI_GITLAB_USER_LOGIN;
+  } else if (env.JENKINS_URL) {
+    attrs.ci_provider = 'Jenkins';
+    if (env.JOB_NAME)      attrs.pipeline = env.JOB_NAME;
+    if (env.BUILD_NUMBER)  attrs.build_number = env.BUILD_NUMBER;
+    if (env.BUILD_URL)     attrs.build_url = env.BUILD_URL;
+    if (env.GIT_COMMIT)    attrs.commit = env.GIT_COMMIT;
+    if (env.BRANCH_NAME)   attrs.branch = env.BRANCH_NAME;
+    else if (env.GIT_BRANCH) attrs.branch = env.GIT_BRANCH;
+  } else if (env.BITBUCKET_PIPELINE_UUID) {
+    attrs.ci_provider = 'Bitbucket Pipelines';
+    if (env.BITBUCKET_BUILD_NUMBER) attrs.build_number = env.BITBUCKET_BUILD_NUMBER;
+    if (env.BITBUCKET_COMMIT)       attrs.commit = env.BITBUCKET_COMMIT;
+    if (env.BITBUCKET_BRANCH)       attrs.branch = env.BITBUCKET_BRANCH;
+    if (env.BITBUCKET_REPO_SLUG && env.BITBUCKET_WORKSPACE && env.BITBUCKET_BUILD_NUMBER) {
+      attrs.build_url = `https://bitbucket.org/${env.BITBUCKET_WORKSPACE}/${env.BITBUCKET_REPO_SLUG}/pipelines/results/${env.BITBUCKET_BUILD_NUMBER}`;
+    }
+  } else if (env.TF_BUILD) {
+    attrs.ci_provider = 'Azure DevOps';
+    if (env.BUILD_DEFINITIONNAME) attrs.pipeline = env.BUILD_DEFINITIONNAME;
+    if (env.BUILD_BUILDNUMBER)    attrs.build_number = env.BUILD_BUILDNUMBER;
+    if (env.BUILD_SOURCEVERSION)  attrs.commit = env.BUILD_SOURCEVERSION;
+    if (env.BUILD_SOURCEBRANCH)   attrs.branch = env.BUILD_SOURCEBRANCH.replace(/^refs\/heads\//, '');
+    if (env.BUILD_REASON)         attrs.trigger = env.BUILD_REASON;
+    if (env.SYSTEM_TEAMFOUNDATIONSERVERURI && env.SYSTEM_TEAMPROJECT && env.BUILD_BUILDID) {
+      attrs.build_url = `${env.SYSTEM_TEAMFOUNDATIONSERVERURI}${env.SYSTEM_TEAMPROJECT}/_build/results?buildId=${env.BUILD_BUILDID}`;
+    }
+  } else if (env.CIRCLECI) {
+    attrs.ci_provider = 'CircleCI';
+    if (env.CIRCLE_WORKFLOW_JOB_NAME) attrs.pipeline = env.CIRCLE_WORKFLOW_JOB_NAME;
+    if (env.CIRCLE_BUILD_NUM)         attrs.build_number = env.CIRCLE_BUILD_NUM;
+    if (env.CIRCLE_BUILD_URL)         attrs.build_url = env.CIRCLE_BUILD_URL;
+    if (env.CIRCLE_SHA1)              attrs.commit = env.CIRCLE_SHA1;
+    if (env.CIRCLE_BRANCH)            attrs.branch = env.CIRCLE_BRANCH;
+    if (env.CIRCLE_USERNAME)          attrs.triggered_by = env.CIRCLE_USERNAME;
+  } else if (env.TRAVIS) {
+    attrs.ci_provider = 'Travis CI';
+    if (env.TRAVIS_BUILD_NUMBER) attrs.build_number = env.TRAVIS_BUILD_NUMBER;
+    if (env.TRAVIS_BUILD_WEB_URL) attrs.build_url = env.TRAVIS_BUILD_WEB_URL;
+    if (env.TRAVIS_COMMIT)       attrs.commit = env.TRAVIS_COMMIT;
+    if (env.TRAVIS_BRANCH)       attrs.branch = env.TRAVIS_BRANCH;
+    if (env.TRAVIS_EVENT_TYPE)   attrs.trigger = env.TRAVIS_EVENT_TYPE;
+  }
+
+  return attrs;
+}
+
 function extractAnnotations(test) {
   const result = {};
   const caseIdAnn = test?.annotations?.find(a => a?.type === 'caseId')?.description;
@@ -1331,6 +1409,12 @@ export default class M00nReporter {
     this.verbose = options.verbose || false;  // Performance/timing logs
     this.logFile = options.logFile || null;   // Log file path
     this.disabled = false;
+
+    if (options.enable === false) {
+      this.log('info', 'Reporter disabled via enable: false');
+      this.disabled = true;
+      return;
+    }
     this.realtime = options.realtime !== false; // Default: true
     this.binaryAttachments = options.binaryAttachments !== false; // Default: true (use multipart)
     
@@ -1488,10 +1572,13 @@ export default class M00nReporter {
         return { ok: true };
       }).catch(err => ({ ok: false, error: err }));
       
-      // Normalize attributes: flat key-value object
-      const attributes = this.opts.attributes && typeof this.opts.attributes === 'object' 
-        ? { ...this.opts.attributes }
+      // Auto-detect CI environment variables, then overlay user-provided attributes
+      // User attributes always take precedence over auto-detected ones
+      const ciAttrs = detectCIAttributes();
+      const userAttrs = this.opts.attributes && typeof this.opts.attributes === 'object'
+        ? this.opts.attributes
         : {};
+      const attributes = { ...ciAttrs, ...userAttrs };
       
       // Add workers count from Playwright config (useful for timeline visualization)
       if (config.workers != null) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@m00nsolutions/playwright-reporter",
-  "version": "1.0.6",
-  "description": "Playwright test reporter for M00n Report dashboard - real-time test result streaming with step tracking, attachments, and retry support",
+  "version": "1.0.8",
+  "description": "Playwright test reporter for M00N Report dashboard - real-time test result streaming with step tracking, attachments, and retry support",
   "main": "index.mjs",
   "type": "module",
   "exports": {