Add injectable IScenarioStateStore for distributed scenario state (#1430)

* 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.
This commit is contained in:
m4tchl0ck
2026-03-25 13:04:44 +01:00
committed by GitHub
parent cdd33695e5
commit f919929cb7
17 changed files with 1454 additions and 801 deletions

View File

@@ -0,0 +1,273 @@
// Copyright © WireMock.Net
using System;
using System.IO;
using Newtonsoft.Json;
using WireMock.Handlers;
using Xunit;
namespace WireMock.Net.Tests.Handlers;
public class FileBasedScenarioStateStoreTests : IDisposable
{
private readonly string _tempFolder;
private readonly string _scenariosFolder;
public FileBasedScenarioStateStoreTests()
{
_tempFolder = Path.Combine(Path.GetTempPath(), "WireMock_Tests_" + Guid.NewGuid().ToString("N"));
_scenariosFolder = Path.Combine(_tempFolder, "__admin", "scenarios");
}
public void Dispose()
{
if (Directory.Exists(_tempFolder))
{
Directory.Delete(_tempFolder, true);
}
}
private FileBasedScenarioStateStore CreateSut() => new(_tempFolder);
// --- Mirror tests from InMemoryScenarioStateStoreTests ---
[Fact]
public void TryAdd_ShouldAddNewScenario()
{
var sut = CreateSut();
var state = new ScenarioState { Name = "scenario1" };
sut.TryAdd("scenario1", state).Should().BeTrue();
sut.ContainsKey("scenario1").Should().BeTrue();
}
[Fact]
public void TryAdd_ShouldReturnFalse_WhenScenarioAlreadyExists()
{
var sut = CreateSut();
var state = new ScenarioState { Name = "scenario1" };
sut.TryAdd("scenario1", state);
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" }).Should().BeFalse();
}
[Fact]
public void TryGet_ShouldReturnTrue_WhenExists()
{
var sut = CreateSut();
var state = new ScenarioState { Name = "scenario1", NextState = "state2" };
sut.TryAdd("scenario1", state);
sut.TryGet("scenario1", out var result).Should().BeTrue();
result.Should().NotBeNull();
result!.NextState.Should().Be("state2");
}
[Fact]
public void TryGet_ShouldReturnFalse_WhenNotExists()
{
var sut = CreateSut();
sut.TryGet("nonexistent", out var result).Should().BeFalse();
result.Should().BeNull();
}
[Fact]
public void GetAll_ShouldReturnAllScenarios()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
sut.TryAdd("scenario2", new ScenarioState { Name = "scenario2" });
var result = sut.GetAll();
result.Should().HaveCount(2);
}
[Fact]
public void GetAll_ShouldReturnEmpty_WhenNoScenarios()
{
var sut = CreateSut();
sut.GetAll().Should().BeEmpty();
}
[Fact]
public void Update_ShouldModifyExistingScenario()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", Counter = 0 });
var result = sut.Update("scenario1", s => { s.Counter = 5; s.NextState = "state2"; });
result.Should().NotBeNull();
result!.Counter.Should().Be(5);
result.NextState.Should().Be("state2");
}
[Fact]
public void Update_ShouldReturnNull_WhenNotExists()
{
var sut = CreateSut();
sut.Update("nonexistent", s => { s.Counter = 5; }).Should().BeNull();
}
[Fact]
public void AddOrUpdate_ShouldAddNewScenario()
{
var sut = CreateSut();
var result = sut.AddOrUpdate(
"scenario1",
_ => new ScenarioState { Name = "scenario1", NextState = "added" },
(_, current) => { current.NextState = "updated"; return current; }
);
result.NextState.Should().Be("added");
}
[Fact]
public void AddOrUpdate_ShouldUpdateExistingScenario()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", NextState = "initial" });
var result = sut.AddOrUpdate(
"scenario1",
_ => new ScenarioState { Name = "scenario1", NextState = "added" },
(_, current) => { current.NextState = "updated"; return current; }
);
result.NextState.Should().Be("updated");
}
[Fact]
public void TryRemove_ShouldRemoveExistingScenario()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
sut.TryRemove("scenario1").Should().BeTrue();
sut.ContainsKey("scenario1").Should().BeFalse();
}
[Fact]
public void TryRemove_ShouldReturnFalse_WhenNotExists()
{
var sut = CreateSut();
sut.TryRemove("nonexistent").Should().BeFalse();
}
[Fact]
public void Clear_ShouldRemoveAllScenarios()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
sut.TryAdd("scenario2", new ScenarioState { Name = "scenario2" });
sut.Clear();
sut.GetAll().Should().BeEmpty();
}
[Fact]
public void ContainsKey_ShouldBeCaseInsensitive()
{
var sut = CreateSut();
sut.TryAdd("Scenario1", new ScenarioState { Name = "Scenario1" });
sut.ContainsKey("scenario1").Should().BeTrue();
sut.ContainsKey("SCENARIO1").Should().BeTrue();
}
[Fact]
public void TryGet_ShouldBeCaseInsensitive()
{
var sut = CreateSut();
sut.TryAdd("Scenario1", new ScenarioState { Name = "Scenario1", NextState = "state2" });
sut.TryGet("scenario1", out var result1).Should().BeTrue();
result1!.NextState.Should().Be("state2");
sut.TryGet("SCENARIO1", out var result2).Should().BeTrue();
result2!.NextState.Should().Be("state2");
}
// --- File-persistence-specific tests ---
[Fact]
public void TryAdd_ShouldCreateJsonFileOnDisk()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", NextState = "state2" });
var filePath = Path.Combine(_scenariosFolder, "scenario1.json");
File.Exists(filePath).Should().BeTrue();
var json = File.ReadAllText(filePath);
var deserialized = JsonConvert.DeserializeObject<ScenarioState>(json);
deserialized!.Name.Should().Be("scenario1");
deserialized.NextState.Should().Be("state2");
}
[Fact]
public void TryRemove_ShouldDeleteJsonFileFromDisk()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
var filePath = Path.Combine(_scenariosFolder, "scenario1.json");
File.Exists(filePath).Should().BeTrue();
sut.TryRemove("scenario1");
File.Exists(filePath).Should().BeFalse();
}
[Fact]
public void Clear_ShouldDeleteAllJsonFilesFromDisk()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
sut.TryAdd("scenario2", new ScenarioState { Name = "scenario2" });
Directory.GetFiles(_scenariosFolder, "*.json").Should().HaveCount(2);
sut.Clear();
Directory.GetFiles(_scenariosFolder, "*.json").Should().BeEmpty();
}
[Fact]
public void Constructor_ShouldLoadExistingScenariosFromDisk()
{
// Pre-write JSON files before constructing the store
Directory.CreateDirectory(_scenariosFolder);
var state1 = new ScenarioState { Name = "scenario1", NextState = "loaded1" };
var state2 = new ScenarioState { Name = "scenario2", NextState = "loaded2", Counter = 3 };
File.WriteAllText(Path.Combine(_scenariosFolder, "scenario1.json"), JsonConvert.SerializeObject(state1));
File.WriteAllText(Path.Combine(_scenariosFolder, "scenario2.json"), JsonConvert.SerializeObject(state2));
var sut = CreateSut();
sut.GetAll().Should().HaveCount(2);
sut.TryGet("scenario1", out var loaded1).Should().BeTrue();
loaded1!.NextState.Should().Be("loaded1");
sut.TryGet("scenario2", out var loaded2).Should().BeTrue();
loaded2!.Counter.Should().Be(3);
}
[Fact]
public void Update_ShouldPersistChangesToDisk()
{
var sut = CreateSut();
sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", Counter = 0 });
sut.Update("scenario1", s => { s.Counter = 10; s.NextState = "persisted"; });
var filePath = Path.Combine(_scenariosFolder, "scenario1.json");
var json = File.ReadAllText(filePath);
var deserialized = JsonConvert.DeserializeObject<ScenarioState>(json);
deserialized!.Counter.Should().Be(10);
deserialized.NextState.Should().Be("persisted");
}
}

