Merge #3931 Make where-CKAN-would-install logic consistent

KSP-CKAN · Nov 24, 2023 · 0a97717 · 0a97717
2 parents 3b8b888 + 3ca47c9
commit 0a97717
Show file tree

Hide file tree

Showing 6 changed files with 115 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -33,6 +33,7 @@ All notable changes to this project will be documented in this file.
 - [Multiple] Fix auto-remove during upgrade (#3913 by: HebaruSan; reviewed: techman83)
 - [Build] Clean up Linux .desktop files (#3927 by: irasponsible; reviewed: HebaruSan)
 - [GUI] Don't change language setting with scroll wheel (#3928 by: HebaruSan; reviewed: techman83)
+- [Core] Make where-CKAN-would-install logic consistent (#3931 by: HebaruSan; reviewed: techman83)
 
 ### Internal
 

diff --git a/Core/ModuleInstaller.cs b/Core/ModuleInstaller.cs
@@ -340,10 +340,10 @@ private IEnumerable<string> InstallModule(CkanModule module, string zip_filename
                     {
                         // Find where we're installing identifier.optionalversion.dll
                         // (file name might not be an exact match with manually installed)
-                        var dllFolders = files.Where(f =>
-                                Path.GetFileName(f.destination).StartsWith(module.identifier)
-                                    && f.destination.EndsWith(".dll", StringComparison.CurrentCultureIgnoreCase))
-                            .Select(f => Path.GetDirectoryName(ksp.ToRelativeGameDir(f.destination)))
+                        var dllFolders = files
+                            .Select(f => ksp.ToRelativeGameDir(f.destination))
+                            .Where(relPath => ksp.DllPathToIdentifier(relPath) == module.identifier)
+                            .Select(relPath => Path.GetDirectoryName(relPath))
                             .ToHashSet();
                         // Make sure that the DLL is actually included in the install
                         // (NearFutureElectrical, NearFutureElectrical-Core)

diff --git a/Tests/Core/ModuleInstallerTests.cs b/Tests/Core/ModuleInstallerTests.cs
@@ -1118,5 +1118,62 @@ public void Replace_WithIncompatibleModule_Fails()
                                                registry.InstalledModules.Select(im => im.identifier).ToArray());
             }
         }
+
+        [TestCase]
+        public void Install_WithMatchedUnmanagedDll_Throws()
+        {
+            const string unmanaged = "GameData/DogeCoinPlugin.1.0.0.dll";
+            var kraken = Assert.Throws<DllLocationMismatchKraken>(() =>
+                installTestPlugin(unmanaged,
+                                  TestData.DogeCoinPlugin(),
+                                  TestData.DogeCoinPluginZip()));
+            Assert.AreEqual(unmanaged, kraken.path);
+        }
+
+        [TestCase]
+        public void Install_WithUnmatchedUnmanagedDll_DoesNotThrow()
+        {
+            Assert.DoesNotThrow(() => installTestPlugin("GameData/DogeCoinPlugin-1-0-0.dll",
+                                                        TestData.DogeCoinPlugin(),
+                                                        TestData.DogeCoinPluginZip()),
+                                "Unmanaged file must match identifier");
+            Assert.DoesNotThrow(() => installTestPlugin("GameData/DogeCoinPlugin.dll",
+                                                        TestData.DogeCoinPluginAddonFerram(),
+                                                        TestData.DogeCoinPluginAddonFerramZip()),
+                                "Managed file being installed must match identifier");
+        }
+
+        private void installTestPlugin(string unmanaged, string moduleJson, string zipPath)
+        {
+            // Arrange
+            using (var repo     = new TemporaryRepository(moduleJson))
+            using (var repoData = new TemporaryRepositoryData(nullUser, repo.repo))
+            using (var inst     = new DisposableKSP())
+            using (var config   = new FakeConfiguration(inst.KSP, inst.KSP.Name))
+            using (var manager  = new GameInstanceManager(nullUser, config)
+                {
+                    CurrentInstance = inst.KSP
+                })
+            {
+                var regMgr    = RegistryManager.Instance(manager.CurrentInstance,
+                                                         repoData.Manager);
+                var module    = CkanModule.FromJson(moduleJson);
+                var modules   = new List<CkanModule> { module };
+                var installer = new ModuleInstaller(inst.KSP, manager.Cache, nullUser);
+                File.WriteAllText(inst.KSP.ToAbsoluteGameDir(unmanaged),
+                                  "Not really a DLL, are we?");
+                regMgr.ScanUnmanagedFiles();
+                manager.Cache.Store(module, zipPath, new Progress<long>(bytes => {}));
+
+                // Act
+                HashSet<string> possibleConfigOnlyDirs = null;
+                new ModuleInstaller(inst.KSP, manager.Cache, nullUser)
+                    .InstallList(modules,
+                                 new RelationshipResolverOptions(),
+                                 regMgr,
+                                 ref possibleConfigOnlyDirs);
+            }
+        }
+
     }
 }
