|
| 1 | +using System; |
| 2 | +using Serilog.Configuration; |
| 3 | +using Serilog.Core; |
| 4 | +using Serilog.Events; |
| 5 | +using Serilog.Formatting; |
| 6 | +using Serilog.Formatting.Display; |
| 7 | +using Serilog.Sinks.XUnit; |
| 8 | +using Xunit.Abstractions; |
| 9 | + |
| 10 | +namespace Serilog |
| 11 | +{ |
| 12 | + /// <summary> |
| 13 | + /// Adds the WriteTo.TestOutput() extension method to <see cref="LoggerConfiguration"/>. |
| 14 | + /// </summary> |
| 15 | + public static class TestOutputLoggerConfigurationExtensions |
| 16 | + { |
| 17 | + internal const string DefaultConsoleOutputTemplate = "{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}"; |
| 18 | + |
| 19 | + /// <summary> |
| 20 | + /// Writes log events to <see cref="ITestOutputHelper"/>. |
| 21 | + /// </summary> |
| 22 | + /// <param name="sinkConfiguration">Logger sink configuration.</param> |
| 23 | + /// <param name="messageSink">The <see cref="IMessageSink"/> that will be written to.</param> |
| 24 | + /// <param name="restrictedToMinimumLevel">The minimum level for |
| 25 | + /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param> |
| 26 | + /// <param name="outputTemplate">A message template describing the format used to write to the sink. |
| 27 | + /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}".</param> |
| 28 | + /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param> |
| 29 | + /// <param name="levelSwitch">A switch allowing the pass-through minimum level to be changed at runtime.</param> |
| 30 | + /// <returns>Configuration object allowing method chaining.</returns> |
| 31 | + public static LoggerConfiguration TestOutput( |
| 32 | + this LoggerSinkConfiguration sinkConfiguration, |
| 33 | + IMessageSink messageSink, |
| 34 | + LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, |
| 35 | + string outputTemplate = DefaultConsoleOutputTemplate, |
| 36 | + IFormatProvider formatProvider = null, |
| 37 | + LoggingLevelSwitch levelSwitch = null) |
| 38 | + { |
| 39 | + if (sinkConfiguration == null) |
| 40 | + throw new ArgumentNullException(nameof(sinkConfiguration)); |
| 41 | + if (messageSink == null) |
| 42 | + throw new ArgumentNullException(nameof(messageSink)); |
| 43 | + |
| 44 | + var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider); |
| 45 | + |
| 46 | + return sinkConfiguration.Sink(new TestOutputSink(messageSink, formatter), restrictedToMinimumLevel, levelSwitch); |
| 47 | + } |
| 48 | + |
| 49 | + /// <summary> |
| 50 | + /// Writes log events to <see cref="ITestOutputHelper"/>. |
| 51 | + /// </summary> |
| 52 | + /// <param name="sinkConfiguration">Logger sink configuration.</param> |
| 53 | + /// <param name="messageSink">The <see cref="IMessageSink"/> that will be written to.</param> |
| 54 | + /// <param name="formatter">Controls the rendering of log events into text, for example to log JSON. To |
| 55 | + /// control plain text formatting, use the overload that accepts an output template.</param> |
| 56 | + /// <param name="restrictedToMinimumLevel">The minimum level for |
| 57 | + /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param> |
| 58 | + /// <param name="levelSwitch">A switch allowing the pass-through minimum level |
| 59 | + /// to be changed at runtime.</param> |
| 60 | + /// <returns>Configuration object allowing method chaining.</returns> |
| 61 | + public static LoggerConfiguration TestOutput( |
| 62 | + this LoggerSinkConfiguration sinkConfiguration, |
| 63 | + IMessageSink messageSink, |
| 64 | + ITextFormatter formatter, |
| 65 | + LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, |
| 66 | + LoggingLevelSwitch levelSwitch = null) |
| 67 | + { |
| 68 | + if (sinkConfiguration == null) |
| 69 | + throw new ArgumentNullException(nameof(sinkConfiguration)); |
| 70 | + if (formatter == null) |
| 71 | + throw new ArgumentNullException(nameof(formatter)); |
| 72 | + |
| 73 | + return sinkConfiguration.Sink(new TestOutputSink(messageSink, formatter), restrictedToMinimumLevel, levelSwitch); |
| 74 | + } |
| 75 | + |
| 76 | + /// <summary> |
| 77 | + /// Writes log events to <see cref="ITestOutputHelper"/>. |
| 78 | + /// </summary> |
| 79 | + /// <param name="sinkConfiguration">Logger sink configuration.</param> |
| 80 | + /// <param name="testOutputHelper">The <see cref="ITestOutputHelper"/> that will be written to.</param> |
| 81 | + /// <param name="restrictedToMinimumLevel">The minimum level for |
| 82 | + /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param> |
| 83 | + /// <param name="outputTemplate">A message template describing the format used to write to the sink. |
| 84 | + /// the default is "{Timestamp} [{Level}] {Message}{NewLine}{Exception}".</param> |
| 85 | + /// <param name="formatProvider">Supplies culture-specific formatting information, or null.</param> |
| 86 | + /// <param name="levelSwitch">A switch allowing the pass-through minimum level to be changed at runtime.</param> |
| 87 | + /// <returns>Configuration object allowing method chaining.</returns> |
| 88 | + public static LoggerConfiguration TestOutput( |
| 89 | + this LoggerSinkConfiguration sinkConfiguration, |
| 90 | + ITestOutputHelper testOutputHelper, |
| 91 | + LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, |
| 92 | + string outputTemplate = DefaultConsoleOutputTemplate, |
| 93 | + IFormatProvider formatProvider = null, |
| 94 | + LoggingLevelSwitch levelSwitch = null) |
| 95 | + { |
| 96 | + if (sinkConfiguration == null) |
| 97 | + throw new ArgumentNullException(nameof(sinkConfiguration)); |
| 98 | + if (testOutputHelper == null) |
| 99 | + throw new ArgumentNullException(nameof(testOutputHelper)); |
| 100 | + |
| 101 | + var formatter = new MessageTemplateTextFormatter(outputTemplate, formatProvider); |
| 102 | + |
| 103 | + return sinkConfiguration.Sink(new TestOutputSink(testOutputHelper, formatter), restrictedToMinimumLevel, levelSwitch); |
| 104 | + } |
| 105 | + |
| 106 | + /// <summary> |
| 107 | + /// Writes log events to <see cref="ITestOutputHelper"/>. |
| 108 | + /// </summary> |
| 109 | + /// <param name="sinkConfiguration">Logger sink configuration.</param> |
| 110 | + /// <param name="testOutputHelper">The <see cref="ITestOutputHelper"/> that will be written to.</param> |
| 111 | + /// <param name="formatter">Controls the rendering of log events into text, for example to log JSON. To |
| 112 | + /// control plain text formatting, use the overload that accepts an output template.</param> |
| 113 | + /// <param name="restrictedToMinimumLevel">The minimum level for |
| 114 | + /// events passed through the sink. Ignored when <paramref name="levelSwitch"/> is specified.</param> |
| 115 | + /// <param name="levelSwitch">A switch allowing the pass-through minimum level |
| 116 | + /// to be changed at runtime.</param> |
| 117 | + /// <returns>Configuration object allowing method chaining.</returns> |
| 118 | + public static LoggerConfiguration TestOutput( |
| 119 | + this LoggerSinkConfiguration sinkConfiguration, |
| 120 | + ITestOutputHelper testOutputHelper, |
| 121 | + ITextFormatter formatter, |
| 122 | + LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum, |
| 123 | + LoggingLevelSwitch levelSwitch = null) |
| 124 | + { |
| 125 | + if (sinkConfiguration == null) |
| 126 | + throw new ArgumentNullException(nameof(sinkConfiguration)); |
| 127 | + if (formatter == null) |
| 128 | + throw new ArgumentNullException(nameof(formatter)); |
| 129 | + |
| 130 | + return sinkConfiguration.Sink(new TestOutputSink(testOutputHelper, formatter), restrictedToMinimumLevel, levelSwitch); |
| 131 | + } |
| 132 | + } |
| 133 | +} |
0 commit comments