Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

chore(reporter): report shardIndex (#38608)

Simon Knotta7886413d37f
diff --git a/docs/src/test-reporter-api/class-testresult.md b/docs/src/test-reporter-api/class-testresult.md
index ef41200b40..278a2dbaf6 100644
--- a/docs/src/test-reporter-api/class-testresult.md
+++ b/docs/src/test-reporter-api/class-testresult.md
@@ -100,3 +100,9 @@ Learn more about [parallelism and sharding](../test-parallel.md) with Playwright
- type: <[int]>
The index of the worker between `0` and `workers - 1`. It is guaranteed that workers running at the same time have a different `parallelIndex`.
+
+## property: TestResult.shardIndex
+* since: v1.58
+- type: <[int]>
+
+The index of the shard between `0` and `shards - 1`.
diff --git a/packages/playwright/src/common/test.ts b/packages/playwright/src/common/test.ts
index dce6cbcd83..bae4bde071 100644
--- a/packages/playwright/src/common/test.ts
+++ b/packages/playwright/src/common/test.ts
@@ -345,6 +345,7 @@ export class TestCase extends Base implements reporterTypes.TestCase {
retry: this.results.length,
parallelIndex: -1,
workerIndex: -1,
+ shardIndex: -1,
duration: 0,
startTime: new Date(),
stdout: [],
diff --git a/packages/playwright/src/isomorphic/teleReceiver.ts b/packages/playwright/src/isomorphic/teleReceiver.ts
index 43d94d0007..859dd7ffdc 100644
--- a/packages/playwright/src/isomorphic/teleReceiver.ts
+++ b/packages/playwright/src/isomorphic/teleReceiver.ts
@@ -87,6 +87,7 @@ export type JsonTestResultStart = {
retry: number;
workerIndex: number;
parallelIndex: number;
+ shardIndex: number;
startTime: number;
};
@@ -356,6 +357,7 @@ export class TeleReporterReceiver {
testResult.retry = payload.retry;
testResult.workerIndex = payload.workerIndex;
testResult.parallelIndex = payload.parallelIndex;
+ testResult.shardIndex = payload.shardIndex;
testResult.setStartTimeNumber(payload.startTime);
this._reporter.onTestBegin?.(test, testResult);
}
@@ -723,6 +725,7 @@ export class TeleTestResult implements reporterTypes.TestResult {
retry: reporterTypes.TestResult['retry'];
parallelIndex: reporterTypes.TestResult['parallelIndex'] = -1;
workerIndex: reporterTypes.TestResult['workerIndex'] = -1;
+ shardIndex: reporterTypes.TestResult['shardIndex'] = -1;
duration: reporterTypes.TestResult['duration'] = -1;
stdout: reporterTypes.TestResult['stdout'] = [];
stderr: reporterTypes.TestResult['stderr'] = [];
diff --git a/packages/playwright/src/reporters/json.ts b/packages/playwright/src/reporters/json.ts
index 5823746e50..566d06dce1 100644
--- a/packages/playwright/src/reporters/json.ts
+++ b/packages/playwright/src/reporters/json.ts
@@ -200,6 +200,7 @@ class JSONReporter implements ReporterV2 {
const jsonResult: JSONReportTestResult = {
workerIndex: result.workerIndex,
parallelIndex: result.parallelIndex,
+ shardIndex: result.shardIndex,
status: result.status,
duration: result.duration,
error: result.error,
diff --git a/packages/playwright/src/reporters/teleEmitter.ts b/packages/playwright/src/reporters/teleEmitter.ts
index 42c688fb5c..4efd401309 100644
--- a/packages/playwright/src/reporters/teleEmitter.ts
+++ b/packages/playwright/src/reporters/teleEmitter.ts
@@ -258,6 +258,7 @@ export class TeleReporterEmitter implements ReporterV2 {
retry: result.retry,
workerIndex: result.workerIndex,
parallelIndex: result.parallelIndex,
+ shardIndex: result.shardIndex,
startTime: +result.startTime,
};
}
diff --git a/packages/playwright/src/runner/dispatcher.ts b/packages/playwright/src/runner/dispatcher.ts
index d12091d629..e00ba5b459 100644
--- a/packages/playwright/src/runner/dispatcher.ts
+++ b/packages/playwright/src/runner/dispatcher.ts
@@ -320,6 +320,7 @@ class JobDispatcher {
this._dataByTestId.set(test.id, { test, result, steps: new Map() });
result.parallelIndex = this._parallelIndex;
result.workerIndex = this._workerIndex;
+ result.shardIndex = this._config.config.shard?.current ?? 0;
result.startTime = new Date(params.startWallTime);
this._reporter.onTestBegin?.(test, result);
this._currentlyRunning = { test, result };
diff --git a/packages/playwright/types/testReporter.d.ts b/packages/playwright/types/testReporter.d.ts
index df4a40ba0d..8ae9b6935d 100644
--- a/packages/playwright/types/testReporter.d.ts
+++ b/packages/playwright/types/testReporter.d.ts
@@ -297,6 +297,7 @@ export interface JSONReportError {
export interface JSONReportTestResult {
workerIndex: number;
parallelIndex: number;
+ shardIndex: number;
status: TestStatus | undefined;
duration: number;
error: TestError | undefined;
@@ -680,6 +681,11 @@ export interface TestResult {
*/
retry: number;
+ /**
+ * The index of the shard between `0` and `shards - 1`.
+ */
+ shardIndex: number;
+
/**
* Start time of this particular test run.
*/
diff --git a/tests/playwright-test/reporter-json.spec.ts b/tests/playwright-test/reporter-json.spec.ts
index 89b995ff35..18f4d52d12 100644
--- a/tests/playwright-test/reporter-json.spec.ts
+++ b/tests/playwright-test/reporter-json.spec.ts
@@ -68,6 +68,7 @@ test('should not report skipped due to sharding', async ({ runInlineTest }) => {
expect(result.report.suites[0].specs.length).toBe(2);
expect(result.report.suites[0].specs[0].tests[0].status).toBe('expected');
expect(result.report.suites[0].specs[1].tests[0].status).toBe('skipped');
+ expect(result.report.suites[0].specs[1].tests[0].results[0].shardIndex).toBe(1);
});
test('should report projects and stats', async ({ runInlineTest }, testInfo) => {
diff --git a/utils/generate_types/overrides-testReporter.d.ts b/utils/generate_types/overrides-testReporter.d.ts
index b949dd3d0c..c92e37b006 100644
--- a/utils/generate_types/overrides-testReporter.d.ts
+++ b/utils/generate_types/overrides-testReporter.d.ts
@@ -110,6 +110,7 @@ export interface JSONReportError {
export interface JSONReportTestResult {
workerIndex: number;
parallelIndex: number;
+ shardIndex: number;
status: TestStatus | undefined;
duration: number;
error: TestError | undefined;