mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-11 23:04:52 +09:00
Hornwitser
5dcaca4d0b
Migrate the usage of CommonJS specific code and imports to ESM. Roughly summarised this: - Changes all require() calls to import statement or expressions. - Changes usage of module.exports to export statements. - Replaces require.resolve with import.meta.resolve. - Replaces conditional imports with conditional subpath imports. - Replaces module === require.main with import.meta.main. - Adds the full filename with extention to all relative imports. - Changes all usage of __dirname and __filename to their import.meta equivalents. - Sets "type": "module" in package.json files. - Removes usage of "use strict". - Adds .ts an an alias of .js for the webpack build. Due to differences in how require and import resolves files the plugin entrypoints will have to include the filename and extension after this migration in order to work.
243 lines
8.9 KiB
JavaScript
243 lines
8.9 KiB
JavaScript
import assert from "node:assert/strict";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
|
|
import * as lib from "@clusterio/lib";
|
|
import Host, { _discoverInstances } from "@clusterio/host/dist/node/src/Host.js";
|
|
import Instance from "@clusterio/host/dist/node/src/Instance.js";
|
|
import { HostConnector } from "@clusterio/host/dist/node/host.js";
|
|
|
|
describe("Host testing", function() {
|
|
describe("discoverInstances()", function() {
|
|
it("should discover test instance", async function() {
|
|
const instancePath = path.join("test", "file", "instances");
|
|
const instances = await _discoverInstances(instancePath);
|
|
|
|
const configPath = path.join(instancePath, "test", "instance.json");
|
|
const referenceConfig = new lib.InstanceConfig("host", {
|
|
...Host.instanceConfigWarning,
|
|
"instance.id": 1,
|
|
"instance.name": "test",
|
|
}, configPath);
|
|
|
|
assert.deepEqual(instances, new Map([
|
|
[1, {
|
|
config: referenceConfig,
|
|
path: path.join(instancePath, "test"),
|
|
}],
|
|
]));
|
|
});
|
|
});
|
|
|
|
describe("class Host", function() {
|
|
describe(".handleSyncUserListsEvent()", function() {
|
|
const hostAddress = lib.Address.fromShorthand({ hostId: 1 });
|
|
const instanceAddress = lib.Address.fromShorthand({ instanceId: 1 });
|
|
let mockHost, hostConnector, instanceConnector;
|
|
before(function() {
|
|
[hostConnector, instanceConnector] = lib.VirtualConnector.makePair(hostAddress, instanceAddress);
|
|
instanceConnector.on("message", function(message) {
|
|
Instance.prototype._validateMessage(message);
|
|
});
|
|
});
|
|
beforeEach(function() {
|
|
mockHost = {
|
|
adminlist: new Set(),
|
|
whitelist: new Set(),
|
|
banlist: new Map(),
|
|
broadcasts: [],
|
|
broadcastEventToInstance(event) {
|
|
this.broadcasts.push(event);
|
|
hostConnector.sendEvent(event, instanceAddress);
|
|
},
|
|
handleSyncUserListsEvent: Host.prototype.handleSyncUserListsEvent,
|
|
syncLists(adminlist, banlist, whitelist) {
|
|
return this.handleSyncUserListsEvent(
|
|
new lib.SyncUserListsEvent(adminlist, banlist, whitelist)
|
|
);
|
|
},
|
|
};
|
|
});
|
|
|
|
it("should broadcast new entries to adminlist", async function() {
|
|
await mockHost.syncLists(["admin1"], [], []);
|
|
await mockHost.syncLists(["admin1", "admin2"], [], []);
|
|
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceAdminlistUpdateEvent("admin1", true),
|
|
new lib.InstanceAdminlistUpdateEvent("admin2", true),
|
|
]);
|
|
});
|
|
|
|
it("should broadcast removals from adminlist", async function() {
|
|
mockHost.adminlist.add("admin1").add("admin2");
|
|
await mockHost.syncLists(["admin1"], [], []);
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceAdminlistUpdateEvent("admin2", false),
|
|
]);
|
|
});
|
|
|
|
it("should broadcast new entries to whitelist", async function() {
|
|
await mockHost.syncLists([], [], ["player1"]);
|
|
await mockHost.syncLists([], [], ["player1", "player2"]);
|
|
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceWhitelistUpdateEvent("player1", true),
|
|
new lib.InstanceWhitelistUpdateEvent("player2", true),
|
|
]);
|
|
});
|
|
|
|
it("should broadcast removals from whitelist", async function() {
|
|
mockHost.whitelist.add("player1").add("player2");
|
|
await mockHost.syncLists([], [], ["player1"]);
|
|
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceWhitelistUpdateEvent("player2", false),
|
|
]);
|
|
});
|
|
|
|
it("should broadcast new entries to banlist", async function() {
|
|
await mockHost.syncLists([], [["badie1", "greifing"]], []);
|
|
await mockHost.syncLists([], [["badie1", "greifing"], ["badie2", "annoying"]], []);
|
|
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceBanlistUpdateEvent("badie1", true, "greifing"),
|
|
new lib.InstanceBanlistUpdateEvent("badie2", true, "annoying"),
|
|
]);
|
|
});
|
|
|
|
it("should broadcast removals to banlist", async function() {
|
|
mockHost.banlist.set("badie1", "greifing").set("badie2", "annoying");
|
|
await mockHost.syncLists([], [["badie1", "greifing"]], []);
|
|
|
|
assert.deepEqual(mockHost.broadcasts, [
|
|
new lib.InstanceBanlistUpdateEvent("badie2", false, ""),
|
|
]);
|
|
});
|
|
});
|
|
describe(".checkRestartRequired()", async function() {
|
|
let host;
|
|
const hostVersion = (
|
|
await import("@clusterio/host/package.json", { with: { type: "json" }})
|
|
).default.version;
|
|
before(function() {
|
|
lib.addPluginConfigFields([{ name: "restart_test", hostEntrypoint: "host.js" }]);
|
|
});
|
|
beforeEach(function() {
|
|
// This can be used more generally, but i did not want to interfere with handleSyncUserListsEvent
|
|
const pluginInfos = [{
|
|
name: "restart_test",
|
|
packagePath: fileURLToPath(import.meta.resolve("@clusterio/host/package.json")),
|
|
version: hostVersion,
|
|
}];
|
|
const hostConfig = new lib.HostConfig("host", { "host.version": hostVersion });
|
|
const hostConnector = new HostConnector(hostConfig, pluginInfos);
|
|
host = new Host(hostConnector, hostConfig, pluginInfos);
|
|
});
|
|
it("returns false when no changes are present", async function() {
|
|
host.pluginInfos[0].hostEntrypoint = true;
|
|
host.pluginInfos[0].instanceEntrypoint = true;
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, false);
|
|
assert.equal(host.config.restartRequired, false);
|
|
});
|
|
it("returns false when an unloaded plugin version changes", async function() {
|
|
host.pluginInfos[0].version = "0.0.0";
|
|
host.pluginInfos[0].hostEntrypoint = true;
|
|
host.pluginInfos[0].instanceEntrypoint = true;
|
|
host.config.set("restart_test.load_plugin", false);
|
|
host.config.restartRequired = false; // Setting load_plugin requires a restart
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, false);
|
|
assert.equal(host.config.restartRequired, false);
|
|
});
|
|
it("returns true when the config flag is set", async function() {
|
|
host.config.restartRequired = true;
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, true);
|
|
assert.equal(host.config.restartRequired, true);
|
|
});
|
|
it("returns true when clusterio version changes", async function() {
|
|
host.config.set("host.version", "0.0.0");
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, true);
|
|
assert.equal(host.config.restartRequired, true);
|
|
});
|
|
it("returns true when a host plugin version changes", async function() {
|
|
host.pluginInfos[0].version = "0.0.0";
|
|
host.pluginInfos[0].hostEntrypoint = true;
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, true);
|
|
assert.equal(host.config.restartRequired, true);
|
|
});
|
|
it("returns true when an instance plugin version changes", async function() {
|
|
host.pluginInfos[0].version = "0.0.0";
|
|
host.pluginInfos[0].instanceEntrypoint = true;
|
|
const result = await host.checkRestartRequired();
|
|
assert.equal(result, true);
|
|
assert.equal(host.config.restartRequired, true);
|
|
});
|
|
});
|
|
describe(".checkRestartDowngrade()", async function() {
|
|
let host;
|
|
const hostVersion = (
|
|
await import("@clusterio/host/package.json", { with: { type: "json" }})
|
|
).default.version;
|
|
beforeEach(function() {
|
|
const hostConfig = new lib.HostConfig("host", { "host.version": hostVersion });
|
|
const hostConnector = new HostConnector(hostConfig, []);
|
|
host = new Host(hostConnector, hostConfig, []);
|
|
});
|
|
it("returns null when the installed version matches", async function() {
|
|
assert.equal(await host.checkRestartDowngrade(), null);
|
|
});
|
|
it("returns null when the installed version is newer", async function() {
|
|
host.config.set("host.version", "0.0.0");
|
|
assert.equal(await host.checkRestartDowngrade(), null);
|
|
});
|
|
it("returns both versions when the installed version is older", async function() {
|
|
host.config.set("host.version", "999.0.0");
|
|
assert.deepEqual(await host.checkRestartDowngrade(), {
|
|
installedVersion: hostVersion,
|
|
runningVersion: "999.0.0",
|
|
});
|
|
});
|
|
});
|
|
describe(".handleHostRestartRequest()", function() {
|
|
let mockHost;
|
|
beforeEach(function() {
|
|
process.exitCode = undefined;
|
|
mockHost = {
|
|
canRestart: true,
|
|
shutdownCalled: false,
|
|
async checkRestartDowngrade() { return null; },
|
|
shutdown() { this.shutdownCalled = true; },
|
|
handleHostRestartRequest: Host.prototype.handleHostRestartRequest,
|
|
};
|
|
});
|
|
afterEach(function() {
|
|
process.exitCode = undefined;
|
|
});
|
|
|
|
it("restarts when the installed version is not older", async function() {
|
|
await mockHost.handleHostRestartRequest();
|
|
assert.equal(process.exitCode, 1);
|
|
assert.equal(mockHost.shutdownCalled, true);
|
|
});
|
|
it("rejects a downgrade without shutting down the host", async function() {
|
|
mockHost.checkRestartDowngrade = async () => ({
|
|
installedVersion: "1.0.0",
|
|
runningVersion: "2.0.0",
|
|
});
|
|
|
|
await assert.rejects(
|
|
() => mockHost.handleHostRestartRequest(),
|
|
/Stop the host before starting the older version manually/
|
|
);
|
|
assert.equal(process.exitCode, undefined);
|
|
assert.equal(mockHost.shutdownCalled, false);
|
|
});
|
|
});
|
|
});
|
|
});
|