Files
wwtools/mbproxy/tests/Mbproxy.Tests/HostSmokeTests.cs
T
Joseph Doherty 56eee3c563 mbproxy: initial commit through Phase 9 (TxId multiplexing)
Adds the mbproxy service end-to-end. Phases 00-08 implement the
production-ready single-listener / 1:1-backend transparent Modbus TCP
proxy with bidirectional BCD rewriting for the ~54-PLC DL205/DL260
fleet. Phase 9 replaces the connection layer with a single backend
socket per PLC plus MBAP TxId rewriting, lifting the H2-ECOM100's
4-concurrent-client cap as an operational ceiling.

Phase 9 additions of note:
- PlcMultiplexer + UpstreamPipe + TxIdAllocator + CorrelationMap
- InFlightRequest with IReadOnlyList<InterestedParty> (load-bearing
  for Phase 10 read coalescing — do not collapse to a single field)
- Per-request watchdog: surfaces Modbus exception 0x0B to upstream
  on BackendRequestTimeoutMs, defending against lost responses,
  dead-PLC paths, and pymodbus 3.13.0's concurrent-multiplexed-
  request bug (its ServerRequestHandler.last_pdu state race)
- Status DTO + HTML gain inFlight / maxInFlight / txIdWraps /
  disconnectCascades / queueDepth (Tier 1.6 in docs/kpi.md)

Tests: 263 unit + 38 E2E. Multiplexer correctness under truly
concurrent backend traffic is proved against a stub backend in
PlcMultiplexerTests; MultiplexerE2ETests paces requests so pymodbus
3.13's single-PDU framer stays in known-good mode.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-14 01:49:35 -04:00

120 lines
3.9 KiB
C#

using System.Collections.Concurrent;
using Mbproxy;
using Mbproxy.Options;
using Mbproxy.Proxy;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Serilog;
using Serilog.Core;
using Serilog.Events;
using Shouldly;
using Xunit;
namespace Mbproxy.Tests;
/// <summary>
/// Smoke tests: host starts, logs <c>mbproxy.startup.ready</c>, and shuts down cleanly.
/// </summary>
[Trait("Category", "Unit")]
public sealed class HostSmokeTests
{
[Fact]
public async Task HostSmoke_StartsAndStops_Cleanly_AndLogs_StartupReady()
{
// Arrange: build a host with an in-memory Serilog sink.
var sink = new CapturingSink();
var serilogLogger = new LoggerConfiguration()
.MinimumLevel.Debug()
.WriteTo.Sink(sink)
.CreateLogger();
using var host = Host.CreateApplicationBuilder()
.ConfigureForTest(serilogLogger)
.Build();
using var cts = new CancellationTokenSource(TimeSpan.FromSeconds(10));
// Act
await host.StartAsync(cts.Token);
// Give ProxyWorker time to fire (it binds 0 listeners and logs startup.ready).
await Task.Delay(500, cts.Token);
await host.StopAsync(cts.Token);
// Assert: the startup.ready event was logged at Information.
var readyEvents = sink.Events
.Where(e =>
e.Level == LogEventLevel.Information &&
e.MessageTemplate.Text.Contains("mbproxy service ready"))
.ToList();
readyEvents.ShouldNotBeEmpty("ProxyWorker should have logged mbproxy.startup.ready");
}
[Fact]
public async Task HostSmoke_ShutdownIsOrdered()
{
// Arrange
using var host = Host.CreateApplicationBuilder()
.ConfigureForTest(new LoggerConfiguration().CreateLogger())
.Build();
using var startCts = new CancellationTokenSource(TimeSpan.FromSeconds(5));
await host.StartAsync(startCts.Token);
// Act: stop must complete well within 2 s.
using var stopCts = new CancellationTokenSource(TimeSpan.FromSeconds(2));
var stopTask = host.StopAsync(stopCts.Token);
// Assert: does not throw / time out.
await stopTask.ShouldCompleteWithinAsync(TimeSpan.FromSeconds(3));
}
}
/// <summary>
/// Helper to configure a <see cref="HostApplicationBuilder"/> for smoke tests,
/// wiring in an in-memory config and the workers under test.
/// </summary>
internal static class TestHostBuilderExtensions
{
public static HostApplicationBuilder ConfigureForTest(
this HostApplicationBuilder builder,
Serilog.ILogger serilogLogger)
{
// Minimal in-memory config so AddMbproxyOptions doesn't fail.
builder.Configuration.AddInMemoryCollection(new Dictionary<string, string?>
{
["Mbproxy:AdminPort"] = "8080",
});
builder.Services.AddSerilog(serilogLogger, dispose: false);
builder.AddMbproxyOptions();
// Phase 03: register the no-op pipeline and ProxyWorker (replaces HeartbeatWorker).
builder.Services.AddSingleton<IPduPipeline, NoopPduPipeline>();
builder.Services.AddHostedService<ProxyWorker>();
return builder;
}
}
/// <summary>Serilog <see cref="ILogEventSink"/> that stores events for assertion.</summary>
internal sealed class CapturingSink : ILogEventSink
{
private readonly ConcurrentQueue<LogEvent> _events = new();
public IEnumerable<LogEvent> Events => _events;
public void Emit(LogEvent logEvent) => _events.Enqueue(logEvent);
}
internal static class TaskExtensions
{
public static async Task ShouldCompleteWithinAsync(this Task task, TimeSpan timeout)
{
var completed = await Task.WhenAny(task, Task.Delay(timeout));
completed.ShouldBe(task, $"Task did not complete within {timeout}");
await task; // propagate any exception
}
}