mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-03-26 11:21:51 +01:00
Add new package WireMock.Net.Extensions.Routing which provides minimal-API-style routing for WireMock.Net (#1344)
* Add new package WireMock.Net.Extensions.Routing * Update documentation for WireMock.Net.Extensions.Routing * Cleanup imports * Add header to all source files inside WireMock.Net.Extensions.Routing * Add header to all source files inside WireMock.Net.Extensions.Routing.Tests * Revert unintended changes * Remove redundant build configurations * Remove incorrect links from documentation * Update nuget package references * Revert unintended changes * Migrate to AwesomeAssertions * Remove redundant project reference * Adjust formatting * Migrate to primary constructor * Refactoring: rename delegate parameter * Abstract over JSON converter * Replace WireMock with WireMock.Net in comments * Move local functions to the bottom of the methods
This commit is contained in:
committed by
GitHub
parent
60eb519ae2
commit
be2ea67b89
153
src/WireMock.Net.Extensions.Routing/WireMockRouter.cs
Normal file
153
src/WireMock.Net.Extensions.Routing/WireMockRouter.cs
Normal file
@@ -0,0 +1,153 @@
|
||||
// Copyright © WireMock.Net
|
||||
|
||||
using JsonConverter.Abstractions;
|
||||
using JsonConverter.Newtonsoft.Json;
|
||||
using Microsoft.AspNetCore.Http;
|
||||
using Microsoft.Extensions.DependencyInjection;
|
||||
using WireMock.Matchers;
|
||||
using WireMock.Net.Extensions.Routing.Delegates;
|
||||
using WireMock.Net.Extensions.Routing.Extensions;
|
||||
using WireMock.Net.Extensions.Routing.Models;
|
||||
using WireMock.Net.Extensions.Routing.Utils;
|
||||
using WireMock.Server;
|
||||
|
||||
namespace WireMock.Net.Extensions.Routing;
|
||||
|
||||
/// <summary>
|
||||
/// Provides routing and request mapping functionality for WireMock.Net,
|
||||
/// mimicking ASP.NET Core Minimal APIs routing style.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Initializes a new instance of the <see cref="WireMockRouter"/> class.
|
||||
/// </remarks>
|
||||
/// <param name="server">The WireMock.Net server instance.</param>
|
||||
public sealed class WireMockRouter(WireMockServer server)
|
||||
{
|
||||
private readonly WireMockServer _server = server;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or initializes the collection of middleware for the router.
|
||||
/// </summary>
|
||||
public IReadOnlyCollection<WireMockMiddleware> MiddlewareCollection { get; init; } = [];
|
||||
|
||||
/// <summary>
|
||||
/// Gets or initializes the default <see cref="IJsonConverter"/> [optional].
|
||||
/// </summary>
|
||||
public IJsonConverter? DefaultJsonConverter { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or initializes the default <see cref="JsonConverterOptions"/> [optional].
|
||||
/// </summary>
|
||||
public JsonConverterOptions? DefaultJsonOptions { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Maps a route to a synchronous request handler.
|
||||
/// </summary>
|
||||
/// <param name="method">The HTTP method.</param>
|
||||
/// <param name="pattern">The route pattern.</param>
|
||||
/// <param name="requestHandler">The request handler function.</param>
|
||||
/// <returns>The current <see cref="WireMockRouter"/> instance.</returns>
|
||||
public WireMockRouter Map(
|
||||
string method, string pattern, Func<WireMockRequestInfo, object?> requestHandler)
|
||||
{
|
||||
return Map(method, pattern, CreateResponse);
|
||||
|
||||
object? CreateResponse(IRequestMessage request) =>
|
||||
requestHandler(CreateRequestInfo(request, pattern));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maps a route to an asynchronous request handler.
|
||||
/// </summary>
|
||||
/// <param name="method">The HTTP method.</param>
|
||||
/// <param name="pattern">The route pattern.</param>
|
||||
/// <param name="requestHandler">The asynchronous request handler function.</param>
|
||||
/// <returns>The current <see cref="WireMockRouter"/> instance.</returns>
|
||||
public WireMockRouter Map(
|
||||
string method, string pattern, Func<WireMockRequestInfo, Task<object?>> requestHandler)
|
||||
{
|
||||
return Map(method, pattern, CreateResponseAsync);
|
||||
|
||||
Task<object?> CreateResponseAsync(IRequestMessage request) =>
|
||||
requestHandler(CreateRequestInfo(request, pattern));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Maps a route to a request handler with a typed body.
|
||||
/// </summary>
|
||||
/// <typeparam name="TRequest">The type of the request body.</typeparam>
|
||||
/// <param name="method">The HTTP method.</param>
|
||||
/// <param name="pattern">The route pattern.</param>
|
||||
/// <param name="requestHandler">The request handler function.</param>
|
||||
/// <param name="jsonConverter">The <see cref="IJsonConverter"/> [optional]. Default value is NewtonsoftJsonConverter.</param>
|
||||
/// <param name="jsonOptions">The <see cref="JsonConverterOptions"/> [optional].</param>
|
||||
/// <returns>The current <see cref="WireMockRouter"/> instance.</returns>
|
||||
public WireMockRouter Map<TRequest>(
|
||||
string method,
|
||||
string pattern,
|
||||
Func<WireMockRequestInfo<TRequest>, object?> requestHandler,
|
||||
IJsonConverter? jsonConverter = null,
|
||||
JsonConverterOptions? jsonOptions = null)
|
||||
{
|
||||
return Map(method, pattern, CreateBody);
|
||||
|
||||
object? CreateBody(IRequestMessage request) =>
|
||||
requestHandler(CreateRequestInfo<TRequest>(request, pattern, jsonConverter, jsonOptions));
|
||||
}
|
||||
|
||||
private static WireMockRequestInfo CreateRequestInfo(IRequestMessage request, string pattern) =>
|
||||
new(request)
|
||||
{
|
||||
RouteArgs = RoutePattern.GetArgs(pattern, request.Path),
|
||||
};
|
||||
|
||||
private static WireMockHttpRequestHandler CreateHttpRequestHandler(
|
||||
Func<IRequestMessage, object?> requestHandler) =>
|
||||
request => CreateResponseMessageAsync(requestHandler(request));
|
||||
|
||||
private static async Task<ResponseMessage> CreateResponseMessageAsync(object? response)
|
||||
{
|
||||
var awaitedResponse = response is Task task
|
||||
? await task.ToGenericTaskAsync()
|
||||
: response;
|
||||
var result = awaitedResponse as IResult ?? Results.Ok(awaitedResponse);
|
||||
var httpContext = CreateHttpContext();
|
||||
await result.ExecuteAsync(httpContext);
|
||||
return await httpContext.Response.ToResponseMessageAsync();
|
||||
}
|
||||
|
||||
private static HttpContext CreateHttpContext() =>
|
||||
new DefaultHttpContext
|
||||
{
|
||||
RequestServices = new ServiceCollection().AddLogging().BuildServiceProvider(),
|
||||
Response = { Body = new MemoryStream() },
|
||||
};
|
||||
|
||||
private WireMockRequestInfo<TRequest> CreateRequestInfo<TRequest>(
|
||||
IRequestMessage request,
|
||||
string pattern,
|
||||
IJsonConverter? jsonConverter = null,
|
||||
JsonConverterOptions? jsonOptions = null)
|
||||
{
|
||||
var requestInfo = CreateRequestInfo(request, pattern);
|
||||
var establishedJsonConverter =
|
||||
jsonConverter ?? DefaultJsonConverter ?? new NewtonsoftJsonConverter();
|
||||
var establishedJsonOptions = jsonOptions ?? DefaultJsonOptions;
|
||||
return new WireMockRequestInfo<TRequest>(requestInfo.Request)
|
||||
{
|
||||
RouteArgs = requestInfo.RouteArgs,
|
||||
Body = requestInfo.Request.GetBodyAsJson<TRequest>(
|
||||
establishedJsonConverter, establishedJsonOptions),
|
||||
};
|
||||
}
|
||||
|
||||
private WireMockRouter Map(
|
||||
string method, string pattern, Func<IRequestMessage, object?> requestHandler)
|
||||
{
|
||||
var matcher = new RegexMatcher(RoutePattern.ToRegex(pattern), ignoreCase: true);
|
||||
var httpRequestHandler =
|
||||
CreateHttpRequestHandler(requestHandler).UseMiddlewareCollection(MiddlewareCollection);
|
||||
_server.Map(method, matcher, httpRequestHandler);
|
||||
return this;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user