Divergic.Logging.Xunit 1.0.0

There is a newer version of this package available.
See the version list below for details.
Install-Package Divergic.Logging.Xunit -Version 1.0.0
dotnet add package Divergic.Logging.Xunit --version 1.0.0
<PackageReference Include="Divergic.Logging.Xunit" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Divergic.Logging.Xunit --version 1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Divergic.Logging.Xunit, 1.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Divergic.Logging.Xunit as a Cake Addin
#addin nuget:?package=Divergic.Logging.Xunit&version=1.0.0

// Install Divergic.Logging.Xunit as a Cake Tool
#tool nuget:?package=Divergic.Logging.Xunit&version=1.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Introduction

Divergic.Logging.Xunit is a NuGet package that returns an ILogger or ILogger<T> provider that wraps around the ITestOutputHelper supplied by xUnit. xUnit uses this helper to write log messages to the test output of each test execution. This means that any log messages from classes being tested will end up in the xUnit test result output.

Installation

Run the following in the NuGet command line or visit the NuGet package page.

Install-Package Divergic.Logging.Xunit

Usage

The common usage of this package is to call the BuildLogger extension method on the xUnit ITestOutputHelper.

using System;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;
using Xunit.Abstractions;

public class MyClass
{
    private readonly ILogger _logger;

    public MyClass(ILogger logger)
    {
        _logger = logger;
    }

    public string DoSomething()
    {
        _logger.LogInformation("Hey, we did something");

        return Guid.NewGuid().ToString();
    }
}

public class MyClassTests
{
    private readonly ITestOutputHelper _output;
    private readonly ILogger _logger;

    public MyClassTests(ITestOutputHelper output)
    {
        _output = output;
        _logger = output.BuildLogger();
    }

    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var sut = new MyClass(_logger);

        var actual = sut.DoSomething();

        // The xUnit test output should now include the log message from MyClass.DoSomething()

        actual.Should().NotBeNullOrWhiteSpace();
    }
}

This would output the following in the test results.

Information [0]: Hey, we did something

Support for ILogger<T> is there using the BuildLoggerFor<T> extension method.

using System;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;
using Xunit.Abstractions;

public class MyClassTests
{
    private readonly ITestOutputHelper _output;
    private readonly ILogger<MyClass> _logger;

    public MyClassTests(ITestOutputHelper output)
    {
        _output = output;
        _logger = output.BuildLoggerFor<MyClass>();
    }

    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var sut = new MyClass(_logger);

        var actual = sut.DoSomething();

        // The xUnit test output should now include the log message from MyClass.DoSomething()

        actual.Should().NotBeNull();
    }
}

Inspection

Using this library makes it really easy to output log messages from your code as part of the test results. You may want to also inspect the log messages written as part of the test assertions as well.

The BuildLogger and BuildLoggerFor<T> extension methods support this by returning a ICacheLogger or ICacheLogger<T> respectively. The cache logger is a wrapper around the created logger and exposes all the log entries written by the test.

using System;
using Divergic.Logging.Xunit;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;
using Xunit.Abstractions;

public class MyClassTests
{
    private readonly ITestOutputHelper _output;
    private readonly ICacheLogger _logger;

    public MyClassTests(ITestOutputHelper output)
    {
        _output = output;
        _logger = output.BuildLogger();
    }

    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var sut = new MyClass(_logger);

        sut.DoSomething();
        
        _logger.Count.Should().Be(1);
        _logger.Entries.Should().HaveCount(1);
        _logger.Last.Message.Should().Be("Hey, we did something");
    }
}

Perhaps you don't want to use the xUnit ITestOutputHelper but still want to use the ICacheLogger to run assertions over log messages written by the class under test. You can do this by creating a CacheLogger of CacheLogger<T> directly.

using System;
using Divergic.Logging.Xunit;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;

public class MyClassTests
{
    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var logger = new CacheLogger();

        var sut = new MyClass(_logger);

        sut.DoSomething();
        
        logger.Count.Should().Be(1);
        logger.Entries.Should().HaveCount(1);
        logger.Last.Message.Should().Be("Hey, we did something");
    }
}

Configured LoggerFactory

You may have an integration or acceptance test that requires additional configuration to the log providers on ILoggerFactory while also supporting the logging out to xUnit test results. You can do this by create a factory that is already configured with xUnit support.

using System;
using Divergic.Logging.Xunit;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using Xunit;
using Xunit.Abstractions;

public class MyClassTests
{
    private readonly ILogger _logger;

    public MyClassTests(ITestOutputHelper output)
    {
        var factory = LogFactory.Create(output);

        // call factory.UseConsole or other provider extension method

        _logger = factory.CreateLogger(nameof(MyClassTests));
    }

    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var sut = new MyClass(_logger);

        // The xUnit test output should now include the log message from MyClass.DoSomething()

        var actual = sut.DoSomething();

        actual.Should().NotBeNullOrWhiteSpace();
    }
}

Existing Loggers

Already have an existing logger and want the above cache support? Got you covered there too using the WithCache() method.

using System;
using Divergic.Logging.Xunit;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using NSubstitute;
using Xunit;

public class MyClassTests
{
    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var logger = Substitute.For<ILogger>();

