SNOW-856231 Enable easy logging

snowflakedb · Sep 14, 2023 · dab63ae · dab63ae
1 parent 2f24377
commit dab63ae
Show file tree

Hide file tree

Showing 27 changed files with 838 additions and 104 deletions.
diff --git a/README.md b/README.md
diff --git a/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigFinderTest.cs b/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigFinderTest.cs
@@ -1,8 +1,13 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
 using System;
 using System.IO;
 using Moq;
 using NUnit.Framework;
 using Snowflake.Data.Configuration;
+using Snowflake.Data.Core.Tools;
 
 namespace Snowflake.Data.Tests.UnitTests.Configuration
 {

diff --git a/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigGenerator.cs b/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigGenerator.cs
@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
 using System.IO;
 
 namespace Snowflake.Data.Tests.UnitTests.Configuration

diff --git a/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigParserTest.cs b/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigParserTest.cs
@@ -1,3 +1,8 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
+using System;
 using System.Collections.Generic;
 using System.IO;
 using NUnit.Framework;
@@ -6,7 +11,7 @@
 
 namespace Snowflake.Data.Tests.UnitTests.Configuration
 {
-    [TestFixture]
+    [TestFixture, NonParallelizable]
     public class EasyLoggingConfigParserTest
     {
         private const string NotExistingFilePath = "../../../Resources/EasyLogging/not_existing_config.json";
@@ -45,32 +50,72 @@ public void TestThatParsesConfigFile()
             Assert.AreEqual(LogPath, config.CommonProps.LogPath);
         }
 
-        [Test]
-        public void TestThatReturnsNullIfFileDoesNotExist(
-            [Values(null, "", NotExistingFilePath)]
-            string notExistingFilePath)
+        [Test, TestCaseSource(nameof(ConfigFilesWithoutValues))]
+        public void TestThatParsesConfigFileWithNullValues(string filePath)
         {
             // arrange
             var parser = new EasyLoggingConfigParser();
 
             // act
-            var config = parser.Parse(notExistingFilePath);
+            var config = parser.Parse(filePath);
+
+            // assert
+            Assert.IsNotNull(config);
+            Assert.IsNotNull(config.CommonProps);
+            Assert.IsNull(config.CommonProps.LogLevel);
+            Assert.IsNull(config.CommonProps.LogPath);            
+        }
 
+        [Test]
+        [TestCase(null)]
+        [TestCase("")]
+        public void TestThatReturnsNullWhenNothingToParse(string noFilePath)
+        {
+            // arrange
+            var parser = new EasyLoggingConfigParser();
+
+            // act
+            var config = parser.Parse(noFilePath);
+
             // assert
             Assert.IsNull(config);
         }
+
+        [Test]
+        public void TestThatFailsWhenTheFileDoesNotExist()
+        {
+            // arrange
+            var parser = new EasyLoggingConfigParser();
+
+            // act
+            var thrown = Assert.Throws<Exception>(() => parser.Parse(NotExistingFilePath));
+
+            // assert
+            Assert.IsNotNull(thrown);
+            Assert.IsTrue(thrown.Message == "Finding easy logging configuration failed");
+        }
 
         [Test, TestCaseSource(nameof(WrongConfigFiles))]
-        public void TestThatReturnsNullIfMissingOrInvalidRequiredFields(string filePath)
+        public void TestThatFailsIfMissingOrInvalidRequiredFields(string filePath)
         {
             // arrange
             var parser = new EasyLoggingConfigParser();
 
             // act
-            var config = parser.Parse(filePath);
-
+            var thrown = Assert.Throws<Exception>(() => parser.Parse(filePath));
             // assert
-            Assert.IsNull(config);
+            Assert.IsNotNull(thrown);
+            Assert.IsTrue(thrown.Message == "Parsing easy logging configuration failed");
+        }
+
+        public static IEnumerable<string> ConfigFilesWithoutValues()
+        {
+            BeforeAll();
+            return new[]
+            {
+                CreateConfigTempFile(EmptyCommonConfig),
+                CreateConfigTempFile(Config(null, null))
+            };
         }
 
         public static IEnumerable<string> WrongConfigFiles()
@@ -79,9 +124,6 @@ public static IEnumerable<string> WrongConfigFiles()
             return new[]
             {
                 CreateConfigTempFile(EmptyConfig),
-                CreateConfigTempFile(EmptyCommonConfig),
-                CreateConfigTempFile(Config(null, LogPath)),
-                CreateConfigTempFile(Config(LogLevel, null)),
                 CreateConfigTempFile(Config("unknown", LogPath)),
             };
         }

diff --git a/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigProviderTest.cs b/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingConfigProviderTest.cs
@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
 using Moq;
 using NUnit.Framework;
 using Snowflake.Data.Configuration;
@@ -17,7 +21,7 @@ public void TestThatProvidesConfiguration()
             var configFinder = new Mock<EasyLoggingConfigFinder>();
             var configParser = new Mock<EasyLoggingConfigParser>();
             var configProvider = new EasyLoggingConfigProvider(configFinder.Object, configParser.Object);
-            var config = new EasyLoggingConfig();
+            var config = new ClientConfig();
             configFinder
                 .Setup(finder => finder.FindConfigFilePath(FilePathFromConnectionString))
                 .Returns(FilePathToUse);

diff --git a/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingLogLevelTest.cs b/Snowflake.Data.Tests/UnitTests/Configuration/EasyLoggingLogLevelTest.cs
@@ -1,3 +1,7 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
 using System;
 using NUnit.Framework;
 using Snowflake.Data.Configuration;

diff --git a/Snowflake.Data.Tests/UnitTests/Logger/EasyLoggerManagerTest.cs b/Snowflake.Data.Tests/UnitTests/Logger/EasyLoggerManagerTest.cs
@@ -0,0 +1,117 @@
+/*
+ * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
+ */
+
+using System;
+using System.IO;
+using System.Linq;
+using NUnit.Framework;
+using Snowflake.Data.Configuration;
+using Snowflake.Data.Core;
+using Snowflake.Data.Log;
+
+namespace Snowflake.Data.Tests.UnitTests.Logger
+{
+    [TestFixture, NonParallelizable]
+    public class EasyLoggerManagerTest
+    {
+
+        private const string InfoMessage = "Easy logging Info message";
+        private const string DebugMessage = "Easy logging Debug message";
+        private const string WarnMessage = "Easy logging Warn message";
+        private const string ErrorMessage = "Easy logging Error message";
+        private const string FatalMessage = "Easy logging Fatal message";
+        private static readonly string s_logsDirectory = Path.GetTempPath();
+
+        [ThreadStatic]
+        private static string t_directoryLogPath;
+
+        [OneTimeTearDown]
+        public static void CleanUp()
+        {
+            RemoveEasyLoggingLogFiles();
+        }
+
+        [SetUp]
+        public void BeforeEach()
+        {
+            t_directoryLogPath = RandomLogsDirectoryPath();
+        }
+
+        [TearDown]
+        public void AfterEach()
+        {
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Warn, t_directoryLogPath);
+        }
+
+        [Test]
+        public void TestThatChangesLogLevel()
+        {
+            // arrange
+            var logger = SFLoggerFactory.GetLogger<SFBlockingChunkDownloaderV3>();
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Warn, t_directoryLogPath);
+
+            // assert
+            Assert.IsFalse(logger.IsDebugEnabled());
+            Assert.IsFalse(logger.IsInfoEnabled());
+            Assert.IsTrue(logger.IsWarnEnabled());
+            Assert.IsTrue(logger.IsErrorEnabled());
+            Assert.IsTrue(logger.IsFatalEnabled());
+
+            // act
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Debug, t_directoryLogPath);
+
+            // assert
+            Assert.IsTrue(logger.IsDebugEnabled());
+            Assert.IsTrue(logger.IsInfoEnabled());
+            Assert.IsTrue(logger.IsWarnEnabled());
+            Assert.IsTrue(logger.IsErrorEnabled());
+            Assert.IsTrue(logger.IsFatalEnabled());
+        }
+
+        [Test]
+        public void TestThatLogsToProperFileWithProperLogLevelOnly()
+        {
+            // arrange
+            var logger = SFLoggerFactory.GetLogger<SFBlockingChunkDownloaderV3>();
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Info, t_directoryLogPath);
+
+            // act
+            logger.Info(InfoMessage);
+            logger.Debug(DebugMessage);
+            logger.Warn(WarnMessage);
+            logger.Error(ErrorMessage);
+            logger.Fatal(FatalMessage);
+
+            // assert
+            var logLines = File.ReadLines(FindLogFilePath(t_directoryLogPath));
+            Assert.That(logLines, Has.Exactly(1).Matches<string>(s => s.Contains(InfoMessage)));
+            Assert.That(logLines, Has.Exactly(1).Matches<string>(s => s.Contains(WarnMessage)));
+            Assert.That(logLines, Has.Exactly(0).Matches<string>(s => s.Contains(DebugMessage)));
+            Assert.That(logLines, Has.Exactly(1).Matches<string>(s => s.Contains(ErrorMessage)));
+            Assert.That(logLines, Has.Exactly(1).Matches<string>(s => s.Contains(FatalMessage)));
+        }
+
+        private static string RandomLogsDirectoryPath()
+        {
+            var randomName = Path.GetRandomFileName();
+            return Path.Combine(s_logsDirectory, $"easy_logging_logs_{randomName}", "dotnet");
+        }
+
+        private static string FindLogFilePath(string directoryLogPath)
+        {
+            Assert.IsTrue(Directory.Exists(directoryLogPath));
+            var files = Directory.GetFiles(directoryLogPath);
+            Assert.AreEqual(1, files.Length);
+            return files.First();
+        }
+
+        private static void RemoveEasyLoggingLogFiles()
+        {
+            Directory.GetFiles(s_logsDirectory)
+                .Where(filePath => filePath.StartsWith(Path.Combine(s_logsDirectory, "easy_logging_logs")))
+                .AsParallel()
+                .ForAll(filePath => File.Delete(filePath));
+        }
+    }
+}
diff --git a/...lake.Data.Tests/UnitTests/SFLoggerTest.cs → ...ta.Tests/UnitTests/Logger/SFLoggerTest.cs b/...lake.Data.Tests/UnitTests/SFLoggerTest.cs → ...ta.Tests/UnitTests/Logger/SFLoggerTest.cs
@@ -2,29 +2,32 @@
  * Copyright (c) 2023 Snowflake Computing Inc. All rights reserved.
  */
 
