Added feature to enable and disable mappings (#1437)

* feat/1421 added feature to enable and disable mappings * feat/1421 updated test constants to reflect 2 new admin endpoints /enable and /disable * feat/1421 updated tests to fix flakyness - removed delay before assertion that is causing upstream connection from proxy to teardown prematurely before test ends * feat/1421 addressing PR comments - Updated logic to represent IsDisable insted of IsEnabled
2026-04-27 11:17:31 +02:00 · 2026-04-24 02:07:37 -04:00
parent 85d61a1877
commit 1962437dcd
13 changed files with 277 additions and 4 deletions
--- a/test/WireMock.Net.Tests/AdminApi/WireMockAdminApiTests.IsDisabled.cs
+++ b/test/WireMock.Net.Tests/AdminApi/WireMockAdminApiTests.IsDisabled.cs
@@ -0,0 +1,134 @@
+// Copyright © WireMock.Net
+
+using RestEase;
+using WireMock.Admin.Mappings;
+using WireMock.Client;
+using WireMock.Server;
+
+namespace WireMock.Net.Tests.AdminApi;
+
+public partial class WireMockAdminApiTests
+{
+    [Fact]
+    public async Task IWireMockAdminApi_PostMappingAsync_WithIsDisabledTrue_DoesNotMatchRequests()
+    {
+        // Arrange
+        var ct = TestContext.Current.CancellationToken;
+        using var server = WireMockServer.StartWithAdminInterface();
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
+        var httpClient = server.CreateClient();
+
+        var model = new MappingModel
+        {
+            Request = new RequestModel { Path = "/foo", Methods = ["GET"] },
+            Response = new ResponseModel { Body = "hello", StatusCode = 200 },
+            IsDisabled = true
+        };
+
+        // Act — POST the disabled mapping
+        var postResult = await api.PostMappingAsync(model, ct);
+        postResult.Should().NotBeNull();
+
+        // Assert — request should not be matched (404)
+        var response = await httpClient.GetAsync("/foo", ct);
+        ((int)response.StatusCode).Should().Be(404);
+
+        // Assert — mapping exists but IsDisabled is true
+        server.Mappings.Where(m => !m.IsAdminInterface).Should().ContainSingle(m => m.IsDisabled == true);
+    }
+
+    [Fact]
+    public async Task IWireMockAdminApi_DisableMappingAsync_PreventsMatching()
+    {
+        // Arrange
+        var ct = TestContext.Current.CancellationToken;
+        using var server = WireMockServer.StartWithAdminInterface();
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
+        var httpClient = server.CreateClient();
+
+        var model = new MappingModel
+        {
+            Request = new RequestModel { Path = "/bar", Methods = ["GET"] },
+            Response = new ResponseModel { Body = "world", StatusCode = 200 }
+        };
+        var postResult = await api.PostMappingAsync(model, ct);
+        var guid = postResult.Guid!.Value;
+
+        // Assert — mapping matches before disable
+        var before = await httpClient.GetAsync("/bar", ct);
+        ((int)before.StatusCode).Should().Be(200);
+
+        // Act — disable
+        var disableResult = await api.DisableMappingAsync(guid, ct);
+        disableResult.Status.Should().Be("Mapping disabled");
+
+        // Assert — no match after disable
+        var after = await httpClient.GetAsync("/bar", ct);
+        ((int)after.StatusCode).Should().Be(404);
+    }
+
+    [Fact]
+    public async Task IWireMockAdminApi_EnableMappingAsync_ResumesMatching()
+    {
+        // Arrange
+        var ct = TestContext.Current.CancellationToken;
+        using var server = WireMockServer.StartWithAdminInterface();
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
+        var httpClient = server.CreateClient();
+
+        var model = new MappingModel
+        {
+            Request = new RequestModel { Path = "/baz", Methods = ["GET"] },
+            Response = new ResponseModel { Body = "re-enabled", StatusCode = 200 },
+            IsDisabled = true
+        };
+        var postResult = await api.PostMappingAsync(model, ct);
+        var guid = postResult.Guid!.Value;
+
+        // Assert — no match while disabled
+        var before = await httpClient.GetAsync("/baz", ct);
+        ((int)before.StatusCode).Should().Be(404);
+
+        // Act — enable
+        var enableResult = await api.EnableMappingAsync(guid, ct);
+        enableResult.Status.Should().Be("Mapping enabled");
+
+        // Assert — mapping matches after enable
+        var after = await httpClient.GetAsync("/baz", ct);
+        ((int)after.StatusCode).Should().Be(200);
+    }
+
+    [Fact]
+    public async Task IWireMockAdminApi_GetMappingAsync_ReturnsIsDisabledTrue_WhenDisabled()
+    {
+        // Arrange
+        var ct = TestContext.Current.CancellationToken;
+        using var server = WireMockServer.StartWithAdminInterface();
+        var api = RestClient.For<IWireMockAdminApi>(server.Urls[0]);
+
+        var disabledModel = new MappingModel
+        {
+            Request = new RequestModel { Path = "/check-disabled" },
+            Response = new ResponseModel { Body = "x", StatusCode = 200 },
+            IsDisabled = true
+        };
+        var enabledModel = new MappingModel
+        {
+            Request = new RequestModel { Path = "/check-enabled" },
+            Response = new ResponseModel { Body = "y", StatusCode = 200 }
+        };
+
+        var disabledPost = await api.PostMappingAsync(disabledModel, ct);
+        var enabledPost = await api.PostMappingAsync(enabledModel, ct);
+
+        // Act
+        var disabledGot = await api.GetMappingAsync(disabledPost.Guid!.Value, ct);
+        var enabledGot = await api.GetMappingAsync(enabledPost.Guid!.Value, ct);
+
+        // Assert — disabled mapping serializes IsDisabled = true
+        disabledGot.IsDisabled.Should().BeTrue();
+
+        // Assert — enabled mapping omits IsDisabled (null = default not disabled)
+        enabledGot.IsDisabled.Should().BeNull();
+    }
+}