Add support for logging to an xUnit ITestOutputHelper #423

New Issue

adam · 2025-12-29T15:23:31+01:00

adam commented

2025-12-29 15:23:31 +01:00

Originally created by @siewers on GitHub (May 20, 2022).

Is your feature request related to a problem? Please describe.
When using xUnit, it would be nice to be able to log the output from WireMock to the test output helper.

Describe the solution you'd like
Introduce a new WireMock.Net.XUnit project and create a TestOutputHelperWireMockLogger class, for logging to an ITestOutputHelper.

Describe alternatives you've considered
Keeping the implementation in my own code base.

Is your feature request supported by WireMock (java version)? Please provide details.
Not to my knowledge, no. XUnit is a .NET testing framework, so there is no direct Java equivalent.

Additional context
This is the implementation I'm currently using:

private sealed class TestOutputHelperWireMockLogger : IWireMockLogger
{
    private readonly ITestOutputHelper _testOutputHelper;

    public TestOutputHelperWireMockLogger(ITestOutputHelper testOutputHelper)
    {
        _testOutputHelper = testOutputHelper;
    }

    public void Debug(string formatString, params object[] args)
    {
        _testOutputHelper.WriteLine(Format("Debug", formatString, args));
    }

    public void Info(string formatString, params object[] args)
    {
        _testOutputHelper.WriteLine(Format("Info", formatString, args));
    }

    public void Warn(string formatString, params object[] args)
    {
        _testOutputHelper.WriteLine(Format("Warning", formatString, args));
    }

    public void Error(string formatString, params object[] args)
    {
        _testOutputHelper.WriteLine(Format("Error", formatString, args));
    }

    public void Error(string formatString, Exception exception)
    {
        _testOutputHelper.WriteLine(Format("Error", formatString, exception.Message));

        if (exception is AggregateException ae)
        {
            ae.Handle(ex =>
            {
                _testOutputHelper.WriteLine(Format("Error", "Exception {0}", ex.Message));
                return true;
            });
        }
    }

    public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest)
    {
        var message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented);
        _testOutputHelper.WriteLine(Format("DebugRequestResponse", "Admin[{0}] {1}", isAdminRequest, message));
    }

    private static string Format(string level, string formatString, params object[] args)
    {
        var message = args.Length > 0 ? string.Format(formatString, args) : formatString;

        return $"{DateTime.UtcNow} [{level}] : {message}";
    }
}

Originally created by @siewers on GitHub (May 20, 2022). **Is your feature request related to a problem? Please describe.** When using xUnit, it would be nice to be able to log the output from WireMock to the test output helper. **Describe the solution you'd like** Introduce a new `WireMock.Net.XUnit` project and create a TestOutputHelperWireMockLogger class, for logging to an `ITestOutputHelper`. **Describe alternatives you've considered** Keeping the implementation in my own code base. **Is your feature request supported by [WireMock (java version)](https://www.wiremock.org)? Please provide details.** Not to my knowledge, no. XUnit is a .NET testing framework, so there is no direct Java equivalent. **Additional context** This is the implementation I'm currently using: ```cs private sealed class TestOutputHelperWireMockLogger : IWireMockLogger { private readonly ITestOutputHelper _testOutputHelper; public TestOutputHelperWireMockLogger(ITestOutputHelper testOutputHelper) { _testOutputHelper = testOutputHelper; } public void Debug(string formatString, params object[] args) { _testOutputHelper.WriteLine(Format("Debug", formatString, args)); } public void Info(string formatString, params object[] args) { _testOutputHelper.WriteLine(Format("Info", formatString, args)); } public void Warn(string formatString, params object[] args) { _testOutputHelper.WriteLine(Format("Warning", formatString, args)); } public void Error(string formatString, params object[] args) { _testOutputHelper.WriteLine(Format("Error", formatString, args)); } public void Error(string formatString, Exception exception) { _testOutputHelper.WriteLine(Format("Error", formatString, exception.Message)); if (exception is AggregateException ae) { ae.Handle(ex => { _testOutputHelper.WriteLine(Format("Error", "Exception {0}", ex.Message)); return true; }); } } public void DebugRequestResponse(LogEntryModel logEntryModel, bool isAdminRequest) { var message = JsonConvert.SerializeObject(logEntryModel, Formatting.Indented); _testOutputHelper.WriteLine(Format("DebugRequestResponse", "Admin[{0}] {1}", isAdminRequest, message)); } private static string Format(string level, string formatString, params object[] args) { var message = args.Length > 0 ? string.Format(formatString, args) : formatString; return $"{DateTime.UtcNow} [{level}] : {message}"; } } ```

adam added the feature label 2025-12-29 15:23:31 +01:00

adam closed this issue

2025-12-29 15:23:32 +01:00

adam commented

2025-12-29 15:23:32 +01:00

@StefH commented on GitHub (May 20, 2022):

https://github.com/WireMock-Net/WireMock.Net/pull/759

@StefH commented on GitHub (May 20, 2022): https://github.com/WireMock-Net/WireMock.Net/pull/759

adam commented

2025-12-29 15:23:33 +01:00

@StefH commented on GitHub (May 20, 2022):

@siewers
How to use this in the xunit test ?
Or is just referencing the new project enough?

@StefH commented on GitHub (May 20, 2022): @siewers How to use this in the xunit test ? Or is just referencing the new project enough?

adam commented

2025-12-29 15:23:33 +01:00

@siewers commented on GitHub (May 20, 2022):

It should be sufficient to reference the project.
Normally you already have a reference to xUnit, but since it can't write to the console, you need to use the ITestOutputHelper.

@siewers commented on GitHub (May 20, 2022): It should be sufficient to reference the project. Normally you already have a reference to xUnit, but since it can't write to the console, you need to use the `ITestOutputHelper`.

adam referenced this issue

2025-12-29 15:34:12 +01:00

[PR #423] [MERGED] Fixes for Cookie and Header Reject on Match #910

Sign in to join this conversation.

Branches Tags

master

mime-part-matcher

version-2.x

MappingSerializer

1341-mapping-json

stef-aspire-tests-updates

bug/973-TinyMapper

bug/1149-AppendGuidToSavedMappingFile

feature/1150-DockerImageVersion

61

stef-1108

stef-1097

stef-1083-MessageOptions_Type_Conflict

stef-1062-logger

stef-IgnoreOpenApiErrors

stef-928-TypeLoadException-FluentAssertions-net472

nunit

stef-849

stef-847-regex-questionmark

http_verb

WireMockServerContext

webapp

ai

CommandLineArgumentsParser

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/WireMock.Net-wiremock#423