Refactor tests

Author: danelson

test/Serilog.Sinks.OpenTelemetry.Tests/LogRecordBuilderTests.cs

@@ -45,7 +45,7 @@ public void TestProcessMessage()
     public void TestProcessLevel()
     {
         var logRecord = new LogRecord();
-        var logEvent = Some.SerilogEvent();
+        var logEvent = Some.DefaultSerilogEvent();
 
         LogRecordBuilder.ProcessLevel(logRecord, logEvent);
 
@@ -57,7 +57,7 @@ public void TestProcessLevel()
     public void TestProcessProperties()
     {
         var logRecord = new LogRecord();
-        var logEvent = Some.SerilogEvent();
+        var logEvent = Some.DefaultSerilogEvent();
 
         var prop = new LogEventProperty("property_name", new ScalarValue("ok"));
         var propertyKeyValue = PrimitiveConversions.NewStringAttribute("property_name", "ok");
@@ -76,7 +76,7 @@ public void TestTimestamp()
         var nowNano = PrimitiveConversions.ToUnixNano(now);
 
         var logRecord = new LogRecord();
-        var logEvent = Some.SerilogEvent(timestamp: now);
+        var logEvent = Some.SerilogEvent(Some.TestMessageTemplate, timestamp: now);
 
         LogRecordBuilder.ProcessTimestamp(logRecord, logEvent);
 
@@ -96,7 +96,7 @@ public void TestException()
         catch (Exception ex)
         {
             var logRecord = new LogRecord();
-            var logEvent = Some.SerilogEvent(ex: ex);
+            var logEvent = Some.SerilogEvent(Some.TestMessageTemplate, ex: ex);
 
             LogRecordBuilder.ProcessException(logRecord, logEvent);
 
@@ -131,11 +131,14 @@ public void IncludeMessageTemplateMD5Hash()
     [Fact]
     public void IncludeMessageTemplateText()
     {
-        var logEvent = Some.SerilogEvent(messageTemplate: Some.TestMessageTemplate);
+        var messageTemplate = "Hello, {Name}";
+        var properties = new List<LogEventProperty> { new("Name", new ScalarValue("World")) };
+
+        var logEvent = Some.SerilogEvent(messageTemplate, properties);
 
         var logRecord = LogRecordBuilder.ToLogRecord(logEvent, null, IncludedData.MessageTemplateTextAttribute, new());
 
-        var expectedAttribute = new KeyValue { Key = SemanticConventions.AttributeMessageTemplateText, Value = new() { StringValue = Some.TestMessageTemplate }};
+        var expectedAttribute = new KeyValue { Key = SemanticConventions.AttributeMessageTemplateText, Value = new() { StringValue = messageTemplate } };
         Assert.Contains(expectedAttribute, logRecord.Attributes);
     }
 
@@ -146,7 +149,7 @@ public void IncludeTraceIdWhenActivityIsNull()
 
         var collector = new ActivityContextCollector();
 
-        var logEvent = Some.SerilogEvent();
+        var logEvent = Some.DefaultSerilogEvent();
         collector.CollectFor(logEvent);
 
         var logRecord = LogRecordBuilder.ToLogRecord(logEvent, null, IncludedData.TraceIdField | IncludedData.SpanIdField, collector);
@@ -172,7 +175,7 @@ public void IncludeTraceIdAndSpanId()
 
         var collector = new ActivityContextCollector();
 
-        var logEvent = Some.SerilogEvent();
+        var logEvent = Some.DefaultSerilogEvent();
         collector.CollectFor(logEvent);
 
         var logRecord = LogRecordBuilder.ToLogRecord(logEvent, null, IncludedData.TraceIdField | IncludedData.SpanIdField, collector);
@@ -182,10 +185,13 @@ public void IncludeTraceIdAndSpanId()
     }
 
     [Fact]
-    public void IncludeTemplateBody()
+    public void TemplateBodyIncludesMessageTemplateInBody()
     {
-        var logRecord = LogRecordBuilder.ToLogRecord(Some.SerilogEvent(), null, IncludedData.TemplateBody, new());
+        var messageTemplate = "Hello, {Name}";
+        var properties = new List<LogEventProperty> { new("Name", new ScalarValue("World")) };
+
+        var logRecord = LogRecordBuilder.ToLogRecord(Some.SerilogEvent(messageTemplate, properties), null, IncludedData.TemplateBody, new());
         Assert.NotNull(logRecord.Body);
-        Assert.Equal(Some.TestMessageTemplate, logRecord.Body.StringValue);
+        Assert.Equal(messageTemplate, logRecord.Body.StringValue);
     }
 }

test/Serilog.Sinks.OpenTelemetry.Tests/OpenTelemetryUtilsTests.cs

@@ -24,7 +24,7 @@ public class RequestTemplateFactoryTests
     // request template to another.
     public void TestNoDuplicateLogs()
     {
-        var logEvent = Some.SerilogEvent();
+        var logEvent = Some.DefaultSerilogEvent();
         var logRecord = LogRecordBuilder.ToLogRecord(logEvent, null, IncludedData.None, new());
 
         var requestTemplate = RequestTemplateFactory.CreateRequestTemplate(new Dictionary<string, object>());

test/Serilog.Sinks.OpenTelemetry.Tests/Some.cs

@@ -23,7 +23,21 @@ static class Some
 
     public const string TestMessageTemplate = "Message template {Variable}";
 
-    internal static LogEvent SerilogEvent(DateTimeOffset? timestamp = null, Exception? ex = null, string messageTemplate = TestMessageTemplate)
+    internal static LogEvent DefaultSerilogEvent()
+    {
+        return SerilogEvent(
+            TestMessageTemplate,
+            new List<LogEventProperty> { new("Variable", new ScalarValue(42)) },
+            DateTimeOffset.UtcNow,
+            null);
+    }
+
+    internal static LogEvent SerilogEvent(string messageTemplate, DateTimeOffset? timestamp = null, Exception? ex = null)
+    {
+        return SerilogEvent(messageTemplate, new List<LogEventProperty>(), timestamp, ex);
+    }
+
+	internal static LogEvent SerilogEvent(string messageTemplate, IEnumerable<LogEventProperty> properties, DateTimeOffset? timestamp = null, Exception? ex = null)
     {
         var ts = timestamp ?? DateTimeOffset.UtcNow;
         var parser = new MessageTemplateParser();
@@ -33,7 +47,7 @@ internal static LogEvent SerilogEvent(DateTimeOffset? timestamp = null, Exceptio
             LogEventLevel.Warning,
             ex,
             template,
-            new List<LogEventProperty>{ new("Variable", new ScalarValue(42)) });
+            properties);
 
         return logEvent;
     }