Add WireMock.Net.AspNetCore.Middleware

WireMock.Net Solution.sln

@@ -131,6 +131,10 @@ 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.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
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -317,6 +321,14 @@ Global
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{C9210DA3-F390-4598-8512-349A473FE9C9}.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
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -369,6 +381,8 @@ Global
 		{CE602F57-FEF8-4559-A9E0-6200BE1BF398} = {0BB8B634-407A-4610-A91F-11586990767A}
 		{F1B5999D-D22E-48A6-AB86-18A7876BD32E} = {0BB8B634-407A-4610-A91F-11586990767A}
 		{C9210DA3-F390-4598-8512-349A473FE9C9} = {AD474543-0715-49F2-A284-936B060BF736}
+		{E72ADFAB-4B42-439E-B1EE-C06E504B35D2} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
+		{B6269AAC-170A-4346-8B9A-579DED3D9A13} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

examples/WireMock.Net.WebApplication/Program.cs

@@ -0,0 +1,26 @@
+using WireMock.Net.AspNetCore.Middleware;
+using WireMock.RequestBuilders;
+using WireMock.ResponseBuilders;
+
+var builder = WebApplication.CreateBuilder(args);
+
+builder.Services.AddControllers();
+
+if (!builder.Environment.IsProduction())
+{
+    builder.Services.AddWireMockService(server =>
+    {
+        server.Given(Request.Create()
+            .WithPath("/test")
+            .UsingAnyMethod()
+        ).RespondWith(Response.Create()
+            .WithBody("WebApplication")
+        );
+    }, true);
+}
+
+var app = builder.Build();
+
+app.MapControllers();
+
+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": "test",
+            "applicationUrl": "http://localhost:5112",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        },
+        "https": {
+            "commandName": "Project",
+            "dotnetRunMessages": true,
+            "launchBrowser": true,
+            "launchUrl": "test",
+            "applicationUrl": "https://localhost:7021;http://localhost:5112",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        },
+        "IIS Express": {
+            "commandName": "IISExpress",
+            "launchBrowser": true,
+            "launchUrl": "test",
+            "environmentVariables": {
+                "ASPNETCORE_ENVIRONMENT": "Development"
+            }
+        }
+    }
+}

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": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}

examples/WireMock.Net.WebApplication/appsettings.json

@@ -0,0 +1,9 @@
+{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "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_WIREMOCK_STATUS = "X-WireMock-Status";
+    internal const string HEADER_RESPONSE_DELAY = "X-Response-Delay";
+}

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

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

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

