Improve project tooling, packaging, and test workflow

Author: Hellfrosted

.github/workflows/logic-checks.yml

@@ -0,0 +1,21 @@
+name: Logic Checks
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  logic-tests:
+    runs-on: windows-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up .NET SDK
+        uses: actions/setup-dotnet@v4
+        with:
+          global-json-file: global.json
+
+      - name: Run logic tests
+        run: dotnet test BetterModMenu.Tests/BetterModMenu.Tests.csproj

.gitignore

@@ -30,6 +30,7 @@ obj/
 
 # Build, export, and temp files
 build/
+artifacts/
 export/
 *.log
 *.tmp

BetterModMenu.Tests/BetterModMenu.Tests.csproj

@@ -1,12 +1,17 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <OutputType>Exe</OutputType>
     <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
+    <PackageReference Include="MSTest.TestAdapter" Version="3.10.4" />
+    <PackageReference Include="MSTest.TestFramework" Version="3.10.4" />
+  </ItemGroup>
+
   <ItemGroup>
     <Compile Include="..\Data\ManifestScanner.cs" Link="Data\ManifestScanner.cs" />
     <Compile Include="..\Data\ProfileStateRules.cs" Link="Data\ProfileStateRules.cs" />

BetterModMenu.Tests/LogicTests.cs

