/* ======================================================================== * Copyright (c) 2005-2025 The OPC Foundation, Inc. All rights reserved. * * OPC Foundation MIT License 1.00 * * Permission is hereby granted, free of charge, to any person * obtaining a copy of this software and associated documentation * files (the "Software"), to deal in the Software without * restriction, including without limitation the rights to use, * copy, modify, merge, publish, distribute, sublicense, and/or sell * copies of the Software, and to permit persons to whom the * Software is furnished to do so, subject to the following * conditions: * * The above copyright notice and this permission notice shall be * included in all copies or substantial portions of the Software. * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR * OTHER DEALINGS IN THE SOFTWARE. * * The complete license agreement can be found here: * http://opcfoundation.org/License/MIT/1.00/ * ======================================================================*/ // CA2000: test code; many disposables are ownership-transferred to test fixtures or short-lived, // making CA2000 noisy without a real leak risk. Disabled file-level for the suite. #pragma warning disable CA2000 using System; using Moq; using Opc.Ua.Configuration; using Opc.Ua.Tests; namespace Opc.Ua.Client.TestFramework { /// /// Session with channel mock /// public sealed class SessionMock : Session { /// /// Get private field m_serverNonce from base class using reflection /// public ByteString ServerNonce => (ByteString)typeof(Session) .GetField( "m_serverNonce", System.Reflection.BindingFlags.NonPublic | System.Reflection.BindingFlags.Instance)! .GetValue(this)!; /// /// Create the mock /// public SessionMock( Mock channel, ApplicationConfiguration configuration, ConfiguredEndpoint endpoint) : base( channel.Object, configuration, endpoint, null) { Channel = channel; } public SessionMock( Mock channel, ApplicationConfiguration configuration, ConfiguredEndpoint endpoint, ArrayOf availableEndpoints, ArrayOf discoveryProfileUris = default) : base( channel.Object, configuration, endpoint, clientCertificate: null, clientCertificateChain: null, availableEndpoints: availableEndpoints, discoveryProfileUris: discoveryProfileUris, engineFactory: null) { Channel = channel; } /// /// Create default mock /// /// public static SessionMock Create( EndpointDescription? endpoint = null, ArrayOf availableEndpoints = default, ArrayOf discoveryProfileUris = default) { ITelemetryContext telemetry = NUnitTelemetryContext.Create(); var channel = new Mock(); channel .SetupGet(s => s.MessageContext) .Returns(ServiceMessageContext.Create(telemetry)); channel .SetupGet(s => s.SupportedFeatures) .Returns(TransportChannelFeatures.Reconnect); var configuration = new ApplicationConfiguration(telemetry) { ClientConfiguration = new ClientConfiguration() // TODO: Reasonable defaults! }; endpoint ??= new EndpointDescription { SecurityMode = MessageSecurityMode.None, SecurityPolicyUri = SecurityPolicies.None, EndpointUrl = "opc.tcp://localhost:4840", UserIdentityTokens = [ new UserTokenPolicy() ] }; // TODO: Allow mocking of application certificate loading var application = new ApplicationInstance(configuration, telemetry); if (endpoint.SecurityMode != MessageSecurityMode.None) { application.CheckApplicationInstanceCertificatesAsync(true).AsTask().GetAwaiter().GetResult(); } var configuredEndpoint = new ConfiguredEndpoint( null!, endpoint ?? new EndpointDescription { SecurityMode = MessageSecurityMode.None, SecurityPolicyUri = SecurityPolicies.None, EndpointUrl = "opc.tcp://localhost:4840", UserIdentityTokens = [ new UserTokenPolicy() ] }); if (availableEndpoints.IsEmpty && discoveryProfileUris.IsEmpty) { return new SessionMock(channel, configuration, configuredEndpoint); } return new SessionMock( channel, configuration, configuredEndpoint, availableEndpoints, discoveryProfileUris); } public void SetConnected() { SessionCreated(NodeId.Parse("s=connected"), NodeId.Parse("s=auth")); RenewUserIdentity += Sut_RenewUserIdentity; } /// /// Marks the session connected and records a successful keep-alive response. /// public void SetConnectedAndResponsive() { SetConnected(); OnKeepAlive(ServerState.Running, DateTime.UtcNow); } private IUserIdentity Sut_RenewUserIdentity(ISession session, IUserIdentity identity) { return identity ?? new UserIdentity(); } /// /// Channel mock /// public Mock Channel { get; } } }