fix: escape some special characters if present in test name (#386)

src/helpers/report-builder.cjs

@@ -4,6 +4,7 @@ const { randomUUID } = require('node:crypto');
 const { resolve } = require('node:path');
 const { ReportConfiguration } = require('./report-configuration.cjs');
 const { writeFileSync } = require('node:fs');
+const { escapeSpecialCharacters } = require('./strings.cjs');
 
 const defaultReportPath = './d2l-test-report.json';
 const reportMemberPriority = [
@@ -186,7 +187,7 @@ class ReportDetailBuilder extends ReportBuilderBase {
 	}
 
 	setName(name, options) {
-		this._setProperty('name', name, options);
+		this._setProperty('name', escapeSpecialCharacters(name), options);
 
 		return this;
 	}

src/helpers/strings.cjs

@@ -0,0 +1,11 @@
+const escapeSpecialCharacters = (str) => {
+	return str
+		.replace(/[\\]/g, '\\\\')
+		.replace(/[\b]/g, '\\b')
+		.replace(/[\f]/g, '\\f')
+		.replace(/[\n]/g, '\\n')
+		.replace(/[\r]/g, '\\r')
+		.replace(/[\t]/g, '\\t');
+};
+
+module.exports = { escapeSpecialCharacters };

test/integration/data/tests/mocha/reporter-1.test.js

@@ -27,6 +27,8 @@ describe('reporter 1', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/tests/mocha/reporter-2.test.js

@@ -27,6 +27,8 @@ describe('reporter 2', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/tests/mocha/reporter-3.test.js

@@ -27,6 +27,8 @@ describe('reporter 3', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/tests/playwright/reporter-1.test.js

@@ -55,6 +55,8 @@ test.describe('reporter 1', () => {
 		throw new Error('fail');
 	});
 
+	test('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	test.afterEach(async() => { await delay(250); });
 
 	test.afterAll(async() => { await delay(250); });

test/integration/data/tests/playwright/reporter-2.test.js

@@ -55,6 +55,8 @@ test.describe('reporter 2', () => {
 		throw new Error('fail');
 	});
 
+	test('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	test.afterEach(async() => { await delay(250); });
 
 	test.afterAll(async() => { await delay(250); });

test/integration/data/tests/playwright/reporter-3.test.js

@@ -55,6 +55,8 @@ test.describe('reporter 3', () => {
 		throw new Error('fail');
 	});
 
+	test('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	test.afterEach(async() => { await delay(250); });
 
 	test.afterAll(async() => { await delay(250); });

test/integration/data/tests/web-test-runner/reporter-1.test.js

@@ -13,6 +13,8 @@ describe('reporter 1', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/tests/web-test-runner/reporter-2.test.js

@@ -13,6 +13,8 @@ describe('reporter 2', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/tests/web-test-runner/reporter-3.test.js

@@ -13,6 +13,8 @@ describe('reporter 3', () => {
 
 	it('failed', () => { throw new Error('fail'); });
 
+	it('special/characters "(\n\r\t\b\f)"', async() => { await delay(); });
+
 	afterEach(async() => { await delay(250); });
 
 	after(async() => { await delay(250); });

test/integration/data/validation/test-report-mocha.js

@@ -3,12 +3,7 @@ export const testReportV2Partial = {
 	summary: {
 		status: 'failed',
 		framework: 'mocha',
-		count: {
-			passed: 2,
-			failed: 2,
-			skipped: 2,
-			flaky: 2
-		}
+		count: { passed: 4, failed: 2, skipped: 2, flaky: 2 }
 	},
 	details: [{
 		name: 'reporter 1 > passed',
@@ -82,5 +77,23 @@ export const testReportV2Partial = {
 		experience: 'Mocha 2 Test Framework',
 		type: 'integration',
 		retries: 3
+	}, {
+		name: 'reporter 1 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: { file: 'test/integration/data/tests/mocha/reporter-1.test.js' },
+		timeout: 2000,
+		tool: 'Mocha 1 Test Reporting',
+		experience: 'Test Framework',
+		type: 'ui',
+		retries: 0
+	}, {
+		name: 'reporter 2 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: { file: 'test/integration/data/tests/mocha/reporter-2.test.js' },
+		timeout: 2000,
+		tool: 'Test Reporting',
+		experience: 'Mocha 2 Test Framework',
+		type: 'integration',
+		retries: 0
 	}]
 };

test/integration/data/validation/test-report-playwright.js

@@ -3,12 +3,7 @@ export const testReportV2Partial = {
 	summary: {
 		status: 'failed',
 		framework: 'playwright',
-		count: {
-			passed: 15,
-			failed: 5,
-			skipped: 30,
-			flaky: 5
-		}
+		count: { passed: 20, failed: 5, skipped: 30, flaky: 5 }
 	},
 	details: [{
 		name: '[chromium] > reporter 1 > skipped static, fixme',
@@ -780,5 +775,75 @@ export const testReportV2Partial = {
 		experience: 'Playwright 2 Test Framework',
 		type: 'visual diff',
 		retries: 0
+	}, {
+		name: '[chromium] > reporter 1 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: {
+			file: 'test/integration/data/tests/playwright/reporter-1.test.js',
+			line: 58,
+			column: 2
+		},
+		browser: 'chromium',
+		timeout: 30000,
+		tool: 'Playwright 1 Test Reporting',
+		experience: 'Playwright 1 Test Framework',
+		type: 'integration',
+		retries: 0
+	}, {
+		name: '[chromium] > reporter 2 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: {
+			file: 'test/integration/data/tests/playwright/reporter-2.test.js',
+			line: 58,
+			column: 2
+		},
+		browser: 'chromium',
+		timeout: 30000,
+		tool: 'Test Reporting',
+		experience: 'Playwright 2 Test Framework',
+		type: 'visual diff',
+		retries: 0
+	}, {
+		name: '[firefox] > reporter 2 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: {
+			file: 'test/integration/data/tests/playwright/reporter-2.test.js',
+			line: 58,
+			column: 2
+		},
+		browser: 'firefox',
+		timeout: 30000,
+		tool: 'Test Reporting',
+		experience: 'Playwright 2 Test Framework',
+		type: 'visual diff',
+		retries: 0
+	}, {
+		name: '[webkit] > reporter 1 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: {
+			file: 'test/integration/data/tests/playwright/reporter-1.test.js',
+			line: 58,
+			column: 2
+		},
+		browser: 'webkit',
+		timeout: 30000,
+		tool: 'Playwright 1 Test Reporting',
+		experience: 'Playwright 1 Test Framework',
+		type: 'integration',
+		retries: 0
+	}, {
+		name: '[webkit] > reporter 2 > special/characters "(\\n\\r\\t\\b\\f)"',
+		status: 'passed',
+		location: {
+			file: 'test/integration/data/tests/playwright/reporter-2.test.js',
+			line: 58,
+			column: 2
+		},
+		browser: 'webkit',
+		timeout: 30000,
+		tool: 'Test Reporting',
+		experience: 'Playwright 2 Test Framework',
+		type: 'visual diff',
+		retries: 0
 	}]
 };