using System; using System.Diagnostics.CodeAnalysis; using Newtonsoft.Json; using NUnit.Framework; using StardewModdingAPI; using StardewModdingAPI.Framework; namespace SMAPI.Tests.Utilities { /// Unit tests for . [TestFixture] internal class SemanticVersionTests { /********* ** Unit tests *********/ /**** ** Constructor ****/ /// Assert the parsed version when constructed from a standard string. /// The version string to parse. [TestCase("1.0", ExpectedResult = "1.0.0")] [TestCase("1.0.0", ExpectedResult = "1.0.0")] [TestCase("3000.4000.5000", ExpectedResult = "3000.4000.5000")] [TestCase("1.2-some-tag.4", ExpectedResult = "1.2.0-some-tag.4")] [TestCase("1.2.3-some-tag.4", ExpectedResult = "1.2.3-some-tag.4")] [TestCase("1.2.3-SoME-tAg.4", ExpectedResult = "1.2.3-SoME-tAg.4")] [TestCase("1.2.3-some-tag.4 ", ExpectedResult = "1.2.3-some-tag.4")] [TestCase("1.2.3-some-tag.4+build.004", ExpectedResult = "1.2.3-some-tag.4+build.004")] [TestCase("1.2+3.4.5-build.004", ExpectedResult = "1.2.0+3.4.5-build.004")] public string Constructor_FromString(string input) { // act ISemanticVersion version = new SemanticVersion(input); // assert return version.ToString(); } /// Assert that the constructor rejects invalid values when constructed from a string. /// The version string to parse. [Test(Description = "Assert that the constructor throws the expected exception for invalid versions.")] [TestCase(null)] [TestCase("")] [TestCase(" ")] [TestCase("1")] [TestCase("01.0")] [TestCase("1.05")] [TestCase("1.5.06")] // leading zeros specifically prohibited by spec [TestCase("1.2.3.4")] [TestCase("1.apple")] [TestCase("1.2.apple")] [TestCase("1.2.3.apple")] [TestCase("1..2..3")] [TestCase("1.2.3-")] [TestCase("1.2.3--some-tag")] [TestCase("1.2.3-some-tag...")] [TestCase("1.2.3-some-tag...4")] [TestCase("1.2.3-some-tag.4+build...4")] [TestCase("apple")] [TestCase("-apple")] [TestCase("-5")] public void Constructor_FromString_WithInvalidValues(string? input) { if (input == null) this.AssertAndLogException(() => new SemanticVersion(input!)); else this.AssertAndLogException(() => new SemanticVersion(input)); } /// Assert the parsed version when constructed from a non-standard string. /// The version string to parse. [TestCase("1.2.3", ExpectedResult = "1.2.3")] [TestCase("1.0.0.0", ExpectedResult = "1.0.0")] [TestCase("1.0.0.5", ExpectedResult = "1.0.0.5")] [TestCase("1.2.3.4-some-tag.4 ", ExpectedResult = "1.2.3.4-some-tag.4")] public string Constructor_FromString_NonStandard(string input) { // act ISemanticVersion version = new SemanticVersion(input, allowNonStandard: true); // assert return version.ToString(); } /// Assert that the constructor rejects a non-standard string when the non-standard flag isn't set. /// The version string to parse. [TestCase("1.0.0.0")] [TestCase("1.0.0.5")] [TestCase("1.2.3.4-some-tag.4 ")] public void Constructor_FromString_Standard_DisallowsNonStandardVersion(string input) { Assert.Throws(() => _ = new SemanticVersion(input)); } /// Assert the parsed version when constructed from standard parts. /// The major number. /// The minor number. /// The patch number. /// The prerelease tag. /// The build metadata. [TestCase(1, 0, 0, null, null, ExpectedResult = "1.0.0")] [TestCase(3000, 4000, 5000, null, null, ExpectedResult = "3000.4000.5000")] [TestCase(1, 2, 3, "", null, ExpectedResult = "1.2.3")] [TestCase(1, 2, 3, " ", null, ExpectedResult = "1.2.3")] [TestCase(1, 2, 3, "0", null, ExpectedResult = "1.2.3-0")] [TestCase(1, 2, 3, "some-tag.4", null, ExpectedResult = "1.2.3-some-tag.4")] [TestCase(1, 2, 3, "sOMe-TaG.4", null, ExpectedResult = "1.2.3-sOMe-TaG.4")] [TestCase(1, 2, 3, "some-tag.4 ", null, ExpectedResult = "1.2.3-some-tag.4")] [TestCase(1, 2, 3, "some-tag.4 ", "build.004", ExpectedResult = "1.2.3-some-tag.4+build.004")] [TestCase(1, 2, 0, null, "3.4.5-build.004", ExpectedResult = "1.2.0+3.4.5-build.004")] public string Constructor_FromParts(int major, int minor, int patch, string? prerelease, string? build) { // act ISemanticVersion version = new SemanticVersion(major, minor, patch, prerelease, build); // assert this.AssertParts(version, major, minor, patch, prerelease, build, nonStandard: false); return version.ToString(); } /// Assert the parsed version when constructed from parts including non-standard fields. /// The major number. /// The minor number. /// The patch number. /// The non-standard platform release number. /// The prerelease tag. /// The build metadata. [TestCase(1, 0, 0, 0, null, null, ExpectedResult = "1.0.0")] [TestCase(3000, 4000, 5000, 6000, null, null, ExpectedResult = "3000.4000.5000.6000")] [TestCase(1, 2, 3, 4, "", null, ExpectedResult = "1.2.3.4")] [TestCase(1, 2, 3, 4, " ", null, ExpectedResult = "1.2.3.4")] [TestCase(1, 2, 3, 4, "0", null, ExpectedResult = "1.2.3.4-0")] [TestCase(1, 2, 3, 4, "some-tag.4", null, ExpectedResult = "1.2.3.4-some-tag.4")] [TestCase(1, 2, 3, 4, "sOMe-TaG.4", null, ExpectedResult = "1.2.3.4-sOMe-TaG.4")] [TestCase(1, 2, 3, 4, "some-tag.4 ", null, ExpectedResult = "1.2.3.4-some-tag.4")] [TestCase(1, 2, 3, 4, "some-tag.4 ", "build.004", ExpectedResult = "1.2.3.4-some-tag.4+build.004")] [TestCase(1, 2, 0, 4, null, "3.4.5-build.004", ExpectedResult = "1.2.0.4+3.4.5-build.004")] public string Constructor_FromParts_NonStandard(int major, int minor, int patch, int platformRelease, string prerelease, string build) { // act ISemanticVersion version = new SemanticVersion(major, minor, patch, platformRelease, prerelease, build); // assert this.AssertParts(version, major, minor, patch, prerelease, build, nonStandard: platformRelease != 0); return version.ToString(); } /// Assert that the constructor rejects invalid values when constructed from the individual numbers. /// The major number. /// The minor number. /// The patch number. /// The prerelease tag. /// The build metadata. [TestCase(0, 0, 0, null, null)] [TestCase(-1, 0, 0, null, null)] [TestCase(0, -1, 0, null, null)] [TestCase(0, 0, -1, null, null)] [TestCase(1, 0, 0, "-tag", null)] [TestCase(1, 0, 0, "tag spaces", null)] [TestCase(1, 0, 0, "tag~", null)] [TestCase(1, 0, 0, null, "build~")] public void Constructor_FromParts_WithInvalidValues(int major, int minor, int patch, string prerelease, string build) { this.AssertAndLogException(() => new SemanticVersion(major, minor, patch, prerelease, build)); } /// Assert the parsed version when constructed from an assembly version. /// The major number. /// The minor number. /// The patch number. [Test(Description = "Assert that the constructor sets the expected values for all valid versions when constructed from an assembly version.")] [TestCase(1, 0, 0, ExpectedResult = "1.0.0")] [TestCase(1, 2, 3, ExpectedResult = "1.2.3")] [TestCase(3000, 4000, 5000, ExpectedResult = "3000.4000.5000")] public string Constructor_FromAssemblyVersion(int major, int minor, int patch) { // act ISemanticVersion version = new SemanticVersion(new Version(major, minor, patch)); // assert this.AssertParts(version, major, minor, patch, null, null, nonStandard: false); return version.ToString(); } /**** ** CompareTo ****/ /// Assert that returns the expected value. /// The left version. /// The right version. // equal [TestCase("0.5.7", "0.5.7", ExpectedResult = 0)] [TestCase("1.0", "1.0", ExpectedResult = 0)] [TestCase("1.0-beta", "1.0-beta", ExpectedResult = 0)] [TestCase("1.0-beta.10", "1.0-beta.10", ExpectedResult = 0)] [TestCase("1.0-beta", "1.0-beta ", ExpectedResult = 0)] [TestCase("1.0-beta+build.001", "1.0-beta+build.001", ExpectedResult = 0)] [TestCase("1.0-beta+build.001", "1.0-beta+build.006", ExpectedResult = 0)] // build metadata must not affect precedence // less than [TestCase("0.5.7", "0.5.8", ExpectedResult = -1)] [TestCase("1.0", "1.1", ExpectedResult = -1)] [TestCase("1.0-beta", "1.0", ExpectedResult = -1)] [TestCase("1.0-beta", "1.0-beta.2", ExpectedResult = -1)] [TestCase("1.0-beta.1", "1.0-beta.2", ExpectedResult = -1)] [TestCase("1.0-beta.2", "1.0-beta.10", ExpectedResult = -1)] [TestCase("1.0-beta-2", "1.0-beta-10", ExpectedResult = -1)] [TestCase("1.0-unofficial.1", "1.0-beta.1", ExpectedResult = -1)] // special case: 'unofficial' has lower priority than official releases // more than [TestCase("0.5.8", "0.5.7", ExpectedResult = 1)] [TestCase("1.1", "1.0", ExpectedResult = 1)] [TestCase("1.0", "1.0-beta", ExpectedResult = 1)] [TestCase("1.0-beta.2", "1.0-beta", ExpectedResult = 1)] [TestCase("1.0-beta.2", "1.0-beta.1", ExpectedResult = 1)] [TestCase("1.0-beta.10", "1.0-beta.2", ExpectedResult = 1)] [TestCase("1.0-beta-10", "1.0-beta-2", ExpectedResult = 1)] // null [TestCase("1.0.0", null, ExpectedResult = 1)] // null is always less than any value per CompareTo remarks public int CompareTo(string versionStrA, string? versionStrB) { // arrange ISemanticVersion versionA = new SemanticVersion(versionStrA); ISemanticVersion? versionB = versionStrB != null ? new SemanticVersion(versionStrB) : null; // assert return versionA.CompareTo(versionB); } /**** ** IsOlderThan ****/ /// Assert that and return the expected value. /// The left version. /// The right version. // keep test cases in sync with CompareTo for simplicity. // equal [TestCase("0.5.7", "0.5.7", ExpectedResult = false)] [TestCase("1.0", "1.0", ExpectedResult = false)] [TestCase("1.0-beta", "1.0-beta", ExpectedResult = false)] [TestCase("1.0-beta.10", "1.0-beta.10", ExpectedResult = false)] [TestCase("1.0-beta", "1.0-beta ", ExpectedResult = false)] [TestCase("1.0-beta+build.001", "1.0-beta+build.001", ExpectedResult = false)] // build metadata must not affect precedence [TestCase("1.0-beta+build.001", "1.0-beta+build.006", ExpectedResult = false)] // build metadata must not affect precedence // less than [TestCase("0.5.7", "0.5.8", ExpectedResult = true)] [TestCase("1.0", "1.1", ExpectedResult = true)] [TestCase("1.0-beta", "1.0", ExpectedResult = true)] [TestCase("1.0-beta", "1.0-beta.2", ExpectedResult = true)] [TestCase("1.0-beta.1", "1.0-beta.2", ExpectedResult = true)] [TestCase("1.0-beta.2", "1.0-beta.10", ExpectedResult = true)] [TestCase("1.0-beta-2", "1.0-beta-10", ExpectedResult = true)] // more than [TestCase("0.5.8", "0.5.7", ExpectedResult = false)] [TestCase("1.1", "1.0", ExpectedResult = false)] [TestCase("1.0", "1.0-beta", ExpectedResult = false)] [TestCase("1.0-beta.2", "1.0-beta", ExpectedResult = false)] [TestCase("1.0-beta.2", "1.0-beta.1", ExpectedResult = false)] [TestCase("1.0-beta.10", "1.0-beta.2", ExpectedResult = false)] [TestCase("1.0-beta-10", "1.0-beta-2", ExpectedResult = false)] // null [TestCase("1.0.0", null, ExpectedResult = false)] // null is always less than any value per CompareTo remarks public bool IsOlderThan(string versionStrA, string? versionStrB) { // arrange ISemanticVersion versionA = new SemanticVersion(versionStrA); ISemanticVersion? versionB = versionStrB != null ? new SemanticVersion(versionStrB) : null; // assert Assert.AreEqual(versionA.IsOlderThan(versionB), versionA.IsOlderThan(versionB?.ToString()), "The two signatures returned different results."); return versionA.IsOlderThan(versionB); } /**** ** IsNewerThan ****/ /// Assert that and return the expected value. /// The left version. /// The right version. // keep test cases in sync with CompareTo for simplicity. // equal [TestCase("0.5.7", "0.5.7", ExpectedResult = false)] [TestCase("1.0", "1.0", ExpectedResult = false)] [TestCase("1.0-beta", "1.0-beta", ExpectedResult = false)] [TestCase("1.0-beta.10", "1.0-beta.10", ExpectedResult = false)] [TestCase("1.0-beta", "1.0-beta ", ExpectedResult = false)] [TestCase("1.0-beta+build.001", "1.0-beta+build.001", ExpectedResult = false)] // build metadata must not affect precedence [TestCase("1.0-beta+build.001", "1.0-beta+build.006", ExpectedResult = false)] // build metadata must not affect precedence // less than [TestCase("0.5.7", "0.5.8", ExpectedResult = false)] [TestCase("1.0", "1.1", ExpectedResult = false)] [TestCase("1.0-beta", "1.0", ExpectedResult = false)] [TestCase("1.0-beta", "1.0-beta.2", ExpectedResult = false)] [TestCase("1.0-beta.1", "1.0-beta.2", ExpectedResult = false)] [TestCase("1.0-beta.2", "1.0-beta.10", ExpectedResult = false)] [TestCase("1.0-beta-2", "1.0-beta-10", ExpectedResult = false)] // more than [TestCase("0.5.8", "0.5.7", ExpectedResult = true)] [TestCase("1.1", "1.0", ExpectedResult = true)] [TestCase("1.0", "1.0-beta", ExpectedResult = true)] [TestCase("1.0-beta.2", "1.0-beta", ExpectedResult = true)] [TestCase("1.0-beta.2", "1.0-beta.1", ExpectedResult = true)] [TestCase("1.0-beta.10", "1.0-beta.2", ExpectedResult = true)] [TestCase("1.0-beta-10", "1.0-beta-2", ExpectedResult = true)] // null [TestCase("1.0.0", null, ExpectedResult = true)] // null is always less than any value per CompareTo remarks public bool IsNewerThan(string versionStrA, string? versionStrB) { // arrange ISemanticVersion versionA = new SemanticVersion(versionStrA); ISemanticVersion? versionB = versionStrB != null ? new SemanticVersion(versionStrB) : null; // assert Assert.AreEqual(versionA.IsNewerThan(versionB), versionA.IsNewerThan(versionB?.ToString()), "The two signatures returned different results."); return versionA.IsNewerThan(versionB); } /**** ** IsBetween ****/ /// Assert that and return the expected value. /// The main version. /// The lower version number. /// The upper version number. [Test(Description = "Assert that version.IsBetween returns the expected value.")] // is between [TestCase("0.5.7-beta.3", "0.5.7-beta.3", "0.5.7-beta.3", ExpectedResult = true)] [TestCase("1.0", "1.0", "1.1", ExpectedResult = true)] [TestCase("1.0", "1.0-beta", "1.1", ExpectedResult = true)] [TestCase("1.0", "0.5", "1.1", ExpectedResult = true)] [TestCase("1.0-beta.2", "1.0-beta.1", "1.0-beta.3", ExpectedResult = true)] [TestCase("1.0-beta-2", "1.0-beta-1", "1.0-beta-3", ExpectedResult = true)] [TestCase("1.0.0", null, "1.0.0", ExpectedResult = true)] // null is always less than any value per CompareTo remarks // is not between [TestCase("1.0-beta", "1.0", "1.1", ExpectedResult = false)] [TestCase("1.0", "1.1", "1.0", ExpectedResult = false)] [TestCase("1.0-beta.2", "1.1", "1.0", ExpectedResult = false)] [TestCase("1.0-beta.2", "1.0-beta.10", "1.0-beta.3", ExpectedResult = false)] [TestCase("1.0-beta-2", "1.0-beta-10", "1.0-beta-3", ExpectedResult = false)] [TestCase("1.0.0", "1.0.0", null, ExpectedResult = false)] // null is always less than any value per CompareTo remarks public bool IsBetween(string versionStr, string? lowerStr, string? upperStr) { // arrange ISemanticVersion? lower = lowerStr != null ? new SemanticVersion(lowerStr) : null; ISemanticVersion? upper = upperStr != null ? new SemanticVersion(upperStr) : null; ISemanticVersion version = new SemanticVersion(versionStr); // assert Assert.AreEqual(version.IsBetween(lower, upper), version.IsBetween(lower?.ToString(), upper?.ToString()), "The two signatures returned different results."); return version.IsBetween(lower, upper); } /**** ** Serializable ****/ /// Assert that the version can be round-tripped through JSON with no special configuration. /// The semantic version. [TestCase("1.0.0")] [TestCase("1.0.0-beta.400")] [TestCase("1.0.0-beta.400+build")] public void Serializable(string versionStr) { // act string json = JsonConvert.SerializeObject(new SemanticVersion(versionStr)); SemanticVersion? after = JsonConvert.DeserializeObject(json); // assert Assert.IsNotNull(after, "The semantic version after deserialization is unexpectedly null."); Assert.AreEqual(versionStr, after!.ToString(), "The semantic version after deserialization doesn't match the input version."); } /**** ** GameVersion ****/ /// Assert that the GameVersion subclass correctly parses non-standard game versions. /// The raw version. [TestCase("1.0")] [TestCase("1.01")] [TestCase("1.02")] [TestCase("1.03")] [TestCase("1.04")] [TestCase("1.05")] [TestCase("1.051")] [TestCase("1.051b")] [TestCase("1.06")] [TestCase("1.07")] [TestCase("1.07a")] [TestCase("1.08")] [TestCase("1.1")] [TestCase("1.11")] [TestCase("1.2")] [TestCase("1.2.15")] [TestCase("1.4.0.1")] [TestCase("1.4.0.6")] public void GameVersion(string versionStr) { // act GameVersion version = new(versionStr); // assert Assert.AreEqual(versionStr, version.ToString(), "The game version did not round-trip to the same value."); } /********* ** Private methods *********/ /// Assert that the version matches the expected parts. /// The version number. /// The major number. /// The minor number. /// The patch number. /// The prerelease tag. /// The build metadata. /// Whether the version should be marked as non-standard. private void AssertParts(ISemanticVersion version, int major, int minor, int patch, string? prerelease, string? build, bool nonStandard) { Assert.AreEqual(major, version.MajorVersion, "The major version doesn't match."); Assert.AreEqual(minor, version.MinorVersion, "The minor version doesn't match."); Assert.AreEqual(patch, version.PatchVersion, "The patch version doesn't match."); Assert.AreEqual(string.IsNullOrWhiteSpace(prerelease) ? null : prerelease.Trim(), version.PrereleaseTag, "The prerelease tag doesn't match."); Assert.AreEqual(string.IsNullOrWhiteSpace(build) ? null : build.Trim(), version.BuildMetadata, "The build metadata doesn't match."); Assert.AreEqual(nonStandard, version.IsNonStandard(), $"The version is incorrectly marked {(nonStandard ? "standard" : "non-standard")}."); } /// Assert that the expected exception type is thrown, and log the action output and thrown exception. /// The expected exception type. /// The action which may throw the exception. [SuppressMessage("ReSharper", "UnusedParameter.Local", Justification = "The message argument is deliberately only used in precondition checks since this is an assertion method.")] private void AssertAndLogException(Func action) where T : Exception { this.AssertAndLogException(() => { object result = action(); TestContext.WriteLine($"Func result: {result}"); }); } /// Assert that the expected exception type is thrown, and log the thrown exception. /// The expected exception type. /// The action which may throw the exception. /// The message to log if the expected exception isn't thrown. [SuppressMessage("ReSharper", "UnusedParameter.Local", Justification = "The message argument is deliberately only used in precondition checks since this is an assertion method.")] private void AssertAndLogException(Action action, string? message = null) where T : Exception { try { action(); } catch (T ex) { TestContext.WriteLine($"Exception thrown:\n{ex}"); return; } catch (Exception ex) when (ex is not AssertionException) { TestContext.WriteLine($"Exception thrown:\n{ex}"); Assert.Fail(message ?? $"Didn't throw the expected exception; expected {typeof(T).FullName}, got {ex.GetType().FullName}."); } // no exception thrown Assert.Fail(message ?? "Didn't throw an exception."); } } }