@wdio/junit-reporter 9.32.0-alpha.6 → 10.0.0-alpha.148

package/AGENTS.md

@@ -0,0 +1,20 @@
+# @wdio/junit-reporter
+
+JUnit XML reporter. It extends `@wdio/reporter`. User docs are this package's `README.md`.
+
+## Commands
+
+```sh
+pnpm run test:package wdio-junit-reporter
+```
+
+CJS `addProperty` load check: `pnpm --filter @wdio/test-interop-cjs run test:junit-reporter`.
+
+## Test ownership
+
+- JUnit XML shape (suites, failures, skips, Cucumber scenarios, BrowserStack package names, and file association) is owned by `tests/reporter.test.ts` through `_buildJunitXml`. Keep those snapshots. Do not stub the suite builders and assert the stub.
+- `onRunnerEnd` must write the built report. Assert that document. A mocked `undefined` snapshot does not.
+- Whitespace-stripped snapshots do not lock command-log spacing. Exact `COMMAND:` / `RESULT:` text stays on the stdout test.
+- `addProperty` is the public worker API (process event `junit:addProperty`). Call `addProperty`, not the private listener.
+- `addWorkerLogs` is owned by writing to `stdout` while a test is current, then restoring `stdout.write`.
+- The CJS interop check uses `assert.equal(typeof fn, 'function')`. `assert(typeof fn, 'function')` cannot fail.

package/README.md

