Files
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

1236 lines
49 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.Threading;
using System.Threading.Tasks;
using Moq;
using NUnit.Framework;
using Opc.Ua.Client.TestFramework;
namespace Opc.Ua.Client.Tests
{
[TestFixture]
[Category("Client")]
[Category("Session")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public sealed class NodeCacheContextTests
{
[Test]
public async Task FetchValuesAsyncShouldReturnResultSetAsync()
{
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
ArrayOf<DataValue> dataValues =
[
new DataValue(new Variant(123), StatusCodes.Good, DateTime.UtcNow),
new DataValue(new Variant(456), StatusCodes.Good, DateTime.UtcNow)
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = dataValues,
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
ResultSet<DataValue> result = await sut.FetchValuesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.EqualTo(dataValues));
Assert.That(result.Errors.ToList(), Is.All.EqualTo(ServiceResult.Good));
}
[Test]
public async Task FetchValueAsyncShouldReturnDataValueAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var dataValue = new DataValue(new Variant(123), StatusCodes.Good, DateTime.UtcNow);
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = [dataValue],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
DataValue result = await sut.FetchValueAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(result, Is.EqualTo(dataValue));
session.Channel.Verify();
}
[Test]
public async Task FetchValuesAsyncShouldReturnEmptyResultSetForEmptyNodeIdsAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds = [];
// Act
ResultSet<DataValue> result = await sut.FetchValuesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.Empty);
Assert.That(result.Errors, Is.Empty);
}
[Test]
public void FetchValueAsyncShouldThrowServiceResultExceptionForBadStatusCode()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var dataValue = new DataValue(new Variant(123), StatusCodes.Bad, DateTime.UtcNow);
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = [dataValue],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
Assert.ThrowsAsync<ServiceResultException>(async () => await sut.FetchValueAsync(
null,
nodeId,
CancellationToken.None).ConfigureAwait(false));
session.Channel.Verify();
}
[Test]
public async Task FetchValuesAsyncShouldReturnErrorsForBadStatusCodesAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
ArrayOf<DataValue> dataValues =
[
new DataValue(new Variant(123), StatusCodes.Bad, DateTime.UtcNow),
new DataValue(new Variant(456), StatusCodes.Good, DateTime.UtcNow)
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = dataValues,
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
ResultSet<DataValue> result = await sut.FetchValuesAsync(
null,
nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.EqualTo(dataValues));
Assert.That(result.Errors[0].StatusCode, Is.EqualTo(StatusCodes.Bad));
Assert.That(result.Errors[1].StatusCode, Is.EqualTo(StatusCodes.Good));
}
[Test]
public void FetchValueAsyncShouldHandleCancellation()
{
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(
async () => await sut.FetchValueAsync(null, nodeId, cts.Token).ConfigureAwait(false));
}
[Test]
public void FetchValuesAsyncShouldHandleCancellation()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(
async () => _ = await sut.FetchValuesAsync(null, nodeIds, cts.Token).ConfigureAwait(false));
}
[Test]
public async Task FetchValueAsyncShouldProcessDiagnosticInfoAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var dataValue = new DataValue(new Variant(123), StatusCodes.Good, DateTime.UtcNow);
var diagnosticInfo = new DiagnosticInfo();
ArrayOf<DiagnosticInfo> diagnosticInfos = [diagnosticInfo];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = [dataValue],
DiagnosticInfos = diagnosticInfos
}))
.Verifiable(Times.Once);
// Act
DataValue result = await sut.FetchValueAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(result, Is.EqualTo(dataValue));
Assert.That(diagnosticInfos.ToList(), Contains.Item(diagnosticInfo));
session.Channel.Verify();
}
[Test]
public async Task FetchValuesAsyncShouldProcessDiagnosticInfoAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
ArrayOf<DataValue> dataValues =
[
new DataValue(new Variant(123), StatusCodes.Good, DateTime.UtcNow),
new DataValue(new Variant(456), StatusCodes.Good, DateTime.UtcNow)
];
var diagnosticInfo = new DiagnosticInfo();
ArrayOf<DiagnosticInfo> diagnosticInfos = [diagnosticInfo, diagnosticInfo];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new ReadResponse
{
Results = dataValues,
DiagnosticInfos = diagnosticInfos
}))
.Verifiable(Times.Once);
// Act
ResultSet<DataValue> result = await sut.FetchValuesAsync(
null,
nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.EqualTo(dataValues));
Assert.That(result.Errors.ToList(), Is.All.EqualTo(ServiceResult.Good));
Assert.That(diagnosticInfos.ToList(), Contains.Item(diagnosticInfo));
session.Channel.Verify();
}
[Test]
public async Task FetchNodesAsyncShouldReturnResultSetAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
VariableNode[] nodes =
[
new VariableNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType1"),
Description = LocalizedText.From("TestDescription1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
UserAccessLevel = 1
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType2"),
Description = LocalizedText.From("TestDescription2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
if (r.NodeId == nodeIds[0])
{
nodes[0].Read(null!, r.AttributeId, ref value);
}
else
{
nodes[1].Read(null!, r.AttributeId, ref value);
}
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = []
});
})
.Verifiable(Times.Exactly(2));
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(nodes[0], result.Results[0]), Is.True);
Assert.That(Utils.IsEqual(nodes[1], result.Results[1]), Is.True);
Assert.That(result.Errors.ToList(), Is.All.EqualTo(ServiceResult.Good));
}
[Test]
public async Task FetchNodesAsyncShouldReturnResultSetWhenOptionalAttributesMissingAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
VariableNode[] nodes =
[
new VariableNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType1"),
Description = LocalizedText.From("TestDescription1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
UserAccessLevel = 1
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType2"),
Description = LocalizedText.From("TestDescription2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
if (r.AttributeId == Attributes.MinimumSamplingInterval)
{
return DataValue.FromStatusCode(StatusCodes.BadNotReadable);
}
if (r.AttributeId == Attributes.Description)
{
return DataValue.FromStatusCode(StatusCodes.BadAttributeIdInvalid);
}
if (r.NodeId == nodeIds[0])
{
nodes[0].Read(null!, r.AttributeId, ref value);
}
else
{
nodes[1].Read(null!, r.AttributeId, ref value);
}
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = []
});
})
.Verifiable(Times.Exactly(2));
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(nodes[0], result.Results[0]), Is.False);
Assert.That(Utils.IsEqual(nodes[1], result.Results[1]), Is.False);
Assert.That(result.Errors.ToList(), Is.All.EqualTo(ServiceResult.Good));
}
[Test]
public async Task FetchNodeAsyncShouldReturnNodeAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var node = new VariableNode
{
NodeId = nodeId,
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType"),
Description = LocalizedText.From("TestDescription"),
DisplayName = LocalizedText.From("TestDisplayName"),
BrowseName = QualifiedName.From("TestBrowseName"),
UserAccessLevel = 1
};
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
node.Read(null!, r.AttributeId, ref value);
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = []
});
})
.Verifiable(Times.Once);
// Act
Node result = await sut.FetchNodeAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(Utils.IsEqual(node, result), Is.True);
session.Channel.Verify();
}
[Test]
public async Task FetchNodesAsyncShouldReturnEmptyResultSetForEmptyNodeIdsAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds = [];
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.Empty);
Assert.That(result.Errors, Is.Empty);
}
[Test]
public void FetchNodeAsyncShouldThrowServiceResultExceptionForBadStatusCode()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var node = new VariableNode
{
NodeId = nodeId,
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType"),
Description = LocalizedText.From("TestDescription"),
DisplayName = LocalizedText.From("TestDisplayName"),
BrowseName = QualifiedName.From("TestBrowseName"),
UserAccessLevel = 1
};
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
new ValueTask<IServiceResponse>(new ReadResponse
{
Results = request.NodesToRead
.ConvertAll(r => DataValue.FromStatusCode(StatusCodes.BadAlreadyExists)),
DiagnosticInfos = request.NodesToRead.ConvertAll(_ => new DiagnosticInfo())
}))
.Verifiable(Times.Once);
ServiceResultException sre = Assert.ThrowsAsync<ServiceResultException>(
async () => await sut.FetchNodeAsync(null, nodeId,
NodeClass.Unspecified).ConfigureAwait(false));
Assert.That(sre.StatusCode, Is.EqualTo(StatusCodes.BadAlreadyExists));
session.Channel.Verify();
}
[Test]
public async Task FetchNodesAsyncShouldReturnErrorsForBadStatusCodesAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
VariableNode[] nodes =
[
new VariableNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType1"),
Description = LocalizedText.From("TestDescription1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
UserAccessLevel = 1
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType2"),
Description = LocalizedText.From("TestDescription2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead.ConvertAll(r =>
{
if (r.NodeId == nodeIds[0])
{
var value = new DataValue();
nodes[0].Read(null!, r.AttributeId, ref value);
return value;
}
return DataValue.FromStatusCode(StatusCodes.BadUnexpectedError);
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = [.. results.ConvertAll(r => new DiagnosticInfo())]
});
})
.Verifiable(Times.Exactly(2));
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(nodes[0], result.Results[0]), Is.True);
Assert.That(Utils.IsEqual(nodes[1], result.Results[1]), Is.False);
Assert.That(result.Errors.Count, Is.EqualTo(2));
Assert.That(result.Errors[0], Is.EqualTo(ServiceResult.Good));
Assert.That(result.Errors[1].StatusCode, Is.EqualTo(StatusCodes.BadUnexpectedError));
}
[Test]
public async Task FetchNodesAsyncShouldReturnErrorsForBadNodeClassTypeAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
VariableNode[] nodes =
[
new VariableNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType1"),
Description = LocalizedText.From("TestDescription1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
UserAccessLevel = 1
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType2"),
Description = LocalizedText.From("TestDescription2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
if (r.AttributeId == Attributes.NodeClass)
{
return new DataValue(new Variant("Badclass"));
}
var value = new DataValue();
if (r.NodeId == nodeIds[0])
{
nodes[0].Read(null!, r.AttributeId, ref value);
}
else
{
nodes[1].Read(null!, r.AttributeId, ref value);
}
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = results.ConvertAll(r => new DiagnosticInfo())
});
})
.Verifiable(Times.Exactly(2));
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(nodes[0], result.Results[0]), Is.False);
Assert.That(Utils.IsEqual(nodes[1], result.Results[1]), Is.False);
Assert.That(result.Errors.Count, Is.EqualTo(2));
Assert.That(result.Errors[0].StatusCode, Is.EqualTo(StatusCodes.BadUnexpectedError));
Assert.That(result.Errors[1].StatusCode, Is.EqualTo(StatusCodes.BadUnexpectedError));
}
/// <summary>
/// L9-7: reading with a NodeClass hint that does not match the node's
/// real NodeClass threw KeyNotFoundException out of the whole batch
/// instead of failing just that node.
/// </summary>
[Test]
public async Task FetchNodesAsyncWithMismatchedNodeClassFailsOnlyThatNodeAsync()
{
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=Object"),
NodeId.Parse("ns=2;s=Variable")
];
Node[] nodes =
[
new ObjectNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Object,
DisplayName = LocalizedText.From("Object"),
BrowseName = QualifiedName.From("Object")
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType"),
DisplayName = LocalizedText.From("Variable"),
BrowseName = QualifiedName.From("Variable"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
(r.NodeId == nodeIds[0] ? nodes[0] : nodes[1])
.Read(null!, r.AttributeId, ref value);
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = results.ConvertAll(r => new DiagnosticInfo())
});
});
ResultSet<Node> result = await sut
.FetchNodesAsync(null, nodeIds, NodeClass.Variable)
.ConfigureAwait(false);
Assert.That(result.Errors.Count, Is.EqualTo(2));
Assert.That(
result.Errors[0].StatusCode,
Is.EqualTo((StatusCode)StatusCodes.BadNodeClassInvalid));
Assert.That(ServiceResult.IsGood(result.Errors[1]), Is.True);
Assert.That(result.Results[1].NodeClass, Is.EqualTo(NodeClass.Variable));
}
[Test]
public void FetchNodeAsyncShouldHandleCancellation()
{
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(async () =>
await sut.FetchNodeAsync(null, nodeId, ct: cts.Token).ConfigureAwait(false));
}
[Test]
public void FetchNodesAsyncShouldHandleCancellation()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(async () => _ = await sut.FetchNodesAsync(
null,
nodeIds,
NodeClass.Unspecified,
ct: cts.Token).ConfigureAwait(false));
}
[Test]
public async Task FetchNodeAsyncShouldProcessDiagnosticInfoAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var node = new VariableNode
{
NodeId = nodeId,
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType"),
Description = LocalizedText.From("TestDescription"),
DisplayName = LocalizedText.From("TestDisplayName"),
BrowseName = QualifiedName.From("TestBrowseName"),
UserAccessLevel = 1
};
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
node.Read(null!, r.AttributeId, ref value);
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = results.ConvertAll(_ => new DiagnosticInfo())
});
})
.Verifiable(Times.Once);
// Act
Node result = await sut.FetchNodeAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(Utils.IsEqual(node, result), Is.True);
session.Channel.Verify();
}
[Test]
public async Task FetchNodesAsyncShouldProcessDiagnosticInfoAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
VariableNode[] nodes =
[
new VariableNode
{
NodeId = nodeIds[0],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType1"),
Description = LocalizedText.From("TestDescription1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
UserAccessLevel = 1
},
new VariableNode
{
NodeId = nodeIds[1],
NodeClass = NodeClass.Variable,
AccessLevel = 1,
DataType = NodeId.Parse("ns=2;s=TestDataType2"),
Description = LocalizedText.From("TestDescription2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
UserAccessLevel = 1
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<ReadRequest>(),
It.IsAny<CancellationToken>()))
.Returns<ReadRequest, CancellationToken>((request, ct) =>
{
ArrayOf<DataValue> results = request.NodesToRead
.ConvertAll(r =>
{
var value = new DataValue();
if (r.NodeId == nodeIds[0])
{
nodes[0].Read(null!, r.AttributeId, ref value);
}
else
{
nodes[1].Read(null!, r.AttributeId, ref value);
}
return value;
});
return new ValueTask<IServiceResponse>(new ReadResponse
{
Results = results,
DiagnosticInfos = results.ConvertAll(r => new DiagnosticInfo())
});
})
.Verifiable(Times.Exactly(2));
// Act
ResultSet<Node> result = await sut.FetchNodesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(nodes[0], result.Results[0]), Is.True);
Assert.That(Utils.IsEqual(nodes[1], result.Results[1]), Is.True);
Assert.That(result.Errors.Count, Is.EqualTo(2));
Assert.That(result.Errors.ToList(), Is.All.EqualTo(ServiceResult.Good));
session.Channel.Verify();
}
[Test]
public async Task FetchReferencesAsyncShouldReturnResultSetAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
ArrayOf<ReferenceDescription> references =
[
new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
NodeClass = NodeClass.Variable
},
new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
NodeClass = NodeClass.Variable
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new BrowseResponse
{
Results =
[
new BrowseResult
{
References = references
}
],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
ArrayOf<ReferenceDescription> result = await sut.FetchReferencesAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(result, Is.EqualTo(references));
session.Channel.Verify();
}
[Test]
public async Task FetchReferencesAsyncShouldReturnEmptyResultSetForEmptyNodeIdsAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeIds = ArrayOf.Empty<NodeId>();
// Act
ResultSet<ArrayOf<ReferenceDescription>> result =
await sut.FetchReferencesAsync(null, nodeIds).ConfigureAwait(false);
// Assert
Assert.That(result.Results, Is.Empty);
Assert.That(result.Errors, Is.Empty);
}
[Test]
public async Task FetchReferencesAsyncShouldReturnErrorsForBadStatusCodesAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
ArrayOf<ReferenceDescription> references =
[
new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
NodeClass = NodeClass.Variable
},
new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode2"),
BrowseName = QualifiedName.From("TestBrowseName2"),
DisplayName = LocalizedText.From("TestDisplayName2"),
NodeClass = NodeClass.Variable
}
];
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new BrowseResponse
{
Results =
[
new BrowseResult
{
References = references,
StatusCode = StatusCodes.Bad
},
new BrowseResult
{
References = references,
StatusCode = StatusCodes.Bad
}
],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
ResultSet<ArrayOf<ReferenceDescription>> result = await sut.FetchReferencesAsync(null, nodeIds,
CancellationToken.None).ConfigureAwait(false);
// Assert
Assert.That(result.Results.Count, Is.EqualTo(2));
Assert.That(Utils.IsEqual(result.Results[0], references), Is.True);
Assert.That(Utils.IsEqual(result.Results[1], references), Is.True);
Assert.That(result.Errors.Count, Is.EqualTo(2));
Assert.That(result.Errors[0].StatusCode, Is.EqualTo(StatusCodes.Bad));
Assert.That(result.Errors[1].StatusCode, Is.EqualTo(StatusCodes.Bad));
}
[Test]
public void FetchReferencesAsyncShouldHandleCancellation()
{
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
ArrayOf<NodeId> nodeIds =
[
NodeId.Parse("ns=2;s=TestNode1"),
NodeId.Parse("ns=2;s=TestNode2")
];
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(
async () => _ = await sut.FetchReferencesAsync(null, nodeIds, cts.Token).ConfigureAwait(false));
}
[Test]
public async Task FetchReferenceAsyncShouldReturnReferenceDescriptionAsync()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var reference = new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
NodeClass = NodeClass.Variable
};
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new BrowseResponse
{
Results =
[
new BrowseResult
{
References = [reference]
}
],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
ArrayOf<ReferenceDescription> result = await sut.FetchReferencesAsync(null, nodeId).ConfigureAwait(false);
// Assert
Assert.That(result.Count, Is.EqualTo(1));
Assert.That(result[0], Is.EqualTo(reference));
session.Channel.Verify();
}
[Test]
public void FetchReferenceAsyncShouldThrowServiceResultExceptionForBadStatusCode()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
var reference = new ReferenceDescription
{
NodeId = ExpandedNodeId.Parse("ns=2;s=TestNode1"),
BrowseName = QualifiedName.From("TestBrowseName1"),
DisplayName = LocalizedText.From("TestDisplayName1"),
NodeClass = NodeClass.Variable
};
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.IsAny<CancellationToken>()))
.Returns(new ValueTask<IServiceResponse>(new BrowseResponse
{
ResponseHeader = new ResponseHeader { ServiceResult = StatusCodes.Bad },
Results =
[
new BrowseResult
{
References = [reference]
}
],
DiagnosticInfos = []
}))
.Verifiable(Times.Once);
// Act
Assert.ThrowsAsync<ServiceResultException>(
async () => await sut.FetchReferencesAsync(null, nodeId).ConfigureAwait(false));
session.Channel.Verify();
}
[Test]
public void FetchReferenceAsyncShouldHandleCancellation()
{
// Arrange
using var session = SessionMock.Create();
var sut = new NodeCacheContext(session);
var nodeId = NodeId.Parse("ns=2;s=TestNode");
using var cts = new CancellationTokenSource();
cts.Cancel();
session.Channel
.Setup(c => c.SendRequestAsync(
It.IsAny<BrowseRequest>(),
It.Is<CancellationToken>(ct => ct.IsCancellationRequested)))
.ThrowsAsync(new OperationCanceledException())
.Verifiable(Times.Once);
Assert.ThrowsAsync<OperationCanceledException>(
async () => await sut.FetchReferencesAsync(null, nodeId, cts.Token).ConfigureAwait(false));
}
}
}