Joseph Doherty
513fa1aa16
Comment/XML-doc changes only: - add summaries to ~10k test methods, fixtures, fakes and helpers (+ <param> on theories, <returns> on async Task methods, <inheritdoc/> on interface implementations the checker can resolve) - strip ~2.6k project-tracking references (WP*, P*-*, row-NN, Task N, #NN, Component-0NN) from comments, keeping the explanatory text; reword false positives in comments only - real docs on fakes implementing BCL/library interfaces (IDisposable, ILogger, IOptionsMonitor, IAsyncLifetime) - reword the last 5 src/ false positives (CWE-1236, failures-1, year-0001, M365) Only non-comment edits: four one-line nested classes split across lines so members can carry docs. Build 0 errors / 0 warnings.
118 lines
6.4 KiB
C#
118 lines
6.4 KiB
C#
using Microsoft.Extensions.Logging.Abstractions;
|
|
using Microsoft.Extensions.Options;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Artifacts;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.DataConnection;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.DebugView;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Deployment;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.InboundApi;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Lifecycle;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.Management;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Messages.RemoteQuery;
|
|
using ZB.MOM.WW.ScadaBridge.Commons.Types;
|
|
using ZB.MOM.WW.ScadaBridge.Communication.Grpc;
|
|
|
|
namespace ZB.MOM.WW.ScadaBridge.Communication.Tests;
|
|
|
|
/// <summary>
|
|
/// Pins <see cref="GrpcSiteTransport.ResolveDeadline"/> to the EXACT Ask timeout
|
|
/// <see cref="CommunicationService"/> uses for each command today, so flipping the transport cannot
|
|
/// change how long any call waits. Every timeout is given a distinct value so a wrong mapping is
|
|
/// caught, not masked by two defaults that happen to be equal (QueryTimeout == IntegrationTimeout in
|
|
/// production).
|
|
/// </summary>
|
|
public class GrpcSiteTransportDeadlineTests
|
|
{
|
|
private static readonly CommunicationOptions Opts = new()
|
|
{
|
|
DeploymentTimeout = TimeSpan.FromSeconds(120),
|
|
LifecycleTimeout = TimeSpan.FromSeconds(30),
|
|
ArtifactDeploymentTimeout = TimeSpan.FromSeconds(60),
|
|
QueryTimeout = TimeSpan.FromSeconds(31),
|
|
IntegrationTimeout = TimeSpan.FromSeconds(32),
|
|
DebugViewTimeout = TimeSpan.FromSeconds(10)
|
|
};
|
|
|
|
private static readonly GrpcSiteTransport Transport = new(
|
|
new SitePairChannelProvider(
|
|
new NoKeyProvider(), Options.Create(Opts), NullLogger<SitePairChannelProvider>.Instance),
|
|
Opts,
|
|
NullLogger<GrpcSiteTransport>.Instance);
|
|
|
|
private static readonly DateTimeOffset T = DateTimeOffset.UtcNow;
|
|
|
|
/// <summary>Supplies the command and expected deadline pairs for the deadline theory.</summary>
|
|
/// <returns>The theory data rows.</returns>
|
|
public static IEnumerable<object[]> Cases()
|
|
{
|
|
// Lifecycle group — note it is NOT one deadline class.
|
|
yield return [new RefreshDeploymentCommand("d", "i", "h", "by", T, "u", "t"), Opts.DeploymentTimeout];
|
|
yield return [new EnableInstanceCommand("c", "i", T), Opts.LifecycleTimeout];
|
|
yield return [new DisableInstanceCommand("c", "i", T), Opts.LifecycleTimeout];
|
|
yield return [new DeleteInstanceCommand("c", "i", T), Opts.LifecycleTimeout];
|
|
// DeploymentStateQuery uses QueryTimeout in CommunicationService, NOT LifecycleTimeout.
|
|
yield return [new DeploymentStateQueryRequest("c", "i", T), Opts.QueryTimeout];
|
|
yield return [new DeployArtifactsCommand("d", null, null, null, null, null, null, T), Opts.ArtifactDeploymentTimeout];
|
|
|
|
// OPC UA group — all QueryTimeout.
|
|
yield return [new BrowseNodeCommand("conn", null, null, null), Opts.QueryTimeout];
|
|
yield return [new SearchAddressSpaceCommand("conn", "q", 1, 1, null), Opts.QueryTimeout];
|
|
yield return [new ReadTagValuesCommand("conn", []), Opts.QueryTimeout];
|
|
yield return [new VerifyEndpointCommand("conn", "OpcUa", "{}", null), Opts.QueryTimeout];
|
|
yield return [new TrustServerCertCommand("conn", "ZGVy", "AA", null), Opts.QueryTimeout];
|
|
yield return [new ListServerCertsCommand(null), Opts.QueryTimeout];
|
|
yield return [new RemoveServerCertCommand("AA", null), Opts.QueryTimeout];
|
|
yield return [new WriteTagRequest("c", "conn", "tag", 1, T), Opts.QueryTimeout];
|
|
|
|
// Query group.
|
|
yield return [new EventLogQueryRequest("c", "s", null, null, null, null, null, null, null, 10, T), Opts.QueryTimeout];
|
|
yield return [new DebugSnapshotRequest("i", "c"), Opts.QueryTimeout];
|
|
yield return [new SubscribeDebugViewRequest("i", "c"), Opts.DebugViewTimeout];
|
|
yield return [new UnsubscribeDebugViewRequest("i", "c"), Opts.DebugViewTimeout];
|
|
|
|
// Parked group — the two relays keep QueryTimeout (30s) so SiteCallAudit's inner
|
|
// RelayTimeout (10s) still expires first.
|
|
yield return [new ParkedMessageQueryRequest("c", "s", 1, 10, T), Opts.QueryTimeout];
|
|
yield return [new ParkedMessageRetryRequest("c", "s", "m", T), Opts.QueryTimeout];
|
|
yield return [new ParkedMessageDiscardRequest("c", "s", "m", T), Opts.QueryTimeout];
|
|
yield return [new RetryParkedOperation("c", new TrackedOperationId(Guid.NewGuid())), Opts.QueryTimeout];
|
|
yield return [new DiscardParkedOperation("c", new TrackedOperationId(Guid.NewGuid())), Opts.QueryTimeout];
|
|
|
|
// Route group.
|
|
yield return [new RouteToCallRequest("c", "i", "m", null, T), Opts.IntegrationTimeout];
|
|
yield return [new RouteToGetAttributesRequest("c", "i", [], T), Opts.IntegrationTimeout];
|
|
yield return [new RouteToSetAttributesRequest("c", "i", new Dictionary<string, string>(), T), Opts.IntegrationTimeout];
|
|
|
|
// Failover — QueryTimeout in CommunicationService, NOT LifecycleTimeout.
|
|
yield return [new TriggerSiteFailover("c", "s"), Opts.QueryTimeout];
|
|
}
|
|
|
|
/// <summary>Verifies that ResolveDeadline returns the same timeout the Ask-based path used for each command.</summary>
|
|
/// <param name="command">The command.</param>
|
|
/// <param name="expected">The expected.</param>
|
|
/// <returns>The result.</returns>
|
|
[Theory]
|
|
[MemberData(nameof(Cases))]
|
|
public void ResolveDeadline_MatchesTodaysAskTimeout(object command, TimeSpan expected)
|
|
{
|
|
Assert.Equal(expected, Transport.ResolveDeadline(command));
|
|
}
|
|
|
|
/// <summary>Verifies that a wait-for-attribute request uses its own timeout plus the integration slack as the deadline.</summary>
|
|
/// <returns>The result.</returns>
|
|
[Fact]
|
|
public void WaitForAttribute_UsesItsDynamicTimeoutPlusIntegrationSlack()
|
|
{
|
|
// CommunicationService.RouteToWaitForAttributeAsync uses request.Timeout + IntegrationTimeout.
|
|
var wait = new RouteToWaitForAttributeRequest("c", "i", "attr", "10", TimeSpan.FromSeconds(45), T);
|
|
Assert.Equal(TimeSpan.FromSeconds(45) + Opts.IntegrationTimeout, Transport.ResolveDeadline(wait));
|
|
}
|
|
|
|
private sealed class NoKeyProvider : ISitePskProvider
|
|
{
|
|
/// <inheritdoc />
|
|
public ValueTask<string> GetAsync(string siteId, CancellationToken ct) => new("k");
|
|
/// <inheritdoc />
|
|
public void Invalidate(string siteId) { }
|
|
}
|
|
}
|