Reo.Core.Serilog.Sinks.XunitTestOutput 8.0.625

Reo.Core.Serilog.Sinks.XunitTestOutput

Описание пакета

Пакет Reo.Core.Serilog.Sinks.XunitTestOutput предоставляет интеграцию между Serilog и xUnit, позволяя направлять логи из приложений, использующих Serilog, напрямую в вывод тестов xUnit. Это особенно полезно при тестировании сценариев, где требуется визуализация логов в рамках выполнения тестов, например, для отладки или мониторинга состояния тестов.

Основные функции:

• Отправка логов Serilog в вывод xUnit.
• Настройка формата вывода логов через шаблоны.
• Поддержка фильтрации логов по уровню серьёзности (например, только ошибки).

Основные компоненты

1. XUnitTestOutputSink

• Описание: Класс, реализующий интерфейс ILogEventSink Serilog. Отвечает за обработку и запись логов в ITestOutputHelper, используемый xUnit.
• Функции:
  • Принимает лог-события от Serilog.
  • Форматирует их с использованием предоставленного ITextFormatter.
  • Записывает результат в вывод теста через ITestOutputHelper.

2. LoggerConfigurationXunitTestOutputExtensions

• Описание: Статический класс с методом расширения для конфигурации Serilog.
• Функции:
  • Добавляет XUnitTestOutputSink в конвейер логирования Serilog.
  • Позволяет настраивать минимальный уровень логирования, формат вывода и другие параметры.
  • Использует MessageTemplateTextFormatter для форматирования логов.

Требования

Совместимость с .NET

• .NET 8.0
• .NET 9.0

Зависимости

• Serilog (версия 2.x или выше)
• xUnit (версия 2.x или выше)

Установка

Способы установки:

# NuGet Package Manager
Install-Package Reo.Core.Serilog.Sinks.XunitTestOutput

# .NET CLI
dotnet add package Reo.Core.Serilog.Sinks.XunitTestOutput

Настройка

Использование в конфигурации Serilog

Добавьте XUnitTestOutputSink в логгер Serilog через метод расширения XunitTestOutput:

using Serilog;
using Serilog.Events;
using Xunit.Abstractions;

public class TestClass : IClassFixture<TestFixture>
{
    private readonly ITestOutputHelper _output;
    private readonly ILogger _logger;

    public TestClass(ITestOutputHelper output)
    {
        _output = output;
        _logger = new LoggerConfiguration()
            .WriteTo.XunitTestOutput(_output, restrictedToMinimumLevel: LogEventLevel.Information)
            .CreateLogger();
    }
}

Настройка формата логов

По умолчанию используется шаблон:

"{Timestamp:yyyy-MM-dd HH:mm:ss} [{Level}] {Message}{NewLine}{Exception}"

Вы можете изменить формат, указав свой outputTemplate:

_logger = new LoggerConfiguration()
    .WriteTo.XunitTestOutput(_output, outputTemplate: "{Timestamp} | {Level} | {Message}")
    .CreateLogger();

Использование

Примеры кода

1. Логирование в тестах xUnit

using Serilog;
using Xunit;

public class MyTests
{
    private readonly ILogger _logger;

    public MyTests(ITestOutputHelper output)
    {
        _logger = new LoggerConfiguration()
            .WriteTo.XunitTestOutput(output)
            .CreateLogger();
    }

    [Fact]
    public void TestExample()
    {
        _logger.Information("Тестовый лог: выполнение теста");
        _logger.Error("Ошибка: неожиданный результат");

        // Дополнительные действия теста...
    }
}

2. Фильтрация логов

_logger = new LoggerConfiguration()
    .WriteTo.XunitTestOutput(_output, restrictedToMinimumLevel: LogEventLevel.Error)
    .CreateLogger();

Лицензия

Данный пакет распространяется под лицензией MIT.