Write Better Integration Tests With WireMock

Integration testing is a critical part of software development, ensuring that different components of your application work together as expected. WireMock is a powerful tool for simulating HTTP-based APIs, making it easier to write reliable integration tests. In this article, we’ll explore how to use WireMock in .NET to improve your integration testing workflow.

What is WireMock?

WireMock is a library for stubbing and mocking web services. It allows you to create a mock server that simulates the behavior of real APIs, enabling you to test your application without relying on external services. This is particularly useful for testing edge cases, error handling, and scenarios where external APIs are unavailable or unreliable.

Getting Started with WireMock in .NET

To use WireMock in your .NET projects, you’ll need to install the `WireMock.Net` NuGet package. You can do this via the NuGet Package Manager or by running the following command in the Package Manager Console:

Install-Package WireMock.Net

Setting Up WireMock

Once installed, you can start using WireMock in your integration tests. Below is an example of how to set up a WireMock server and define a simple stub:

using WireMock.Server;
using WireMock.RequestBuilders;
using WireMock.ResponseBuilders;

public class WireMockTests
{
private WireMockServer _server;

[SetUp]
public void Setup()
{
// Start the WireMock server
_server = WireMockServer.Start();
}

[Test]
public void TestExampleApi()
{
// Define a stub for a GET request
_server.Given(
Request.Create().WithPath("/api/example").UsingGet()
)
.RespondWith(
Response.Create()
.WithStatusCode(200)
.WithBody("Hello, WireMock!")
);

// Use HttpClient to send a request to the mock server
var client = new HttpClient();
var response = client.GetAsync($"{_server.Urls[0]}/api/example").Result;

// Assert the response
Assert.AreEqual(200, (int)response.StatusCode);
Assert.AreEqual("Hello, WireMock!", response.Content.ReadAsStringAsync().Result);
}

[TearDown]
public void TearDown()
{
// Stop the WireMock server
_server.Stop();
}
}

You Should Know: Advanced WireMock Features

WireMock offers a wide range of features to simulate complex API behaviors. Here are some advanced use cases:

Dynamic Responses: You can configure WireMock to return dynamic responses based on request parameters.

_server.Given(
Request.Create().WithPath("/api/dynamic").UsingGet()
)
.RespondWith(
Response.Create()
.WithStatusCode(200)
.WithBody(request => $"Hello, {request.Query["name"]}!")
);

Request Matching: WireMock allows you to match requests based on headers, cookies, and JSON bodies.

_server.Given(
Request.Create()
.WithPath("/api/match")
.WithHeader("Authorization", "Bearer token")
.UsingPost()
)
.RespondWith(
Response.Create().WithStatusCode(200)
);

Simulating Delays: You can simulate network latency by adding delays to responses.

_server.Given(
Request.Create().WithPath("/api/delay").UsingGet()
)
.RespondWith(
Response.Create()
.WithStatusCode(200)
.WithDelay(TimeSpan.FromSeconds(2))
);

Recording and Playback: WireMock can record requests and responses from a real API and replay them during tests.
```
_server = WireMockServer.StartWithAdminInterface();
_server.StartRecording("http://real-api.com");
```

What Undercode Say

WireMock is an invaluable tool for .NET developers looking to improve their integration testing practices. By simulating real-world API behaviors, you can ensure your application is robust and reliable. Whether you’re testing edge cases, handling errors, or simulating network conditions, WireMock provides the flexibility and power you need.

Expected Output:

WireMock Documentation: https://wiremock.org/docs/
WireMock.NET GitHub Repository: https://github.com/WireMock-Net/WireMock.Net
Clean Architecture Template: https://dub.sh/caw11

By incorporating WireMock into your testing strategy, you can write better integration tests, reduce dependencies on external services, and deliver higher-quality software.