Files
UA-.NETStandard/tests/Opc.Ua.Subscriptions.Tests/MonitorItemsBatchTests.cs
romanett 9b034f8291 Enable nullable reference types centrally; migrate all unset and annotations-only projects (#4700)
# Description

Nullable reference types are now enabled once, in `common.props`, and
every project in the repository builds warning-clean with them.

**Configuration**
- `<Nullable>enable</Nullable>` lives in `common.props`. All per-project
`<Nullable>` settings are removed: 178 project files (enable,
annotations, and the `disable` in the three Aot test projects).
- 419 per-file `#nullable enable`/`restore` directives and the 4
`#nullable disable` directives are removed.
- Kept on purpose:
- The 5 `<auto-generated>` schema files (`UANodeSet.cs`, `UA Type
Dictionary.cs`, `OPCBinarySchema.cs`, `SecuredApplication.cs`,
`PInvokeHelper.cs`) keep `#nullable enable`. The compiler ignores the
project setting in generated code, so the directive is required there.
- `tests/Opc.Ua.Interop.LegacyPeer` keeps `disable`. It builds against
the 1.5.378 packages and does not import the repository props.
- `docs/DeveloperGuide.md` and `.github/copilot-instructions.md` now
describe the central setting.

**Migration** (the 43 unset and 13 annotations-only projects, roughly
10k diagnostics)
- **Production code: annotated at the declarations.** Covers
`tools/Opc.Ua.SourceGeneration.Core`, `src/Opc.Ua.Lds.Server` and the
LDS sample.
- Members, parameters and returns are nullable where null actually
flows.
- Null-check helpers carry `[NotNullWhen]` (`IsNull`, `IsValidXmlName`,
`IsMethodTypeDesign`).
- `CoreUtils.Format`, `Utils.Format`, `ITemplateWriter.WriteLine` take
`params object?[]`. `Template.AddReplacement` takes `string?` (rendering
already skips null replacements).
- `IRegisteredServerStore.RegisterAsync` returns
`Task<RegistrationEntry?>`: it returns null when a registration is
removed.
- Dereferences backed by an invariant (for example, the validated model)
use `!`, so runtime behaviour is unchanged.
- **Behavioural changes in production code** (small, deliberate):
- `NodeSetToModelDesign` throws `InvalidOperationException` when the
file is not a NodeSet. Before, it threw a NullReferenceException on the
next line.
- `ModelDesignValidator` starts its lookup tables empty instead of null.
A redundant `if (m_nodes == null) return;` guard is gone.
- **Test code: minimal annotations.**
  - `?` on values that can be null, `!` where the test asserts non-null.
  - `= null!` for fixture members assigned in SetUp.
- `TryGetStructure<T>(out T? x)` where the inferred `T?` broke the
`IEncodeable` constraint.
- A few redundant `== null` checks on structs (`NodeId`, `ArrayOf<T>`)
folded into the adjacent `IsNull`/`Count` checks.

**Notes for reviewers**
- The diff is large (~1,500 files) but almost entirely mechanical: `?`,
`!` and directive removal. The non-annotation changes are listed above.
- Known follow-up, not done here:
`IModelDesign.Namespaces/TargetNamespace/NamespaceUris` stay
non-nullable even though the validator returns null before it loads a
dictionary. Making them nullable would ripple through every generator
call site.

## Related Issues

- Fixes #4439

## Checklist

- [ ] 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.

The "no new warnings" box covers net10.0 and net48: full non-incremental
builds of `UA.slnx`, `tools/SourceGeneration.slnx`,
`tools/MigrationAnalyzer.slnx` and the Aot test projects finished with 0
warnings and 0 errors under the repository's warnings-as-errors
settings. net9.0 and net8.0 also had no nullable diagnostics, but they
were not rebuilt after the final fixes. Tests have not been run locally
yet.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-08 08:48:13 +02:00

498 lines
20 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;
using System.Collections.Generic;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Client.TestFramework;
namespace Opc.Ua.Subscriptions.Tests
{
/// <summary>
/// compliance tests for batch MonitoredItem operations including
/// batch create, modify, and delete of monitored items.
/// </summary>
[NonParallelizable]
[TestFixture]
[Category("Conformance")]
[Category("MonitoredItem")]
[Category("MonitorItemsBatch")]
public class MonitorItemsBatchTests : TestFixture
{
[SetUp]
public async Task SetUp()
{
m_subscriptionId = await CreateSetupSubscriptionAsync(
publishingInterval: 100, requestedLifetimeCount: 100,
requestedMaxKeepAliveCount: 10).ConfigureAwait(false);
}
[TearDown]
public async Task TearDown()
{
if (m_subscriptionId > 0)
{
try
{
await Session.DeleteSubscriptionsAsync(
null,
new uint[] { m_subscriptionId }.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
}
catch (ServiceResultException)
{
// Subscription may already be deleted
}
m_subscriptionId = 0;
}
}
[Test]
public async Task BatchCreateTenItemsOnDifferentNodesAsync()
{
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 10; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(ToNodeId(eni), (uint)(100 + i)));
}
CreateMonitoredItemsResponse resp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(resp.Results.Count, Is.EqualTo(10));
int goodCount = resp.Results.ToArray()!
.Count(r => StatusCode.IsGood(r.StatusCode));
Assert.That(goodCount, Is.EqualTo(10),
"All 10 items on different nodes should be created.");
}
[Test]
public async Task BatchCreateTenItemsOnSameNodeAsync()
{
NodeId nodeId = ToNodeId(Constants.ScalarStaticInt32);
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 10; i++)
{
items.Add(CreateItemRequest(nodeId, (uint)(200 + i)));
}
CreateMonitoredItemsResponse resp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(resp.Results.Count, Is.EqualTo(10));
int goodCount = resp.Results.ToArray()!
.Count(r => StatusCode.IsGood(r.StatusCode));
Assert.That(goodCount, Is.GreaterThan(0),
"At least some items on the same node should succeed.");
}
[Test]
public async Task BatchCreateMixOfValidAndInvalidNodesAsync()
{
var items = new List<MonitoredItemCreateRequest>
{
CreateItemRequest(
ToNodeId(Constants.ScalarStaticInt32), 300),
CreateItemRequest(
Constants.InvalidNodeId, 301),
CreateItemRequest(
ToNodeId(Constants.ScalarStaticDouble), 302),
CreateItemRequest(
Constants.InvalidNodeId, 303),
CreateItemRequest(
ToNodeId(Constants.ScalarStaticString), 304)
};
CreateMonitoredItemsResponse resp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(resp.Results.Count, Is.EqualTo(5));
// Valid nodes should succeed
Assert.That(
StatusCode.IsGood(resp.Results[0].StatusCode), Is.True);
Assert.That(
StatusCode.IsGood(resp.Results[2].StatusCode), Is.True);
Assert.That(
StatusCode.IsGood(resp.Results[4].StatusCode), Is.True);
// Invalid nodes should fail
Assert.That(
StatusCode.IsGood(resp.Results[1].StatusCode), Is.False);
Assert.That(
StatusCode.IsGood(resp.Results[3].StatusCode), Is.False);
}
[Test]
public async Task BatchCreateWithVaryingSamplingIntervalsAsync()
{
var items = new List<MonitoredItemCreateRequest>();
double[] intervals =
[0, 50, 100, 250, 500, 1000, 2000, 5000, 10000, -1];
for (int i = 0; i < 10; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(
ToNodeId(eni), (uint)(400 + i),
samplingInterval: intervals[i]));
}
CreateMonitoredItemsResponse resp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(resp.Results.Count, Is.EqualTo(10));
foreach (MonitoredItemCreateResult r in resp.Results)
{
Assert.That(StatusCode.IsGood(r.StatusCode), Is.True);
Assert.That(r.RevisedSamplingInterval,
Is.GreaterThanOrEqualTo(0.0));
}
}
[Test]
public async Task BatchModifyTenItemsSamplingIntervalAsync()
{
// Create 10 items first
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 10; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(
ToNodeId(eni), (uint)(500 + i), samplingInterval: 1000));
}
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(createResp.Results.Count, Is.EqualTo(10));
// Build modify requests
var modItems = new List<MonitoredItemModifyRequest>();
for (int i = 0; i < 10; i++)
{
modItems.Add(new MonitoredItemModifyRequest
{
MonitoredItemId = createResp.Results[i].MonitoredItemId,
RequestedParameters = new MonitoringParameters
{
ClientHandle = (uint)(500 + i),
SamplingInterval = 250,
QueueSize = 10,
DiscardOldest = true
}
});
}
ModifyMonitoredItemsResponse modResp =
await Session.ModifyMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
modItems.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(modResp.Results.Count, Is.EqualTo(10));
foreach (MonitoredItemModifyResult r in modResp.Results)
{
Assert.That(StatusCode.IsGood(r.StatusCode), Is.True);
Assert.That(r.RevisedSamplingInterval,
Is.GreaterThanOrEqualTo(0.0));
}
}
[Test]
public async Task BatchModifyTenItemsQueueSizeAsync()
{
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 10; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(
ToNodeId(eni), (uint)(600 + i), queueSize: 5));
}
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(createResp.Results.Count, Is.EqualTo(10));
var modItems = new List<MonitoredItemModifyRequest>();
for (int i = 0; i < 10; i++)
{
modItems.Add(new MonitoredItemModifyRequest
{
MonitoredItemId = createResp.Results[i].MonitoredItemId,
RequestedParameters = new MonitoringParameters
{
ClientHandle = (uint)(600 + i),
SamplingInterval = 100,
QueueSize = 20,
DiscardOldest = true
}
});
}
ModifyMonitoredItemsResponse modResp =
await Session.ModifyMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
modItems.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(modResp.Results.Count, Is.EqualTo(10));
foreach (MonitoredItemModifyResult r in modResp.Results)
{
Assert.That(StatusCode.IsGood(r.StatusCode), Is.True);
Assert.That(r.RevisedQueueSize, Is.GreaterThan(0u));
}
}
[Test]
public async Task BatchModifyMixOfValidAndInvalidIdsAsync()
{
NodeId nodeId = ToNodeId(Constants.ScalarStaticInt32);
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
new MonitoredItemCreateRequest[]
{
CreateItemRequest(nodeId, 700)
}.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
uint validId = createResp.Results[0].MonitoredItemId;
var modItems = new MonitoredItemModifyRequest[]
{
new() {
MonitoredItemId = validId,
RequestedParameters = new MonitoringParameters
{
ClientHandle = 700,
SamplingInterval = 500,
QueueSize = 10,
DiscardOldest = true
}
},
new() {
MonitoredItemId = 999999,
RequestedParameters = new MonitoringParameters
{
ClientHandle = 701,
SamplingInterval = 500,
QueueSize = 10,
DiscardOldest = true
}
}
};
ModifyMonitoredItemsResponse modResp =
await Session.ModifyMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
modItems.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(modResp.Results.Count, Is.EqualTo(2));
Assert.That(
StatusCode.IsGood(modResp.Results[0].StatusCode), Is.True);
Assert.That(
StatusCode.IsGood(modResp.Results[1].StatusCode), Is.False,
"Invalid monitored item ID should fail.");
}
[Test]
public async Task BatchDeleteTenItemsAsync()
{
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 10; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(ToNodeId(eni), (uint)(800 + i)));
}
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(createResp.Results.Count, Is.EqualTo(10));
uint[] monIds = [.. createResp.Results.ToArray()!.Select(r => r.MonitoredItemId)];
DeleteMonitoredItemsResponse delResp =
await Session.DeleteMonitoredItemsAsync(
null, m_subscriptionId, monIds.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(delResp.Results.Count, Is.EqualTo(10));
foreach (StatusCode sc in delResp.Results)
{
Assert.That(StatusCode.IsGood(sc), Is.True);
}
}
[Test]
public async Task BatchDeleteMixOfValidAndInvalidIdsAsync()
{
NodeId nodeId = ToNodeId(Constants.ScalarStaticInt32);
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
new MonitoredItemCreateRequest[]
{
CreateItemRequest(nodeId, 900)
}.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
uint validId = createResp.Results[0].MonitoredItemId;
uint[] ids = [validId, 999998, 999999];
DeleteMonitoredItemsResponse delResp =
await Session.DeleteMonitoredItemsAsync(
null, m_subscriptionId, ids.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
Assert.That(delResp.Results.Count, Is.EqualTo(3));
Assert.That(StatusCode.IsGood(delResp.Results[0]), Is.True);
Assert.That(StatusCode.IsGood(delResp.Results[1]), Is.False);
Assert.That(StatusCode.IsGood(delResp.Results[2]), Is.False);
}
[Test]
public async Task BatchDeleteThenVerifyNoMoreNotificationsAsync()
{
var items = new List<MonitoredItemCreateRequest>();
for (int i = 0; i < 5; i++)
{
ExpandedNodeId eni = Constants.ScalarStaticNodes[
i % Constants.ScalarStaticNodes.Length];
items.Add(CreateItemRequest(
ToNodeId(eni), (uint)(1000 + i), samplingInterval: 50));
}
CreateMonitoredItemsResponse createResp =
await Session.CreateMonitoredItemsAsync(
null, m_subscriptionId, TimestampsToReturn.Both,
items.ToArray().ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
// Consume initial notifications
await Task.Delay(300).ConfigureAwait(false);
await Session.PublishWithTimeoutAsync().ConfigureAwait(false);
// Delete all items
uint[] monIds = [.. createResp.Results.ToArray()!.Select(r => r.MonitoredItemId)];
await Session.DeleteMonitoredItemsAsync(
null, m_subscriptionId, monIds.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
// Write to trigger potential notifications
NodeId writeNode = ToNodeId(Constants.ScalarStaticInt32);
WriteResponse writeResp = await Session.WriteAsync(
null,
new WriteValue[]
{
new() {
NodeId = writeNode,
AttributeId = Attributes.Value,
Value = new DataValue(Variant.From(42))
}
}.ToArrayOf(),
CancellationToken.None).ConfigureAwait(false);
await Task.Delay(300).ConfigureAwait(false);
PublishResponse pubResp = await Session.PublishWithTimeoutAsync().ConfigureAwait(false);
Assert.That(
StatusCode.IsGood(pubResp.ResponseHeader.ServiceResult),
Is.True);
Assert.That(
pubResp.NotificationMessage.NotificationData.Count,
Is.Zero,
"After deleting all items, publish should return keep-alive.");
}
private MonitoredItemCreateRequest CreateItemRequest(
NodeId nodeId,
uint clientHandle,
double samplingInterval = 100,
uint queueSize = 10,
MonitoringMode mode = MonitoringMode.Reporting,
uint attributeId = Attributes.Value,
bool discardOldest = true,
ExtensionObject filter = default,
TimestampsToReturn timestamps = TimestampsToReturn.Both)
{
return new MonitoredItemCreateRequest
{
ItemToMonitor = new ReadValueId
{
NodeId = nodeId,
AttributeId = attributeId
},
MonitoringMode = mode,
RequestedParameters = new MonitoringParameters
{
ClientHandle = clientHandle,
SamplingInterval = samplingInterval,
Filter = filter,
DiscardOldest = discardOldest,
QueueSize = queueSize
}
};
}
private uint m_subscriptionId;
}
}