sentry-dotnet/test/Sentry.Tests/SentryStructuredLoggerTests.Format.cs at 4da13f3d9a55eebf7f5864dc10900c62cf887b34 · getsentry/sentry-dotnet · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
#nullable enable

namespace Sentry.Tests;

public partial class SentryStructuredLoggerTests
{
    [Theory]
    [InlineData(SentryLogLevel.Trace)]
    [InlineData(SentryLogLevel.Debug)]
    [InlineData(SentryLogLevel.Info)]
    [InlineData(SentryLogLevel.Warning)]
    [InlineData(SentryLogLevel.Error)]
    [InlineData(SentryLogLevel.Fatal)]
    public void Log_Enabled_CapturesEnvelope(SentryLogLevel level)
    {
        _fixture.Options.EnableLogs = true;
        var logger = _fixture.GetSut();

        Envelope envelope = null!;
        _fixture.Hub.CaptureEnvelope(Arg.Do<Envelope>(arg => envelope = arg));

        logger.Log(level, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
        logger.Flush();

        _fixture.Hub.Received(1).CaptureEnvelope(Arg.Any<Envelope>());
        _fixture.AssertEnvelopeWithoutAttributes(envelope, level);
    }

    [Theory]
    [InlineData(SentryLogLevel.Trace)]
    [InlineData(SentryLogLevel.Debug)]
    [InlineData(SentryLogLevel.Info)]
    [InlineData(SentryLogLevel.Warning)]
    [InlineData(SentryLogLevel.Error)]
    [InlineData(SentryLogLevel.Fatal)]
    public void Log_Disabled_DoesNotCaptureEnvelope(SentryLogLevel level)
    {
        _fixture.Options.EnableLogs.Should().BeFalse();
        var logger = _fixture.GetSut();

        logger.Log(level, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
        logger.Flush();

        _fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
    }

    [Theory]
    [InlineData(SentryLogLevel.Trace)]
    [InlineData(SentryLogLevel.Debug)]
    [InlineData(SentryLogLevel.Info)]
    [InlineData(SentryLogLevel.Warning)]
    [InlineData(SentryLogLevel.Error)]
    [InlineData(SentryLogLevel.Fatal)]
    public void Log_ConfigureLog_Enabled_CapturesEnvelope(SentryLogLevel level)
    {
        _fixture.Options.EnableLogs = true;
        var logger = _fixture.GetSut();

        Envelope envelope = null!;
        _fixture.Hub.CaptureEnvelope(Arg.Do<Envelope>(arg => envelope = arg));

        logger.Log(level, ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
        logger.Flush();

        _fixture.Hub.Received(1).CaptureEnvelope(Arg.Any<Envelope>());
        _fixture.AssertEnvelope(envelope, level);
    }

    [Theory]
    [InlineData(SentryLogLevel.Trace)]
    [InlineData(SentryLogLevel.Debug)]
    [InlineData(SentryLogLevel.Info)]
    [InlineData(SentryLogLevel.Warning)]
    [InlineData(SentryLogLevel.Error)]
    [InlineData(SentryLogLevel.Fatal)]
    public void Log_ConfigureLog_Disabled_DoesNotCaptureEnvelope(SentryLogLevel level)
    {
        _fixture.Options.EnableLogs.Should().BeFalse();
        var logger = _fixture.GetSut();

        logger.Log(level, ConfigureLog, "Template string with arguments: {0}, {1}, {2}, {3}", "string", true, 1, 2.2);
        logger.Flush();

        _fixture.Hub.Received(0).CaptureEnvelope(Arg.Any<Envelope>());
    }

    [Theory]
    [InlineData(SentryLogLevel.Trace)]
    [InlineData(SentryLogLevel.Debug)]
    [InlineData(SentryLogLevel.Info)]
    [InlineData(SentryLogLevel.Warning)]
    [InlineData(SentryLogLevel.Error)]
    [InlineData(SentryLogLevel.Fatal)]
    public void Log_WithoutParameters_DoesNotAttachTemplateAttribute(SentryLogLevel level)
    {
        _fixture.Options.EnableLogs = true;
        var logger = _fixture.GetSut();

        Envelope envelope = null!;
        _fixture.Hub.CaptureEnvelope(Arg.Do<Envelope>(arg => envelope = arg));

        logger.Log(level, "Message Text");
        logger.Flush();

        _fixture.Hub.Received(1).CaptureEnvelope(Arg.Any<Envelope>());
        var log = envelope.ShouldContainSingleLog();

        log.Level.Should().Be(level);
        log.Message.Should().Be("Message Text");
        log.Template.Should().BeNull();
        log.Parameters.Should().BeEmpty();

        log.TryGetAttribute("sentry.message.template", out object? template).Should().BeFalse();
        template.Should().BeNull();
    }
}

file static class SentryStructuredLoggerExtensions
{
    public static void Log(this SentryStructuredLogger logger, SentryLogLevel level, string template, params object[] parameters)
    {
        switch (level)
        {
            case SentryLogLevel.Trace:
                logger.LogTrace(template, parameters);
                break;
            case SentryLogLevel.Debug:
                logger.LogDebug(template, parameters);
                break;
            case SentryLogLevel.Info:
                logger.LogInfo(template, parameters);
                break;
            case SentryLogLevel.Warning:
                logger.LogWarning(template, parameters);
                break;
            case SentryLogLevel.Error:
                logger.LogError(template, parameters);
                break;
            case SentryLogLevel.Fatal:
                logger.LogFatal(template, parameters);
                break;
            default:
                throw new ArgumentOutOfRangeException(nameof(level), level, null);
        }
    }

    public static void Log(this SentryStructuredLogger logger, SentryLogLevel level, Action<SentryLog> configureLog, string template, params object[] parameters)
    {
        switch (level)
        {
            case SentryLogLevel.Trace:
                logger.LogTrace(configureLog, template, parameters);
                break;
            case SentryLogLevel.Debug:
                logger.LogDebug(configureLog, template, parameters);
                break;
            case SentryLogLevel.Info:
                logger.LogInfo(configureLog, template, parameters);
                break;
            case SentryLogLevel.Warning:
                logger.LogWarning(configureLog, template, parameters);
                break;
            case SentryLogLevel.Error:
                logger.LogError(configureLog, template, parameters);
                break;
            case SentryLogLevel.Fatal:
                logger.LogFatal(configureLog, template, parameters);
                break;
            default:
                throw new ArgumentOutOfRangeException(nameof(level), level, null);
        }
    }
}