diff --git a/Tests/Data/DogeCoinPlugin.zip b/Tests/Data/DogeCoinPlugin.zip
diff --git a/Tests/Data/DogeCoinPluginAddonFerram.zip b/Tests/Data/DogeCoinPluginAddonFerram.zip
diff --git a/Tests/Data/TestData.cs b/Tests/Data/TestData.cs
@@ -46,13 +46,6 @@ public static string DogeCoinFlagZipWithExtras()
         public static string DogeCoinFlagZipCorrupt()
             => Path.Combine(DataDir(), "DogeCoinFlag-1.01-corrupt.zip");
 
-        /// <summary>
-        /// Adds a plugins directory to the DogeCoinFlag directory to test.
-        /// </summary>
-        /// <returns>The coin plugin.</returns>
-        public static string DogeCoinPluginZip()
-            => Path.Combine(DataDir(), "DogeCoinPlugin.zip");
-
         ///<summary>
         /// DogeCoinFlag 1.01 info. This doesn't contain any bugs.
         ///</summary>
@@ -339,8 +332,8 @@ public static string DogeCoinPlugin()
                     ""identifier"": ""DogeCoinPlugin"",
                     ""install"": [
                         {
-                        ""file"": ""GameData/DogeCoinFlag/plugin"",
-                        ""install_to"": ""GameData/DogeCoinFlag"",
+                        ""file"": ""GameData/DogeCoinPlugin/Plugins"",
+                        ""install_to"": ""GameData/DogeCoinPlugin"",
                         ""filter"" : [ ""Thumbs.db"", ""README.md"" ],
                         ""filter_regexp"" : ""\\.bak$""
                         }
@@ -357,10 +350,10 @@ public static string DogeCoinPlugin()
                     ""author"": ""politas"",
                     ""version"": ""1.01"",
                     ""download"": ""https://kerbalstuff.com/mod/269/Dogecoin%20Flag/download/1.01"",
-                    ""download_size"": 528,
+                    ""download_size"": 447,
                     ""download_hash"": {
-                        ""sha1"": ""8B4F4DD53E702E0C1D3FBCA1C9CB4E4027F50E8A"",
-                        ""sha256"": ""CEB1F30B8E1561EFD7F02D680407FE8FEC36B37AE073ABA8B06EEE05701F0EEF"",
+                        ""sha1"": ""9EC130C7D212DB664A97C28AFCA46CD186B73B3C"",
+                        ""sha256"": ""C7D787A875C92A0DCA5B7F0B8900F92F5FAE9DC23F2FDB95509B31420F209015"",
                     },
                     ""ksp_version"": ""0.25""
                 }
@@ -369,6 +362,54 @@ public static string DogeCoinPlugin()
         public static CkanModule DogeCoinPlugin_module()
             => CkanModule.FromJson(DogeCoinPlugin());
 
+        /// <summary>
+        /// Adds a plugins directory to the DogeCoinFlag directory to test.
+        /// </summary>
+        /// <returns>The coin plugin.</returns>
+        public static string DogeCoinPluginZip()
+            => Path.Combine(DataDir(), "DogeCoinPlugin.zip");
+
+        public static string DogeCoinPluginAddonFerram()
+            => @"
+                {
+                    ""spec_version"": ""v1.2"",
+                    ""identifier"": ""DogeCoinPlugin"",
+                    ""install"": [
+                        {
+                        ""file"": ""GameData/DogeCoinPlugin/Plugins"",
+                        ""install_to"": ""GameData/DogeCoinPlugin"",
+                        ""filter"" : [ ""Thumbs.db"", ""README.md"" ],
+                        ""filter_regexp"" : ""\\.bak$""
+                        }
+                    ],
+                    ""resources"": {
+                        ""kerbalstuff"": {
+                        ""url"": ""https://kerbalstuff.com/mod/269/Dogecoin%20Flag""
+                        },
+                        ""homepage"": ""https://www.reddit.com/r/dogecoin/comments/1tdlgg/i_made_a_more_accurate_dogecoin_and_a_ksp_flag/""
+                    },
+                    ""name"": ""Dogecoin Plugin Addon - Ferram"",
+                    ""license"": ""CC-BY"",
+                    ""abstract"": ""Such plugin. Very linkage. Dynamically Minmus! Wow!"",
+                    ""author"": ""politas"",
+                    ""version"": ""1.01"",
+                    ""download"": ""https://kerbalstuff.com/mod/269/Dogecoin%20Flag/download/1.01"",
+                    ""download_size"": 357,
+                    ""download_hash"": {
+                        ""sha1"": ""07B05B89258E0D17FF7586054F6CE486AA6FFB7D"",
+                        ""sha256"": ""568F4F2C8B3C6492CF63518272F0DF86E3FBC6A3ADBCC9EC3FD2B6457CC67053"",
+                    },
+                    ""ksp_version"": ""0.25""
+                }
+            ";
+
+        /// <summary>
+        /// Adds a plugins directory to the DogeCoinFlag directory to test.
+        /// </summary>
+        /// <returns>The coin plugin.</returns>
+        public static string DogeCoinPluginAddonFerramZip()
+            => Path.Combine(DataDir(), "DogeCoinPluginAddonFerram.zip");
+
         /// <summary>
         /// Taurus HCV pod, which seems to cause weird KS errors when the unescaped
         /// download string is used.