Files
UA-.NETStandard/samples/MachineTool/MachineToolClient/Program.cs
T
Marc Schier 0374e19121 Add MachineTool, WMTP, GMS and CranesHoists companions (#4765)
# Description

_Describe the changes here to communicate to the maintainers why they
should accept this pull request. By default - this will become the
Commit message after merging and thus define history._

Add provider-backed MachineTool, bundled WMTP, GMS and CranesHoists
companions using the existing Machinery/MachineVision fluent, DI and
typed-client approach. **The PR is open/non-draft by user choice.
Current head `ecc4a7d6ca3e8004cf28ab54da605da302d026bf` is mergeable and
has 108 successful checks, six intentionally skipped checks, zero
failures and zero pending checks. All five primary workflows completed
successfully at that exact head.**

| Family | Released specification/model | Packaging |
| --- | --- | --- |
| MachineTool | OPC 40501-1, 1.02.0 | Model, Server, Client and MCP;
normal root versions |
| WMTP | OPC 40505, 1.0.0 | Bundled in MachineTool; distinct CLR/wire
namespace and independent WMTP-only hosting |
| GMS | OPC 40210 reference 1.0.1, normative model 1.0.0 | Model,
Server, Client and MCP; normal root versions |
| CranesHoists | OPC 40020-1, 1.00 | Model, Server, Client and MCP; all
four plus Debug variants forced preview |

There are **12 new packable projects**. No separate WMTP
package/profile/guide, root version bump, tag, release or package
publication is included. Mandatory instance structure is the default;
selected optional features require explicit providers. The
implementation reuses Machinery results/jobs/files/ProcessValues and
Robotics topology, including retained MachineTool Production, defined
GMS jobs/parts, modern ISA95/Machinery jobs, shared-owner hosting and
isolated instances alongside MachineVision.

Runtime and integration fixes preserve raw quality/timestamps, coherent
acquisition, namespace ownership, accepted-configuration state,
borrowed-resource lifetime, session/node/file cleanup, terminal-value
publication, event propagation and endpoint-aware capability
publication. Firmware/licence transfer means provider acceptance, not
installation/activation. Cancellation does not silently abort another
caller's operation. The later upstream MCP expansion is integrated
without losing either family set or its default-off privileged/live
execution policy.

### Conformance and scope

Canonical model inputs are pinned to UA-Nodeset revision
`96a08945425d0295edb3607d2a38f6841ef44046`.

**GMS upstream exception:** [Annex
A.1](https://reference.opcfoundation.org/specs/OPC-40210/annex-a) makes
the released NodeSet normative, but §12.3.2.7 requires undefined
`GMS_ProductionStatisticsType`. Inherited statistics and defined
jobs/parts are implemented without inventing a standard type/NodeId; the
complete GMS Production facet is withheld.

The requirement ledger records **102 positively evidenced CU rows, 96
directly negative-tested rows and six explicit negative-evidence
limitations**. All 648 test-class/name/TRX links were independently
resolved to passing cases. The six limitations concern Stacklight,
retained legacy PowerOnDuration, Machinery PowerOnDuration, WorkingUnit,
Obligation and MaintenanceMode. They are not claims that every
invalid-input or hardware-control behavior was tested. The undefined GMS
requirement is outside the 102 defined CUs. No external certification
claim is made.

Retained baseline complete-assembly line coverage, with generated code
retained and no source exclusions:

| Family | Model | Server | Client |
| --- | ---: | ---: | ---: |
| MachineTool/WMTP | 83.80% | 91.98% | 84.74% |
| GMS | 95.51% | 90.63% | 88.38% |
| CranesHoists | 92.76% | 94.45% | 92.24% |

These nine measurements predate the later focused review fixes and
merges; they are not relabelled as new `ecc4a7d6c` percentages. The
current head's separate CI code-coverage check succeeded. No new
exclusions or threshold relaxations were introduced.

## Related Issues

- Fixes
[#4764](https://github.com/OPCFoundation/UA-.NETStandard/issues/4764),
the implementation/design and acceptance tracker.

## 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.
- [x] 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.
- [ ] 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.
- [x] I have addressed **all** PR feedback received.
2026-10-15 15:15:46 +02:00

189 lines
8.5 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.Threading;
using System.Threading.Tasks;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Opc.Ua;
using Opc.Ua.Client;
using Opc.Ua.MachineTool.Client;
using TypedClient = Opc.Ua.MachineTool.Client.MachineToolClient;
namespace MachineToolSample.Client
{
/// <summary>
/// Runs one bounded, passive-by-default workflow through a managed session and the typed client factory.
/// </summary>
internal static class Program
{
/// <summary>
/// Validates local consent before allocating resources and reports cancellation separately.
/// </summary>
private static async Task<int> Main(string[] args)
{
if (Array.IndexOf(args, "--help") >= 0 || Array.IndexOf(args, "-h") >= 0)
{
ClientOptions.PrintHelp();
return 0;
}
using var cancelled = new CancellationTokenSource();
void Cancel(object? _, ConsoleCancelEventArgs eventArgs)
{
eventArgs.Cancel = true;
cancelled.Cancel();
}
Console.CancelKeyPress += Cancel;
try
{
ClientOptions options = ClientOptions.Parse(ArrayOf.Wrapped(args));
if (options.CancelAfterMilliseconds.HasValue)
{
cancelled.CancelAfter(options.CancelAfterMilliseconds.Value);
}
await RunAsync(options, cancelled.Token).ConfigureAwait(false);
return 0;
}
catch (OperationCanceledException) when (cancelled.IsCancellationRequested)
{
Console.WriteLine("CANCELLED: local request cancelled; no implicit AbortOperation or command retry.");
return 2;
}
catch (Exception exception)
{
await Console.Error.WriteLineAsync(exception.ToString()).ConfigureAwait(false);
return 1;
}
finally
{
Console.CancelKeyPress -= Cancel;
}
}
/// <summary>
/// Keeps secure endpoint selection and certificate validation, and releases all owned sessions on every path.
/// </summary>
private static async Task RunAsync(ClientOptions options, CancellationToken cancellationToken)
{
TimeProvider clock = TimeProvider.System;
using CancellationTokenSource deadline =
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(90));
using var linked = CancellationTokenSource.CreateLinkedTokenSource(cancellationToken, deadline.Token);
CancellationToken ct = linked.Token;
HostApplicationBuilder builder = Host.CreateApplicationBuilder();
builder.Logging.ClearProviders();
builder.Logging.AddConsole();
builder.Logging.SetMinimumLevel(LogLevel.Warning);
builder.Logging.AddFilter("MachineToolSample", LogLevel.Information);
builder.Services.AddSingleton(clock);
builder.Services.AddOpcUa()
.AddClient(client =>
{
client.ApplicationName = "MachineToolClient";
client.ApplicationUri = "urn:localhost:OPCFoundation:MachineToolClient";
client.ProductUri = "uri:opcfoundation.org:MachineToolClient";
client.PkiRoot = options.PkiRoot;
client.AutoAcceptUntrustedCertificates = options.DemoTrust;
client.Session = new ManagedSessionOptions
{
SessionName = "MachineToolClient",
SessionTimeout = TimeSpan.FromSeconds(30),
CheckDomain = true,
TimeProvider = clock
};
})
.AddDiscoveryAndConnect(discovery =>
{
discovery.DiscoveryUrl = options.Endpoint;
discovery.SecurityMode = MessageSecurityMode.SignAndEncrypt;
discovery.SecurityPolicyUri = SecurityPolicies.Basic256Sha256;
})
.AddMachineToolClient();
IHost host = builder.Build();
await using (((IAsyncDisposable)host).ConfigureAwait(false))
{
ILogger logger = host.Services.GetRequiredService<ITelemetryContext>().CreateLogger<ClientOptions>();
if (options.DemoTrust)
{
logger.LocalDemoTrust();
}
try
{
await host.StartAsync(ct).ConfigureAwait(false);
TypedClient client = await host.Services.GetRequiredService<MachineToolClientFactory>()
.CreateAsync(ct).ConfigureAwait(false);
ManagedSession session = client.Session as ManagedSession ??
throw new InvalidOperationException("The configured factory did not return a managed session.");
try
{
await DemoReader.RunAsync(client, options, ct).ConfigureAwait(false);
}
finally
{
try
{
using CancellationTokenSource close =
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(10));
await session.CloseAsync(close.Token).ConfigureAwait(false);
}
finally
{
await client.DisposeAsync().ConfigureAwait(false);
await session.DisposeAsync().ConfigureAwait(false);
}
Console.WriteLine($"SESSION_CLOSED connected={session.Connected} disposed={session.Disposed}");
}
}
finally
{
using CancellationTokenSource cleanup =
TimeProviderExtensions.CreateCancellationTokenSource(clock, TimeSpan.FromSeconds(20));
await host.StopAsync(cleanup.Token).ConfigureAwait(false);
}
}
Console.WriteLine("CLIENT_COMPLETE: observations, session and application host disposed.");
}
}
/// <summary>
/// Source-generated client policy diagnostics.
/// </summary>
internal static partial class ProgramLog
{
/// <summary>
/// Makes the loopback-only trust exception visible without changing message-security selection.
/// </summary>
[LoggerMessage(EventId = MachineToolClientEventIds.Program, Level = LogLevel.Warning,
Message = "LOCAL SIMULATION ONLY: unknown server certificates accepted; SignAndEncrypt still required.")]
public static partial void LocalDemoTrust(this ILogger logger);
}
}