Loggers (#442)

* Log to file * Initialise logging * log file from commandline * log file name from settings file * fix * Stream logger * Write the message! * nulls in tests * static * Refactor for review
NuKeeperDotNet · Sep 24, 2018 · 71cc2a6 · 71cc2a6
1 parent c02b14d
commit 71cc2a6
Show file tree

Hide file tree

Showing 23 changed files with 197 additions and 69 deletions.
diff --git a/NuKeeper.Inspection/Logging/ConfigurableLogger.cs b/NuKeeper.Inspection/Logging/ConfigurableLogger.cs
@@ -0,0 +1,67 @@
+using System;
+
+namespace NuKeeper.Inspection.Logging
+{
+    public class ConfigurableLogger : INuKeeperLogger, IConfigureLogger
+    {
+        private IInternalLogger _inner;
+
+        public void Initialise(LogLevel logLevel, string filePath)
+        {
+            var destination = string.IsNullOrWhiteSpace(filePath) ?
+                LogDestination.Console :
+                LogDestination.File;
+
+            _inner = CreateLogger(logLevel, destination, filePath);
+        }
+
+        public void Error(string message, Exception ex)
+        {
+            CheckLoggerCreated();
+            _inner.Error(message, ex);
+        }
+
+        public void Minimal(string message)
+        {
+            CheckLoggerCreated();
+            _inner.Log(LogLevel.Minimal, message);
+        }
+
+        public void Normal(string message)
+        {
+            CheckLoggerCreated();
+            _inner.Log(LogLevel.Normal, message);
+        }
+
+        public void Detailed(string message)
+        {
+            CheckLoggerCreated();
+            _inner.Log(LogLevel.Detailed, message);
+        }
+
+        private void CheckLoggerCreated()
+        {
+            if (_inner == null)
+            {
+                _inner = CreateLogger(LogLevel.Detailed, LogDestination.Console, string.Empty);
+            }
+        }
+
+        private static IInternalLogger CreateLogger(
+            LogLevel logLevel, LogDestination destination,
+            string filePath)
+        {
+            switch (destination)
+            {
+                case LogDestination.Console:
+                    return new ConsoleLogger(logLevel);
+
+                case LogDestination.File:
+                    return new FileLogger(filePath, logLevel);
+
+                default:
+                    throw new Exception($"Unknown log destination {destination}");
+            }
+        }
+    }
+}
diff --git a/NuKeeper.Inspection/Logging/ConsoleLogger.cs b/NuKeeper.Inspection/Logging/ConsoleLogger.cs
@@ -2,11 +2,16 @@
 
 namespace NuKeeper.Inspection.Logging
 {
-    public class ConsoleLogger : INuKeeperLogger, IConfigureLogLevel
+    public class ConsoleLogger : IInternalLogger
     {
-        private LogLevel _logLevel = LogLevel.Normal;
+        private readonly LogLevel _logLevel;
 
-        public void Error(string message, Exception ex = null)
+        public ConsoleLogger(LogLevel logLevel)
+        {
+            _logLevel = logLevel;
+        }
+
+        public void Error(string message, Exception ex)
         {
             if (ex == null)
             {
@@ -22,32 +27,12 @@ public void Error(string message, Exception ex = null)
             }
         }
 
-        public void Minimal(string message)
-        {
-            LogWithLevel(message, LogLevel.Minimal);
-        }
-
-        public void Normal(string message)
-        {
-            LogWithLevel(message, LogLevel.Normal);
-        }
-
-        public void Detailed(string message)
-        {
-            LogWithLevel(message, LogLevel.Detailed);
-        }
-
-        private void LogWithLevel(string message, LogLevel level)
+        public void Log(LogLevel level, string message)
         {
             if (_logLevel >= level)
             {
                 Console.WriteLine(message);
             }
         }
-
-        void IConfigureLogLevel.SetLogLevel(LogLevel logLevel)
-        {
-            _logLevel = logLevel;
-        }
     }
 }
diff --git a/NuKeeper.Inspection/Logging/FileLogger.cs b/NuKeeper.Inspection/Logging/FileLogger.cs
@@ -0,0 +1,49 @@
+using System;
+using System.IO;
+
+namespace NuKeeper.Inspection.Logging
+{
+    public class FileLogger : IInternalLogger
+    {
+        private readonly string _filePath;
+        private readonly LogLevel _logLevel;
+
+        public FileLogger(string filePath, LogLevel logLevel)
+        {
+            _filePath = filePath;
+            _logLevel = logLevel;
+        }
+
+        public void Error(string message, Exception ex)
+        {
+            if (ex == null)
+            {
+                WriteMessageToFile(message);
+            }
+            else
+            {
+                Log(LogLevel.Quiet, $"{message} {ex.GetType().Name} : {ex.Message}");
+                if (_logLevel == LogLevel.Detailed)
+                {
+                    WriteMessageToFile(ex.StackTrace);
+                }
+            }
+        }
+
+        public void Log(LogLevel level, string message)
+        {
+            if (_logLevel >= level)
+            {
+                WriteMessageToFile(message);
+            }
+        }
+
+        private void WriteMessageToFile(string message)
+        {
+            using (var w = File.AppendText(_filePath))
+            {
+                w.WriteLine(message);
+            }
+        }
+    }
+}
diff --git a/NuKeeper.Inspection/Logging/IConfigureLogLevel.cs b/NuKeeper.Inspection/Logging/IConfigureLogLevel.cs
diff --git a/NuKeeper.Inspection/Logging/IConfigureLogger.cs b/NuKeeper.Inspection/Logging/IConfigureLogger.cs
@@ -0,0 +1,8 @@
+namespace NuKeeper.Inspection.Logging
+{
+
+    public interface IConfigureLogger
+    {
+        void Initialise(LogLevel logLevel, string filePath);
+    }
+}
diff --git a/NuKeeper.Inspection/Logging/IInternalLogger.cs b/NuKeeper.Inspection/Logging/IInternalLogger.cs
@@ -0,0 +1,10 @@
+using System;
+
+namespace NuKeeper.Inspection.Logging
+{
+    public interface IInternalLogger
+    {
+        void Error(string message, Exception ex);
+        void Log(LogLevel level, string message);
+    }
+}
diff --git a/NuKeeper.Inspection/Logging/LogDestination.cs b/NuKeeper.Inspection/Logging/LogDestination.cs
@@ -0,0 +1,8 @@
+namespace NuKeeper.Inspection.Logging
+{
+    public enum LogDestination
+    {
+        Console,
+        File
+    }
+}
diff --git a/NuKeeper.Tests/Commands/GlobalCommandTests.cs b/NuKeeper.Tests/Commands/GlobalCommandTests.cs
@@ -18,7 +18,7 @@ public class GlobalCommandTests
         public async Task ShouldCallEngineAndNotSucceedWithoutParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -37,7 +37,7 @@ await engine
         public async Task ShouldCallEngineAndSucceedWithRequiredGithubParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -198,7 +198,7 @@ public async Task WillReadMaxRepoFromFile()
 
         public async Task<SettingsContainer> CaptureSettings(FileSettings settingsIn)
         {
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             SettingsContainer settingsOut = null;

diff --git a/NuKeeper.Tests/Commands/InspectCommandTests.cs b/NuKeeper.Tests/Commands/InspectCommandTests.cs
@@ -18,7 +18,7 @@ public class InspectCommandTests
         public async Task ShouldCallEngineAndSucceed()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -104,7 +104,7 @@ public async Task WillReadIncludeExcludeFromFile()
         public async Task LogLevelIsNormalByDefault()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -115,14 +115,14 @@ public async Task LogLevelIsNormalByDefault()
 
             logger
                 .Received(1)
-                .SetLogLevel(LogLevel.Normal);
+                .Initialise(LogLevel.Normal, null);
         }
 
         [Test]
         public async Task ShouldSetLogLevelFromCommand()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -134,14 +134,14 @@ public async Task ShouldSetLogLevelFromCommand()
 
             logger
                 .Received(1)
-                .SetLogLevel(LogLevel.Minimal);
+                .Initialise(LogLevel.Minimal, null);
         }
 
         [Test]
         public async Task ShouldSetLogLevelFromFile()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             var settings = new FileSettings
