Merge pull request #18 from nils-a/feature/GH-8

nils-a · web-flow · commit 2eaf3506b040 · 2021-06-18T23:32:07.000+02:00
(#8) added an internal logger
diff --git a/src/JavaVersionSwitcher.Tests/JavaHomeTests.cs b/src/JavaVersionSwitcher.Tests/JavaHomeTests.cs
@@ -1,14 +1,16 @@
 using System;
 using System.Threading.Tasks;
 using JavaVersionSwitcher.Adapters;
+using JavaVersionSwitcher.Logging;
+using Moq;
 using Shouldly;
 using Xunit;
 
 namespace JavaVersionSwitcher.Tests
 {
     public class JavaHomeTests
     {
-        private readonly JavaHomeAdapter _adapter = new JavaHomeAdapter();
+        private readonly JavaHomeAdapter _adapter = new JavaHomeAdapter(new Mock<ILogger>().Object);
 
         [Fact]
         public async Task Can_Set_per_process()
diff --git a/src/JavaVersionSwitcher.Tests/JavaVersionSwitcher.Tests.csproj b/src/JavaVersionSwitcher.Tests/JavaVersionSwitcher.Tests.csproj
@@ -7,6 +7,7 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.10.0" />
+    <PackageReference Include="Moq" Version="4.16.1" />
     <PackageReference Include="Shouldly" Version="4.0.3" />
     <PackageReference Include="xunit" Version="2.4.1" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.3">
diff --git a/src/JavaVersionSwitcher.Tests/PathTests.cs b/src/JavaVersionSwitcher.Tests/PathTests.cs
@@ -2,14 +2,16 @@
 using System.Linq;
 using System.Threading.Tasks;
 using JavaVersionSwitcher.Adapters;
+using JavaVersionSwitcher.Logging;
+using Moq;
 using Shouldly;
 using Xunit;
 
 namespace JavaVersionSwitcher.Tests
 {
     public class PathTests
     {
-        private readonly PathAdapter _adapter = new PathAdapter();
+        private readonly PathAdapter _adapter = new PathAdapter(new Mock<ILogger>().Object);
 
         [Fact]
         public async Task Can_Set_per_process()
diff --git a/src/JavaVersionSwitcher/Adapters/JavaHomeAdapter.cs b/src/JavaVersionSwitcher/Adapters/JavaHomeAdapter.cs
@@ -1,26 +1,32 @@
 ﻿using System.Threading.Tasks;
+using JavaVersionSwitcher.Logging;
 
 namespace JavaVersionSwitcher.Adapters
 {
     /// <inheritdoc cref="IJavaHomeAdapter"/>
     public class JavaHomeAdapter : IJavaHomeAdapter
     {
+        private readonly ILogger _logger;
         private readonly SimpleEnvironmentAdapter _adapter;
 
-        public JavaHomeAdapter()
+        public JavaHomeAdapter(ILogger logger)
         {
+            _logger = logger;
             _adapter = new SimpleEnvironmentAdapter("JAVA_HOME");
         }
 
         /// <inheritdoc cref="IJavaHomeAdapter.GetValue"/>
         public async Task<string> GetValue(EnvironmentScope scope)
         {
-            return await _adapter.GetValue(scope);
+            var val =await _adapter.GetValue(scope);
+            _logger.LogVerbose($"Read JAVA_HOME: {val}");
+            return val;
         }
 
         /// <inheritdoc cref="IJavaHomeAdapter.SetValue"/>
         public async Task SetValue(string value, EnvironmentScope scope)
         {
+            _logger.LogVerbose($"Setting JAVA_HOME to: {value}");
             await _adapter.SetValue(value, scope);
         }
     }
diff --git a/src/JavaVersionSwitcher/Adapters/JavaInstallationsAdapter.cs b/src/JavaVersionSwitcher/Adapters/JavaInstallationsAdapter.cs
@@ -6,6 +6,7 @@
 using System.Text;
 using System.Threading.Tasks;
 using System.Xml.Serialization;
+using JavaVersionSwitcher.Logging;
 using JavaVersionSwitcher.Models;
 using Spectre.Console;
 
@@ -14,6 +15,13 @@ namespace JavaVersionSwitcher.Adapters
     /// <inheritdoc cref="IJavaInstallationsAdapter"/>
     public class JavaInstallationsAdapter : IJavaInstallationsAdapter
     {
+        private readonly ILogger _logger;
+
+        public JavaInstallationsAdapter(ILogger logger)
+        {
+            _logger = logger;
+        }
+        
         /// <inheritdoc cref="IJavaInstallationsAdapter.GetJavaInstallations"/>
         public async Task<IEnumerable<JavaInstallation>> GetJavaInstallations(bool forceReScan = false)
         {
@@ -23,15 +31,22 @@ public async Task<IEnumerable<JavaInstallation>> GetJavaInstallations(bool force
                 {
                     return await LoadCacheData();
                 }
-                catch {/* TODO: Log?? */}
+                catch (Exception ex)
+                {
+                    _logger.LogVerbose($"{ex.GetType().Name} while reading cached data.");
+                }
             }
 
             var data = (await ForceScan()).ToList();
 
             try
             {
                 await SaveCacheData(data);
-            } catch {/* TODO: Log?? */}
+            } 
+            catch (Exception ex)
+            {
+                _logger.LogVerbose($"{ex.GetType().Name} while writing data cache.");
+            }
 
             return data;
         }
@@ -96,6 +111,9 @@ await AnsiConsole.Status()
                             Environment.ExpandEnvironmentVariables("%ProgramFiles(x86)%")
                         }.Distinct()
                         .Where(x => !string.IsNullOrEmpty(x));
+                    _logger.LogVerbose(
+                        $@"Scanning for installations in:{Environment.NewLine} - {string.Join($"{Environment.NewLine} - ", start)}");
+                    
                     var javaExeFiles = await FindFileRecursive(start);
                     foreach (var javaExeFile in javaExeFiles)
                     {
@@ -123,7 +141,6 @@ private Task<IEnumerable<string>> FindFileRecursive(IEnumerable<string> startPat
                 var results = new List<string>();
                 while (queue.TryDequeue(out var item))
                 {
-                    // log ? Console.WriteLine("Checking: "+item);
                     try
                     {
                         results.AddRange(Directory.GetFiles(item, "java.exe", SearchOption.TopDirectoryOnly));
@@ -133,9 +150,9 @@ private Task<IEnumerable<string>> FindFileRecursive(IEnumerable<string> startPat
                             queue.Enqueue(subfolder);
                         }
                     }
-                    catch
+                    catch (Exception ex)
                     {
-                        // log?!
+                        _logger.LogVerbose($"{ex.GetType().Name} while accessing {item}");
                     }
                 }
 
diff --git a/src/JavaVersionSwitcher/Adapters/PathAdapter.cs b/src/JavaVersionSwitcher/Adapters/PathAdapter.cs
@@ -2,16 +2,19 @@
 using System.Collections.Generic;
 using System.IO;
 using System.Threading.Tasks;
+using JavaVersionSwitcher.Logging;
 
 namespace JavaVersionSwitcher.Adapters
 {
     /// <inheritdoc cref="IPathAdapter"/>
     public class PathAdapter : IPathAdapter
     {
+        private readonly ILogger _logger;
         private readonly SimpleEnvironmentAdapter _adapter;
 
-        public PathAdapter()
+        public PathAdapter(ILogger logger)
         {
+            _logger = logger;
             _adapter = new SimpleEnvironmentAdapter("PATH");
         }
 
diff --git a/src/JavaVersionSwitcher/Commands/CheckSettingsCommand.cs b/src/JavaVersionSwitcher/Commands/CheckSettingsCommand.cs
@@ -3,6 +3,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using JavaVersionSwitcher.Adapters;
+using JavaVersionSwitcher.Logging;
 using JetBrains.Annotations;
 using Spectre.Console;
 using Spectre.Console.Cli;
@@ -15,20 +16,23 @@ internal sealed class CheckSettingsCommand : AsyncCommand<CheckSettingsCommand.S
         private readonly IJavaHomeAdapter _javaHomeAdapter;
         private readonly IJavaInstallationsAdapter _javaInstallationsAdapter;
         private readonly IPathAdapter _pathAdapter;
+        private readonly ILogger _logger;
 
         public CheckSettingsCommand(
             IJavaHomeAdapter javaHomeAdapter,
             IJavaInstallationsAdapter javaInstallationsAdapter,
-            IPathAdapter pathAdapter
+            IPathAdapter pathAdapter,
+            ILogger logger
         )
         {
             _javaHomeAdapter = javaHomeAdapter;
             _javaInstallationsAdapter = javaInstallationsAdapter;
             _pathAdapter = pathAdapter;
+            _logger = logger;
         }
         
         [UsedImplicitly]
-        public sealed class Settings : CommandSettings
+        public sealed class Settings : CommonCommandSettings
         {
             /*
              TODO: Implement
@@ -41,6 +45,7 @@ public sealed class Settings : CommandSettings
 
         public override async Task<int> ExecuteAsync(CommandContext context, Settings settings)
         {
+            _logger.PrintVerbose = settings.Verbose;
             var javaHome = await _javaHomeAdapter.GetValue(EnvironmentScope.Process);
             if (string.IsNullOrEmpty(javaHome))
             {
diff --git a/src/JavaVersionSwitcher/Commands/CommonCommandSettings.cs b/src/JavaVersionSwitcher/Commands/CommonCommandSettings.cs
@@ -0,0 +1,14 @@
+﻿using System.ComponentModel;
+using System.Threading.Tasks;
+using Spectre.Console.Cli;
+
+namespace JavaVersionSwitcher.Commands
+{
+    public abstract class CommonCommandSettings : CommandSettings
+    {
+        [CommandOption("--verbose")]
+        [Description("Show verbose messages.")]
+        [DefaultValue(false)]
+        public bool Verbose { get; set; }
+    }
+}
diff --git a/src/JavaVersionSwitcher/Commands/ScanJavaInstallationsCommand.cs b/src/JavaVersionSwitcher/Commands/ScanJavaInstallationsCommand.cs
@@ -2,6 +2,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using JavaVersionSwitcher.Adapters;
+using JavaVersionSwitcher.Logging;
 using JetBrains.Annotations;
 using Spectre.Console;
 using Spectre.Console.Cli;
@@ -12,15 +13,18 @@ namespace JavaVersionSwitcher.Commands
     internal sealed class ScanJavaInstallationsCommand : AsyncCommand<ScanJavaInstallationsCommand.Settings>
     {
         private readonly IJavaInstallationsAdapter _javaInstallationsAdapter;
+        private readonly ILogger _logger;
 
         public ScanJavaInstallationsCommand(
-            IJavaInstallationsAdapter javaInstallationsAdapter)
+            IJavaInstallationsAdapter javaInstallationsAdapter,
+            ILogger logger)
         {
             _javaInstallationsAdapter = javaInstallationsAdapter;
+            _logger = logger;
         }
         
         [UsedImplicitly]
-        public sealed class Settings : CommandSettings
+        public sealed class Settings : CommonCommandSettings
         {
             [CommandOption("--force")]
             [DefaultValue(false)]
@@ -30,6 +34,7 @@ public sealed class Settings : CommandSettings
 
         public override async Task<int> ExecuteAsync(CommandContext context, Settings settings)
         {
+            _logger.PrintVerbose = settings.Verbose;
             var installations = await _javaInstallationsAdapter
                 .GetJavaInstallations(settings.Force)
                 .ConfigureAwait(false);
diff --git a/src/JavaVersionSwitcher/Commands/SwitchVersionCommand.cs b/src/JavaVersionSwitcher/Commands/SwitchVersionCommand.cs
@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using JavaVersionSwitcher.Adapters;
+using JavaVersionSwitcher.Logging;
 using JetBrains.Annotations;
 using Spectre.Console;
 using Spectre.Console.Cli;
@@ -16,20 +17,23 @@ internal sealed class SwitchVersionCommand : AsyncCommand<SwitchVersionCommand.S
         private readonly IJavaHomeAdapter _javaHomeAdapter;
         private readonly IJavaInstallationsAdapter _javaInstallationsAdapter;
         private readonly IPathAdapter _pathAdapter;
+        private readonly ILogger _logger;
 
         public SwitchVersionCommand(
             IJavaHomeAdapter javaHomeAdapter,
             IJavaInstallationsAdapter javaInstallationsAdapter,
-            IPathAdapter pathAdapter
+            IPathAdapter pathAdapter,
+            ILogger logger
         )
         {
             _javaHomeAdapter = javaHomeAdapter;
             _javaInstallationsAdapter = javaInstallationsAdapter;
             _pathAdapter = pathAdapter;
+            _logger = logger;
         }
         
         [UsedImplicitly]
-        public sealed class Settings : CommandSettings
+        public sealed class Settings : CommonCommandSettings
         {
             [CommandOption("--machine")]
             [DefaultValue(false)]
@@ -39,6 +43,7 @@ public sealed class Settings : CommandSettings
 
         public override async Task<int> ExecuteAsync(CommandContext context, Settings settings)
         {
+            _logger.PrintVerbose = settings.Verbose;
             var installations = await _javaInstallationsAdapter
                 .GetJavaInstallations()
                 .ConfigureAwait(false);
diff --git a/src/JavaVersionSwitcher/Logging/ILogger.cs b/src/JavaVersionSwitcher/Logging/ILogger.cs
@@ -0,0 +1,21 @@
+﻿namespace JavaVersionSwitcher.Logging
+{
+    /// <summary>
+    /// The internal logger
+    /// </summary>
+    public interface ILogger
+    {
+        /// <summary>
+        /// Verbose messages will be printed,
+        /// only if this is set to <c>true</c>
+        /// </summary>
+        bool PrintVerbose { get; set; }
+        
+        /// <summary>
+        /// Log a verbose message.
+        /// See also <see cref="PrintVerbose"/>.
+        /// </summary>
+        /// <param name="text">The text to print.</param>
+        void LogVerbose(string text);
+    }
+}
diff --git a/src/JavaVersionSwitcher/Logging/Logger.cs b/src/JavaVersionSwitcher/Logging/Logger.cs
@@ -0,0 +1,19 @@
+﻿using Spectre.Console;
+
+namespace JavaVersionSwitcher.Logging
+{
+    public class Logger : ILogger
+    {
+        public bool PrintVerbose { get; set; }
+        
+        public void LogVerbose(string text)
+        {
+            if (!PrintVerbose)
+            {
+                return;
+            }
+            
+            AnsiConsole.MarkupLine($"[gray]{text}[/]");
+        }
+    }
+}
diff --git a/src/JavaVersionSwitcher/Program.cs b/src/JavaVersionSwitcher/Program.cs
@@ -1,5 +1,6 @@
 ﻿using JavaVersionSwitcher.Adapters;
 using JavaVersionSwitcher.Commands;
+using JavaVersionSwitcher.Logging;
 using JetBrains.Annotations;
 using SimpleInjector;
 using Spectre.Console.Cli;
@@ -27,7 +28,10 @@ private static int Main(string[] args)
                 config.AddCommand<SwitchVersionCommand>("switch")
                     .WithDescription("Switch to a different Java version.");
 
+#if DEBUG
+                config.PropagateExceptions();
                 config.ValidateExamples();
+#endif
             });
             
             return app.Run(args);
@@ -36,6 +40,7 @@ private static int Main(string[] args)
         private static ITypeRegistrar BuildRegistrar()
         {
             var container = new Container();
+            container.Register<ILogger, Logger>(Lifestyle.Singleton);
             container.Register<IJavaHomeAdapter, JavaHomeAdapter>(Lifestyle.Singleton);
             container.Register<IPathAdapter, PathAdapter>(Lifestyle.Singleton);
             container.Register<IJavaInstallationsAdapter, JavaInstallationsAdapter>(Lifestyle.Singleton);

Original file line number	Diff line number	Diff line change
`@@ -1,26 +1,32 @@`
`1`	`1`	`using System.Threading.Tasks;`
	`2`	`+using JavaVersionSwitcher.Logging;`
`2`	`3`
`3`	`4`	`namespace JavaVersionSwitcher.Adapters`
`4`	`5`	`{`
`5`	`6`	`/// <inheritdoc cref="IJavaHomeAdapter"/>`
`6`	`7`	`public class JavaHomeAdapter : IJavaHomeAdapter`
`7`	`8`	`{`
	`9`	`+ private readonly ILogger _logger;`
`8`	`10`	`private readonly SimpleEnvironmentAdapter _adapter;`
`9`	`11`
`10`		`- public JavaHomeAdapter()`
	`12`	`+ public JavaHomeAdapter(ILogger logger)`
`11`	`13`	`{`
	`14`	`+ _logger = logger;`
`12`	`15`	`_adapter = new SimpleEnvironmentAdapter("JAVA_HOME");`
`13`	`16`	`}`
`14`	`17`
`15`	`18`	`/// <inheritdoc cref="IJavaHomeAdapter.GetValue"/>`
`16`	`19`	`public async Task<string> GetValue(EnvironmentScope scope)`
`17`	`20`	`{`
`18`		`- return await _adapter.GetValue(scope);`
	`21`	`+ var val =await _adapter.GetValue(scope);`
	`22`	`+ _logger.LogVerbose($"Read JAVA_HOME: {val}");`
	`23`	`+ return val;`
`19`	`24`	`}`
`20`	`25`
`21`	`26`	`/// <inheritdoc cref="IJavaHomeAdapter.SetValue"/>`
`22`	`27`	`public async Task SetValue(string value, EnvironmentScope scope)`
`23`	`28`	`{`
	`29`	`+ _logger.LogVerbose($"Setting JAVA_HOME to: {value}");`
`24`	`30`	`await _adapter.SetValue(value, scope);`
`25`	`31`	`}`
`26`	`32`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,7 @@`
`6`	`6`	`using System.Text;`
`7`	`7`	`using System.Threading.Tasks;`
`8`	`8`	`using System.Xml.Serialization;`
	`9`	`+using JavaVersionSwitcher.Logging;`
`9`	`10`	`using JavaVersionSwitcher.Models;`
`10`	`11`	`using Spectre.Console;`
`11`	`12`
`@@ -14,6 +15,13 @@ namespace JavaVersionSwitcher.Adapters`
`14`	`15`	`/// <inheritdoc cref="IJavaInstallationsAdapter"/>`
`15`	`16`	`public class JavaInstallationsAdapter : IJavaInstallationsAdapter`
`16`	`17`	`{`
	`18`	`+ private readonly ILogger _logger;`
	`19`	`+`
	`20`	`+ public JavaInstallationsAdapter(ILogger logger)`
	`21`	`+ {`
	`22`	`+ _logger = logger;`
	`23`	`+ }`
	`24`	`+`
`17`	`25`	`/// <inheritdoc cref="IJavaInstallationsAdapter.GetJavaInstallations"/>`
`18`	`26`	`public async Task<IEnumerable<JavaInstallation>> GetJavaInstallations(bool forceReScan = false)`
`19`	`27`	`{`
`@@ -23,15 +31,22 @@ public async Task<IEnumerable<JavaInstallation>> GetJavaInstallations(bool force`
`23`	`31`	`{`
`24`	`32`	`return await LoadCacheData();`
`25`	`33`	`}`
`26`		`- catch {/* TODO: Log?? */}`
	`34`	`+ catch (Exception ex)`
	`35`	`+ {`
	`36`	`+ _logger.LogVerbose($"{ex.GetType().Name} while reading cached data.");`
	`37`	`+ }`
`27`	`38`	`}`
`28`	`39`
`29`	`40`	`var data = (await ForceScan()).ToList();`
`30`	`41`
`31`	`42`	`try`
`32`	`43`	`{`
`33`	`44`	`await SaveCacheData(data);`
`34`		`- } catch {/* TODO: Log?? */}`
	`45`	`+ }`
	`46`	`+ catch (Exception ex)`
	`47`	`+ {`
	`48`	`+ _logger.LogVerbose($"{ex.GetType().Name} while writing data cache.");`
	`49`	`+ }`
`35`	`50`
`36`	`51`	`return data;`
`37`	`52`	`}`
`@@ -96,6 +111,9 @@ await AnsiConsole.Status()`
`96`	`111`	`Environment.ExpandEnvironmentVariables("%ProgramFiles(x86)%")`
`97`	`112`	`}.Distinct()`
`98`	`113`	`.Where(x => !string.IsNullOrEmpty(x));`
	`114`	`+ _logger.LogVerbose(`
	`115`	`+ $@"Scanning for installations in:{Environment.NewLine} - {string.Join($"{Environment.NewLine} - ", start)}");`
	`116`	`+`
`99`	`117`	`var javaExeFiles = await FindFileRecursive(start);`
`100`	`118`	`foreach (var javaExeFile in javaExeFiles)`
`101`	`119`	`{`
`@@ -123,7 +141,6 @@ private Task<IEnumerable<string>> FindFileRecursive(IEnumerable<string> startPat`
`123`	`141`	`var results = new List<string>();`
`124`	`142`	`while (queue.TryDequeue(out var item))`
`125`	`143`	`{`
`126`		`- // log ? Console.WriteLine("Checking: "+item);`
`127`	`144`	`try`
`128`	`145`	`{`
`129`	`146`	`results.AddRange(Directory.GetFiles(item, "java.exe", SearchOption.TopDirectoryOnly));`
`@@ -133,9 +150,9 @@ private Task<IEnumerable<string>> FindFileRecursive(IEnumerable<string> startPat`
`133`	`150`	`queue.Enqueue(subfolder);`
`134`	`151`	`}`
`135`	`152`	`}`
`136`		`- catch`
	`153`	`+ catch (Exception ex)`
`137`	`154`	`{`
`138`		`- // log?!`
	`155`	`+ _logger.LogVerbose($"{ex.GetType().Name} while accessing {item}");`
`139`	`156`	`}`
`140`	`157`	`}`
`141`	`158`
Original file line number	Diff line number	Diff line change
`@@ -2,16 +2,19 @@`
`2`	`2`	`using System.Collections.Generic;`
`3`	`3`	`using System.IO;`
`4`	`4`	`using System.Threading.Tasks;`
	`5`	`+using JavaVersionSwitcher.Logging;`
`5`	`6`
`6`	`7`	`namespace JavaVersionSwitcher.Adapters`
`7`	`8`	`{`
`8`	`9`	`/// <inheritdoc cref="IPathAdapter"/>`
`9`	`10`	`public class PathAdapter : IPathAdapter`
`10`	`11`	`{`
	`12`	`+ private readonly ILogger _logger;`
`11`	`13`	`private readonly SimpleEnvironmentAdapter _adapter;`
`12`	`14`
`13`		`- public PathAdapter()`
	`15`	`+ public PathAdapter(ILogger logger)`
`14`	`16`	`{`
	`17`	`+ _logger = logger;`
`15`	`18`	`_adapter = new SimpleEnvironmentAdapter("PATH");`
`16`	`19`	`}`
`17`	`20`