@@ -0,0 +1,167 @@
+using BetterModMenu.Data;
+using BetterModMenu.Patches;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System.IO;
+
+namespace BetterModMenu.Tests;
+
+[TestClass]
+public class LogicTests
+{
+    [TestMethod]
+    public void CanAdd_TrimsAndAcceptsValidNames()
+    {
+        var existingGroups = new List<string> { "Bosses" };
+
+        bool isValid = ModdingGroupRules.CanAdd(existingGroups, "  New Group  ", out string trimmedName);
+
+        Assert.IsTrue(isValid);
+        Assert.AreEqual("New Group", trimmedName);
+    }
+
+    [TestMethod]
+    public void CanAdd_RejectsReservedGroupName()
+    {
+        bool isValid = ModdingGroupRules.CanAdd(Array.Empty<string>(), ModdingScreenConstants.UnassignedGroup, out _);
+
+        Assert.IsFalse(isValid);
+    }
+
+    [TestMethod]
+    public void ValidateRename_AllowsNoOpRename()
+    {
+        var result = ModdingGroupRules.ValidateRename(new[] { "Bosses" }, "Bosses", "Bosses", out string trimmedName);
+
+        Assert.AreEqual(GroupNameValidationResult.Unchanged, result);
+        Assert.AreEqual("Bosses", trimmedName);
+    }
+
+    [TestMethod]
+    public void ValidateRename_RejectsDuplicateTarget()
+    {
+        var result = ModdingGroupRules.ValidateRename(new[] { "Bosses", "Elites" }, "Bosses", "Elites", out _);
+
+        Assert.AreEqual(GroupNameValidationResult.Duplicate, result);
+    }
+
+    [TestMethod]
+    public void FindManifestPath_ReturnsOnlyExactManifestNames()
+    {
+        string tempDirectory = CreateTempDirectory();
+        try
+        {
+            File.WriteAllText(Path.Combine(tempDirectory, "RouteSuggestConfig.json"), "{ }");
+            File.WriteAllText(Path.Combine(tempDirectory, "BetterModMenu.json"), "{ }");
+
+            string? manifestPath = ManifestScanner.FindManifestPath(tempDirectory, "BetterModMenu", new[] { ".json" });
+
+            Assert.AreEqual(Path.Combine(tempDirectory, "BetterModMenu.json"), manifestPath);
+        }
+        finally
+        {
+            Directory.Delete(tempDirectory, true);
+        }
+    }
+
+    [TestMethod]
+    public void FindManifestPath_RejectsUnsafeManifestIds()
+    {
+        string tempDirectory = CreateTempDirectory();
+        try
+        {
+            File.WriteAllText(Path.Combine(tempDirectory, "BetterModMenu.json"), "{ }");
+
+            string? traversed = ManifestScanner.FindManifestPath(tempDirectory, @"..\BetterModMenu", new[] { ".json" });
+            string rootedId = Path.Combine(tempDirectory, "BetterModMenu");
+            string? rooted = ManifestScanner.FindManifestPath(tempDirectory, rootedId, new[] { ".json" });
+
+            Assert.IsNull(traversed);
+            Assert.IsNull(rooted);
+        }
+        finally
+        {
+            Directory.Delete(tempDirectory, true);
+        }
+    }
+
+    [TestMethod]
+    public void TryReadAffectsGameplay_IgnoresMismatchedIds()
+    {
+        string tempPath = Path.Combine(Path.GetTempPath(), "BetterModMenuTests_" + Guid.NewGuid().ToString("N") + ".json");
+        try
+        {
+            File.WriteAllText(tempPath, """
+            {
+              "id": "AnotherMod",
+              "affects_gameplay": true
+            }
+            """);
+
+            bool found = ManifestScanner.TryReadAffectsGameplay(tempPath, "BetterModMenu", out bool affectsGameplay);
+
+            Assert.IsFalse(found);
+            Assert.IsFalse(affectsGameplay);
+        }
+        finally
+        {
+            if (File.Exists(tempPath))
+                File.Delete(tempPath);
+        }
+    }
+
+    [TestMethod]
+    public void NormalizeGroups_RemovesStaleEntries()
+    {
+        var customGroups = new List<string> { "Bosses", "Elites" };
+        var modGroups = new Dictionary<string, string>
+        {
+            ["keep-mod"] = "Bosses",
+            ["missing-mod"] = "Bosses",
+            ["wrong-group"] = "Missing"
+        };
+        var collapsedGroups = new HashSet<string> { "Bosses", "Missing", "Unassigned" };
+
+        bool changed = ProfileStateRules.NormalizeGroups(customGroups, modGroups, collapsedGroups, new[] { "keep-mod", "other-mod" }, "Unassigned");
+
+        Assert.IsTrue(changed);
+        Assert.AreEqual(1, modGroups.Count);
+        Assert.AreEqual("Bosses", modGroups["keep-mod"]);
+        Assert.IsTrue(collapsedGroups.Contains("Bosses"));
+        Assert.IsFalse(collapsedGroups.Contains("Missing"));
+        Assert.IsFalse(collapsedGroups.Contains("Unassigned"));
+    }
+
+    [TestMethod]
+    public void NormalizeGroups_ReportsNoOpWhenAlreadyValid()
+    {
+        var customGroups = new List<string> { "Bosses" };
+        var modGroups = new Dictionary<string, string> { ["keep-mod"] = "Bosses" };
+        var collapsedGroups = new HashSet<string> { "Bosses" };
+
+        bool changed = ProfileStateRules.NormalizeGroups(customGroups, modGroups, collapsedGroups, new[] { "keep-mod" }, "Unassigned");
+
+        Assert.IsFalse(changed);
+    }
+
+    [TestMethod]
+    public void BuildVisibleGroupOrder_OmitsEmptyUnassignedGroup()
+    {
+        var groups = new Dictionary<string, int>
+        {
+            [ModdingScreenConstants.UnassignedGroup] = 0,
+            ["Bosses"] = 1,
+            ["Elites"] = 0
+        };
+
+        var names = ProfileStateRules.BuildVisibleGroupOrder(groups, new List<string> { "Bosses", "Elites" }, ModdingScreenConstants.UnassignedGroup);
+
+        CollectionAssert.AreEqual(new[] { "Bosses", "Elites" }, names);
+    }
+
+    private static string CreateTempDirectory()
+    {
+        string tempDirectory = Path.Combine(Path.GetTempPath(), "BetterModMenuTests_" + Guid.NewGuid().ToString("N"));
+        Directory.CreateDirectory(tempDirectory);
+        return tempDirectory;
+    }
+}