- Add minLogLevel param to CLog.Init()

- Add tests for CLog

Tests/Tests.csproj

@@ -65,6 +65,15 @@
   </ItemGroup>
   <ItemGroup>
     <Compile Include="PartyModeChallenge\CPartyModeChallangeTest.cs" />
+    <Content Include="VocaluxeLib\Log\CLogTest.tt">
+      <Generator>TextTemplatingFileGenerator</Generator>
+      <LastGenOutput>CLogTest.cs</LastGenOutput>
+    </Content>
+    <Compile Include="VocaluxeLib\Log\CLogTest.cs">
+      <AutoGen>True</AutoGen>
+      <DesignTime>True</DesignTime>
+      <DependentUpon>CLogTest.tt</DependentUpon>
+    </Compile>
     <Compile Include="VocaluxeLib\Log\Rolling\CLogFileRollerTest.cs" />
     <Compile Include="VocaluxeLib\Utils\Combinatorics\CCombinationsTest.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
@@ -76,6 +85,7 @@
     </None>
   </ItemGroup>
   <ItemGroup>
+    <Service Include="{508349B6-6B84-4DF5-91F0-309BEEBAD82D}" />
     <Service Include="{82A7F48D-3B50-4B1E-B82E-3ADA8210C358}" />
   </ItemGroup>
   <ItemGroup>

Tests/VocaluxeLib/Log/CLogTest.tt

