Joseph Doherty
a212283104
WP2.6 (arch-review remediation, cross-cutting misc): - SiteExternalSystemRepository: name/ID-indexed ExternalSystemDefinitionCache replaces the fetch-all + reverse-map scan on every by-ID/method lookup; loaded once per redeploy, invalidated by DeploymentManagerActor after HandleDeployArtifacts applies external-system changes. Static JsonSerializerOptions for method-list parsing. - Inbound API: short-TTL ApiMethodCache fronts the per-request ApiMethod repository fetch; invalidated by name via the existing ScriptArtifactChangeSubscriber/ IScriptArtifactChangeBus pipeline, self-healing via TTL for changes the bus doesn't cover (e.g. Management API edits). - StoreAndForward: the cached-call audit-observer queue — the one unbounded channel left in the system — is now bounded (ObserverQueueCapacity, default 10,000) with DropOldest overflow and a dropped-notification counter. - SiteStreamManager: alarm state changes now travel a dedicated publish source/broadcast hub, isolated from the (far higher-volume) attribute path, so an attribute storm can no longer evict a pending alarm transition; the alarm hand-off queue is bounded with a drop counter surfaced on the site health report (SiteStreamAlarmDropCount via the new SiteStreamAlarmDropReporter), and publishing is skipped entirely at zero subscribers on either path. - CLI ManagementHttpClient: explicit 30s HttpClient.Timeout on the shared construction (was the 100s framework default), overridable via SCADABRIDGE_HTTP_TIMEOUT_SECONDS. Deviation: the failback-probe heartbeat item is NOT included — its only viable surface (CentralChannelProvider.cs / heartbeat consumers) lives entirely in the Communication project, explicitly off-limits to this work package this phase. Tests: SiteRuntime.Tests (550), InboundAPI.Tests (278), StoreAndForward.Tests (133), CLI.Tests (390), HealthMonitoring.Tests (97) — all green after full solution build.
182 lines
6.4 KiB
C#
182 lines
6.4 KiB
C#
using System.Net;
|
|
using System.Text;
|
|
using ZB.MOM.WW.ScadaBridge.CLI;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.CLI.Tests;
|
|
|
|
/// <summary>
|
|
/// Regression tests for CLI-013 — <see cref="ManagementHttpClient.SendCommandAsync"/>
|
|
/// (success, error-body parsing, connection-failure, and timeout paths) was untested.
|
|
/// Uses a stub <see cref="HttpMessageHandler"/> so no live server is required.
|
|
/// </summary>
|
|
public class ManagementHttpClientTests
|
|
{
|
|
private sealed class StubHandler : HttpMessageHandler
|
|
{
|
|
private readonly Func<HttpRequestMessage, CancellationToken, Task<HttpResponseMessage>> _responder;
|
|
|
|
public StubHandler(HttpStatusCode status, string body)
|
|
: this((_, _) => Task.FromResult(new HttpResponseMessage(status)
|
|
{
|
|
Content = new StringContent(body, Encoding.UTF8, "application/json"),
|
|
}))
|
|
{
|
|
}
|
|
|
|
public StubHandler(Func<HttpRequestMessage, CancellationToken, Task<HttpResponseMessage>> responder)
|
|
{
|
|
_responder = responder;
|
|
}
|
|
|
|
protected override Task<HttpResponseMessage> SendAsync(
|
|
HttpRequestMessage request, CancellationToken cancellationToken)
|
|
=> _responder(request, cancellationToken);
|
|
}
|
|
|
|
private static ManagementHttpClient ClientWith(StubHandler handler)
|
|
=> new(new HttpClient(handler), "http://localhost:9001", "user", "pass");
|
|
|
|
[Fact]
|
|
public async Task SendCommandAsync_Success_ReturnsJsonData()
|
|
{
|
|
using var client = ClientWith(new StubHandler(HttpStatusCode.OK, "{\"id\":1}"));
|
|
|
|
var response = await client.SendCommandAsync("ListSites", new { }, TimeSpan.FromSeconds(5));
|
|
|
|
Assert.Equal(200, response.StatusCode);
|
|
Assert.Equal("{\"id\":1}", response.JsonData);
|
|
Assert.Null(response.Error);
|
|
Assert.Null(response.ErrorCode);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SendCommandAsync_ErrorBody_ParsesErrorAndCode()
|
|
{
|
|
using var client = ClientWith(new StubHandler(
|
|
HttpStatusCode.BadRequest, "{\"error\":\"Bad input\",\"code\":\"INVALID_ARGUMENT\"}"));
|
|
|
|
var response = await client.SendCommandAsync("ListSites", new { }, TimeSpan.FromSeconds(5));
|
|
|
|
Assert.Equal(400, response.StatusCode);
|
|
Assert.Null(response.JsonData);
|
|
Assert.Equal("Bad input", response.Error);
|
|
Assert.Equal("INVALID_ARGUMENT", response.ErrorCode);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SendCommandAsync_NonJsonErrorBody_FallsBackToRawBody()
|
|
{
|
|
using var client = ClientWith(new StubHandler(
|
|
HttpStatusCode.BadGateway, "<html>Bad Gateway</html>"));
|
|
|
|
var response = await client.SendCommandAsync("ListSites", new { }, TimeSpan.FromSeconds(5));
|
|
|
|
Assert.Equal(502, response.StatusCode);
|
|
Assert.Equal("<html>Bad Gateway</html>", response.Error);
|
|
Assert.Null(response.ErrorCode);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SendCommandAsync_ConnectionFailure_ReturnsStatusZero()
|
|
{
|
|
using var client = ClientWith(new StubHandler((_, _) =>
|
|
throw new HttpRequestException("connection refused")));
|
|
|
|
var response = await client.SendCommandAsync("ListSites", new { }, TimeSpan.FromSeconds(5));
|
|
|
|
Assert.Equal(0, response.StatusCode);
|
|
Assert.Equal("CONNECTION_FAILED", response.ErrorCode);
|
|
Assert.Contains("connection refused", response.Error);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task SendCommandAsync_Timeout_Returns504()
|
|
{
|
|
using var client = ClientWith(new StubHandler(async (_, ct) =>
|
|
{
|
|
await Task.Delay(Timeout.Infinite, ct);
|
|
return new HttpResponseMessage(HttpStatusCode.OK);
|
|
}));
|
|
|
|
var response = await client.SendCommandAsync("ListSites", new { }, TimeSpan.FromMilliseconds(50));
|
|
|
|
Assert.Equal(504, response.StatusCode);
|
|
Assert.Equal("TIMEOUT", response.ErrorCode);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// WP2.6e (arch-review misc — CLI HttpClient timeout): the public
|
|
/// <see cref="ManagementHttpClient"/> constructor must bound its underlying
|
|
/// <see cref="HttpClient.Timeout"/> explicitly (30 s default) rather than leaving the
|
|
/// framework's 100 s default in place, and must honor the
|
|
/// <c>SCADABRIDGE_HTTP_TIMEOUT_SECONDS</c> override — consistent with how every other
|
|
/// CLI setting is environment-overridable (<see cref="CliConfig"/>). Runs in the shared
|
|
/// "Environment" collection (see <see cref="TestCollections"/>) so it never races another
|
|
/// test mutating process-wide environment variables.
|
|
/// </summary>
|
|
[Collection("Environment")]
|
|
public class ManagementHttpClientTimeoutTests
|
|
{
|
|
private const string EnvVar = "SCADABRIDGE_HTTP_TIMEOUT_SECONDS";
|
|
|
|
[Fact]
|
|
public void DefaultConstructor_SetsThirtySecondTimeout_WhenEnvVarUnset()
|
|
{
|
|
var original = Environment.GetEnvironmentVariable(EnvVar);
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, null);
|
|
|
|
using var client = new ManagementHttpClient("http://localhost:9001", "user", "pass");
|
|
|
|
Assert.Equal(TimeSpan.FromSeconds(30), ManagementHttpClient.DefaultTimeout);
|
|
Assert.Equal(TimeSpan.FromSeconds(30), client.EffectiveTimeout);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, original);
|
|
}
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData("0")]
|
|
[InlineData("-5")]
|
|
[InlineData("not-a-number")]
|
|
[InlineData("")]
|
|
public void InvalidOrNonPositiveEnvValue_FallsBackToDefault(string value)
|
|
{
|
|
var original = Environment.GetEnvironmentVariable(EnvVar);
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, value);
|
|
|
|
using var client = new ManagementHttpClient("http://localhost:9001", "user", "pass");
|
|
|
|
Assert.Equal(TimeSpan.FromSeconds(30), client.EffectiveTimeout);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, original);
|
|
}
|
|
}
|
|
|
|
[Fact]
|
|
public void PositiveEnvValue_OverridesDefaultTimeout()
|
|
{
|
|
var original = Environment.GetEnvironmentVariable(EnvVar);
|
|
try
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, "5");
|
|
|
|
using var client = new ManagementHttpClient("http://localhost:9001", "user", "pass");
|
|
|
|
Assert.Equal(TimeSpan.FromSeconds(5), client.EffectiveTimeout);
|
|
}
|
|
finally
|
|
{
|
|
Environment.SetEnvironmentVariable(EnvVar, original);
|
|
}
|
|
}
|
|
}
|