Devodo.Logging.Xunit 0.2.0

dotnet add package Devodo.Logging.Xunit --version 0.2.0
NuGet\Install-Package Devodo.Logging.Xunit -Version 0.2.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Devodo.Logging.Xunit" Version="0.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Devodo.Logging.Xunit --version 0.2.0
#r "nuget: Devodo.Logging.Xunit, 0.2.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Devodo.Logging.Xunit as a Cake Addin
#addin nuget:?package=Devodo.Logging.Xunit&version=0.2.0

// Install Devodo.Logging.Xunit as a Cake Tool
#tool nuget:?package=Devodo.Logging.Xunit&version=0.2.0

Devodo.Logging.Xunit

nuget build

An xUnit Microsoft.Extensions.Logging.ILoggerProvider that writes logs to the test output.

Its formatting and its configuration is based on the Microsoft.Extensions.Logging.Console.SimpleConsoleFormatter created from the ConsoleLoggerExtensions.AddSimpleConsole Method.

Installing

Install Devodo.Logging.Xunit as a NuGet package:

Install-Package Devodo.Logging.Xunit

Or via the .NET command line interface:

dotnet add package Devodo.Logging.Xunit

Usage

Given a simple ASP.NET Minimal API as follows:

var app = WebApplication.Create(args);

app.MapGet("/echo/{message}", (string message, ILogger<Program> logger) =>
{
    logger.LogInformation("Handling echo request with input: {Message}", message);
    
    return message;
});

app.Run();

The application logs can be sent to xUnit test output as follows:

public class ExampleTests
{
    private readonly ITestOutputHelper _outputHelper;

    public ExampleTests(ITestOutputHelper outputHelper)
    {
        _outputHelper = outputHelper;
    }
    
    [Fact]
    public async Task GivenHttpClient_WhenGetRoot_ThenRespondsHello()
    {
        // ARRANGE
        var httpClient = new WebApplicationFactory<Program>().WithWebHostBuilder(builder =>
        {
            builder.ConfigureLogging(logging =>
            {
                // Add an xUnit logging provider that writes to the ITestOutputHelper
                logging.AddXunit(_outputHelper);
            });
        }).CreateClient();

        // ACT
        var response = await httpClient.GetAsync("/echo/hello xunit logging");
        
        // ASSERT
        Assert.Equal("hello xunit logging", await response.Content.ReadAsStringAsync());
    }
}

The output from the test above is:

info: Program[0]
      Handling echo request with input: hello xunit logging

The following format options can be configured:

logging.AddXunit(_outputHelper, options =>
{
    options.IncludeScopes = true;
    options.TimestampFormat = "HH:mm:ss ";
    options.SingleLine = false;
    options.UseUtcTimestamp = true;
});
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.2.0 5,632 4/25/2023
0.1.0 219 4/22/2023