OPC UA Part 4 6.6 Redundancy (server + client) with opt-in distributed high-availability

.azurepipelines/sample-ha-longhaul.yml

@@ -0,0 +1,81 @@
+# Azure DevOps pipeline: Sample HA Long-Haul Test.
+#
+# Long-haul high-availability soak of the redundant sample applications
+# (RedundantServer / RedundantClient / RedundantPubSub). The tests are marked
+# [Explicit] so they are never part of the PR gate; the short-haul variants run
+# in the normal test stages. Register this file as its own pipeline in Azure
+# DevOps and run it manually (choosing the duration) or let the weekly schedule
+# run the default one-hour soak.
+
+trigger: none
+pr: none
+
+schedules:
+- cron: '0 4 * * 0'
+  displayName: 'Weekly HA long-haul soak (Sun 04:00 UTC)'
+  branches:
+    include:
+    - master
+  always: true
+
+parameters:
+- name: durationMinutes
+  displayName: 'High-availability soak duration in minutes'
+  type: number
+  default: 60
+
+variables:
+  configuration: 'Release'
+  targetFramework: 'net10.0'
+  testProject: 'Tests/Opc.Ua.Redundancy.Samples.Tests/Opc.Ua.Redundancy.Samples.Tests.csproj'
+
+pool:
+  vmImage: 'ubuntu-24.04'
+
+steps:
+- checkout: self
+  fetchDepth: 0
+
+- task: UseDotNet@2
+  displayName: 'Install .NET 10 SDK'
+  inputs:
+    packageType: sdk
+    version: '10.0.x'
+
+- pwsh: ./.azurepipelines/set-version.ps1
+  displayName: 'Set Cloud Version'
+
+- script: dotnet restore 'UA.slnx'
+  displayName: 'Restore dependencies'
+
+- script: >
+    dotnet build $(testProject)
+    --framework $(targetFramework)
+    --configuration $(configuration)
+    --no-restore
+    /p:CustomTestTarget=$(targetFramework)
+  displayName: 'Build sample HA tests (and the referenced sample apps)'
+
+- script: >
+    dotnet test $(testProject)
+    --configuration $(configuration)
+    --no-build
+    --framework $(targetFramework)
+    /p:CustomTestTarget=$(targetFramework)
+    --filter "Category=SampleHaLongHaul"
+    --logger "trx;LogFileName=sample-ha-longhaul.trx"
+    --logger "console;verbosity=detailed"
+    --results-directory $(Agent.TempDirectory)/TestResults
+  displayName: 'Run long-haul HA soak (${{ parameters.durationMinutes }} min)'
+  timeoutInMinutes: 110
+  env:
+    SAMPLE_HA_DURATION_MINUTES: ${{ parameters.durationMinutes }}
+
+- task: PublishTestResults@2
+  displayName: 'Publish test results'
+  condition: always()
+  inputs:
+    testResultsFormat: 'VSTest'
+    testResultsFiles: '**/sample-ha-longhaul.trx'
+    searchFolder: '$(Agent.TempDirectory)/TestResults'
+    failTaskOnFailedTests: true

.github/workflows/docker-image.yml

@@ -1,4 +1,4 @@
-name: Docker Reference Server CI
+name: Docker Sample Images CI
 
 on:
   push:
@@ -18,13 +18,38 @@ concurrency:
 
 env:
   REGISTRY: ghcr.io
-  IMAGE_NAME: refserver
   DOCKERSIGN: false
 
 jobs:
   build-and-push-image:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Sample servers
+          - image: refserver
+            dockerfile: ./Applications/ConsoleReferenceServer/Dockerfile
+          - image: ldsserver
+            dockerfile: ./Applications/ConsoleLdsServer/Dockerfile
+          - image: boilerserver
+            dockerfile: ./Applications/MinimalBoilerServer/Dockerfile
+          - image: calcserver
+            dockerfile: ./Applications/MinimalCalcServer/Dockerfile
+          - image: mcpserver
+            dockerfile: ./Applications/McpServer/Dockerfile
+          - image: redundantserver
+            dockerfile: ./Applications/RedundantServer/Dockerfile
+          # Redundant client
+          - image: redundantclient
+            dockerfile: ./Applications/RedundantClient/Dockerfile
+          # PubSub samples
+          - image: redundantpubsub
+            dockerfile: ./Applications/RedundantPubSub/Dockerfile
+          - image: pubsubclient
+            dockerfile: ./Applications/ConsoleReferencePubSubClient/Dockerfile
     env:
