/* ========================================================================
* 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 Moq;
using NUnit.Framework;
using Opc.Ua.Schema.Model;
namespace Opc.Ua.SourceGeneration.Generator.Tests
{
///
/// Tests for — the
/// cross-namespace prefix override step used by the source generator
/// to align dependency type references with the C# prefix published
/// by referenced assemblies' [ModelDependencyAttribute] entries.
///
[TestFixture]
[Category("Api")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
[Parallelizable]
public class CrossNamespacePrefixTests
{
private const string TargetUri = "http://example.org/UA/Target/";
private const string DependencyUri = "http://opcfoundation.org/UA/DI/";
private const string MachineryUri = "http://opcfoundation.org/UA/Machinery/";
///
/// When the loaded ModelDesign declares a dependency namespace with
/// the auto-generated prefix (e.g. Opc.Ua.DI) but a
/// referenced assembly publishes that model under a different C#
/// prefix (e.g. Opc.Ua.Di), the override rewrites the
/// dependency namespace prefix to match.
///
[Test]
public void ModelWithDifferentPrefixAndXmlPrefix_EmitsCSharpPrefix()
{
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
var dep = new Namespace
{
Value = DependencyUri,
Prefix = "Opc.Ua.DI",
XmlPrefix = "DI"
};
IModelDesign md = BuildDesign(target, [target, dep]);
var referenced = new Dictionary
{
[DependencyUri] = new ModelDependencyReference(
"Opc.Ua.Di", DependencyUri, "Opc.Ua.Di", null!, null!)
};
Generators.OverrideDependencyPrefixes(md, referenced);
Assert.That(dep.Prefix, Is.EqualTo("Opc.Ua.Di"));
// XmlPrefix is untouched — only the C# Prefix is rewritten.
Assert.That(dep.XmlPrefix, Is.EqualTo("DI"));
}
///
/// Looking up by URI (not by XmlPrefix or auto-generated name)
/// matches the entry in .
///
[Test]
public void CrossModelReference_ResolvesViaUriLookup()
{
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
var dep = new Namespace { Value = DependencyUri, Prefix = "wrong" };
IModelDesign md = BuildDesign(target, [target, dep]);
var referenced = new Dictionary
{
[DependencyUri] = new ModelDependencyReference(
"Opc.Ua.Di", DependencyUri, "Opc.Ua.Di", null!, null!)
};
Generators.OverrideDependencyPrefixes(md, referenced);
Assert.That(dep.Prefix, Is.EqualTo("Opc.Ua.Di"));
}
///
/// A namespace URI that is not in the referenced-models map is
/// left untouched.
///
[Test]
public void UnknownNamespaceUri_NotRewritten()
{
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
var dep = new Namespace
{
Value = "http://unknown.example.org/X/",
Prefix = "Original"
};
IModelDesign md = BuildDesign(target, [target, dep]);
var referenced = new Dictionary
{
[DependencyUri] = new ModelDependencyReference(
"Opc.Ua.Di", DependencyUri, "Opc.Ua.Di", null!, null!)
};
Generators.OverrideDependencyPrefixes(md, referenced);
Assert.That(dep.Prefix, Is.EqualTo("Original"));
}
///
/// When multiple namespaces match referenced-models entries, all
/// of them are rewritten.
///
[Test]
public void MultipleNamespaceImports_AllMapCorrectly()
{
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
var di = new Namespace { Value = DependencyUri, Prefix = "Opc.Ua.DI" };
var machinery = new Namespace { Value = MachineryUri, Prefix = "Opc.Ua.Machinery" };
IModelDesign md = BuildDesign(target, [target, di, machinery]);
var referenced = new Dictionary
{
[DependencyUri] = new ModelDependencyReference(
"Opc.Ua.Di", DependencyUri, "Opc.Ua.Di", null!, null!),
[MachineryUri] = new ModelDependencyReference(
"Acme.Machinery", MachineryUri, "Acme.Machinery", null!, null!)
};
Generators.OverrideDependencyPrefixes(md, referenced);
Assert.That(di.Prefix, Is.EqualTo("Opc.Ua.Di"));
Assert.That(machinery.Prefix, Is.EqualTo("Acme.Machinery"));
}
///
/// The target namespace itself is never rewritten, even if a
/// referenced-models entry happens to claim the same URI.
/// Otherwise the generator would emit references into someone
/// else's assembly.
///
[Test]
public void TargetNamespace_NeverRewritten()
{
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
IModelDesign md = BuildDesign(target, [target]);
var referenced = new Dictionary
{
[TargetUri] = new ModelDependencyReference(
"Foreign.Asm", TargetUri, "Foreign.Target", null!, null!)
};
Generators.OverrideDependencyPrefixes(md, referenced);
Assert.That(target.Prefix, Is.EqualTo("Opc.Ua.Target"));
}
///
/// Null inputs do not throw.
///
[Test]
public void NullInputs_NoThrow()
{
// Null modelDesign
Assert.DoesNotThrow(() =>
Generators.OverrideDependencyPrefixes(
null!, new Dictionary()));
// Null referenced map
var target = new Namespace { Value = TargetUri, Prefix = "Opc.Ua.Target" };
IModelDesign md = BuildDesign(target, [target]);
Assert.DoesNotThrow(() =>
Generators.OverrideDependencyPrefixes(md, null!));
}
private static IModelDesign BuildDesign(Namespace target, Namespace[] all)
{
var mock = new Mock();
mock.Setup(m => m.TargetNamespace).Returns(target);
mock.Setup(m => m.Namespaces).Returns(all);
return mock.Object;
}
}
}