@@ -149,18 +149,23 @@ export const config = {
 The following options are supported:
 
 ### outputDir
+
+<Option type="String">
+
 Define a directory where your XML files should get stored. Ignored if either `logFile` or `setLogFile` are defined.
 
-Type: `String`
+</Option>
 
 ### outputFileFormat
+
+<Option type="Object" default={`(opts) => \`wdio-\${opts.cid}-junit-reporter.log\``}>
+
 Function for defining the filename format for the reporter log files. Ignored if either `logFile` or `setLogFile`
 are defined.
 
 The function accepts an object input parameter with the `cid` and `capabilities` keys.
 
-Type: `Object`<br />
-Default: ``(opts) => `wdio-${opts.cid}-junit-reporter.log` ``<br />
+</Option>
 Example:
 ```js
 // wdio.conf.js
@@ -175,10 +180,13 @@ export const config = {
 ```
 
 ### logFile
+
+<Option type="String">
+
 Path to the reporter log file relative to the current directory. Overrides `outputDir` and `outputFileFormat`.
 Ignored if `setLogFile` is defined.
 
-Type: `String`<br />
+</Option>
 Example:
 ```js
 // wdio.conf.js
@@ -192,11 +200,14 @@ export const config = {
 ```
 
 ### setLogFile
+
+<Option type="Object">
+
 Function for defining the path for the reporter log files. Overrides `outputDir`, `outputFileFormat`, and `logFile`.
 
 The function accepts two input parameters: `cid` and `name` (the reporter name, set to `junit`).
 
-Type: `Object`<br />
+</Option>
 Example:
 ```js
 // wdio.conf.js
@@ -210,25 +221,32 @@ export const config = {
 ```
 
 ### stdout
+
+<Option type="boolean" default="false">
+
 Output the generated XML to the console instead of creating a log file.
 
-Type: `boolean`<br />
-Default: `false`
+</Option>
 
 ### writeStream
+
+<Option type="WriteStream">
+
 Set a stream to which the generated XML should be output, instead of creating a log file.
 
 Note: `logFile` must not be set, unless `stdout` is set to `true`.
 
-Type: `WriteStream`
+</Option>
 
 ### suiteNameFormat
+
+<Option type="Regex | Object" default="/[^a-zA-Z0-9@]+/">
+
 Format the generated name of a test suite, using custom regex or a function.
 
 The function accepts an object input parameter with the `name` and `suite` keys.
 
-Type: `Regex | Object`,<br />
-Default: `/[^a-zA-Z0-9@]+/`<br />
+</Option>
 Example with Regex:
 ```js
 // wdio.conf.js
@@ -255,12 +273,15 @@ export const config = {
 ```
 
 ### classNameFormat
+
+<Option type="Object">
+
 Format the generated classname of a test case.
 
 The function accepts an object input parameter with the [`packageName`](#packagename), `activeFeatureName`
 (Cucumber only), and `suite` (non-Cucumber only) keys.
 
-Type: `Object`<br />
+</Option>
 Default (Cucumber): ``(opts) => `${opts.packageName}${opts.activeFeatureName}` ``<br />
 Default (others): ``(opts) => `${opts.packageName}.${(opts.suite.fullTitle || opts.suite.title).replace(/\s/g, '_')}` ``<br />
 Example (Cucumber):
@@ -288,14 +309,14 @@ export const config = {
 };
 ```
 
-
 ### addFileAttribute
 
+<Option type="Boolean" default="false">
+
 Adds a `file` attribute to each testcase. The value of this attribute matches the filepath property of the parent test
 suite. This config is primarily for CircleCI, but may break on other CI platforms.
 
-Type: `Boolean`<br />
-Default: `false`<br />
+</Option>
 Example simplified XML:
 ```xml
 <testsuite>
@@ -310,9 +331,11 @@ Example simplified XML:
 
 ### packageName
 
+<Option type="String">
+
 You can break out packages by an additional level by setting `'packageName'`. For example, if you wanted to iterate over a test suite with a different environment variable set:
 
-Type: `String`<br />
+</Option>
 Default (Cucumber): `CucumberJUnitReport-${sanitizedCapabilities}`<br />
 Default (others): `${sanitizedCapabilities}`<br />
 Example:
@@ -331,6 +354,8 @@ export const config = {
 
 ### errorOptions
 
+<Option type="Object" default={`errorOptions: { error: "message" }`}>
+
 Allows to set various combinations of error notifications inside xml.<br />
 Given a Jasmine test like `expect(true).toBe(false, 'my custom message')` you will get this test error:
 
@@ -347,8 +372,7 @@ Given a Jasmine test like `expect(true).toBe(false, 'my custom message')` you wi
 
 Therefore you can choose *which* key will be used *where*, see the example below.
 
-Type: `Object`,<br />
-Default: `errorOptions: { error: "message" }`<br />
+</Option>
 Example:
 
 ```js
@@ -369,10 +393,11 @@ export const config = {
 
 ### addWorkerLogs
 
+<Option type="Boolean" default="false">
+
 Attach console logs from the test in the reporter.
 
-Type: `Boolean`<br />
-Default: `false`<br />
+</Option>
 Example:
 
 ```js
@@ -426,3 +451,5 @@ If there is no such post-build step in your CI system, there is probably a plugi
 ----
 
 For more information on WebdriverIO see the [homepage](https://webdriver.io).
+
+

package/build/index.d.ts

@@ -38,9 +38,27 @@ declare class JunitReporter extends WDIOReporter {
     private _addSuiteToBuilder;
     private _buildJunitXml;
     private _buildOrderedReport;
+    /**
+     * Emit filename-only suites that matched more than one grouped spec. They
+     * still belong in the report (issue #13052) but must not inherit the first
+     * spec's full path.
+     */
+    private _addAmbiguousBasenameSuites;
     private _getStandardOutput;
     private _getCommandStandardOutput;
     private _format;
+    private _toFilePath;
+    private _isBasenameOnly;
+    private _fileNamesEqual;
+    private _matchingSpecCount;
+    /**
+     * Decide whether a suite can be tied to a specific runner spec.
+     * - unique: full path match, or a filename-only Jasmine suite whose
+     *   basename appears once in runner.specs
+     * - ambiguous: filename-only suite that matches multiple grouped specs
+     * - none: not the same file
+     */
+    private _suiteFileAssociation;
     private _sameFileName;
 }
 export * from './common/api.js';

package/build/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,WAAW,EAAc,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAGzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAmBtD;;;;;GAKG;AACH,cAAM,aAAc,SAAQ,YAAY;IAajB,OAAO,EAAE,oBAAoB;IAZhD,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAC,CAAK;IAC5B,OAAO,CAAC,kBAAkB,CAAC,CAAK;IAChC,OAAO,CAAC,4BAA4B,CAAwD;IAC5F,OAAO,CAAC,YAAY,CAAC,CAAW;IAChC,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAS;gBAER,OAAO,EAAE,oBAAoB;IAiBhD,WAAW,CAAC,SAAS,EAAE,SAAS;IAIhC,WAAW,CAAC,IAAI,EAAE,SAAS;IAU3B,WAAW,CAAC,MAAM,EAAE,WAAW;IAK/B,OAAO,CAAC,yBAAyB;IAMjC,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,eAAe;IAkBvB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IA+CtB,OAAO,CAAC,4BAA4B;IA6GpC,OAAO,CAAC,kBAAkB;IAqC1B,OAAO,CAAC,cAAc;IA2CtB,OAAO,CAAC,mBAAmB;IAwC3B,OAAO,CAAC,kBAAkB;IAkB1B,OAAO,CAAC,yBAAyB;IAoBjC,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,aAAa;CAgBxB;AAED,cAAc,iBAAiB,CAAA;AAC/B,eAAe,aAAa,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAc,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACxE,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAGzC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAmBtD;;;;;GAKG;AACH,cAAM,aAAc,SAAQ,YAAY;IAajB,OAAO,EAAE,oBAAoB;IAZhD,OAAO,CAAC,eAAe,CAAQ;IAC/B,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,gBAAgB,CAAC,CAAQ;IACjC,OAAO,CAAC,cAAc,CAAC,CAAQ;IAC/B,OAAO,CAAC,cAAc,CAAC,CAAK;IAC5B,OAAO,CAAC,kBAAkB,CAAC,CAAK;IAChC,OAAO,CAAC,4BAA4B,CAAwD;IAC5F,OAAO,CAAC,YAAY,CAAC,CAAW;IAChC,OAAO,CAAC,oBAAoB,CAAU;IACtC,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,UAAU,CAAS;gBAER,OAAO,EAAE,oBAAoB;IAiBhD,WAAW,CAAC,SAAS,EAAE,SAAS;IAIhC,WAAW,CAAC,IAAI,EAAE,SAAS;IAU3B,WAAW,CAAC,MAAM,EAAE,WAAW;IAK/B,OAAO,CAAC,yBAAyB;IAMjC,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,YAAY;IAMpB,OAAO,CAAC,eAAe;IAkBvB;;;;OAIG;IACH,OAAO,CAAC,cAAc;IA+CtB,OAAO,CAAC,4BAA4B;IA6GpC,OAAO,CAAC,kBAAkB;IAqC1B,OAAO,CAAC,cAAc;IAuDtB,OAAO,CAAC,mBAAmB;IA6D3B;;;;OAIG;IACH,OAAO,CAAC,2BAA2B;IAkCnC,OAAO,CAAC,kBAAkB;IAkB1B,OAAO,CAAC,yBAAyB;IAoBjC,OAAO,CAAC,OAAO;IAIf,OAAO,CAAC,WAAW;IAInB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,eAAe;IAIvB,OAAO,CAAC,kBAAkB;IAO1B;;;;;;OAMG;IACH,OAAO,CAAC,qBAAqB;IAoB7B,OAAO,CAAC,aAAa;CAuBxB;AAED,cAAc,iBAAiB,CAAA;AAC/B,eAAe,aAAa,CAAA"}

package/build/index.js

@@ -1,4 +1,5 @@
 // src/index.ts
+import path from "node:path";
 import url from "node:url";
 import os from "node:os";
 import WDIOReporter from "@wdio/reporter";
@@ -318,17 +319,19 @@ ${stepsOutput}
       this._suiteTitleLabel = "suiteName";
       this._fileNameLabel = "file";
     }
+    const assignedSuiteKeys = /* @__PURE__ */ new Set();
     runner.specs.forEach((specFileName) => {
       if (isCucumberFrameworkRunner) {
-        this._buildOrderedReport(builder, runner, specFileName, "feature", isCucumberFrameworkRunner);
-        this._buildOrderedReport(builder, runner, specFileName, "scenario", isCucumberFrameworkRunner);
+        this._buildOrderedReport(builder, runner, specFileName, "feature", isCucumberFrameworkRunner, assignedSuiteKeys);
+        this._buildOrderedReport(builder, runner, specFileName, "scenario", isCucumberFrameworkRunner, assignedSuiteKeys);
       } else {
-        this._buildOrderedReport(builder, runner, specFileName, "", isCucumberFrameworkRunner);
+        this._buildOrderedReport(builder, runner, specFileName, "", isCucumberFrameworkRunner, assignedSuiteKeys);
       }
     });
+    this._addAmbiguousBasenameSuites(builder, runner, isCucumberFrameworkRunner, assignedSuiteKeys);
     return builder.build();
   }
-  _buildOrderedReport(builder, runner, specFileName, type, isCucumberFrameworkRunner) {
+  _buildOrderedReport(builder, runner, specFileName, type, isCucumberFrameworkRunner, assignedSuiteKeys) {
     const suiteKeys = Object.keys(this.suites);
     if (suiteKeys.length === 0) {
       if (!isCucumberFrameworkRunner || isCucumberFrameworkRunner && type === "feature") {
@@ -343,16 +346,48 @@ ${stepsOutput}
       if (suiteKey.match(/^"before all"/)) {
         continue;
       }
+      if (assignedSuiteKeys.has(suiteKey)) {
+        continue;
+      }
       const suite = this.suites[suiteKey];
-      const sameSpecFileName = this._sameFileName(specFileName, suite.file);
-      if (isCucumberFrameworkRunner && suite.type === type && sameSpecFileName) {
+      if (this._suiteFileAssociation(specFileName, suite.file, runner?.specs) !== "unique") {
+        continue;
+      }
+      if (isCucumberFrameworkRunner && suite.type === type) {
+        assignedSuiteKeys.add(suiteKey);
         builder = this._addCucumberFeatureToBuilder(builder, runner, specFileName, suite);
-      } else if (!isCucumberFrameworkRunner && sameSpecFileName) {
+      } else if (!isCucumberFrameworkRunner) {
+        assignedSuiteKeys.add(suiteKey);
         builder = this._addSuiteToBuilder(builder, runner, specFileName, suite);
       }
     }
     return builder;
   }
+  /**
+   * Emit filename-only suites that matched more than one grouped spec. They
+   * still belong in the report (issue #13052) but must not inherit the first
+   * spec's full path.
+   */
+  _addAmbiguousBasenameSuites(builder, runner, isCucumberFrameworkRunner, assignedSuiteKeys) {
+    const types = isCucumberFrameworkRunner ? ["feature", "scenario"] : [""];
+    for (const type of types) {
+      for (const suiteKey of Object.keys(this.suites)) {
+        if (suiteKey.match(/^"before all"/) || assignedSuiteKeys.has(suiteKey)) {
+          continue;
+        }
+        const suite = this.suites[suiteKey];
+        if (isCucumberFrameworkRunner && suite.type !== type) {
+          continue;
+        }
+        if (!suite.file || !this._isBasenameOnly(this._toFilePath(suite.file)) || this._matchingSpecCount(suite.file, runner.specs) <= 1) {
+          continue;
+        }
+        assignedSuiteKeys.add(suiteKey);
+        builder = isCucumberFrameworkRunner ? this._addCucumberFeatureToBuilder(builder, runner, suite.file, suite) : this._addSuiteToBuilder(builder, runner, suite.file, suite);
+      }
+    }
+    return builder;
+  }
   _getStandardOutput(test) {
     let consoleOutput = "";
     if (this._addWorkerLogs) {
@@ -388,6 +423,39 @@ ${stepsOutput}
   _format(val) {
     return JSON.stringify(limit(val));
   }
+  _toFilePath(file) {
+    return file.startsWith("file://") ? url.fileURLToPath(file) : file;
+  }
+  _isBasenameOnly(file) {
+    return !file.includes("/") && !file.includes("\\");
+  }
+  _fileNamesEqual(file1, file2) {
+    return file1.localeCompare(file2, void 0, { sensitivity: this._isWindows ? "accent" : "variant" }) === 0;
+  }
+  _matchingSpecCount(suiteFile, runnerSpecs) {
+    const suiteBase = path.basename(this._toFilePath(suiteFile));
+    return runnerSpecs.filter((spec) => this._fileNamesEqual(path.basename(this._toFilePath(spec)), suiteBase)).length;
+  }
+  /**
+   * Decide whether a suite can be tied to a specific runner spec.
+   * - unique: full path match, or a filename-only Jasmine suite whose
+   *   basename appears once in runner.specs
+   * - ambiguous: filename-only suite that matches multiple grouped specs
+   * - none: not the same file
+   */
+  _suiteFileAssociation(specFileName, suiteFile, runnerSpecs = []) {
+    if (!this._sameFileName(specFileName, suiteFile)) {
+      return "none";
+    }
+    if (!suiteFile) {
+      return "unique";
+    }
+    const suitePath = this._toFilePath(suiteFile);
+    if (!this._isBasenameOnly(suitePath)) {
+      return "unique";
+    }
+    return this._matchingSpecCount(suiteFile, runnerSpecs) > 1 ? "ambiguous" : "unique";
+  }
   _sameFileName(file1, file2) {
     if (!file1 && !file2) {
       return true;
@@ -395,9 +463,13 @@ ${stepsOutput}
     if (!file1 || !file2) {
       return false;
     }
-    file1 = file1.startsWith("file://") ? url.fileURLToPath(file1) : file1;
-    file2 = file2.startsWith("file://") ? url.fileURLToPath(file2) : file2;
-    return file1.localeCompare(file2, void 0, { sensitivity: this._isWindows ? "accent" : "variant" }) === 0;
+    file1 = this._toFilePath(file1);
+    file2 = this._toFilePath(file2);
+    if (this._isBasenameOnly(file1) || this._isBasenameOnly(file2)) {
+      file1 = path.basename(file1);
+      file2 = path.basename(file2);
+    }
+    return this._fileNamesEqual(file1, file2);
   }
 };
 var index_default = JunitReporter;

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@wdio/junit-reporter",
-  "version": "9.32.0-alpha.6+3d8818a67",
+  "version": "10.0.0-alpha.148+3a926c3d0",
   "description": "A WebdriverIO reporter that creates Jenkins compatible XML based JUnit reports",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-junit-reporter",
   "license": "MIT",
   "engines": {
-    "node": ">=18.20.0"
+    "node": ">=22.19.0"
   },
   "repository": {
     "type": "git",
@@ -33,12 +33,12 @@
       "require": "./build/index.cjs"
     }
   },
-  "typeScriptVersion": "3.8.3",
+  "typeScriptVersion": "6.0.3",
   "dependencies": {
-    "@wdio/reporter": "9.32.0-alpha.6+3d8818a67",
-    "@wdio/types": "9.32.0-alpha.6+3d8818a67",
+    "@wdio/reporter": "10.0.0-alpha.148+3a926c3d0",
+    "@wdio/types": "10.0.0-alpha.148+3a926c3d0",
     "json-stringify-safe": "^5.0.1",
-    "junit-report-builder": "^5.1.1"
+    "junit-report-builder": "^5.1.2"
   },
   "devDependencies": {
     "@types/json-stringify-safe": "^5.0.0"
@@ -46,5 +46,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3d8818a67404f0b5d4b81eda877ffad1f4d317c0"
+  "gitHead": "3a926c3d08dafa93c92021b2892341709d74968a"
 }