Add support to publish OPC UA applications as Native AOT

.azurepipelines/get-matrix.ps1

@@ -15,6 +15,9 @@
  .PARAMETER FileName
     File patterns to match defining the folders and files in the matrix
 
+ .PARAMETER ExcludeFileName
+    Optional file pattern to exclude from the matrix
+
  .PARAMETER JobPrefix
     Optional name prefix for each job
 
@@ -25,6 +28,7 @@
 Param(
     [string] $BuildRoot = $null,
     [string] $FileName = $null,
+    [string] $ExcludeFileName = $null,
     [string] $JobPrefix = "",
     [hashtable] $AgentTable = $null
 )
@@ -57,6 +61,7 @@ $jobMatrix = @{}
 # Traverse from build root and find all files to create job matrix
 Get-ChildItem $BuildRoot -Recurse `
     | Where-Object Name -like $FileName `
+    | Where-Object { [string]::IsNullOrEmpty($ExcludeFileName) -or $_.Name -notlike $ExcludeFileName } `
     | ForEach-Object {
 
     $fullFolder = $_.DirectoryName.Replace("\", "/")
@@ -76,11 +81,11 @@ Get-ChildItem $BuildRoot -Recurse `
     }
     $agents.keys | ForEach-Object {
         $jobName = "$($JobPrefix)$($postFix)$($_)"
-        $jobMatrix.Add($jobName, @{ 
+        $jobMatrix.Add($jobName, @{
             "poolImage" = $agents.Item($_)
-            "folder" = $folder 
-            "fullFolder" = $fullFolder 
-            "file" = $file 
+            "folder" = $folder
+            "fullFolder" = $fullFolder
+            "file" = $file
             "agent" = $($_)
         })
     }

.azurepipelines/preview.yml

@@ -96,7 +96,7 @@ jobs:
     displayName: Pack Nuget ${{parameters.config}}
     inputs:
       command: pack
-      packagesToPack:  'UA Core Library.slnx'
+      packagesToPack: 'UA Core Library.slnx'
       configuration: ${{parameters.config}}
       configurationToPack: ${{parameters.config}}
       nobuild: true

.azurepipelines/test-aot.yml

@@ -0,0 +1,76 @@
+#
+# Test Opc.Ua.Aot.Tests with native AOT publish using Microsoft Testing Platform
+#
+parameters:
+  configuration: 'Release'
+  agents: '@{}'
+  jobnamesuffix: ''
+jobs:
+- job: testaotprep${{ parameters.jobnamesuffix }}
+  displayName: Prepare AoT Test Jobs ${{ parameters.configuration }}
+  pool:
+    vmImage: 'windows-2025-vs2026'
+  variables:
+    DOTNET_CLI_TELEMETRY_OPTOUT: true
+    DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  steps:
+  - task: PowerShell@2
+    name: aotmatrix
+    displayName: Prepare AoT Tests
+    inputs:
+      targetType: filePath
+      filePath: ./.azurepipelines/get-matrix.ps1
+      arguments: -FileName Opc.Ua.Aot.Tests.csproj -AgentTable ${{ parameters.agents }}
+- job: testaot${{ parameters.jobnamesuffix }}
+  displayName: AoT Tests
+  dependsOn: testaotprep${{ parameters.jobnamesuffix }}
+  timeoutInMinutes: 30
+  strategy:
+    matrix: $[dependencies.testaotprep${{ parameters.jobnamesuffix }}.outputs['aotmatrix.jobMatrix'] ]
+  variables:
+    DOTNET_CLI_TELEMETRY_OPTOUT: true
+    DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  pool:
+    vmImage: $(poolImage)
+  steps:
+  - task: UseDotNet@2
+    displayName: 'Install .NET 10.0'
+    inputs:
+      packageType: 'sdk'
+      version: '10.0.x'
+  - task: NuGetToolInstaller@1
+    inputs:
+      versionSpec: '>=7.0.x'
+  - task: PowerShell@2
+    displayName: Versioning
+    inputs:
+      targetType: filePath
+      filePath: ./.azurepipelines/set-version.ps1
+  - task: DotNetCoreCLI@2
+    displayName: Publish AoT Tests ${{ parameters.configuration }}
+    inputs:
+      command: publish
+      publishWebProjects: false
+      projects: $(file)
+      arguments: '--configuration ${{ parameters.configuration }}'
+      zipAfterPublish: false
+      modifyOutputPath: false
+  - task: PowerShell@2
+    displayName: Run AoT Tests
+    inputs:
+      pwsh: true
+      targetType: inline
+      script: |
+        $publishDir = Get-ChildItem -Path "$(folder)/bin/${{ parameters.configuration }}/net10.0/*/publish" -Directory | Select-Object -First 1
+        if (-not $publishDir) {
+          Write-Error "No publish directory found."
+          exit 1
+        }
+        if ($IsWindows) {
+          $exe = Join-Path $publishDir.FullName "Opc.Ua.Aot.Tests.exe"
+        } else {
+          $exe = Join-Path $publishDir.FullName "Opc.Ua.Aot.Tests"
+        }
+        Write-Host "Running: $exe"
+        & $exe
+        if ($LASTEXITCODE -ne 0) { exit $LASTEXITCODE }

.azurepipelines/test.yml

@@ -22,7 +22,7 @@ jobs:
     inputs:
       targetType: filePath
       filePath: ./.azurepipelines/get-matrix.ps1
-      arguments: -FileName *.Tests.csproj -AgentTable ${{ parameters.agents }}
+      arguments: -FileName *.Tests.csproj -ExcludeFileName Opc.Ua.Aot.Tests.csproj -AgentTable ${{ parameters.agents }}
 - job: testall${{ parameters.jobnamesuffix }}
   displayName: Tests (${{ parameters.framework }})
   dependsOn: testprep${{ parameters.jobnamesuffix }}
@@ -40,18 +40,6 @@ jobs:
   pool:
     vmImage: $(poolImage)
   steps:
-  - task: UseDotNet@2
-    displayName: 'Install .NET 8.0'
-    condition: eq('${{parameters.framework}}', 'net8.0')
-    inputs:
-      packageType: 'sdk'
-      version: '8.0.x'
-  - task: UseDotNet@2
-    displayName: 'Install .NET 9.0'
-    condition: eq('${{parameters.framework}}', 'net9.0')
-    inputs:
-      packageType: 'sdk'
-      version: '9.0.x'
   - task: UseDotNet@2
     displayName: 'Install .NET 10.0'
     inputs:

.azurepipelines/testcc.yml

@@ -23,12 +23,6 @@ jobs:
   pool:
     vmImage: ${{ parameters.poolImage }}
   steps:
-  - task: UseDotNet@2
-    displayName: 'Install .NET 8.0'
-    condition: eq('${{parameters.framework}}', 'net8.0')
-    inputs:
-      packageType: 'sdk'
-      version: '8.0.x'
   - task: UseDotNet@2
     displayName: 'Install .NET 10.0'
     inputs:
@@ -67,7 +61,9 @@ jobs:
     timeoutInMinutes: 60
     inputs:
       command: test
-      projects: 'UA.slnx'
+      projects: |
+        **/*.Tests.csproj
+        !**/Opc.Ua.Aot.Tests.csproj
       # note: /p:CollectCoverage=true is only used to disable deterministic builds
       arguments: '--no-restore ${{ variables.DotCliCommandline }} --configuration ${{ parameters.configuration }} /p:CollectCoverage=true --collect:"XPlat Code Coverage" --settings ./Tests/coverlet.runsettings.xml --results-directory $(Agent.TempDirectory)'
       publishTestResults: false

.github/workflows/buildandtest.yml

@@ -77,3 +77,49 @@ jobs:
         verbose: true
       # Use always() to always run this step to publish test results when there are test failures
       if: ${{ always() }}
+
+  aot-test:
+    name: aot-${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+        include:
+          - dotnet-version: '10.0.x'
+            configuration: 'Release'
+
+    env:
+      AOTPROJECT: './Tests/Opc.Ua.Aot.Tests/Opc.Ua.Aot.Tests.csproj'
+
+    steps:
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
+
+    - name: Setup .NET ${{ matrix.dotnet-version }}
+      uses: actions/setup-dotnet@v5
+      with:
+        dotnet-version: ${{ matrix.dotnet-version }}
+
+    - name: Set Cloud Version
+      shell: pwsh
+      run: ./.azurepipelines/set-version.ps1
+
+    - name: Publish NativeAOT
+      run: dotnet publish ${{ env.AOTPROJECT }} --configuration ${{ matrix.configuration }}
+
+    - name: Run NativeAOT Tests (Linux)
+      if: runner.os == 'Linux'
+      run: ./Tests/Opc.Ua.Aot.Tests/bin/${{ matrix.configuration }}/net10.0/linux-x64/publish/Opc.Ua.Aot.Tests
+
+    - name: Run NativeAOT Tests (Windows)
+      if: runner.os == 'Windows'
+      run: ./Tests/Opc.Ua.Aot.Tests/bin/${{ matrix.configuration }}/net10.0/win-x64/publish/Opc.Ua.Aot.Tests.exe
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v7
+      with:
+        name: aot-results-${{ matrix.os }}
+        path: '**/TestResults/**'
+      if: ${{ always() }}

.gitignore

@@ -187,6 +187,7 @@ BundleArtifacts/
 
 # Others
 ClientBin/
+_publish/
 ~$*
 *~
 *.dbmdl

Applications/ConsoleReferenceClient/ClientSamples.cs

@@ -31,14 +31,14 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Globalization;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using System.Xml;
 using Microsoft.Extensions.Logging;
-using Newtonsoft.Json;
 using Opc.Ua;
 using Opc.Ua.Client;
 using Opc.Ua.Client.ComplexTypes;
@@ -1101,29 +1101,26 @@ ArrayOf<BrowseDescription> browseDescriptionCollection
         /// Outputs elapsed time information for perf testing and lists all
         /// types that were successfully added to the session encodeable type factory.
         /// </remarks>
-        public async Task<ComplexTypeSystem> LoadTypeSystemAsync(
-            ISession session,
-            CancellationToken ct = default)
+        public async Task LoadTypeSystemAsync(ComplexTypeSystem complexTypeSystem, CancellationToken ct = default)
         {
             m_logger.LogInformation("Load the server type system.");
 
             var stopWatch = new Stopwatch();
             stopWatch.Start();
 
-            var complexTypeSystem = new ComplexTypeSystem(session, m_telemetry);
             await complexTypeSystem.LoadAsync(throwOnError: true, ct: ct).ConfigureAwait(false);
 
             stopWatch.Stop();
 
             m_logger.LogInformation(
                 "Loaded {Count} types took {Duration}ms.",
-                complexTypeSystem.GetDefinedTypes().Length,
+                complexTypeSystem.GetDefinedTypes().Count,
                 stopWatch.ElapsedMilliseconds);
 
             if (m_verbose)
             {
                 m_logger.LogInformation("Custom types defined for this session:");
-                foreach (Type type in complexTypeSystem.GetDefinedTypes())
+                foreach (XmlQualifiedName type in complexTypeSystem.GetDefinedTypes())
                 {
                     m_logger.LogInformation("{Namespace}.{TypeName}", type.Namespace, type.Name);
                 }
@@ -1140,8 +1137,6 @@ public async Task<ComplexTypeSystem> LoadTypeSystemAsync(
                     }
                 }
             }
-
-            return complexTypeSystem;
         }
 
         /// <summary>
@@ -1369,25 +1364,26 @@ public static string FormatValueAsJson(
             }
 
             // prettify
-            using var stringWriter = new StringWriter();
             try
             {
-                using var stringReader = new StringReader(textbuffer);
-                var jsonReader = new JsonTextReader(stringReader);
-                var jsonWriter = new JsonTextWriter(stringWriter)
+                using var doc = System.Text.Json.JsonDocument.Parse(textbuffer);
+                using var stream = new MemoryStream();
+                using (var writer = new System.Text.Json.Utf8JsonWriter(stream, new System.Text.Json.JsonWriterOptions
                 {
-                    Formatting = Formatting.Indented,
-                    Culture = CultureInfo.InvariantCulture
-                };
-                jsonWriter.WriteToken(jsonReader);
+                    Indented = true
+                }))
+                {
+                    doc.WriteTo(writer);
+                }
+                return Encoding.UTF8.GetString(stream.ToArray());
             }
             catch (Exception ex)
             {
+                using var stringWriter = new StringWriter();
                 stringWriter.WriteLine("Failed to format the JSON output: {0}", ex.Message);
                 stringWriter.WriteLine(textbuffer);
                 throw;
             }
-            return stringWriter.ToString();
         }
 
         /// <summary>
