Prefix clusterio/lib imports with lib

Use lib* prefix for the modules impored from the lib package to help
distinguish them more from ordinary variables.  Fix up the naming
convention for files to be consistently lowercase_underscore for
JavaScript files.
This commit is contained in:
Hornwitser committed 2020-10-23 21:22:43 +02:00
1 parent fbbaf3dd3a
commit 24397b75cc
55 files changed
+692 -668

No files matched your search

+10 -10
View File
@@ -3,13 +3,13 @@ const assert = require("assert").strict;
const fs = require("fs-extra");
const path = require("path");
const link = require("@clusterio/lib/link");
const libLink = require("@clusterio/lib/link");
const { slowTest, get, execCtl, sendRcon, getControl, instancesDir } = require("./index");
async function getInstances() {
let result = await link.messages.listInstances.send(getControl());
let result = await libLink.messages.listInstances.send(getControl());
return new Map(result.list.map(instance => [instance.id, instance]));
}
@@ -170,14 +170,14 @@ describe("Integration of Clusterio", function() {
describe("user set-admin/whitelisted/banned", function() {
async function getUsers() {
let result = await link.messages.listUsers.send(getControl());
let result = await libLink.messages.listUsers.send(getControl());
return new Map(result.list.map(user => [user.name, user]));
}
let lists = ["admin", "whitelisted", "banned"];
it("should add and remove the given user to the list", async function() {
slowTest(this);
await link.messages.createUser.send(getControl(), { name: "list_test" });
await libLink.messages.createUser.send(getControl(), { name: "list_test" });
let user = (await getUsers()).get("list_test");
for (let list of lists) {
assert.equal(user[`is_${list}`], false, `unexpected ${list} status`);
@@ -248,7 +248,7 @@ describe("Integration of Clusterio", function() {
it("should create the given role", async function() {
let args = "--description \"A temp role\" --permissions core.control.connect";
await execCtl(`role create temp ${args}`);
let result = await link.messages.listRoles.send(getControl());
let result = await libLink.messages.listRoles.send(getControl());
let role = result.list.find(role => role.name === "temp");
assert.deepEqual(role, { id: 5, name: "temp", description: "A temp role", permissions: ["core.control.connect"] });
});
@@ -258,7 +258,7 @@ describe("Integration of Clusterio", function() {
it("should modify the given role", async function() {
let args = "--name new --description \"A new role\" --permissions";
await execCtl(`role edit temp ${args}`);
let result = await link.messages.listRoles.send(getControl());
let result = await libLink.messages.listRoles.send(getControl());
let role = result.list.find(role => role.name === "new");
assert.deepEqual(role, { id: 5, name: "new", description: "A new role", permissions: [] });
});
@@ -267,7 +267,7 @@ describe("Integration of Clusterio", function() {
describe("role delete", function() {
it("should modify the given role", async function() {
await execCtl("role delete new");
let result = await link.messages.listRoles.send(getControl());
let result = await libLink.messages.listRoles.send(getControl());
let role = result.list.find(role => role.name === "new");
assert(!role, "Role was not deleted");
});
@@ -282,7 +282,7 @@ describe("Integration of Clusterio", function() {
describe("user create", function() {
it("should create the given user", async function() {
await execCtl("user create temp");
let result = await link.messages.listUsers.send(getControl());
let result = await libLink.messages.listUsers.send(getControl());
let user = result.list.find(user => user.name === "temp");
assert(user, "user was not created");
});
@@ -291,7 +291,7 @@ describe("Integration of Clusterio", function() {
describe("user set-roles", function() {
it("should set the roles on the user", async function() {
await execCtl("user set-roles temp Admin");
let result = await link.messages.listUsers.send(getControl());
let result = await libLink.messages.listUsers.send(getControl());
let user = result.list.find(user => user.name === "temp");
assert.deepEqual(user.roles, [0]);
});
@@ -300,7 +300,7 @@ describe("Integration of Clusterio", function() {
describe("user delete", function() {
it("should delete the user", async function() {
await execCtl("user delete temp");
let result = await link.messages.listUsers.send(getControl());
let result = await libLink.messages.listUsers.send(getControl());
let user = result.list.find(user => user.name === "temp");
assert(!user, "user was note deleted");
});
+3 -3
View File
@@ -2,17 +2,17 @@
const assert = require("assert").strict;
const path = require("path");
const factorio = require("@clusterio/lib/factorio");
const libFactorio = require("@clusterio/lib/factorio");
describe("Integration of lib/factorio/export", function() {
describe("exportLocale()", function() {
it("returns a nested Map with base game locale information", async function() {
let writePath = path.join("temp", "test", "server");
let testServer = new factorio.FactorioServer("factorio", writePath, {});
let testServer = new libFactorio.FactorioServer("factorio", writePath, {});
await testServer.init();
let locale = await factorio._exportLocale(testServer, new Map(), ["base"], "en");
let locale = await libFactorio._exportLocale(testServer, new Map(), ["base"], "en");
assert(locale instanceof Map, "locale is not a map");
assert.equal(locale.get("entity-name.fish"), "Fish");
+5 -5
View File
@@ -7,14 +7,14 @@ const phin = require("phin");
const util = require("util");
const events = require("events");
const link = require("@clusterio/lib/link");
const libLink = require("@clusterio/lib/link");
const server = require("@clusterio/lib/factorio/server");
class TestControl extends link.Link {
class TestControl extends libLink.Link {
constructor(connector) {
super("control", "master", connector);
link.attachAllMessages(this);
libLink.attachAllMessages(this);
}
async prepareDisconnectRequestHandler(message, request) {
@@ -27,7 +27,7 @@ class TestControl extends link.Link {
async instanceOutputEventHandler() { }
}
class TestControlConnector extends link.WebSocketClientConnector {
class TestControlConnector extends libLink.WebSocketClientConnector {
register() {
this.sendHandshake("register_control", { token: this.token, agent: "clusterioctl", version: "test" });
}
@@ -81,7 +81,7 @@ async function execCtl(...args) {
}
async function sendRcon(instanceId, command) {
let response = await link.messages.sendRcon.send(control, { instance_id: instanceId, command });
let response = await libLink.messages.sendRcon.send(control, { instance_id: instanceId, command });
return response.result;
}
+3 -3
View File
@@ -4,7 +4,7 @@ const fs = require("fs-extra");
const jszip = require("jszip");
const path = require("path");
const factorio = require("@clusterio/lib/factorio");
const libFactorio = require("@clusterio/lib/factorio");
const { slowTest } = require("./index");
@@ -17,7 +17,7 @@ describe("Integration of lib/factorio/patch", function() {
let savePath = path.join("temp", "test", "integration", "saves", "test.zip");
it("should patch a freeplay game", async function() {
slowTest(this);
await factorio.patch(savePath, [{
await libFactorio.patch(savePath, [{
name: "test",
version: "1.0.0",
dependencies: {},
@@ -39,7 +39,7 @@ describe("Integration of lib/factorio/patch", function() {
});
it("should remove old modules in a save", async function() {
slowTest(this);
await factorio.patch(savePath, []);
await libFactorio.patch(savePath, []);
let zip = await jszip.loadAsync(await fs.readFile(savePath));
assert.equal(zip.file("test/modules/test/test.lua"), null);
});
+8 -6
View File
@@ -4,8 +4,8 @@ const events = require("events");
const fs = require("fs-extra");
const path = require("path");
const factorio = require("@clusterio/lib/factorio");
const errors = require("@clusterio/lib/errors");
const libFactorio = require("@clusterio/lib/factorio");
const libErrors = require("@clusterio/lib/errors");
const { slowTest } = require("./index");
@@ -13,7 +13,7 @@ const { slowTest } = require("./index");
describe("Integration of lib/factorio/server", function() {
describe("_getVersion()", function() {
it("should get a version from factorio's changelog.txt", async function() {
let version = await factorio._getVersion(path.join("factorio", "data", "changelog.txt"));
let version = await libFactorio._getVersion(path.join("factorio", "data", "changelog.txt"));
if (!/^\d+\.\d+\.\d+$/.test(version)) {
assert.fail(`Detected version '${version}' does not followed the format x.y.z`);
}
@@ -22,7 +22,7 @@ describe("Integration of lib/factorio/server", function() {
describe("class FactorioServer", function() {
let writePath = path.join("temp", "test", "integration");
let server = new factorio.FactorioServer("factorio", writePath, {});
let server = new libFactorio.FactorioServer("factorio", writePath, {});
let logFile;
before(async function() {
@@ -215,7 +215,9 @@ describe("Integration of lib/factorio/server", function() {
await assert.rejects(
startPromise,
new errors.EnvironmentError("Factorio server was unexpectedly killed, is the system low on memory?")
new libErrors.EnvironmentError(
"Factorio server was unexpectedly killed, is the system low on memory?"
)
);
});
@@ -225,7 +227,7 @@ describe("Integration of lib/factorio/server", function() {
await assert.rejects(
server.start("does-not-exist.zip"),
new errors.EnvironmentError("Factorio server unexpectedly shut down with code 1")
new libErrors.EnvironmentError("Factorio server unexpectedly shut down with code 1")
);
});
});