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>
This commit is contained in:
Joseph Doherty
@@ -0,0 +1,38 @@
|
||||
using Opc.Ua;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Adapters;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Models;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Fakes;
|
||||
|
||||
internal sealed class FakeApplicationConfigurationFactory : IApplicationConfigurationFactory
|
||||
{
|
||||
public bool ThrowOnCreate { get; set; }
|
||||
public int CreateCallCount { get; private set; }
|
||||
public ConnectionSettings? LastSettings { get; private set; }
|
||||
|
||||
public Task<ApplicationConfiguration> CreateAsync(ConnectionSettings settings, CancellationToken ct)
|
||||
{
|
||||
CreateCallCount++;
|
||||
LastSettings = settings;
|
||||
|
||||
if (ThrowOnCreate)
|
||||
throw new InvalidOperationException("FakeApplicationConfigurationFactory configured to fail.");
|
||||
|
||||
var config = new ApplicationConfiguration
|
||||
{
|
||||
ApplicationName = "FakeClient",
|
||||
ApplicationUri = "urn:localhost:FakeClient",
|
||||
ApplicationType = ApplicationType.Client,
|
||||
SecurityConfiguration = new SecurityConfiguration
|
||||
{
|
||||
AutoAcceptUntrustedCertificates = true
|
||||
},
|
||||
ClientConfiguration = new ClientConfiguration
|
||||
{
|
||||
DefaultSessionTimeout = settings.SessionTimeoutSeconds * 1000
|
||||
}
|
||||
};
|
||||
|
||||
return Task.FromResult(config);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,35 @@
|
||||
using Opc.Ua;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Adapters;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Fakes;
|
||||
|
||||
internal sealed class FakeEndpointDiscovery : IEndpointDiscovery
|
||||
{
|
||||
public bool ThrowOnSelect { get; set; }
|
||||
public int SelectCallCount { get; private set; }
|
||||
public string? LastEndpointUrl { get; private set; }
|
||||
|
||||
public EndpointDescription SelectEndpoint(ApplicationConfiguration config, string endpointUrl,
|
||||
MessageSecurityMode requestedMode)
|
||||
{
|
||||
SelectCallCount++;
|
||||
LastEndpointUrl = endpointUrl;
|
||||
|
||||
if (ThrowOnSelect)
|
||||
throw new InvalidOperationException($"No endpoint found for {endpointUrl}");
|
||||
|
||||
return new EndpointDescription
|
||||
{
|
||||
EndpointUrl = endpointUrl,
|
||||
SecurityMode = requestedMode,
|
||||
SecurityPolicyUri = requestedMode == MessageSecurityMode.None
|
||||
? SecurityPolicies.None
|
||||
: SecurityPolicies.Basic256Sha256,
|
||||
Server = new ApplicationDescription
|
||||
{
|
||||
ApplicationName = "FakeServer",
|
||||
ApplicationUri = "urn:localhost:FakeServer"
|
||||
}
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,199 @@
|
||||
using Opc.Ua;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Adapters;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Fakes;
|
||||
|
||||
/// <summary>
|
||||
/// Test double for <see cref="ISessionAdapter" /> used to simulate reads, writes, browsing, history, and failover callbacks.
|
||||
/// </summary>
|
||||
internal sealed class FakeSessionAdapter : ISessionAdapter
|
||||
{
|
||||
private readonly List<FakeSubscriptionAdapter> _createdSubscriptions = [];
|
||||
private Action<bool>? _keepAliveCallback;
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the fake session has been closed through the client disconnect path.
|
||||
/// </summary>
|
||||
public bool Closed { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the fake session has been disposed.
|
||||
/// </summary>
|
||||
public bool Disposed { get; private set; }
|
||||
public int ReadCount { get; private set; }
|
||||
public int WriteCount { get; private set; }
|
||||
public int BrowseCount { get; private set; }
|
||||
public int BrowseNextCount { get; private set; }
|
||||
public int HasChildrenCount { get; private set; }
|
||||
public int HistoryReadRawCount { get; private set; }
|
||||
public int HistoryReadAggregateCount { get; private set; }
|
||||
|
||||
// Configurable responses
|
||||
public DataValue? ReadResponse { get; set; }
|
||||
public Func<NodeId, DataValue>? ReadResponseFunc { get; set; }
|
||||
public StatusCode WriteResponse { get; set; } = StatusCodes.Good;
|
||||
public bool ThrowOnRead { get; set; }
|
||||
public bool ThrowOnWrite { get; set; }
|
||||
public bool ThrowOnBrowse { get; set; }
|
||||
|
||||
public ReferenceDescriptionCollection BrowseResponse { get; set; } = [];
|
||||
public byte[]? BrowseContinuationPoint { get; set; }
|
||||
public ReferenceDescriptionCollection BrowseNextResponse { get; set; } = [];
|
||||
public byte[]? BrowseNextContinuationPoint { get; set; }
|
||||
public bool HasChildrenResponse { get; set; } = false;
|
||||
|
||||
public List<DataValue> HistoryReadRawResponse { get; set; } = [];
|
||||
public List<DataValue> HistoryReadAggregateResponse { get; set; } = [];
|
||||
public bool ThrowOnHistoryReadRaw { get; set; }
|
||||
public bool ThrowOnHistoryReadAggregate { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the next fake subscription returned when the client creates a monitored-item subscription.
|
||||
/// If unset, the fake builds a new subscription automatically.
|
||||
/// </summary>
|
||||
public FakeSubscriptionAdapter? NextSubscription { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the fake subscriptions created by this session so tests can inspect replay and cleanup behavior.
|
||||
/// </summary>
|
||||
public IReadOnlyList<FakeSubscriptionAdapter> CreatedSubscriptions => _createdSubscriptions;
|
||||
|
||||
/// <inheritdoc />
|
||||
public bool Connected { get; set; } = true;
|
||||
|
||||
/// <inheritdoc />
|
||||
public string SessionId { get; set; } = "ns=0;i=12345";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string SessionName { get; set; } = "FakeSession";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string EndpointUrl { get; set; } = "opc.tcp://localhost:4840";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string ServerName { get; set; } = "FakeServer";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string SecurityMode { get; set; } = "None";
|
||||
|
||||
/// <inheritdoc />
|
||||
public string SecurityPolicyUri { get; set; } = "http://opcfoundation.org/UA/SecurityPolicy#None";
|
||||
|
||||
/// <inheritdoc />
|
||||
public NamespaceTable NamespaceUris { get; set; } = new();
|
||||
|
||||
/// <inheritdoc />
|
||||
public void RegisterKeepAliveHandler(Action<bool> callback)
|
||||
{
|
||||
_keepAliveCallback = callback;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<DataValue> ReadValueAsync(NodeId nodeId, CancellationToken ct)
|
||||
{
|
||||
ReadCount++;
|
||||
if (ThrowOnRead)
|
||||
throw new ServiceResultException(StatusCodes.BadNodeIdUnknown, "Node not found");
|
||||
|
||||
if (ReadResponseFunc != null)
|
||||
return Task.FromResult(ReadResponseFunc(nodeId));
|
||||
|
||||
return Task.FromResult(ReadResponse ?? new DataValue(new Variant(0), StatusCodes.Good));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<StatusCode> WriteValueAsync(NodeId nodeId, DataValue value, CancellationToken ct)
|
||||
{
|
||||
WriteCount++;
|
||||
if (ThrowOnWrite)
|
||||
throw new ServiceResultException(StatusCodes.BadNodeIdUnknown, "Node not found");
|
||||
return Task.FromResult(WriteResponse);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseAsync(
|
||||
NodeId nodeId, uint nodeClassMask, CancellationToken ct)
|
||||
{
|
||||
BrowseCount++;
|
||||
if (ThrowOnBrowse)
|
||||
throw new ServiceResultException(StatusCodes.BadNodeIdUnknown, "Node not found");
|
||||
return Task.FromResult((BrowseContinuationPoint, BrowseResponse));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<(byte[]? ContinuationPoint, ReferenceDescriptionCollection References)> BrowseNextAsync(
|
||||
byte[] continuationPoint, CancellationToken ct)
|
||||
{
|
||||
BrowseNextCount++;
|
||||
return Task.FromResult((BrowseNextContinuationPoint, BrowseNextResponse));
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<bool> HasChildrenAsync(NodeId nodeId, CancellationToken ct)
|
||||
{
|
||||
HasChildrenCount++;
|
||||
return Task.FromResult(HasChildrenResponse);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<IReadOnlyList<DataValue>> HistoryReadRawAsync(
|
||||
NodeId nodeId, DateTime startTime, DateTime endTime, int maxValues, CancellationToken ct)
|
||||
{
|
||||
HistoryReadRawCount++;
|
||||
if (ThrowOnHistoryReadRaw)
|
||||
throw new ServiceResultException(StatusCodes.BadHistoryOperationUnsupported, "History not supported");
|
||||
return Task.FromResult<IReadOnlyList<DataValue>>(HistoryReadRawResponse);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<IReadOnlyList<DataValue>> HistoryReadAggregateAsync(
|
||||
NodeId nodeId, DateTime startTime, DateTime endTime, NodeId aggregateId, double intervalMs,
|
||||
CancellationToken ct)
|
||||
{
|
||||
HistoryReadAggregateCount++;
|
||||
if (ThrowOnHistoryReadAggregate)
|
||||
throw new ServiceResultException(StatusCodes.BadHistoryOperationUnsupported, "History not supported");
|
||||
return Task.FromResult<IReadOnlyList<DataValue>>(HistoryReadAggregateResponse);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<ISubscriptionAdapter> CreateSubscriptionAsync(int publishingIntervalMs, CancellationToken ct)
|
||||
{
|
||||
var sub = NextSubscription ?? new FakeSubscriptionAdapter();
|
||||
NextSubscription = null;
|
||||
_createdSubscriptions.Add(sub);
|
||||
return Task.FromResult<ISubscriptionAdapter>(sub);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<IList<object>?> CallMethodAsync(NodeId objectId, NodeId methodId, object[] inputArguments,
|
||||
CancellationToken ct = default)
|
||||
{
|
||||
return Task.FromResult<IList<object>?>(null);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task CloseAsync(CancellationToken ct)
|
||||
{
|
||||
Closed = true;
|
||||
Connected = false;
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Marks the fake session as disposed so tests can verify cleanup after disconnect or failover.
|
||||
/// </summary>
|
||||
public void Dispose()
|
||||
{
|
||||
Disposed = true;
|
||||
Connected = false;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Simulates a keep-alive event.
|
||||
/// </summary>
|
||||
public void SimulateKeepAlive(bool isGood)
|
||||
{
|
||||
_keepAliveCallback?.Invoke(isGood);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,52 @@
|
||||
using Opc.Ua;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Adapters;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Fakes;
|
||||
|
||||
internal sealed class FakeSessionFactory : ISessionFactory
|
||||
{
|
||||
private readonly List<FakeSessionAdapter> _createdSessions = [];
|
||||
private readonly Queue<FakeSessionAdapter> _sessions = new();
|
||||
|
||||
public int CreateCallCount { get; private set; }
|
||||
public bool ThrowOnCreate { get; set; }
|
||||
public string? LastEndpointUrl { get; private set; }
|
||||
|
||||
public IReadOnlyList<FakeSessionAdapter> CreatedSessions => _createdSessions;
|
||||
|
||||
public Task<ISessionAdapter> CreateSessionAsync(
|
||||
ApplicationConfiguration config, EndpointDescription endpoint, string sessionName,
|
||||
uint sessionTimeoutMs, UserIdentity identity, CancellationToken ct)
|
||||
{
|
||||
CreateCallCount++;
|
||||
LastEndpointUrl = endpoint.EndpointUrl;
|
||||
|
||||
if (ThrowOnCreate)
|
||||
throw new InvalidOperationException("FakeSessionFactory configured to fail.");
|
||||
|
||||
FakeSessionAdapter session;
|
||||
if (_sessions.Count > 0)
|
||||
session = _sessions.Dequeue();
|
||||
else
|
||||
session = new FakeSessionAdapter
|
||||
{
|
||||
EndpointUrl = endpoint.EndpointUrl,
|
||||
ServerName = endpoint.Server?.ApplicationName?.Text ?? "FakeServer",
|
||||
SecurityMode = endpoint.SecurityMode.ToString(),
|
||||
SecurityPolicyUri = endpoint.SecurityPolicyUri ?? string.Empty
|
||||
};
|
||||
|
||||
// Ensure endpoint URL matches
|
||||
session.EndpointUrl = endpoint.EndpointUrl;
|
||||
_createdSessions.Add(session);
|
||||
return Task.FromResult<ISessionAdapter>(session);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Enqueues a session adapter to be returned on the next call to CreateSessionAsync.
|
||||
/// </summary>
|
||||
public void EnqueueSession(FakeSessionAdapter session)
|
||||
{
|
||||
_sessions.Enqueue(session);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,111 @@
|
||||
using Opc.Ua;
|
||||
using ZB.MOM.WW.OtOpcUa.Client.Shared.Adapters;
|
||||
|
||||
namespace ZB.MOM.WW.OtOpcUa.Client.Shared.Tests.Fakes;
|
||||
|
||||
/// <summary>
|
||||
/// Test double for <see cref="ISubscriptionAdapter" /> used to drive monitored-item behavior in shared-client tests.
|
||||
/// </summary>
|
||||
internal sealed class FakeSubscriptionAdapter : ISubscriptionAdapter
|
||||
{
|
||||
private readonly
|
||||
Dictionary<uint, (NodeId NodeId, Action<string, DataValue>? DataCallback, Action<EventFieldList>? EventCallback
|
||||
)> _items = new();
|
||||
|
||||
private uint _nextHandle = 100;
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether the fake subscription has been deleted.
|
||||
/// </summary>
|
||||
public bool Deleted { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets a value indicating whether a condition refresh was requested by the client under test.
|
||||
/// </summary>
|
||||
public bool ConditionRefreshCalled { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether condition refresh should throw to simulate unsupported servers.
|
||||
/// </summary>
|
||||
public bool ThrowOnConditionRefresh { get; set; }
|
||||
public int AddDataChangeCount { get; private set; }
|
||||
public int AddEventCount { get; private set; }
|
||||
public int RemoveCount { get; private set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets the handles of all active items.
|
||||
/// </summary>
|
||||
public IReadOnlyCollection<uint> ActiveHandles => _items.Keys.ToList();
|
||||
|
||||
/// <inheritdoc />
|
||||
public uint SubscriptionId { get; set; } = 42;
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<uint> AddDataChangeMonitoredItemAsync(NodeId nodeId, int samplingIntervalMs,
|
||||
Action<string, DataValue> onDataChange, CancellationToken ct)
|
||||
{
|
||||
AddDataChangeCount++;
|
||||
var handle = _nextHandle++;
|
||||
_items[handle] = (nodeId, onDataChange, null);
|
||||
return Task.FromResult(handle);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task RemoveMonitoredItemAsync(uint clientHandle, CancellationToken ct)
|
||||
{
|
||||
RemoveCount++;
|
||||
_items.Remove(clientHandle);
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task<uint> AddEventMonitoredItemAsync(NodeId nodeId, int samplingIntervalMs, EventFilter filter,
|
||||
Action<EventFieldList> onEvent, CancellationToken ct)
|
||||
{
|
||||
AddEventCount++;
|
||||
var handle = _nextHandle++;
|
||||
_items[handle] = (nodeId, null, onEvent);
|
||||
return Task.FromResult(handle);
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task ConditionRefreshAsync(CancellationToken ct)
|
||||
{
|
||||
ConditionRefreshCalled = true;
|
||||
if (ThrowOnConditionRefresh)
|
||||
throw new InvalidOperationException("Condition refresh not supported");
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <inheritdoc />
|
||||
public Task DeleteAsync(CancellationToken ct)
|
||||
{
|
||||
Deleted = true;
|
||||
_items.Clear();
|
||||
return Task.CompletedTask;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Clears tracked monitored items when the fake subscription is disposed by the client under test.
|
||||
/// </summary>
|
||||
public void Dispose()
|
||||
{
|
||||
_items.Clear();
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Simulates a data change notification for testing.
|
||||
/// </summary>
|
||||
public void SimulateDataChange(uint handle, DataValue value)
|
||||
{
|
||||
if (_items.TryGetValue(handle, out var item) && item.DataCallback != null)
|
||||
item.DataCallback(item.NodeId.ToString(), value);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Simulates an event notification for testing.
|
||||
/// </summary>
|
||||
public void SimulateEvent(uint handle, EventFieldList eventFields)
|
||||
{
|
||||
if (_items.TryGetValue(handle, out var item) && item.EventCallback != null) item.EventCallback(eventFields);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user