starred/WireMock.Net
1
0
Fork 0
mirror of https://github.com/wiremock/WireMock.Net.git synced 2026-08-29 22:57:19 +02:00
Code Issues 32 Packages Projects Releases 10 Wiki Activity

Add support for logging to an xUnit ITestOutputHelper #423

New Issue
Closed
opened 2025-12-29 08:27:58 +01:00 by adam · 3 comments
adam commented 2025-12-29 08:27:58 +01:00
Owner
Copy Link
Copy Source

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 08:27:58 +01:00
adam closed this issue 2025-12-29 08:27:58 +01:00
adam commented 2025-12-29 08:27:59 +01:00
Author
Owner
Copy Link
Copy Source

@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 08:27:59 +01:00
Author
Owner
Copy Link
Copy Source

@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 08:27:59 +01:00
Author
Owner
Copy Link
Copy Source

@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`.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
bug
bug
doc
doc
duplicate
feature
feature
invalid
pull-request
Mirrored from GitHub Pull Request
 question
wontfix
No labels feature
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/WireMock.Net#423