Merge pull request #169 from nils-a/feature/GH-167

(#167) add a check of the registry

Author: nils-a

src/JavaVersionSwitcher/Adapters/IRegistryAdapter.cs

@@ -4,5 +4,14 @@ namespace JavaVersionSwitcher.Adapters;
 
 public interface IRegistryAdapter
 {
-    IAsyncEnumerable<string> GetInstallationPaths();
+    IAsyncEnumerable<IJavaRegistryRegistration> GetInstallations();
+}
+
+public interface IJavaRegistryRegistration
+{
+    string RegKey { get; }
+    
+    string InstallationPath { get; }
+    
+    string Version { get; }
 }

src/JavaVersionSwitcher/Adapters/RegistryAdapter.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Runtime.InteropServices;
 using System.Threading.Tasks;
@@ -22,7 +23,7 @@ private static Task<AsyncRegistryKey> GetHklmAsync()
         return AsyncRegistryKey.Hklm;
     }
 
-    internal class AsyncRegistryKey
+    internal class AsyncRegistryKey : IDisposable
     {
 #pragma warning disable CA1416
         private readonly RegistryKey _key;
@@ -70,19 +71,24 @@ public override string ToString()
         {
             return _key.ToString();
         }
+
+        public void Dispose()
+        {
+            _key?.Dispose();
+        }
 #pragma warning restore CA1416
     }
 
-    public async IAsyncEnumerable<string> GetInstallationPaths()
+    public async IAsyncEnumerable<IJavaRegistryRegistration> GetInstallations()
     {
-        var localMachine = await GetHklmAsync();
+        using var localMachine = await GetHklmAsync();
         if (localMachine == null)
         {
             _logger.LogVerbose($"Not Checking the registry, since we're running on {RuntimeInformation.RuntimeIdentifier}");
             yield break;
         }
 
-        var javaSoft = await localMachine.OpenSubKey("SOFTWARE\\JavaSoft");
+        using var javaSoft = await localMachine.OpenSubKey("SOFTWARE\\JavaSoft");
         if (javaSoft == null)
         {
             _logger.LogWarning(@"RegKey 'HKLM\Software\JavaSoft' does not exist.");
@@ -99,20 +105,20 @@ public async IAsyncEnumerable<string> GetInstallationPaths()
 
         foreach (var root in roots)
         {
-            var rootKey = await javaSoft.OpenSubKey(root);
+            using var rootKey = await javaSoft.OpenSubKey(root);
             if (rootKey == null)
             {
                 continue;
             }
-            
-            var keyNames = await rootKey.GetSubKeyNames();
-            foreach (var name in keyNames)
+
+            var versions = await rootKey.GetSubKeyNames();
+            foreach (var javaVersion in versions)
             {
-                _logger.LogVerbose($"Checking SubKey: {rootKey}\\{name}");
-                var key = await rootKey.OpenSubKey(name);
+                _logger.LogVerbose($"Checking SubKey: {rootKey}\\{javaVersion}");
+                using var key = await rootKey.OpenSubKey(javaVersion);
                 if (key == null)
                 {
-                    _logger.LogWarning($"SubKey '{rootKey}\\{name}' was reported to exist, but it does not.");
+                    _logger.LogWarning($"SubKey '{rootKey}\\{javaVersion}' was reported to exist, but it does not.");
                     continue;
                 }
 
@@ -121,8 +127,20 @@ public async IAsyncEnumerable<string> GetInstallationPaths()
                     continue;
                 }
 
-                yield return javaHome;
+                yield return new JavaRegistryRegistration
+                {
+                    RegKey = key.ToString(),
+                    InstallationPath = javaHome,
+                    Version = javaVersion,
+                };
             }
         }
     }
+
+    private class JavaRegistryRegistration : IJavaRegistryRegistration
+    {
+        public string RegKey { get; init; }
+        public string InstallationPath { get; init; }
+        public string Version { get; init; }
+    }
 }

src/JavaVersionSwitcher/Commands/CheckSettingsCommand.cs

@@ -94,17 +94,19 @@ public override async Task<int> ExecuteAsync(CommandContext context, Settings se
             }
         }
 
-        await foreach (var path in _registryAdapter.GetInstallationPaths())
+        await foreach (var installation in _registryAdapter.GetInstallations())
         {
-            var binPath = Path.Combine(path, "bin", "java.exe");
+            var binPath = Path.Combine(installation.InstallationPath, "bin", "java.exe");
             if (File.Exists(binPath))
             {
                 continue;
             }
 
             var warn =
-                $"Path for java installation '{path}' set in  Windows Registry. But does not contain a java executable!";
+                $@"Path for java installation '{installation.InstallationPath}' set in  Windows Registry. But does not contain a java executable!
+    You should probably remove the RegKey {installation.RegKey}";
             _console.MarkupLine($"[red]{warn}[/]");
+            errors = true;
         }
 
         if (errors)

src/JavaVersionSwitcher/JavaVersionSwitcher.csproj

@@ -36,6 +36,10 @@
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="IDisposableAnalyzers" Version="4.0.7">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
     <PackageReference Include="JetBrains.Annotations" Version="2023.2.0" />
     <PackageReference Include="Microsoft.Win32.Registry" Version="6.0.0-preview.5.21301.5" />
     <PackageReference Include="Microsoft.Windows.Compatibility" Version="7.0.5" />