/* ======================================================================== * 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.IO; using System.Linq; using System.Text; using Microsoft.CodeAnalysis; using Microsoft.CodeAnalysis.CSharp; using Microsoft.Extensions.Logging; using Moq; using NUnit.Framework; using Opc.Ua.Schema.Model; using Opc.Ua.Tests; namespace Opc.Ua.SourceGeneration.Generator.Tests { /// /// Unit tests for the NodeStateGenerator class. /// [TestFixture] [Category("Generator")] [SetCulture("en-us")] [SetUICulture("en-us")] [Parallelizable] public class NodeStateGeneratorTests { [SetUp] public void SetUp() { m_mockFileSystem = new Mock(); m_mockModelDesign = new Mock(); m_mockTelemetry = new Mock(); // Setup default namespace var targetNamespace = new Namespace { Value = "http://test.org/UA/", Prefix = "Test", Name = "TestNamespace" }; m_mockModelDesign.Setup(m => m.TargetNamespace).Returns(targetNamespace); m_mockModelDesign.Setup(m => m.Namespaces).Returns([targetNamespace]); } /// /// Tests that the constructor throws ArgumentNullException when context is null. /// [Test] public void Constructor_NullContext_ThrowsArgumentNullException() { // Arrange GeneratorContext context = null; // Act & Assert Assert.Throws(() => new NodeStateGenerator(context)); } /// /// Tests that constructor creates instance with valid context. /// [Test] public void Constructor_ValidContext_CreatesInstance() { // Arrange m_context = new GeneratorContext { FileSystem = m_mockFileSystem.Object, OutputFolder = "TestOutput", ModelDesign = m_mockModelDesign.Object, Telemetry = m_mockTelemetry.Object, Options = new GeneratorOptions() }; // Act var generator = new NodeStateGenerator(m_context); // Assert Assert.That(generator, Is.Not.Null); } /// /// Tests that Emit returns early without creating files when no node state classes exist. /// [Test] public void Emit_NoNodeStateClasses_ReturnsEarlyWithoutCreatingFiles() { // Arrange m_mockModelDesign.Setup(m => m.GetNodeDesigns()).Returns([]); m_context = new GeneratorContext { FileSystem = m_mockFileSystem.Object, OutputFolder = "TestOutput", ModelDesign = m_mockModelDesign.Object, Telemetry = m_mockTelemetry.Object, Options = new GeneratorOptions() }; var generator = new NodeStateGenerator(m_context); // Act generator.Emit(); // Assert - OpenWrite should not be called when there are no node state classes m_mockFileSystem.Verify( fs => fs.OpenWrite(It.IsAny()), Times.Never, "OpenWrite should not be called when there are no node state classes"); } [Test] public void GenerateNodeStateGeneratorCodeTest() { // Arrange ITelemetryContext telemetry = NUnitTelemetryContext.Create(logLevel: LogLevel.Error); using var fileSystem = new VirtualFileSystem(); // Act - Generate full stack Generators.GenerateStack(StackGenerationType.All, fileSystem, string.Empty, telemetry); // Assert - NodeState file should be created var generatedFiles = fileSystem.CreatedFiles .Where(c => c.EndsWith(".NodeStates.ex.g.cs", StringComparison.Ordinal)) .ToList(); Assert.That(generatedFiles, Is.Not.Empty, "NodeStates.ex.g.cs file should be generated"); foreach (string file in generatedFiles) { string content = Encoding.UTF8.GetString(fileSystem.Get(file)); TestContext.Out.WriteLine("Generated file: {0} ({1} bytes)", file, content.Length); // Verify basic structure Assert.That(content, Does.Contain("// "), "Generated code should have auto-generated header"); Assert.That(content, Does.Contain("public static partial class OpcUaExtensions"), "Generated code should contain OpcUaExtensions class"); Assert.That(content, Does.Contain("public static global::Opc.Ua.NodeStateCollection AddOpcUa"), "Generated code should contain AddOpcUa method"); } } [Test] public void GeneratedNodeStateGeneratorCodeCompilesTest() { // Arrange ITelemetryContext telemetry = NUnitTelemetryContext.Create(logLevel: LogLevel.Error); using var fileSystem = new VirtualFileSystem(); // Act - Generate stack Generators.GenerateStack(StackGenerationType.All, fileSystem, string.Empty, telemetry); // Get all generated C# files var generatedText = fileSystem.CreatedFiles .Where(c => Path.GetExtension(c) == ".cs") .ToDictionary(c => c, c => Encoding.UTF8.GetString(fileSystem.Get(c))); // Verify generated code compiles using var peStream = new MemoryStream(); bool success = OptimizationLevel.Debug .CreateCompilation() .AddCode(generatedText.WithOpcUaCoreStubs(), LanguageVersion.Latest) .Emit(peStream) .Check(TestContext.Out, out int errorCount, out int warnCount); // Assert Assert.That(success, Is.True, $"Generated NodeStates should compile without errors. Errors: {errorCount}, Warnings: {warnCount}"); } [Test] public void NodeStateGeneratorCodeGeneratesCorrectMethodSignatures() { // Arrange ITelemetryContext telemetry = NUnitTelemetryContext.Create(logLevel: LogLevel.Error); using var fileSystem = new VirtualFileSystem(); // Act Generators.GenerateStack(StackGenerationType.All, fileSystem, string.Empty, telemetry); // Find NodeStateGenerator files var predefinedNodesFiles = fileSystem.CreatedFiles .Where(c => c.EndsWith(".NodeStates.ex.g.cs", StringComparison.Ordinal)) .ToList(); Assert.That(predefinedNodesFiles, Is.Not.Empty); foreach (string file in predefinedNodesFiles) { string content = Encoding.UTF8.GetString(fileSystem.Get(file)); // Check for proper method signatures Assert.That(content, Does.Contain("global::Opc.Ua.ISystemContext context"), "Methods should use ISystemContext parameter"); Assert.That(content, Does.Contain("state.NodeId ="), "Code should set NodeId property"); Assert.That(content, Does.Contain("state.BrowseName ="), "Code should set BrowseName property"); } } private Mock m_mockFileSystem; private Mock m_mockModelDesign; private Mock m_mockTelemetry; private GeneratorContext m_context; } }