fix: add ordering of fields for consistent output (#19)

Brightspace · Dec 21, 2023 · d636839 · d636839
1 parent dfc9891
commit d636839
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 7 deletions.
diff --git a/.c8rc.json b/.c8rc.json
@@ -3,7 +3,7 @@
   "check-coverage": true,
   "statements": 90,
   "branches": 75,
-  "functions": 85,
+  "functions": 90,
   "lines": 90,
   "include": [
     "src/**/*.{js,cjs}"

diff --git a/src/reporters/helpers.cjs b/src/reporters/helpers.cjs
@@ -2,6 +2,40 @@ const { relative, sep: platformSeparator } = require('path');
 const { join } = require('path/posix');
 const { type } = require('os');
 
+const memberPriority = [
+	'reportId',
+	'reportVersion',
+	'summary',
+	'details',
+	'githubOrganization',
+	'githubRepository',
+	'githubWorkflow',
+	'githubRunId',
+	'githubRunAttempt',
+	'gitBranch',
+	'gitSha',
+	'name',
+	'status',
+	'lmsInstance',
+	'lmsBuild',
+	'location',
+	'browser',
+	'framework',
+	'operatingSystem',
+	'started',
+	'totalDuration',
+	'duration',
+	'countPassed',
+	'countFailed',
+	'countSkipped',
+	'countFlaky',
+	'retries'
+];
+
+const generateReportOutput = (report) => {
+	return JSON.stringify(report, memberPriority);
+};
+
 const getOperatingSystem = () => {
 	switch (type()) {
 		case 'Linux':
@@ -22,4 +56,4 @@ const makeLocation = (filePath) => {
 	return join(...pathParts);
 };
 
-module.exports = { getOperatingSystem, makeLocation };
+module.exports = { generateReportOutput, getOperatingSystem, makeLocation };
diff --git a/src/reporters/mocha.cjs b/src/reporters/mocha.cjs
@@ -1,7 +1,7 @@
 
 const { reporters: { Base, Spec } } = require('mocha');
 const { hasContext, getContext } = require('../helpers/github.cjs');
-const { getOperatingSystem, makeLocation } = require('./helpers.cjs');
+const { getOperatingSystem, makeLocation, generateReportOutput } = require('./helpers.cjs');
 const { resolve } = require('path');
 const { Runner: { constants } } = require('mocha');
 const { v4: uuid } = require('uuid');
@@ -128,7 +128,7 @@ class TestReportingMochaReporter extends Spec {
 		);
 
 		try {
-			const reportOutput = JSON.stringify(this._report);
+			const reportOutput = generateReportOutput(this._report);
 			const filePath = resolve(this._reportPath);
 
 			writeFileSync(filePath, reportOutput, 'utf8');

diff --git a/src/reporters/playwright.js b/src/reporters/playwright.js
@@ -1,7 +1,7 @@
+import { generateReportOutput, getOperatingSystem, makeLocation } from './helpers.cjs';
+import { getContext, hasContext } from '../helpers/github.cjs';
 import { colors } from 'playwright-core/lib/utilsBundle';
 import { v4 as uuid } from 'uuid';
-import { getOperatingSystem, makeLocation } from './helpers.cjs';
-import { getContext, hasContext } from '../helpers/github.cjs';
 import { resolve } from 'path';
 import { writeFile } from 'fs/promises';
 
@@ -123,7 +123,7 @@ export default class Reporter {
 		}
 
 		try {
-			const reportOutput = JSON.stringify(this._report);
+			const reportOutput = generateReportOutput(this._report);
 			const filePath = resolve(this._reportPath);
 
 			await writeFile(filePath, reportOutput, 'utf8');