mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-18 14:43:08 +08:00
romanett
9b034f8291
# 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>
421 lines
15 KiB
C#
421 lines
15 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 NUnit.Framework;
|
|
using Opc.Ua.Client.TestFramework;
|
|
using ISession = Opc.Ua.Client.ISession;
|
|
|
|
namespace Opc.Ua.Core.Security.Tests
|
|
{
|
|
[TestFixture]
|
|
[Category("Conformance")]
|
|
[Category("SecurityRoleServerBase2")]
|
|
public class SecurityRoleServerBase2Tests : TestFixture
|
|
{
|
|
[Test]
|
|
public async Task Base2VerifyNamespacesObject001Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool foundNamespaceMetadata = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References)
|
|
{
|
|
if (rd.TypeDefinition.ToString().Contains("11616", StringComparison.Ordinal) ||
|
|
rd.BrowseName.Name!.Contains("Namespace", StringComparison.Ordinal))
|
|
{
|
|
foundNamespaceMetadata = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
Assert.That(foundNamespaceMetadata, Is.True,
|
|
"Namespaces folder should contain " +
|
|
"NamespaceMetadataType instances.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2VerifyNamespaceMetadataInstance002Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
Assert.That(
|
|
response.Results[0].References.Count,
|
|
Is.GreaterThan(0),
|
|
"At least one NamespaceMetadata instance " +
|
|
"should exist.");
|
|
|
|
ReferenceDescription firstNs =
|
|
response.Results[0].References[0];
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
firstNs.NodeId, Session.NamespaceUris);
|
|
|
|
BrowseResponse nsChildren =
|
|
await BrowseForwardAsync(nsNodeId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(nsChildren.Results, Is.Not.Null);
|
|
Assert.That(nsChildren.Results.Count,
|
|
Is.GreaterThan(0));
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultRolePermissions004Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultRolePermissions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultRolePermissions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultUserRolePermissions005Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultUserRolePermissions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultUserRolePermissions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2DefaultAccessRestrictions006Async()
|
|
{
|
|
NodeId namespacesId = ToNodeId(
|
|
ObjectIds.Server_Namespaces);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(namespacesId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var nsNodeId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
NodeId propId = await FindChildAsync(
|
|
nsNodeId, "DefaultAccessRestrictions")
|
|
.ConfigureAwait(false);
|
|
if (!propId.IsNull)
|
|
{
|
|
DataValue dv = await ReadPropertyValueAsync(
|
|
propId).ConfigureAwait(false);
|
|
Assert.That(dv.StatusCode,
|
|
Is.EqualTo(StatusCodes.Good));
|
|
return;
|
|
}
|
|
}
|
|
|
|
Assert.Fail(
|
|
"No namespace exposes " +
|
|
"DefaultAccessRestrictions property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindRolePermissions007Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId, Attributes.RolePermissions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ArrayOf<ExtensionObject> _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with RolePermissions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindUserRolePermissions008Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId,
|
|
Attributes.UserRolePermissions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ArrayOf<ExtensionObject> _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with UserRolePermissions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task Base2FindAccessRestrictions009Async()
|
|
{
|
|
NodeId objectsId = ToNodeId(ObjectIds.ObjectsFolder);
|
|
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(objectsId)
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.GreaterThan(0));
|
|
|
|
bool found = false;
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References.ToArray()!)
|
|
{
|
|
var childId = ExpandedNodeId.ToNodeId(
|
|
rd.NodeId, Session.NamespaceUris);
|
|
DataValue dv = await ReadAttributeAsync(
|
|
childId,
|
|
Attributes.AccessRestrictions)
|
|
.ConfigureAwait(false);
|
|
if (StatusCode.IsGood(dv.StatusCode) &&
|
|
dv.WrappedValue.TryGetValue(out ushort _))
|
|
{
|
|
found = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!found)
|
|
{
|
|
Assert.Ignore(
|
|
"No nodes with AccessRestrictions " +
|
|
"attribute found in Objects folder.");
|
|
}
|
|
}
|
|
|
|
private async Task<BrowseResponse> BrowseForwardAsync(
|
|
NodeId nodeId,
|
|
ISession? session = null)
|
|
{
|
|
session ??= Session;
|
|
return await session.BrowseAsync(
|
|
null, null, 0,
|
|
new BrowseDescription[]
|
|
{
|
|
new() {
|
|
NodeId = nodeId,
|
|
BrowseDirection = BrowseDirection.Forward,
|
|
ReferenceTypeId =
|
|
ReferenceTypeIds.HierarchicalReferences,
|
|
IncludeSubtypes = true,
|
|
NodeClassMask = 0,
|
|
ResultMask = (uint)BrowseResultMask.All
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
|
|
private async Task<NodeId> FindChildAsync(
|
|
NodeId parentId,
|
|
string childName,
|
|
ISession? session = null)
|
|
{
|
|
BrowseResponse response =
|
|
await BrowseForwardAsync(parentId, session)
|
|
.ConfigureAwait(false);
|
|
if (response?.Results == null ||
|
|
response.Results.Count == 0)
|
|
{
|
|
return NodeId.Null;
|
|
}
|
|
|
|
foreach (ReferenceDescription rd in
|
|
response.Results[0].References)
|
|
{
|
|
if (rd.BrowseName.Name == childName)
|
|
{
|
|
return ExpandedNodeId.ToNodeId(
|
|
rd.NodeId,
|
|
(session ?? Session).NamespaceUris);
|
|
}
|
|
}
|
|
|
|
return WellKnownRoleNodeIds.TryGetChild(parentId, childName);
|
|
}
|
|
|
|
private async Task<DataValue> ReadPropertyValueAsync(
|
|
NodeId nodeId,
|
|
ISession? session = null)
|
|
{
|
|
session ??= Session;
|
|
ReadResponse response = await session.ReadAsync(
|
|
null, 0, TimestampsToReturn.Both,
|
|
new ReadValueId[]
|
|
{
|
|
new() {
|
|
NodeId = nodeId,
|
|
AttributeId = Attributes.Value
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
return response.Results[0];
|
|
}
|
|
|
|
private async Task<DataValue> ReadAttributeAsync(
|
|
NodeId nodeId,
|
|
uint attributeId,
|
|
ISession? session = null)
|
|
{
|
|
session ??= Session;
|
|
ReadResponse response = await session.ReadAsync(
|
|
null, 0, TimestampsToReturn.Both,
|
|
new ReadValueId[]
|
|
{
|
|
new() {
|
|
NodeId = nodeId,
|
|
AttributeId = attributeId
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results, Is.Not.Null);
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
return response.Results[0];
|
|
}
|
|
}
|
|
}
|