mirror of
https://github.com/wiremock/WireMock.Net.git
synced 2026-03-26 11:01:03 +01:00
f919929cb7
* Move ScenarioState to Abstractions and add IScenarioStateStore interface ScenarioState is moved to the Abstractions project so it can be referenced by the new IScenarioStateStore interface. The interface defines the contract for storing and retrieving scenario states, enabling distributed implementations. * Add InMemoryScenarioStateStore default implementation Wraps ConcurrentDictionary with OrdinalIgnoreCase comparer, preserving exact current behavior. The Update method encapsulates read-modify-write so distributed implementations can make it atomic. * Wire IScenarioStateStore into middleware options, settings, and consumers Replace direct ConcurrentDictionary<string, ScenarioState> usage with IScenarioStateStore across all consumer files. The store is injectable via WireMockServerSettings.ScenarioStateStore, defaulting to the InMemoryScenarioStateStore for backward compatibility. * Add FileBasedScenarioStateStore for persistent scenario state In-memory ConcurrentDictionary backed by JSON file persistence in __admin/scenarios/. Reads from cache, mutations write through to disk. Constructor loads existing state from disk on startup. * Make ScenarioStateStore non-nullable with default InMemoryScenarioStateStore Move InMemoryScenarioStateStore from WireMock.Net.Minimal to WireMock.Net.Shared so it lives alongside WireMockServerSettings. This allows WireMockServerSettings.ScenarioStateStore to be non-nullable with a default value, following the same pattern as DefaultJsonSerializer. The null-coalescing fallback in WireMockMiddlewareOptionsHelper is no longer needed.
352 lines
15 KiB
C#
352 lines
15 KiB
C#
// Copyright © WireMock.Net
|
|
|
|
using System.Collections.Concurrent;
|
|
using System.Diagnostics;
|
|
using System.Linq.Expressions;
|
|
using Microsoft.AspNetCore.Http;
|
|
using Moq;
|
|
using WireMock.Admin.Mappings;
|
|
using WireMock.Admin.Requests;
|
|
using WireMock.Handlers;
|
|
using WireMock.Logging;
|
|
using WireMock.Matchers;
|
|
using WireMock.Matchers.Request;
|
|
using WireMock.Models;
|
|
using WireMock.Owin;
|
|
using WireMock.Owin.ActivityTracing;
|
|
using WireMock.Owin.Mappers;
|
|
using WireMock.RequestBuilders;
|
|
using WireMock.ResponseBuilders;
|
|
using WireMock.Settings;
|
|
using WireMock.Util;
|
|
|
|
namespace WireMock.Net.Tests.Owin;
|
|
|
|
public class WireMockMiddlewareTests
|
|
{
|
|
private static readonly Guid NewGuid = new("98fae52e-76df-47d9-876f-2ee32e931d9b");
|
|
private static readonly DateTime UtcNow = new(2026, 1, 1, 0, 0, 0, DateTimeKind.Utc);
|
|
private static readonly DateTime UpdatedAt = new(2022, 12, 4);
|
|
|
|
private readonly ConcurrentDictionary<Guid, IMapping> _mappings = new();
|
|
private readonly Mock<IWireMockMiddlewareOptions> _optionsMock;
|
|
private readonly Mock<IOwinRequestMapper> _requestMapperMock;
|
|
private readonly Mock<IOwinResponseMapper> _responseMapperMock;
|
|
private readonly Mock<IMappingMatcher> _matcherMock;
|
|
private readonly Mock<IMapping> _mappingMock;
|
|
private readonly Mock<IRequestMatchResult> _requestMatchResultMock;
|
|
private readonly Mock<HttpContext> _contextMock;
|
|
private readonly Mock<IGuidUtils> _guidUtilsMock;
|
|
private readonly Mock<IDateTimeUtils> _dateTimeUtilsMock;
|
|
|
|
private readonly WireMockMiddleware _sut;
|
|
|
|
public WireMockMiddlewareTests()
|
|
{
|
|
var wireMockMiddlewareLoggerMock = new Mock<IWireMockMiddlewareLogger>();
|
|
|
|
_guidUtilsMock = new Mock<IGuidUtils>();
|
|
_guidUtilsMock.Setup(g => g.NewGuid()).Returns(NewGuid);
|
|
|
|
_dateTimeUtilsMock = new Mock<IDateTimeUtils>();
|
|
_dateTimeUtilsMock.Setup(d => d.UtcNow).Returns(UtcNow);
|
|
|
|
_optionsMock = new Mock<IWireMockMiddlewareOptions>();
|
|
_optionsMock.SetupAllProperties();
|
|
_optionsMock.Setup(o => o.Mappings).Returns(_mappings);
|
|
_optionsMock.Setup(o => o.LogEntries).Returns(new ConcurrentObservableCollection<LogEntry>());
|
|
_optionsMock.Setup(o => o.ScenarioStateStore).Returns(new InMemoryScenarioStateStore());
|
|
_optionsMock.Setup(o => o.Logger.Warn(It.IsAny<string>(), It.IsAny<object[]>()));
|
|
_optionsMock.Setup(o => o.Logger.Error(It.IsAny<string>(), It.IsAny<object[]>()));
|
|
_optionsMock.Setup(o => o.Logger.DebugRequestResponse(It.IsAny<LogEntryModel>(), It.IsAny<bool>()));
|
|
|
|
_requestMapperMock = new Mock<IOwinRequestMapper>();
|
|
_requestMapperMock.SetupAllProperties();
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1");
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_responseMapperMock = new Mock<IOwinResponseMapper>();
|
|
_responseMapperMock.SetupAllProperties();
|
|
_responseMapperMock.Setup(m => m.MapAsync(It.IsAny<ResponseMessage?>(), It.IsAny<HttpResponse>())).Returns(Task.FromResult(true));
|
|
|
|
_matcherMock = new Mock<IMappingMatcher>();
|
|
_matcherMock.SetupAllProperties();
|
|
// _matcherMock.Setup(m => m.FindBestMatch(It.IsAny<RequestMessage>())).Returns((new MappingMatcherResult(), new MappingMatcherResult()));
|
|
|
|
_contextMock = new Mock<HttpContext>();
|
|
_contextMock.SetupGet(c => c.Items).Returns(new Dictionary<object, object?>());
|
|
|
|
_mappingMock = new Mock<IMapping>();
|
|
|
|
_requestMatchResultMock = new Mock<IRequestMatchResult>();
|
|
_requestMatchResultMock.Setup(r => r.TotalNumber).Returns(1);
|
|
_requestMatchResultMock.Setup(r => r.MatchDetails).Returns([]);
|
|
|
|
_sut = new WireMockMiddleware(
|
|
_ => Task.CompletedTask,
|
|
_optionsMock.Object,
|
|
_requestMapperMock.Object,
|
|
_responseMapperMock.Object,
|
|
_matcherMock.Object,
|
|
wireMockMiddlewareLoggerMock.Object,
|
|
_guidUtilsMock.Object,
|
|
_dateTimeUtilsMock.Object
|
|
);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_NoMatch()
|
|
{
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert and Verify
|
|
_optionsMock.Verify(o => o.Logger.Warn(It.IsAny<string>(), It.IsAny<object[]>()), Times.Once);
|
|
|
|
Expression<Func<ResponseMessage, bool>> match = r => (int)r.StatusCode! == 404 && ((StatusModel)r.BodyData!.BodyAsJson!).Status == "No matching mapping found";
|
|
_responseMapperMock.Verify(m => m.MapAsync(It.Is(match), It.IsAny<HttpResponse>()), Times.Once);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_IsAdminInterface_EmptyHeaders_401()
|
|
{
|
|
// Assign
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1", null, new Dictionary<string, string[]>());
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.AuthenticationMatcher).Returns(new ExactMatcher());
|
|
_mappingMock.SetupGet(m => m.IsAdminInterface).Returns(true);
|
|
|
|
var result = new MappingMatcherResult(_mappingMock.Object, _requestMatchResultMock.Object);
|
|
_matcherMock.Setup(m => m.FindBestMatch(It.IsAny<RequestMessage>())).Returns((result, result));
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert and Verify
|
|
_optionsMock.Verify(o => o.Logger.Error(It.IsAny<string>(), It.IsAny<object[]>()), Times.Once);
|
|
|
|
Expression<Func<ResponseMessage, bool>> match = r => (int?)r.StatusCode == 401;
|
|
_responseMapperMock.Verify(m => m.MapAsync(It.Is(match), It.IsAny<HttpResponse>()), Times.Once);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_IsAdminInterface_MissingHeader_401()
|
|
{
|
|
// Assign
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1", null, new Dictionary<string, string[]> { { "h", new[] { "x" } } });
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.AuthenticationMatcher).Returns(new ExactMatcher());
|
|
_mappingMock.SetupGet(m => m.IsAdminInterface).Returns(true);
|
|
|
|
var result = new MappingMatcherResult(_mappingMock.Object, _requestMatchResultMock.Object);
|
|
_matcherMock.Setup(m => m.FindBestMatch(It.IsAny<RequestMessage>())).Returns((result, result));
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert and Verify
|
|
_optionsMock.Verify(o => o.Logger.Error(It.IsAny<string>(), It.IsAny<object[]>()), Times.Once);
|
|
|
|
Expression<Func<ResponseMessage, bool>> match = r => (int?)r.StatusCode == 401;
|
|
_responseMapperMock.Verify(m => m.MapAsync(It.Is(match), It.IsAny<HttpResponse>()), Times.Once);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_RequestLogExpirationDurationIsDefined()
|
|
{
|
|
// Assign
|
|
_optionsMock.SetupGet(o => o.RequestLogExpirationDuration).Returns(1);
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_Mapping_Has_ProxyAndRecordSettings_And_SaveMapping_Is_True()
|
|
{
|
|
// Assign
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1", null, new Dictionary<string, string[]>());
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.AuthenticationMatcher).Returns(new ExactMatcher());
|
|
|
|
var fileSystemHandlerMock = new Mock<IFileSystemHandler>();
|
|
fileSystemHandlerMock.Setup(f => f.GetMappingFolder()).Returns("m");
|
|
|
|
var logger = new Mock<IWireMockLogger>();
|
|
|
|
var proxyAndRecordSettings = new ProxyAndRecordSettings
|
|
{
|
|
SaveMapping = true,
|
|
SaveMappingToFile = true
|
|
};
|
|
|
|
var settings = new WireMockServerSettings
|
|
{
|
|
FileSystemHandler = fileSystemHandlerMock.Object,
|
|
Logger = logger.Object
|
|
};
|
|
|
|
var responseBuilder = Response.Create().WithProxy(proxyAndRecordSettings);
|
|
|
|
_mappingMock.SetupGet(m => m.Provider).Returns(responseBuilder);
|
|
_mappingMock.SetupGet(m => m.Settings).Returns(settings);
|
|
|
|
var newMappingFromProxy = new Mapping(NewGuid, UpdatedAt, string.Empty, string.Empty, null, settings, Request.Create(), Response.Create(), 0, null, null, null, null, null, false, null, null);
|
|
_mappingMock.Setup(m => m.ProvideResponseAsync(It.IsAny<HttpContext>(), It.IsAny<RequestMessage>())).ReturnsAsync((new ResponseMessage(), newMappingFromProxy));
|
|
|
|
var requestBuilder = Request.Create().UsingAnyMethod();
|
|
_mappingMock.SetupGet(m => m.RequestMatcher).Returns(requestBuilder);
|
|
|
|
var result = new MappingMatcherResult(_mappingMock.Object, _requestMatchResultMock.Object);
|
|
_matcherMock.Setup(m => m.FindBestMatch(It.IsAny<RequestMessage>())).Returns((result, result));
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert and Verify
|
|
fileSystemHandlerMock.Verify(f => f.WriteMappingFile(It.IsAny<string>(), It.IsAny<string>()), Times.Once);
|
|
|
|
_mappings.Count.Should().Be(1);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_Mapping_Has_ProxyAndRecordSettings_And_SaveMapping_Is_False_But_WireMockServerSettings_SaveMapping_Is_True()
|
|
{
|
|
// Assign
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/foo"), "GET", "::1", null, new Dictionary<string, string[]>());
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.AuthenticationMatcher).Returns(new ExactMatcher());
|
|
|
|
var fileSystemHandlerMock = new Mock<IFileSystemHandler>();
|
|
fileSystemHandlerMock.Setup(f => f.GetMappingFolder()).Returns("m");
|
|
|
|
var logger = new Mock<IWireMockLogger>();
|
|
|
|
var proxyAndRecordSettings = new ProxyAndRecordSettings
|
|
{
|
|
SaveMapping = false,
|
|
SaveMappingToFile = false
|
|
};
|
|
|
|
var settings = new WireMockServerSettings
|
|
{
|
|
FileSystemHandler = fileSystemHandlerMock.Object,
|
|
Logger = logger.Object,
|
|
ProxyAndRecordSettings = new ProxyAndRecordSettings
|
|
{
|
|
SaveMapping = true,
|
|
SaveMappingToFile = true
|
|
}
|
|
};
|
|
|
|
var responseBuilder = Response.Create().WithProxy(proxyAndRecordSettings);
|
|
|
|
_mappingMock.SetupGet(m => m.Provider).Returns(responseBuilder);
|
|
_mappingMock.SetupGet(m => m.Settings).Returns(settings);
|
|
|
|
var newMappingFromProxy = new Mapping(NewGuid, UpdatedAt, "my-title", "my-description", null, settings, Request.Create(), Response.Create(), 0, null, null, null, null, null, false, null, data: null);
|
|
_mappingMock.Setup(m => m.ProvideResponseAsync(It.IsAny<HttpContext>(), It.IsAny<RequestMessage>())).ReturnsAsync((new ResponseMessage(), newMappingFromProxy));
|
|
|
|
var requestBuilder = Request.Create().UsingAnyMethod();
|
|
_mappingMock.SetupGet(m => m.RequestMatcher).Returns(requestBuilder);
|
|
|
|
var result = new MappingMatcherResult(_mappingMock.Object, _requestMatchResultMock.Object);
|
|
_matcherMock.Setup(m => m.FindBestMatch(It.IsAny<RequestMessage>())).Returns((result, result));
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert and Verify
|
|
fileSystemHandlerMock.Verify(f => f.WriteMappingFile(It.IsAny<string>(), It.IsAny<string>()), Times.Once);
|
|
|
|
_mappings.Should().HaveCount(1);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_AdminPath_WithExcludeAdminRequests_ShouldNotStartActivity()
|
|
{
|
|
// Arrange
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/__admin/health"), "GET", "::1");
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.ActivityTracingOptions).Returns(new ActivityTracingOptions
|
|
{
|
|
ExcludeAdminRequests = true
|
|
});
|
|
|
|
var activityStarted = false;
|
|
using var listener = new ActivityListener
|
|
{
|
|
ShouldListenTo = source => source.Name == WireMockActivitySource.SourceName,
|
|
Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
|
|
ActivityStarted = _ => activityStarted = true
|
|
};
|
|
|
|
ActivitySource.AddActivityListener(listener);
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert
|
|
activityStarted.Should().BeFalse();
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_NonAdminPath_WithTracingEnabled_ShouldStartActivity()
|
|
{
|
|
// Arrange
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/api/orders"), "GET", "::1");
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.ActivityTracingOptions).Returns(new ActivityTracingOptions
|
|
{
|
|
ExcludeAdminRequests = true
|
|
});
|
|
|
|
var activityStarted = false;
|
|
using var listener = new ActivityListener
|
|
{
|
|
ShouldListenTo = source => source.Name == WireMockActivitySource.SourceName,
|
|
Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
|
|
ActivityStarted = _ => activityStarted = true
|
|
};
|
|
|
|
ActivitySource.AddActivityListener(listener);
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert
|
|
activityStarted.Should().BeTrue();
|
|
}
|
|
|
|
[Fact]
|
|
public async Task WireMockMiddleware_Invoke_NonAdminPath_WithoutTracingOptions_ShouldNotStartActivity()
|
|
{
|
|
// Arrange
|
|
var request = new RequestMessage(new UrlDetails("http://localhost/api/orders"), "GET", "::1");
|
|
_requestMapperMock.Setup(m => m.MapAsync(It.IsAny<HttpContext>(), It.IsAny<IWireMockMiddlewareOptions>())).ReturnsAsync(request);
|
|
|
|
_optionsMock.SetupGet(o => o.ActivityTracingOptions).Returns((ActivityTracingOptions?)null);
|
|
|
|
var activityStarted = false;
|
|
using var listener = new ActivityListener
|
|
{
|
|
ShouldListenTo = source => source.Name == WireMockActivitySource.SourceName,
|
|
Sample = (ref ActivityCreationOptions<ActivityContext> _) => ActivitySamplingResult.AllDataAndRecorded,
|
|
ActivityStarted = _ => activityStarted = true
|
|
};
|
|
|
|
ActivitySource.AddActivityListener(listener);
|
|
|
|
// Act
|
|
await _sut.Invoke(_contextMock.Object);
|
|
|
|
// Assert
|
|
activityStarted.Should().BeFalse();
|
|
}
|
|
} |