feat: output more location and timeout information (#209)

Brightspace · May 2, 2024 · 7be98be · 7be98be
1 parent 8a938eb
commit 7be98be
Show file tree

Hide file tree

Showing 8 changed files with 217 additions and 40 deletions.
diff --git a/src/helpers/report-builder.cjs b/src/helpers/report-builder.cjs
@@ -32,6 +32,7 @@ const reportMemberPriority = [
 	'browser',
 	'framework',
 	'operatingSystem',
+	'timeout',
 	'started',
 	'duration',
 	'total',
@@ -267,6 +268,12 @@ class ReportDetailBuilder extends ReportBuilderBase {
 
 		return this;
 	}
+
+	setTimeout(timeout, options) {
+		this._setProperty('timeout', timeout, options);
+
+		return this;
+	}
 }
 
 class ReportBuilder extends ReportBuilderBase {

diff --git a/src/reporters/mocha.cjs b/src/reporters/mocha.cjs
@@ -57,7 +57,7 @@ class TestReportingMochaReporter extends Spec {
 	}
 
 	_onTestBegin(test) {
-		const { file } = test;
+		const { file, _timeout } = test;
 
 		if (this._report.ignoreFilePath(file)) {
 			return;
@@ -70,7 +70,8 @@ class TestReportingMochaReporter extends Spec {
 		detail
 			.setName(name)
 			.setLocationFile(file)
-			.setStarted((new Date()).toISOString());
+			.setStarted((new Date()).toISOString())
+			.setTimeout(_timeout); // using internal property, not ideal
 	}
 
 	_onTestRetry(test) {

diff --git a/src/reporters/playwright.js b/src/reporters/playwright.js
@@ -63,7 +63,7 @@ export default class Reporter {
 	}
 
 	onTestEnd(test, result) {
-		const { location: { file } } = test;
+		const { timeout, location: { file, line, column } } = test;
 
 		if (this._report.ignoreFilePath(file)) {
 			return;
@@ -77,7 +77,10 @@ export default class Reporter {
 			.getDetail(id)
 			.setName(name)
 			.setLocationFile(file)
+			.setLocationLine(line)
+			.setLocationColumn(column)
 			.setStarted(startTime)
+			.setTimeout(Math.round(timeout))
 			.addDuration(Math.round(duration));
 
 		if (retry !== 0) {

diff --git a/src/reporters/web-test-runner.js b/src/reporters/web-test-runner.js
@@ -38,6 +38,7 @@ export function reporter(options = {}) {
 		}
 
 		const browser = browserName.toLowerCase();
+		const { testsFinishTimeout } = testConfig;
 
 		for (const test of tests) {
 			const { skipped, passed, duration, name } = test;
@@ -48,7 +49,8 @@ export function reporter(options = {}) {
 				.setName(testName)
 				.setLocationFile(testFile)
 				.setStarted(started)
-				.setBrowser(browser);
+				.setBrowser(browser)
+				.setTimeout(testsFinishTimeout);
 
 			if (passed) {
 				detail.setPassed();

diff --git a/test/integration/data/validation/test-report-mocha.js b/test/integration/data/validation/test-report-mocha.js
@@ -79,12 +79,18 @@ export const testReportV2Partial = {
 	summary: {
 		status: 'failed',
 		framework: 'mocha',
-		count: { passed: 2, failed: 2, skipped: 2, flaky: 2 }
+		count: {
+			passed: 2,
+			failed: 2,
+			skipped: 2,
+			flaky: 2
+		}
 	},
 	details: [{
 		name: 'reporter tests 1 > test',
 		status: 'passed',
 		location: { file: 'test/integration/data/mocha-1.test.js' },
+		timeout: 2000,
 		tool: 'Mocha 1 Test Reporting',
 		experience: 'Test Framework',
 		type: 'ui',
@@ -93,6 +99,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 1 > skipped test',
 		status: 'skipped',
 		location: { file: 'test/integration/data/mocha-1.test.js' },
+		timeout: 2000,
 		tool: 'Mocha 1 Test Reporting',
 		experience: 'Test Framework',
 		type: 'ui',
@@ -101,6 +108,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 1 > flaky test',
 		status: 'passed',
 		location: { file: 'test/integration/data/mocha-1.test.js' },
+		timeout: 2000,
 		tool: 'Mocha 1 Test Reporting',
 		experience: 'Test Framework',
 		type: 'ui',
@@ -109,6 +117,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 1 > failed test',
 		status: 'failed',
 		location: { file: 'test/integration/data/mocha-1.test.js' },
+		timeout: 2000,
 		tool: 'Mocha 1 Test Reporting',
 		experience: 'Test Framework',
 		type: 'ui',
@@ -117,6 +126,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 2 > test',
 		status: 'passed',
 		location: { file: 'test/integration/data/mocha-2.test.js' },
+		timeout: 2000,
 		tool: 'Test Reporting',
 		experience: 'Mocha 2 Test Framework',
 		type: 'integration',
@@ -125,6 +135,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 2 > skipped test',
 		status: 'skipped',
 		location: { file: 'test/integration/data/mocha-2.test.js' },
+		timeout: 2000,
 		tool: 'Test Reporting',
 		experience: 'Mocha 2 Test Framework',
 		type: 'integration',
@@ -133,6 +144,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 2 > flaky test',
 		status: 'passed',
 		location: { file: 'test/integration/data/mocha-2.test.js' },
+		timeout: 2000,
 		tool: 'Test Reporting',
 		experience: 'Mocha 2 Test Framework',
 		type: 'integration',
@@ -141,6 +153,7 @@ export const testReportV2Partial = {
 		name: 'reporter tests 2 > failed test',
 		status: 'failed',
 		location: { file: 'test/integration/data/mocha-2.test.js' },
+		timeout: 2000,
 		tool: 'Test Reporting',
 		experience: 'Mocha 2 Test Framework',
 		type: 'integration',