add support for test mode detection in modulename.js via index.html

sdetweil · sdetweil · commit ee33350a37db · 2024-11-11T09:04:09.000-06:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ _This release is scheduled to be released on 2025-01-01._
 - [linter] re-added `eslint-plugin-import`now that it supports ESLint v9 (#3586)
 - [docs] Added step for npm publishing in release process (#3595)
 - [core] Add GitHub workflow to run spellcheck a few days before each release.
+- [core] Add intest flag to index.html to pass to module js for test mode detection (needed by #3630)
 
 ### Removed
 
diff --git a/index.html b/index.html
@@ -18,6 +18,7 @@
 
     <script type="text/javascript">
       window.mmVersion = "#VERSION#";
+      window.intest = "#TESTMODE#";
     </script>
   </head>
   <body>
diff --git a/js/app.js b/js/app.js
@@ -13,6 +13,7 @@ const { getEnvVarsAsObj } = require(`${__dirname}/server_functions`);
 
 // Get version number.
 global.version = require(`${__dirname}/../package.json`).version;
+global.intest = process.env.intest ? true : false;
 Log.log(`Starting MagicMirror: v${global.version}`);
 
 // Log system information.
diff --git a/js/server_functions.js b/js/server_functions.js
@@ -109,6 +109,7 @@ function geExpectedReceivedHeaders (url) {
 function getHtml (req, res) {
 	let html = fs.readFileSync(path.resolve(`${global.root_path}/index.html`), { encoding: "utf8" });
 	html = html.replace("#VERSION#", global.version);
+	html = html.replace("#TESTMODE#", global.intest);
 
 	let configFile = "config/config.js";
 	if (typeof global.configuration_file !== "undefined") {
diff --git a/tests/e2e/helpers/global-setup.js b/tests/e2e/helpers/global-setup.js
@@ -26,6 +26,7 @@ exports.startApplication = async (configFilename, exec) => {
 	} else {
 		process.env.MM_CONFIG_FILE = configFilename;
 	}
+	process.env.intest = true;
 	if (exec) exec;
 	global.app = require("../../../js/app");
 
diff --git a/tests/electron/helpers/global-setup.js b/tests/electron/helpers/global-setup.js
@@ -11,6 +11,7 @@ exports.startApplication = async (configFilename, systemDate = null, electronPar
 	if (systemDate) {
 		process.env.MOCK_DATE = systemDate;
 	}
+	process.env.intest = true;
 
 	global.electronApp = await electron.launch({ args: electronParams });
 
@@ -39,6 +40,7 @@ exports.stopApplication = async () => {
 	global.electronApp = null;
 	global.page = null;
 	process.env.MOCK_DATE = undefined;
+	process.env.jstest = undefined;
 };
 
 exports.getElement = async (selector) => {

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,7 @@ exports.startApplication = async (configFilename, exec) => {`
`26`	`26`	`} else {`
`27`	`27`	`process.env.MM_CONFIG_FILE = configFilename;`
`28`	`28`	`}`
	`29`	`+ process.env.intest = true;`
`29`	`30`	`if (exec) exec;`
`30`	`31`	`global.app = require("../../../js/app");`
`31`	`32`