Phase 0 — mechanical rename ZB.MOM.WW.LmxOpcUa.* → ZB.MOM.WW.OtOpcUa.*

Renames all 11 projects (5 src + 6 tests), the .slnx solution file, all source-file namespaces, all axaml namespace references, and all v1 documentation references in CLAUDE.md and docs/*.md (excluding docs/v2/ which is already in OtOpcUa form). Also updates the TopShelf service registration name from "LmxOpcUa" to "OtOpcUa" per Phase 0 Task 0.6. Preserves runtime identifiers per Phase 0 Out-of-Scope rules to avoid breaking v1/v2 client trust during coexistence: OPC UA `ApplicationUri` defaults (`urn:{GalaxyName}:LmxOpcUa`), server `EndpointPath` (`/LmxOpcUa`), `ServerName` default (feeds cert subject CN), `MxAccessConfiguration.ClientName` default (defensive — stays "LmxOpcUa" for MxAccess audit-trail consistency), client OPC UA identifiers (`ApplicationName = "LmxOpcUaClient"`, `ApplicationUri = "urn:localhost:LmxOpcUaClient"`, cert directory `%LocalAppData%\LmxOpcUaClient\pki\`), and the `LmxOpcUaServer` class name (class rename out of Phase 0 scope per Task 0.5 sed pattern; happens in Phase 1 alongside `LmxNodeManager → GenericDriverNodeManager` Core extraction). 23 LmxOpcUa references retained, all enumerated and justified in `docs/v2/implementation/exit-gate-phase-0.md`. Build clean: 0 errors, 30 warnings (lower than baseline 167). Tests at strict improvement over baseline: 821 passing / 1 failing vs baseline 820 / 2 (one flaky pre-existing failure passed this run; the other still fails — both pre-existing and unrelated to the rename). `Client.UI.Tests`, `Historian.Aveva.Tests`, `Client.Shared.Tests`, `IntegrationTests` all match baseline exactly. Exit gate compliance results recorded in `docs/v2/implementation/exit-gate-phase-0.md` with all 7 checks PASS or DEFERRED-to-PR-review (#7 service install verification needs Windows service permissions on the reviewer's box). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-17 13:57:47 -04:00
parent 5b8d708c58
commit 3b2defd94f
293 changed files with 841 additions and 722 deletions
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ChangeDetectionToRebuildWiringTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ChangeDetectionToRebuildWiringTest.cs
@@ -0,0 +1,58 @@
+using System;
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Host.GalaxyRepository;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: Galaxy change detection → OnGalaxyChanged → address space rebuild
+    /// </summary>
+    public class ChangeDetectionToRebuildWiringTest
+    {
+        /// <summary>
+        ///     Confirms that a changed deploy timestamp causes the change-detection pipeline to raise another rebuild signal.
+        /// </summary>
+        [Fact]
+        public async Task ChangedTimestamp_TriggersRebuild()
+        {
+            var repo = new FakeGalaxyRepository
+            {
+                LastDeployTime = new DateTime(2024, 1, 1),
+                Hierarchy = new List<GalaxyObjectInfo>
+                {
+                    new() { GobjectId = 1, TagName = "Obj1", BrowseName = "Obj1", ParentGobjectId = 0, IsArea = false }
+                },
+                Attributes = new List<GalaxyAttributeInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "Obj1", AttributeName = "Attr1", FullTagReference = "Obj1.Attr1",
+                        MxDataType = 5, IsArray = false
+                    }
+                }
+            };
+
+            var rebuildCount = 0;
+            var service = new ChangeDetectionService(repo, 1);
+            service.OnGalaxyChanged += () => Interlocked.Increment(ref rebuildCount);
+
+            service.Start();
+            await Task.Delay(500); // First poll triggers
+            rebuildCount.ShouldBeGreaterThanOrEqualTo(1);
+
+            // Change deploy time → should trigger rebuild
+            repo.LastDeployTime = new DateTime(2024, 2, 1);
+            await Task.Delay(1500);
+            service.Stop();
+
+            rebuildCount.ShouldBeGreaterThanOrEqualTo(2);
+            service.Dispose();
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/MxAccessToNodeManagerWiringTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/MxAccessToNodeManagerWiringTest.cs
@@ -0,0 +1,54 @@
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: FakeMxProxy OnDataChange → MxAccessClient → OnTagValueChanged → node manager delivery
+    /// </summary>
+    public class MxAccessToNodeManagerWiringTest
+    {
+        /// <summary>
+        ///     Confirms that a simulated data change reaches the global tag-value-changed event.
+        /// </summary>
+        [Fact]
+        public async Task DataChange_ReachesGlobalHandler()
+        {
+            var mxClient = new FakeMxAccessClient();
+            string? receivedAddress = null;
+            Vtq? receivedVtq = null;
+
+            mxClient.OnTagValueChanged += (addr, vtq) =>
+            {
+                receivedAddress = addr;
+                receivedVtq = vtq;
+            };
+
+            mxClient.SimulateDataChange("TestTag.Attr", Vtq.Good(42));
+
+            receivedAddress.ShouldBe("TestTag.Attr");
+            receivedVtq.ShouldNotBeNull();
+            receivedVtq.Value.Value.ShouldBe(42);
+            receivedVtq.Value.Quality.ShouldBe(Quality.Good);
+        }
+
+        /// <summary>
+        ///     Confirms that a simulated data change reaches the stored per-tag subscription callback.
+        /// </summary>
+        [Fact]
+        public async Task DataChange_ReachesSubscriptionCallback()
+        {
+            var mxClient = new FakeMxAccessClient();
+            Vtq? received = null;
+
+            await mxClient.SubscribeAsync("TestTag.Attr", (addr, vtq) => received = vtq);
+            mxClient.SimulateDataChange("TestTag.Attr", Vtq.Good(99));
+
+            received.ShouldNotBeNull();
+            received.Value.Value.ShouldBe(99);
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaReadToMxAccessWiringTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaReadToMxAccessWiringTest.cs
@@ -0,0 +1,59 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Host.OpcUa;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: OPC UA Read → NodeManager → IMxAccessClient.ReadAsync with correct full_tag_reference
+    /// </summary>
+    public class OpcUaReadToMxAccessWiringTest
+    {
+        /// <summary>
+        ///     Confirms that the resolved OPC UA read path uses the expected full Galaxy tag reference.
+        /// </summary>
+        [Fact]
+        public async Task Read_ResolvesCorrectTagReference()
+        {
+            var mxClient = new FakeMxAccessClient();
+            mxClient.TagValues["DelmiaReceiver_001.DownloadPath"] = Vtq.Good("/some/path");
+
+            var hierarchy = new List<GalaxyObjectInfo>
+            {
+                new()
+                {
+                    GobjectId = 1, TagName = "TestMachine_001", BrowseName = "TestMachine_001", ParentGobjectId = 0,
+                    IsArea = false
+                },
+                new()
+                {
+                    GobjectId = 2, TagName = "DelmiaReceiver_001", ContainedName = "DelmiaReceiver",
+                    BrowseName = "DelmiaReceiver", ParentGobjectId = 1, IsArea = false
+                }
+            };
+            var attributes = new List<GalaxyAttributeInfo>
+            {
+                new()
+                {
+                    GobjectId = 2, TagName = "DelmiaReceiver_001", AttributeName = "DownloadPath",
+                    FullTagReference = "DelmiaReceiver_001.DownloadPath", MxDataType = 5, IsArray = false
+                }
+            };
+
+            var model = AddressSpaceBuilder.Build(hierarchy, attributes);
+
+            // The model should contain the correct tag reference
+            model.NodeIdToTagReference.ContainsKey("DelmiaReceiver_001.DownloadPath").ShouldBe(true);
+            model.NodeIdToTagReference["DelmiaReceiver_001.DownloadPath"].ShouldBe("DelmiaReceiver_001.DownloadPath");
+
+            // The MxAccessClient should be able to read using the tag reference
+            var vtq = await mxClient.ReadAsync("DelmiaReceiver_001.DownloadPath");
+            vtq.Value.ShouldBe("/some/path");
+            vtq.Quality.ShouldBe(Quality.Good);
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaServiceDashboardFailureTests.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaServiceDashboardFailureTests.cs
@@ -0,0 +1,78 @@
+using System;
+using System.Collections.Generic;
+using System.Net;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host;
+using ZB.MOM.WW.OtOpcUa.Host.Configuration;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Regression for stability review 2026-04-13 Finding 2. Confirms that when the dashboard
+    ///     port is already bound, the service continues to start (degraded mode) and the
+    ///     <see cref="OpcUaService.DashboardStartFailed"/> flag is raised.
+    /// </summary>
+    public class OpcUaServiceDashboardFailureTests
+    {
+        [Fact]
+        public void Start_DashboardPortInUse_ContinuesInDegradedMode()
+        {
+            var dashboardPort = new Random().Next(19500, 19999);
+            using var blocker = new HttpListener();
+            blocker.Prefixes.Add($"http://localhost:{dashboardPort}/");
+            blocker.Start();
+
+            var config = new AppConfiguration
+            {
+                OpcUa = new OpcUaConfiguration
+                {
+                    Port = 14842,
+                    GalaxyName = "TestGalaxy",
+                    EndpointPath = "/LmxOpcUa"
+                },
+                MxAccess = new MxAccessConfiguration { ClientName = "Test" },
+                GalaxyRepository = new GalaxyRepositoryConfiguration(),
+                Dashboard = new DashboardConfiguration { Enabled = true, Port = dashboardPort }
+            };
+
+            var proxy = new FakeMxProxy();
+            var repo = new FakeGalaxyRepository
+            {
+                Hierarchy = new List<GalaxyObjectInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", BrowseName = "TestObj",
+                        ParentGobjectId = 0, IsArea = false
+                    }
+                },
+                Attributes = new List<GalaxyAttributeInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", AttributeName = "TestAttr",
+                        FullTagReference = "TestObj.TestAttr", MxDataType = 5, IsArray = false
+                    }
+                }
+            };
+
+            var service = new OpcUaService(config, proxy, repo);
+            service.Start();
+
+            try
+            {
+                // Service continues despite dashboard bind failure — degraded mode policy.
+                service.ServerHost.ShouldNotBeNull();
+                service.DashboardStartFailed.ShouldBeTrue();
+                service.StatusWeb.ShouldBeNull();
+            }
+            finally
+            {
+                service.Stop();
+            }
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaWriteToMxAccessWiringTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/OpcUaWriteToMxAccessWiringTest.cs
@@ -0,0 +1,52 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Host.OpcUa;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: OPC UA Write → NodeManager → IMxAccessClient.WriteAsync with correct tag+value
+    /// </summary>
+    public class OpcUaWriteToMxAccessWiringTest
+    {
+        /// <summary>
+        ///     Confirms that the resolved OPC UA write path targets the expected Galaxy tag reference and payload.
+        /// </summary>
+        [Fact]
+        public async Task Write_SendsCorrectTagAndValue()
+        {
+            var mxClient = new FakeMxAccessClient();
+
+            var hierarchy = new List<GalaxyObjectInfo>
+            {
+                new()
+                {
+                    GobjectId = 1, TagName = "TestMachine_001", BrowseName = "TestMachine_001", ParentGobjectId = 0,
+                    IsArea = false
+                }
+            };
+            var attributes = new List<GalaxyAttributeInfo>
+            {
+                new()
+                {
+                    GobjectId = 1, TagName = "TestMachine_001", AttributeName = "MachineCode",
+                    FullTagReference = "TestMachine_001.MachineCode", MxDataType = 5, IsArray = false
+                }
+            };
+
+            var model = AddressSpaceBuilder.Build(hierarchy, attributes);
+            var tagRef = model.NodeIdToTagReference["TestMachine_001.MachineCode"];
+
+            // Write through MxAccessClient
+            var result = await mxClient.WriteAsync(tagRef, "NEW_CODE");
+
+            result.ShouldBe(true);
+            mxClient.WrittenValues.ShouldContain(w =>
+                w.Tag == "TestMachine_001.MachineCode" && (string)w.Value == "NEW_CODE");
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ServiceStartupSequenceTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ServiceStartupSequenceTest.cs
@@ -0,0 +1,149 @@
+using System.Collections.Generic;
+using System.Threading.Tasks;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host;
+using ZB.MOM.WW.OtOpcUa.Host.Configuration;
+using ZB.MOM.WW.OtOpcUa.Host.Domain;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: OpcUaService Start() creates and wires all components with fakes.
+    /// </summary>
+    public class ServiceStartupSequenceTest
+    {
+        /// <summary>
+        ///     Confirms that startup with fake dependencies creates the expected bridge components and state.
+        /// </summary>
+        [Fact]
+        public void Start_WithFakes_AllComponentsCreated()
+        {
+            var config = new AppConfiguration
+            {
+                OpcUa = new OpcUaConfiguration
+                {
+                    Port = 14840,
+                    GalaxyName = "TestGalaxy",
+                    EndpointPath = "/LmxOpcUa"
+                },
+                MxAccess = new MxAccessConfiguration { ClientName = "Test" },
+                GalaxyRepository = new GalaxyRepositoryConfiguration(),
+                Dashboard = new DashboardConfiguration { Enabled = false } // Don't start HTTP listener in tests
+            };
+
+            var proxy = new FakeMxProxy();
+            var repo = new FakeGalaxyRepository
+            {
+                Hierarchy = new List<GalaxyObjectInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", BrowseName = "TestObj", ParentGobjectId = 0, IsArea = false
+                    }
+                },
+                Attributes = new List<GalaxyAttributeInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", AttributeName = "TestAttr",
+                        FullTagReference = "TestObj.TestAttr", MxDataType = 5, IsArray = false
+                    }
+                }
+            };
+
+            var service = new OpcUaService(config, proxy, repo);
+            service.Start();
+
+            try
+            {
+                // Verify all components were created
+                service.MxClient.ShouldNotBeNull();
+                service.MxClient!.State.ShouldBe(ConnectionState.Connected);
+                service.Metrics.ShouldNotBeNull();
+                service.ServerHost.ShouldNotBeNull();
+                service.ChangeDetectionInstance.ShouldNotBeNull();
+                service.GalaxyStatsInstance.ShouldNotBeNull();
+                service.GalaxyStatsInstance!.GalaxyName.ShouldBe("TestGalaxy");
+                service.GalaxyStatsInstance.DbConnected.ShouldBe(true);
+                service.StatusReportInstance.ShouldNotBeNull();
+
+                // Dashboard disabled → no web server
+                service.StatusWeb.ShouldBeNull();
+
+                // MxProxy should have been registered
+                proxy.IsRegistered.ShouldBe(true);
+            }
+            finally
+            {
+                service.Stop();
+            }
+        }
+
+        /// <summary>
+        ///     Confirms that when MXAccess is initially unavailable, the background monitor reconnects it later.
+        /// </summary>
+        [Fact]
+        public async Task Start_WhenMxAccessIsInitiallyDown_MonitorReconnectsInBackground()
+        {
+            var config = new AppConfiguration
+            {
+                OpcUa = new OpcUaConfiguration
+                {
+                    Port = 14841,
+                    GalaxyName = "TestGalaxy",
+                    EndpointPath = "/LmxOpcUa"
+                },
+                MxAccess = new MxAccessConfiguration
+                {
+                    ClientName = "Test",
+                    MonitorIntervalSeconds = 1,
+                    AutoReconnect = true
+                },
+                GalaxyRepository = new GalaxyRepositoryConfiguration(),
+                Dashboard = new DashboardConfiguration { Enabled = false }
+            };
+
+            var proxy = new FakeMxProxy { ShouldFailRegister = true };
+            var repo = new FakeGalaxyRepository
+            {
+                Hierarchy = new List<GalaxyObjectInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", BrowseName = "TestObj", ParentGobjectId = 0, IsArea = false
+                    }
+                },
+                Attributes = new List<GalaxyAttributeInfo>
+                {
+                    new()
+                    {
+                        GobjectId = 1, TagName = "TestObj", AttributeName = "TestAttr",
+                        FullTagReference = "TestObj.TestAttr", MxDataType = 5, IsArray = false
+                    }
+                }
+            };
+
+            var service = new OpcUaService(config, proxy, repo);
+            service.Start();
+
+            try
+            {
+                service.ServerHost.ShouldNotBeNull();
+                service.MxClient.ShouldNotBeNull();
+                service.MxClient!.State.ShouldBe(ConnectionState.Error);
+
+                proxy.ShouldFailRegister = false;
+                await Task.Delay(2500);
+
+                service.MxClient.State.ShouldBe(ConnectionState.Connected);
+                proxy.RegisterCallCount.ShouldBeGreaterThan(1);
+            }
+            finally
+            {
+                service.Stop();
+            }
+        }
+    }
+}
--- a/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ShutdownCompletesTest.cs
+++ b/tests/ZB.MOM.WW.OtOpcUa.Tests/Wiring/ShutdownCompletesTest.cs
@@ -0,0 +1,41 @@
+using System.Diagnostics;
+using Shouldly;
+using Xunit;
+using ZB.MOM.WW.OtOpcUa.Host;
+using ZB.MOM.WW.OtOpcUa.Host.Configuration;
+using ZB.MOM.WW.OtOpcUa.Tests.Helpers;
+
+namespace ZB.MOM.WW.OtOpcUa.Tests.Wiring
+{
+    /// <summary>
+    ///     Verifies: Start then Stop completes within 30 seconds. (SVC-004)
+    /// </summary>
+    public class ShutdownCompletesTest
+    {
+        /// <summary>
+        ///     Confirms that a started service can shut down within the required time budget.
+        /// </summary>
+        [Fact]
+        public void Shutdown_CompletesWithin30Seconds()
+        {
+            var config = new AppConfiguration
+            {
+                OpcUa = new OpcUaConfiguration { Port = 14841, GalaxyName = "TestGalaxy" },
+                MxAccess = new MxAccessConfiguration { ClientName = "Test" },
+                Dashboard = new DashboardConfiguration { Enabled = false }
+            };
+
+            var proxy = new FakeMxProxy();
+            var repo = new FakeGalaxyRepository();
+            var service = new OpcUaService(config, proxy, repo);
+
+            service.Start();
+
+            var sw = Stopwatch.StartNew();
+            service.Stop();
+            sw.Stop();
+
+            sw.Elapsed.TotalSeconds.ShouldBeLessThan(30);
+        }
+    }
+}