Add base instances for instance config inheritance

Instances can be marked as a base with instance.is_base and other
instances inherit config values from it through instance.base_id.
The controller copies base values into inheriting configs and keeps
track of inherited fields in the hidden instance.inherited_fields, so
hosts receive resolved configs and need no changes. Setting a field
stops inheriting it, `instance config inherit` undoes that.

Bases cannot be assigned to a host, are hidden from `instance list`
unless --bases is given, and cannot be deleted or unmarked while
other instances inherit from them. Chains of bases are allowed and
cycles are rejected.

Part of #200

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
bbassieandClaude Opus 5.5 committed 2026-11-02 11:54:21 +00:00
1 parent 024d7b427a
commit 01cf789f5d
16 files changed
+769 -26

No files matched your search

+42
View File
@@ -4,6 +4,48 @@ import * as lib from "@clusterio/lib";
describe("lib/config/definitions", function() {
describe("InstanceConfig", function() {
describe("isInheritable()", function() {
it("should allow regular fields", function() {
assert.equal(lib.InstanceConfig.isInheritable("factorio.version"), true);
assert.equal(lib.InstanceConfig.isInheritable("instance.auto_start"), true);
});
it("should reject identity, hidden, host only and unknown fields", function() {
for (const name of [
"instance.name", "instance.id", "instance.assigned_host", "instance.is_base",
"instance.base_id", "instance.inherited_fields", "factorio.host_assigned_game_port", "no.field",
]) {
assert.equal(lib.InstanceConfig.isInheritable(name), false, name);
}
});
});
describe(".isInherited()", function() {
it("should only report fields as inherited when a base is set", function() {
const config = new lib.InstanceConfig("controller", {
"instance.inherited_fields": { "factorio.version": true },
});
assert.equal(config.isInherited("factorio.version"), false);
config.set("instance.base_id", 1);
assert.equal(config.isInherited("factorio.version"), true);
assert.equal(config.isInherited("factorio.game_port"), false);
});
});
it("should not send inheritance fields to the host", function() {
const config = new lib.InstanceConfig("controller", { "instance.base_id": 1 });
const remote = config.toRemote("host");
for (const name of ["instance.is_base", "instance.base_id", "instance.inherited_fields"]) {
assert(!Object.hasOwn(remote, name), name);
}
});
it("should not let control write inherited_fields", function() {
const config = new lib.InstanceConfig("controller");
assert.throws(
() => config.set("instance.inherited_fields", { "factorio.version": true }, "control"),
new lib.InvalidAccessError("Field 'instance.inherited_fields' is not accessible from control"),
);
});
});
describe("addPluginConfigFields()", function() {
after(function() {
delete lib.CtlConfig.fieldDefinitions["ctl_test.field"];