ConnectingApps.Xunit.TestLogger 1.2.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package ConnectingApps.Xunit.TestLogger --version 1.2.1
                    


                    

                
NuGet\Install-Package ConnectingApps.Xunit.TestLogger -Version 1.2.1
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="ConnectingApps.Xunit.TestLogger" Version="1.2.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="ConnectingApps.Xunit.TestLogger" Version="1.2.1" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="ConnectingApps.Xunit.TestLogger" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add ConnectingApps.Xunit.TestLogger --version 1.2.1
                    


                    

                
#r "nuget: ConnectingApps.Xunit.TestLogger, 1.2.1"
#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. 
#:package ConnectingApps.Xunit.TestLogger@1.2.1
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=ConnectingApps.Xunit.TestLogger&version=1.2.1
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=ConnectingApps.Xunit.TestLogger&version=1.2.1
                    


                            Install as a Cake Tool

Xunit.TestLogger

Before this NuGet package

If you make integration tests with xUnit, your logging is gone. You can just see if the test succeeds or fails but you cannot see why as you don't have the logging to help you understanding what happened during the runtime of the test, which makes it hard to solve it.

Now

The is situation is different now! The problem is solved for .NET 6, .NET 7 and .NET 8 (and .NET 9 in preview). Alle you need to do is stop using this way of creating a WebApplicationFactory:

public NoLoggingTest()
{
    _factory = new WebApplicationFactory<Program>();
}

and start creating it this way

public ImprovedLoggingTest(ITestOutputHelper output)
{
    _factory = new TestLoggerWebApplicationFactory<Program>(output);
}

Here is how it looks like:

Link To ScreenShot Alt text

In Detail

Assume you have the following controller method (just the method from the template in Visual Studio with some logging added):

[HttpGet(Name = "GetWeatherForecast")]
public IEnumerable<WeatherForecast> Get()
{
    // first do some logging
    _logger.LogInformation("This should be logged during testing");
    // Then return an object like it is done in the VS Template
    return Enumerable.Range(1, 5).Select(index => new WeatherForecast
    {
        Date = DateTime.Now.AddDays(index),
        TemperatureC = Random.Shared.Next(-20, 55),
        Summary = Summaries[Random.Shared.Next(Summaries.Length)]
    })
    .ToArray();
}

then you can test it like this:

using ConnectingApps.Xunit.TestLogger;
using System.Net;
using Xunit.Abstractions;

namespace ConnectingApps.LoggingWebApi.IntegrationTest
{
    public class ImprovedLoggingTest : IDisposable
    {
        private readonly TestLoggerWebApplicationFactory<Program> _factory;
        private readonly HttpClient _client;


        public ImprovedLoggingTest(ITestOutputHelper output)
        {
            _factory = new TestLoggerWebApplicationFactory<Program>(output);
            _client = _factory.CreateClient();
        }

        [Fact]
        public async Task ReadInTestOutputIfSomethingIsLogged()
        {
            var response = await _client.GetAsync("/WeatherForecast");
            Assert.Equal(HttpStatusCode.OK, response.StatusCode);
        }

        public void Dispose()
        {
            _factory.Dispose();
            _client.Dispose();
        }
    }
}

As a result, "This should be logged during testing" will be shown in the test output.

Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  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 is compatible.  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 is compatible.  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.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows 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
1.2.1 2,833 11/16/2024
1.2.0-net9support 92 5/20/2024
1.1.0 3,853 11/14/2023
1.0.3 145 10/19/2023
1.0.2-preview 98 10/19/2023
1.0.1-preview 160 10/18/2023
1.0.0-preview 169 10/18/2023

Full Support for .NET 9