WestDiscGolf.MoqExtensions 1.0.0-ci-9

MoqExtensions

Extension method for using Moq with Microsoft.Extensions.Logger

Forked from https://github.com/WestDiscGolf/Random/tree/master/LoggerUnitTests

Original Blog Post | Tracking package request

Installing KeyValueRepo

You should install Extensions with NuGet:

Install-Package WestDiscGolf.MoqExtensions

Or via the .NET Core command line interface:

dotnet add package WestDiscGolf.MoqExtensions

Either command, from Package Manager Console or .NET Core CLI, will download and install all required dependencies.

Contributing

• PRs should be against the develop branch.
• Merged PRs to develop will trigger a [version]-ci-[buildnumber] deployment to nuget, assuming all unit tests pass.
• Merged PRs to main will trigger a [version] deployment to nuget, assuming all of the tests pass.
• Merges to all other pranches will trigger a CI action to run all unit tests

Versioning

The package version is defined in the MoqExtensions.csproj file, using .NET SDK style structure. We follow semantic versioning for this package.

Usage

Use these extensions when working with Moq and Microsoft.Extensions.Logging.ILogger<> since Microsoft's implementation of the ILogger mostly relies on extension methods, and not on methods defined in the actual ILogger interface. This extension method takes a "mock around" approach - to get around the ILogger extension methods and to assert against what they are doing beneath the abstractions.

Examples

More examples in LoggerTest.cs

    [Fact]
    public void VerifyWasCalledWithReusableExtension()
    {
        // Arrange
        var loggerMock = new Mock<ILogger<PleaseTestMe>>();
        var sut = new PleaseTestMe(loggerMock.Object);

        // Act
        sut.RunMe();

        // Assert
        loggerMock.VerifyDebugWasCalled();
    }

    [Fact]
    public void VerifyWasCalledWithReusableExtensionWithMessage()
    {
        // Arrange
        var loggerMock = new Mock<ILogger<PleaseTestMe>>();
        var sut = new PleaseTestMe(loggerMock.Object);

        // Act
        sut.RunMe();

        // Assert
        loggerMock.VerifyDebugWasCalled("Logging this ...");
    }

    [Fact]
    public void VerifyLoopTest_2()
    {
        // Arrange
        var loggerMock = new Mock<ILogger<PleaseTestMe>>();
        var sut = new PleaseTestMe(loggerMock.Object);

        // Act
        sut.RunMeLoop();

        // Assert
        loggerMock.VerifyLogging("Logging Multiple Times ...", LogLevel.Debug, Times.Exactly(3));
    }

More examples in LoggerTest.cs