397d3c5c4f
Rename across every client surface using each language's idiomatic convention:
* .NET clients/dotnet/MxGateway.Client[.Cli|.Tests]/
-> clients/dotnet/ZB.MOM.WW.MxGateway.Client[.Cli|.Tests]/
namespaces -> ZB.MOM.WW.MxGateway.Client[.Cli|.Tests]
contracts ProjectReference repointed to ZB.MOM.WW.MxGateway.Contracts
sln migrated to slnx (dotnet sln migrate)
* Python src/mxgateway -> src/zb_mom_ww_mxgateway
src/mxgateway_cli -> src/zb_mom_ww_mxgateway_cli
distribution: mxaccess-gateway-client -> zb-mom-ww-mxaccess-gateway-client
* Rust crate: mxgateway-client -> zb-mom-ww-mxgateway-client
build.rs proto path repointed
* Java subprojects: mxgateway-{client,cli} -> zb-mom-ww-mxgateway-{client,cli}
packages com.dohertylan.mxgateway -> com.zb.mom.ww.mxgateway
group com.dohertylan.mxgateway -> com.zb.mom.ww.mxgateway
rootProject mxaccessgw-java -> zb-mom-ww-mxaccessgw-java
* Go generate-proto.ps1 proto path repointed; module path and
package mxgateway kept (Go convention).
* proto-inputs.json: generatedOutputs.python updated to new package path.
* scripts/run-client-e2e-tests.ps1: Java CLI install path + gradle task
updated to zb-mom-ww-mxgateway-cli.
CLI binary names (mxgw, mxgw-py, mxgw-go, mxgateway-cli) and wire-level
identifiers (MXGATEWAY_* env vars, the mxgw_<id>_<secret> API key
prefix, protobuf package names like mxaccess_gateway.v1, all MXAccess
references) intentionally NOT renamed.
Fix pre-existing alarms-over-gateway breaks unblocked by the rename:
* mxaccess_gateway.proto: add missing public message QueryActiveAlarmsRequest
{session_id, client_correlation_id, alarm_filter_prefix} and missing
rpc QueryActiveAlarms(QueryActiveAlarmsRequest) returns
(stream ActiveAlarmSnapshot). All four typed clients referenced
these but they were absent from the proto.
* MxAccessGatewayService.QueryActiveAlarms: implement the new RPC on
the server, streaming from IGatewayAlarmService.CurrentAlarms with
optional alarm_filter_prefix filter.
* clients/dotnet/.../DiscoverHierarchyOptions.cs: add the hand-written
.NET POCO that wraps DiscoverHierarchyRequest (referenced by
GalaxyRepositoryClient.DiscoverHierarchyAsync but never authored).
* Drop retired session_id field references from
AcknowledgeAlarmRequest/AcknowledgeAlarmReply test fixtures across
.NET, Rust, Go, and Python clients.
* Rust integration test: add the missing stream_alarms impl on the
fake MxAccessGateway server (the trait gained the method, fake
didn't).
* Rust CLI test: bump expected gatewayProtocolVersion 2 -> 3.
Regenerated artifacts updated in this commit:
* src/ZB.MOM.WW.MxGateway.Contracts/Generated/{MxaccessGateway,MxaccessGatewayGrpc}.cs
* clients/python/src/zb_mom_ww_mxgateway/generated/*_pb2{,_grpc}.py
* clients/go/internal/generated/*.pb.go
(C# regenerated by Grpc.Tools on contracts build; Python and Go via
their generate-proto.ps1 scripts; Rust regenerates from .proto via
tonic-build at compile time so no checked-in artefact.)
Verification: 472 server tests, 275 worker tests (9 dev-rig skipped),
18 integration tests (live MxAccess + LDAP + Galaxy), 57 .NET client
tests, 32 Rust workspace tests, 39 Python tests, all Go packages, and
gradle build for Java all pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
174 lines
6.6 KiB
C#
174 lines
6.6 KiB
C#
using Grpc.Core;
|
|
using ZB.MOM.WW.MxGateway.Contracts.Proto.Galaxy;
|
|
|
|
namespace ZB.MOM.WW.MxGateway.Client.Tests;
|
|
|
|
/// <summary>
|
|
/// Fake Galaxy Repository client transport for testing.
|
|
/// </summary>
|
|
internal sealed class FakeGalaxyRepositoryTransport(MxGatewayClientOptions options) : IGalaxyRepositoryClientTransport
|
|
{
|
|
/// <summary>
|
|
/// Gets the gateway client options.
|
|
/// </summary>
|
|
public MxGatewayClientOptions Options { get; } = options;
|
|
|
|
/// <summary>
|
|
/// Gets the raw gRPC client; always null for the fake.
|
|
/// </summary>
|
|
public GalaxyRepository.GalaxyRepositoryClient? RawClient => null;
|
|
|
|
/// <summary>
|
|
/// Gets the list of TestConnection RPC calls made by the client.
|
|
/// </summary>
|
|
public List<(TestConnectionRequest Request, CallOptions CallOptions)> TestConnectionCalls { get; } = [];
|
|
|
|
/// <summary>
|
|
/// Gets the list of GetLastDeployTime RPC calls made by the client.
|
|
/// </summary>
|
|
public List<(GetLastDeployTimeRequest Request, CallOptions CallOptions)> GetLastDeployTimeCalls { get; } = [];
|
|
|
|
/// <summary>
|
|
/// Gets the list of DiscoverHierarchy RPC calls made by the client.
|
|
/// </summary>
|
|
public List<(DiscoverHierarchyRequest Request, CallOptions CallOptions)> DiscoverHierarchyCalls { get; } = [];
|
|
|
|
/// <summary>
|
|
/// Gets or sets the reply to return from TestConnection; defaults to successful response.
|
|
/// </summary>
|
|
public TestConnectionReply TestConnectionReply { get; set; } = new() { Ok = true };
|
|
|
|
/// <summary>
|
|
/// Gets or sets the reply to return from GetLastDeployTime; defaults to no deploy time present.
|
|
/// </summary>
|
|
public GetLastDeployTimeReply GetLastDeployTimeReply { get; set; } = new() { Present = false };
|
|
|
|
/// <summary>
|
|
/// Gets or sets the reply to return from DiscoverHierarchy; defaults to empty response.
|
|
/// </summary>
|
|
public DiscoverHierarchyReply DiscoverHierarchyReply { get; set; } = new();
|
|
|
|
public Queue<DiscoverHierarchyReply> DiscoverHierarchyReplies { get; } = new();
|
|
|
|
/// <summary>
|
|
/// Gets the queue of exceptions to throw from TestConnection; dequeued in FIFO order.
|
|
/// </summary>
|
|
public Queue<Exception> TestConnectionExceptions { get; } = new();
|
|
|
|
/// <summary>
|
|
/// Gets the queue of exceptions to throw from GetLastDeployTime; dequeued in FIFO order.
|
|
/// </summary>
|
|
public Queue<Exception> GetLastDeployTimeExceptions { get; } = new();
|
|
|
|
/// <summary>
|
|
/// Gets the queue of exceptions to throw from DiscoverHierarchy; dequeued in FIFO order.
|
|
/// </summary>
|
|
public Queue<Exception> DiscoverHierarchyExceptions { get; } = new();
|
|
|
|
/// <summary>
|
|
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
/// </summary>
|
|
/// <param name="request">The TestConnectionRequest to process.</param>
|
|
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
public Task<TestConnectionReply> TestConnectionAsync(
|
|
TestConnectionRequest request,
|
|
CallOptions callOptions)
|
|
{
|
|
TestConnectionCalls.Add((request, callOptions));
|
|
if (TestConnectionExceptions.TryDequeue(out Exception? exception))
|
|
{
|
|
throw exception;
|
|
}
|
|
|
|
return Task.FromResult(TestConnectionReply);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
/// </summary>
|
|
/// <param name="request">The GetLastDeployTimeRequest to process.</param>
|
|
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
public Task<GetLastDeployTimeReply> GetLastDeployTimeAsync(
|
|
GetLastDeployTimeRequest request,
|
|
CallOptions callOptions)
|
|
{
|
|
GetLastDeployTimeCalls.Add((request, callOptions));
|
|
if (GetLastDeployTimeExceptions.TryDequeue(out Exception? exception))
|
|
{
|
|
throw exception;
|
|
}
|
|
|
|
return Task.FromResult(GetLastDeployTimeReply);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Records the request and either throws a queued exception or returns the configured reply.
|
|
/// </summary>
|
|
/// <param name="request">The DiscoverHierarchyRequest to process.</param>
|
|
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
public Task<DiscoverHierarchyReply> DiscoverHierarchyAsync(
|
|
DiscoverHierarchyRequest request,
|
|
CallOptions callOptions)
|
|
{
|
|
DiscoverHierarchyCalls.Add((request, callOptions));
|
|
if (DiscoverHierarchyExceptions.TryDequeue(out Exception? exception))
|
|
{
|
|
throw exception;
|
|
}
|
|
|
|
return Task.FromResult(
|
|
DiscoverHierarchyReplies.TryDequeue(out DiscoverHierarchyReply? reply)
|
|
? reply
|
|
: DiscoverHierarchyReply);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the list of WatchDeployEvents RPC calls made by the client.
|
|
/// </summary>
|
|
public List<(WatchDeployEventsRequest Request, CallOptions CallOptions)> WatchDeployEventsCalls { get; } = [];
|
|
|
|
/// <summary>
|
|
/// Gets or sets the list of events to stream from WatchDeployEvents.
|
|
/// </summary>
|
|
public List<DeployEvent> WatchDeployEvents { get; } = [];
|
|
|
|
/// <summary>
|
|
/// Gets or sets the exception to throw from WatchDeployEvents, if any.
|
|
/// </summary>
|
|
public Exception? WatchDeployEventsException { get; set; }
|
|
|
|
/// <summary>
|
|
/// When set, awaited before each event yield so tests can observe cancellation
|
|
/// mid-stream. Receives the call's cancellation token.
|
|
/// </summary>
|
|
public Func<CancellationToken, Task>? WatchDeployEventsBeforeYield { get; set; }
|
|
|
|
/// <summary>
|
|
/// Records the request and streams events, checking for queued exceptions and calling WatchDeployEventsBeforeYield before each event.
|
|
/// </summary>
|
|
/// <param name="request">The WatchDeployEventsRequest to process.</param>
|
|
/// <param name="callOptions">Call options specifying RPC behavior.</param>
|
|
public async IAsyncEnumerable<DeployEvent> WatchDeployEventsAsync(
|
|
WatchDeployEventsRequest request,
|
|
CallOptions callOptions)
|
|
{
|
|
WatchDeployEventsCalls.Add((request, callOptions));
|
|
|
|
if (WatchDeployEventsException is not null)
|
|
{
|
|
throw WatchDeployEventsException;
|
|
}
|
|
|
|
foreach (DeployEvent deployEvent in WatchDeployEvents)
|
|
{
|
|
if (WatchDeployEventsBeforeYield is not null)
|
|
{
|
|
await WatchDeployEventsBeforeYield(callOptions.CancellationToken).ConfigureAwait(false);
|
|
}
|
|
|
|
callOptions.CancellationToken.ThrowIfCancellationRequested();
|
|
yield return deployEvent;
|
|
}
|
|
}
|
|
}
|