+      IMAGE_NAME: ${{ matrix.image }}
       IS_NOT_PR: ${{ !github.head_ref && true }}
     permissions:
       contents: read
@@ -114,11 +139,11 @@ jobs:
         push: ${{ github.event_name != 'pull_request' }}
         tags: ${{ env.TAG_BRANCH }},${{ env.TAG_LATEST }}${{ env.TAG_RELEASE }}
         platforms: linux/amd64,linux/arm64/v8
-        file: ./Applications/ConsoleReferenceServer/Dockerfile
+        file: ${{ matrix.dockerfile }}
         labels: ${{ steps.meta.outputs.labels }}
         provenance: false
-        cache-from: type=gha
-        cache-to: type=gha,mode=max
+        cache-from: type=gha,scope=${{ matrix.image }}
+        cache-to: type=gha,mode=max,scope=${{ matrix.image }}
 
     # Sign the resulting Docker image digest except on PRs.
     # https://github.com/sigstore/cosign
@@ -131,4 +156,3 @@ jobs:
       run: |
         echo Signing ${{ env.IMAGE_REPOSITORY }}@${{ steps.build-and-push.outputs.digest }}
         echo "${{ env.IMAGE_REPOSITORY }}" | xargs -I {} cosign sign {}@${{ steps.build-and-push.outputs.digest }}
-

.github/workflows/sample-ha-longhaul.yml

@@ -0,0 +1,85 @@
+name: Sample HA Long-Haul Test
+
+# Long-haul high-availability soak of the redundant sample applications
+# (RedundantServer / RedundantClient / RedundantPubSub). These tests are marked
+# [Explicit] so they never run on pull requests; the short-haul variants of the
+# same scenarios run automatically as part of the normal Build and Test workflow.
+#
+# Run on demand (Actions -> Sample HA Long-Haul Test -> Run workflow) and choose
+# the duration, or let the weekly schedule exercise the default one-hour soak.
+on:
+  workflow_dispatch:
+    inputs:
+      duration:
+        description: 'High-availability soak duration in minutes'
+        required: false
+        default: '60'
+        type: string
+  schedule:
+    # Weekly, Sunday 04:00 UTC (after the nightly build/stress windows).
+    - cron: '0 4 * * 0'
+
+permissions:
+  contents: read
+
+jobs:
+  sample-ha-longhaul:
+    name: Sample HA Long-Haul (${{ github.event.inputs.duration || '60' }} min)
+    runs-on: ubuntu-latest
+    # Allow generous head-room beyond the configured soak duration for build,
+    # startup and teardown.
+    timeout-minutes: 120
+
+    env:
+      DOTNET_VERSION: '10.0.x'
+      TARGET_FRAMEWORK: 'net10.0'
+      CONFIGURATION: 'Release'
+      TESTPROJECT: './Tests/Opc.Ua.Redundancy.Samples.Tests/Opc.Ua.Redundancy.Samples.Tests.csproj'
+      SAMPLE_HA_DURATION_MINUTES: ${{ github.event.inputs.duration || '60' }}
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v7
+      with:
+        fetch-depth: 0
+
+    - name: Setup .NET ${{ env.DOTNET_VERSION }}
+      uses: actions/setup-dotnet@v5
+      with:
+        dotnet-version: ${{ env.DOTNET_VERSION }}
+
+    - name: Set Cloud Version
+      shell: pwsh
+      run: ./.azurepipelines/set-version.ps1
+
+    - name: Restore dependencies
+      run: dotnet restore 'UA.slnx'
+
+    - name: Build sample HA tests (and the referenced sample apps)
+      run: >
+        dotnet build ${{ env.TESTPROJECT }}
+        --framework ${{ env.TARGET_FRAMEWORK }}
+        --configuration ${{ env.CONFIGURATION }}
+        --no-restore
+        /p:CustomTestTarget=${{ env.TARGET_FRAMEWORK }}
+
+    - name: Run long-haul HA soak
+      run: |
+        echo "Running the sample HA long-haul soak for $SAMPLE_HA_DURATION_MINUTES minute(s)."
+        dotnet test ${{ env.TESTPROJECT }} \
+          --configuration ${{ env.CONFIGURATION }} \
+          --no-build \
+          --framework ${{ env.TARGET_FRAMEWORK }} \
+          /p:CustomTestTarget=${{ env.TARGET_FRAMEWORK }} \
+          --filter "Category=SampleHaLongHaul" \
+          --logger "trx;LogFileName=sample-ha-longhaul.trx" \
+          --logger "console;verbosity=detailed" \
+          --results-directory ./TestResults
+      timeout-minutes: 110
+
+    - name: Upload test results
+      uses: actions/upload-artifact@v7
+      with:
+        name: sample-ha-longhaul-results
+        path: ./TestResults
+      if: always()

