Files
Marc Schier 4756e7c245 DI (OPC 10000-100) with samples (Pump, SW Update), fluent API gap closures and model dependency implementation (#3808)
This PR implements the **OPC UA Device Integration (DI, OPC 10000-100)**
companion-spec library trio (`Opc.Ua.Di` / `Opc.Ua.Di.Server` /
`Opc.Ua.Di.Client`) plus a worked example
(`Applications/MinimalPumpServer`) demonstrating the OPC 40223 Pumps
companion specification end-to-end with full simulation. It also closes
11 fluent-API gaps in `Opc.Ua.Server.Fluent`, three source-generator
bugs, integrates the DI layer into the unified `services.AddOpcUa()`
Microsoft.Extensions DI hosting pattern, and adds 250+ new tests.

**Worked example — `Applications/MinimalPumpServer/`**
- AOT-compatible console host using `Host.CreateApplicationBuilder` +
`AddOpcUa()`.
- `PumpNodeManager` inherits from `DiNodeManager`; multi-namespace (DI +
Machinery + Pumps) via runtime NodeSet2 loading and
`ModelLoaderBuilder`.
- Demonstrates declarative second-pump creation via
`.ConfigureDevicesFor<PumpNodeManager>(...)` and software-package
seeding from the same configurator.
- Full simulation: pressure, temperatures, power, flow, efficiency,
level, cavitation/overheat fault injection, alarm setup, NAMUR-style
supervision.

**Documentation**
- `Docs/Opc.Ua.Di/` — README, DeviceBuilder, Hosting, LockService,
SoftwareUpdate, ClientHelpers (6 new developer guides).
- `Docs/Opc.Ua.Di/ComplianceMatrix.md` — every DI declaration mapped to
In-v1 / Generated / Deferred / Excluded.
- `Docs/CompanionSpecLibraries.md` — packaging guide for new
companion-spec libraries.
- `Docs/FluentApiGaps.md` — historical record of G1–G11.
- `Docs/SourceGeneratedNodeManagers.md` updated for richer node
managers.
- `Docs/plans/StateMachineBuilder.md` — deferred state-machine builder
design.
2026-06-04 05:57:57 +02:00

106 lines
4.6 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.Collections.Generic;
using System.Collections.Immutable;
using System.Linq;
using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using NUnit.Framework;
namespace Opc.Ua.SourceGeneration
{
/// <summary>
/// Test generation and compilation
/// </summary>
[TestFixture]
[Category("SourceGeneration")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
// [Parallelizable(ParallelScope.All)]
public class StackGeneratorTests
{
[DatapointSource]
public OptimizationLevel[] OptimizationLevels = CompilerUtils.SupportedOptimizationLevels;
[Theory]
public void GenerateAndCompileTest(OptimizationLevel optimizationLevel)
{
var generator = new StackSourceGenerator();
var host = new StackSourceGeneratorHoist(generator);
CSharpCompilation compilation = optimizationLevel.CreateCompilation("Opc.Ua.Test")
.AddCode(new Dictionary<string, string>().WithOpcUaCoreStubs(), LanguageVersion.Latest);
// Create the driver the executes the generator
GeneratorDriver driver = CSharpGeneratorDriver.Create(host);
// Run it
driver = driver.RunGeneratorsAndUpdateCompilation(
compilation,
out Compilation outputCompilation,
out ImmutableArray<Diagnostic> diagnostics);
Assert.That(diagnostics, Is.Empty);
Assert.That(outputCompilation.SyntaxTrees.Count(), Is.GreaterThan(1));
outputCompilation.GetDiagnostics().Check(
TestContext.Out,
out int errors,
out int warnings);
Assert.That(errors, Is.Zero, $"Compilation produced {errors} errors");
#if NETFRAMEWORK
TestContext.Out.WriteLine($"Compilation produced {warnings} warnings");
#else
Assert.That(warnings, Is.Zero, $"Compilation produced {warnings} warnings");
#endif
// Get the results
GeneratorDriverRunResult runResult = driver.GetRunResult();
// Test the results
Assert.That(runResult.GeneratedTrees, Is.Not.Empty);
runResult.Diagnostics.Check(TestContext.Out, out errors, out warnings);
Assert.That(errors, Is.Zero);
TestContext.Out.WriteLine($"Run result produced {warnings} warnings");
GeneratorRunResult generatorResult = runResult.Results[0];
generatorResult.Diagnostics.Check(TestContext.Out, out errors, out warnings);
Assert.That(errors, Is.Zero);
TestContext.Out.WriteLine($"Generate run produced {warnings} warnings");
// 17 generated sources: 16 baseline + 1 Opc.Ua.StateMachineIds.g.cs
// emitted by the StateMachineIdsGenerator added in commit
// 0eda2ad7a for every model that declares concrete
// FiniteStateMachineType subtypes (the OPC UA stack model
// declares ProgramStateMachineType, ShelvedStateMachineType,
// FileTransferStateMachineType, etc.).
Assert.That(generatorResult.GeneratedSources, Has.Length.EqualTo(17));
Assert.That(generatorResult.Exception, Is.Null);
}
}
}