@@ -1568,7 +1564,7 @@ private static ArrayOf<BrowseDescription> CreateBrowseDescriptionCollectionFromN
             var browseDescriptionCollection = new List<BrowseDescription>();
             foreach (NodeId nodeId in nodeIdCollection)
             {
-                var browseDescription = (BrowseDescription)template.MemberwiseClone();
+                BrowseDescription browseDescription = CoreUtils.Clone(template);
                 browseDescription.NodeId = nodeId;
                 browseDescriptionCollection.Add(browseDescription);
             }
@@ -1581,6 +1577,10 @@ private static ArrayOf<BrowseDescription> CreateBrowseDescriptionCollectionFromN
         /// <param name="session">The session to use for exporting.</param>
         /// <param name="nodes">The list of nodes to export.</param>
         /// <param name="filePath">The path where the NodeSet2 XML file will be saved.</param>
+        [RequiresUnreferencedCode(
+            "Uses XmlSerializer which requires unreferenced code.")]
+        [RequiresDynamicCode(
+            "Uses XmlSerializer which requires unreferenced code.")]
         public void ExportNodesToNodeSet2(ISession session, IList<INode> nodes, string filePath)
         {
             m_logger.LogInformation("Exporting {Count} nodes to {FilePath}...", nodes.Count, filePath);
@@ -1617,6 +1617,10 @@ public void ExportNodesToNodeSet2(ISession session, IList<INode> nodes, string f
         /// <returns>A dictionary mapping namespace URI to the file path of the exported NodeSet2 file.</returns>
         /// <exception cref="ArgumentNullException">Thrown when session, nodes, or outputDirectory is null.</exception>
         /// <exception cref="ArgumentException">Thrown when outputDirectory is empty or whitespace.</exception>
+        [RequiresUnreferencedCode(
+            "Uses XmlSerializer which requires unreferenced code.")]
+        [RequiresDynamicCode(
+            "Uses XmlSerializer which requires unreferenced code.")]
         public async Task<IReadOnlyDictionary<string, string>> ExportNodesToNodeSet2PerNamespaceAsync(
             ISession session,
             IList<INode> nodes,

Applications/ConsoleReferenceClient/ConsoleReferenceClient.csproj

@@ -8,6 +8,7 @@
     <Description>.NET Console Reference Client</Description>
     <Copyright>Copyright © 2004-2024 OPC Foundation, Inc</Copyright>
     <RootNamespace>Quickstarts.ConsoleReferenceClient</RootNamespace>
+    <PublishAot Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net10.0'))">true</PublishAot>
   </PropertyGroup>
   <ItemGroup>
     <Compile
@@ -19,7 +20,7 @@
     <PackageReference Include="Microsoft.Extensions.Logging" />
     <PackageReference Include="Microsoft.Extensions.Configuration" />
     <PackageReference Include="Microsoft.Extensions.Configuration.EnvironmentVariables" />
-    <PackageReference Include="Mono.Options" />
+    <PackageReference Include="System.CommandLine" />
     <PackageReference Include="Serilog" />
     <PackageReference Include="Serilog.Extensions.Logging" />
     <PackageReference Include="Serilog.Expressions" />