Add WireMock.Net.AspNetCore.Middleware

.github/workflows/ci.yml

@@ -23,6 +23,7 @@ jobs:
       run: |
         dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0
         dotnet test './test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj' -c Release --framework net8.0
+        dotnet test './test/WireMock.Net.Middleware.Tests/WireMock.Net.Middleware.Tests.csproj' -c Release --framework net8.0
 
   linux-build-and-run:
     name: Run Tests on Linux
@@ -38,6 +39,7 @@ jobs:
       run: |
         dotnet test './test/WireMock.Net.Tests/WireMock.Net.Tests.csproj' -c Release --framework net8.0
         dotnet test './test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj' -c Release --framework net8.0
+        dotnet test './test/WireMock.Net.Middleware.Tests/WireMock.Net.Middleware.Tests.csproj' -c Release --framework net8.0
 
     - name: Install .NET Aspire workload
       run: dotnet workload install aspire

WireMock.Net Solution.sln

@@ -131,10 +131,18 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Aspire.TestApp
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AspireApp1.AppHostOriginal", "examples-Aspire\AspireApp1.AppHostOriginal\AspireApp1.AppHostOriginal.csproj", "{C9210DA3-F390-4598-8512-349A473FE9C9}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WireMock.Net.TUnit", "src\WireMock.Net.TUnit\WireMock.Net.TUnit.csproj", "{91024A93-848F-4A02-AF53-5EBE5834E23C}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.TUnit", "src\WireMock.Net.TUnit\WireMock.Net.TUnit.csproj", "{91024A93-848F-4A02-AF53-5EBE5834E23C}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.TUnitTests", "test\WireMock.Net.TUnitTests\WireMock.Net.TUnitTests.csproj", "{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WireMock.Net.WebApplication", "examples\WireMock.Net.WebApplication\WireMock.Net.WebApplication.csproj", "{E72ADFAB-4B42-439E-B1EE-C06E504B35D2}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.AspNetCore.Middleware", "src\WireMock.Net.AspNetCore.Middleware\WireMock.Net.AspNetCore.Middleware.csproj", "{B6269AAC-170A-4346-8B9A-579DED3D9A13}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.TestWebApplication", "test\WireMock.Net.TestWebApplication\WireMock.Net.TestWebApplication.csproj", "{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.Middleware.Tests", "test\WireMock.Net.Middleware.Tests\WireMock.Net.Middleware.Tests.csproj", "{A5FEF4F7-7DA2-4962-89A8-16BA942886E5}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -329,6 +337,22 @@ Global
 		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A5FEF4F7-7DA2-4962-89A8-16BA942886E5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A5FEF4F7-7DA2-4962-89A8-16BA942886E5}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A5FEF4F7-7DA2-4962-89A8-16BA942886E5}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A5FEF4F7-7DA2-4962-89A8-16BA942886E5}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -383,6 +407,10 @@ Global
 		{C9210DA3-F390-4598-8512-349A473FE9C9} = {AD474543-0715-49F2-A284-936B060BF736}
 		{91024A93-848F-4A02-AF53-5EBE5834E23C} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 		{4CD237F7-B616-46B8-872F-E49B4BBB3EAE} = {0BB8B634-407A-4610-A91F-11586990767A}
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
+		{6B30AA9F-DA04-4EB5-B03C-45A8EF272ECE} = {0BB8B634-407A-4610-A91F-11586990767A}
+		{A5FEF4F7-7DA2-4962-89A8-16BA942886E5} = {0BB8B634-407A-4610-A91F-11586990767A}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

azure-pipelines-ci.yml

@@ -54,6 +54,7 @@ jobs:
       script: |
           dotnet-coverage collect "dotnet test ./test/WireMock.Net.Tests/WireMock.Net.Tests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-xunit.xml"
           dotnet-coverage collect "dotnet test ./test/WireMock.Net.TUnitTests/WireMock.Net.TUnitTests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-tunit.xml"
+          dotnet-coverage collect "dotnet test ./test/WireMock.Net.Middleware.Tests/WireMock.Net.Middleware.Tests.csproj --configuration Debug --no-build --framework net8.0" -f xml -o "wiremock-coverage-middleware.xml"
     displayName: 'Execute WireMock.Net.Tests with Coverage'
 
   - task: CmdLine@2

examples/WireMock.Net.WebApplication/Program.cs