View File

@@ -0,0 +1,157 @@
// Copyright © WireMock.Net
using WireMock.Handlers;
using Xunit;
namespace WireMock.Net.Tests.Handlers;
public class InMemoryScenarioStateStoreTests
{
private readonly InMemoryScenarioStateStore _sut = new();
[Fact]
public void TryAdd_ShouldAddNewScenario()
{
var state = new ScenarioState { Name = "scenario1" };
_sut.TryAdd("scenario1", state).Should().BeTrue();
_sut.ContainsKey("scenario1").Should().BeTrue();
}
[Fact]
public void TryAdd_ShouldReturnFalse_WhenScenarioAlreadyExists()
{
var state = new ScenarioState { Name = "scenario1" };
_sut.TryAdd("scenario1", state);
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" }).Should().BeFalse();
}
[Fact]
public void TryGet_ShouldReturnTrue_WhenExists()
{
var state = new ScenarioState { Name = "scenario1", NextState = "state2" };
_sut.TryAdd("scenario1", state);
_sut.TryGet("scenario1", out var result).Should().BeTrue();
result.Should().NotBeNull();
result!.NextState.Should().Be("state2");
}
[Fact]
public void TryGet_ShouldReturnFalse_WhenNotExists()
{
_sut.TryGet("nonexistent", out var result).Should().BeFalse();
result.Should().BeNull();
}
[Fact]
public void GetAll_ShouldReturnAllScenarios()
{
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
_sut.TryAdd("scenario2", new ScenarioState { Name = "scenario2" });
var result = _sut.GetAll();
result.Should().HaveCount(2);
}
[Fact]
public void GetAll_ShouldReturnEmpty_WhenNoScenarios()
{
_sut.GetAll().Should().BeEmpty();
}
[Fact]
public void Update_ShouldModifyExistingScenario()
{
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", Counter = 0 });
var result = _sut.Update("scenario1", s => { s.Counter = 5; s.NextState = "state2"; });
result.Should().NotBeNull();
result!.Counter.Should().Be(5);
result.NextState.Should().Be("state2");
}
[Fact]
public void Update_ShouldReturnNull_WhenNotExists()
{
_sut.Update("nonexistent", s => { s.Counter = 5; }).Should().BeNull();
}
[Fact]
public void AddOrUpdate_ShouldAddNewScenario()
{
var result = _sut.AddOrUpdate(
"scenario1",
_ => new ScenarioState { Name = "scenario1", NextState = "added" },
(_, current) => { current.NextState = "updated"; return current; }
);
result.NextState.Should().Be("added");
}
[Fact]
public void AddOrUpdate_ShouldUpdateExistingScenario()
{
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1", NextState = "initial" });
var result = _sut.AddOrUpdate(
"scenario1",
_ => new ScenarioState { Name = "scenario1", NextState = "added" },
(_, current) => { current.NextState = "updated"; return current; }
);
result.NextState.Should().Be("updated");
}
[Fact]
public void TryRemove_ShouldRemoveExistingScenario()
{
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
_sut.TryRemove("scenario1").Should().BeTrue();
_sut.ContainsKey("scenario1").Should().BeFalse();
}
[Fact]
public void TryRemove_ShouldReturnFalse_WhenNotExists()
{
_sut.TryRemove("nonexistent").Should().BeFalse();
}
[Fact]
public void Clear_ShouldRemoveAllScenarios()
{
_sut.TryAdd("scenario1", new ScenarioState { Name = "scenario1" });
_sut.TryAdd("scenario2", new ScenarioState { Name = "scenario2" });
_sut.Clear();
_sut.GetAll().Should().BeEmpty();
}
[Fact]
public void ContainsKey_ShouldBeCaseInsensitive()
{
_sut.TryAdd("Scenario1", new ScenarioState { Name = "Scenario1" });
_sut.ContainsKey("scenario1").Should().BeTrue();
_sut.ContainsKey("SCENARIO1").Should().BeTrue();
}
[Fact]
public void TryGet_ShouldBeCaseInsensitive()
{
_sut.TryAdd("Scenario1", new ScenarioState { Name = "Scenario1", NextState = "state2" });
_sut.TryGet("scenario1", out var result1).Should().BeTrue();
result1!.NextState.Should().Be("state2");
_sut.TryGet("SCENARIO1", out var result2).Should().BeTrue();
result2!.NextState.Should().Be("state2");
}
}

