Files
factorio-clusterio/plugins/global_chat/test/plugin.js
T
Hornwitser 5dcaca4d0b Migrate to ECMAScript Modules
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.
2026-09-11 22:43:57 +02:00

88 lines
3.2 KiB
JavaScript

import assert from "node:assert/strict";
import * as mock from "../../../test/mock.js";
import * as lines from "../../../test/lib/factorio/lines.js";
import * as instance from "../dist/node/instance.js";
import { plugin as info } from "../dist/node/index.js";
import { ChatEvent } from "../dist/node/messages.js";
describe("global_chat plugin", function() {
describe("removeTags()", function() {
it("should pass through an ordinary string", function() {
assert.equal(instance._removeTags("string"), "string");
});
it("should strip out gps tag", function() {
assert.equal(instance._removeTags("Look at [gps=12,-4,nauvis]"), "Look at ");
});
it("should strip out special item tag", function() {
assert.equal(instance._removeTags("Blueprint [special-item=0eNqV...]"), "Blueprint ");
});
it("should strip out train tag", function() {
assert.equal(instance._removeTags("Train [train=1235]"), "Train ");
});
it("should strip out train stop tag", function() {
assert.equal(instance._removeTags("Stop [train-stop=42]"), "Stop ");
});
it("should preserve portable rich text tags", function() {
assert.equal(
instance._removeTags("[gps=12,-4][img=item.iron-plate] [item=iron-plate]"),
"[img=item.iron-plate] [item=iron-plate]",
);
});
});
describe("class InstancePlugin", function() {
let instancePlugin;
before(async function() {
instancePlugin = new instance.InstancePlugin(info, new mock.MockInstance(), new mock.MockHost());
await instancePlugin.init();
});
describe(".handleChatEvent()", function() {
it("should send received chat as command", async function() {
instancePlugin.instance.server.rconCommands = [];
await instancePlugin.handleChatEvent(new ChatEvent("test", "User: message"));
assert.deepEqual(
instancePlugin.instance.server.rconCommands,
["/sc game.print('[test] User: message')"],
);
});
it("should filter server-specific tags from received chat", async function() {
instancePlugin.instance.server.rconCommands = [];
await instancePlugin.handleChatEvent(new ChatEvent("test", "Train [train=1235]"));
assert.deepEqual(
instancePlugin.instance.server.rconCommands,
["/sc game.print('[test] Train ')"],
);
});
});
describe(".onOutput()", function() {
it("should forward chat", async function() {
let count = 0;
for (let [_, output] of lines.testLines) {
if (output.type === "action" && output.action === "CHAT") {
instancePlugin.instance.connector.sentMessages = [];
await instancePlugin.onOutput(output);
assert(instancePlugin.instance.connector.sentMessages.length, "message was not sent");
count += 1;
}
}
assert(count > 0, "no lines were tested");
});
it("should ignore regular output", async function() {
let count = 0;
for (let [_, output] of lines.testLines) {
if (output.type !== "action" || output.action !== "CHAT") {
instancePlugin.instance.connector.sentMessages = [];
await instancePlugin.onOutput(output);
assert(!instancePlugin.instance.connector.sentMessages.length, "message was sent");
count += 1;
}
}
assert(count > 0, "no lines were tested");
});
});
});
});