rename: prefix gateway projects/namespaces with ZB.MOM.WW + sln→slnx

Apply the ZB.MOM.WW. prefix to all gateway-side projects, folders, .csproj/.sln contents, C# namespaces, using directives, generated proto C# (csharp_namespace + checked-in generated files), InternalsVisibleTo attributes, project-name string literals (LoadProject, .sln lookups, worker exe paths, staticwebassets manifest), and the install/script/doc references that point at any of the above. Migrate the solution from .sln to .slnx via `dotnet sln migrate` and delete the old file. External-runtime identifiers are intentionally NOT prefixed so external configuration keeps working: - GatewayMetrics.cs MeterName ("MxGateway.Server") - DashboardAuthenticationDefaults Scheme/Policy ("MxGateway.Dashboard") - GatewayRequestLoggingMiddleware logger category ("MxGateway.Request") - StaRuntime thread name ("MxGateway.Worker.STA") - appsettings.json root section "MxGateway" + env-var prefix MxGateway__... and secret-name MxGateway:ApiKeyPepper - C:\ProgramData\MxGateway\ data dir paths Also fixes two tests that were not rename-related but became visible while validating the rename: - WorkerLiveMxAccessSmokeTests.ShutDownAsync: cancellation that the gateway service correctly maps to RpcException(Cancelled) per gRPC convention was being misclassified as a stream fault. Added a sibling catch on RpcException with StatusCode.Cancelled. - IntegrationTestEnvironment.ResolveRepositoryRoot: extracted IsRepositoryRoot and made it accept either a .git marker OR a .sln/.slnx next to src/ so the worker-exe walker works in non-git working copies. clients/proto/proto-inputs.json's protoRoot updated to point at src/ZB.MOM.WW.MxGateway.Contracts/Protos. Verified by `dotnet build` and a full `dotnet test` of the .slnx with MXGATEWAY_RUN_LIVE_{MXACCESS,LDAP,GALAXY}_TESTS=1: Tests: 472/472 pass Worker.Tests: 280/280 pass (4 dev-rig [Fact(Skip=...)] skipped) IntegrationTests: 18/18 pass Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-23 16:22:23 -04:00
parent 867bf18116
commit dc9c0c950c
491 changed files with 32854 additions and 8414 deletions
@@ -0,0 +1,42 @@
+using ZB.MOM.WW.MxGateway.Server.Security.Authentication;
+using ZB.MOM.WW.MxGateway.Server.Security.Authorization;
+using ZB.MOM.WW.MxGateway.Server.Sessions;
+
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+/// <see cref="IConstraintEnforcer"/> that permits every operation, for tests that
+/// exercise gRPC service or interceptor behaviour without constraint policy.
+/// </summary>
+public sealed class AllowAllConstraintEnforcer : IConstraintEnforcer
+{
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckReadTagAsync(
+        ApiKeyIdentity? identity,
+        string tagAddress,
+        CancellationToken cancellationToken) => Task.FromResult<ConstraintFailure?>(null);
+
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckReadHandleAsync(
+        ApiKeyIdentity? identity,
+        GatewaySession session,
+        int serverHandle,
+        int itemHandle,
+        CancellationToken cancellationToken) => Task.FromResult<ConstraintFailure?>(null);
+
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckWriteHandleAsync(
+        ApiKeyIdentity? identity,
+        GatewaySession session,
+        int serverHandle,
+        int itemHandle,
+        CancellationToken cancellationToken) => Task.FromResult<ConstraintFailure?>(null);
+
+    /// <inheritdoc />
+    public Task RecordDenialAsync(
+        ApiKeyIdentity? identity,
+        string commandKind,
+        string target,
+        ConstraintFailure failure,
+        CancellationToken cancellationToken) => Task.CompletedTask;
+}
@@ -0,0 +1,54 @@
+using System.Runtime.CompilerServices;
+using ZB.MOM.WW.MxGateway.Contracts.Proto;
+using ZB.MOM.WW.MxGateway.Server.Alarms;
+
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+///     <see cref="IGatewayAlarmService"/> test double — serves a scripted
+///     active-alarm set and acknowledges every request with an OK status,
+///     so gRPC service tests can exercise the alarm handlers without the
+///     real gateway alarm monitor or a worker.
+/// </summary>
+public sealed class FakeGatewayAlarmService : IGatewayAlarmService
+{
+    /// <inheritdoc />
+    public GatewayAlarmMonitorState State { get; set; } = GatewayAlarmMonitorState.Monitoring;
+
+    /// <inheritdoc />
+    public string? LastError { get; set; }
+
+    /// <inheritdoc />
+    public int? WorkerProcessId { get; set; }
+
+    /// <inheritdoc />
+    public IReadOnlyList<ActiveAlarmSnapshot> CurrentAlarms { get; set; } = [];
+
+    /// <inheritdoc />
+    public async IAsyncEnumerable<AlarmFeedMessage> StreamAsync(
+        string? alarmFilterPrefix,
+        [EnumeratorCancellation] CancellationToken cancellationToken)
+    {
+        foreach (ActiveAlarmSnapshot alarm in CurrentAlarms)
+        {
+            cancellationToken.ThrowIfCancellationRequested();
+            yield return new AlarmFeedMessage { ActiveAlarm = alarm };
+        }
+
+        yield return new AlarmFeedMessage { SnapshotComplete = true };
+        await Task.CompletedTask.ConfigureAwait(false);
+    }
+
+    /// <inheritdoc />
+    public Task<AcknowledgeAlarmReply> AcknowledgeAsync(
+        AcknowledgeAlarmRequest request,
+        CancellationToken cancellationToken)
+    {
+        return Task.FromResult(new AcknowledgeAlarmReply
+        {
+            CorrelationId = request.ClientCorrelationId,
+            ProtocolStatus = new ProtocolStatus { Code = ProtocolStatusCode.Ok },
+            DiagnosticMessage = string.Empty,
+        });
+    }
+}
@@ -0,0 +1,22 @@
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+/// <see cref="TimeProvider"/> with a manually advanced clock for deterministic
+/// timestamp / heartbeat / lease tests. Tests inject one of these instead of
+/// <see cref="TimeProvider.System"/> so timing assertions don't depend on the
+/// wall clock. Constructed without arguments (or with <c>default</c>) it seeds
+/// from <see cref="DateTimeOffset.UtcNow"/>; for fully deterministic tests pass
+/// an explicit start instant.
+/// </summary>
+/// <param name="start">Initial clock value. When <c>default</c>, the clock seeds from <see cref="DateTimeOffset.UtcNow"/>.</param>
+public sealed class ManualTimeProvider(DateTimeOffset start = default) : TimeProvider
+{
+    private DateTimeOffset _now = start == default ? DateTimeOffset.UtcNow : start;
+
+    /// <inheritdoc />
+    public override DateTimeOffset GetUtcNow() => _now;
+
+    /// <summary>Advances the manual clock by the given amount.</summary>
+    /// <param name="delta">Amount of time to add to the current clock value.</param>
+    public void Advance(TimeSpan delta) => _now += delta;
+}
@@ -0,0 +1,89 @@
+using ZB.MOM.WW.MxGateway.Server.Security.Authentication;
+using ZB.MOM.WW.MxGateway.Server.Security.Authorization;
+using ZB.MOM.WW.MxGateway.Server.Sessions;
+
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+///     <see cref="IConstraintEnforcer"/> for tests that exercise the constraint
+///     filtering and reply-merging code paths in
+///     <c>MxAccessGatewayService.ApplyConstraintsAsync</c> and the
+///     <c>BulkConstraintPlan</c> family. Callers supply predicates that decide
+///     whether a given tag address or (server, item) handle is denied; recorded
+///     denials are exposed for assertions.
+/// </summary>
+public sealed class PredicateConstraintEnforcer : IConstraintEnforcer
+{
+    /// <summary>Deny predicate keyed on tag address (returns true to deny).</summary>
+    public Func<string, bool> DenyTag { get; init; } = _ => false;
+
+    /// <summary>Deny predicate keyed on (serverHandle, itemHandle) (returns true to deny).</summary>
+    public Func<int, int, bool> DenyReadHandle { get; init; } = (_, _) => false;
+
+    /// <summary>Deny predicate keyed on (serverHandle, itemHandle) (returns true to deny).</summary>
+    public Func<int, int, bool> DenyWriteHandle { get; init; } = (_, _) => false;
+
+    /// <summary>Recorded denial messages — (commandKind, target) tuples.</summary>
+    public List<(string CommandKind, string Target)> RecordedDenials { get; } = [];
+
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckReadTagAsync(
+        ApiKeyIdentity? identity,
+        string tagAddress,
+        CancellationToken cancellationToken)
+    {
+        if (DenyTag(tagAddress))
+        {
+            return Task.FromResult<ConstraintFailure?>(
+                new ConstraintFailure("read-tag", $"Read denied for tag '{tagAddress}'."));
+        }
+
+        return Task.FromResult<ConstraintFailure?>(null);
+    }
+
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckReadHandleAsync(
+        ApiKeyIdentity? identity,
+        GatewaySession session,
+        int serverHandle,
+        int itemHandle,
+        CancellationToken cancellationToken)
+    {
+        if (DenyReadHandle(serverHandle, itemHandle))
+        {
+            return Task.FromResult<ConstraintFailure?>(
+                new ConstraintFailure("read-handle", $"Read denied for handle {itemHandle}."));
+        }
+
+        return Task.FromResult<ConstraintFailure?>(null);
+    }
+
+    /// <inheritdoc />
+    public Task<ConstraintFailure?> CheckWriteHandleAsync(
+        ApiKeyIdentity? identity,
+        GatewaySession session,
+        int serverHandle,
+        int itemHandle,
+        CancellationToken cancellationToken)
+    {
+        if (DenyWriteHandle(serverHandle, itemHandle))
+        {
+            return Task.FromResult<ConstraintFailure?>(
+                new ConstraintFailure("write-handle", $"Write denied for handle {itemHandle}."));
+        }
+
+        return Task.FromResult<ConstraintFailure?>(null);
+    }
+
+    /// <inheritdoc />
+    public Task RecordDenialAsync(
+        ApiKeyIdentity? identity,
+        string commandKind,
+        string target,
+        ConstraintFailure failure,
+        CancellationToken cancellationToken)
+    {
+        RecordedDenials.Add((commandKind, target));
+        return Task.CompletedTask;
+    }
+}
@@ -0,0 +1,50 @@
+using Grpc.Core;
+
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+/// Thread-safe <see cref="IServerStreamWriter{T}"/> that records every written message
+/// and lets a test await the first message with a timeout.
+/// </summary>
+/// <typeparam name="T">The streamed message type.</typeparam>
+public sealed class RecordingServerStreamWriter<T> : IServerStreamWriter<T>
+{
+    private readonly object _syncRoot = new();
+    private readonly TaskCompletionSource<T> _firstMessage = new(TaskCreationOptions.RunContinuationsAsynchronously);
+    private readonly List<T> _messages = [];
+
+    /// <summary>Gets the messages written to this stream, in order.</summary>
+    public IReadOnlyList<T> Messages
+    {
+        get
+        {
+            lock (_syncRoot)
+            {
+                return _messages.ToArray();
+            }
+        }
+    }
+
+    /// <summary>Gets or sets options for writing messages to the stream.</summary>
+    public WriteOptions? WriteOptions { get; set; }
+
+    /// <summary>Records the supplied message.</summary>
+    /// <param name="message">The message to record.</param>
+    /// <returns>A completed task.</returns>
+    public Task WriteAsync(T message)
+    {
+        lock (_syncRoot)
+        {
+            _messages.Add(message);
+        }
+
+        _firstMessage.TrySetResult(message);
+        return Task.CompletedTask;
+    }
+
+    /// <summary>Waits for the first message to be written within the specified timeout.</summary>
+    /// <param name="timeout">Maximum time to wait for the first message.</param>
+    /// <returns>The first message written to this stream.</returns>
+    public async Task<T> WaitForFirstMessageAsync(TimeSpan timeout) =>
+        await _firstMessage.Task.WaitAsync(timeout).ConfigureAwait(false);
+}
@@ -0,0 +1,76 @@
+using Grpc.Core;
+
+namespace ZB.MOM.WW.MxGateway.Tests.TestSupport;
+
+/// <summary>
+/// Minimal in-memory <see cref="ServerCallContext"/> for exercising gRPC service
+/// implementations directly in unit tests, without a real gRPC transport.
+/// </summary>
+public sealed class TestServerCallContext : ServerCallContext
+{
+    private readonly Metadata _requestHeaders;
+    private readonly Metadata _responseTrailers = [];
+    private readonly Dictionary<object, object> _userState = [];
+    private readonly CancellationToken _cancellationToken;
+    private Status _status;
+    private WriteOptions? _writeOptions;
+
+    /// <summary>Initializes the context with the supplied request headers and cancellation token.</summary>
+    /// <param name="requestHeaders">Request headers visible to the service; defaults to empty.</param>
+    /// <param name="cancellationToken">Cancellation token surfaced to the service.</param>
+    public TestServerCallContext(Metadata? requestHeaders = null, CancellationToken cancellationToken = default)
+    {
+        _requestHeaders = requestHeaders ?? [];
+        _cancellationToken = cancellationToken;
+    }
+
+    /// <inheritdoc />
+    protected override string MethodCore => "/mxaccess_gateway.v1.MxAccessGateway/Test";
+
+    /// <inheritdoc />
+    protected override string HostCore => "localhost";
+
+    /// <inheritdoc />
+    protected override string PeerCore => "ipv4:127.0.0.1:5000";
+
+    /// <inheritdoc />
+    protected override DateTime DeadlineCore => DateTime.UtcNow.AddMinutes(1);
+
+    /// <inheritdoc />
+    protected override Metadata RequestHeadersCore => _requestHeaders;
+
+    /// <inheritdoc />
+    protected override CancellationToken CancellationTokenCore => _cancellationToken;
+
+    /// <inheritdoc />
+    protected override Metadata ResponseTrailersCore => _responseTrailers;
+
+    /// <inheritdoc />
+    protected override Status StatusCore
+    {
+        get => _status;
+        set => _status = value;
+    }
+
+    /// <inheritdoc />
+    protected override WriteOptions? WriteOptionsCore
+    {
+        get => _writeOptions;
+        set => _writeOptions = value;
+    }
+
+    /// <inheritdoc />
+    protected override AuthContext AuthContextCore { get; } = new(
+        string.Empty,
+        new Dictionary<string, List<AuthProperty>>(StringComparer.Ordinal));
+
+    /// <inheritdoc />
+    protected override IDictionary<object, object> UserStateCore => _userState;
+
+    /// <inheritdoc />
+    protected override Task WriteResponseHeadersAsyncCore(Metadata responseHeaders) => Task.CompletedTask;
+
+    /// <inheritdoc />
+    protected override ContextPropagationToken CreatePropagationTokenCore(ContextPropagationOptions? options) =>
+        throw new NotSupportedException();
+}