Phase 2 Stream D Option B — archive v1 surface + new Driver.Galaxy.E2E parity suite. Non-destructive intermediate state: the v1 OtOpcUa.Host + Historian.Aveva + Tests + IntegrationTests projects all still build (494 v1 unit + 6 v1 integration tests still pass when run explicitly), but solution-level dotnet test ZB.MOM.WW.OtOpcUa.slnx now skips them via IsTestProject=false on the test projects + archive-status PropertyGroup comments on the src projects. The destructive deletion is reserved for Phase 2 PR 3 with explicit operator review per CLAUDE.md "only use destructive operations when truly the best approach". tests/ZB.MOM.WW.OtOpcUa.Tests/ renamed via git mv to tests/ZB.MOM.WW.OtOpcUa.Tests.v1Archive/; csproj <AssemblyName> kept as the original ZB.MOM.WW.OtOpcUa.Tests so v1 OtOpcUa.Host's [InternalsVisibleTo("ZB.MOM.WW.OtOpcUa.Tests")] still matches and the project rebuilds clean. tests/ZB.MOM.WW.OtOpcUa.IntegrationTests gets <IsTestProject>false</IsTestProject>. src/ZB.MOM.WW.OtOpcUa.Host + src/ZB.MOM.WW.OtOpcUa.Historian.Aveva get PropertyGroup archive-status comments documenting they're functionally superseded but kept in-build because cascading dependencies (Historian.Aveva → Host; IntegrationTests → Host) make a single-PR deletion high blast-radius. New tests/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.E2E/ project (.NET 10) with ParityFixture that spawns OtOpcUa.Driver.Galaxy.Host.exe (net48 x86) as a Process.Start subprocess with OTOPCUA_GALAXY_BACKEND=db env vars, awaits 2s for the PipeServer to bind, then exposes a connected GalaxyProxyDriver; skips on non-Windows / Administrator shells (PipeAcl denies admins per decision #76) / ZB unreachable / Host EXE not built — each skip carries a SkipReason string the test method reads via Assert.Skip(SkipReason). RecordingAddressSpaceBuilder captures every Folder/Variable/AddProperty registration so parity tests can assert on the same shape v1 LmxNodeManager produced. HierarchyParityTests (3) — Discover returns gobjects with attributes; attribute full references match the tag.attribute Galaxy reference grammar; HistoryExtension flag flows through correctly. StabilityFindingsRegressionTests (4) — one test per 2026-04-13 stability finding from commits c76ab8f and 7310925: phantom probe subscription doesn't corrupt unrelated host status; HostStatusChangedEventArgs structurally carries a specific HostName + OldState + NewState (event signature mathematically prevents the v1 cross-host quality-clear bug); all GalaxyProxyDriver capability methods return Task or Task<T> (sync-over-async would deadlock OPC UA stack thread); AcknowledgeAsync completes before returning (no fire-and-forget background work that could race shutdown). Solution test count: 470 pass / 7 skip (E2E on admin shell) / 1 pre-existing Phase 0 baseline. Run archived suites explicitly: dotnet test tests/ZB.MOM.WW.OtOpcUa.Tests.v1Archive (494 pass) + dotnet test tests/ZB.MOM.WW.OtOpcUa.IntegrationTests (6 pass). docs/v2/V1_ARCHIVE_STATUS.md inventories every archived surface with run-it-explicitly instructions + a 10-step deletion plan for PR 3 + rollback procedure (git revert restores all four projects). docs/v2/implementation/exit-gate-phase-2-final.md supersedes the two partial-exit docs with the per-stream status table (A/B/C/D/E all addressed, D split across PR 2/3 per safety protocol), the test count breakdown, fresh adversarial review of PR 2 deltas (4 new findings: medium IsTestProject=false safety net loss, medium structural-vs-behavioral stability tests, low backend=db default, low Process.Start env inheritance), the 8 carried-forward findings from exit-gate-phase-2.md, the recommended PR order (1 → 2 → 3 → 4). docs/v2/implementation/pr-2-body.md is the Gitea web-UI paste-in for opening PR 2 once pushed.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-18 00:56:21 -04:00
parent 50f81a156d
commit a3d16a28f1
76 changed files with 692 additions and 2 deletions
--- a/tests/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.E2E/ParityFixture.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.E2E/ParityFixture.cs
@@ -0,0 +1,136 @@
+using System.Diagnostics;
+using System.Net.Sockets;
+using System.Reflection;
+using System.Security.Principal;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Proxy;
+
+namespace ZB.MOM.WW.OtOpcUa.Driver.Galaxy.E2E;
+
+/// <summary>
+///     Spawns one <c>OtOpcUa.Driver.Galaxy.Host.exe</c> subprocess per test class and exposes
+///     a connected <see cref="GalaxyProxyDriver"/> for the tests. Per Phase 2 plan §"Stream E
+///     Parity Validation": the Proxy owns a session against a real out-of-process Host running
+///     the production-shape <c>MxAccessGalaxyBackend</c> backed by live ZB + MXAccess COM.
+///     Skipped when the Host EXE isn't built, when ZB SQL is unreachable, or when the dev box
+///     runs as Administrator (the IPC ACL explicitly denies Administrators per decision #76).
+/// </summary>
+public sealed class ParityFixture : IAsyncLifetime
+{
+    public GalaxyProxyDriver? Driver { get; private set; }
+    public string? SkipReason { get; private set; }
+
+    private Process? _host;
+    private const string Secret = "parity-suite-secret";
+
+    public async ValueTask InitializeAsync()
+    {
+        if (!OperatingSystem.IsWindows()) { SkipReason = "Windows-only"; return; }
+        if (IsAdministrator()) { SkipReason = "PipeAcl denies Administrators on dev shells"; return; }
+        if (!await ZbReachableAsync()) { SkipReason = "Galaxy ZB SQL not reachable on localhost:1433"; return; }
+
+        var hostExe = FindHostExe();
+        if (hostExe is null) { SkipReason = "Galaxy.Host EXE not built — run `dotnet build src/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host`"; return; }
+
+        // Use the SQL-only DB backend by default — exercises the full IPC + dispatcher + SQL
+        // path without requiring a healthy MXAccess connection. Tests that need MXAccess
+        // override via env vars before InitializeAsync is called (use a separate fixture).
+        var pipe = $"OtOpcUaGalaxyParity-{Guid.NewGuid():N}";
+        using var identity = WindowsIdentity.GetCurrent();
+        var sid = identity.User!;
+
+        var psi = new ProcessStartInfo(hostExe)
+        {
+            UseShellExecute = false,
+            CreateNoWindow = true,
+            RedirectStandardOutput = true,
+            RedirectStandardError = true,
+            EnvironmentVariables =
+            {
+                ["OTOPCUA_GALAXY_PIPE"] = pipe,
+                ["OTOPCUA_ALLOWED_SID"] = sid.Value,
+                ["OTOPCUA_GALAXY_SECRET"] = Secret,
+                ["OTOPCUA_GALAXY_BACKEND"] = "db",
+                ["OTOPCUA_GALAXY_ZB_CONN"] = "Server=localhost;Database=ZB;Integrated Security=True;TrustServerCertificate=True;Encrypt=False;",
+            },
+        };
+
+        _host = Process.Start(psi)
+            ?? throw new InvalidOperationException("Failed to spawn Galaxy.Host EXE");
+
+        // Give the PipeServer ~2s to bind. The supervisor's HeartbeatMonitor can do this
+        // in production with retry, but the parity tests are best served by a fixed warm-up.
+        await Task.Delay(2_000);
+
+        Driver = new GalaxyProxyDriver(new GalaxyProxyOptions
+        {
+            DriverInstanceId = "parity",
+            PipeName = pipe,
+            SharedSecret = Secret,
+            ConnectTimeout = TimeSpan.FromSeconds(5),
+        });
+
+        await Driver.InitializeAsync(driverConfigJson: "{}", CancellationToken.None);
+    }
+
+    public async ValueTask DisposeAsync()
+    {
+        if (Driver is not null)
+        {
+            try { await Driver.ShutdownAsync(CancellationToken.None); } catch { /* shutdown */ }
+            Driver.Dispose();
+        }
+
+        if (_host is not null && !_host.HasExited)
+        {
+            try { _host.Kill(entireProcessTree: true); } catch { /* ignore */ }
+            try { _host.WaitForExit(5_000); } catch { /* ignore */ }
+        }
+        _host?.Dispose();
+    }
+
+    /// <summary>Skip the test if the fixture couldn't initialize. xUnit Skip.If pattern.</summary>
+    public void SkipIfUnavailable()
+    {
+        if (SkipReason is not null)
+            Assert.Skip(SkipReason);
+    }
+
+    private static bool IsAdministrator()
+    {
+        if (!OperatingSystem.IsWindows()) return false;
+        using var identity = WindowsIdentity.GetCurrent();
+        return new WindowsPrincipal(identity).IsInRole(WindowsBuiltInRole.Administrator);
+    }
+
+    private static async Task<bool> ZbReachableAsync()
+    {
+        try
+        {
+            using var client = new TcpClient();
+            var task = client.ConnectAsync("localhost", 1433);
+            return await Task.WhenAny(task, Task.Delay(1_500)) == task && client.Connected;
+        }
+        catch { return false; }
+    }
+
+    private static string? FindHostExe()
+    {
+        var asmDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location)!;
+        var solutionRoot = asmDir;
+        for (var i = 0; i < 8 && solutionRoot is not null; i++)
+        {
+            if (File.Exists(Path.Combine(solutionRoot, "ZB.MOM.WW.OtOpcUa.slnx"))) break;
+            solutionRoot = Path.GetDirectoryName(solutionRoot);
+        }
+        if (solutionRoot is null) return null;
+
+        var path = Path.Combine(solutionRoot,
+            "src", "ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Host", "bin", "Debug", "net48",
+            "OtOpcUa.Driver.Galaxy.Host.exe");
+        return File.Exists(path) ? path : null;
+    }
+}
+
+[CollectionDefinition(nameof(ParityCollection))]
+public sealed class ParityCollection : ICollectionFixture<ParityFixture> { }