Applications/ConsoleLdsServer/Dockerfile

@@ -0,0 +1,19 @@
+# OPC UA ConsoleLdsServer (Local Discovery Server) sample image.
+#
+# The build context must be the repository ROOT so the project references resolve.
+# Build directly:
+#   docker build -f Applications/ConsoleLdsServer/Dockerfile -t opcua-lds-server .
+FROM mcr.microsoft.com/dotnet/sdk AS build
+WORKDIR /src
+ENV DOTNET_EnableWriteXorExecute=0
+COPY . .
+RUN dotnet publish "Applications/ConsoleLdsServer/ConsoleLdsServer.csproj" \
+    -c Release -f net10.0 -p:PublishAot=false -p:CustomTestTarget=net10.0 \
+    -o /app/publish
+
+FROM mcr.microsoft.com/dotnet/runtime AS final
+WORKDIR /app
+COPY --from=build /app/publish .
+# OPC UA Local Discovery Server endpoint port.
+EXPOSE 4840
+ENTRYPOINT ["dotnet", "ConsoleLdsServer.dll"]

Applications/ConsoleReferenceClient/ClientSamples.cs

@@ -40,7 +40,6 @@
 using Microsoft.Extensions.Logging;
 using Opc.Ua;
 using Opc.Ua.Client;
-using Opc.Ua.Client.ComplexTypes;
 
 namespace Quickstarts
 {

Applications/ConsoleReferencePubSubClient/ConsoleLoggingSink.cs

@@ -72,9 +72,10 @@ public ValueTask WriteAsync(
                 {
                     builder.Append(", ");
                 }
-                builder.Append(string.IsNullOrEmpty(field.Name) ? $"f{i}" : field.Name);
-                builder.Append('=');
-                builder.Append(field.Value.IsNull ? "(null)" : field.Value.ToString());
+                builder
+                    .Append(string.IsNullOrEmpty(field.Name) ? $"f{i}" : field.Name)
+                    .Append('=')
+                    .Append(field.Value.IsNull ? "(null)" : field.Value.ToString());
             }
             m_logger.LogInformation(
                 "DataSet #{Sequence} received ({FieldCount} fields): {Fields}",

Applications/ConsoleReferencePubSubClient/Dockerfile

@@ -0,0 +1,19 @@
+# OPC UA ConsoleReferencePubSubClient sample image.
+#
+# The build context must be the repository ROOT so the project references resolve.
+# Build directly:
+#   docker build -f Applications/ConsoleReferencePubSubClient/Dockerfile -t opcua-pubsub-client .
+FROM mcr.microsoft.com/dotnet/sdk AS build
+WORKDIR /src
+ENV DOTNET_EnableWriteXorExecute=0
+COPY . .
+RUN dotnet publish "Applications/ConsoleReferencePubSubClient/ConsoleReferencePubSubClient.csproj" \
+    -c Release -f net10.0 -p:PublishAot=false -p:CustomTestTarget=net10.0 \
+    -o /app/publish
+
+FROM mcr.microsoft.com/dotnet/runtime AS final
+WORKDIR /app
+COPY --from=build /app/publish .
+# OPC UA endpoint and PubSub (UADP/MQTT) ports.
+EXPOSE 4840 4841
+ENTRYPOINT ["dotnet", "ConsoleReferencePubSubClient.dll"]

Applications/ConsoleReferencePubSubClient/ExternalServerPubSubConfiguration.cs

@@ -97,10 +97,10 @@ public static PubSubConfigurationDataType BuildConfiguration(BridgeMode modes, s
             }
 
             bool includePublisher = modes.HasFlag(BridgeMode.Publisher);
-            bool includeSubscriber = modes.HasFlag(BridgeMode.Subscriber)
-                || modes.HasFlag(BridgeMode.Responder);
+            bool includeSubscriber = modes.HasFlag(BridgeMode.Subscriber) ||
+                modes.HasFlag(BridgeMode.Responder);
 
-            PubSubConfigurationBuilder builder = PubSubConfigurationBuilder.Create();
+            var builder = PubSubConfigurationBuilder.Create();
             if (includePublisher)
             {
                 AddExternalServerDataSet(builder);
@@ -183,9 +183,7 @@ private static void AddExternalServerDataSet(PubSubConfigurationBuilder builder)
 
         private static void AddWriterGroup(PubSubConnectionBuilder connection)
         {
-            connection.AddWriterGroup("WriterGroup 1", group =>
-            {
-                group
+            connection.AddWriterGroup("WriterGroup 1", group => group
                     .WithWriterGroupId(WriterGroupId)
                     .WithPublishingInterval(PublishingIntervalMs)
                     .WithMessageSettings(WriterGroupMessageSettings())
@@ -195,8 +193,7 @@ private static void AddWriterGroup(PubSubConnectionBuilder connection)
                         .WithDataSetName(DataSetName)
                         .WithKeyFrameCount(1)
                         .WithFieldContentMask(DataSetFieldContentMask.RawData)
-                        .WithMessageSettings(WriterMessageSettings()));
-            });
+                        .WithMessageSettings(WriterMessageSettings())));
         }
 
         private static void AddReaderGroup(PubSubConnectionBuilder connection)
@@ -221,7 +218,7 @@ private static string ConnectionName(BridgeMode modes)
             {
                 return "External Server Publisher Connection";
             }
-            if (modes == BridgeMode.Subscriber || modes == BridgeMode.Responder)
+            if (modes is BridgeMode.Subscriber or BridgeMode.Responder)
             {
                 return "External Server Subscriber Connection";
             }
@@ -321,12 +318,12 @@ private static UadpWriterGroupMessageDataType WriterGroupMessageSettings()
             {
                 DataSetOrdering = DataSetOrderingType.AscendingWriterId,
                 NetworkMessageContentMask = (uint)(
-                    UadpNetworkMessageContentMask.PublisherId
-                    | UadpNetworkMessageContentMask.GroupHeader
-                    | UadpNetworkMessageContentMask.WriterGroupId
-                    | UadpNetworkMessageContentMask.PayloadHeader
-                    | UadpNetworkMessageContentMask.NetworkMessageNumber
-                    | UadpNetworkMessageContentMask.SequenceNumber)
+                    UadpNetworkMessageContentMask.PublisherId |
+                    UadpNetworkMessageContentMask.GroupHeader |
+                    UadpNetworkMessageContentMask.WriterGroupId |
+                    UadpNetworkMessageContentMask.PayloadHeader |
+                    UadpNetworkMessageContentMask.NetworkMessageNumber |
+                    UadpNetworkMessageContentMask.SequenceNumber)
             };
         }
 
