/* ========================================================================
* Copyright (c) 2005-2026 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.Linq;
using NUnit.Framework;
using Opc.Ua.Tests;
namespace Opc.Ua.GMS.Tests
{
///
/// Creates isolated contexts with shifted or reversed namespaces for model seam tests.
///
internal static class ModelTestContext
{
///
/// The independently specified GMS closure, including the selected MachineTool 1.02 job dependencies.
///
public static ArrayOf ExpectedNamespaceUris =>
[
"http://opcfoundation.org/UA/DI/",
"http://opcfoundation.org/UA/IA/",
"http://opcfoundation.org/UA/Machinery/",
"http://opcfoundation.org/UA/ISA95-JOBCONTROL_V2/",
"http://opcfoundation.org/UA/Machinery/Jobs/",
"http://opcfoundation.org/UA/MachineTool/",
"http://opcfoundation.org/UA/Machinery/Result/",
"http://opcfoundation.org/UA/GMS/"
];
///
/// Creates a core message context with optional GMS encodeable registration.
///
public static ServiceMessageContext CreateMessageContext(
bool registerModel = true,
bool reverseNamespaces = false)
{
var context = ServiceMessageContext.Create(NUnitTelemetryContext.Create());
context.NamespaceUris.GetIndexOrAppend("urn:gms-tests:application");
context.NamespaceUris.GetIndexOrAppend("urn:gms-tests:unrelated");
if (registerModel)
{
IEnumerable namespaces = ExpectedNamespaceUris.ToArray()!;
foreach (string uri in reverseNamespaces ? namespaces.Reverse() : namespaces)
{
context.NamespaceUris.GetIndexOrAppend(uri);
}
context.Factory.Builder.AddGmsTypeSystem().Commit();
}
return context;
}
///
/// Creates a node-state context sharing the message namespace table and encodeable factory.
///
public static SystemContext CreateSystemContext(
bool registerModel = true,
bool reverseNamespaces = false)
{
ServiceMessageContext message = CreateMessageContext(registerModel, reverseNamespaces);
return new SystemContext(NUnitTelemetryContext.Create())
{
NamespaceUris = message.NamespaceUris,
EncodeableFactory = message.Factory
};
}
///
/// Indexes all roots and nested declarations through the public node-state traversal API.
///
public static Dictionary IndexNodes(ISystemContext context, NodeStateCollection roots)
{
var nodes = new Dictionary();
foreach (NodeState root in roots)
{
AddNode(context, root, nodes);
}
return nodes;
}
///
/// Requires a child with both the expected CLR type and exact namespace-qualified browse name.
///
public static T RequireChild(
SystemContext context,
NodeState parent,
string browseName,
string namespaceUri)
where T : BaseInstanceState
{
var name = new QualifiedName(browseName, context.NamespaceUris.GetIndexOrAppend(namespaceUri));
BaseInstanceState? child = parent.FindChild(context, name);
Assert.That(child, Is.InstanceOf(), $"{parent.BrowseName}/{name}");
Assert.That(child!.BrowseName, Is.EqualTo(name));
return (T)child;
}
private static void AddNode(
ISystemContext context,
NodeState node,
Dictionary nodes)
{
if (!nodes.TryAdd(node.NodeId, node))
{
return;
}
var children = new List();
node.GetChildren(context, children);
foreach (BaseInstanceState child in children)
{
AddNode(context, child, nodes);
}
}
}
}