Vocaluxe/Tests/VocaluxeLib/Log/CLogTest.tt

<#
// 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 _FirstParam = "Test";
        private const string _SecondParam = "Foo";
        private const string _TestMessageWithResolvedData = "This is a test with data: \"Test\"";
        private const string _TestExceptionMessage = "TestExceptionMessage";
        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.That(show, Is.True);
                Assert.That(crash, Is.False);
                Assert.That(cont, Is.True);
                Assert.That(tag, Is.EqualTo(versionTag));

                Assert.That(log, Contains.Substring("[Information] Starting to log"), "Main log start entry wrong");
                Assert.That(log, Contains.Substring("Version = " + versionTag), "Main log version tag entry wrong");
                Assert.That(log, Contains.Substring("[<#= LogLevel #>] " + <#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>), "Main log entry wrong");

                Assert.That(error, Contains.Substring(<#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>), "Error message wrong");
            },
            ELogLevel.Verbose);

            // Add log entry
            CLog.<#= LogLevel #>(<#= WithException?"new Exception(_TestExceptionMessage), ":"" #><#= WithData?"_TestMessageWithData":"_TestMessage" #><#= WithData?", CLog.Params(_FirstParam, _SecondParam)":"" #>, show);
<# if(LogLevel!="Fatal") { #>
            CLog.CSongLog.<#= LogLevel #>(<#= WithData?"_TestMessageWithData":"_TestMessage" #><#= WithData?", CLog.Params(_FirstParam, _SecondParam)":"" #>);
<# } #>

            // Close logfile
            CLog.Close();

            // Check log
            Assert.That(File.Exists(Path.Combine(_TestFolder, testFileName)), Is.True, "Mainlog file is missing.");
            Assert.That(File.Exists(Path.Combine(_TestFolder, testFileSongName)), Is.True, "Songlog file is missing.");

            string mainLogContent = File.ReadAllText(Path.Combine(_TestFolder, testFileName));
            string songLogContent = File.ReadAllText(Path.Combine(_TestFolder, testFileSongName));

            Assert.That(mainLogContent, Contains.Substring("[Information] Starting to log"), "Main log start entry wrong");
            Assert.That(mainLogContent, Contains.Substring("Version = " + versionTag), "Main log version tag entry wrong");
            Assert.That(mainLogContent, Contains.Substring("[<#= LogLevel #>] " +<#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>), "Main log entry wrong");
<# if(WithException) { #>
            Assert.That(mainLogContent, Contains.Substring(_TestExceptionMessage), "Exception is missing");
<# } #>
<# if(WithData) { #>
            Assert.That(mainLogContent, Contains.Substring(_SecondParam), "Second data field is missing");
<# } #>
<# if(LogLevel!="Fatal") { #>
            Assert.That(songLogContent, Contains.Substring(<#= WithData?"_TestMessageWithResolvedData":"_TestMessage" #>), "Song log entry wrong");
<# } #>
            if(!show)
            {
                Assert.That(messageShown, Is.False);
            }
        }
<# } #>
<# } #>

        #endregion
<# } #>

        #endregion

        #region Helper methods

        private string _GetTemporaryDirectory()
        {
            string tempDirectory = Path.Combine(Path.GetTempPath(), Path.GetRandomFileName());
            Directory.CreateDirectory(tempDirectory);
            return tempDirectory;
        }

        #endregion

    }
}