mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-20 07:43:12 +09:00
Better handling of mod dependencies (#801)
* Add ModDependency and version types * Add warnings for mod dependencies * Add warning for wrong factorio version * Add fix issues button * Add automatic dependency resolution and download * Add abilty to check for updates * Add extra test coverage * One extra test * Fix copy paste error
This commit is contained in:
1 parent
73cc019d2f
commit
d52931a326
29 files changed
+2763
-403
No files matched your search
+245
-2
@@ -5,10 +5,226 @@ const path = require("path");
|
||||
|
||||
const lib = require("@clusterio/lib");
|
||||
const libBuildMod = require("@clusterio/lib/build_mod");
|
||||
const { ModInfo } = lib;
|
||||
const { ModInfo, ModDependency } = lib;
|
||||
|
||||
const { testMatrix, testRoundTripJsonSerialisable } = require("../../common");
|
||||
|
||||
describe("lib/data/ModInfo", function() {
|
||||
describe("class ModDependency", function() {
|
||||
describe(".getTypeFromPrefix()", function() {
|
||||
it("should not throw for valid prefixes", function() {
|
||||
assert.equal(ModDependency.getTypeFromPrefix("!"), "incompatible");
|
||||
assert.equal(ModDependency.getTypeFromPrefix("?"), "optional");
|
||||
assert.equal(ModDependency.getTypeFromPrefix("(?)"), "hidden");
|
||||
assert.equal(ModDependency.getTypeFromPrefix("~"), "unordered");
|
||||
assert.equal(ModDependency.getTypeFromPrefix(""), "required");
|
||||
});
|
||||
it("should throw for unknown prefixes", function() {
|
||||
assert.throws(() => ModDependency.getTypeFromPrefix("invalid"));
|
||||
});
|
||||
});
|
||||
describe("constructor", function() {
|
||||
it("should accept specifications of name only", function() {
|
||||
const dependency = new ModDependency("my-mod");
|
||||
assert.equal(dependency.name, "my-mod");
|
||||
assert.equal(dependency.type, "required");
|
||||
assert.equal(dependency.version, undefined);
|
||||
});
|
||||
it("should accept specifications of name and prefix", function() {
|
||||
const dependency = new ModDependency("? my-mod");
|
||||
assert.equal(dependency.name, "my-mod");
|
||||
assert.equal(dependency.type, "optional");
|
||||
assert.equal(dependency.version, undefined);
|
||||
});
|
||||
it("should accept specifications of name and version", function() {
|
||||
const dependency = new ModDependency("my-mod >= 1.2.3");
|
||||
assert.equal(dependency.name, "my-mod");
|
||||
assert.equal(dependency.type, "required");
|
||||
assert.notEqual(dependency.version, undefined);
|
||||
assert.equal(dependency.version.equality, ">=");
|
||||
assert.equal(dependency.version.integerVersion, lib.integerFullVersion("1.2.3"));
|
||||
});
|
||||
it("should accept specifications of name, prefix and version", function() {
|
||||
const dependency = new ModDependency("? my-mod >= 1.2.3");
|
||||
assert.equal(dependency.name, "my-mod");
|
||||
assert.equal(dependency.type, "optional");
|
||||
assert.notEqual(dependency.version, undefined);
|
||||
assert.equal(dependency.version.equality, ">=");
|
||||
assert.equal(dependency.version.integerVersion, lib.integerFullVersion("1.2.3"));
|
||||
});
|
||||
it("should throw if no version equality is given", function() {
|
||||
assert.throws(() => new ModDependency("my-mod 1.2.3"));
|
||||
assert.throws(() => new ModDependency("? my-mod 1.2.3"));
|
||||
});
|
||||
it("should throw if invalid specification given", function() {
|
||||
assert.throws(() => new ModDependency("? ? my-mod = 1.2.3"));
|
||||
});
|
||||
it("should throw if name contains spaces", function() {
|
||||
// Apparently there are some legacy mods which include spaces
|
||||
// Such as https://mods.factorio.com/mod/Explosive%20Excavation
|
||||
this.skip();
|
||||
assert.throws(() => new ModDependency("my mod"));
|
||||
assert.throws(() => new ModDependency("? my mod"));
|
||||
assert.throws(() => new ModDependency("? my mod >= 1.2.3"));
|
||||
});
|
||||
it("should not error when the name contains spaces", function() {
|
||||
const dependencyReq = new ModDependency("my mod");
|
||||
assert.equal(dependencyReq.name, "my mod");
|
||||
assert.equal(dependencyReq.type, "required");
|
||||
|
||||
const dependencyOpt = new ModDependency("? my mod");
|
||||
assert.equal(dependencyOpt.name, "my mod");
|
||||
assert.equal(dependencyOpt.type, "optional");
|
||||
|
||||
const dependencyVer = new ModDependency("my mod >= 1.2.3");
|
||||
assert.equal(dependencyVer.name, "my mod");
|
||||
assert.equal(dependencyVer.type, "required");
|
||||
assert.equal(dependencyVer.version.version, "1.2.3");
|
||||
|
||||
const dependencyOptVer = new ModDependency("? my mod >= 1.2.3");
|
||||
assert.equal(dependencyOptVer.name, "my mod");
|
||||
assert.equal(dependencyOptVer.type, "optional");
|
||||
assert.equal(dependencyOptVer.version.version, "1.2.3");
|
||||
});
|
||||
it("should be round trip json serialisable", function() {
|
||||
testRoundTripJsonSerialisable(ModDependency, testMatrix(
|
||||
["my-mod", "? my-mod", "! my-mod", "my-mod > 1.0.0", "~ my-mod <= 2.0.0"], // Specification
|
||||
));
|
||||
});
|
||||
});
|
||||
describe("checkUnsatisfiedReason()", function() {
|
||||
const mods = [
|
||||
ModInfo.fromJSON({ name: "my-mod", version: "1.0.0" }),
|
||||
];
|
||||
it("should be undefined for incompatible being missing", function() {
|
||||
const dependency = new ModDependency("! not-present");
|
||||
assert.equal(dependency.checkUnsatisfiedReason(mods), undefined);
|
||||
});
|
||||
it("should give reason for incompatible being present", function() {
|
||||
const dependency = new ModDependency("! my-mod");
|
||||
assert.equal(dependency.checkUnsatisfiedReason(mods), "incompatible");
|
||||
});
|
||||
it("should undefined for optional / hidden being missing", function() {
|
||||
const dependencyOptional = new ModDependency("? not-present");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), undefined);
|
||||
const dependencyHidden = new ModDependency("(?) not-present");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), undefined);
|
||||
});
|
||||
it("should undefined for optional / hidden being present", function() {
|
||||
const dependencyOptional = new ModDependency("? my-mod");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), undefined);
|
||||
const dependencyHidden = new ModDependency("(?) my-mod");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), undefined);
|
||||
});
|
||||
it("should give reason for optional / hidden being present but wrong version", function() {
|
||||
const dependencyOptional = new ModDependency("? my-mod > 2.0.0");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), "wrong_version");
|
||||
const dependencyHidden = new ModDependency("(?) my-mod > 2.0.0");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), "wrong_version");
|
||||
});
|
||||
it("should undefined for unordered / required being present", function() {
|
||||
const dependencyOptional = new ModDependency("~ my-mod");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), undefined);
|
||||
const dependencyHidden = new ModDependency("my-mod");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), undefined);
|
||||
});
|
||||
it("should give reason for unordered / required being present but wrong version", function() {
|
||||
const dependencyOptional = new ModDependency("~ my-mod > 2.0.0");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), "wrong_version");
|
||||
const dependencyHidden = new ModDependency("my-mod > 2.0.0");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), "wrong_version");
|
||||
});
|
||||
it("should give reason for unordered / required being missing", function() {
|
||||
const dependencyOptional = new ModDependency("~ not-present");
|
||||
assert.equal(dependencyOptional.checkUnsatisfiedReason(mods), "missing_dependency");
|
||||
const dependencyHidden = new ModDependency("not-present");
|
||||
assert.equal(dependencyHidden.checkUnsatisfiedReason(mods), "missing_dependency");
|
||||
});
|
||||
});
|
||||
describe("isSatisfied()", function() {
|
||||
const mods = [
|
||||
ModInfo.fromJSON({ name: "my-mod", version: "1.0.0" }),
|
||||
];
|
||||
it("should pass for incompatible being missing", function() {
|
||||
const dependency = new ModDependency("! not-present");
|
||||
assert.equal(dependency.isSatisfied(mods), true);
|
||||
});
|
||||
it("should fail for incompatible being present", function() {
|
||||
const dependency = new ModDependency("! my-mod");
|
||||
assert.equal(dependency.isSatisfied(mods), false);
|
||||
});
|
||||
it("should pass for optional / hidden being missing", function() {
|
||||
const dependencyOptional = new ModDependency("? not-present");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), true);
|
||||
const dependencyHidden = new ModDependency("(?) not-present");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), true);
|
||||
});
|
||||
it("should pass for optional / hidden being present", function() {
|
||||
const dependencyOptional = new ModDependency("? my-mod");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), true);
|
||||
const dependencyHidden = new ModDependency("(?) my-mod");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), true);
|
||||
});
|
||||
it("should fail for optional / hidden being present but wrong version", function() {
|
||||
const dependencyOptional = new ModDependency("? my-mod > 2.0.0");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), false);
|
||||
const dependencyHidden = new ModDependency("(?) my-mod > 2.0.0");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), false);
|
||||
});
|
||||
it("should pass for unordered / required being present", function() {
|
||||
const dependencyOptional = new ModDependency("~ my-mod");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), true);
|
||||
const dependencyHidden = new ModDependency("my-mod");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), true);
|
||||
});
|
||||
it("should fail for unordered / required being present but wrong version", function() {
|
||||
const dependencyOptional = new ModDependency("~ my-mod > 2.0.0");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), false);
|
||||
const dependencyHidden = new ModDependency("my-mod > 2.0.0");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), false);
|
||||
});
|
||||
it("should fail for unordered / required being missing", function() {
|
||||
const dependencyOptional = new ModDependency("~ not-present");
|
||||
assert.equal(dependencyOptional.isSatisfied(mods), false);
|
||||
const dependencyHidden = new ModDependency("not-present");
|
||||
assert.equal(dependencyHidden.isSatisfied(mods), false);
|
||||
});
|
||||
});
|
||||
describe("incompatible", function() {
|
||||
it("should return true iff the type is incompatible", function() {
|
||||
const dependencyIncompatible = new ModDependency("! my-mod");
|
||||
assert.equal(dependencyIncompatible.incompatible, true);
|
||||
for (const test of ["my-mod", "? my-mod", "(?) my-mod", "~ my-mod"]) {
|
||||
const dependency = new ModDependency(test);
|
||||
assert.equal(dependency.incompatible, false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("required", function() {
|
||||
it("should return true iff the dependency is required", function() {
|
||||
for (const test of ["my-mod", "~ my-mod"]) {
|
||||
const dependency = new ModDependency(test);
|
||||
assert.equal(dependency.required, true, test);
|
||||
}
|
||||
for (const test of ["! my-mod", "? my-mod", "(?) my-mod"]) {
|
||||
const dependency = new ModDependency(test);
|
||||
assert.equal(dependency.required, false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("optional", function() {
|
||||
it("should return true iff the dependency is optional", function() {
|
||||
for (const test of ["? my-mod", "(?) my-mod"]) {
|
||||
const dependency = new ModDependency(test);
|
||||
assert.equal(dependency.optional, true, test);
|
||||
}
|
||||
for (const test of ["! my-mod", "my-mod", "~ my-mod"]) {
|
||||
const dependency = new ModDependency(test);
|
||||
assert.equal(dependency.optional, false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
describe("class ModInfo", function() {
|
||||
it("should round trip serialize", function() {
|
||||
const validate = lib.compile(ModInfo.jsonSchema);
|
||||
@@ -70,7 +286,16 @@ describe("lib/data/ModInfo", function() {
|
||||
factorioMods.sort((a, b) => a.integerFactorioVersion - b.integerFactorioVersion);
|
||||
assert.deepEqual(factorioMods.map(mod => mod.factorioVersion), sortedVersions);
|
||||
});
|
||||
|
||||
it("should provide the original string specifications for dependencies", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["UltraMod", "SuperLib >= 1.00", "! bad-mod"] });
|
||||
assert.deepEqual(mod.dependencySpecifications, ["UltraMod", "SuperLib >= 1.00", "! bad-mod"]);
|
||||
});
|
||||
it("should parse the provided dependency specifications", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["UltraMod", "SuperLib >= 1.00", "! bad-mod"] });
|
||||
assert.deepEqual(mod.dependencies,
|
||||
["UltraMod", "SuperLib >= 1.00", "! bad-mod"].map(dep => new ModDependency(dep))
|
||||
);
|
||||
});
|
||||
it("should load from a mod zip file", async function() {
|
||||
await libBuildMod.build({
|
||||
build: true,
|
||||
@@ -100,5 +325,23 @@ describe("lib/data/ModInfo", function() {
|
||||
})
|
||||
);
|
||||
});
|
||||
describe("checkDependencySatisfaction()", function() {
|
||||
it("should return undefined when satisfied", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["! a", "b = 1.0.0", "? c = 2.0.0"] });
|
||||
assert.equal(mod.checkDependencySatisfaction([{ name: "b", version: "1.0.0" }]), undefined);
|
||||
});
|
||||
it("should return incompatible when there is an incompatibility", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["! a", "b = 1.0.0", "? c = 2.0.0"] });
|
||||
assert.equal(mod.checkDependencySatisfaction([{ name: "a", version: "1.0.0" }]), "incompatible");
|
||||
});
|
||||
it("should return missing dependency when missing but no incompatibly", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["! a", "b = 1.0.0", "? c = 2.0.0"] });
|
||||
assert.equal(mod.checkDependencySatisfaction([{ name: "c", version: "1.0.0" }]), "missing_dependency");
|
||||
});
|
||||
it("should return wrong version when wrong but not missing or incompatible", function() {
|
||||
const mod = ModInfo.fromJSON({ dependencies: ["! a", "b = 1.0.0", "? c = 2.0.0"] });
|
||||
assert.equal(mod.checkDependencySatisfaction([{ name: "b", version: "2.0.0" }]), "wrong_version");
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
@@ -397,16 +397,16 @@ describe("lib/data/ModPack", function() {
|
||||
it("should work with versions before 2.0", function() {
|
||||
const builtinMods = ModPack.getBuiltinMods("1.1");
|
||||
assert.deepEqual(builtinMods, [
|
||||
{ name: "base", enabled: true, version: "1.1" },
|
||||
{ name: "base", enabled: true, version: "1.1.0" },
|
||||
]);
|
||||
});
|
||||
it("should work with versions after 2.0", function() {
|
||||
const builtinMods = ModPack.getBuiltinMods("2.0");
|
||||
assert.deepEqual(builtinMods, [
|
||||
{ name: "base", enabled: true, version: "2.0" },
|
||||
{ name: "elevated-rails", enabled: false, version: "2.0" },
|
||||
{ name: "quality", enabled: false, version: "2.0" },
|
||||
{ name: "space-age", enabled: false, version: "2.0" },
|
||||
{ name: "base", enabled: true, version: "2.0.0" },
|
||||
{ name: "elevated-rails", enabled: false, version: "2.0.0" },
|
||||
{ name: "quality", enabled: false, version: "2.0.0" },
|
||||
{ name: "space-age", enabled: false, version: "2.0.0" },
|
||||
]);
|
||||
});
|
||||
});
|
||||
|
||||
@@ -0,0 +1,515 @@
|
||||
"use strict";
|
||||
const assert = require("assert").strict;
|
||||
const lib = require("@clusterio/lib");
|
||||
|
||||
const { testMatrix, testRoundTripJsonSerialisable } = require("../../common");
|
||||
|
||||
describe("lib/data/version", function() {
|
||||
describe("isVersionEquality()", function() {
|
||||
it("should correctly validate input strings", function() {
|
||||
const valid = ["<", "<=", "=", ">=", ">"];
|
||||
for (const test of valid) {
|
||||
assert.equal(lib.isVersionEquality(test), true, test);
|
||||
}
|
||||
const invalid = ["==", "!=", "<>", ""];
|
||||
for (const test of invalid) {
|
||||
assert.equal(lib.isVersionEquality(test), false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("isApiVersion()", function() {
|
||||
it("should correctly validate input strings", function() {
|
||||
const valid = ["0.13", "0.14", "0.15", "0.16", "0.17", "0.18", "1.0", "1.1", "2.0"];
|
||||
for (const test of valid) {
|
||||
assert.equal(lib.isApiVersion(test), true, test);
|
||||
}
|
||||
const invalid = ["0.12", "0.19", "1.2", "2.1", "1.0.0", "1.0.0.0", "0", "", "latest"];
|
||||
for (const test of invalid) {
|
||||
assert.equal(lib.isApiVersion(test), false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("normaliseApiVersion()", function() {
|
||||
it("should normalise accepted versions", function() {
|
||||
assert.equal(lib.normaliseApiVersion("0.13"), "0.13");
|
||||
assert.equal(lib.normaliseApiVersion("0.13.0"), "0.13");
|
||||
assert.equal(lib.normaliseApiVersion("0.13.1"), "0.13");
|
||||
assert.equal(lib.normaliseApiVersion("1.1"), "1.1");
|
||||
assert.equal(lib.normaliseApiVersion("1.1.0"), "1.1");
|
||||
assert.equal(lib.normaliseApiVersion("1.1.1"), "1.1");
|
||||
assert.equal(lib.normaliseApiVersion("2.0"), "2.0");
|
||||
assert.equal(lib.normaliseApiVersion("2.0.0"), "2.0");
|
||||
assert.equal(lib.normaliseApiVersion("2.0.1"), "2.0");
|
||||
assert.equal(lib.normaliseApiVersion("1.0.0.0"), "1.0");
|
||||
});
|
||||
it("should throw for invalid versions", function() {
|
||||
const invalid = ["0.12", "0", "", "latest"];
|
||||
for (const test of invalid) {
|
||||
assert.throws(() => lib.normaliseApiVersion(test), undefined, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("isFullVersion()", function() {
|
||||
it("should correctly validate input strings", function() {
|
||||
const valid = ["0.12.0", "0.13.1", "0.17.99", "00.000.0001", "1.1.110"];
|
||||
for (const test of valid) {
|
||||
assert.equal(lib.isFullVersion(test), true, test);
|
||||
}
|
||||
const invalid = ["0.12", "0.19", "1.0", "1.0.0.0", "0", "", "latest"];
|
||||
for (const test of invalid) {
|
||||
assert.equal(lib.isFullVersion(test), false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("integerFullVersion()", function() {
|
||||
it("should sort versions lexicographically", function() {
|
||||
let unsortedVersions = ["1.0.0", "1.1.0", "0.1.0", "3.0.0", "1.2.0", "0.3.1", "0.3.3", "2.1.1", "0.0.1"];
|
||||
let sortedVersions = ["0.0.1", "0.1.0", "0.3.1", "0.3.3", "1.0.0", "1.1.0", "1.2.0", "2.1.1", "3.0.0"];
|
||||
unsortedVersions.sort((a, b) => lib.integerFullVersion(a) - lib.integerFullVersion(b));
|
||||
assert.deepEqual(unsortedVersions, sortedVersions);
|
||||
});
|
||||
});
|
||||
describe("normaliseFullVersion()", function() {
|
||||
it("should normalise accepted versions", function() {
|
||||
assert.equal(lib.normaliseFullVersion("0.13"), "0.13.0");
|
||||
assert.equal(lib.normaliseFullVersion("0.13.0"), "0.13.0");
|
||||
assert.equal(lib.normaliseFullVersion("0.13.1"), "0.13.1");
|
||||
assert.equal(lib.normaliseFullVersion("1.1"), "1.1.0");
|
||||
assert.equal(lib.normaliseFullVersion("1.1.0"), "1.1.0");
|
||||
assert.equal(lib.normaliseFullVersion("1.1.1"), "1.1.1");
|
||||
assert.equal(lib.normaliseFullVersion("2.0"), "2.0.0");
|
||||
assert.equal(lib.normaliseFullVersion("2.0.0"), "2.0.0");
|
||||
assert.equal(lib.normaliseFullVersion("2.0.1"), "2.0.1");
|
||||
});
|
||||
});
|
||||
describe("isPartialVersion()", function() {
|
||||
it("should correctly validate input strings", function() {
|
||||
const valid = [
|
||||
"0.13", "0.14", "0.15", "0.16", "0.17", "0.18", "1.0", "1.1", "2.0",
|
||||
"0.12.0", "0.13.1", "0.17.99", "00.000.0001", "1.1.110",
|
||||
];
|
||||
for (const test of valid) {
|
||||
assert.equal(lib.isPartialVersion(test), true, test);
|
||||
}
|
||||
const invalid = ["1.0.0.0", "0", "", "latest"];
|
||||
for (const test of invalid) {
|
||||
assert.equal(lib.isPartialVersion(test), false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("integerPartialVersion()", function() {
|
||||
it("should sort versions lexicographically", function() {
|
||||
let unsortedVersions = ["1.0", "1.1", "0.1", "3.0", "1.2", "0.3", "2.1"];
|
||||
let sortedVersions = ["0.1", "0.3", "1.0", "1.1", "1.2", "2.1", "3.0"];
|
||||
unsortedVersions.sort((a, b) => lib.integerPartialVersion(a) - lib.integerPartialVersion(b));
|
||||
assert.deepEqual(unsortedVersions, sortedVersions);
|
||||
});
|
||||
});
|
||||
describe("isTargetVersion()", function() {
|
||||
it("should correctly validate input strings", function() {
|
||||
const valid = [
|
||||
"0.13", "0.14", "0.15", "0.16", "0.17", "0.18", "1.0", "1.1", "2.0",
|
||||
"0.12.0", "0.13.1", "0.17.99", "00.000.0001", "1.1.110", "latest",
|
||||
];
|
||||
for (const test of valid) {
|
||||
assert.equal(lib.isTargetVersion(test), true, test);
|
||||
}
|
||||
const invalid = ["1.0.0.0", "0", ""];
|
||||
for (const test of invalid) {
|
||||
assert.equal(lib.isTargetVersion(test), false, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("class ModVersionEquality", function() {
|
||||
const tests = testMatrix(
|
||||
["<", "<=", "=", ">=", ">"],
|
||||
["0.18", "1.0", "1.0.0", "1.1.1"],
|
||||
);
|
||||
describe("constructor", function() {
|
||||
it("should be round trip json serialisable", function() {
|
||||
testRoundTripJsonSerialisable(lib.ModVersionEquality, tests);
|
||||
});
|
||||
it("should be constructible", function() {
|
||||
for (const [eq, ver] of tests) {
|
||||
const test = `${eq} ${ver}`;
|
||||
const version = new lib.ModVersionEquality(eq, ver);
|
||||
assert.equal(version.equality, eq, test);
|
||||
assert.equal(version.version, ver, test);
|
||||
assert.equal(version.integerVersion, lib.integerPartialVersion(ver), test);
|
||||
}
|
||||
});
|
||||
it("should throw when given an invalid equality", function() {
|
||||
assert.throws(() => new lib.ModVersionEquality("==", "1.0.0"));
|
||||
});
|
||||
it("should throw when given an invalid version", function() {
|
||||
assert.throws(() => new lib.ModVersionEquality("=", "1.0.0.0"));
|
||||
});
|
||||
});
|
||||
describe("testIntegerVersion()", function() {
|
||||
it("should test for less than", function() {
|
||||
const version = new lib.ModVersionEquality("<", "0.0.100");
|
||||
assert.equal(version.testIntegerVersion(90), true);
|
||||
assert.equal(version.testIntegerVersion(100), false);
|
||||
assert.equal(version.testIntegerVersion(110), false);
|
||||
});
|
||||
it("should test for less than equal", function() {
|
||||
const version = new lib.ModVersionEquality("<=", "0.0.100");
|
||||
assert.equal(version.testIntegerVersion(90), true);
|
||||
assert.equal(version.testIntegerVersion(100), true);
|
||||
assert.equal(version.testIntegerVersion(110), false);
|
||||
});
|
||||
it("should test for equal", function() {
|
||||
const version = new lib.ModVersionEquality("=", "0.0.100");
|
||||
assert.equal(version.testIntegerVersion(90), false);
|
||||
assert.equal(version.testIntegerVersion(100), true);
|
||||
assert.equal(version.testIntegerVersion(110), false);
|
||||
});
|
||||
it("should test for greater than equal", function() {
|
||||
const version = new lib.ModVersionEquality(">=", "0.0.100");
|
||||
assert.equal(version.testIntegerVersion(90), false);
|
||||
assert.equal(version.testIntegerVersion(100), true);
|
||||
assert.equal(version.testIntegerVersion(110), true);
|
||||
});
|
||||
it("should test for greater than", function() {
|
||||
const version = new lib.ModVersionEquality(">", "0.0.100");
|
||||
assert.equal(version.testIntegerVersion(90), false);
|
||||
assert.equal(version.testIntegerVersion(100), false);
|
||||
assert.equal(version.testIntegerVersion(110), true);
|
||||
});
|
||||
it("should throw if the equality is invalid (unreachable)", function() {
|
||||
const version = new lib.ModVersionEquality(">", "0.0.100");
|
||||
version.equality = "==";
|
||||
assert.throws(() => version.testIntegerVersion(100));
|
||||
});
|
||||
});
|
||||
describe("testVersion()", function() {
|
||||
it("should test for less than", function() {
|
||||
const version = new lib.ModVersionEquality("<", "1.1.1");
|
||||
assert.equal(version.testVersion("1.0"), true);
|
||||
assert.equal(version.testVersion("1.1"), true);
|
||||
assert.equal(version.testVersion("1.1.1"), false);
|
||||
assert.equal(version.testVersion("1.1.2"), false);
|
||||
assert.equal(version.testVersion("1.2"), false);
|
||||
});
|
||||
it("should test for less than equal", function() {
|
||||
const version = new lib.ModVersionEquality("<=", "1.1.1");
|
||||
assert.equal(version.testVersion("1.0"), true);
|
||||
assert.equal(version.testVersion("1.1"), true);
|
||||
assert.equal(version.testVersion("1.1.1"), true);
|
||||
assert.equal(version.testVersion("1.1.2"), false);
|
||||
assert.equal(version.testVersion("1.2"), false);
|
||||
});
|
||||
it("should test for equal", function() {
|
||||
const version = new lib.ModVersionEquality("=", "1.1.1");
|
||||
assert.equal(version.testVersion("1.0"), false);
|
||||
assert.equal(version.testVersion("1.1"), false);
|
||||
assert.equal(version.testVersion("1.1.1"), true);
|
||||
assert.equal(version.testVersion("1.1.2"), false);
|
||||
assert.equal(version.testVersion("1.2"), false);
|
||||
});
|
||||
it("should test for greater than equal", function() {
|
||||
const version = new lib.ModVersionEquality(">=", "1.1.1");
|
||||
assert.equal(version.testVersion("1.0"), false);
|
||||
assert.equal(version.testVersion("1.1"), false);
|
||||
assert.equal(version.testVersion("1.1.1"), true);
|
||||
assert.equal(version.testVersion("1.1.2"), true);
|
||||
assert.equal(version.testVersion("1.2"), true);
|
||||
});
|
||||
it("should test for greater than", function() {
|
||||
const version = new lib.ModVersionEquality(">", "1.1.1");
|
||||
assert.equal(version.testVersion("1.0"), false);
|
||||
assert.equal(version.testVersion("1.1"), false);
|
||||
assert.equal(version.testVersion("1.1.1"), false);
|
||||
assert.equal(version.testVersion("1.1.2"), true);
|
||||
assert.equal(version.testVersion("1.2"), true);
|
||||
});
|
||||
it("should throw if the equality is invalid (unreachable)", function() {
|
||||
const version = new lib.ModVersionEquality(">", "1.1.1");
|
||||
version.equality = "==";
|
||||
assert.throws(() => version.testInteger("1.0.0"));
|
||||
});
|
||||
});
|
||||
describe("toString()", function() {
|
||||
it("should be convertible to string", function() {
|
||||
for (const [eq, ver] of tests) {
|
||||
const expected = `${eq} ${ver}`;
|
||||
const version = new lib.ModVersionEquality(eq, ver);
|
||||
assert.equal(version.toString(), expected);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("fromString()", function() {
|
||||
it("should be constructable from string", function() {
|
||||
for (const [eq, ver] of tests) {
|
||||
const test = `${eq} ${ver}`;
|
||||
const version = lib.ModVersionEquality.fromString(test);
|
||||
assert.equal(version.equality, eq, test);
|
||||
assert.equal(version.version, ver, test);
|
||||
assert.equal(version.integerVersion, lib.integerPartialVersion(ver), test);
|
||||
}
|
||||
});
|
||||
it("should error for invalid equalities", function() {
|
||||
const equalities = ["==", "!=", "<>", ""];
|
||||
for (const eq of equalities) {
|
||||
const test = `${eq} 1.0.0`;
|
||||
assert.throws(() => lib.ModVersionEquality.fromString(test), undefined, test);
|
||||
}
|
||||
});
|
||||
it("should error for invalid versions", function() {
|
||||
const versions = ["1.0.0.0", "0", "", "latest"];
|
||||
for (const ver of versions) {
|
||||
const test = `= ${ver}`;
|
||||
assert.throws(() => lib.ModVersionEquality.fromString(test), undefined, test);
|
||||
}
|
||||
});
|
||||
});
|
||||
describe("fromParts()", function() {
|
||||
it("should be constructable from parts", function() {
|
||||
for (const [eq, ver] of tests) {
|
||||
const test = `${eq} ${ver}`;
|
||||
const version = lib.ModVersionEquality.fromParts(eq, ver);
|
||||
assert.equal(version.equality, eq, test);
|
||||
assert.equal(version.version, ver, test);
|
||||
assert.equal(version.integerVersion, lib.integerPartialVersion(ver), test);
|
||||
}
|
||||
});
|
||||
it("should error for invalid equalities", function() {
|
||||
const equalities = ["==", "!=", "<>", ""];
|
||||
for (const eq of equalities) {
|
||||
assert.throws(() => lib.ModVersionEquality.fromParts(eq, "1.0.0"), undefined, eq);
|
||||
}
|
||||
});
|
||||
it("should error for invalid versions", function() {
|
||||
const versions = ["1.0.0.0", "0", "", "latest"];
|
||||
for (const ver of versions) {
|
||||
assert.throws(() => lib.ModVersionEquality.fromParts("=", ver), undefined, ver);
|
||||
}
|
||||
});
|
||||
});
|
||||
});
|
||||
describe("class ModVersionRange", function() {
|
||||
describe("constructor", function() {
|
||||
it("should be constructable", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
assert.equal(range.minVersion.equality, ">=");
|
||||
assert.equal(range.minVersion.version, "1.0.0");
|
||||
assert.equal(range.maxVersion.equality, "<");
|
||||
assert.equal(range.maxVersion.version, "2.0.0");
|
||||
});
|
||||
it("should be default constructable", function() {
|
||||
const range = new lib.ModVersionRange();
|
||||
assert.equal(range.minVersion.equality, ">=");
|
||||
assert.equal(range.minVersion.version, "0.0.0");
|
||||
assert.equal(range.maxVersion.equality, "<=");
|
||||
assert.equal(range.maxVersion.version, "65535.65535.65535");
|
||||
});
|
||||
it("should throw if invalid equality is given for min version", function() {
|
||||
assert.throws(() => new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality("<", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
));
|
||||
assert.throws(() => new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality("<=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
));
|
||||
});
|
||||
it("should throw if invalid equality is given for max version", function() {
|
||||
assert.throws(() => new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality(">", "2.0.0"),
|
||||
));
|
||||
assert.throws(() => new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality(">=", "2.0.0"),
|
||||
));
|
||||
});
|
||||
});
|
||||
describe("valid", function() {
|
||||
it("should be true for valid ranges", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
assert.equal(range.valid, true);
|
||||
|
||||
const defaultRange = new lib.ModVersionRange();
|
||||
assert.equal(defaultRange.valid, true);
|
||||
});
|
||||
it("should be false for invalid ranges", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "2.0.0"),
|
||||
new lib.ModVersionEquality("<", "1.0.0"),
|
||||
);
|
||||
assert.equal(range.valid, false);
|
||||
|
||||
const rangeImpossible = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality("=", "1.0.0"),
|
||||
new lib.ModVersionEquality("=", "2.0.0"),
|
||||
);
|
||||
assert.equal(rangeImpossible.valid, false);
|
||||
});
|
||||
});
|
||||
describe("invalidate()", function() {
|
||||
it("should result in the range becoming invalid", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
range.invalidate();
|
||||
assert.equal(range.valid, false);
|
||||
|
||||
const defaultRange = new lib.ModVersionRange();
|
||||
defaultRange.invalidate();
|
||||
assert.equal(defaultRange.valid, false);
|
||||
});
|
||||
});
|
||||
describe("testIntegerVersion()", function() {
|
||||
it("should return true when in range", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "0.0.100"),
|
||||
new lib.ModVersionEquality("<", "0.0.200"),
|
||||
);
|
||||
assert.equal(range.testIntegerVersion(100), true);
|
||||
assert.equal(range.testIntegerVersion(199), true);
|
||||
});
|
||||
it("should return false when out of range", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "0.0.100"),
|
||||
new lib.ModVersionEquality("<", "0.0.200"),
|
||||
);
|
||||
assert.equal(range.testIntegerVersion(99), false);
|
||||
assert.equal(range.testIntegerVersion(200), false);
|
||||
});
|
||||
it("should handle exact matches", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality("=", "0.0.100"),
|
||||
new lib.ModVersionEquality("=", "0.0.100"),
|
||||
);
|
||||
assert.equal(range.testIntegerVersion(99), false);
|
||||
assert.equal(range.testIntegerVersion(100), true);
|
||||
assert.equal(range.testIntegerVersion(101), false);
|
||||
});
|
||||
});
|
||||
describe("testVersion()", function() {
|
||||
it("should return true when in range", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
assert.equal(range.testVersion("1.0.0"), true);
|
||||
assert.equal(range.testVersion("1.9.9"), true);
|
||||
});
|
||||
it("should return false when out of range", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
assert.equal(range.testVersion("0.9.9"), false);
|
||||
assert.equal(range.testVersion("2.0.0"), false);
|
||||
});
|
||||
it("should handle exact matches", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality("=", "1.0.0"),
|
||||
new lib.ModVersionEquality("=", "1.0.0"),
|
||||
);
|
||||
assert.equal(range.testVersion("0.9.9"), false);
|
||||
assert.equal(range.testVersion("1.0.0"), true);
|
||||
assert.equal(range.testVersion("1.0.1"), false);
|
||||
});
|
||||
});
|
||||
describe("combineVersion()", function() {
|
||||
it("should handle merge with less than", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
|
||||
assert.equal(range.testVersion("1.1"), true);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
range.combineVersion(new lib.ModVersionEquality("<", "1.2"));
|
||||
assert.equal(range.testVersion("1.1"), true);
|
||||
assert.equal(range.testVersion("1.5"), false);
|
||||
|
||||
assert.equal(range.valid, true);
|
||||
range.combineVersion(new lib.ModVersionEquality("<", "0.5"));
|
||||
assert.equal(range.valid, false);
|
||||
});
|
||||
it("should handle merge with less than equal", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
|
||||
assert.equal(range.testVersion("1.2"), true);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
range.combineVersion(new lib.ModVersionEquality("<=", "1.2"));
|
||||
assert.equal(range.testVersion("1.2"), true);
|
||||
assert.equal(range.testVersion("1.5"), false);
|
||||
|
||||
assert.equal(range.valid, true);
|
||||
range.combineVersion(new lib.ModVersionEquality("<=", "0.5"));
|
||||
assert.equal(range.valid, false);
|
||||
});
|
||||
it("should handle merge with equal", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
|
||||
assert.equal(range.testVersion("1.2"), true);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
range.combineVersion(new lib.ModVersionEquality("=", "1.2"));
|
||||
assert.equal(range.testVersion("1.2"), true);
|
||||
assert.equal(range.testVersion("1.5"), false);
|
||||
|
||||
assert.equal(range.valid, true);
|
||||
range.combineVersion(new lib.ModVersionEquality("=", "0.5"));
|
||||
assert.equal(range.valid, false);
|
||||
});
|
||||
it("should handle merge with greater than equal", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
|
||||
assert.equal(range.testVersion("1.1"), true);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
range.combineVersion(new lib.ModVersionEquality(">=", "1.2"));
|
||||
assert.equal(range.testVersion("1.1"), false);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
|
||||
assert.equal(range.valid, true);
|
||||
range.combineVersion(new lib.ModVersionEquality(">=", "2.5"));
|
||||
assert.equal(range.valid, false);
|
||||
});
|
||||
it("should handle merge with greater than", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
|
||||
assert.equal(range.testVersion("1.2"), true);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
range.combineVersion(new lib.ModVersionEquality(">", "1.2"));
|
||||
assert.equal(range.testVersion("1.2"), false);
|
||||
assert.equal(range.testVersion("1.5"), true);
|
||||
|
||||
assert.equal(range.valid, true);
|
||||
range.combineVersion(new lib.ModVersionEquality(">", "2.5"));
|
||||
assert.equal(range.valid, false);
|
||||
});
|
||||
it("should throw if the equality is invalid (unreachable)", function() {
|
||||
const range = new lib.ModVersionRange(
|
||||
new lib.ModVersionEquality(">=", "1.0.0"),
|
||||
new lib.ModVersionEquality("<", "2.0.0"),
|
||||
);
|
||||
const version = new lib.ModVersionEquality(">", "1.2");
|
||||
version.equality = "==";
|
||||
assert.throws(() => range.combineVersion(version));
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
Reference in new issue
Block a user