public static void LogWrite___Should_create_LogItem___When_logging_string_subject_via_lambda_without_comment()
{
// Arrange
var logWriter = BuildAndConfigureMemoryLogWriter();
var subject = "this is a string subject " + A.Dummy <string>();
// Act
Log.Write(() => subject);
Thread.Sleep(TimeSpan.FromMilliseconds(200));
// Assert
var logItem = logWriter.LoggedItems.Single(_ => _.Subject.Summary.Contains(subject));
var actualSubject = logItem.Subject.DeserializeSubject <string>();
logItem.Subject.Summary.Should().Be(subject);
actualSubject.Should().Be(subject);
logItem.Kind.Should().Be(LogItemKind.String);
logItem.Comment.Should().BeNull();
logItem.Context.Should().NotBeNull();
logItem.Context.StackTrace.Should().BeNull();
logItem.Context.Origin.Should().Be(LogItemOrigin.ItsLogEntryPosted.ToString());
logItem.Context.CallingMethod.Should().NotBeNullOrWhiteSpace();
logItem.Context.CallingType.Should().NotBeNull();
logItem.Context.MachineName.Should().NotBeNullOrWhiteSpace();
logItem.Context.ProcessFileVersion.Should().NotBeNullOrWhiteSpace();
logItem.Context.ProcessName.Should().NotBeNullOrWhiteSpace();
logItem.Context.TimestampUtc.Should().BeOnOrBefore(DateTime.UtcNow);
logItem.Correlations.Should().BeEmpty();
}
public static void Log_Write___Should_make_null_subject_LogItem___When_nulls_written()
{
// Arrange
var logWriter = BuildAndConfigureMemoryLogWriter();
// Act
Log.Write((string)null);
Log.Write(() => (string)null);
Log.Write(() => (DifferentTestObjectWithToStringForItsLog)null);
Log.Write(() => (Exception)null);
using (var log = Log.Enter(() => (TestObjectWithToStringForItsLog)null))
{
log.Trace(null);
log.Trace(() => (string)null);
log.Trace(() => (DifferentTestObjectWithToStringForItsLog)null);
log.Trace(() => (Exception)null);
}
// Assert
logWriter.LoggedItems.Count.Should().Be(10);
logWriter.LoggedItems.Count(_ => _.Subject.Summary == "[null]").Should().Be(8);
logWriter.LoggedItems.Count(_ => _.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 0)).Should().Be(1);
logWriter.LoggedItems.Count(_ => _.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 2)).Should().Be(1);
var middleItems = logWriter.LoggedItems.Where(_ => _.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 1)).ToList();
middleItems.Count.Should().Be(4);
middleItems.Count(_ => _.Context.CallingMethod != null).Should().Be(4, "We have this on everything because the correlating subject has it.");
middleItems.Count(_ => _.Correlations.Any(c => c is ExceptionIdCorrelation)).Should().Be(0, "Can't know if null is an exception or not.");
}
public static void Log_Write___Records_details_correctly___With_exception_and_inner_exception()
{
// Arrange
var logWriter = BuildAndConfigureMemoryLogWriter();
var exceptionMessage = "Exception " + A.Dummy <string>();
var innerExceptionMessage = "Exception to inner " + A.Dummy <string>();
// Act
try
{
try
{
throw new InvalidOperationException(innerExceptionMessage);
}
catch (Exception innerException)
{
Log.Write(() => innerException);
throw new InvalidOperationException(exceptionMessage, innerException);
}
}
catch (Exception exception)
{
Log.Write(() => exception);
}
// Assert
var timeOrderedItems = logWriter.LoggedItems.OrderBy(_ => _.Context.TimestampUtc).ToList();
timeOrderedItems.Count.Should().Be(2);
var logItemInner = logWriter.LoggedItems.First();
var logItem = logWriter.LoggedItems.Last();
var innerSubject = logItemInner.Subject.DeserializeSubject <InvalidOperationException>();
var actualSubject = logItem.Subject.DeserializeSubject <InvalidOperationException>();
logItemInner.Subject.Summary.Should().Be(Invariant($"{nameof(InvalidOperationException)}: {innerExceptionMessage}"));
logItem.Subject.Summary.Should().Be(Invariant($"{nameof(InvalidOperationException)}: {exceptionMessage}"));
innerSubject.Message.Should().Be(innerExceptionMessage);
innerSubject.InnerException.Should().BeNull();
actualSubject.Message.Should().Be(exceptionMessage);
actualSubject.InnerException.Should().NotBeNull();
actualSubject.InnerException.Message.Should().Be(innerExceptionMessage);
logItemInner.Kind.Should().Be(LogItemKind.Exception);
logItemInner.Comment.Should().BeNull();
logItem.Kind.Should().Be(LogItemKind.Exception);
logItem.Comment.Should().BeNull();
var innerCorrelation = (ExceptionIdCorrelation)logItemInner.Correlations.Single();
var exceptionCorrelation = (ExceptionIdCorrelation)logItem.Correlations.Single();
innerCorrelation.ExceptionId.Should().Be(innerSubject.GetExceptionIdFromExceptionData(searchInnerExceptionChain: true).ToString());
exceptionCorrelation.ExceptionId.Should().Be(actualSubject.GetExceptionIdFromExceptionData(searchInnerExceptionChain: true).ToString());
innerCorrelation.ExceptionId.Should().Be(exceptionCorrelation.ExceptionId);
}
public static void Log_Write___Records_details_correctly___With_exception_and_comment_and_error_code()
{
// Arrange
var logWriter = BuildAndConfigureMemoryLogWriter();
var exceptionMessage = "Exception " + A.Dummy <string>();
var comment = "this is a comment " + A.Dummy <string>();
var errorCode = "errorCode" + Guid.NewGuid().ToString().ToLowerInvariant();
// Act
try
{
throw new InvalidOperationException(exceptionMessage).AddErrorCode(errorCode);
}
catch (Exception ex)
{
Log.Write(() => ex, comment);
}
// Assert
var logItem = logWriter.LoggedItems.Single(_ => _.Subject.Summary.Contains(exceptionMessage));
var actualSubject = logItem.Subject.DeserializeSubject <InvalidOperationException>();
logItem.Subject.Summary.Should().Be(Invariant($"{nameof(InvalidOperationException)}: {exceptionMessage}"));
actualSubject.Message.Should().Be(exceptionMessage);
logItem.Kind.Should().Be(LogItemKind.Exception);
logItem.Comment.Should().Be(comment);
logItem.Context.Should().NotBeNull();
logItem.Context.StackTrace.Should().Be(actualSubject.StackTrace);
logItem.Context.Origin.Should().Be(LogItemOrigin.ItsLogEntryPosted.ToString());
logItem.Context.CallingMethod.Should().NotBeNullOrWhiteSpace();
logItem.Context.CallingType.BuildAssemblyQualifiedName().Should().NotBeNullOrWhiteSpace();
logItem.Context.MachineName.Should().NotBeNullOrWhiteSpace();
logItem.Context.ProcessFileVersion.Should().NotBeNullOrWhiteSpace();
logItem.Context.ProcessName.Should().NotBeNullOrWhiteSpace();
logItem.Context.TimestampUtc.Should().BeOnOrBefore(DateTime.UtcNow);
var errorCodeCorrelation = (ErrorCodeCorrelation)logItem.Correlations.Single(_ => _.GetType() == typeof(ErrorCodeCorrelation));
errorCodeCorrelation.ErrorCode.Should().Be(errorCode);
var exceptionCorrelation = (ExceptionIdCorrelation)logItem.Correlations.Single(_ => _.GetType() == typeof(ExceptionIdCorrelation));
exceptionCorrelation.ExceptionId.Should().Be(actualSubject.GetExceptionIdFromExceptionData(searchInnerExceptionChain: true).ToString());
}
public static void Log_Enter_Activity_Trace___Records_details_correctly___With_exception_and_comment()
{
// Arrange
var logWriter = BuildAndConfigureMemoryLogWriter();
var enterSubject = new TestObjectWithToStringForItsLog();
var stringTraceWithoutLambda = "some trace without a lambda" + A.Dummy <string>();
var stringTraceWithLambda = "some trace with a lambda" + A.Dummy <string>();
var traceObjectWithLambda = new DifferentTestObjectWithToStringForItsLog();
var exceptionToThrow = new InvalidOperationException("Oh no.");
// Act
using (var log = Log.Enter(() => enterSubject))
{
try
{
throw exceptionToThrow;
}
catch (Exception exception)
{
log.Trace(() => exception);
}
log.Trace(stringTraceWithoutLambda);
log.Trace(() => stringTraceWithLambda);
log.Trace(() => traceObjectWithLambda);
}
// Assert
logWriter.LoggedItems.ToList().ForEach(_ => _.Correlations.Single(c => c is ElapsedCorrelation).Should().NotBeNull());
logWriter.LoggedItems.ToList().ForEach(_ => _.Correlations.Single(c => c is SubjectCorrelation).Should().NotBeNull());
logWriter.LoggedItems.Select(_ => _.Correlations.Single(c => c is ElapsedCorrelation).CorrelationId).Count().Should()
.Be(logWriter.LoggedItems.Count);
logWriter.LoggedItems.Select(_ => _.Correlations.Single(c => c is SubjectCorrelation).CorrelationId).Count().Should()
.Be(logWriter.LoggedItems.Count);
logWriter.LoggedItems.ToList().ForEach(
_ => ((SubjectCorrelation)_.Correlations.Single(c => c is SubjectCorrelation)).Subject
.DeserializeSubject <TestObjectWithToStringForItsLog>().Test.Should().Be(enterSubject.Test));
var enterItem = logWriter.LoggedItems.Single(_ => _.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 0));
enterItem.Subject.DeserializeSubject <string>().Should().Be(UsingBlockLogger.InitialItemOfUsingBlockSubject);
var enterCorrelation = (ElapsedCorrelation)enterItem.Correlations.Single(_ => _ is ElapsedCorrelation);
enterCorrelation.ElapsedTime.TotalMilliseconds.Should().Be(0);
var middleItems = logWriter.LoggedItems.Where(
_ => new[] { exceptionToThrow.Message, stringTraceWithLambda, stringTraceWithoutLambda, traceObjectWithLambda.ToString() }.Any(
a => _.Subject.Summary.EndsWith(a, StringComparison.CurrentCulture))).ToList();
middleItems.ForEach(_ =>
{
_.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 1).Should().BeTrue();
var middleCorrelation = (ElapsedCorrelation)_.Correlations.Single(s => s is ElapsedCorrelation);
middleCorrelation.ElapsedTime.TotalMilliseconds.Should().BeGreaterThan(0);
});
var exitItem = logWriter.LoggedItems.Single(_ => _.Correlations.Any(c => c is OrderCorrelation oc && oc.Position == 2));
exitItem.Subject.DeserializeSubject <string>().Should().Be(UsingBlockLogger.FinalItemOfUsingBlockSubject);
var exitCorrelation = (ElapsedCorrelation)exitItem.Correlations.Single(_ => _ is ElapsedCorrelation);
exitCorrelation.ElapsedTime.TotalMilliseconds.Should().BeGreaterThan(0);
}