View File

@@ -2,6 +2,7 @@
using System.Collections.Concurrent;
using Moq;
using WireMock.Handlers;
using WireMock.Logging;
using WireMock.Matchers.Request;
using WireMock.Models;
@@ -23,7 +24,7 @@ public class MappingMatcherTests
_optionsMock.SetupAllProperties();
_optionsMock.Setup(o => o.Mappings).Returns(new ConcurrentDictionary<Guid, IMapping>());
_optionsMock.Setup(o => o.LogEntries).Returns([]);
_optionsMock.Setup(o => o.Scenarios).Returns(new ConcurrentDictionary<string, ScenarioState>());
_optionsMock.Setup(o => o.ScenarioStateStore).Returns(new InMemoryScenarioStateStore());
var loggerMock = new Mock<IWireMockLogger>();
loggerMock.SetupAllProperties();

View File

@@ -55,7 +55,7 @@ public class WireMockMiddlewareTests
_optionsMock.SetupAllProperties();
_optionsMock.Setup(o => o.Mappings).Returns(_mappings);
_optionsMock.Setup(o => o.LogEntries).Returns(new ConcurrentObservableCollection<LogEntry>());
_optionsMock.Setup(o => o.Scenarios).Returns(new ConcurrentDictionary<string, ScenarioState>());
_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>()));

