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

+57
View File
@@ -971,6 +971,63 @@ describe("Integration of Clusterio", function() {
});
});
describe("instance base inheritance", function() {
after(async function() {
for (const id of [4402, 4401, 4400]) {
await getControl().send(new lib.InstanceDeleteRequest(id)).catch(() => {});
}
});
it("creates a base and an instance inheriting from it", async function() {
await execCtl("instance create inheritBase --id 4400 --is-base");
await execCtl("instance config set inheritBase factorio.version 2.0");
await execCtl("instance create inheritChild --id 4401 --base inheritBase");
const config = await getControl().send(new lib.InstanceConfigGetRequest(4401));
assert.equal(config["instance.base_id"], 4400);
assert.equal(config["factorio.version"], "2.0");
assert.equal(config["instance.inherited_fields"]["factorio.version"], true);
assert.equal((await getInstances()).get(4400).isBase, true);
});
it("propagates base changes", async function() {
await execCtl("instance config set inheritBase factorio.version 2.1");
const config = await getControl().send(new lib.InstanceConfigGetRequest(4401));
assert.equal(config["factorio.version"], "2.1");
});
it("rejects inheriting from an instance that is not a base", async function() {
await assert.rejects(
execCtl("instance create inheritBad --id 4402 --base inheritChild"),
new lib.ValidationError("Instance inheritChild is not a base"),
);
});
it("rejects assigning a base to a host", async function() {
await assert.rejects(
execCtl("instance assign inheritBase 4"),
new lib.ValidationError("Base instances cannot be assigned to a host"),
);
});
describe("instance list --bases", function() {
it("runs", async function() {
await execCtl("instance list --bases");
});
});
describe("instance config list", function() {
it("runs on an inheriting instance", async function() {
await execCtl("instance config list inheritChild");
});
});
describe("instance config inherit", function() {
it("runs", async function() {
await execCtl("instance config set inheritChild factorio.version 2.0");
let config = await getControl().send(new lib.InstanceConfigGetRequest(4401));
assert.equal(config["instance.inherited_fields"]["factorio.version"], undefined);
await execCtl("instance config inherit inheritChild factorio.version");
config = await getControl().send(new lib.InstanceConfigGetRequest(4401));
assert.equal(config["factorio.version"], "2.1");
assert.equal(config["instance.inherited_fields"]["factorio.version"], true);
});
});
});
describe("instance assign", function() {
it("creates the instance files", async function() {
await execCtl(`instance assign test ${hostId}`);
+2 -1
View File
@@ -41,7 +41,8 @@ function connectInstance(controller, host, instanceId) {
instanceConfig.set("instance.id", instanceId);
instanceConfig.set("instance.assigned_host", host.config.get("host.id"));
host.assignedInstances.set(instanceId, { path: "invalid", config: instanceConfig });
controller.instances.records.set(new InstanceRecord(instanceConfig, "stopped"));
const controllerConfig = new lib.InstanceConfig("controller", instanceConfig.toRemote("controller"));
controller.instances.records.set(new InstanceRecord(controllerConfig, "stopped"));
const instance = new Instance(host, instanceSide, "invalid", instanceConfig, new MockServer());
const instanceConnection = new InstanceConnection(hostSide, host, instance);
host.instanceConnections.set(instanceId, instanceConnection);