factorio-test-cli 3.4.0 → 3.5.1

package/config/cli-config.js

@@ -131,6 +131,7 @@ export function registerAllCliOptions(command) {
     command.option("-c --config <path>", "Path to config file (default: factorio-test.json, or 'factorio-test' key in package.json)");
     command.option("-g --graphics", "Launch Factorio with graphics (interactive mode) instead of headless");
     command.option("-w --watch", "Watch for file changes and rerun tests");
+    command.option("--no-auto-start", "Configure tests but do not auto-start them (requires --graphics)");
     addOption(command, f.modPath.cli);
     addOption(command, f.modName.cli);
     addOption(command, f.factorioPath.cli);

package/config/loader.js

@@ -58,6 +58,7 @@ export function resolveConfig({ cliOptions, patterns }) {
     return {
         graphics: cliOptions.graphics,
         watch: cliOptions.watch,
+        noAutoStart: cliOptions.autoStart === false ? true : undefined,
         modPath: baseConfig.modPath,
         modName: baseConfig.modName,
         factorioPath: baseConfig.factorioPath,

package/config/test-config.js

@@ -49,7 +49,7 @@ const testConfigFields = {
         schema: z.boolean().optional(),
         cli: {
             flags: "--reorder-failed-first",
-            description: "Run previously failed tests first (default: enabled).",
+            description: "Run previously failed tests first (default: disabled).",
             negatable: true,
         },
     },

package/mod-setup.js

@@ -154,17 +154,20 @@ locale=
         }
     }
 }
