mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-18 07:33:12 +09:00
Require config files to be explicitly created (#1040)
The behaviour of creating the config file if it's missing while convenient causes confusion and problems when the tools are run in the wrong folder. They end up creating a shadow installation and misdirect the user with nonsensical error messages, instead pointing to the real problem which is that the tool can't find the configuration needed to actually run. Require a config file to be present at startup and refuse to run if this file is missing. To support the odd use-case of creating the config when missing a --create-config flag is added. To conveniently generate a config file to edit out from the "config create" command is added.
This commit is contained in:
1 parent
5df5af7ca8
commit
2c52c265cf
15 files changed
+249
-75
No files matched your search
Vendored
+97
@@ -0,0 +1,97 @@
|
||||
import assert from "node:assert/strict";
|
||||
import fs from "node:fs/promises";
|
||||
import path from "node:path";
|
||||
|
||||
import * as lib from "@clusterio/lib";
|
||||
|
||||
describe("lib/bootstrap", function() {
|
||||
describe("loadConfigFromArgs()", function() {
|
||||
const folder = path.join("temp", "test", "bootstrap");
|
||||
const configPath = path.join(folder, "sample-config.json");
|
||||
const noentPath = path.join(folder, "noent-config.json");
|
||||
const createPath1 = path.join(folder, "create-config-1.json");
|
||||
const createPath2 = path.join(folder, "create-config-2.json");
|
||||
before(async function() {
|
||||
await fs.mkdir(folder, { recursive: true });
|
||||
await fs.writeFile(
|
||||
configPath,
|
||||
JSON.stringify({
|
||||
"ctl.controller_url": "http://example/foo",
|
||||
}),
|
||||
{ encoding: "utf8" },
|
||||
);
|
||||
await fs.unlink(noentPath).catch(() => {});
|
||||
await fs.unlink(createPath1).catch(() => {});
|
||||
await fs.unlink(createPath2).catch(() => {});
|
||||
});
|
||||
it("should load an existing config", async function() {
|
||||
const [config] = await lib.loadConfigFromArgs(
|
||||
{
|
||||
config: configPath,
|
||||
bypassLockFile: false,
|
||||
createConfig: false,
|
||||
_: ["run"],
|
||||
},
|
||||
lib.CtlConfig,
|
||||
"control",
|
||||
);
|
||||
assert.equal(config.get("ctl.controller_url"), "http://example/foo");
|
||||
});
|
||||
it("should reject if config does not exist", async function() {
|
||||
await assert.rejects(
|
||||
() => lib.loadConfigFromArgs(
|
||||
{
|
||||
config: noentPath,
|
||||
bypassLockFile: false,
|
||||
createConfig: false,
|
||||
_: ["run"],
|
||||
},
|
||||
lib.CtlConfig,
|
||||
"control",
|
||||
),
|
||||
/Error: Failed to load temp.test.bootstrap.noent-config\.json/
|
||||
);
|
||||
});
|
||||
it("should create the config if it does not exist and createConfig is set", async function() {
|
||||
const [config] = await lib.loadConfigFromArgs(
|
||||
{
|
||||
config: createPath1,
|
||||
bypassLockFile: false,
|
||||
createConfig: true,
|
||||
_: ["run"],
|
||||
},
|
||||
lib.CtlConfig,
|
||||
"control",
|
||||
);
|
||||
assert.equal(config.get("ctl.controller_url"), null);
|
||||
await assert.doesNotReject(fs.access(createPath1));
|
||||
});
|
||||
it("should create the config if it does not exist and the command is config create", async function() {
|
||||
const [config] = await lib.loadConfigFromArgs(
|
||||
{
|
||||
config: createPath2,
|
||||
bypassLockFile: false,
|
||||
createConfig: false,
|
||||
_: ["config", "create"],
|
||||
},
|
||||
lib.CtlConfig,
|
||||
"control",
|
||||
);
|
||||
assert.equal(config.get("ctl.controller_url"), null);
|
||||
await assert.doesNotReject(fs.access(createPath2));
|
||||
});
|
||||
it("should use the existing config if it does not exist and createConfig is set", async function() {
|
||||
const [config] = await lib.loadConfigFromArgs(
|
||||
{
|
||||
config: configPath,
|
||||
bypassLockFile: false,
|
||||
createConfig: true,
|
||||
_: ["run"],
|
||||
},
|
||||
lib.CtlConfig,
|
||||
"control",
|
||||
);
|
||||
assert.equal(config.get("ctl.controller_url"), "http://example/foo");
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user