@@ -335,8 +332,8 @@ private static UadpDataSetWriterMessageDataType WriterMessageSettings()
             return new UadpDataSetWriterMessageDataType
             {
                 DataSetMessageContentMask = (uint)(
-                    UadpDataSetMessageContentMask.Status
-                    | UadpDataSetMessageContentMask.SequenceNumber)
+                    UadpDataSetMessageContentMask.Status |
+                    UadpDataSetMessageContentMask.SequenceNumber)
             };
         }
 
@@ -345,15 +342,15 @@ private static UadpDataSetReaderMessageDataType ReaderMessageSettings()
             return new UadpDataSetReaderMessageDataType
             {
                 NetworkMessageContentMask = (uint)(
-                    UadpNetworkMessageContentMask.PublisherId
-                    | UadpNetworkMessageContentMask.GroupHeader
-                    | UadpNetworkMessageContentMask.WriterGroupId
-                    | UadpNetworkMessageContentMask.PayloadHeader
-                    | UadpNetworkMessageContentMask.NetworkMessageNumber
-                    | UadpNetworkMessageContentMask.SequenceNumber),
+                    UadpNetworkMessageContentMask.PublisherId |
+                    UadpNetworkMessageContentMask.GroupHeader |
+                    UadpNetworkMessageContentMask.WriterGroupId |
+                    UadpNetworkMessageContentMask.PayloadHeader |
+                    UadpNetworkMessageContentMask.NetworkMessageNumber |
+                    UadpNetworkMessageContentMask.SequenceNumber),
                 DataSetMessageContentMask = (uint)(
-                    UadpDataSetMessageContentMask.Status
-                    | UadpDataSetMessageContentMask.SequenceNumber)
+                    UadpDataSetMessageContentMask.Status |
+                    UadpDataSetMessageContentMask.SequenceNumber)
             };
         }
     }