mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-22 09:37:12 +08:00
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>
796 lines
31 KiB
C#
796 lines
31 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.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
|
|
{
|
|
/// <summary>
|
|
/// compliance tests for auditing operational event types,
|
|
/// event subscriptions, server configuration, history audit types,
|
|
/// node management audit types, cancel, and condition audit types.
|
|
/// </summary>
|
|
[TestFixture]
|
|
[Category("Conformance")]
|
|
[Category("Auditing")]
|
|
[Category("AuditingOperations")]
|
|
public class AuditingOperationTests : TestFixture
|
|
{
|
|
[Test]
|
|
public async Task ServerObjectEventNotifierBitIsSetAsync()
|
|
{
|
|
DataValue result = await ReadAttributeAsync(
|
|
ObjectIds.Server,
|
|
Attributes.EventNotifier).ConfigureAwait(false);
|
|
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
|
|
|
|
byte notifier =
|
|
result.WrappedValue.GetByte();
|
|
Assert.That(
|
|
notifier & EventNotifiers.SubscribeToEvents,
|
|
Is.Not.Zero,
|
|
"Server object should support event subscriptions.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditEventTypeExistsInAddressSpaceAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditEventType).ConfigureAwait(false);
|
|
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True,
|
|
"AuditEventType should exist.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task BaseEventTypeHasEventIdAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.BaseEventType,
|
|
"EventId").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"BaseEventType should have EventId property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task BaseEventTypeHasTimeAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.BaseEventType,
|
|
"Time").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"BaseEventType should have Time property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task BaseEventTypeHasSourceNodeAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.BaseEventType,
|
|
"SourceNode").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"BaseEventType should have SourceNode property.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditCreateSessionEventTypeExistsAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditCreateSessionEventType)
|
|
.ConfigureAwait(false);
|
|
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True,
|
|
"AuditCreateSessionEventType should exist.");
|
|
}
|
|
|
|
[Test]
|
|
public Task AuditEventAfterCreateSessionFiresAsync()
|
|
{
|
|
return AssertAuditEventFiresAsync(
|
|
ObjectTypeIds.AuditCreateSessionEventType,
|
|
async () =>
|
|
{
|
|
ISession s = await OpenAuxSessionAsync().ConfigureAwait(false);
|
|
await s.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
s.Dispose();
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public Task AuditEventAfterActivateSessionFiresAsync()
|
|
{
|
|
return AssertAuditEventFiresAsync(
|
|
ObjectTypeIds.AuditActivateSessionEventType,
|
|
async () =>
|
|
{
|
|
ISession s = await OpenAuxSessionAsync().ConfigureAwait(false);
|
|
await s.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
s.Dispose();
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public Task AuditEventAfterCloseSessionFiresAsync()
|
|
{
|
|
return AssertAuditEventFiresAsync(
|
|
ObjectTypeIds.AuditSessionEventType,
|
|
async () =>
|
|
{
|
|
ISession s = await OpenAuxSessionAsync().ConfigureAwait(false);
|
|
await s.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
s.Dispose();
|
|
});
|
|
}
|
|
|
|
/// <summary>
|
|
/// Pre-subscribes to events on Server.EventNotifier (using a
|
|
/// sysadmin session because audit events are typically only
|
|
/// surfaced to privileged subscribers), runs <paramref name="trigger"/>,
|
|
/// then awaits a notification whose EventType is or inherits
|
|
/// from <paramref name="expectedEventType"/>.
|
|
/// </summary>
|
|
private async Task AssertAuditEventFiresAsync(
|
|
NodeId expectedEventType,
|
|
Func<Task> trigger)
|
|
{
|
|
await AssertAuditEventFiresAsync(expectedEventType, trigger, null!).ConfigureAwait(false);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Part 3 §8.55 ReceiveEvents: an event is delivered only if the bit is
|
|
/// set on the EventType node and on the SourceNode. The ns0 NodeSet
|
|
/// grants ReceiveEvents on AuditEventType and its subtypes only to
|
|
/// SecurityAdmin, so a SecurityAdmin subscription over an encrypted
|
|
/// channel must receive the AuditCreateSession event. (The CTT "Auditing
|
|
/// Connections" unit therefore needs a user with the SecurityAdmin role,
|
|
/// e.g. sysadmin, for its auditing session.)
|
|
/// </summary>
|
|
[Test]
|
|
public async Task AuditEventDeliveredToSecurityAdminAsync()
|
|
{
|
|
bool seen = await MonitorAuditEventAsync(
|
|
ObjectTypeIds.AuditCreateSessionEventType,
|
|
async () =>
|
|
{
|
|
ISession s = await OpenAuxSessionAsync().ConfigureAwait(false);
|
|
await s.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
s.Dispose();
|
|
},
|
|
() => OpenAuxSessionAsync(
|
|
SecurityPolicies.Basic256Sha256,
|
|
new UserIdentity("sysadmin", "demo"u8))).ConfigureAwait(false);
|
|
|
|
Assert.That(
|
|
seen,
|
|
Is.True,
|
|
"A SecurityAdmin (sysadmin) subscription must receive audit events.");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Part 3 §8.55 ReceiveEvents on the EventType node: Anonymous and
|
|
/// AuthenticatedUser have no ReceiveEvents on AuditEventType (ns0 grants
|
|
/// Anonymous only Browse and Read), so their subscriptions on the Server
|
|
/// object must not receive audit events, while event types without
|
|
/// RolePermissions (RefreshStartEventType/RefreshEndEventType raised by
|
|
/// ConditionRefresh) are still delivered.
|
|
/// </summary>
|
|
[TestCase(false)]
|
|
[TestCase(true)]
|
|
public async Task AuditEventNotDeliveredWithoutReceiveEventsPermissionAsync(bool authenticated)
|
|
{
|
|
IUserIdentity identity = (authenticated
|
|
? new UserIdentity("user1", "password"u8)
|
|
: null)!;
|
|
List<NodeId> eventTypes = await ObserveEventsAsync(
|
|
async (session, subscriptionId) =>
|
|
{
|
|
ISession s = await OpenAuxSessionAsync().ConfigureAwait(false);
|
|
await s.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
s.Dispose();
|
|
|
|
// ConditionRefresh is a Method of an ObjectType without RolePermissions,
|
|
// so any session may call it; it raises RefreshStart/RefreshEnd events.
|
|
await Opc.Ua.Client.SessionClientExtensions.CallAsync(
|
|
session,
|
|
ObjectTypeIds.ConditionType,
|
|
MethodIds.ConditionType_ConditionRefresh,
|
|
CancellationToken.None,
|
|
new Variant(subscriptionId)).ConfigureAwait(false);
|
|
},
|
|
() => OpenAuxSessionAsync(SecurityPolicies.Basic256Sha256, identity!),
|
|
(_, eventType) => Task.FromResult(eventType == ObjectTypeIds.RefreshEndEventType))
|
|
.ConfigureAwait(false);
|
|
|
|
Assert.That(eventTypes, Does.Contain(ObjectTypeIds.RefreshEndEventType),
|
|
"Events whose type carries no RolePermissions must still be delivered.");
|
|
foreach (NodeId eventType in eventTypes)
|
|
{
|
|
Assert.That(
|
|
await NodeIdMatchesTypeAsync(Session, eventType, ObjectTypeIds.AuditEventType)
|
|
.ConfigureAwait(false),
|
|
Is.False,
|
|
$"Audit event {eventType} must not be delivered without ReceiveEvents.");
|
|
}
|
|
}
|
|
|
|
private async Task AssertAuditEventFiresAsync(
|
|
NodeId expectedEventType,
|
|
Func<Task> trigger,
|
|
Func<Task<ISession>> monitorSessionFactory)
|
|
{
|
|
bool seen = await MonitorAuditEventAsync(
|
|
expectedEventType, trigger, monitorSessionFactory).ConfigureAwait(false);
|
|
if (!seen)
|
|
{
|
|
Assert.Ignore(
|
|
$"No {expectedEventType} event observed within 5s — server may not " +
|
|
"audit anonymous sessions or fixture timing race fired before subscribe.");
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Pre-subscribes to events on Server.EventNotifier using the session
|
|
/// returned by <paramref name="monitorSessionFactory"/> (defaulting to a
|
|
/// SecurityAdmin session), runs <paramref name="trigger"/>, then polls
|
|
/// Publish for up to 5s for a notification whose EventType is or inherits
|
|
/// from <paramref name="expectedEventType"/>. Returns whether it was seen.
|
|
/// </summary>
|
|
private async Task<bool> MonitorAuditEventAsync(
|
|
NodeId expectedEventType,
|
|
Func<Task> trigger,
|
|
Func<Task<ISession>> monitorSessionFactory)
|
|
{
|
|
bool seen = false;
|
|
await ObserveEventsAsync(
|
|
(_, _) => trigger(),
|
|
monitorSessionFactory,
|
|
async (session, eventType) => seen =
|
|
await NodeIdMatchesTypeAsync(session, eventType, expectedEventType)
|
|
.ConfigureAwait(false)).ConfigureAwait(false);
|
|
return seen;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Pre-subscribes to events on Server.EventNotifier using the session
|
|
/// returned by <paramref name="monitorSessionFactory"/> (defaulting to a
|
|
/// SecurityAdmin session), runs <paramref name="trigger"/> with the monitoring
|
|
/// session and subscription id, then polls Publish for up to 5s until
|
|
/// <paramref name="stopWhen"/> returns true for a received EventType.
|
|
/// Returns the EventTypes of all received events.
|
|
/// </summary>
|
|
private async Task<List<NodeId>> ObserveEventsAsync(
|
|
Func<ISession, uint, Task> trigger,
|
|
Func<Task<ISession>> monitorSessionFactory,
|
|
Func<ISession, NodeId, Task<bool>> stopWhen)
|
|
{
|
|
var received = new List<NodeId>();
|
|
ISession adminSession = await (monitorSessionFactory ?? ConnectAsSysAdminAsync)()
|
|
.ConfigureAwait(false);
|
|
ISession session = adminSession ?? Session;
|
|
try
|
|
{
|
|
CreateSubscriptionResponse subResp = await session.CreateSubscriptionAsync(
|
|
null, 100, 1000, 100, 0, true, 0,
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
uint subscriptionId = subResp.SubscriptionId;
|
|
try
|
|
{
|
|
var eventFilter = new EventFilter
|
|
{
|
|
SelectClauses =
|
|
[
|
|
new SimpleAttributeOperand
|
|
{
|
|
TypeDefinitionId = ObjectTypeIds.BaseEventType,
|
|
BrowsePath = [new QualifiedName(BrowseNames.EventType)],
|
|
AttributeId = Attributes.Value
|
|
}
|
|
],
|
|
WhereClause = new ContentFilter()
|
|
};
|
|
var item = new MonitoredItemCreateRequest
|
|
{
|
|
ItemToMonitor = new ReadValueId
|
|
{
|
|
NodeId = ObjectIds.Server,
|
|
AttributeId = Attributes.EventNotifier
|
|
},
|
|
MonitoringMode = MonitoringMode.Reporting,
|
|
RequestedParameters = new MonitoringParameters
|
|
{
|
|
ClientHandle = 1,
|
|
SamplingInterval = 0,
|
|
Filter = new ExtensionObject(eventFilter),
|
|
QueueSize = 100,
|
|
DiscardOldest = true
|
|
}
|
|
};
|
|
CreateMonitoredItemsResponse miResp =
|
|
await session.CreateMonitoredItemsAsync(
|
|
null, subscriptionId, TimestampsToReturn.Neither,
|
|
new MonitoredItemCreateRequest[] { item }.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
if (miResp.Results.Count == 0 ||
|
|
!StatusCode.IsGood(miResp.Results[0].StatusCode))
|
|
{
|
|
Assert.Ignore(
|
|
"Could not subscribe to events on Server " +
|
|
$"(StatusCode={(miResp.Results.Count > 0 ? miResp.Results[0].StatusCode.ToString() : "no result")}).");
|
|
}
|
|
|
|
// Trigger the operation that should fire an audit event.
|
|
await trigger(session, subscriptionId).ConfigureAwait(false);
|
|
|
|
// Poll Publish for up to 5 seconds looking for the event type.
|
|
DateTime deadline = DateTime.UtcNow.AddSeconds(5);
|
|
bool seen = false;
|
|
while (!seen && DateTime.UtcNow < deadline)
|
|
{
|
|
PublishResponse pubResp;
|
|
try
|
|
{
|
|
pubResp = await session.PublishAsync(
|
|
null,
|
|
Array.Empty<SubscriptionAcknowledgement>().ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
catch (ServiceResultException)
|
|
{
|
|
await Task.Delay(50).ConfigureAwait(false);
|
|
continue;
|
|
}
|
|
|
|
var candidateEventTypes = new List<NodeId>();
|
|
foreach (ExtensionObject notification in pubResp.NotificationMessage.NotificationData)
|
|
{
|
|
if (notification.TryGetValue(out EventNotificationList? eventList))
|
|
{
|
|
foreach (EventFieldList ef in eventList.Events)
|
|
{
|
|
if (ef.EventFields.Count > 0 &&
|
|
ef.EventFields[0].TryGetValue(out NodeId eventType))
|
|
{
|
|
candidateEventTypes.Add(eventType);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
received.AddRange(candidateEventTypes);
|
|
foreach (NodeId eventType in candidateEventTypes)
|
|
{
|
|
if (await stopWhen(session, eventType).ConfigureAwait(false))
|
|
{
|
|
seen = true;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return received;
|
|
}
|
|
finally
|
|
{
|
|
try
|
|
{
|
|
await session.DeleteSubscriptionsAsync(
|
|
null,
|
|
new uint[] { subscriptionId }.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{
|
|
// best effort
|
|
}
|
|
}
|
|
}
|
|
finally
|
|
{
|
|
if (adminSession != null)
|
|
{
|
|
try
|
|
{
|
|
await adminSession.CloseAsync(2000, true, CancellationToken.None).ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{
|
|
// best effort
|
|
}
|
|
adminSession.Dispose();
|
|
}
|
|
}
|
|
}
|
|
|
|
private static async Task<bool> NodeIdMatchesTypeAsync(ISession session, NodeId actual, NodeId expected)
|
|
{
|
|
if (actual == expected)
|
|
{
|
|
return true;
|
|
}
|
|
try
|
|
{
|
|
BrowseResponse resp = await session.BrowseAsync(
|
|
null, null, 0,
|
|
new BrowseDescription[]
|
|
{
|
|
new() {
|
|
NodeId = actual,
|
|
BrowseDirection = BrowseDirection.Inverse,
|
|
ReferenceTypeId = ReferenceTypeIds.HasSubtype,
|
|
IncludeSubtypes = false,
|
|
NodeClassMask = 0,
|
|
ResultMask = (uint)BrowseResultMask.NodeClass
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
if (resp.Results.Count == 0 || resp.Results[0].References.Count == 0)
|
|
{
|
|
return false;
|
|
}
|
|
var parent = ExpandedNodeId.ToNodeId(
|
|
resp.Results[0].References[0].NodeId, session.NamespaceUris);
|
|
if (parent == expected)
|
|
{
|
|
return true;
|
|
}
|
|
return await NodeIdMatchesTypeAsync(session, parent, expected).ConfigureAwait(false);
|
|
}
|
|
catch
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ServerAuditingPropertyIsBoolAsync()
|
|
{
|
|
DataValue result = await ReadAttributeAsync(
|
|
VariableIds.Server_Auditing,
|
|
Attributes.Value).ConfigureAwait(false);
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Ignore(
|
|
$"Server_Auditing not accessible: {result.StatusCode}");
|
|
}
|
|
|
|
Assert.That(
|
|
result.WrappedValue.TryGetValue(out bool _), Is.True,
|
|
"Server_Auditing value should be a boolean.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task ServerAuditingDataTypeIsBooleanAsync()
|
|
{
|
|
DataValue result = await ReadAttributeAsync(
|
|
VariableIds.Server_Auditing,
|
|
Attributes.DataType).ConfigureAwait(false);
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Ignore(
|
|
"Server_Auditing DataType not readable: " +
|
|
$"{result.StatusCode}");
|
|
}
|
|
|
|
NodeId dataType =
|
|
result.WrappedValue.GetNodeId();
|
|
Assert.That(dataType, Is.EqualTo(DataTypeIds.Boolean),
|
|
"Server_Auditing DataType should be Boolean.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task SessionDiagnosticsArrayIsReadableAsync()
|
|
{
|
|
DataValue result = await ReadAttributeAsync(
|
|
VariableIds
|
|
.Server_ServerDiagnostics_SessionsDiagnosticsSummary_SessionDiagnosticsArray,
|
|
Attributes.Value).ConfigureAwait(false);
|
|
if (StatusCode.IsBad(result.StatusCode))
|
|
{
|
|
Assert.Ignore("SessionDiagnosticsArray not readable: " +
|
|
result.StatusCode.ToString());
|
|
}
|
|
|
|
Assert.That(
|
|
StatusCode.IsGood(result.StatusCode) ||
|
|
StatusCode.IsUncertain(result.StatusCode),
|
|
Is.True,
|
|
"SessionDiagnosticsArray should be readable.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task ServerCurrentTimeIsRecentAsync()
|
|
{
|
|
DataValue result = await ReadAttributeAsync(
|
|
VariableIds.Server_ServerStatus_CurrentTime,
|
|
Attributes.Value).ConfigureAwait(false);
|
|
Assert.That(StatusCode.IsGood(result.StatusCode), Is.True);
|
|
|
|
DateTimeUtc serverTime = result.WrappedValue.GetDateTime();
|
|
Assert.That(
|
|
Math.Abs((DateTime.UtcNow - (DateTime)serverTime).TotalMinutes),
|
|
Is.LessThan(5),
|
|
"Server time should be within 5 minutes of local time.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditHistoryUpdateEventTypeExistsAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditHistoryUpdateEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditHistoryUpdateEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditHistoryEventUpdateHasPropertyAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditHistoryEventUpdateEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditHistoryEventUpdateEventType not supported.");
|
|
}
|
|
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditHistoryEventUpdateEventType,
|
|
"UpdatedNode").ConfigureAwait(false);
|
|
Assert.That(has, Is.True.Or.False,
|
|
"UpdatedNode property may or may not exist.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditHistoryValueUpdateEventTypeExistsAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditHistoryValueUpdateEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditHistoryValueUpdateEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditHistoryDeleteEventTypeExistsOrFailAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditHistoryDeleteEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail("AuditHistoryDeleteEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditHistoryRawModifyDeleteExistsOrFailAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditHistoryRawModifyDeleteEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail("AuditHistoryRawModifyDeleteEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task ProgramTransitionAuditEventTypeExistsOrFailAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.ProgramTransitionAuditEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail("ProgramTransitionAuditEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditAddNodesHasNodesToAddAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditAddNodesEventType,
|
|
"NodesToAdd").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditAddNodesEventType should have NodesToAdd.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditDeleteNodesHasNodesToDeleteAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditDeleteNodesEventType,
|
|
"NodesToDelete").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditDeleteNodesEventType should have NodesToDelete.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditAddReferencesHasReferencesToAddAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditAddReferencesEventType,
|
|
"ReferencesToAdd").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditAddReferencesEventType should have ReferencesToAdd.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditDeleteReferencesHasReferencesToDeleteAsync()
|
|
{
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditDeleteReferencesEventType,
|
|
"ReferencesToDelete").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditDeleteReferencesEventType should have " +
|
|
"ReferencesToDelete.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditCancelHasRequestHandleAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditCancelEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail("AuditCancelEventType not supported.");
|
|
}
|
|
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditCancelEventType,
|
|
"RequestHandle").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditCancelEventType should have RequestHandle.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditConditionCommentHasCommentAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditConditionCommentEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditConditionCommentEventType not supported.");
|
|
}
|
|
|
|
bool has = await TypeHasPropertyAsync(
|
|
ObjectTypeIds.AuditConditionCommentEventType,
|
|
"Comment").ConfigureAwait(false);
|
|
Assert.That(has, Is.True,
|
|
"AuditConditionCommentEventType should have Comment.");
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditConditionRespondExistsOrFailAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditConditionRespondEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditConditionRespondEventType not supported.");
|
|
}
|
|
}
|
|
|
|
[Test]
|
|
public async Task AuditConditionShelvingExistsOrFailAsync()
|
|
{
|
|
DataValue result = await ReadBrowseNameAsync(
|
|
ObjectTypeIds.AuditConditionShelvingEventType)
|
|
.ConfigureAwait(false);
|
|
|
|
if (!StatusCode.IsGood(result.StatusCode))
|
|
{
|
|
Assert.Fail(
|
|
"AuditConditionShelvingEventType not supported.");
|
|
}
|
|
}
|
|
|
|
private async Task<DataValue> ReadAttributeAsync(
|
|
NodeId nodeId, uint attributeId)
|
|
{
|
|
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.Count, Is.EqualTo(1));
|
|
return response.Results[0];
|
|
}
|
|
|
|
private Task<DataValue> ReadBrowseNameAsync(NodeId nodeId)
|
|
{
|
|
return ReadAttributeAsync(
|
|
nodeId, Attributes.BrowseName);
|
|
}
|
|
|
|
private async Task<bool> TypeHasPropertyAsync(
|
|
NodeId eventTypeId, string propertyName)
|
|
{
|
|
BrowseResponse response = await Session.BrowseAsync(
|
|
null, null, 0,
|
|
new BrowseDescription[]
|
|
{
|
|
new() {
|
|
NodeId = eventTypeId,
|
|
BrowseDirection = BrowseDirection.Forward,
|
|
ReferenceTypeId =
|
|
ReferenceTypeIds.HierarchicalReferences,
|
|
IncludeSubtypes = true,
|
|
NodeClassMask = 0,
|
|
ResultMask = (uint)BrowseResultMask.All
|
|
}
|
|
}.ToArrayOf(),
|
|
CancellationToken.None).ConfigureAwait(false);
|
|
|
|
Assert.That(response.Results.Count, Is.EqualTo(1));
|
|
foreach (ReferenceDescription r in response.Results[0].References)
|
|
{
|
|
if (r.BrowseName.Name == propertyName)
|
|
{
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|
|
}
|