@@ -0,0 +1,56 @@
+using WireMock.Net.AspNetCore.Middleware;
+using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+
+var builder = WebApplication.CreateBuilder(args);
+
+if (!builder.Environment.IsProduction())
+{
+    builder.Services.AddWireMockService(server =>
+    {
+        server.Given(Request.Create()
+            .WithPath("/test1")
+            .UsingAnyMethod()
+        ).RespondWith(Response.Create()
+            .WithBody("1 : WireMock.Net !")
+        );
+
+        server.Given(Request.Create()
+            .WithPath("/test2")
+            .UsingAnyMethod()
+        ).RespondWith(Response.Create()
+            .WithBody("2 : WireMock.Net !")
+        );
+    }, true);
+}
+
+var app = builder.Build();
+
+app.MapGet("/weatherforecast", async (HttpClient client) =>
+{
+    var result = await client.GetStringAsync("https://real-api:12345/test1");
+
+    return Enumerable.Range(1, 3).Select(index =>
+        new WeatherForecast
+        (
+            DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+            Random.Shared.Next(-20, 55),
+            result
+        ));
+});
+
+app.MapGet("/weatherforecast2", async (IHttpClientFactory factory) =>
+{
+    using var client = factory.CreateClient();
+    var result = await client.GetStringAsync("https://real-api:12345/test2");
+
+    return Enumerable.Range(1, 3).Select(index =>
+        new WeatherForecast
+        (
+            DateOnly.FromDateTime(DateTime.Now.AddDays(index)),
+            Random.Shared.Next(-20, 55),
+            result
+        ));
+});
+
+await app.RunAsync();

examples/WireMock.Net.WebApplication/Properties/launchSettings.json

@@ -0,0 +1,41 @@
+{
+    "$schema": "http://json.schemastore.org/launchsettings.json",
+    "iisSettings": {
+        "windowsAuthentication": false,
+        "anonymousAuthentication": true,
+        "iisExpress": {
+            "applicationUrl": "http://localhost:57375",
+            "sslPort": 44333
+        }
+    },
+    "profiles": {
+        "http": {
+            "commandName": "Project",
+            "dotnetRunMessages": true,
+            "launchBrowser": true,
+            "launchUrl": "weatherforecast",
+            "applicationUrl": "http://localhost:5112",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        },
+        "https": {
+            "commandName": "Project",
+            "dotnetRunMessages": true,
+            "launchBrowser": true,
+            "launchUrl": "weatherforecast",
+            "applicationUrl": "https://localhost:7021;http://localhost:5112",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        },
+        "IIS Express": {
+            "commandName": "IISExpress",
+            "launchBrowser": true,
+            "launchUrl": "weatherforecast",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        }
+    }
+}

examples/WireMock.Net.WebApplication/WeatherForecast.cs

@@ -0,0 +1,4 @@
+record WeatherForecast(DateOnly Date, int TemperatureC, string? Summary)
+{
+    public int TemperatureF => 32 + (int)(TemperatureC / 0.5556);
+}

examples/WireMock.Net.WebApplication/WireMock.Net.WebApplication.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\WireMock.Net.AspNetCore.Middleware\WireMock.Net.AspNetCore.Middleware.csproj" />
+  </ItemGroup>
+
+</Project>

examples/WireMock.Net.WebApplication/appsettings.Development.json

@@ -0,0 +1,8 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

examples/WireMock.Net.WebApplication/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Debug",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}

src/WireMock.Net.AspNetCore.Middleware/AppConstants.cs

@@ -0,0 +1,9 @@
+// Copyright © WireMock.Net
+
+namespace WireMock.Net.AspNetCore.Middleware;
+
+internal static class AppConstants
+{
+    internal const string HEADER_REDIRECT = "X-WireMock-Redirect";
+    internal const string HEADER_RESPONSE_DELAY = "X-WireMock-Response-Delay";
+}

src/WireMock.Net.AspNetCore.Middleware/HttpDelegatingHandler/WireMockDelegationHandler.cs

