test/Serilog.Tests/Formatting/Display/MessageTemplateTextFormatterTests.cs - dev - aprogrammer/serilog

test/Serilog.Tests/Formatting/Display/MessageTemplateTextFormatterTests.cs
407 строк15 KB
epeshk
Added test for timestamp formatting
20 авг 2024, 07:38
20 авг 2024, 07:389f6b814

// ReSharper disable StringLiteralTypo

using System.Diagnostics;

namespace Serilog.Tests.Formatting.Display;

public class MessageTemplateTextFormatterTests
{
    [Fact]
    public void UsesFormatProvider()
    {
        var french = new CultureInfo("fr-FR");
        var formatter = new MessageTemplateTextFormatter("{Message}", french);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{0}", 12.345));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("12,345", sw.ToString());
    }

    [Fact]
    public void MessageTemplatesContainingFormatStringPropertiesRenderCorrectly()
    {
        var formatter = new MessageTemplateTextFormatter("{Message}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{Message}", "Hello, world!"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("\"Hello, world!\"", sw.ToString());
    }

    [Fact]
    public void UppercaseFormatSpecifierIsSupportedForStrings()
    {
        var formatter = new MessageTemplateTextFormatter("{Name:u}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{Name}", "Nick"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("NICK", sw.ToString());
    }

    [Fact]
    public void LowercaseFormatSpecifierIsSupportedForStrings()
    {
        var formatter = new MessageTemplateTextFormatter("{Name:w}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{Name}", "Nick"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("nick", sw.ToString());
    }

    [Theory]
    [InlineData(16)]
    [InlineData(100)]
    public void RendersTimestampFormatsOfDifferentLengths(int length)
    {
        var longFormatString = new string('-', length);
        var formatter = new MessageTemplateTextFormatter($"{{Timestamp:{longFormatString}}}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{Name}", "Nick"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Contains(longFormatString, sw.ToString());
    }

    [Theory]
    [InlineData(Verbose, 1, "V")]
    [InlineData(Verbose, 2, "Vb")]
    [InlineData(Verbose, 3, "Vrb")]
    [InlineData(Verbose, 4, "Verb")]
    [InlineData(Verbose, 5, "Verbo")]
    [InlineData(Verbose, 6, "Verbos")]
    [InlineData(Verbose, 7, "Verbose")]
    [InlineData(Verbose, 8, "Verbose")]
    [InlineData(LogEventLevel.Debug, 1, "D")]
    [InlineData(LogEventLevel.Debug, 2, "De")]
    [InlineData(LogEventLevel.Debug, 3, "Dbg")]
    [InlineData(LogEventLevel.Debug, 4, "Dbug")]
    [InlineData(LogEventLevel.Debug, 5, "Debug")]
    [InlineData(LogEventLevel.Debug, 6, "Debug")]
    [InlineData(Information, 1, "I")]
    [InlineData(Information, 2, "In")]
    [InlineData(Information, 3, "Inf")]
    [InlineData(Information, 4, "Info")]
    [InlineData(Information, 5, "Infor")]
    [InlineData(Information, 6, "Inform")]
    [InlineData(Information, 7, "Informa")]
    [InlineData(Information, 8, "Informat")]
    [InlineData(Information, 9, "Informati")]
    [InlineData(Information, 10, "Informatio")]
    [InlineData(Information, 11, "Information")]
    [InlineData(Information, 12, "Information")]
    [InlineData(Error, 1, "E")]
    [InlineData(Error, 2, "Er")]
    [InlineData(Error, 3, "Err")]
    [InlineData(Error, 4, "Eror")]
    [InlineData(Error, 5, "Error")]
    [InlineData(Error, 6, "Error")]
    [InlineData(Fatal, 1, "F")]
    [InlineData(Fatal, 2, "Fa")]
    [InlineData(Fatal, 3, "Ftl")]
    [InlineData(Fatal, 4, "Fatl")]
    [InlineData(Fatal, 5, "Fatal")]
    [InlineData(Fatal, 6, "Fatal")]
    [InlineData(Warning, 1, "W")]
    [InlineData(Warning, 2, "Wn")]
    [InlineData(Warning, 3, "Wrn")]
    [InlineData(Warning, 4, "Warn")]
    [InlineData(Warning, 5, "Warni")]
    [InlineData(Warning, 6, "Warnin")]
    [InlineData(Warning, 7, "Warning")]
    [InlineData(Warning, 8, "Warning")]
    public void FixedLengthLevelIsSupported(
        LogEventLevel level,
        int width,
        string expected)
    {
        var formatter = new MessageTemplateTextFormatter($"{{Level:t{width}}}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Write(level, "Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal(expected, sw.ToString());
    }

    [Fact]
    public void FixedLengthLevelSupportsUpperCasing()
    {
        var formatter = new MessageTemplateTextFormatter("{Level:u3}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("INF", sw.ToString());
    }

    [Fact]
    public void FixedLengthLevelSupportsLowerCasing()
    {
        var formatter = new MessageTemplateTextFormatter("{Level:w3}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("inf", sw.ToString());
    }

    [Fact]
    public void DefaultLevelLengthIsFullText()
    {
        var formatter = new MessageTemplateTextFormatter("{Level}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("Information", sw.ToString());
    }

    [Fact]
    public void AlignmentAndWidthCanBeCombined()
    {
        var formatter = new MessageTemplateTextFormatter("{Level,5:w3}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("  inf", sw.ToString());
    }

    enum Size
    {
        Large
    }

    class SizeFormatter : IFormatProvider, ICustomFormatter
    {
        readonly IFormatProvider _innerFormatProvider;

        public SizeFormatter(IFormatProvider innerFormatProvider)
        {
            _innerFormatProvider = innerFormatProvider;
        }

        public object? GetFormat(Type? formatType)
        {
            return formatType == typeof(ICustomFormatter) ? this : _innerFormatProvider.GetFormat(formatType);
        }

        public string Format(string? format, object? arg, IFormatProvider? formatProvider)
        {
            Guard.AgainstNull(arg);

            if (arg is Size size)
                return size == Size.Large ? "Huge" : size.ToString();

            if (arg is IFormattable formattable)
                return formattable.ToString(format, _innerFormatProvider);

            return arg.ToString()!;
        }
    }

    [Fact]
    public void AppliesCustomFormatterToEnums()
    {
        var formatter = new MessageTemplateTextFormatter("{Message}", new SizeFormatter(CultureInfo.InvariantCulture));
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Size {Size}", Size.Large));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("Size Huge", sw.ToString());
    }

    [Fact]
    public void NonMessagePropertiesAreRendered()
    {
        var formatter = new MessageTemplateTextFormatter("{Properties}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.ForContext("Foo", 42).Information("Hello from {Bar}!", "bar"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("{ Foo: 42 }", sw.ToString());
    }

    [Fact]
    public void NonMessagePositionalPropertiesAreRendered()
    {
        var formatter = new MessageTemplateTextFormatter("{Properties}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.ForContext("Foo", 42).Information("Hello from {0}!", "bar"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("{ Foo: 42 }", sw.ToString());
    }

    [Fact]
    public void DoNotDuplicatePropertiesAlreadyRenderedInOutputTemplate()
    {
        var formatter = new MessageTemplateTextFormatter("{Foo} {Properties}", CultureInfo.InvariantCulture);
        var evt = DelegatingSink.GetLogEvent(l => l.ForContext("Foo", 42).ForContext("Bar", 42).Information("Hello from bar!"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("42 { Bar: 42 }", sw.ToString());
    }

    [Theory]
    [InlineData("", "Hello, \"World\"!")]
    [InlineData(":j", "Hello, \"World\"!")]
    [InlineData(":l", "Hello, World!")]
    [InlineData(":lj", "Hello, World!")]
    [InlineData(":jl", "Hello, World!")]
    public void AppliesLiteralFormattingToMessageStringsWhenSpecified(string format, string expected)
    {
        var formatter = new MessageTemplateTextFormatter("{Message" + format + "}", null);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello, {Name}!", "World"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal(expected, sw.ToString());
    }

    [Theory]
    [InlineData("", "{ Name: \"World\" }")]
    [InlineData(":j", "{\"Name\":\"World\"}")]
    [InlineData(":lj", "{\"Name\":\"World\"}")]
    [InlineData(":jl", "{\"Name\":\"World\"}")]
    public void AppliesJsonFormattingToMessageStructuresWhenSpecified(string format, string expected)
    {
        var formatter = new MessageTemplateTextFormatter("{Message" + format + "}", null);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("{@Obj}", new { Name = "World" }));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal(expected, sw.ToString());
    }

    [Theory]
    [InlineData("", "{ Name: \"World\" }")]
    [InlineData(":j", "{\"Name\":\"World\"}")]
    [InlineData(":lj", "{\"Name\":\"World\"}")]
    [InlineData(":jl", "{\"Name\":\"World\"}")]
    public void AppliesJsonFormattingToPropertiesTokenWhenSpecified(string format, string expected)
    {
        var formatter = new MessageTemplateTextFormatter("{Properties" + format + "}", null);
        var evt = DelegatingSink.GetLogEvent(l => l.ForContext("Name", "World").Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal(expected, sw.ToString());
    }

    [Fact]
    public void AnEmptyPropertiesTokenIsAnEmptyStructureValueWithDefaultFormatting()
    {
        var formatter = new MessageTemplateTextFormatter("{Properties}", null);
        var evt = DelegatingSink.GetLogEvent(l => l.Information("Hello"));
        var sw = new StringWriter();
        formatter.Format(evt, sw);

        var expected = new StructureValue(Enumerable.Empty<LogEventProperty>()).ToString();
        Assert.Equal(expected, sw.ToString());
    }

    [Theory]
    [InlineData("", true)]
    [InlineData(":lj", false)]
    [InlineData(":jl", false)]
    [InlineData(":j", false)]
    [InlineData(":l", true)]
    public void FormatProviderWithScalarProperties(string format, bool shouldUseCustomFormatter)
    {
        var frenchFormatProvider = new CultureInfo("fr-FR");
        var defaultFormatProvider = CultureInfo.InvariantCulture;

        var date = new DateTime(2018, 01, 01);
        var number = 12.345;

        var expectedFormattedDate = shouldUseCustomFormatter
            ? date.ToString(frenchFormatProvider)
            : date.ToString("O", defaultFormatProvider);
        var expectedFormattedNumber = shouldUseCustomFormatter
            ? number.ToString(frenchFormatProvider)
            : number.ToString(defaultFormatProvider);

        var formatter = new MessageTemplateTextFormatter("{Message" + format + "}", frenchFormatProvider);
        var evt = DelegatingSink.GetLogEvent(l =>
        {
            l.Information("{MyDate}{MyNumber}", date, number);
        });
        var sw = new StringWriter();
        formatter.Format(evt, sw);

        Assert.Contains(expectedFormattedDate, sw.ToString());
        Assert.Contains(expectedFormattedNumber, sw.ToString());
    }

    [Theory]
    [InlineData("", true)]
    [InlineData(":lj", false)]
    [InlineData(":jl", false)]
    [InlineData(":j", false)]
    [InlineData(":l", true)]
    public void FormatProviderWithDestructuredProperties(string format, bool shouldUseCustomFormatter)
    {
        var frenchFormatProvider = new CultureInfo("fr-FR");
        var defaultFormatProvider = CultureInfo.InvariantCulture;

        var date = new DateTime(2018, 01, 01);
        var number = 12.345;

        var expectedFormattedDate = shouldUseCustomFormatter
            ? date.ToString(frenchFormatProvider)
            : date.ToString("O", defaultFormatProvider);
        var expectedFormattedNumber = shouldUseCustomFormatter
            ? number.ToString(frenchFormatProvider)
            : number.ToString(defaultFormatProvider);

        var formatter = new MessageTemplateTextFormatter("{Message" + format + "}", frenchFormatProvider);
        var evt = DelegatingSink.GetLogEvent(l =>
        {
            l.Information("{@Item}", new
            {
                MyDate = date,
                MyNumber = number
            });
        });
        var sw = new StringWriter();
        formatter.Format(evt, sw);

        Assert.Contains(expectedFormattedDate, sw.ToString());
        Assert.Contains(expectedFormattedNumber, sw.ToString());
    }

    [Theory]
    [InlineData(15, "", "15")]
    [InlineData(15, ",5", "   15")]
    [InlineData(15, ",-5", "15   ")]
    public void PaddingIsApplied(int n, string format, string expected)
    {
        var formatter = new MessageTemplateTextFormatter("{ThreadId" + format + "}", null);
        var evt = Some.InformationEvent();
        evt.AddOrUpdateProperty(new LogEventProperty("ThreadId", new ScalarValue(n)));
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal(expected, sw.ToString());
    }

    [Fact]
    public void TraceAndSpanAreEmptyWhenAbsent()
    {
        var formatter = new MessageTemplateTextFormatter("{TraceId}/{SpanId}", CultureInfo.InvariantCulture);
        var evt = Some.LogEvent(traceId: default, spanId: default);
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("/", sw.ToString());
    }

    [Fact]
    public void TraceAndSpanAreIncludedWhenPresent()
    {
        var traceId = ActivityTraceId.CreateRandom();
        var spanId = ActivitySpanId.CreateRandom();
        var formatter = new MessageTemplateTextFormatter("{TraceId}/{SpanId}", CultureInfo.InvariantCulture);
        var evt = Some.LogEvent(traceId: traceId, spanId: spanId);
        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal($"{traceId}/{spanId}", sw.ToString());
    }

    [Fact]
    public void UtcTimestampOutputsCorrectValue()
    {
        var formatter = new MessageTemplateTextFormatter("{UtcTimestamp:yyyy-MM-dd hh:mm:ss.fffZ}", CultureInfo.InvariantCulture);

        var evt = Some.LogEvent(timestamp: new(2013, 3, 11, 15, 59, 0, 123, TimeSpan.FromHours(10)));

        var sw = new StringWriter();
        formatter.Format(evt, sw);
        Assert.Equal("2013-03-11 05:59:00.123Z", sw.ToString());
    }
}