// Copyright © WireMock.Net using System.Net; using System.Net.Http; using System.Text; using Moq; using Newtonsoft.Json; using RestEase; using WireMock.Client; using WireMock.Handlers; using WireMock.Logging; using WireMock.Matchers.Request; using WireMock.Net.Xunit; using WireMock.RequestBuilders; using WireMock.ResponseBuilders; using WireMock.Server; using WireMock.Settings; namespace WireMock.Net.Tests; public class WireMockServerAdminTests(ITestOutputHelper output, ITestContextAccessor testContext) { private readonly CancellationToken _ct = testContext.Current.CancellationToken; private static string GetCurrentFolder() { return Directory.GetCurrentDirectory(); } [Fact] public void WireMockServer_Admin_ResetMappings() { using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); var folder = Path.Combine(GetCurrentFolder(), "__admin", "mappings"); server.ReadStaticMappings(folder); server.Mappings.Should().HaveCount(Constants.NumStaticMappings); server.MappingModels.Should().HaveCount(Constants.NumStaticMappings); // Act server.ResetMappings(); // Assert server.Mappings.Should().HaveCount(0); server.MappingModels.Should().HaveCount(0); } [Fact] public void WireMockServer_Admin_SaveStaticMappings() { // Assign string guid = "791a3f31-6946-aaaa-8e6f-0237c7441111"; var staticMappingHandlerMock = new Mock(); staticMappingHandlerMock.Setup(m => m.GetMappingFolder()).Returns("folder"); staticMappingHandlerMock.Setup(m => m.FolderExists(It.IsAny())).Returns(true); staticMappingHandlerMock.Setup(m => m.WriteMappingFile(It.IsAny(), It.IsAny())); var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), FileSystemHandler = staticMappingHandlerMock.Object }); server .Given(Request.Create().WithPath($"/foo_{Guid.NewGuid()}")) .WithGuid(guid) .RespondWith(Response.Create().WithBody("save test")); // Act server.SaveStaticMappings(); // Assert and Verify staticMappingHandlerMock.Verify(m => m.GetMappingFolder(), Times.Once); staticMappingHandlerMock.Verify(m => m.FolderExists("folder"), Times.Once); staticMappingHandlerMock.Verify(m => m.WriteMappingFile(Path.Combine("folder", guid + ".json"), It.IsAny()), Times.Once); } [Fact] public async Task WireMockServer_Admin_ReadStaticMapping_WithNonGuidFilename() { var guid = Guid.Parse("04ee4872-9efd-4770-90d3-88d445265d0d"); string title = "documentdb_root_title"; using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); string path = Path.Combine(GetCurrentFolder(), "__admin", "mappings", "documentdb_root.json"); server.ReadStaticMappingAndAddOrUpdate(path); await Task.Delay(100, _ct); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(1); mappings.First().RequestMatcher.Should().NotBeNull(); mappings.First().Provider.Should().NotBeNull(); mappings.First().Guid.Should().Be(guid); mappings.First().Title.Should().Be(title); } [Fact] public void WireMockServer_Admin_ReadStaticMapping_WithGuidFilename() { string guid = "00000002-ee28-4f29-ae63-1ac9b0802d86"; using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); string path = Path.Combine(GetCurrentFolder(), "__admin", "mappings", guid + ".json"); server.ReadStaticMappingAndAddOrUpdate(path); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(1); mappings.First().RequestMatcher.Should().NotBeNull(); mappings.First().Provider.Should().NotBeNull(); mappings.First().Guid.Should().Be(Guid.Parse(guid)); mappings.First().Title.Should().BeNullOrEmpty(); } [Fact] public void WireMockServer_Admin_ReadStaticMapping_WithArray() { using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); string path = Path.Combine(GetCurrentFolder(), "__admin", "mappings", "array.json"); server.ReadStaticMappingAndAddOrUpdate(path); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(2); } [Fact] public void WireMockServer_Admin_ReadStaticMapping_WithResponseBodyFromFile() { string guid = "00000002-ee28-4f29-ae63-1ac9b0802d87"; string path = Path.Combine(GetCurrentFolder(), "__admin", "mappings", guid + ".json"); string json = File.ReadAllText(path); string responseBodyFilePath = Path.Combine(GetCurrentFolder(), "responsebody.json"); dynamic jsonObj = JsonConvert.DeserializeObject(json)!; jsonObj["Response"]["BodyAsFile"] = responseBodyFilePath; var jsonObjAsJson = JsonConvert.SerializeObject(jsonObj, Formatting.Indented); File.WriteAllText(path, jsonObjAsJson); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); server.ReadStaticMappingAndAddOrUpdate(path); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(1); mappings.First().RequestMatcher.Should().NotBeNull(); mappings.First().Provider.Should().NotBeNull(); mappings.First().Guid.Should().Be(Guid.Parse(guid)); mappings.First().Title.Should().BeNullOrEmpty(); } [Fact] public void WireMockServer_Admin_ReadStaticMappings_FolderExistsIsTrue() { // Assign var staticMappingHandlerMock = new Mock(); staticMappingHandlerMock.Setup(m => m.GetMappingFolder()).Returns("folder"); staticMappingHandlerMock.Setup(m => m.FolderExists(It.IsAny())).Returns(true); staticMappingHandlerMock.Setup(m => m.EnumerateFiles(It.IsAny(), It.IsAny())).Returns([]); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), FileSystemHandler = staticMappingHandlerMock.Object }); // Act server.ReadStaticMappings(); // Assert and Verify staticMappingHandlerMock.Verify(m => m.GetMappingFolder(), Times.Once); staticMappingHandlerMock.Verify(m => m.FolderExists("folder"), Times.Once); staticMappingHandlerMock.Verify(m => m.EnumerateFiles("folder", false), Times.Once); } [Fact] public void WireMockServer_Admin_ReadStaticMappingAndAddOrUpdate() { // Assign string mapping = "{\"Request\": {\"Path\": {\"Matchers\": [{\"Name\": \"WildcardMatcher\",\"Pattern\": \"/static/mapping\"}]},\"Methods\": [\"get\"]},\"Response\": {\"BodyAsJson\": { \"body\": \"static mapping\" }}}"; var staticMappingHandlerMock = new Mock(); staticMappingHandlerMock.Setup(m => m.ReadMappingFile(It.IsAny())).Returns(mapping); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), FileSystemHandler = staticMappingHandlerMock.Object }); // Act server.ReadStaticMappingAndAddOrUpdate(@"c:\test.json"); // Assert and Verify staticMappingHandlerMock.Verify(m => m.ReadMappingFile(@"c:\test.json"), Times.Once); } [Fact] public void WireMockServer_Admin_ReadStaticMappings() { using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); string folder = Path.Combine(GetCurrentFolder(), "__admin", "mappings"); server.ReadStaticMappings(folder); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(Constants.NumStaticMappings); } [Fact] public void WireMockServer_Admin_ReadStaticMappings_FolderDoesNotExist() { // Assign var loggerMock = new Mock(); loggerMock.Setup(l => l.Info(It.IsAny(), It.IsAny())); var settings = new WireMockServerSettings { Logger = loggerMock.Object }; var server = WireMockServer.Start(settings); // Act server.ReadStaticMappings(Guid.NewGuid().ToString()); // Assert server.Mappings.Should().HaveCount(0); // Verify loggerMock.Verify(l => l.Info(It.Is(s => s.StartsWith("The Static Mapping folder")), It.IsAny()), Times.Once); } [Fact] public async Task WireMockServer_Admin_Mapping_WithoutPathOrUrl() { // Arrange var cancellationToken = TestContext.Current.CancellationToken; using var server = WireMockServer.StartWithAdminInterface(); // Act server.Given(Request.Create().UsingGet()) .RespondWith(Response.Create()); // Assert var mapping = server.Mappings.First(m => !m.IsAdminInterface); var request = (Request)mapping.RequestMatcher; var pathMatcher = request.GetRequestMessageMatcher(); pathMatcher.Should().BeNull(); var api = RestClient.For(server.Url); var mappingModels = await api.GetMappingsAsync(cancellationToken); var mappingModel = mappingModels.First(); mappingModel.Request.Path.Should().BeNull(); mappingModel.Request.Url.Should().BeNull(); await api.DeleteMappingsAsync(cancellationToken); await api.PostMappingAsync(mappingModel, cancellationToken); await api.GetMappingsAsync(cancellationToken); mappingModels = await api.GetMappingsAsync(cancellationToken); mappingModel = mappingModels.First(); mappingModel.Request.Path.Should().BeNull(); mappingModel.Request.Url.Should().BeNull(); } [Fact] public void WireMockServer_Admin_Mappings_WithGuid_Get() { Guid guid = Guid.Parse("90356dba-b36c-469a-a17e-669cd84f1f05"); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); server.Given(Request.Create().WithPath("/foo1").UsingGet()).WithGuid(guid) .RespondWith(Response.Create().WithStatusCode(201).WithBody("1")); server.Given(Request.Create().WithPath("/foo2").UsingGet()) .RespondWith(Response.Create().WithStatusCode(202).WithBody("2")); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(2); } [Fact] public void WireMockServer_Admin_Mappings_WithGuidAsString_Get() { string guid = "90356dba-b36c-469a-a17e-669cd84f1f05"; using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); server.Given(Request.Create().WithPath("/foo100").UsingGet()).WithGuid(guid) .RespondWith(Response.Create().WithStatusCode(201).WithBody("1")); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(1); } [Fact] public void WireMockServer_Admin_Mappings_Add_SameGuid() { var guid = Guid.Parse("90356dba-b36c-469a-a17e-669cd84f1f05"); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); var response1 = Response.Create().WithStatusCode(500); server.Given(Request.Create().UsingGet()) .WithGuid(guid) .RespondWith(response1); var mappings1 = server.Mappings.ToArray(); mappings1.Should().HaveCount(1); mappings1.First().Guid.Should().Be(guid); var response2 = Response.Create().WithStatusCode(400); server.Given(Request.Create().WithPath("/2").UsingGet()) .WithGuid(guid) .RespondWith(response2); var mappings2 = server.Mappings.ToArray(); mappings2.Should().HaveCount(1); mappings2.First().Guid.Should().Be(guid); mappings2.First().Provider.Should().Be(response2); } [Fact] public async Task WireMockServer_Admin_Mappings_AtPriority() { using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); // given server.Given(Request.Create().WithPath("/1").UsingGet()) .AtPriority(2) .RespondWith(Response.Create().WithStatusCode(200)); server.Given(Request.Create().WithPath("/1").UsingGet()) .AtPriority(1) .RespondWith(Response.Create().WithStatusCode(400)); var mappings = server.Mappings.ToArray(); mappings.Should().HaveCount(2); // when var response = await new HttpClient().GetAsync("http://localhost:" + server.Port + "/1", TestContext.Current.CancellationToken); // then ((int)response.StatusCode).Should().Be(400); } [Fact] public async Task WireMockServer_Admin_Requests_Get() { // given using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); // when await new HttpClient().GetAsync("http://localhost:" + server.Ports[0] + "/foo", TestContext.Current.CancellationToken); // then server.LogEntries.Should().HaveCount(1); var requestLogged = server.LogEntries.First(); requestLogged.RequestMessage!.Method.Should().Be("GET"); requestLogged.RequestMessage.BodyData.Should().BeNull(); } [Fact] public async Task WireMockServer_Admin_Logging_SetMaxRequestLogCount() { // Assign using var client = new HttpClient(); // Act using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); server.SetMaxRequestLogCount(2); await client.GetAsync("http://localhost:" + server.Ports[0] + "/foo1", _ct); await client.GetAsync("http://localhost:" + server.Ports[0] + "/foo2", _ct); await client.GetAsync("http://localhost:" + server.Ports[0] + "/foo3", _ct); // Assert server.LogEntries.Should().HaveCount(2); var requestLoggedA = server.LogEntries.First(); requestLoggedA.RequestMessage!.Path.Should().EndWith("/foo2"); var requestLoggedB = server.LogEntries.Last(); requestLoggedB.RequestMessage!.Path.Should().EndWith("/foo3"); } [Fact] public async Task WireMockServer_Admin_Logging_SetMaxRequestLogCount_To_0_Should_Not_AddLogging() { // Assign using var client = new HttpClient(); // Act using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); server.SetMaxRequestLogCount(0); await client.GetAsync("http://localhost:" + server.Port + "/foo1", _ct); await client.GetAsync("http://localhost:" + server.Port + "/foo2", _ct); await client.GetAsync("http://localhost:" + server.Port + "/foo3", _ct); // Assert server.LogEntries.Should().BeEmpty(); server.Stop(); } [Fact] public async Task WireMockServer_Admin_Logging_FindLogEntries() { // Assign using var client = new HttpClient(); // Act using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); var tasks = new[] { client.GetAsync($"{server.Url}/foo1", _ct), client.PostAsync($"{server.Url}/foo2", new StringContent("test"), _ct), client.GetAsync($"{server.Url}/foo3", _ct) }; await Task.WhenAll(tasks); await Task.Delay(200, _ct); // Act var logEntries = server.FindLogEntries(new RequestMessageMethodMatcher("GET")); // Assert logEntries.Should().HaveCount(2); logEntries.Single(le => le.RequestMessage!.Path.EndsWith("foo1")).Should().NotBeNull(); logEntries.Single(le => le.RequestMessage!.Path.EndsWith("foo3")).Should().NotBeNull(); } [Fact] public void WireMockServer_Admin_WatchStaticMappings() { // Assign var fileMock = new Mock(); var settings = new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), FileSystemHandler = fileMock.Object }; using var server = WireMockServer.Start(settings); // Act server.WatchStaticMappings(); // Verify fileMock.Verify(f => f.GetMappingFolder(), Times.Once); fileMock.Verify(f => f.FolderExists(It.IsAny()), Times.Once); } [Fact] public void WireMockServer_Admin_AddMappingsAndSaveToFile() { // Assign string guid = "791a3f31-6946-aaaa-8e6f-0237c7442222"; var staticMappingHandlerMock = new Mock(); staticMappingHandlerMock.Setup(m => m.GetMappingFolder()).Returns("folder"); staticMappingHandlerMock.Setup(m => m.FolderExists(It.IsAny())).Returns(true); staticMappingHandlerMock.Setup(m => m.WriteMappingFile(It.IsAny(), It.IsAny())); using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), FileSystemHandler = staticMappingHandlerMock.Object }); // Act server .Given(Request.Create().WithPath($"/foo_{Guid.NewGuid()}"), true) .WithGuid(guid) .RespondWith(Response.Create().WithBody("post and save test")); // Assert and Verify staticMappingHandlerMock.Verify(m => m.GetMappingFolder(), Times.Once); staticMappingHandlerMock.Verify(m => m.FolderExists("folder"), Times.Once); staticMappingHandlerMock.Verify(m => m.WriteMappingFile(Path.Combine("folder", guid + ".json"), It.IsAny()), Times.Once); } [Fact] public async Task WireMockServer_Admin_DeleteMappings() { // Arrange using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output), StartAdminInterface = true, ReadStaticMappings = false, WatchStaticMappings = false, WatchStaticMappingsInSubdirectories = false }); server .Given(Request.Create().WithPath("/path1")) .AtPriority(0) .RespondWith(Response.Create().WithStatusCode(200)); server .Given(Request.Create().WithPath("/path2")) .AtPriority(1) .RespondWith(Response.Create().WithStatusCode(200)); server .Given(Request.Create().WithPath("/path3")) .AtPriority(2) .RespondWith(Response.Create().WithStatusCode(200)); server.MappingModels.Count().Should().Be(3); var guid1 = server.MappingModels.ElementAt(0).Guid; var guid2 = server.MappingModels.ElementAt(1).Guid; var guid3 = server.MappingModels.ElementAt(2).Guid; guid1.Should().NotBeNull(); guid2.Should().NotBeNull(); guid3.Should().NotBeNull(); string guidsJsonBody = $"[" + $"{{\"Guid\": \"{guid1}\"}}," + $"{{\"Guid\": \"{guid2}\"}}" + $"]"; // Act var request = new HttpRequestMessage { Method = HttpMethod.Delete, RequestUri = new Uri($"http://localhost:{server.Ports[0]}/__admin/mappings"), Content = new StringContent(guidsJsonBody, Encoding.UTF8, "application/json") }; var response = await new HttpClient().SendAsync(request, _ct); // Assert var guids = server.MappingModels.Select(mapping => mapping.Guid!.Value).ToArray(); guids.Contains(guid1.Value).Should().BeFalse(); guids.Contains(guid2.Value).Should().BeFalse(); guids.Contains(guid3.Value).Should().BeTrue(); response.StatusCode.Should().Be(HttpStatusCode.OK); (await response.Content.ReadAsStringAsync(_ct)).Should().Be($"{{\"Status\":\"Mappings deleted. Affected GUIDs: [{guid1}, {guid2}]\"}}"); } #if NET5_0_OR_GREATER [Fact] public async Task WireMockServer_CreateHttpClientFactory_And_CallEndpoint() { // Arrange using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); var factory = server.CreateHttpClientFactory(); var client = factory.CreateClient("any name"); // Act await client.GetAsync($"{server.Url}/foo", _ct); // Assert server.LogEntries.Should().HaveCount(1); var requestLogged = server.LogEntries.First(); requestLogged.RequestMessage!.Method.Should().Be("GET"); requestLogged.RequestMessage.BodyData.Should().BeNull(); } #endif [Fact] public async Task WireMockServer_CreateClient_And_CallEndpoint() { // Arrange using var server = WireMockServer.Start(new WireMockServerSettings { Logger = new TestOutputHelperWireMockLogger(output) }); var client = server.CreateClient(); // Act await client.GetAsync($"{server.Url}/foo", _ct); // Assert server.LogEntries.Should().HaveCount(1); var requestLogged = server.LogEntries.First(); requestLogged.RequestMessage!.Method.Should().Be("GET"); requestLogged.RequestMessage.BodyData.Should().BeNull(); } [Fact] public async Task WireMockServer_CreateClient_And_CallAdminSettingsEndpoint() { // Arrange var cancellationToken = TestContext.Current.CancellationToken; using var server = WireMockServer.Start(w => { w.Logger = new TestOutputHelperWireMockLogger(output); w.StartAdminInterface = true; w.AdminPath = "/adm"; }); var client = server.CreateClient(); // Act var settings = await client.GetStringAsync($"{server.Url}/adm/settings", cancellationToken); // Assert settings.Should().NotBeNull(); } }