@@ -157,14 +157,14 @@ public async Task ShouldSetLogLevelFromFile()
 
             logger
                 .Received(1)
-                .SetLogLevel(LogLevel.Detailed);
+                .Initialise(LogLevel.Detailed, null);
         }
 
         [Test]
         public async Task CommandLineLogLevelOverridesFile()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             var settings = new FileSettings
@@ -181,12 +181,12 @@ public async Task CommandLineLogLevelOverridesFile()
 
             logger
                 .Received(1)
-                .SetLogLevel(LogLevel.Minimal);
+                .Initialise(LogLevel.Minimal, null);
         }
 
         public async Task<SettingsContainer> CaptureSettings(FileSettings settingsIn)
         {
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             SettingsContainer settingsOut = null;

diff --git a/NuKeeper.Tests/Commands/OrganisationCommandTests.cs b/NuKeeper.Tests/Commands/OrganisationCommandTests.cs
@@ -18,7 +18,7 @@ public class OrganisationCommandTests
         public async Task ShouldCallEngineAndNotSucceedWithoutParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -37,7 +37,7 @@ await engine
         public async Task ShouldCallEngineAndSucceedWithRequiredGithubParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -236,7 +236,7 @@ public async Task<SettingsContainer> CaptureSettings(
             bool addCommandRepoExclude = false,
             int? maxRepo = null)
         {
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             SettingsContainer settingsOut = null;

diff --git a/NuKeeper.Tests/Commands/RepositoryCommandTests.cs b/NuKeeper.Tests/Commands/RepositoryCommandTests.cs
@@ -18,7 +18,7 @@ public class RepositoryCommandTests
         public async Task ShouldCallEngineAndNotSucceedWithoutParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -37,7 +37,7 @@ await engine
         public async Task ShouldCallEngineAndSucceedWithRequiredGithubParams()
         {
             var engine = Substitute.For<IGitHubEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -199,7 +199,7 @@ public async Task<SettingsContainer> CaptureSettings(FileSettings settingsIn,
             bool addLabels = false,
             int? maxPr = null)
         {
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             SettingsContainer settingsOut = null;

diff --git a/NuKeeper.Tests/Commands/UpdateCommandTests.cs b/NuKeeper.Tests/Commands/UpdateCommandTests.cs
@@ -18,7 +18,7 @@ public class UpdateCommandTests
         public async Task ShouldCallEngineAndSucceed()
         {
             var engine = Substitute.For<ILocalEngine>();
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             fileSettings.Get().Returns(FileSettings.Empty());
@@ -119,7 +119,7 @@ public async Task WillReadVersionChangeFromFile()
         public async Task<SettingsContainer> CaptureSettings(FileSettings settingsIn,
             VersionChange? change = null)
         {
-            var logger = Substitute.For<IConfigureLogLevel>();
+            var logger = Substitute.For<IConfigureLogger>();
             var fileSettings = Substitute.For<IFileSettingsCache>();
 
             SettingsContainer settingsOut = null;