+using Snowflake.Data.Configuration;
+
 namespace Snowflake.Data.Tests.UnitTests
 {
-    using log4net.Repository.Hierarchy;
-    using log4net;
     using NUnit.Framework;
     using Snowflake.Data.Log;
-    using log4net.Core;
-    using System;
-
-    [TestFixture]
+
+    [TestFixture, NonParallelizable]
     class SFLoggerTest
     {
         SFLogger _logger;
 
         [OneTimeSetUp]
-        public void BeforeTest()
+        public static void BeforeTest()
         {
             // Log level defaults to Warn on net6.0 builds in github actions
             // Set the root level to Debug
-            ((Hierarchy)LogManager.GetRepository()).Root.Level = Level.Debug;
-            ((Hierarchy)LogManager.GetRepository()).RaiseConfigurationChanged(EventArgs.Empty);
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Debug, "STDOUT");
         }
 
+        [OneTimeTearDown]
+        public static void AfterAll()
+        {
+            EasyLoggerManager.Instance.ReconfigureEasyLogging(EasyLoggingLogLevel.Warn, "STDOUT");
+        }
+
         [TearDown] public void AfterTest()
         {
             // Return to default setting

diff --git a/Snowflake.Data.Tests/UnitTests/SFSessionTest.cs b/Snowflake.Data.Tests/UnitTests/SFSessionTest.cs
@@ -2,6 +2,9 @@
  * Copyright (c) 2012-2019 Snowflake Computing Inc. All rights reserved.
  */
 
+using Snowflake.Data.Configuration;
+using Snowflake.Data.Log;
+
 namespace Snowflake.Data.Tests.UnitTests
 {
     using Snowflake.Data.Core;
@@ -33,5 +36,23 @@ public void TestUpdateDatabaseAndSchema()
             Assert.AreEqual(schemaName, sfSession.schema);
         }
 
+        [Test]
+        [TestCase(null)]
+        [TestCase("/some-path/config.json")]
+        public void TestThatConfiguresEasyLogging(string configPath)
+        {
+            // arrange
+            var easyLoggingStarter = new Moq.Mock<EasyLoggingStarter>();
+            var simpleConnectionString = "account=test;user=test;password=test;";
+            var connectionString = configPath == null
+                ? simpleConnectionString
+                : $"{simpleConnectionString}client_config_file={configPath};";
+
+            // act
+            new SFSession(connectionString, null, easyLoggingStarter.Object);
+
+            // assert
+            easyLoggingStarter.Verify(starter => starter.Init(configPath));
+        }
     }
 }