View File

@@ -325,26 +325,26 @@ public class StatefulBehaviorTests
var getResponse1 = await client.GetStringAsync("/todo/items", cancelationToken);
getResponse1.Should().Be("Buy milk");
server.Scenarios["To do list"].Name.Should().Be("To do list");
server.Scenarios["To do list"].NextState.Should().Be("TodoList State Started");
server.Scenarios["To do list"].Started.Should().BeTrue();
server.Scenarios["To do list"].Finished.Should().BeFalse();
server.Scenarios.First(s => s.Name == "To do list").Name.Should().Be("To do list");
server.Scenarios.First(s => s.Name == "To do list").NextState.Should().Be("TodoList State Started");
server.Scenarios.First(s => s.Name == "To do list").Started.Should().BeTrue();
server.Scenarios.First(s => s.Name == "To do list").Finished.Should().BeFalse();
var postResponse = await client.PostAsync("/todo/items", new StringContent("Cancel newspaper subscription"), cancelationToken);
postResponse.StatusCode.Should().Be(HttpStatusCode.Created);
server.Scenarios["To do list"].Name.Should().Be("To do list");
server.Scenarios["To do list"].NextState.Should().Be("Cancel newspaper item added");
server.Scenarios["To do list"].Started.Should().BeTrue();
server.Scenarios["To do list"].Finished.Should().BeFalse();
server.Scenarios.First(s => s.Name == "To do list").Name.Should().Be("To do list");
server.Scenarios.First(s => s.Name == "To do list").NextState.Should().Be("Cancel newspaper item added");
server.Scenarios.First(s => s.Name == "To do list").Started.Should().BeTrue();
server.Scenarios.First(s => s.Name == "To do list").Finished.Should().BeFalse();
string getResponse2 = await client.GetStringAsync("/todo/items", cancelationToken);
getResponse2.Should().Be("Buy milk;Cancel newspaper subscription");
server.Scenarios["To do list"].Name.Should().Be("To do list");
server.Scenarios["To do list"].NextState.Should().BeNull();
server.Scenarios["To do list"].Started.Should().BeTrue();
server.Scenarios["To do list"].Finished.Should().BeTrue();
server.Scenarios.First(s => s.Name == "To do list").Name.Should().Be("To do list");
server.Scenarios.First(s => s.Name == "To do list").NextState.Should().BeNull();
server.Scenarios.First(s => s.Name == "To do list").Started.Should().BeTrue();
server.Scenarios.First(s => s.Name == "To do list").Finished.Should().BeTrue();
server.Stop();
}
@@ -372,14 +372,14 @@ public class StatefulBehaviorTests
// Act and Assert
server.SetScenarioState(scenario, "Buy milk");
server.Scenarios[scenario].Should().BeEquivalentTo(new { Name = scenario, NextState = "Buy milk" });
server.Scenarios.First(s => s.Name == scenario).Should().BeEquivalentTo(new { Name = scenario, NextState = "Buy milk" });
var getResponse1 = await client.GetStringAsync("/todo/items", cancelationToken);
getResponse1.Should().Be("Buy milk");
server.SetScenarioState(scenario, "Cancel newspaper");
server.Scenarios[scenario].Name.Should().Be(scenario);
server.Scenarios[scenario].Should().BeEquivalentTo(new { Name = scenario, NextState = "Cancel newspaper" });
server.Scenarios.First(s => s.Name == scenario).Name.Should().Be(scenario);
server.Scenarios.First(s => s.Name == scenario).Should().BeEquivalentTo(new { Name = scenario, NextState = "Cancel newspaper" });
var getResponse2 = await client.GetStringAsync("/todo/items", cancelationToken);
getResponse2.Should().Be("Buy milk;Cancel newspaper subscription");