@@ -0,0 +1,74 @@
+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 IWireMockDelegationHandlerSettings _settings;
+
+    /// <summary>
+    /// Creates a new instance of <see cref="WireMockDelegationHandler"/>
+    /// </summary>
+    public WireMockDelegationHandler(
+        ILogger<WireMockDelegationHandler> logger,
+        WireMockServerInstance server,
+        IHttpContextAccessor httpContextAccessor,
+        IWireMockDelegationHandlerSettings settings
+    )
+    {
+        _server = Guard.NotNull(server);
+        _httpContextAccessor = Guard.NotNull(httpContextAccessor);
+        _logger = Guard.NotNull(logger);
+        _settings = Guard.NotNull(settings);
+    }
+
+    /// <inheritdoc />
+    /// <exception cref="ArgumentNullException"></exception>
+    protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
+    {
+        Guard.NotNull(request);
+        Guard.NotNull(_httpContextAccessor.HttpContext);
+
+        if (_settings.AlwaysRedirect || IsWireMockStatusHeaderSetToTrue())
+        {
+            _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 IsWireMockStatusHeaderSetToTrue()
+    {
+        return
+            _httpContextAccessor.HttpContext!.Request.Headers.TryGetValue(AppConstants.HEADER_WIREMOCK_STATUS, 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 : IWireMockDelegationHandlerSettings
+{
+    public bool AlwaysRedirect { get; set; }
+}

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

@@ -0,0 +1,59 @@
+// 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 = false,
+        WireMockServerSettings? settings = null
+    )
+    {
+        Guard.NotNull(services);
+        Guard.NotNull(configure);
+
+        services.AddTransient<WireMockDelegationHandler>();
+
+        if (settings is null)
+        {
+            services.AddSingleton(new WireMockServerInstance(configure));
+        }
+        else
+        {
+            services.AddSingleton(new WireMockServerInstance(configure, settings));
+        }
+
+        services.AddSingleton<IWireMockDelegationHandlerSettings>(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;
+    }
+}

src/WireMock.Net.AspNetCore.Middleware/WireMock.Net.AspNetCore.Middleware.csproj

@@ -0,0 +1,49 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Description>Middleware which can be used to host WireMock.Net as a AspNetCore Middleware in a WebApplication</Description>
+        <AssemblyTitle>WireMock.Net.AspNetCore.Middleware</AssemblyTitle>
+        <Authors>Matt Yost;Stef Heyenrath</Authors>
+        <TargetFramework>net8.0</TargetFramework>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
+        <AssemblyName>WireMock.Net.AspNetCore.Middleware</AssemblyName>
+        <PackageId>WireMock.Net.AspNetCore.Middleware</PackageId>
+        <PackageTags>dotnet;middleware;wiremock;service;webapplication</PackageTags>
+        <ProjectGuid>{B6269AAC-170A-4346-8B9A-579DED3D9A13}</ProjectGuid>
+        <PublishRepositoryUrl>true</PublishRepositoryUrl>
+        <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
+        <EmbedUntrackedSources>true</EmbedUntrackedSources>
+        <AutoGenerateBindingRedirects>true</AutoGenerateBindingRedirects>
+        <GenerateBindingRedirectsOutputType>true</GenerateBindingRedirectsOutputType>
+        <CodeAnalysisRuleSet>../WireMock.Net/WireMock.Net.ruleset</CodeAnalysisRuleSet>
+        <SignAssembly>true</SignAssembly>
+        <AssemblyOriginatorKeyFile>../WireMock.Net/WireMock.Net.snk</AssemblyOriginatorKeyFile>
+        <PublicSign Condition=" '$(OS)' != 'Windows_NT' ">true</PublicSign>
+        <PackageLicenseExpression>MIT</PackageLicenseExpression>
+        <PackageIcon>WireMock.Net-LogoAspire.png</PackageIcon>
+        <ApplicationIcon>../../resources/WireMock.Net-LogoAspire.ico</ApplicationIcon>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <Compile Remove="IWireMockContext.cs" />
+    </ItemGroup>
+
+    <ItemGroup>
+        <None Remove="../../resources/WireMock.Net-Logo.png" />
+        <None Include="../../resources/WireMock.Net-LogoAspire.png" Pack="true" PackagePath="" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\WireMock.Net\WireMock.Net.csproj" />
+    </ItemGroup>
+
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+    </PropertyGroup>
+
+</Project>

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

@@ -0,0 +1,39 @@
+// Copyright © WireMock.Net
+
+using Microsoft.Extensions.Hosting;
+using Stef.Validation;
+using WireMock.Server;
+
+namespace WireMock.Net.AspNetCore.Middleware;
+
+/// <summary>
+/// <see cref="BackgroundService"/> used to start/stop the <see cref="WireMockServer"/>
+/// </summary>
+public class WireMockBackgroundService : BackgroundService
+{
+    private readonly WireMockServerInstance _server;
+
+    /// <summary>
+    /// Creates a new <see cref="BackgroundService"/> using an instance
+    /// of <see cref="WireMockServerInstance"/>
+    /// </summary>
+    /// <param name="server"></param>
+    public WireMockBackgroundService(WireMockServerInstance server)
+    {
+        _server = Guard.NotNull(server);
+    }
+
+    /// <inheritdoc />
+    protected override Task ExecuteAsync(CancellationToken stoppingToken)
+    {
+        _server.Start();
+        return Task.CompletedTask;
+    }
+
+    /// <inheritdoc />
+    public override Task StopAsync(CancellationToken cancellationToken)
+    {
+        _server.Stop();
+        return base.StopAsync(cancellationToken);
+    }
+}