        logger.IsEnabled(Arg.Any<LogLevel>()).Returns(true);

        var cacheLogger = logger.WithCache();

        var sut = new MyClass(cacheLogger);

        sut.DoSomething();

        cacheLogger.Count.Should().Be(1);
        cacheLogger.Entries.Should().HaveCount(1);
        cacheLogger.Last.Message.Should().Be("Hey, we did something");
    }
}

The WithCache() also supports ILogger<T>.

using System;
using Divergic.Logging.Xunit;
using FluentAssertions;
using Microsoft.Extensions.Logging;
using NSubstitute;
using Xunit;

public class MyClassTests
{
    [Fact]
    public void DoSomethingReturnsValueTest()
    {
        var logger = Substitute.For<ILogger<MyClass>>();

        logger.IsEnabled(Arg.Any<LogLevel>()).Returns(true);

        var cacheLogger = logger.WithCache();

        var sut = new MyClass(cacheLogger);

        sut.DoSomething();

        cacheLogger.Count.Should().Be(1);
        cacheLogger.Entries.Should().HaveCount(1);
        cacheLogger.Last.Message.Should().Be("Hey, we did something");
    }
}
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Divergic.Logging.Xunit:

Package Downloads
AutoMoqFixture

Package Description

U2U.EntityFrameworkCore.Testing

Package Description

GitHub repositories (4)

Showing the top 4 popular GitHub repositories that depend on Divergic.Logging.Xunit:

Repository Stars
asynkron/protoactor-dotnet
Proto Actor - Ultra fast distributed actors for Go, C# and Java/Kotlin
imperugo/StackExchange.Redis.Extensions
sethreno/schemazen
Script and create SQL Server objects quickly
JosephWoodward/GlobalExceptionHandlerDotNet
Exception handling as a convention in the ASP.NET Core request pipeline
Version Downloads Last updated
4.0.0 1,114 1/10/2022
3.6.1-beta0010 23 1/10/2022
3.6.0 329,804 11/13/2020
3.5.2-beta0019 171 11/13/2020
3.5.2-beta0018 165 11/13/2020
3.5.2-beta0017 157 11/13/2020
3.5.2-beta0016 166 11/13/2020
3.5.2-beta0015 202 11/12/2020
3.5.2-beta0010 179 11/12/2020
3.5.2-beta0006 206 11/10/2020
3.5.2-beta0003 554 10/14/2020
3.5.2-beta0001 4,493 10/12/2020
3.5.1 71,180 10/8/2020
3.5.1-releasejob0001 285 8/4/2020
3.5.1-beta0032 259 10/8/2020
3.5.1-beta0031 196 10/8/2020
3.5.1-beta0030 210 10/8/2020
3.5.1-beta0029 278 9/27/2020
3.5.1-beta0028 225 9/15/2020
3.5.1-beta0027 216 9/9/2020
3.5.1-beta0026 212 9/9/2020
3.5.1-beta0025 209 9/2/2020
3.5.1-beta0024 200 8/21/2020
3.5.1-beta0023 249 8/15/2020
3.5.1-beta0022 260 8/12/2020
3.5.1-beta0021 202 8/12/2020
3.5.1-beta0020 220 8/11/2020
3.5.1-beta0019 249 8/8/2020
3.5.1-beta0018 255 8/8/2020
3.5.1-beta0017 264 8/8/2020
3.5.1-beta0015 237 8/5/2020
3.5.1-beta0013 210 8/4/2020
3.5.1-beta0012 209 8/4/2020
3.5.1-beta0011 213 8/4/2020
3.5.1-beta0010 224 8/2/2020
3.5.1-beta0009 261 7/31/2020
3.5.1-beta0008 259 7/31/2020
3.5.1-beta0007 272 7/31/2020
3.5.1-beta0003 274 7/31/2020
3.5.0 107,598 6/22/2020
3.5.0-beta0001 238 6/17/2020
3.4.0 69,911 4/28/2020
3.3.1-beta0004 241 4/28/2020
3.3.0 43,700 3/18/2020
3.3.0-beta0005 339 3/18/2020
3.2.2-beta0003 2,506 1/12/2020
3.2.2-beta0002 301 1/12/2020
3.2.2-beta0001 293 1/12/2020
3.2.1 186,461 12/18/2019
3.2.1-beta0001 297 12/18/2019
3.2.0 363 12/18/2019
3.2.0-beta0002 309 12/18/2019
3.1.0 177,967 9/27/2019
3.1.0-beta0002 287 9/27/2019
3.0.0 56,980 5/3/2019
2.2.0 32,959 4/18/2019
2.2.0-beta0001 317 4/18/2019
2.1.0 1,472 4/14/2019
2.1.0-beta0003 332 4/14/2019
2.1.0-beta0002 305 4/13/2019
2.0.1-beta0001 351 3/25/2019
2.0.0 33,200 3/19/2019
1.1.0 43,180 6/3/2018
1.0.0 7,112 6/1/2018
0.2.0-beta0047 221 8/5/2020
0.2.0-beta0045 215 8/4/2020
0.2.0-beta0036 222 7/31/2020
0.2.0-beta0035 223 7/31/2020
0.2.0-beta0034 274 6/22/2020