-export async function setSettingsForAutorun(factorioPath, dataDir, modsDir, modToTest, mode, options) {
+export async function ensureModSettingsDat(factorioPath, dataDir, modsDir, verbose) {
     const settingsDat = path.join(modsDir, "mod-settings.dat");
-    if (!fs.existsSync(settingsDat)) {
-        if (options?.verbose)
-            console.log("Creating mod-settings.dat file by running factorio");
-        const dummySaveFile = path.join(dataDir, "____dummy_save_file.zip");
-        await runProcess(false, factorioPath, "--create", dummySaveFile, "--mod-directory", modsDir, "-c", path.join(dataDir, "config.ini"));
-        if (fs.existsSync(dummySaveFile)) {
-            await fsp.rm(dummySaveFile);
-        }
+    if (fs.existsSync(settingsDat))
+        return;
+    if (verbose)
+        console.log("Creating mod-settings.dat file by running factorio");
+    const dummySaveFile = path.join(dataDir, "____dummy_save_file.zip");
+    await runProcess(false, factorioPath, "--create", dummySaveFile, "--mod-directory", modsDir, "-c", path.join(dataDir, "config.ini"));
+    if (fs.existsSync(dummySaveFile)) {
+        await fsp.rm(dummySaveFile);
     }
+}
+export async function setSettingsForAutorun(factorioPath, dataDir, modsDir, modToTest, mode, options) {
+    await ensureModSettingsDat(factorioPath, dataDir, modsDir, options?.verbose);
     if (options?.verbose)
         console.log("Setting autorun settings");
     const autoStartConfig = JSON.stringify({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-test-cli",
-  "version": "3.4.0",
+  "version": "3.5.1",
   "description": "A CLI to run FactorioTest.",
   "license": "MIT",
   "repository": {

package/run.js

@@ -5,10 +5,9 @@ import * as fsp from "fs/promises";
 import * as path from "path";
 import { CliError } from "./cli-error.js";
 import { registerAllCliOptions, resolveConfig } from "./config/index.js";
-import { autoDetectFactorioPath } from "./factorio-process.js";
-import { getHeadlessSavePath, runFactorioTestsGraphics, runFactorioTestsHeadless, } from "./factorio-process.js";
+import { autoDetectFactorioPath, getHeadlessSavePath, runFactorioTestsGraphics, runFactorioTestsHeadless, } from "./factorio-process.js";
 import { watchDirectory, watchFile } from "./file-watcher.js";
-import { configureModToTest, ensureConfigIni, installFactorioTest, installModDependencies, installMods, parseModRequirement, resetAutorunSettings, resolveModWatchTarget, setSettingsForAutorun, } from "./mod-setup.js";
+import { configureModToTest, ensureConfigIni, ensureModSettingsDat, installFactorioTest, installModDependencies, installMods, parseModRequirement, resetAutorunSettings, resolveModWatchTarget, setSettingsForAutorun, } from "./mod-setup.js";
 import { runScript, setVerbose } from "./process-utils.js";
 import { OutputFormatter } from "./test-output.js";
 import { readPreviousFailedTests, writeResultsFile } from "./test-results.js";
@@ -16,17 +15,27 @@ 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.
-
 One of --mod-path or --mod-name is required.
-Test execution options (--test-pattern, --tag-*, --bail, etc.) override in-mod config.
 
-When using variadic options (--mods, --factorio-args, etc.) with filter patterns,
-use -- to separate them:
-  factorio-test run -p ./my-mod --mods quality space-age -- "inventory"
+JSON configuration:
+  Instead of using command-line arguments, you can configure the test runner using a JSON file.
+  By default, the CLI will look for a factorio-test.json file or a "factorio-test" key in
+  package.json. You can specify a custom file using the --config option.
+  CLI arguments override file config.
+  Test execution options (options that can also be specified in the mod itself) go under the
+  "test" key using snake_case, overriding in-mod config.
+    {
+      "modPath": "./my-mod",
+      "test": { "bail": 1, "game_speed": 100, "tag_blacklist": ["slow"] }
+    }
 
-Patterns use Lua pattern syntax (not regex). Special characters like - must be
-escaped with %:
-  factorio-test run -p ./my-mod "my%-test"  Match "my-test" (escape the dash)
+Test filter patterns:
+  Filter patterns use Lua pattern syntax (not regex). Special characters like -
+  must be escaped with %:
+    factorio-test run -p ./my-mod "foo > my%-test"
+  When using variadic options (--mods, --factorio-args, etc.) with filter
+  patterns, use -- to separate them:
+    factorio-test run -p ./my-mod --mods quality space-age -- "inventory"
 
 Examples:
   factorio-test run -p ./my-mod             Run all tests
@@ -47,6 +56,9 @@ async function setupTestRun(patterns, cliOptions) {
     if (config.modPath === undefined && config.modName === undefined) {
         throw new CliError("One of --mod-path or --mod-name must be specified.");
     }
+    if (config.noAutoStart && !config.graphics) {
+        throw new CliError("--no-auto-start requires --graphics.");
+    }
     const factorioPath = config.factorioPath ?? autoDetectFactorioPath();
     const dataDir = config.dataDirectory;
     const modsDir = path.join(dataDir, "mods");
@@ -82,7 +94,7 @@ async function setupTestRun(patterns, cliOptions) {
 async function executeTestRun(ctx, execOptions) {
     const { config, factorioPath, dataDir, modsDir, modToTest, mode, savePath, factorioArgs } = ctx;
     const { signal, skipResetAutorun, resolveOnResult } = execOptions ?? {};
-    const reorderEnabled = config.testConfig.reorder_failed_first ?? true;
+    const reorderEnabled = config.testConfig.reorder_failed_first ?? false;
     const lastFailedTests = reorderEnabled && config.outputFile ? await readPreviousFailedTests(config.outputFile) : [];
     await setSettingsForAutorun(factorioPath, dataDir, modsDir, modToTest, mode, {
         verbose: config.verbose,
@@ -191,9 +203,24 @@ async function runHeadlessWatchMode(ctx) {
     });
     return new Promise(() => { });
 }
+async function launchWithoutAutoStart(ctx) {
+    const { config, factorioPath, dataDir, modsDir, modToTest, savePath, factorioArgs } = ctx;
+    await ensureModSettingsDat(factorioPath, dataDir, modsDir, config.verbose);
+    await runScript("fmtk", "settings", "set", "runtime-global", "factorio-test-mod-to-test", modToTest, "--modsPath", modsDir);
+    if (Object.keys(config.testConfig).length > 0) {
+        await runScript("fmtk", "settings", "set", "runtime-global", "factorio-test-config", JSON.stringify(config.testConfig), "--modsPath", modsDir);
+    }
+    await runFactorioTestsGraphics(factorioPath, dataDir, savePath, factorioArgs, {
+        verbose: config.verbose,
+        quiet: config.quiet,
+    });
+}
 async function runTests(patterns, cliOptions) {
     const ctx = await setupTestRun(patterns, cliOptions);
-    if (ctx.config.watch && ctx.config.graphics) {
+    if (ctx.config.noAutoStart) {
+        await launchWithoutAutoStart(ctx);
+    }
+    else if (ctx.config.watch && ctx.config.graphics) {
         await runGraphicsWatchMode(ctx);
     }
     else if (ctx.config.watch) {