Merge branch 'master' of https://github.com/stackify/stackify-api-dotnet

Author: mwatson

Src/ConsoleTest/App.config

@@ -11,6 +11,7 @@
       <appender-ref ref="Console" />
     </root>
     <appender name="StackifyAppender" type="StackifyLib.log4net.StackifyAppender, StackifyLib.log4net">
+      <logicalThreadContextKeys>TestLogicalThreadContext</logicalThreadContextKeys>
     </appender>
     <appender name="Console" type="log4net.Appender.ConsoleAppender">
       <layout type="log4net.Layout.PatternLayout">

Src/ConsoleTest/ConsoleTest.csproj

@@ -32,8 +32,9 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
-    <Reference Include="log4net">
-      <HintPath>..\packages\log4net.2.0.3\lib\net40-full\log4net.dll</HintPath>
+    <Reference Include="log4net, Version=1.2.15.0, Culture=neutral, PublicKeyToken=669e0ddf0bb1aa2a, processorArchitecture=MSIL">
+      <HintPath>..\packages\log4net.2.0.5\lib\net45-full\log4net.dll</HintPath>
+      <Private>True</Private>
     </Reference>
     <Reference Include="System" />
     <Reference Include="System.Core" />

Src/ConsoleTest/packages.config

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="log4net" version="2.0.3" targetFramework="net45" />
+  <package id="log4net" version="2.0.5" targetFramework="net45" />
 </packages>

Src/StackifyLib.log4net.Tests/StackifyAppenderTest.cs

@@ -23,33 +23,27 @@ public class StackifyAppenderTest
         private MockLogClient _mockLogClient;
         private StackifyAppender _appender;
 
-        [SetUp]
+        [OneTimeSetUp]
         public void Init()
         {
             _mockLogClient = new MockLogClient();
             Hierarchy hierarchy = (Hierarchy)LogManager.GetRepository();
 
-            PatternLayout patternLayout = new PatternLayout();
-            patternLayout.ConversionPattern = "%date [%thread] %-5level %logger - %message%newline";
-            patternLayout.ActivateOptions();
-
-            RollingFileAppender roller = new RollingFileAppender();
-            roller.AppendToFile = false;
-            roller.File = @"Logs\EventLog.txt";
-            roller.Layout = patternLayout;
-            roller.MaxSizeRollBackups = 5;
-            roller.MaximumFileSize = "1GB";
-            roller.RollingStyle = RollingFileAppender.RollingMode.Size;
-            roller.StaticLogFileName = true;
-            roller.ActivateOptions();
-            hierarchy.Root.AddAppender(roller);
-
             _appender = new StackifyAppender { CreateLogClient = (s, s1) => _mockLogClient, threadContextKeys = "TestThreadContext", logicalThreadContextKeys = "TestLogicalThreadContext" };
             _appender.ActivateOptions();
             hierarchy.Root.AddAppender(_appender);
 
             hierarchy.Root.Level = Level.Info;
             hierarchy.Configured = true;
+            Console.WriteLine("Setup Log4Net");
+        }
+
+        public void CleanUp()
+        {
+            // Just a bit of cleanup.
+            ThreadContext.Properties["TestThreadContext"] = null;
+            LogicalThreadContext.Properties["TestLogicalThreadContext"] = null;
+            Console.WriteLine("Cleaned up Context");
         }
 
         [Test]
@@ -58,6 +52,7 @@ public void ShouldIncludeContextObjects_WhenUsingLog4NetContextStacks()
             LogMsg result = null;
             _mockLogClient.OnQueueMessage = m => result = m;
             var logger = LogManager.GetLogger("Test");
+
             using (LogicalThreadContext.Stacks["TestLogicalThreadContext"].Push("Logical Test Value"))
             using (ThreadContext.Stacks["TestThreadContext"].Push("Thread Test Value"))
             {
@@ -77,6 +72,31 @@ public void ShouldIncludeContextObjects_WhenUsingLog4NetContextStacks()
             Assert.AreEqual("Thread Test Value", dataObj.context.testthreadcontext.Value, "TestThreadContext didn't match expected value.");
             Assert.AreEqual("Logical Test Value", dataObj.context.testlogicalthreadcontext.Value, "TestLogicalThreadContext didn't match expected value");
         }
+
+        [Test]
+        public void ShouldIncludeContextObjects_WhenUsingLog4NetContextProperty()
+        {
+            LogMsg result = null;
+            _mockLogClient.OnQueueMessage = m => result = m;
+            var logger = LogManager.GetLogger("Test");
+            LogicalThreadContext.Properties["TestLogicalThreadContext"] = new { MyProp = "Logical Test Value" };
+            ThreadContext.Properties["TestThreadContext"] = new { MyProp = "Thread Test Value" };
+
+            logger.Info("Test Message");
+
+            Console.WriteLine("Actual Result:");
+            Console.WriteLine(JsonConvert.SerializeObject(result, Formatting.Indented));
+            Console.WriteLine();
+
+            Assert.IsNotNull(result, "No Message was queued");
+            Assert.IsNotNull(result.data, "Data was not set on result");
+
+            // Data is JSON, so we are going to Deserialize it so we can take a deeper look. 
+            dynamic dataObj = JsonConvert.DeserializeObject(result.data);
+
+            Assert.AreEqual("Thread Test Value", dataObj.context.testthreadcontext.MyProp.Value, "TestThreadContext didn't match expected value.");
+            Assert.AreEqual("Logical Test Value", dataObj.context.testlogicalthreadcontext.MyProp.Value, "TestLogicalThreadContext didn't match expected value");
+        }
     }
 
     public class MockLogClient : ILogClient

Src/StackifyLib.log4net/StackifyAppender.cs

@@ -237,8 +237,6 @@ internal LogMsg Translate(LoggingEvent loggingEvent)
                     msg.Msg += "\r\n" + error.ToString();
                 }
             }
-			
-
 
             if (!string.IsNullOrWhiteSpace(errorAdditionalMessage) && error != null)
             {
@@ -333,16 +331,28 @@ private Dictionary<string, object> GetDiagnosticContextProperties()
                     // Check if the property is a Log4net Context Stack,
                     // If it is, then we want to read it as a string as that is
                     // the expected behavior for a Log4Net Appender.
+
                     var tcs = mdcValue as Apache_log4net.Util.ThreadContextStack;
                     if (tcs != null)
                     {
                         properties[mdcKey.ToLower()] = tcs.ToString();
+                        continue;
                     }
-                    else
+
+                    // Log4Net 1.2.14 (2.0.4) added LogicalThreadContextStack
+                    // see https://issues.apache.org/jira/browse/LOG4NET-455
+                    // To maintain compatibility with version 2.0.0 in this library, we have to use reflection here.
+
+                    // TODO: Require version 1.2.14, as we know there are issues in prior versions.
+                    var mdcType = mdcValue.GetType();
+                    if (mdcType.FullName == "log4net.Util.LogicalThreadContextStack")
                     {
-                        // for anything else, we will let Json.Net take care of it.
-                        properties[mdcKey.ToLower()] = mdcValue;
+                        properties[mdcKey.ToLower()] = mdcValue.ToString();
+                        continue;
                     }
+
+                    // for anything else, we will let Json.Net take care of it.
+                    properties[mdcKey.ToLower()] = mdcValue;
                 }
             }