mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 06:31:35 +08:00
Marc Schier
15d0ce7bd5
# Description Implement OPC UA Part 10 Programs across `Opc.Ua.Core`/`Core.Types`, `Opc.Ua.Server`, and `Opc.Ua.Client`, reusing the existing state-machine, source-generation, node-management, auditing, and streaming-subscription infrastructure. - Add asynchronous provider-backed execution, standard controls, internal/autonomous transitions, generation checks, and nested-state activation/resumption. - Add checked creation/adoption, vendor Create adapters, deletion, recycling and instance limits, auto-delete, DI, and direct-construction paths. - Maintain ProgramDiagnostic2 and retained final results; publish captured intermediate results and concrete transition/audit events with access controls. - Add generated SDK models/proxies, typed client discovery and reads, event streams, and subscribe-before-call readiness handling. - Add unit, connected client/server, generated Annex A-style model, and NativeAOT coverage. Document usage and migration in `docs/Programs.md` and related guides. ### Compatibility and design decisions The linked Part 10 document is v1.05.00; namespace-zero definitions remain aligned with 1.05.07. Documentation distinguishes normative requirements from conflicting specification text and SDK conventions. - Correct state numbers to Halted=11, Ready=12, Running=13, Suspended=14. Generated subtypes retain inherited namespace-zero state/transition identifiers. - Managed Reset is Halted-to-Ready only. Preserve the existing low-level Reset-from-Suspended behavior for compatibility. - Preserve UInt32 limit types; use `UInt32.MaxValue` as a documented SDK unlimited convention. RecycleCount overflow reports BadOutOfRange without stopping unlimited execution. - In-memory default with injectable providers. Durable recovery, distributed execution/failover, and a production Annex A download engine are excluded. ## Checklist _Put an `x` in the boxes that apply. You can complete these step by step after opening the PR._ - [ ] I have signed the [CLA](https://opcfoundation.org/license/cla/ContributorLicenseAgreementv1.0.pdf) and read the [CONTRIBUTING](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/CONTRIBUTING.md) doc. - [ ] I have added tests that prove my fix is effective or that my feature works and increased code coverage. - [x] I have added all necessary documentation. - [x] I have verified that my changes do not introduce (new) build or analyzer warnings. - [ ] I ran **all** tests locally using the **UA.slnx** solution against at least .net **framework** and .net **10**, and all passed. - [ ] I fixed **all** failing and flaky tests in the CI pipelines and **all** CodeQL warnings. - [ ] I have addressed **all** PR feedback received. Tests and focused coverage evidence are above; the combined tests/coverage checkbox remains open because a whole-repository coverage increase has not been established. CLA status, CI/CodeQL results, tracking-issue approval, and PR feedback are not asserted.
672 lines
34 KiB
C#
672 lines
34 KiB
C#
/* ========================================================================
|
|
* 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;
|
|
using System.Collections.Generic;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Threading;
|
|
using System.Threading.Channels;
|
|
using System.Threading.Tasks;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Programs;
|
|
using Opc.Ua.Server.Programs;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Server.Tests.Programs
|
|
{
|
|
/// <summary>
|
|
/// Exercises managed Programs through the same method and provider seams used by applications.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Programs")]
|
|
[Parallelizable(ParallelScope.All)]
|
|
public sealed class ProgramRuntimeTests
|
|
{
|
|
[Test]
|
|
public async Task ControlsFollowStrictProgramSemanticsAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Suspend, ProgramState.Suspended).ConfigureAwait(false);
|
|
MethodInvocationResult reset = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Reset).ConfigureAwait(false);
|
|
Assert.That(reset.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Suspended));
|
|
await fixture.CallAsync(ProgramControlMethod.Resume, ProgramState.Running).ConfigureAwait(false);
|
|
Assert.That(fixture.Runtime.Node.RecycleCount!.Value, Is.Zero);
|
|
await fixture.CallAsync(ProgramControlMethod.Halt, ProgramState.Halted).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Reset, ProgramState.Ready).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
Assert.That(fixture.Runtime.Node.RecycleCount!.Value, Is.EqualTo(1));
|
|
}
|
|
|
|
[Test]
|
|
public async Task RejectedProviderDoesNotCommitOrConsumeAnExecutionAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
fixture.Execution.Result = new ServiceResult(StatusCodes.BadResourceUnavailable);
|
|
MethodInvocationResult result = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadResourceUnavailable));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Ready));
|
|
Assert.That(fixture.Runtime.RunId, Is.Zero);
|
|
Assert.That(fixture.Runtime.Node.RecycleCount!.Value, Is.Zero);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task GuardsRunBeforeTheProviderAndOnlyOnceAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
int guards = 0;
|
|
fixture.Runtime.Node.OnBeforeTransition = (_, _, _, _, _, _) =>
|
|
{
|
|
guards++;
|
|
return StatusCodes.BadInvalidState;
|
|
};
|
|
MethodInvocationResult result = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadInvalidState));
|
|
Assert.That(guards, Is.EqualTo(1));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task InternalCompletionAndStaleRunAreDistinguishedAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
long firstRun = fixture.Runtime.RunId;
|
|
ServiceResult completion = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(firstRun, ProgramState.Ready)).ConfigureAwait(false);
|
|
Assert.That(ServiceResult.IsGood(completion), Is.True);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
ServiceResult stale = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(firstRun, ProgramState.Halted)).ConfigureAwait(false);
|
|
Assert.That(stale.StatusCode, Is.EqualTo(StatusCodes.BadInvalidState));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Running));
|
|
}
|
|
|
|
[Test]
|
|
public async Task RunOncePolicyKeepsCompletedInvocationHaltedAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(maxRecycles: 0).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Halt, ProgramState.Halted).ConfigureAwait(false);
|
|
MethodInvocationResult reset = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Reset).ConfigureAwait(false);
|
|
Assert.That(reset.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
MethodInvocationResult secondStart = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(secondStart.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Execution.CallCount, Is.EqualTo(2));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Halted));
|
|
}
|
|
|
|
[Test]
|
|
public async Task InvalidArgumentsNeverReachTheProviderAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
MethodInvocationResult result = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start, [new Variant(42)]).ConfigureAwait(false);
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadTooManyArguments));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ClientDeletionRequiresHaltedAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
ServiceResult running = await fixture.Runtime.PrepareDeleteAsync(byClient: true).ConfigureAwait(false);
|
|
Assert.That(running.StatusCode, Is.EqualTo(StatusCodes.BadInvalidState));
|
|
await fixture.CallAsync(ProgramControlMethod.Halt, ProgramState.Halted).ConfigureAwait(false);
|
|
ServiceResult halted = await fixture.Runtime.PrepareDeleteAsync(byClient: true).ConfigureAwait(false);
|
|
Assert.That(ServiceResult.IsGood(halted), Is.True);
|
|
}
|
|
|
|
[Test]
|
|
public async Task DiagnosticsRecordValidationFailuresAndInternalTransitionsAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(diagnostics: true).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
MethodInvocationResult invalid = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(invalid.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
ProgramDiagnostic2DataType diagnostic = fixture.Runtime.Node.ProgramDiagnostic!.Value;
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(diagnostic.LastMethodCall, Is.EqualTo("Start"));
|
|
Assert.That(diagnostic.LastMethodReturnStatus, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Runtime.Node.ProgramDiagnostic.LastMethodCall!.Value,
|
|
Is.EqualTo(diagnostic.LastMethodCall));
|
|
});
|
|
ServiceResult result = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(fixture.Runtime.RunId, ProgramState.Ready)).ConfigureAwait(false);
|
|
Assert.That(ServiceResult.IsGood(result), Is.True);
|
|
Assert.That(fixture.Runtime.Node.ProgramDiagnostic.Value.LastTransitionTime,
|
|
Is.EqualTo(fixture.Runtime.Node.LastTransition!.TransitionTime!.Value));
|
|
}
|
|
|
|
[Test]
|
|
public async Task DisposalReleasesTheProviderAsync()
|
|
{
|
|
Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
await fixture.DisposeAsync().ConfigureAwait(false);
|
|
Assert.That(fixture.Execution.Disposed, Is.True);
|
|
await fixture.Runtime.DisposeAsync().ConfigureAwait(false);
|
|
}
|
|
|
|
[TestCase((long)int.MaxValue - 1)]
|
|
[TestCase((long)int.MaxValue)]
|
|
public void RepresentableRecycleCountsRemainAccurate(long count)
|
|
{
|
|
PropertyState<int> variable = PropertyState<int>.With<VariantBuilder>(new BaseObjectState(null));
|
|
ProgramRuntime.PublishRecycleCount(variable, count);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(variable.Value, Is.EqualTo(count));
|
|
Assert.That(variable.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public void UnlimitedRecyclingContinuesAfterTheWireCounterOverflows()
|
|
{
|
|
PropertyState<int> variable =
|
|
PropertyState<int>.With<VariantBuilder>(new BaseObjectState(null), int.MaxValue);
|
|
long count = (long)int.MaxValue + 1;
|
|
ProgramRuntime.PublishRecycleCount(variable, count);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(variable.Value, Is.EqualTo(int.MaxValue));
|
|
Assert.That(variable.StatusCode, Is.EqualTo(StatusCodes.BadOutOfRange));
|
|
Assert.That(ProgramRuntime.CanRestart(true, count, uint.MaxValue), Is.True);
|
|
Assert.That(ProgramRuntime.CanRestart(true, count, int.MaxValue), Is.False);
|
|
Assert.That(ProgramRuntime.CanRestart(true, (long)uint.MaxValue - 1, uint.MaxValue - 1), Is.False);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task TransitionEventsRetainTheirCapturedStateAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
var events = new List<ProgramTransitionEventState>();
|
|
fixture.Runtime.Node.OnReportEvent = (_, _, value) =>
|
|
{
|
|
if (value is ProgramTransitionEventState transition)
|
|
{
|
|
events.Add(transition);
|
|
}
|
|
};
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Suspend, ProgramState.Suspended).ConfigureAwait(false);
|
|
Assert.That(events, Has.Count.EqualTo(2));
|
|
Assert.That(events[0].ToState!.Id!.Value.TryGetValue(out NodeId firstTarget), Is.True);
|
|
Assert.That(firstTarget, Is.EqualTo(ObjectIds.ProgramStateMachineType_Running));
|
|
Assert.That(events[1].ToState!.Id!.Value.TryGetValue(out NodeId secondTarget), Is.True);
|
|
Assert.That(secondTarget, Is.EqualTo(ObjectIds.ProgramStateMachineType_Suspended));
|
|
}
|
|
|
|
[Test]
|
|
public async Task DuplicateAttachmentCannotResetAnExistingExecutionAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
ServiceResultException exception = Assert.ThrowsAsync<ServiceResultException>(
|
|
async () => await ProgramRuntime.AttachAsync(fixture.Runtime.Node, fixture.Runtime.Definition,
|
|
fixture.Context, TimeProvider.System).ConfigureAwait(false))!;
|
|
Assert.That(exception.StatusCode, Is.EqualTo(StatusCodes.BadConfigurationError));
|
|
Assert.That(fixture.Runtime.Node.CurrentState!.Number!.Value, Is.EqualTo((uint)ProgramState.Running));
|
|
Assert.That(fixture.Execution.Disposed, Is.False);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ProviderOutputTypesAreValidatedBeforeCommitAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
var method = (MethodState)fixture.Runtime.Node.FindChild(
|
|
fixture.Context, new QualifiedName("Start", 1))!;
|
|
method.OutputArguments = PropertyState<ArrayOf<Argument>>.With<StructureBuilder<Argument>>(method,
|
|
[new Argument { Name = "Result", DataType = DataTypeIds.Int32, ValueRank = ValueRanks.Scalar }]);
|
|
fixture.Execution.Outputs = [Variant.From("not an integer")];
|
|
MethodInvocationResult result = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadTypeMismatch));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Ready));
|
|
Assert.That(fixture.Runtime.RunId, Is.Zero);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task UserPermissionFailureDoesNotInvokeTheProviderAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(diagnostics: true).ConfigureAwait(false);
|
|
fixture.Runtime.Node.OnCheckUserPermission = (_, _, _, _, _, _) => StatusCodes.BadUserAccessDenied;
|
|
MethodInvocationResult result = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadUserAccessDenied));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
Assert.That(fixture.Runtime.Node.ProgramDiagnostic!.Value.LastMethodReturnStatus,
|
|
Is.EqualTo(StatusCodes.BadUserAccessDenied));
|
|
}
|
|
|
|
[Test]
|
|
public async Task InitiallyHaltedProgramCanBecomeReadyWhenResourcesArriveAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(initialState: ProgramState.Halted)
|
|
.ConfigureAwait(false);
|
|
ServiceResult result = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(0, ProgramState.Ready)).ConfigureAwait(false);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(result.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Ready));
|
|
Assert.That(fixture.Runtime.RunId, Is.Zero);
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task AutonomousRunsUseNewGenerationsAndTheSameRecyclingPolicyAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
ServiceResult first = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(1, ProgramState.Running)).ConfigureAwait(false);
|
|
Assert.That(first.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
ServiceResult pause = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(1, ProgramState.Suspended)).ConfigureAwait(false);
|
|
Assert.That(pause.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
ServiceResult complete = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(1, ProgramState.Ready)).ConfigureAwait(false);
|
|
Assert.That(complete.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
ServiceResult restart = await fixture.Runtime.ApplyUpdateAsync(
|
|
new ProgramExecutionUpdate(2, ProgramState.Running)).ConfigureAwait(false);
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(restart.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
Assert.That(fixture.Runtime.RunId, Is.EqualTo(2));
|
|
Assert.That(fixture.Runtime.Node.RecycleCount!.Value, Is.EqualTo(1));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public async Task ControlsRemainDisabledUntilRegistrationIsActivatedAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(startObserving: false).ConfigureAwait(false);
|
|
MethodInvocationResult before = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(before.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
await fixture.Runtime.ActivateAsync().ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ActivationWaitsForObservationBeforeEnablingControlsAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(startObserving: false).ConfigureAwait(false);
|
|
fixture.Execution.PublishHotCompletion = true;
|
|
var halted = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
fixture.Runtime.Node.OnReportEvent = (_, _, value) =>
|
|
{
|
|
if (value is ProgramTransitionEventState transition &&
|
|
transition.ToState!.Id!.Value.TryGetValue(out NodeId state) &&
|
|
state == ObjectIds.ProgramStateMachineType_Halted)
|
|
{
|
|
halted.TrySetResult(true);
|
|
}
|
|
};
|
|
var scheduler = new DeferredSynchronizationContext();
|
|
SynchronizationContext? previous = SynchronizationContext.Current;
|
|
ValueTask activation;
|
|
try
|
|
{
|
|
SynchronizationContext.SetSynchronizationContext(scheduler);
|
|
activation = fixture.Runtime.ActivateAsync();
|
|
}
|
|
finally
|
|
{
|
|
SynchronizationContext.SetSynchronizationContext(previous);
|
|
}
|
|
try
|
|
{
|
|
Assert.That(activation.IsCompleted, Is.False,
|
|
"Activation must wait until the provider's first MoveNext has installed its observer.");
|
|
Assert.That(fixture.Execution.ObservationStarted.Task.IsCompleted, Is.False);
|
|
MethodInvocationResult before = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(before.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
scheduler.RunPostedCallbacks();
|
|
await activation.ConfigureAwait(false);
|
|
Assert.That(fixture.Execution.ObservationStarted.Task.Status, Is.EqualTo(TaskStatus.RanToCompletion));
|
|
MethodInvocationResult start = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(start.OperationResult.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
await halted.Task.WaitAsync(TimeSpan.FromSeconds(10)).ConfigureAwait(false);
|
|
Assert.That(fixture.Execution.DroppedUpdates, Is.Zero,
|
|
"A provider that drops updates without an observer must retain the first Start completion.");
|
|
}
|
|
finally
|
|
{
|
|
scheduler.RunPostedCallbacks();
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ActivationFailureKeepsControlsDisabledAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(startObserving: false).ConfigureAwait(false);
|
|
fixture.Execution.OnObservationStarting =
|
|
() => throw new InvalidOperationException("Observer setup failed.");
|
|
|
|
InvalidOperationException exception = Assert.ThrowsAsync<InvalidOperationException>(
|
|
() => fixture.Runtime.ActivateAsync().AsTask())!;
|
|
|
|
Assert.That(exception.Message, Is.EqualTo("Observer setup failed."));
|
|
MethodInvocationResult start = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(start.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadNotExecutable));
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ActivationCancellationDrainsPendingEnumerationAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync(startObserving: false).ConfigureAwait(false);
|
|
using var cancellation = new CancellationTokenSource();
|
|
fixture.Execution.OnObservationStarting = cancellation.Cancel;
|
|
|
|
Assert.ThrowsAsync<TaskCanceledException>(
|
|
() => fixture.Runtime.ActivateAsync(cancellation.Token).AsTask());
|
|
|
|
await fixture.Runtime.DisposeAsync().ConfigureAwait(false);
|
|
Assert.That(fixture.Execution.Disposed, Is.True);
|
|
Assert.That(fixture.Execution.CallCount, Is.Zero);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ResetWaitsForRestartedObservationBeforeEnablingControlsAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
var halted = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
fixture.Runtime.Node.OnReportEvent = (_, _, value) =>
|
|
{
|
|
if (value is ProgramTransitionEventState transition &&
|
|
transition.ToState!.Id!.Value.TryGetValue(out NodeId state) &&
|
|
state == ObjectIds.ProgramStateMachineType_Halted)
|
|
{
|
|
halted.TrySetResult(true);
|
|
}
|
|
};
|
|
fixture.Execution.FailObservation();
|
|
await halted.Task.WaitAsync(TimeSpan.FromSeconds(10)).ConfigureAwait(false);
|
|
var scheduler = new DeferredSynchronizationContext();
|
|
SynchronizationContext? previous = SynchronizationContext.Current;
|
|
ValueTask<MethodInvocationResult> reset;
|
|
try
|
|
{
|
|
SynchronizationContext.SetSynchronizationContext(scheduler);
|
|
reset = fixture.Runtime.ControlAsync(fixture.Context, ProgramControlMethod.Reset);
|
|
}
|
|
finally
|
|
{
|
|
SynchronizationContext.SetSynchronizationContext(previous);
|
|
scheduler.RunPostedCallbacks();
|
|
}
|
|
MethodInvocationResult result = await reset.ConfigureAwait(false);
|
|
Assert.That(result.OperationResult.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
Assert.That(fixture.Execution.ObservationStarted.Task.Status, Is.EqualTo(TaskStatus.RanToCompletion),
|
|
"A completed Reset must have reinstalled the observer before another Start can run.");
|
|
fixture.Execution.PublishHotCompletion = true;
|
|
MethodInvocationResult start = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Start).ConfigureAwait(false);
|
|
Assert.That(start.OperationResult.StatusCode, Is.EqualTo(StatusCodes.Good));
|
|
Assert.That(fixture.Execution.DroppedUpdates, Is.Zero);
|
|
}
|
|
|
|
[Test]
|
|
public async Task FailedObservationRestartCanBeResetAgainAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
var halted = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
fixture.Runtime.Node.OnReportEvent = (_, _, value) =>
|
|
{
|
|
if (value is ProgramTransitionEventState transition &&
|
|
transition.ToState!.Id!.Value.TryGetValue(out NodeId state) &&
|
|
state == ObjectIds.ProgramStateMachineType_Halted)
|
|
{
|
|
halted.TrySetResult(true);
|
|
}
|
|
};
|
|
fixture.Execution.FailObservation();
|
|
await halted.Task.WaitAsync(TimeSpan.FromSeconds(10)).ConfigureAwait(false);
|
|
halted = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
fixture.Execution.OnObservationStarting =
|
|
() => throw new InvalidOperationException("Observer could not restart.");
|
|
MethodInvocationResult failedReset = await fixture.Runtime.ControlAsync(
|
|
fixture.Context, ProgramControlMethod.Reset).ConfigureAwait(false);
|
|
Assert.That(failedReset.OperationResult.StatusCode, Is.EqualTo(StatusCodes.BadUnexpectedError));
|
|
await halted.Task.WaitAsync(TimeSpan.FromSeconds(10)).ConfigureAwait(false);
|
|
Assert.That(fixture.Runtime.CurrentState, Is.EqualTo(ProgramState.Halted));
|
|
|
|
fixture.Execution.OnObservationStarting = null;
|
|
await fixture.CallAsync(ProgramControlMethod.Reset, ProgramState.Ready).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
}
|
|
|
|
[Test]
|
|
public async Task ObservationFailureHaltsAnUnstartedProgramAndResetRestartsObservationAsync()
|
|
{
|
|
await using Fixture fixture = await Fixture.CreateAsync().ConfigureAwait(false);
|
|
var halted = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
fixture.Runtime.Node.OnReportEvent = (_, _, value) =>
|
|
{
|
|
if (value is ProgramTransitionEventState transition &&
|
|
transition.ToState!.Id!.Value.TryGetValue(out NodeId state) &&
|
|
state == ObjectIds.ProgramStateMachineType_Halted)
|
|
{
|
|
halted.TrySetResult(true);
|
|
}
|
|
};
|
|
fixture.Execution.FailObservation();
|
|
await halted.Task.WaitAsync(TimeSpan.FromSeconds(10)).ConfigureAwait(false);
|
|
Assert.That(fixture.Runtime.RunId, Is.Zero);
|
|
await fixture.CallAsync(ProgramControlMethod.Reset, ProgramState.Ready).ConfigureAwait(false);
|
|
await fixture.CallAsync(ProgramControlMethod.Start, ProgramState.Running).ConfigureAwait(false);
|
|
Assert.That(fixture.Runtime.RunId, Is.EqualTo(1));
|
|
}
|
|
|
|
private sealed class Fixture : IAsyncDisposable
|
|
{
|
|
private Fixture(SystemContext context, ControlledExecution execution, ProgramRuntime runtime)
|
|
{
|
|
Context = context;
|
|
Execution = execution;
|
|
Runtime = runtime;
|
|
}
|
|
|
|
public SystemContext Context { get; }
|
|
|
|
public ControlledExecution Execution { get; }
|
|
|
|
public ProgramRuntime Runtime { get; }
|
|
|
|
public static async Task<Fixture> CreateAsync(
|
|
uint maxRecycles = uint.MaxValue,
|
|
bool diagnostics = false,
|
|
ProgramState initialState = ProgramState.Ready,
|
|
bool startObserving = true)
|
|
{
|
|
ITelemetryContext telemetry = NUnitTelemetryContext.Create();
|
|
var namespaces = new NamespaceTable();
|
|
namespaces.GetIndexOrAppend(global::Opc.Ua.Namespaces.OpcUa);
|
|
namespaces.GetIndexOrAppend("urn:program-tests");
|
|
namespaces.GetIndexOrAppend(global::Opc.Ua.Programs.Namespaces.OpcUaPrograms);
|
|
var context = new SystemContext(telemetry)
|
|
{
|
|
NamespaceUris = namespaces,
|
|
TypeTable = new TypeTable(namespaces)
|
|
};
|
|
var execution = new ControlledExecution();
|
|
var definition = new ProgramDefinition(
|
|
new ExpandedNodeId(ObjectTypes.ProgramStateMachineType),
|
|
static parent => new ProgramStateMachineState(parent),
|
|
new DelegateProgramProvider((_, _) => new ValueTask<IProgramExecution>(execution)),
|
|
[ProgramControlMethod.Start, ProgramControlMethod.Suspend, ProgramControlMethod.Resume,
|
|
ProgramControlMethod.Halt, ProgramControlMethod.Reset],
|
|
initialState, 1, maxRecycles)
|
|
{
|
|
Deletable = true,
|
|
DiagnosticsEnabled = diagnostics
|
|
};
|
|
var node = new ProgramStateMachineState(null);
|
|
node.Create(context, new NodeId("Program", 1),
|
|
new QualifiedName("Program", 1), new LocalizedText("Program"), false);
|
|
ProgramRuntime runtime = await ProgramRuntime.AttachAsync(
|
|
node, definition, context, TimeProvider.System, startObserving: startObserving)
|
|
.ConfigureAwait(false);
|
|
return new Fixture(context, execution, runtime);
|
|
}
|
|
|
|
public async Task CallAsync(ProgramControlMethod control, ProgramState expected)
|
|
{
|
|
MethodInvocationResult result = await Runtime.ControlAsync(Context, control).ConfigureAwait(false);
|
|
Assert.That(ServiceResult.IsGood(result.OperationResult), Is.True, result.OperationResult.ToString());
|
|
Assert.That(Runtime.CurrentState, Is.EqualTo(expected));
|
|
}
|
|
|
|
public ValueTask DisposeAsync()
|
|
{
|
|
return Runtime.DisposeAsync();
|
|
}
|
|
}
|
|
|
|
private sealed class ControlledExecution : IProgramExecution
|
|
{
|
|
public ServiceResult Result { get; set; } = ServiceResult.Good;
|
|
|
|
public int CallCount { get; private set; }
|
|
|
|
public bool Disposed { get; private set; }
|
|
|
|
public ArrayOf<Variant> Outputs { get; set; }
|
|
|
|
public bool PublishHotCompletion { get; set; }
|
|
|
|
public int DroppedUpdates { get; private set; }
|
|
|
|
public TaskCompletionSource<bool> ObservationStarted { get; private set; } =
|
|
new(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
|
|
public Action? OnObservationStarting { get; set; }
|
|
|
|
public ValueTask<ProgramControlResult> ControlAsync(
|
|
ProgramControlContext context, CancellationToken cancellationToken = default)
|
|
{
|
|
CallCount++;
|
|
if (context.Control == ProgramControlMethod.Reset && m_failed)
|
|
{
|
|
m_updates = Channel.CreateUnbounded<ProgramExecutionUpdate>();
|
|
ObservationStarted = new TaskCompletionSource<bool>(
|
|
TaskCreationOptions.RunContinuationsAsynchronously);
|
|
m_failed = false;
|
|
}
|
|
if (context.Control == ProgramControlMethod.Start && PublishHotCompletion)
|
|
{
|
|
if (ObservationStarted.Task.IsCompleted)
|
|
{
|
|
m_updates.Writer.TryWrite(new ProgramExecutionUpdate(context.RunId, ProgramState.Halted));
|
|
}
|
|
else
|
|
{
|
|
DroppedUpdates++;
|
|
}
|
|
}
|
|
return new ValueTask<ProgramControlResult>(new ProgramControlResult(Result, Outputs));
|
|
}
|
|
|
|
public void FailObservation()
|
|
{
|
|
m_failed = true;
|
|
m_updates.Writer.TryComplete(new InvalidOperationException("Simulated execution stream failure."));
|
|
}
|
|
|
|
public async IAsyncEnumerable<ProgramExecutionUpdate> ObserveAsync(
|
|
[EnumeratorCancellation] CancellationToken cancellationToken = default)
|
|
{
|
|
OnObservationStarting?.Invoke();
|
|
ObservationStarted.TrySetResult(true);
|
|
await foreach (ProgramExecutionUpdate update in
|
|
m_updates.Reader.ReadAllAsync(cancellationToken).ConfigureAwait(false))
|
|
{
|
|
yield return update;
|
|
}
|
|
}
|
|
|
|
public ValueTask DisposeAsync()
|
|
{
|
|
Disposed = true;
|
|
m_updates.Writer.TryComplete();
|
|
return default;
|
|
}
|
|
|
|
private Channel<ProgramExecutionUpdate> m_updates =
|
|
Channel.CreateUnbounded<ProgramExecutionUpdate>();
|
|
private bool m_failed;
|
|
}
|
|
|
|
private sealed class DeferredSynchronizationContext : SynchronizationContext
|
|
{
|
|
public override void Post(SendOrPostCallback callback, object? state)
|
|
{
|
|
m_callbacks.Enqueue(() => callback(state));
|
|
}
|
|
|
|
public void RunPostedCallbacks()
|
|
{
|
|
while (m_callbacks.Count != 0)
|
|
{
|
|
m_callbacks.Dequeue()();
|
|
}
|
|
}
|
|
|
|
private readonly Queue<Action> m_callbacks = new();
|
|
}
|
|
}
|
|
}
|