@@ -0,0 +1,158 @@
+<#
+// This file is part of Vocaluxe.
+// 
+// Vocaluxe is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Vocaluxe is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
+#>
+<#@ template debug="false" hostspecific="false" language="C#" #>
+<#@ assembly name="System.Core" #>
+<#@ import namespace="System.Linq" #>
+<#@ import namespace="System.Text" #>
+<#@ import namespace="System.Collections.Generic" #>
+<#@ output extension=".cs" #>
+#region license
+// This file is part of Vocaluxe.
+// 
+// Vocaluxe is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Vocaluxe is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
+#endregion
+
+using System;
+using System.IO;
+using NUnit.Framework;
+using VocaluxeLib.Log;
+
+namespace Tests.VocaluxeLib.Log
+{
+    [TestFixture]
+    public class CLogTest
+    {
+        private const string _TestMessage = "This is a test";
+        private const string _TestMessageWithData = "This is a test with data: {Data1}";
+        private const string _TestMessageWithResolvedData = "This is a test with data: \"Test\"";
+        private string _TestFolder;
+
+        #region Setup methods
+
+        [SetUp]
+        public void SetUp()
+        {
+            _TestFolder = _GetTemporaryDirectory();
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            Directory.Delete(_TestFolder, true);
+        }
+
+        #endregion
+
+        #region Tests
+        
+<#  foreach (var LogLevel in new[]{"Verbose","Debug", "Information", "Warning", "Error"/*, "Fatal"*/}) { /* Fatal calls Environment.Exit -> cant test without mock*/ #>
+        #region <#= LogLevel #> tests
+<#  foreach (var WithData in new[] {true, false}) { #>
+<#  foreach (var WithException in new[] {true, false}) { #>
+
+        [Test]
+        public void <#= LogLevel #>Test<#= WithData?"With":"Without" #>Data<#= WithException?"With":"Without" #>Exception([Values(true, false)] bool show)
+        {
+            string testFileName = Path.GetRandomFileName();
+            string testFileSongName = Path.GetRandomFileName();
+            string testFileMarkerName = Path.GetRandomFileName();
+            string versionTag = "Test Version (1.2.4)";
+            bool messageShown = false;
+
+            // Init Log
+            CLog.Init(_TestFolder, testFileName, testFileSongName, testFileMarkerName, versionTag,
+                (crash, cont, tag, log, error) =>
+            {
+                messageShown = true;
+                Assert.IsTrue(show);
+                Assert.IsFalse(crash);
+                Assert.IsTrue(cont);
+                Assert.AreEqual(versionTag, tag);
+
+                StringAssert.Contains("[Information] Starting to log", log, "Main log start entry wrong");
+                StringAssert.Contains("Version = " + versionTag, log, "Main log version tag entry wrong");
+                StringAssert.Contains("[<#= LogLevel #>] " + <#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>, log, "Main log entry wrong");
+
+                StringAssert.Contains(<#= WithData?"_TestMessageWithData":"_TestMessage" #>, error, "Error message wrong");
+            },
+            ELogLevel.Verbose);
+
+            // Add log entry
+            CLog.<#= LogLevel #>(<#= WithException?"new Exception(\"TestExceptionMessage\"), ":"" #><#= WithData?"_TestMessageWithData":"_TestMessage" #><#= WithData?", CLog.Params(\"Test\", \"Foo\")":"" #>, show);
+<# if(LogLevel!="Fatal") { #>
+            CLog.CSongLog.<#= LogLevel #>(<#= WithData?"_TestMessageWithData":"_TestMessage" #><#= WithData?", CLog.Params(\"Test\", \"Foo\")":"" #>);
+<# } #>
+
+            // Close logfile
+            CLog.Close();
+
+            // Check log
+            Assert.IsTrue(File.Exists(Path.Combine(_TestFolder, testFileName)), "Mainlog file is missing.");
+            Assert.IsTrue(File.Exists(Path.Combine(_TestFolder, testFileSongName)), "Songlog file is missing.");
+
+            string mainLogContent = File.ReadAllText(Path.Combine(_TestFolder, testFileName));
+            string songLogContent = File.ReadAllText(Path.Combine(_TestFolder, testFileSongName));
+
+            StringAssert.Contains("[Information] Starting to log", mainLogContent, "Main log start entry wrong");
+            StringAssert.Contains("Version = " + versionTag, mainLogContent, "Main log version tag entry wrong");
+            StringAssert.Contains("[<#= LogLevel #>] " +<#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>, mainLogContent, "Main log entry wrong");
+<# if(WithException) { #>
+            StringAssert.Contains("TestExceptionMessage", mainLogContent, "Exception is missing");
+<# } #>
+<# if(WithData) { #>
+            StringAssert.Contains("Foo", mainLogContent, "Second data field is missing");
+<# } #>
+<# if(LogLevel!="Fatal") { #>
+            StringAssert.Contains(<#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>, songLogContent, "Song log entry wrong");
+<# } #>
+            if(!show)
+            {
+                Assert.IsFalse(messageShown);
+            }
+        }
+<# } #>
+<# } #>
+
+        #endregion
+<# } #>
+
+        #endregion
+
+        #region Helper methods
+
+        private string _GetTemporaryDirectory()
+        {
+            string tempDirectory = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
+            Directory.CreateDirectory(tempDirectory);
+            return tempDirectory;
+        }
+
+        #endregion
+
+    }
+}

Vocaluxe/Program.cs

@@ -91,7 +91,13 @@ namespace Vocaluxe
                 Directory.CreateDirectory(CSettings.DataFolder);
 
                 // Init Log
-                CLog.Init(CSettings.FolderNameLogs, CSettings.FileNameMainLog, CSettings.FileNameSongLog, CSettings.FileNameCrashMarker, CSettings.GetFullVersionText(), CReporter.ShowReporterFunc);
+                CLog.Init(CSettings.FolderNameLogs,
+                    CSettings.FileNameMainLog, 
+                    CSettings.FileNameSongLog, 
+                    CSettings.FileNameCrashMarker, 
+                    CSettings.GetFullVersionText(), 
+                    CReporter.ShowReporterFunc, 
+                    ELogLevel.Information);
 
                 if (!CProgrammHelper.CheckRequirements())
                     return;

VocaluxeLib/Log/CLog.cs

@@ -41,7 +41,6 @@ namespace VocaluxeLib.Log
         private const string _MainLogTemplate = "[{TimeStampFromStart}] [{Level}] {Message}{NewLine}{Properties}{NewLine}{Exception}";
         private const string _SongLogTemplate = "{Message}{NewLine}Additional info:{Properties}{NewLine}{Exception}";
 
-
         /// <summary>
         /// Initialize the logging framework.
         /// </summary>
@@ -51,7 +50,8 @@ namespace VocaluxeLib.Log
         /// <param name="fileNameCrashMarker">The name of the file which is used as crash marker.</param>
         /// <param name="currentVersion">The current version tag as it is displayed in the main menu.</param>
         /// <param name="showReporterFunc">Delegate to the function which should be called if the reporter have to been shown.</param>
-        public static void Init(string logFolder, string fileNameMainLog, string fileNameSongInfoLog, string fileNameCrashMarker, string currentVersion, ShowReporterDelegate showReporterFunc)
+        /// <param name="logLevel">The log level for log messages.</param>
+        public static void Init(string logFolder, string fileNameMainLog, string fileNameSongInfoLog, string fileNameCrashMarker, string currentVersion, ShowReporterDelegate showReporterFunc, ELogLevel logLevel)
         {
             _LogFolder = logFolder;
             _ShowReporterFunc = showReporterFunc;
@@ -83,7 +83,11 @@ namespace VocaluxeLib.Log
                 if (_CurrentVersion == versionTag && File.Exists(mainLogFilePath))
                 {
                     string logContent = File.ReadAllText(mainLogFilePath, Encoding.UTF8);
-                    _ShowReporterFunc(crash:true, showContinue:true, vocaluxeVersionTag:versionTag, log:logContent, lastError:"Vocaluxe crashed while the last execution.");
+                    _ShowReporterFunc(crash:true,
+                        showContinue:true,
+                        vocaluxeVersionTag:versionTag,
+                        log:logContent,
+                        lastError:"Vocaluxe crashed while the last execution.");
                 }
 #endif
             }
@@ -95,26 +99,36 @@ namespace VocaluxeLib.Log
             CLogFileRoller.RollLogs(songLogFilePath, 2);
 
             _MainLog = new LoggerConfiguration()
+                .MinimumLevel.Is(logLevel.ToSerilogLogLevel())
                 .Enrich.WithThreadId()
                 .Enrich.FromLogContext()
                 .Enrich.WithTimeStampFromStart()
-                .WriteTo.TextWriter(_MainLogStringWriter, outputTemplate: _MainLogTemplate)
+                .WriteTo.TextWriter(_MainLogStringWriter,
+                    outputTemplate: _MainLogTemplate)
                 // Json can be activated by adding "new CompactJsonFormatter()" as first argument
-                .WriteTo.File(mainLogFilePath, flushToDiskInterval: TimeSpan.FromSeconds(30), outputTemplate: _MainLogTemplate)
+                .WriteTo.File(mainLogFilePath,
+                    flushToDiskInterval: TimeSpan.FromSeconds(30),
+                    outputTemplate: _MainLogTemplate)
 #if DEBUG
                 .WriteTo.Console(outputTemplate: _MainLogTemplate)
 #endif
                 .CreateLogger();
 
             _SongLog = new LoggerConfiguration()
-                .WriteTo.File(songLogFilePath, flushToDiskInterval: TimeSpan.FromSeconds(60), outputTemplate: _SongLogTemplate)
+                .MinimumLevel.Is(logLevel.ToSerilogLogLevel())
+                .WriteTo.File(songLogFilePath, 
+                    flushToDiskInterval: TimeSpan.FromSeconds(60),
+                    outputTemplate: _SongLogTemplate)
 #if DEBUG
                 .WriteTo.Console(outputTemplate: "[SongInfo] " + _SongLogTemplate)
 #endif
                 .CreateLogger();
 
             // Adding first line to log with information about this run
-            Information("Starting to log", Params( new { Version = _CurrentVersion}, new { StartDate = DateTime.Now}, new { Id = Guid.NewGuid() } ) );
+            Information("Starting to log", 
+                Params( new { Version = _CurrentVersion},
+                    new { StartDate = DateTime.Now},
+                    new { Id = Guid.NewGuid() } ) );
         }
 
         /// <summary>

VocaluxeLib/Log/ELogLevel.cs

@@ -0,0 +1,56 @@
+#region license
+// This file is part of Vocaluxe.
+// 
+// Vocaluxe is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+// 
+// Vocaluxe is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+// 
+// You should have received a copy of the GNU General Public License
+// along with Vocaluxe. If not, see <http://www.gnu.org/licenses/>.
+#endregion
+
+using System;
+using Serilog.Events;
+
+namespace VocaluxeLib.Log
+{
+    public enum ELogLevel
+    {
+        Verbose,
+        Debug,
+        Information,
+        Warning,
+        Error,
+        Fatal
+    }
+
+    public static class CLogLevelExtension
+    {
+        public static LogEventLevel ToSerilogLogLevel(this ELogLevel level)
+        {
+            switch (level)
+            {
+                case ELogLevel.Verbose:
+                    return LogEventLevel.Verbose;
+                case ELogLevel.Debug:
+                    return LogEventLevel.Debug;
+                case ELogLevel.Information:
+                    return LogEventLevel.Information;
+                case ELogLevel.Warning:
+                    return LogEventLevel.Warning;
+                case ELogLevel.Error:
+                    return LogEventLevel.Error;
+                case ELogLevel.Fatal:
+                    return LogEventLevel.Fatal;
+                default:
+                    throw new ArgumentOutOfRangeException(nameof(level), level, null);
+            }
+        }
+    }
+}

VocaluxeLib/VocaluxeLib.csproj

@@ -112,6 +112,7 @@
     <Compile Include="CEncoding.cs" />
     <Compile Include="CFading.cs" />
     <Compile Include="CFont.cs" />
+    <Compile Include="Log\ELogLevel.cs" />
     <Compile Include="Log\ShowReporterDelegate.cs" />
     <Compile Include="Log\CLog.cs" />
     <Compile Include="CVideoStream.cs" />