Anarchy.Toolkit.Testing.MockServer
Part of Anarchy I/O Toolkit, a .NET developer platform · Pillar: Infrastructure · Layer: Testing kit · Package catalog
Test helpers for Anarchy.Toolkit.Web.MockServer: assert which requests the mock server received.
dotnet add package Anarchy.Toolkit.Testing.MockServer
MockServerClienttalks to the server’s/__mockcontrol API: received requests, runtime expectations, resets.RecordedRequestAssertionsassert on what was received (ShouldHaveReceived,ShouldNotHaveReceived,ShouldAllHaveBeenMatched,AssertReceivedAsync), with failures listing the requests that were actually received.RecordedRequestsFile.Readreads the JSON-lines file written with--record, so you can assert after the server stopped.MockServerFixtureconnects to the server atMOCKSERVER_URL(set by the AnarchyIMockServerBuildtargets), or spawns one withMockServerProcess.
When to use it
Use it in integration and end-to-end tests whose application calls HTTP services that the mock server stands in for. Most of the time the mock server is started outside the tests (by Anarchy automation or a Makefile), so tests only assert. Spawning it from the tests is there for when they run on their own, e.g. from an IDE.
How to use it
public sealed class IdentityMockServer : MockServerFixture
{
// Only used when MOCKSERVER_URL is not set and the fixture spawns the server itself.
protected override void Configure(MockServerProcessOptions options) => options.ExpectationPaths.Add("mocks");
}
public class UserRegistrationTests(IdentityMockServer mock) : IClassFixture<IdentityMockServer>
{
[Fact]
public async Task Register_CreatesTheUserInTheIdentityService()
{
await mock.Client.ResetAsync();
await mock.Client.AddExpectationAsync("POST", "/clients/{id}/users", 201);
// … call the application, configured to reach the identity service at mock.BaseAddress …
var requests = await mock.Client.AssertReceivedAsync("POST", "/clients/{id}/users", times: 1);
requests[0].BodyAs<CreateUserRequest>()!.Email.Should().Be("jane.doe@example.com");
}
}
Paths in assertions are exact, {param} templates or regular expressions, as in expectations. MockServerProcess
runs the Anarchy.Toolkit.Web.MockServer assembly copied next to the tests, or dotnet runs
MockServerProcessOptions.ProjectPath when you have a host of your own; it stops the server, and everything it started,
on dispose.
Releases
See the release notes for the complete release history.