factorio-test-cli 1.0.5 → 2.0.0

package/cli.js

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 import { program } from "commander";
 import "./run.js";
-program
+await program
     .name("factorio-test")
     .description("cli for factorio testing")
-    .addHelpCommand()
+    .helpCommand(true)
     .showHelpAfterError()
     .showSuggestionAfterError()
-    .parse();
+    .parseAsync();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-test-cli",
-  "version": "1.0.5",
+  "version": "2.0.0",
   "description": "A CLI to run FactorioTest.",
   "license": "MIT",
   "repository": "https://github.com/GlassBricks/FactorioTest",
@@ -15,14 +15,14 @@
     "*.js"
   ],
   "dependencies": {
-    "chalk": "^5.2.0",
-    "commander": "^10.0.1",
-    "factoriomod-debug": "^1.1.28"
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "factoriomod-debug": "^2.0.3"
   },
   "devDependencies": {
-    "@commander-js/extra-typings": "^10.0.3",
-    "del-cli": "^5.0.0",
-    "typescript": "^5.0.4"
+    "@commander-js/extra-typings": "^12.1.0",
+    "del-cli": "^6.0.0",
+    "typescript": "^5.7.2"
   },
   "scripts": {
     "build": "npm run clean && tsc",

package/run.js

@@ -3,20 +3,24 @@ import * as os from "os";
 import * as fsp from "fs/promises";
 import * as fs from "fs";
 import * as path from "path";
-import { spawn } from "child_process";
+import { spawn, spawnSync } from "child_process";
 import BufferLineSplitter from "./buffer-line-splitter.js";
 import chalk from "chalk";
+import * as process from "node:process";
 const thisCommand = program
     .command("run")
     .summary("Runs tests with Factorio test.")
     .description("Runs tests for the specified mod with Factorio test. Exits with code 0 only if all tests pass.\n")
-    .argument("[mod-path]", "The path to the mod to test (containing info.json). A symlink will be created in the mods folder to this folder. Alternatively, you can specify --mod-name for manual setup.")
-    .option("--mod-name <name>", "The name of the mod to test. If specified, the mod must already be present in the mods directory (sse --data-directory below). One of [mod-path] or --mod-name must be specified.")
-    .option("--factorio-path <path>", "The path to the factorio binary. If not specified, tries to auto-detect the factorio installation.")
-    .option("-d --data-directory <path>", 'The path to the data directory. The "config.ini" file and the "mods" folder will be in this directory.', "./factorio-test-data")
-    .option("--show-output", "Prints test output to stdout.", true)
-    .option("-v --verbose", "Enables more logging, and prints all outputs of the Factorio process to stdout (not just test output).")
-    .addHelpText("after", 'Options passed after "--" are passed as Factorio launch arguments.')
+    .argument("[mod-path]", "The path to the mod (folder containing info.json). A symlink will be created in the mods folder to this folder. Either this or --mod-name must be specified.")
+    .option("--mod-name <name>", "The name of the mod to test. To use this option, the mod must already be present in the mods directory (see --data-directory). Either this or [mod-path] must be specified.")
+    .option("--factorio-path <path>", "The path to the factorio binary. If not specified, attempts to auto-detect the path.")
+    .option("-d --data-directory <path>", 'The path to the factorio data directory that the testing instance will use. The "config.ini" file and the "mods" folder will be in this directory.', "./factorio-test-data-dir")
+    .option("--mods <mods...>", 'Adjust mods. By default, only the mod to test and "factorio-test" are enabled, and all others are disabled! ' +
+    'Same format as "fmtk mods adjust". Example: "--mods mod1 mod2=1.2.3" will enable mod1 any version, and mod2 version 1.2.3.')
+    .option("--show-output", "Print test output to stdout.", true)
+    .option("-v --verbose", "Enables more logging, and pipes the Factorio process output to stdout.")
+    .addHelpText("after", 'Arguments after "--" are passed to the Factorio process.')
+    .addHelpText("after", 'Suggested factorio arguments: "--cache-sprite-atlas", "--disable-audio"')
     .action((modPath, options) => runTests(modPath, options));
 async function runTests(modPath, options) {
     if (modPath !== undefined && options.modName !== undefined) {
@@ -31,9 +35,14 @@ async function runTests(modPath, options) {
     await fsp.mkdir(modsDir, { recursive: true });
     const modToTest = await configureModToTest(modsDir, modPath, options.modName);
     await installFactorioTest(modsDir);
+    const enableModsOptions = [
+        "factorio-test=true",
+        `${modToTest}=true`,
+        ...(options.mods?.map((m) => (m.includes("=") ? m : `${m}=true`)) ?? []),
+    ];
     if (options.verbose)
-        console.log("Enabling mods", modToTest, "and factorio-test");
-    await runScript("fmtk mods adjust", "--modsPath", modsDir, "factorio-test=true", modToTest + "=true");
+        console.log("Adjusting mods");
+    await runScript("fmtk mods adjust", "--modsPath", modsDir, "--disableExtra", ...enableModsOptions);
     await ensureConfigIni(dataDir);
     await setSettingsForAutorun(factorioPath, dataDir, modsDir, modToTest);
     let resultMessage;
@@ -131,6 +140,14 @@ write-data=${dataDir}
 locale=
 `);
     }
+    else {
+        // edit "^write-data=.*" to be dataDir
+        const content = await fsp.readFile(filePath, "utf8");
+        const newContent = content.replace(/^write-data=.*$/m, `write-data=${dataDir}`);
+        if (content !== newContent) {
+            await fsp.writeFile(filePath, newContent);
+        }
+    }
 }
 async function setSettingsForAutorun(factorioPath, dataDir, modsDir, modToTest) {
     // touch modsDir/mod-settings.dat
@@ -157,6 +174,7 @@ async function runFactorioTests(factorioPath, dataDir) {
     const actualArgs = [
         "--load-scenario",
         "factorio-test/Test",
+        "--disable-migration-window",
         "--mod-directory",
         path.join(dataDir, "mods"),
         "-c",
@@ -201,12 +219,12 @@ async function runFactorioTests(factorioPath, dataDir) {
         }
     });
     await new Promise((resolve, reject) => {
-        factorioProcess.on("exit", (code) => {
-            if (code === 0 || resultMessage !== undefined) {
+        factorioProcess.on("exit", (code, signal) => {
+            if (code === 0 && resultMessage !== undefined) {
                 resolve();
             }
             else {
-                reject(new Error(`Factorio exited with code ${code}`));
+                reject(new Error(`Factorio exited with code ${code}, signal ${signal}`));
             }
         });
     });
@@ -235,12 +253,18 @@ function runProcess(inheritStdio, command, ...args) {
         });
     });
 }
+function factorioIsInPath() {
+    const result = spawnSync("factorio", ["--version"], { stdio: "ignore" });
+    return result.status === 0;
+}
 function autoDetectFactorioPath() {
+    if (factorioIsInPath()) {
+        return "factorio";
+    }
     let pathsToTry;
     // check if is linux
     if (os.platform() === "linux" || os.platform() === "darwin") {
         pathsToTry = [
-            "factorio",
             "~/.local/share/Steam/steamapps/common/Factorio/bin/x64/factorio",
             "~/Library/Application Support/Steam/steamapps/common/Factorio/factorio.app/Contents/MacOS/factorio",
             "~/.factorio/bin/x64/factorio",