StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add a few more unit tests for metadata loading & validation (#285)

This commit is contained in:
Jesse Plamondon-Willard 2017-05-13 21:58:13 -04:00
parent 725b1f1419
commit 317349f3e2
1 changed files with 44 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
src/StardewModdingAPI.Tests/ModResolverTests.cs
View File

@ -18,8 +18,40 @@ namespace StardewModdingAPI.Tests
/********* /*********
** Unit tests ** Unit tests
*********/ *********/
[Test(Description = "Assert that the resolver correctly returns an empty list if there are no mods installed.")]
public void ReadBasicManifest_NoMods_ReturnsEmptyList()
{
// arrange
string rootFolder = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"));
Directory.CreateDirectory(rootFolder);
// act
IModMetadata[] mods = new ModResolver().ReadManifests(rootFolder, new JsonHelper(), new ModCompatibility[0]).ToArray();
// assert
Assert.AreEqual(0, mods.Length, 0, $"Expected to find zero manifests, found {mods.Length} instead.");
}
[Test(Description = "Assert that the resolver correctly returns a failed metadata if there's an empty mod folder.")]
public void ReadBasicManifest_EmptyModFolder_ReturnsFailedManifest()
{
// arrange
string rootFolder = Path.Combine(Path.GetTempPath(), Guid.NewGuid().ToString("N"));
string modFolder = Path.Combine(rootFolder, Guid.NewGuid().ToString("N"));
Directory.CreateDirectory(modFolder);
// act
IModMetadata[] mods = new ModResolver().ReadManifests(rootFolder, new JsonHelper(), new ModCompatibility[0]).ToArray();
IModMetadata mod = mods.FirstOrDefault();
// assert
Assert.AreEqual(1, mods.Length, 0, $"Expected to find one manifest, found {mods.Length} instead.");
Assert.AreEqual(ModMetadataStatus.Failed, mod.Status, "The mod metadata was not marked failed.");
Assert.IsNotNull(mod.Error, "The mod metadata did not have an error message set.");
}
[Test(Description = "Assert that the resolver correctly reads manifest data from a randomised file.")] [Test(Description = "Assert that the resolver correctly reads manifest data from a randomised file.")]
public void ReadBasicManifest() public void ReadBasicManifest_CanReadFile()
{ {
// create manifest data // create manifest data
IDictionary<string, object> originalDependency = new Dictionary<string, object> IDictionary<string, object> originalDependency = new Dictionary<string, object>
@ -77,8 +109,14 @@ namespace StardewModdingAPI.Tests
Assert.AreEqual(originalDependency[nameof(IManifestDependency.UniqueID)], mod.Manifest.Dependencies[0].UniqueID, "The first dependency's unique ID doesn't match."); Assert.AreEqual(originalDependency[nameof(IManifestDependency.UniqueID)], mod.Manifest.Dependencies[0].UniqueID, "The first dependency's unique ID doesn't match.");
} }
[Test(Description = "Assert that validation doesn't fail if there are no mods installed.")]
public void ValidateManifests_NoMods_DoesNothing()
{
new ModResolver().ValidateManifests(new ModMetadata[0], apiVersion: new SemanticVersion("1.0"));
}
[Test(Description = "Assert that validation skips manifests that have already failed without calling any other properties.")] [Test(Description = "Assert that validation skips manifests that have already failed without calling any other properties.")]
public void ValidateManifest_Skips_Failed() public void ValidateManifests_Skips_Failed()
{ {
// arrange // arrange
Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict); Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict);
@ -92,7 +130,7 @@ namespace StardewModdingAPI.Tests
} }
[Test(Description = "Assert that validation fails if the mod has 'assume broken' compatibility.")] [Test(Description = "Assert that validation fails if the mod has 'assume broken' compatibility.")]
public void ValidateManifest_ModCompatibility_AssumeBroken_Fails() public void ValidateManifests_ModCompatibility_AssumeBroken_Fails()
{ {
// arrange // arrange
Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict); Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict);
@ -108,7 +146,7 @@ namespace StardewModdingAPI.Tests
} }
[Test(Description = "Assert that validation fails when the minimum API version is higher than the current SMAPI version.")] [Test(Description = "Assert that validation fails when the minimum API version is higher than the current SMAPI version.")]
public void ValidateManifest_MinimumApiVersion_Fails() public void ValidateManifests_MinimumApiVersion_Fails()
{ {
// arrange // arrange
Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict); Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict);
@ -125,7 +163,7 @@ namespace StardewModdingAPI.Tests
} }
[Test(Description = "Assert that validation fails when the manifest references a DLL that does not exist.")] [Test(Description = "Assert that validation fails when the manifest references a DLL that does not exist.")]
public void ValidateManifest_MissingEntryDLL_Fails() public void ValidateManifests_MissingEntryDLL_Fails()
{ {
// arrange // arrange
Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict); Mock<IModMetadata> mock = new Mock<IModMetadata>(MockBehavior.Strict);
@ -143,7 +181,7 @@ namespace StardewModdingAPI.Tests
} }
[Test(Description = "Assert that validation fails when the manifest references a DLL that does not exist.")] [Test(Description = "Assert that validation fails when the manifest references a DLL that does not exist.")]
public void ValidateManifest_Valid_Passes() public void ValidateManifests_Valid_Passes()
{ {
// set up manifest // set up manifest
IManifest manifest = this.GetRandomManifest(); IManifest manifest = this.GetRandomManifest();
@ -168,7 +206,6 @@ namespace StardewModdingAPI.Tests
} }
/********* /*********
** Private methods ** Private methods
*********/ *********/