@@ -0,0 +1,72 @@
+using Microsoft.AspNetCore.Http;
+using Microsoft.Extensions.Logging;
+using Stef.Validation;
+using WireMock.Server;
+
+namespace WireMock.Net.AspNetCore.Middleware.HttpDelegatingHandler;
+
+/// <summary>
+/// DelegatingHandler that takes requests made via the <see cref="HttpClient"/>
+/// and routes them to the <see cref="WireMockServer"/>.
+/// </summary>
+internal class WireMockDelegationHandler : DelegatingHandler
+{
+    private readonly ILogger<WireMockDelegationHandler> _logger;
+    private readonly WireMockServerInstance _server;
+    private readonly IHttpContextAccessor _httpContextAccessor;
+    private readonly WireMockDelegationHandlerSettings _settings;
+
+    /// <summary>
+    /// Creates a new instance of <see cref="WireMockDelegationHandler"/>
+    /// </summary>
+    public WireMockDelegationHandler(
+        ILogger<WireMockDelegationHandler> logger,
+        WireMockServerInstance server,
+        IHttpContextAccessor httpContextAccessor,
+        WireMockDelegationHandlerSettings settings
+    )
+    {
+        _server = Guard.NotNull(server);
+        _httpContextAccessor = Guard.NotNull(httpContextAccessor);
+        _logger = Guard.NotNull(logger);
+        _settings = Guard.NotNull(settings);
+    }
+
+    /// <inheritdoc />
+    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    {
+        Guard.NotNull(request);
+        Guard.NotNull(_httpContextAccessor.HttpContext);
+
+        if (_settings.AlwaysRedirect || IsWireMockRedirectHeaderSetToTrue())
+        {
+            _logger.LogDebug("Redirecting request to WireMock server");
+            if (_server.Instance?.Url != null)
+            {
+                request.RequestUri = new Uri(_server.Instance.Url + request.RequestUri!.PathAndQuery);
+            }
+        }
+
+        if (TryGetDelayHeaderValue(out var delayInMs))
+        {
+            await Task.Delay(delayInMs, cancellationToken);
+        }
+
+        return await base.SendAsync(request, cancellationToken);
+    }
+
+    private bool IsWireMockRedirectHeaderSetToTrue()
+    {
+        return
+            _httpContextAccessor.HttpContext!.Request.Headers.TryGetValue(AppConstants.HEADER_REDIRECT, out var values) &&
+            bool.TryParse(values.ToString(), out var shouldRedirectToWireMock) && shouldRedirectToWireMock;
+    }
+
+    private bool TryGetDelayHeaderValue(out int delayInMs)
+    {
+        delayInMs = 0;
+        return
+            _httpContextAccessor.HttpContext!.Request.Headers.TryGetValue(AppConstants.HEADER_RESPONSE_DELAY, out var values) &&
+            int.TryParse(values.ToString(), out delayInMs);
+    }
+}

src/WireMock.Net.AspNetCore.Middleware/HttpDelegatingHandler/WireMockDelegationHandlerSettings.cs

@@ -0,0 +1,8 @@
+// Copyright © WireMock.Net
+
+namespace WireMock.Net.AspNetCore.Middleware.HttpDelegatingHandler;
+
+internal class WireMockDelegationHandlerSettings
+{
+    public bool AlwaysRedirect { get; set; }
+}

src/WireMock.Net.AspNetCore.Middleware/ServiceCollectionExtensions.cs

@@ -0,0 +1,52 @@
+// Copyright © WireMock.Net
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Http;
+using Stef.Validation;
+using WireMock.Net.AspNetCore.Middleware.HttpDelegatingHandler;
+using WireMock.Server;
+using WireMock.Settings;
+
+namespace WireMock.Net.AspNetCore.Middleware;
+
+/// <summary>
+/// Extension methods for <see cref="IServiceCollection"/>.
+/// </summary>
+public static class ServiceCollectionExtensions
+{
+    /// <summary>
+    /// Adds all the components necessary to run WireMock.Net as a background service.
+    /// </summary>
+    public static IServiceCollection AddWireMockService(
+        this IServiceCollection services,
+        Action<WireMockServer> configure,
+        bool alwaysRedirectToWireMock = true,
+        WireMockServerSettings? settings = null
+    )
+    {
+        Guard.NotNull(services);
+        Guard.NotNull(configure);
+
+        services.AddTransient<WireMockDelegationHandler>();
+
+        services.AddSingleton(new WireMockServerInstance(configure, settings));
+
+        services.AddSingleton(new WireMockDelegationHandlerSettings
+        {
+            AlwaysRedirect = alwaysRedirectToWireMock
+        });
+
+        services.AddHostedService<WireMockBackgroundService>();
+        services.AddHttpClient();
+        services.AddHttpContextAccessor();
+        services.ConfigureAll<HttpClientFactoryOptions>(options =>
+        {
+            options.HttpMessageHandlerBuilderActions.Add(builder =>
+            {
+                builder.AdditionalHandlers.Add(builder.Services.GetRequiredService<WireMockDelegationHandler>());
+            });
+        });
+
+        return services;
+    }
+}