#region Apache License
//
// Licensed to the Apache Software Foundation (ASF) under one or more
// contributor license agreements. See the NOTICE file distributed with
// this work for additional information regarding copyright ownership.
// The ASF licenses this file to you under the Apache License, Version 2.0
// (the "License"); you may not use this file except in compliance with
// the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
#endregion
#if NET_4_5 || NETSTANDARD
using System;
using System.Threading.Tasks;
using System.Linq;
using log4net.Config;
using log4net.Layout;
using log4net.Repository;
using log4net.Tests.Appender;
using log4net.Util;
using NUnit.Framework;
namespace log4net.Tests.Context
{
///
/// Used for internal unit testing the class.
///
///
/// Used for internal unit testing the class.
///
[TestFixture]
public class LogicalThreadContextTest
{
[TearDown]
public void TearDown()
{
Utils.RemovePropertyFromAllContexts();
}
[Test]
public void TestLogicalThreadPropertiesPatternBasicGetSet()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestLogicalThreadPropertiesPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread properties value set");
stringAppender.Reset();
LogicalThreadContext.Properties[Utils.PROPERTY_KEY] = "val1";
log1.Info("TestMessage");
Assert.AreEqual("val1", stringAppender.GetString(), "Test logical thread properties value set");
stringAppender.Reset();
LogicalThreadContext.Properties.Remove(Utils.PROPERTY_KEY);
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread properties value removed");
stringAppender.Reset();
}
[Test]
public async Task TestLogicalThreadPropertiesPatternAsyncAwait()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestLogicalThreadPropertiesPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
string testValueForCurrentContext = "Outer";
LogicalThreadContext.Properties[Utils.PROPERTY_KEY] = testValueForCurrentContext;
log1.Info("TestMessage");
Assert.AreEqual(testValueForCurrentContext, stringAppender.GetString(), "Test logical thread properties value set");
stringAppender.Reset();
var strings = await Task.WhenAll(Enumerable.Range(0, 10).Select(x => SomeWorkProperties(x.ToString())));
// strings should be ["00AA0BB0", "01AA1BB1", "02AA2BB2", ...]
for (int i = 0; i < strings.Length; i++)
{
Assert.AreEqual(string.Format("{0}{1}AA{1}BB{1}", testValueForCurrentContext, i), strings[i], "Test logical thread properties expected sequence");
}
log1.Info("TestMessage");
Assert.AreEqual(testValueForCurrentContext, stringAppender.GetString(), "Test logical thread properties value set");
stringAppender.Reset();
LogicalThreadContext.Properties.Remove(Utils.PROPERTY_KEY);
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread properties value removed");
stringAppender.Reset();
}
[Test]
public void TestLogicalThreadStackPattern()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestThreadStackPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push("val1"))
{
log1.Info("TestMessage");
Assert.AreEqual("val1", stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
}
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread stack value removed");
stringAppender.Reset();
}
[Test]
public void TestLogicalThreadStackPattern2()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestThreadStackPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push("val1"))
{
log1.Info("TestMessage");
Assert.AreEqual("val1", stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push("val2"))
{
log1.Info("TestMessage");
Assert.AreEqual("val1 val2", stringAppender.GetString(), "Test logical thread stack value pushed 2nd val");
stringAppender.Reset();
}
}
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread stack value removed");
stringAppender.Reset();
}
[Test]
public void TestLogicalThreadStackPatternNullVal()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestThreadStackPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push(null))
{
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
}
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread stack value removed");
stringAppender.Reset();
}
[Test]
public void TestLogicalThreadStackPatternNullVal2()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestThreadStackPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push("val1"))
{
log1.Info("TestMessage");
Assert.AreEqual("val1", stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push(null))
{
log1.Info("TestMessage");
Assert.AreEqual("val1 ", stringAppender.GetString(), "Test logical thread stack value pushed null");
stringAppender.Reset();
}
}
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread stack value removed");
stringAppender.Reset();
}
[Test]
public async Task TestLogicalThreadStackPatternAsyncAwait()
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log1 = LogManager.GetLogger(rep.Name, "TestLogicalThreadStackPattern");
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test no logical thread stack value set");
stringAppender.Reset();
string testValueForCurrentContext = "Outer";
string[] strings = null;
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push(testValueForCurrentContext))
{
log1.Info("TestMessage");
Assert.AreEqual(testValueForCurrentContext, stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
strings = await Task.WhenAll(Enumerable.Range(0, 10).Select(x => SomeWorkStack(x.ToString())));
}
// strings should be ["Outer 0 AOuter 0 AOuter 0Outer 0 BOuter 0 B Outer 0", ...]
for (int i = 0; i < strings.Length; i++)
{
Assert.AreEqual(string.Format("{0} {1} A{0} {1} A{0} {1}{0} {1} B{0} {1} B{0} {1}", testValueForCurrentContext, i), strings[i], "Test logical thread properties expected sequence");
}
log1.Info("TestMessage");
Assert.AreEqual(SystemInfo.NullText, stringAppender.GetString(), "Test logical thread properties value removed");
stringAppender.Reset();
}
static async Task SomeWorkProperties(string propertyName)
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log = LogManager.GetLogger(rep.Name, "TestLogicalThreadStackPattern");
log.Info("TestMessage");
// set a new one
LogicalThreadContext.Properties[Utils.PROPERTY_KEY] = propertyName;
log.Info("TestMessage");
await MoreWorkProperties(log, "A");
log.Info("TestMessage");
await MoreWorkProperties(log, "B");
log.Info("TestMessage");
return stringAppender.GetString();
}
static async Task MoreWorkProperties(ILog log, string propertyName)
{
LogicalThreadContext.Properties[Utils.PROPERTY_KEY] = propertyName;
log.Info("TestMessage");
await Task.Delay(1);
log.Info("TestMessage");
}
static async Task SomeWorkStack(string stackName)
{
StringAppender stringAppender = new StringAppender();
stringAppender.Layout = new PatternLayout("%property{" + Utils.PROPERTY_KEY + "}");
ILoggerRepository rep = LogManager.CreateRepository(Guid.NewGuid().ToString());
BasicConfigurator.Configure(rep, stringAppender);
ILog log = LogManager.GetLogger(rep.Name, "TestLogicalThreadStackPattern");
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push(stackName))
{
log.Info("TestMessage");
Assert.AreEqual(string.Format("Outer {0}", stackName), stringAppender.GetString(), "Test logical thread stack value set");
stringAppender.Reset();
await MoreWorkStack(log, "A");
log.Info("TestMessage");
await MoreWorkStack(log, "B");
log.Info("TestMessage");
}
return stringAppender.GetString();
}
static async Task MoreWorkStack(ILog log, string stackName)
{
using (LogicalThreadContext.Stacks[Utils.PROPERTY_KEY].Push(stackName))
{
log.Info("TestMessage");
await Task.Delay(1);
log.Info("TestMessage");
}
}
}
}
#endif