/* ======================================================================== * 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/ * ======================================================================*/ using System.Collections.Generic; using System.Threading; using System.Threading.Tasks; using Moq; using NUnit.Framework; namespace Opc.Ua.Server.Tests.NodeManager { /// /// Unit tests for . /// [TestFixture] [Category("NodeManager")] [Parallelizable(ParallelScope.All)] public class SyncNodeManagerAdapterTests { [Test] public void ConstructorRejectsNullNodeManager() { Assert.That(() => new SyncNodeManagerAdapter(null!), Throws.ArgumentNullException); } [Test] public void FactoryReturnsSameInstanceWhenAsyncManagerIsAlsoSyncManager() { var manager = new Mock(); INodeManager result = manager.Object.ToSyncNodeManager(); Assert.That(result, Is.SameAs(manager.Object)); } [Test] public void FactoryWrapsAsyncOnlyManager() { var manager = new Mock(); INodeManager result = manager.Object.ToSyncNodeManager(); Assert.That(result, Is.TypeOf()); } [Test] public void AllMethodsForwardToAsyncNodeManager() { var manager = new Mock(MockBehavior.Strict); var adapter = new SyncNodeManagerAdapter(manager.Object); OperationContext context = NewOpContext(RequestType.Read); var externalReferences = new Dictionary>(); var references = new Dictionary>(); var nodeId = new NodeId(123, 2); object handle = new(); object sourceHandle = new(); var referenceTypeId = new NodeId(234, 2); var targetId = new ExpandedNodeId(new NodeId(345, 2)); var metadata = new NodeMetadata(handle, nodeId); var continuationPoint = new ContinuationPoint(); var returnedContinuationPoint = new ContinuationPoint(); var referenceDescriptions = new List(); var relativePath = new RelativePathElement(); var targetIds = new List(); var unresolvedTargetIds = new List(); var readValues = new ArrayOf(); var values = new List(); var readErrors = new List(); var historyReadDetails = new ReadRawModifiedDetails(); var historyReadValues = new ArrayOf(); var historyReadResults = new List(); var historyReadErrors = new List(); var writeValues = new ArrayOf(); var writeErrors = new List(); var historyUpdates = new ArrayOf(); var historyUpdateResults = new List(); var historyUpdateErrors = new List(); var methodsToCall = new ArrayOf(); var callResults = new List(); var callErrors = new List(); IEventMonitoredItem monitoredItem = new Mock().Object; var eventItems = new List(); var itemsToCreate = new ArrayOf(); var createErrors = new List(); var filterErrors = new List(); var monitoredItems = new List(); var idFactory = new MonitoredItemIdFactory(); var itemsToRestore = new List(); IUserIdentity ownerIdentity = new Mock().Object; var itemsToModify = new ArrayOf(); var modifyErrors = new List(); var deleteProcessed = new List(); var deleteErrors = new List(); var transferProcessed = new List(); var transferErrors = new List(); var monitoringProcessed = new List(); var monitoringErrors = new List(); var sessionId = new NodeId(456, 2); var permissionCache = new Dictionary(); var methodToCall = new CallMethodRequest(); var methodState = new MethodState(null); IFilterTarget filterTarget = new Mock().Object; string[] namespaces = ["urn:test"]; var deleteReferenceResult = new ServiceResult(StatusCodes.BadNodeIdUnknown); var eventResult = new ServiceResult(StatusCodes.BadEventFilterInvalid); var allEventsResult = new ServiceResult(StatusCodes.BadSubscriptionIdInvalid); var permissionResult = new ServiceResult(StatusCodes.BadUserAccessDenied); var roleResult = new ServiceResult(StatusCodes.BadSecurityChecksFailed); SetupAsyncMethods( manager, namespaces, externalReferences, references, nodeId, handle, sourceHandle, referenceTypeId, targetId, deleteReferenceResult, context, metadata, continuationPoint, returnedContinuationPoint, referenceDescriptions, relativePath, targetIds, unresolvedTargetIds, readValues, values, readErrors, historyReadDetails, historyReadValues, historyReadResults, historyReadErrors, writeValues, writeErrors, historyUpdates, historyUpdateResults, historyUpdateErrors, methodsToCall, callResults, callErrors, monitoredItem, eventItems, eventResult, allEventsResult, itemsToCreate, createErrors, filterErrors, monitoredItems, idFactory, itemsToRestore, ownerIdentity, itemsToModify, modifyErrors, deleteProcessed, deleteErrors, transferProcessed, transferErrors, monitoringProcessed, monitoringErrors, sessionId, permissionCache, methodToCall, methodState, filterTarget, permissionResult, roleResult); Assert.That(adapter.NamespaceUris, Is.SameAs(namespaces)); adapter.CreateAddressSpace(externalReferences); adapter.DeleteAddressSpace(); Assert.That(adapter.GetManagerHandle(nodeId), Is.SameAs(handle)); adapter.AddReferences(references); Assert.That( adapter.DeleteReference(sourceHandle, referenceTypeId, true, targetId, true), Is.SameAs(deleteReferenceResult)); Assert.That(adapter.GetNodeMetadata(context, handle, BrowseResultMask.All), Is.SameAs(metadata)); adapter.Browse(context, ref continuationPoint, referenceDescriptions); Assert.That(continuationPoint, Is.SameAs(returnedContinuationPoint)); adapter.TranslateBrowsePath(context, sourceHandle, relativePath, targetIds, unresolvedTargetIds); adapter.Read(context, 1.0, readValues, values, readErrors); adapter.HistoryRead( context, historyReadDetails, TimestampsToReturn.Both, true, historyReadValues, historyReadResults, historyReadErrors); adapter.Write(context, writeValues, writeErrors); adapter.HistoryUpdate( context, typeof(UpdateDataDetails), historyUpdates, historyUpdateResults, historyUpdateErrors); adapter.Call(context, methodsToCall, callResults, callErrors); Assert.That( adapter.SubscribeToEvents(context, sourceHandle, 1, monitoredItem, false), Is.SameAs(eventResult)); Assert.That(adapter.SubscribeToAllEvents(context, 2, monitoredItem, true), Is.SameAs(allEventsResult)); Assert.That(ServiceResult.IsGood(adapter.ConditionRefresh(context, eventItems)), Is.True); adapter.CreateMonitoredItems( context, 3, 1000.0, TimestampsToReturn.Server, itemsToCreate, createErrors, filterErrors, monitoredItems, true, idFactory); adapter.RestoreMonitoredItems(itemsToRestore, monitoredItems, ownerIdentity); adapter.ModifyMonitoredItems( context, TimestampsToReturn.Source, monitoredItems, itemsToModify, modifyErrors, filterErrors); adapter.DeleteMonitoredItems(context, monitoredItems, deleteProcessed, deleteErrors); adapter.TransferMonitoredItems( context, true, monitoredItems, transferProcessed, transferErrors, new MonitoredItemTransferOptions()); adapter.SetMonitoringMode( context, MonitoringMode.Reporting, monitoredItems, monitoringProcessed, monitoringErrors); adapter.SessionClosing(context, sessionId, true); adapter.SessionActivated(context, sessionId); Assert.That(adapter.IsNodeInView(context, nodeId, handle), Is.True); Assert.That( adapter.GetPermissionMetadata(context, handle, BrowseResultMask.All, permissionCache, true), Is.SameAs(metadata)); Assert.That(adapter.FindMethodState(context, methodToCall), Is.SameAs(methodState)); Assert.That(adapter.ValidateEventRolePermissions(monitoredItem, filterTarget), Is.SameAs(permissionResult)); Assert.That( adapter.ValidateRolePermissions(context, nodeId, PermissionType.Read), Is.SameAs(roleResult)); manager.VerifyAll(); } /// /// Composite interface for factory branch coverage. /// public interface IAsyncAndSyncNodeManager : IAsyncNodeManager, INodeManager; private static void SetupAsyncMethods( Mock manager, IEnumerable namespaces, IDictionary> externalReferences, IDictionary> references, NodeId nodeId, object handle, object sourceHandle, NodeId referenceTypeId, ExpandedNodeId targetId, ServiceResult deleteReferenceResult, OperationContext context, NodeMetadata metadata, ContinuationPoint continuationPoint, ContinuationPoint returnedContinuationPoint, IList referenceDescriptions, RelativePathElement relativePath, IList targetIds, IList unresolvedTargetIds, ArrayOf readValues, IList values, IList readErrors, HistoryReadDetails historyReadDetails, ArrayOf historyReadValues, IList historyReadResults, IList historyReadErrors, ArrayOf writeValues, IList writeErrors, ArrayOf historyUpdates, IList historyUpdateResults, IList historyUpdateErrors, ArrayOf methodsToCall, IList callResults, IList callErrors, IEventMonitoredItem monitoredItem, IList eventItems, ServiceResult eventResult, ServiceResult allEventsResult, ArrayOf itemsToCreate, IList createErrors, IList filterErrors, IList monitoredItems, MonitoredItemIdFactory idFactory, IList itemsToRestore, IUserIdentity ownerIdentity, ArrayOf itemsToModify, IList modifyErrors, IList deleteProcessed, IList deleteErrors, IList transferProcessed, IList transferErrors, IList monitoringProcessed, IList monitoringErrors, NodeId sessionId, Dictionary permissionCache, CallMethodRequest methodToCall, MethodState methodState, IFilterTarget filterTarget, ServiceResult permissionResult, ServiceResult roleResult) { manager.Setup(m => m.NamespaceUris).Returns(namespaces); manager.Setup(m => m.CreateAddressSpaceAsync(externalReferences, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.DeleteAddressSpaceAsync(It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.GetManagerHandleAsync(nodeId, It.IsAny())) .Returns(new ValueTask(handle)); manager.Setup(m => m.AddReferencesAsync(references, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.DeleteReferenceAsync( sourceHandle, referenceTypeId, true, targetId, true, It.IsAny())) .Returns(new ValueTask(deleteReferenceResult)); manager.Setup(m => m.GetNodeMetadataAsync( context, handle, BrowseResultMask.All, It.IsAny())) .Returns(new ValueTask(metadata)); manager.Setup(m => m.BrowseAsync( context, continuationPoint, referenceDescriptions, It.IsAny())) .Returns(new ValueTask(returnedContinuationPoint)); manager.Setup(m => m.TranslateBrowsePathAsync( context, sourceHandle, relativePath, targetIds, unresolvedTargetIds, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.ReadAsync(context, 1.0, readValues, values, readErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.HistoryReadAsync( context, historyReadDetails, TimestampsToReturn.Both, true, historyReadValues, historyReadResults, historyReadErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.WriteAsync(context, writeValues, writeErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.HistoryUpdateAsync( context, typeof(UpdateDataDetails), historyUpdates, historyUpdateResults, historyUpdateErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.CallAsync( context, methodsToCall, callResults, callErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.SubscribeToEventsAsync( context, sourceHandle, 1, monitoredItem, false, It.IsAny())) .Returns(new ValueTask(eventResult)); manager.Setup(m => m.SubscribeToAllEventsAsync( context, 2, monitoredItem, true, It.IsAny())) .Returns(new ValueTask(allEventsResult)); manager.Setup(m => m.ConditionRefreshAsync(context, eventItems, It.IsAny())) .Returns(new ValueTask(ServiceResult.Good)); manager.Setup(m => m.CreateMonitoredItemsAsync( context, 3, 1000.0, TimestampsToReturn.Server, itemsToCreate, createErrors, filterErrors, monitoredItems, true, idFactory, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.RestoreMonitoredItemsAsync( itemsToRestore, monitoredItems, ownerIdentity, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.ModifyMonitoredItemsAsync( context, TimestampsToReturn.Source, monitoredItems, itemsToModify, modifyErrors, filterErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.DeleteMonitoredItemsAsync( context, monitoredItems, deleteProcessed, deleteErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.TransferMonitoredItemsAsync( context, true, monitoredItems, transferProcessed, transferErrors, It.IsAny(), It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.SetMonitoringModeAsync( context, MonitoringMode.Reporting, monitoredItems, monitoringProcessed, monitoringErrors, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.SessionClosingAsync(context, sessionId, true, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.SessionActivatedAsync(context, sessionId, It.IsAny())) .Returns(default(ValueTask)); manager.Setup(m => m.IsNodeInViewAsync(context, nodeId, handle, It.IsAny())) .Returns(new ValueTask(true)); manager.Setup(m => m.GetPermissionMetadataAsync( context, handle, BrowseResultMask.All, permissionCache, true, It.IsAny())) .Returns(new ValueTask(metadata)); manager.Setup(m => m.FindMethodStateAsync(context, methodToCall, It.IsAny())) .Returns(new ValueTask(methodState)); manager.Setup(m => m.ValidateEventRolePermissionsAsync( monitoredItem, filterTarget, It.IsAny())) .Returns(new ValueTask(permissionResult)); manager.Setup(m => m.ValidateRolePermissionsAsync( context, nodeId, PermissionType.Read, It.IsAny())) .Returns(new ValueTask(roleResult)); } private static OperationContext NewOpContext(RequestType type) { var session = new Mock(); session.Setup(s => s.EffectiveIdentity).Returns(new Mock().Object); session.Setup(s => s.PreferredLocales).Returns([]); return new OperationContext( new RequestHeader(), null!, type, RequestLifetime.None, session.Object); } } }