Files
Marc Schier 9bfc780e14 Update NuGet dependencies and migrate tests to NUnit 5 (#4840)
# Description

Update 55 NuGet dependencies to the latest stable releases available on
2026-10-19, preserving documented compatibility pins and
framework-specific version bands. Existing OpenUSD prereleases remain
unchanged because no newer releases are available.

Migrate existing tests to NUnit 5: await asynchronous assertions,
propagate async through helpers, handle nullable predicates, and replace
obsolete `Order` attributes with sequencing dependencies. Sequencing
dependencies use `AllowFailure = true`; filtering a dependent test also
runs prerequisites. Adjust fixture-level parallelism where NUnit
dependency scheduling requires it.

Keep Roslyn API/runtime pins intact; select newer Immutable/Metadata
runtime packages only for test and profiling hosts requiring them.
Update the approved SDK pin to 10.0.402 across local, CI, and container
builds. Document NUnit 5 conventions.
2026-10-19 15:23:29 +00:00

569 lines
22 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 Microsoft.Extensions.Logging;
using Moq;
using NUnit.Framework;
using Opc.Ua.Tests;
namespace Opc.Ua.Client.Tests
{
[TestFixture]
[Category("Client")]
[Category("DefaultSessionFactory")]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public sealed class DefaultSessionFactoryTests
{
private ITelemetryContext m_telemetry;
[SetUp]
public void SetUp()
{
m_telemetry = NUnitTelemetryContext.Create();
}
[Test]
public void ConstructorSetsTelemetry()
{
var factory = new DefaultSessionFactory(m_telemetry);
Assert.That(factory.Telemetry, Is.SameAs(m_telemetry));
}
[Test]
public void ReturnDiagnosticsDefaultIsNone()
{
var factory = new DefaultSessionFactory(m_telemetry);
Assert.That(factory.ReturnDiagnostics, Is.EqualTo(DiagnosticsMasks.None));
}
[Test]
public void WithSubscriptionEngineReturnsAConfiguredCopyAndLeavesTheOriginal()
{
var registry = new Mock<ISecurityPolicyRegistry>().Object;
var original = new DefaultSessionFactory(m_telemetry)
{
ReturnDiagnostics = DiagnosticsMasks.All,
SecurityPolicyRegistry = registry,
TimeProvider = TimeProvider.System
};
ISubscriptionEngineFactory engine = new Mock<ISubscriptionEngineFactory>().Object;
ISessionFactory copy = original.WithSubscriptionEngine(engine);
Assert.That(copy, Is.Not.SameAs(original));
Assert.That(copy.SubscriptionEngineFactory, Is.SameAs(engine));
Assert.That(copy.ReturnDiagnostics, Is.EqualTo(DiagnosticsMasks.All));
Assert.That(copy.Telemetry, Is.SameAs(m_telemetry));
Assert.That(((DefaultSessionFactory)copy).SecurityPolicyRegistry, Is.SameAs(registry));
Assert.That(
((DefaultSessionFactory)copy).TimeProvider,
Is.SameAs(TimeProvider.System),
"no time provider given keeps the factory's own");
Assert.That(original.SubscriptionEngineFactory, Is.Null, "a shared factory must not be mutated");
}
[Test]
public void WithSubscriptionEngineKeepsTheSubclassAndOverridesTheTimeProvider()
{
var original = new DerivedSessionFactory(m_telemetry);
ISubscriptionEngineFactory engine = new Mock<ISubscriptionEngineFactory>().Object;
var timeProvider = new Mock<TimeProvider>().Object;
ISessionFactory copy = original.WithSubscriptionEngine(engine, timeProvider);
Assert.That(copy, Is.TypeOf<DerivedSessionFactory>(), "a subclass's overrides must survive");
Assert.That(((DefaultSessionFactory)copy).TimeProvider, Is.SameAs(timeProvider));
Assert.That(original.TimeProvider, Is.Null);
}
[Test]
public void WithSubscriptionEngineRejectsANullEngine()
{
var factory = new DefaultSessionFactory(m_telemetry);
Assert.Throws<ArgumentNullException>(() => factory.WithSubscriptionEngine(null!));
}
private sealed class DerivedSessionFactory : DefaultSessionFactory
{
public DerivedSessionFactory(ITelemetryContext telemetry)
: base(telemetry)
{
}
}
[Test]
public void ReturnDiagnosticsCanBeSet()
{
var factory = new DefaultSessionFactory(m_telemetry)
{
ReturnDiagnostics = DiagnosticsMasks.All
};
Assert.That(factory.ReturnDiagnostics, Is.EqualTo(DiagnosticsMasks.All));
}
[Test]
public void CreateReturnsSessionWithCorrectEndpoint()
{
var factory = new DefaultSessionFactory(m_telemetry);
var channel = new Mock<ITransportChannel>();
channel
.SetupGet(c => c.MessageContext)
.Returns(ServiceMessageContext.Create(m_telemetry));
channel
.SetupGet(c => c.SupportedFeatures)
.Returns(TransportChannelFeatures.Reconnect);
var configuration = new ApplicationConfiguration(m_telemetry)
{
ClientConfiguration = new ClientConfiguration()
};
var endpoint = new ConfiguredEndpoint(null!, new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
});
ISession session = factory.Create(channel.Object, configuration, endpoint);
Assert.That(session, Is.Not.Null);
Assert.That(session, Is.InstanceOf<Session>());
session.Dispose();
}
[Test]
public void CreateSetsReturnDiagnosticsOnSession()
{
var factory = new DefaultSessionFactory(m_telemetry)
{
ReturnDiagnostics = DiagnosticsMasks.ServiceSymbolicId
};
var channel = new Mock<ITransportChannel>();
channel
.SetupGet(c => c.MessageContext)
.Returns(ServiceMessageContext.Create(m_telemetry));
channel
.SetupGet(c => c.SupportedFeatures)
.Returns(TransportChannelFeatures.Reconnect);
var configuration = new ApplicationConfiguration(m_telemetry)
{
ClientConfiguration = new ClientConfiguration()
};
var endpoint = new ConfiguredEndpoint(null!, new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
});
ISession session = factory.Create(channel.Object, configuration, endpoint);
Assert.That(session.ReturnDiagnostics, Is.EqualTo(DiagnosticsMasks.ServiceSymbolicId));
session.Dispose();
}
[Test]
public async Task RecreateAsyncThrowsWhenSessionIsNotSessionType()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object).ConfigureAwait(false));
}
[Test]
public async Task RecreateAsyncWithConnectionThrowsWhenSessionIsNotSessionType()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
var mockConnection = new Mock<ITransportWaitingConnection>();
await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object, mockConnection.Object).ConfigureAwait(false));
}
[Test]
public async Task RecreateAsyncWithChannelThrowsWhenSessionIsNotSessionType()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
var mockChannel = new Mock<ITransportChannel>();
await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object, mockChannel.Object).ConfigureAwait(false));
}
[Test]
public async Task CreateAsyncWithNullReverseConnectManagerForwardsToSimpleOverload()
{
var factory = new Mock<DefaultSessionFactory>(m_telemetry) { CallBase = true };
var configuration = new ApplicationConfiguration(m_telemetry)
{
ClientConfiguration = new ClientConfiguration()
};
var endpoint = new ConfiguredEndpoint(null!, new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
});
var identity = new UserIdentity();
var mockSession = new Mock<ISession>();
factory
.Setup(f => f.CreateAsync(
configuration,
endpoint,
false,
false,
"TestSession",
30000u,
identity,
It.IsAny<ArrayOf<string>>(),
It.IsAny<CancellationToken>()))
.ReturnsAsync(mockSession.Object)
.Verifiable();
Task<ISession> task = factory.Object.CreateAsync(
configuration,
(ReverseConnectManager)null!,
endpoint,
false,
false,
"TestSession",
30000u,
identity,
default,
CancellationToken.None);
await Assert.DoesNotThrowAsync(async () => await task.ConfigureAwait(false));
factory.Verify();
}
[Test]
public void CreateWithAvailableEndpointsReturnsSession()
{
var factory = new DefaultSessionFactory(m_telemetry);
var channel = new Mock<ITransportChannel>();
channel
.SetupGet(c => c.MessageContext)
.Returns(ServiceMessageContext.Create(m_telemetry));
channel
.SetupGet(c => c.SupportedFeatures)
.Returns(TransportChannelFeatures.Reconnect);
var configuration = new ApplicationConfiguration(m_telemetry)
{
ClientConfiguration = new ClientConfiguration()
};
var endpoint = new ConfiguredEndpoint(null!, new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
});
ArrayOf<EndpointDescription> availableEndpoints =
[
new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
}
];
ArrayOf<string> discoveryUris = ["urn:test"];
ISession session = factory.Create(
channel.Object,
configuration,
endpoint,
null,
null,
availableEndpoints,
discoveryUris);
Assert.That(session, Is.Not.Null);
Assert.That(session, Is.InstanceOf<Session>());
session.Dispose();
}
[Test]
public async Task RecreateAsyncThrowsWithCorrectParameterName()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
ArgumentException ex = await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object).ConfigureAwait(false));
Assert.That(ex.ParamName, Is.EqualTo("sessionTemplate"));
}
[Test]
public async Task RecreateAsyncWithConnectionThrowsWithCorrectParameterName()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
var mockConnection = new Mock<ITransportWaitingConnection>();
ArgumentException ex = await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object, mockConnection.Object).ConfigureAwait(false));
Assert.That(ex.ParamName, Is.EqualTo("sessionTemplate"));
}
[Test]
public async Task RecreateAsyncWithChannelThrowsWithCorrectParameterName()
{
var factory = new DefaultSessionFactory(m_telemetry);
var mockSession = new Mock<ISession>();
var mockChannel = new Mock<ITransportChannel>();
ArgumentException ex = await Assert.ThrowsAsync<ArgumentException>(async () =>
await factory.RecreateAsync(mockSession.Object, mockChannel.Object).ConfigureAwait(false));
Assert.That(ex.ParamName, Is.EqualTo("sessionTemplate"));
}
[Test]
public void TelemetryCanBeSetViaInitializer()
{
var factory = new DefaultSessionFactory(m_telemetry)
{
Telemetry = m_telemetry
};
Assert.That(factory.Telemetry, Is.SameAs(m_telemetry));
}
[Test]
public async Task CreateAsyncOverloadWithConnectionForwardsThroughChain()
{
var factory = new Mock<DefaultSessionFactory>(m_telemetry) { CallBase = true };
var configuration = new ApplicationConfiguration(m_telemetry)
{
ClientConfiguration = new ClientConfiguration()
};
var endpoint = new ConfiguredEndpoint(null!, new EndpointDescription
{
EndpointUrl = "opc.tcp://localhost:4840",
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None
});
var mockSession = new Mock<ISession>();
var mockConnection = new Mock<ITransportWaitingConnection>();
factory
.Setup(f => f.CreateAsync(
configuration,
mockConnection.Object,
endpoint,
true,
false,
"Test",
5000u,
It.IsAny<IUserIdentity>(),
It.IsAny<ArrayOf<string>>(),
It.IsAny<CancellationToken>()))
.ReturnsAsync(mockSession.Object)
.Verifiable();
Task<ISession> task = factory.Object.CreateAsync(
configuration,
mockConnection.Object,
endpoint,
true,
false,
"Test",
5000u,
null,
default,
CancellationToken.None);
await Assert.DoesNotThrowAsync(async () => await task.ConfigureAwait(false));
factory.Verify();
}
private static readonly Uri s_reverseEndpointUrl = new("opc.tcp://localhost:4840");
[Test]
public async Task ReverseConnectRetryReturnsFirstSessionWhenConnectionIsHealthyAsync()
{
ITransportWaitingConnection connection = new Mock<ITransportWaitingConnection>().Object;
ISession session = new Mock<ISession>().Object;
int resolveCalls = 0;
ISession result = await DefaultSessionFactory
.CreateReverseConnectSessionWithRetryAsync(
connection,
(conn, ct) => Task.FromResult(session),
ct =>
{
resolveCalls++;
return Task.FromResult(connection);
},
maxAttempts: 3,
logger: null,
endpointUrl: s_reverseEndpointUrl,
ct: CancellationToken.None)
.ConfigureAwait(false);
Assert.That(result, Is.SameAs(session));
Assert.That(resolveCalls, Is.Zero, "a healthy connection must not be re-fetched");
}
[Test]
public async Task ReverseConnectRetryRefetchesConnectionAfterStaleFailureAsync()
{
ITransportWaitingConnection firstConnection = new Mock<ITransportWaitingConnection>().Object;
ITransportWaitingConnection secondConnection = new Mock<ITransportWaitingConnection>().Object;
ISession session = new Mock<ISession>().Object;
int createCalls = 0;
int resolveCalls = 0;
ISession result = await DefaultSessionFactory
.CreateReverseConnectSessionWithRetryAsync(
firstConnection,
(conn, ct) =>
{
createCalls++;
if (createCalls == 1)
{
Assert.That(conn, Is.SameAs(firstConnection));
throw new ServiceResultException(StatusCodes.BadConnectionClosed);
}
Assert.That(conn, Is.SameAs(secondConnection),
"the retry must use the freshly delivered connection");
return Task.FromResult(session);
},
ct =>
{
resolveCalls++;
return Task.FromResult(secondConnection);
},
maxAttempts: 3,
// Exercise the warning-log branch with a real logger.
logger: m_telemetry.CreateLogger<DefaultSessionFactory>(),
endpointUrl: s_reverseEndpointUrl,
ct: CancellationToken.None)
.ConfigureAwait(false);
Assert.That(result, Is.SameAs(session));
Assert.That(createCalls, Is.EqualTo(2));
Assert.That(resolveCalls, Is.EqualTo(1));
}
[Test]
public async Task ReverseConnectRetryPropagatesNonTransientFailureWithoutRefetch()
{
ITransportWaitingConnection connection = new Mock<ITransportWaitingConnection>().Object;
int resolveCalls = 0;
ServiceResultException ex = (await Assert.ThrowsAsync<ServiceResultException>(async () =>
await DefaultSessionFactory
.CreateReverseConnectSessionWithRetryAsync(
connection,
(conn, ct) =>
throw new ServiceResultException(StatusCodes.BadIdentityTokenRejected),
ct =>
{
resolveCalls++;
return Task.FromResult(connection);
},
maxAttempts: 3,
logger: null,
endpointUrl: s_reverseEndpointUrl,
ct: CancellationToken.None)
.ConfigureAwait(false)))!;
Assert.That(ex.StatusCode, Is.EqualTo((uint)StatusCodes.BadIdentityTokenRejected));
Assert.That(resolveCalls, Is.Zero,
"a non-transient failure must not trigger a reverse-connection re-fetch");
}
[Test]
public async Task ReverseConnectRetryStopsAfterMaxAttemptsAndSurfacesStaleFailure()
{
ITransportWaitingConnection connection = new Mock<ITransportWaitingConnection>().Object;
int createCalls = 0;
int resolveCalls = 0;
ServiceResultException ex = (await Assert.ThrowsAsync<ServiceResultException>(async () =>
await DefaultSessionFactory
.CreateReverseConnectSessionWithRetryAsync(
connection,
(conn, ct) =>
{
createCalls++;
throw new ServiceResultException(StatusCodes.BadConnectionClosed);
},
ct =>
{
resolveCalls++;
return Task.FromResult(connection);
},
maxAttempts: 3,
logger: null,
endpointUrl: s_reverseEndpointUrl,
ct: CancellationToken.None)
.ConfigureAwait(false)))!;
Assert.That(ex.StatusCode, Is.EqualTo((uint)StatusCodes.BadConnectionClosed));
Assert.That(createCalls, Is.EqualTo(3), "initial attempt plus two bounded retries");
Assert.That(resolveCalls, Is.EqualTo(2), "a fresh connection is fetched before each retry");
}
}
}