/* ======================================================================== * 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.Threading; using System.Threading.Tasks; using NUnit.Framework; using Opc.Ua.Client.TestFramework; namespace Opc.Ua.InformationModel.Tests { /// /// compliance tests for Node Management Add Node. /// [TestFixture] [Category("Conformance")] [Category("NodeManagement")] public class NodeManagementAddNodeTests : TestFixture { [Description("add a node using typical parameters. */")] [Test] public async Task AddNodeWithTypicalParametersSucceedsAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceTypicalNode_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject( new VariableAttributes { DisplayName = (LocalizedText)"Typical Variable", DataType = DataTypeIds.Int32, ValueRank = ValueRanks.Scalar, AccessLevel = AccessLevels.CurrentReadOrWrite, UserAccessLevel = AccessLevels.CurrentReadOrWrite, Value = new Variant(0) }), TypeDefinition = new ExpandedNodeId(VariableTypeIds.BaseDataVariableType) }; try { AddNodesResponse response = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(response.Results[0].StatusCode), Is.True); Assert.That(response.Results[0].AddedNodeId.IsNull, Is.False); // Cleanup. try { await Session.DeleteNodesAsync( null, new DeleteNodesItem[] { new() { NodeId = response.Results[0].AddedNodeId, DeleteTargetReferences = true } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); } catch (ServiceResultException) { // Best-effort cleanup. } } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add a node varying the browseName and reference type. */")] [Test] public async Task AddNodeWithVariedBrowseNameAndReferenceTypeSucceedsAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.HasComponent, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceVariedNode_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject( new VariableAttributes { DisplayName = (LocalizedText)"Varied Variable", DataType = DataTypeIds.Double, ValueRank = ValueRanks.Scalar, AccessLevel = AccessLevels.CurrentReadOrWrite, UserAccessLevel = AccessLevels.CurrentReadOrWrite, Value = new Variant(0.0) }), TypeDefinition = new ExpandedNodeId(VariableTypeIds.BaseDataVariableType) }; try { AddNodesResponse response = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(response.Results[0].StatusCode), Is.True); Assert.That(response.Results[0].AddedNodeId.IsNull, Is.False); // Cleanup. try { await Session.DeleteNodesAsync( null, new DeleteNodesItem[] { new() { NodeId = response.Results[0].AddedNodeId, DeleteTargetReferences = true } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); } catch (ServiceResultException) { // Best-effort cleanup. } } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add a node using typical parameters. */")] [Test] public async Task AddNodeWithTypicalParametersAlternateSucceedsAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceObject_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Object, NodeAttributes = new ExtensionObject( new ObjectAttributes { DisplayName = (LocalizedText)"Typical Object", EventNotifier = EventNotifiers.None }), TypeDefinition = new ExpandedNodeId(ObjectTypeIds.BaseObjectType) }; try { AddNodesResponse response = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(response.Results[0].StatusCode), Is.True); Assert.That(response.Results[0].AddedNodeId.IsNull, Is.False); // Cleanup. try { await Session.DeleteNodesAsync( null, new DeleteNodesItem[] { new() { NodeId = response.Results[0].AddedNodeId, DeleteTargetReferences = true } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); } catch (ServiceResultException) { // Best-effort cleanup. } } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add an Object of a type with Mandatory InstanceDeclarations; they are created (Part 4 5.8.2.1).")] [Test] public async Task AddNodeCreatesMandatoryMembersOfTypeDefinitionAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceFile_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Object, TypeDefinition = new ExpandedNodeId(ObjectTypeIds.FileType) }; try { AddNodesResponse response = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(response.Results[0].StatusCode), Is.True, response.Results[0].StatusCode.ToString()); NodeId added = response.Results[0].AddedNodeId; BrowseResponse browse = await Session.BrowseAsync( null, null, 0, new BrowseDescription[] { new() { NodeId = added, BrowseDirection = BrowseDirection.Forward, ReferenceTypeId = ReferenceTypeIds.HierarchicalReferences, IncludeSubtypes = true, NodeClassMask = 0, ResultMask = (uint)BrowseResultMask.All } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); var names = new System.Collections.Generic.List(); ArrayOf references = browse.Results[0].References; for (int ii = 0; ii < references.Count; ii++) { names.Add(references[ii].BrowseName.Name!); } Assert.That(names, Is.SupersetOf(new[] { BrowseNames.Size, BrowseNames.Writable, BrowseNames.UserWritable, BrowseNames.OpenCount, BrowseNames.Open, BrowseNames.Close, BrowseNames.Read, BrowseNames.Write, BrowseNames.GetPosition, BrowseNames.SetPosition })); Assert.That(names, Does.Not.Contain(BrowseNames.MimeType)); // Cleanup. try { await Session.DeleteNodesAsync( null, new DeleteNodesItem[] { new() { NodeId = added, DeleteTargetReferences = true } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); } catch (ServiceResultException) { // Best-effort cleanup. } } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add an Object whose TypeDefinition is abstract; rejected (Part 3 5.5.2).")] [Test] public async Task AddNodeWithAbstractTypeDefinitionReturnsBadTypeDefinitionInvalidAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceAbstract_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Object, TypeDefinition = new ExpandedNodeId(ObjectTypeIds.BaseEventType) }; try { AddNodesResponse response = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That( response.Results[0].StatusCode, Is.EqualTo((StatusCode)StatusCodes.BadTypeDefinitionInvalid)); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add a node but do not specify any properties. */")] [Test] public async Task AddNodeWithoutPropertiesReturnsBadStatusAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add a node but do not specify any properties. */")] [Test] public async Task AddNodeWithoutPropertiesAlternateReturnsBadStatusAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("parentNodeId is inknown. Expect BadParentIdInvalid. */")] [Test] public async Task AddNodeWithUnknownParentReturnsBadParentIdInvalidAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("parentNodeId is inknown. Expect BadReferenceTypeIdInvalid. */")] [Test] public async Task AddNodeWithInvalidReferenceTypeReturnsBadReferenceTypeIdInvalidAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("Use incorrect reference type. Expects BadReferenceNotAllowed. */")] [Test] public async Task AddNodeWithIncorrectReferenceTypeReturnsBadReferenceNotAllowedAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("specify a nodeid even if not supported. */")] [Test] public async Task AddNodeWithSpecifiedNodeIdReturnsExpectedStatusAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("specify a nodeid even if not supported, namespaceIndex is 0 (OPC). May be accepted, or return BadNodeIdRejected */")] [Test] public async Task AddNodeWithSpecifiedNodeIdInNamespaceZeroReturnsExpectedStatusAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("add a node using typical parameters. Then add it again: BadNodeIdExists */")] [Test] public async Task AddDuplicateNodeReturnsBadNodeIdExistsAsync() { try { ArrayOf req = new AddNodesItem[] { new() { ParentNodeId = new ExpandedNodeId(Constants.InvalidNodeId), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName("InvalidTestNode"), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject(new VariableAttributes { Value = new Variant(0) }) } }.ToArrayOf(); AddNodesResponse response = await Session.AddNodesAsync(null, req, CancellationToken.None).ConfigureAwait(false); Assert.That(response.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsBad(response.Results[0].StatusCode), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } [Description("Round-trip test: add a Variable node and verify it can be deleted.")] [Test] public async Task AddNodesWriteTestRoundTripSucceedsAsync() { var addRequest = new AddNodesItem { ParentNodeId = new ExpandedNodeId(ObjectIds.ObjectsFolder), ReferenceTypeId = ReferenceTypeIds.Organizes, RequestedNewNodeId = ExpandedNodeId.Null, BrowseName = new QualifiedName( "ConformanceWriteTest_" + System.Guid.NewGuid().ToString("N"), 2), NodeClass = NodeClass.Variable, NodeAttributes = new ExtensionObject( new VariableAttributes { DisplayName = (LocalizedText)"Round Trip", DataType = DataTypeIds.Int32, ValueRank = ValueRanks.Scalar, AccessLevel = AccessLevels.CurrentReadOrWrite, UserAccessLevel = AccessLevels.CurrentReadOrWrite, Value = new Variant(0) }), TypeDefinition = new ExpandedNodeId(VariableTypeIds.BaseDataVariableType) }; try { AddNodesResponse addResponse = await Session.AddNodesAsync( null, new AddNodesItem[] { addRequest }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(addResponse.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(addResponse.Results[0].StatusCode), Is.True); NodeId addedNodeId = addResponse.Results[0].AddedNodeId; DeleteNodesResponse deleteResponse = await Session.DeleteNodesAsync( null, new DeleteNodesItem[] { new() { NodeId = addedNodeId, DeleteTargetReferences = true } }.ToArrayOf(), CancellationToken.None).ConfigureAwait(false); Assert.That(deleteResponse.Results.Count, Is.EqualTo(1)); Assert.That(StatusCode.IsGood(deleteResponse.Results[0]), Is.True); } catch (ServiceResultException ex) when (ex.StatusCode == StatusCodes.BadServiceUnsupported) { Assert.Ignore("AddNodes service not supported by ReferenceServer."); } } } }