mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-22 01:26:20 +08:00
romanett
cc4791e2fd
## Problem The NodeState source generator mishandled `UAView` nodes imported from a NodeSet2 model. When an exporter set a View's `ParentNodeId` to an organizing folder, the importer/generator absorbed the View into that folder's `Children` and tried to emit an invalid `AddChild(...)` call. Because `ViewState` derives from `NodeState` (not `BaseInstanceState`), a View can never be an `AddChild` component, so the generated code was invalid. ## Fix Make Views standalone top-level predefined nodes linked purely via `Organizes` references — mirroring how `DataType`/`ReferenceType` type nodes and `DataTypeEncoding` are handled: - **`tools/Opc.Ua.SourceGeneration.Core/Schema/NodeSetToModelDesign.cs`** — clear the `UAView` `ParentNodeId` so the View stays a standalone top-level node, keep the organizing folder's forward `Organizes` references to those Views, and carry the View's `ContainsNoLoops` attribute through to the `ViewDesign`. - **`tools/Opc.Ua.SourceGeneration.Core/Generators/NodeStateGenerator.cs`** — return `null` for `ViewDesign` in the `AddChild` and `ReplaceChild` template paths so Views are never emitted as components. - **`tests/Opc.Ua.SourceGeneration.Core.Tests/Schema/NodeSetToModelDesignTests.cs`** — new `ViewImport` NodeSet constant and `ImportPreservesFolderOrganizesReferencesToViews` test verifying Views are imported as top-level nodes while the organizing folder retains its forward `Organizes` references to them. ## Validation - `dotnet build tools\Opc.Ua.SourceGeneration.Core` (Release): 0 warnings / 0 errors. - `dotnet test tests\Opc.Ua.SourceGeneration.Core.Tests` (net8.0, filtered to `NodeSetToModelDesign`): all 17 tests pass, including the new `ImportPreservesFolderOrganizesReferencesToViews`. Extracted from the larger PR #4220 work — this PR contains only the source-generator View fix (no WriteMask, UserAccessLevel, NodeSet2.xml, or ReferenceNodeManager changes). Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
441 lines
18 KiB
C#
441 lines
18 KiB
C#
/* ========================================================================
|
|
* 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;
|
|
using System.Collections.Generic;
|
|
using System.IO;
|
|
using System.Linq;
|
|
using System.Text;
|
|
using System.Xml;
|
|
using Microsoft.Extensions.Logging;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Export;
|
|
using Opc.Ua.SourceGeneration;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Schema.Model.Tests
|
|
{
|
|
/// <summary>
|
|
/// Unit tests for the <see cref="NodeSetToModelDesign"/> importer. The tests
|
|
/// use the small, self-contained <c>CrossModelTypes.NodeSet2.xml</c> resource
|
|
/// so that the deterministic surface (node set detection, namespace loading and
|
|
/// the constructor side effects) can be verified without pulling in the full UA
|
|
/// base model.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("ModelDesign")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
public class NodeSetToModelDesignTests
|
|
{
|
|
private const string OpcUaNamespaceUri = "http://opcfoundation.org/UA/";
|
|
private const string CrossModelNamespaceUri = "http://test.org/UA/CrossModel/Types";
|
|
private const string SameNamedArgumentsNamespaceUri =
|
|
"http://test.org/UA/SameNamedMethodArguments/";
|
|
private const string NodeSetResource = "CrossModelTypes.NodeSet2.xml";
|
|
private const string SameNamedArgumentsResource =
|
|
"SameNamedMethodArguments.NodeSet2.xml";
|
|
private const string DesignResource = "TestDataDesign.xml";
|
|
private const string ViewImportNodeSet = """
|
|
<?xml version="1.0" encoding="utf-8"?>
|
|
<UANodeSet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
|
|
xmlns="http://opcfoundation.org/UA/2011/03/UANodeSet.xsd">
|
|
<NamespaceUris>
|
|
<Uri>http://test.org/UA/ViewImport/</Uri>
|
|
</NamespaceUris>
|
|
<Models>
|
|
<Model ModelUri="http://test.org/UA/ViewImport/"
|
|
PublicationDate="2026-08-12T00:00:00Z"
|
|
Version="1.0.0" />
|
|
</Models>
|
|
<Aliases>
|
|
<Alias Alias="HasSubtype">i=45</Alias>
|
|
<Alias Alias="HasTypeDefinition">i=40</Alias>
|
|
<Alias Alias="Organizes">i=35</Alias>
|
|
</Aliases>
|
|
<UAReferenceType NodeId="i=33" BrowseName="HierarchicalReferences" IsAbstract="true">
|
|
<DisplayName>HierarchicalReferences</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="HasSubtype" IsForward="false">i=33</Reference>
|
|
</References>
|
|
</UAReferenceType>
|
|
<UAReferenceType NodeId="i=35" BrowseName="Organizes">
|
|
<DisplayName>Organizes</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="HasSubtype" IsForward="false">i=33</Reference>
|
|
</References>
|
|
</UAReferenceType>
|
|
<UAObjectType NodeId="i=58" BrowseName="BaseObjectType">
|
|
<DisplayName>BaseObjectType</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="HasSubtype" IsForward="false">i=58</Reference>
|
|
</References>
|
|
</UAObjectType>
|
|
<UAObject NodeId="ns=1;s=Views" BrowseName="1:Views">
|
|
<DisplayName>Views</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="Organizes">ns=1;s=Views_Operations</Reference>
|
|
<Reference ReferenceType="Organizes">ns=1;s=Views_Engineering</Reference>
|
|
<Reference ReferenceType="HasTypeDefinition">i=58</Reference>
|
|
</References>
|
|
</UAObject>
|
|
<UAView NodeId="ns=1;s=Views_Operations"
|
|
BrowseName="1:Operations"
|
|
ParentNodeId="ns=1;s=Views"
|
|
ContainsNoLoops="true">
|
|
<DisplayName>Operations</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="Organizes" IsForward="false">i=87</Reference>
|
|
</References>
|
|
</UAView>
|
|
<UAView NodeId="ns=1;s=Views_Engineering"
|
|
BrowseName="1:Engineering"
|
|
ParentNodeId="ns=1;s=Views"
|
|
ContainsNoLoops="true">
|
|
<DisplayName>Engineering</DisplayName>
|
|
<References>
|
|
<Reference ReferenceType="Organizes" IsForward="false">i=87</Reference>
|
|
</References>
|
|
</UAView>
|
|
</UANodeSet>
|
|
""";
|
|
|
|
private VirtualFileSystem m_fileSystem;
|
|
|
|
[SetUp]
|
|
public void SetUp()
|
|
{
|
|
m_fileSystem = new VirtualFileSystem();
|
|
}
|
|
|
|
[TearDown]
|
|
public void TearDown()
|
|
{
|
|
m_fileSystem?.Dispose();
|
|
m_fileSystem = null;
|
|
}
|
|
|
|
[Test]
|
|
public void IsNodeSetReturnsTrueForNodeSet()
|
|
{
|
|
bool result = NodeSetToModelDesign.IsNodeSet(m_fileSystem, ResourcePath(NodeSetResource));
|
|
|
|
Assert.That(result, Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public void IsNodeSetReturnsFalseForDesignFile()
|
|
{
|
|
bool result = NodeSetToModelDesign.IsNodeSet(m_fileSystem, ResourcePath(DesignResource));
|
|
|
|
Assert.That(result, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void IsNodeSetReturnsFalseForNonXmlContent()
|
|
{
|
|
const string path = "memory://garbage.txt";
|
|
m_fileSystem.Add(path, Encoding.UTF8.GetBytes("just some text without any markup"));
|
|
|
|
bool result = NodeSetToModelDesign.IsNodeSet(m_fileSystem, path);
|
|
|
|
Assert.That(result, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public void IsNodeSetNullFileSystemThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => NodeSetToModelDesign.IsNodeSet(null, ResourcePath(NodeSetResource)));
|
|
Assert.That(ex.ParamName, Is.EqualTo("fileSystem"));
|
|
}
|
|
|
|
[Test]
|
|
public void IsNodeSetNullFilePathThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => NodeSetToModelDesign.IsNodeSet(m_fileSystem, null));
|
|
Assert.That(ex.ParamName, Is.EqualTo("filePath"));
|
|
}
|
|
|
|
[Test]
|
|
public void LoadNamespacesReturnsModelAndDependencyNamespaces()
|
|
{
|
|
List<Namespace> namespaces = NodeSetToModelDesign.LoadNamespaces(
|
|
m_fileSystem, ResourcePath(NodeSetResource));
|
|
|
|
Assert.That(namespaces, Has.Count.EqualTo(2));
|
|
|
|
Namespace opcUa = namespaces.Single(x => x.Value == OpcUaNamespaceUri);
|
|
Namespace crossModel = namespaces.Single(x => x.Value == CrossModelNamespaceUri);
|
|
|
|
Assert.That(opcUa.Name, Is.EqualTo("OpcUa"));
|
|
Assert.That(opcUa.Prefix, Is.EqualTo("Opc.Ua"));
|
|
Assert.That(crossModel.Name, Is.EqualTo("testorgUACrossModelTypes"));
|
|
Assert.That(crossModel.Prefix, Is.EqualTo("test.org.UA.CrossModel.Types"));
|
|
}
|
|
|
|
[Test]
|
|
public void LoadNamespacesNullFileSystemThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => NodeSetToModelDesign.LoadNamespaces(null, ResourcePath(NodeSetResource)));
|
|
Assert.That(ex.ParamName, Is.EqualTo("fileSystem"));
|
|
}
|
|
|
|
[Test]
|
|
public void LoadNamespacesNullFilePathThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => NodeSetToModelDesign.LoadNamespaces(m_fileSystem, null));
|
|
Assert.That(ex.ParamName, Is.EqualTo("filePath"));
|
|
}
|
|
|
|
[Test]
|
|
public void ConstructorRegistersNamespacesInSettings()
|
|
{
|
|
var settings = new NodeSetReaderSettings();
|
|
|
|
NodeSetToModelDesign importer = new(
|
|
m_fileSystem, ResourcePath(NodeSetResource), settings, CreateTelemetry());
|
|
|
|
Assert.That(importer, Is.Not.Null);
|
|
Assert.That(settings.NamespaceUris.Count, Is.EqualTo(2));
|
|
Assert.That(settings.NamespaceUris.GetString(0), Is.EqualTo(OpcUaNamespaceUri));
|
|
Assert.That(settings.NamespaceUris.GetString(1), Is.EqualTo(CrossModelNamespaceUri));
|
|
Assert.That(settings.NamespaceTables, Has.Count.EqualTo(1));
|
|
Assert.That(settings.NamespaceTables.ContainsKey(CrossModelNamespaceUri), Is.True);
|
|
Assert.That(settings.NamespaceTables[CrossModelNamespaceUri], Is.EqualTo([CrossModelNamespaceUri]));
|
|
}
|
|
|
|
[Test]
|
|
public void ConstructorNullFilePathThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => new NodeSetToModelDesign(
|
|
m_fileSystem, null, new NodeSetReaderSettings(), CreateTelemetry()));
|
|
Assert.That(ex.ParamName, Is.EqualTo("filePath"));
|
|
}
|
|
|
|
[Test]
|
|
public void ConstructorNullSettingsThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => new NodeSetToModelDesign(
|
|
m_fileSystem, ResourcePath(NodeSetResource), null, CreateTelemetry()));
|
|
Assert.That(ex.ParamName, Is.EqualTo("settings"));
|
|
}
|
|
|
|
[Test]
|
|
public void ConstructorNullFileSystemThrowsArgumentNullException()
|
|
{
|
|
ArgumentNullException ex = Assert.Throws<ArgumentNullException>(
|
|
() => new NodeSetToModelDesign(
|
|
null, ResourcePath(NodeSetResource), new NodeSetReaderSettings(), CreateTelemetry()));
|
|
Assert.That(ex.ParamName, Is.EqualTo("fileSystem"));
|
|
}
|
|
|
|
[Test]
|
|
public void ImportWithoutBaseModelThrowsInvalidDataException()
|
|
{
|
|
var settings = new NodeSetReaderSettings();
|
|
NodeSetToModelDesign importer = new(
|
|
m_fileSystem, ResourcePath(NodeSetResource), settings, CreateTelemetry());
|
|
|
|
InvalidDataException ex = Assert.Throws<InvalidDataException>(
|
|
() => importer.Import("Test", "CrossModel"));
|
|
Assert.That(ex.Message, Does.Contain("WidgetType"));
|
|
}
|
|
|
|
[Test]
|
|
public void ImportPreservesSameNamedInputAndOutputArgumentNames()
|
|
{
|
|
ITelemetryContext telemetry = CreateTelemetry();
|
|
string path = ResourcePath(SameNamedArgumentsResource);
|
|
var nodesets = new NodesetFileCollection(
|
|
[(path, new NodesetFileOptions())],
|
|
[],
|
|
m_fileSystem,
|
|
telemetry);
|
|
List<string> designFiles = nodesets.GetDesignFileListForModel(
|
|
SameNamedArgumentsNamespaceUri,
|
|
out _);
|
|
Assert.That(designFiles, Is.Not.Null);
|
|
|
|
IFileSystem fileSystem = typeof(Generators).Assembly
|
|
.AsFileSystem("Opc.Ua.SourceGeneration.Design")
|
|
.WithFallback(m_fileSystem);
|
|
IModelDesign model = fileSystem.OpenModelDesign(
|
|
new DesignFileCollection { Targets = designFiles },
|
|
[],
|
|
telemetry,
|
|
useAllowSubtypes: false);
|
|
MethodDesign method = model.GetNodeDesigns()
|
|
.OfType<MethodDesign>()
|
|
.Single(x => x.SymbolicName?.Name == "RoundTripMethodType");
|
|
string[] expectedInputNames =
|
|
[
|
|
"Foo",
|
|
"foo",
|
|
"Class",
|
|
"VersionId",
|
|
"Await",
|
|
"Ct",
|
|
"cT",
|
|
"CancellationToken",
|
|
"Context",
|
|
"ObjectId",
|
|
"Method",
|
|
"InputArguments",
|
|
"Results",
|
|
"_result",
|
|
"_foo",
|
|
"_",
|
|
"Nameof",
|
|
"__arglist",
|
|
"__makeref",
|
|
"__reftype",
|
|
"__refvalue"
|
|
];
|
|
string[] expectedOutputNames =
|
|
[
|
|
"VersionId",
|
|
"class",
|
|
"Changed",
|
|
"OutputArguments",
|
|
"ServiceResult",
|
|
"Quote\"Name",
|
|
"Back\\Slash",
|
|
"Line\nBreak",
|
|
"Δelta雪",
|
|
"Foo",
|
|
"RoundTripMethodStateResult",
|
|
"Next\u0085Line",
|
|
"Line\u2028Separator",
|
|
"Paragraph\u2029Separator"
|
|
];
|
|
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(method.InputArguments, Has.Length.EqualTo(expectedInputNames.Length));
|
|
Assert.That(
|
|
method.InputArguments.Select(argument => argument.Name),
|
|
Is.EqualTo(expectedInputNames));
|
|
Assert.That(method.OutputArguments, Has.Length.EqualTo(expectedOutputNames.Length));
|
|
Assert.That(
|
|
method.OutputArguments.Select(argument => argument.Name),
|
|
Is.EqualTo(expectedOutputNames));
|
|
});
|
|
}
|
|
|
|
/// <summary>
|
|
/// Verifies importing views as top-level nodes keeps their organizing folder references.
|
|
/// </summary>
|
|
[Test]
|
|
public void ImportPreservesFolderOrganizesReferencesToViews()
|
|
{
|
|
const string path = "memory://ViewImport.NodeSet2.xml";
|
|
m_fileSystem.Add(path, Encoding.UTF8.GetBytes(ViewImportNodeSet));
|
|
|
|
var settings = new NodeSetReaderSettings();
|
|
NodeSetToModelDesign importer = new(
|
|
m_fileSystem,
|
|
path,
|
|
settings,
|
|
CreateTelemetry());
|
|
|
|
ModelDesign model = importer.Import("ViewImport", "ViewImport");
|
|
ObjectDesign viewsFolder = model.Items
|
|
.OfType<ObjectDesign>()
|
|
.Single(x => x.SymbolicName?.Name == "Views");
|
|
string[] expectedViews = ["Operations", "Engineering"];
|
|
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(model.Items.OfType<ViewDesign>().Select(x => x.SymbolicName?.Name), Is.EquivalentTo(
|
|
expectedViews));
|
|
Assert.That(viewsFolder.Children?.Items, Is.Null.Or.Empty);
|
|
Assert.That(viewsFolder.References, Has.Length.EqualTo(2));
|
|
Assert.That(viewsFolder.References.Select(x => x.ReferenceType.Name), Is.All.EqualTo("Organizes"));
|
|
Assert.That(viewsFolder.References.Select(x => x.IsInverse), Is.All.False);
|
|
Assert.That(viewsFolder.References.Select(x => x.TargetId.Name), Is.EquivalentTo(
|
|
expectedViews));
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public void TypeSymbolicNameUsesNodeIdNamespace()
|
|
{
|
|
var symbolicId = new XmlQualifiedName(
|
|
"GroundControlPointDataType",
|
|
"http://opcfoundation.org/UA/GPOS/");
|
|
var symbolicName = new XmlQualifiedName(
|
|
"GroundControlPointDataType",
|
|
"http://opcfoundation.org/UA/RSL/");
|
|
|
|
XmlQualifiedName normalized = NodeSetToModelDesign.NormalizeSymbolicNameNamespace(
|
|
new UADataType(),
|
|
symbolicId,
|
|
symbolicName);
|
|
|
|
Assert.That(normalized.Name, Is.EqualTo(symbolicName.Name));
|
|
Assert.That(normalized.Namespace, Is.EqualTo(symbolicId.Namespace));
|
|
}
|
|
|
|
[Test]
|
|
public void InstanceSymbolicNameKeepsBrowseNameNamespace()
|
|
{
|
|
var symbolicId = new XmlQualifiedName(
|
|
"Position",
|
|
"http://opcfoundation.org/UA/GPOS/");
|
|
var symbolicName = new XmlQualifiedName(
|
|
"Position",
|
|
"http://opcfoundation.org/UA/RSL/");
|
|
|
|
XmlQualifiedName normalized = NodeSetToModelDesign.NormalizeSymbolicNameNamespace(
|
|
new UAVariable(),
|
|
symbolicId,
|
|
symbolicName);
|
|
Assert.That(normalized, Is.SameAs(symbolicName));
|
|
Assert.That(normalized, Is.SameAs(symbolicName));
|
|
}
|
|
|
|
private static ITelemetryContext CreateTelemetry()
|
|
{
|
|
return NUnitTelemetryContext.Create(logLevel: LogLevel.Error);
|
|
}
|
|
|
|
private static string ResourcePath(string fileName)
|
|
{
|
|
return Path.Combine(TestContext.CurrentContext.TestDirectory, "Resources", fileName);
|
|
}
|
|
}
|
|
}
|