test: suppress logs except errors

Author: gautamkrishnar

package.json

@@ -10,9 +10,9 @@
     "start-server": "node test/testUtils/test-server.js",
     "local-run-script": "node local-run.js",
     "local-run": "start-server-and-test start-server http://localhost:8080 local-run-script",
-    "test-run": "mocha --parallel --reporter json --reporter-option output=src-report.json --jobs 100 test/**.js",
+    "test-run": "mocha --require test/setup.js --parallel --reporter json --reporter-option output=src-report.json --jobs 100 test/**.js",
     "test": "yarn run lint && start-server-and-test start-server http://localhost:8080 test-run",
-    "test-run-dist": "DIST=true mocha --parallel --reporter json --reporter-option output=dist-report.json --jobs 100 test/**.js",
+    "test-run-dist": "DIST=true mocha --require test/setup.js --parallel --reporter json --reporter-option output=dist-report.json --jobs 100 test/**.js",
     "test-dist": "yarn run lint && start-server-and-test start-server http://localhost:8080 test-run-dist",
     "prepare": "husky"
   },

test/setup.js

@@ -0,0 +1,20 @@
+const {
+	setupLogSuppression,
+	restoreLogsOnFailure,
+	restoreMethods,
+} = require('./testUtils/suppress-logs');
+
+// Root hooks for Mocha
+exports.mochaHooks = {
+	beforeEach() {
+		setupLogSuppression();
+	},
+
+	afterEach() {
+		restoreLogsOnFailure.call(this);
+	},
+
+	afterAll() {
+		restoreMethods();
+	},
+};

test/testUtils/suppress-logs.js

@@ -0,0 +1,114 @@
+const core = require('@actions/core');
+const path = require('node:path');
+
+// Get project root directory (where package.json is)
+const projectRoot = path.dirname(path.dirname(__dirname));
+
+// Store original methods
+const originalMethods = {
+	info: core.info,
+	debug: core.debug,
+	warning: core.warning,
+	error: core.error,
+	setSecret: core.setSecret,
+	setOutput: core.setOutput,
+	setFailed: core.setFailed,
+	notice: core.notice,
+	startGroup: core.startGroup,
+	endGroup: core.endGroup,
+};
+
+// Store logs during test execution
+let logs = [];
+
+/**
+ * Setup log suppression before each test
+ */
+const setupLogSuppression = () => {
+	// Clear logs
+	logs = [];
+
+	// Mock core methods to capture logs instead of printing
+	core.info = (...args) => {
+		logs.push({ level: 'info', args });
+	};
+
+	core.debug = (...args) => {
+		logs.push({ level: 'debug', args });
+	};
+
+	core.warning = (...args) => {
+		logs.push({ level: 'warning', args });
+	};
+
+	core.error = (...args) => {
+		logs.push({ level: 'error', args });
+	};
+
+	core.setSecret = () => {
+		// Suppress ::add-mask:: output
+	};
+
+	core.setOutput = () => {
+		// Suppress ::set-output:: output
+	};
+
+	core.setFailed = (...args) => {
+		logs.push({ level: 'setFailed', args });
+	};
+
+	core.notice = (...args) => {
+		logs.push({ level: 'notice', args });
+	};
+
+	core.startGroup = () => {
+		// Suppress group output
+	};
+
+	core.endGroup = () => {
+		// Suppress group output
+	};
+};
+
+/**
+ * Restore original methods and dump logs if test failed
+ */
+const restoreLogsOnFailure = function () {
+	// Check if current test failed
+	if (this.currentTest && this.currentTest.state === 'failed') {
+		// Dump all captured logs
+		const testName = this.currentTest.title;
+		const testFile = path.relative(projectRoot, this.currentTest.file);
+		console.log(`\n--- Logs from failed test: "${testName}" (${testFile}) ---`);
+		for (const log of logs) {
+			const message = log.args.join(' ');
+			console.log(`[${log.level.toUpperCase()}] ${message}`);
+		}
+		console.log('--- End of logs ---\n');
+	}
+
+	// Clear logs array
+	logs = [];
+};
+
+/**
+ * Restore original core methods
+ */
+const restoreMethods = () => {
+	core.info = originalMethods.info;
+	core.debug = originalMethods.debug;
+	core.warning = originalMethods.warning;
+	core.error = originalMethods.error;
+	core.setSecret = originalMethods.setSecret;
+	core.setOutput = originalMethods.setOutput;
+	core.setFailed = originalMethods.setFailed;
+	core.notice = originalMethods.notice;
+	core.startGroup = originalMethods.startGroup;
+	core.endGroup = originalMethods.endGroup;
+};
+
+module.exports = {
+	setupLogSuppression,
+	restoreLogsOnFailure,
+	restoreMethods,
+};