mirror of
https://github.com/OPCFoundation/UA-.NETStandard.git
synced 2026-10-21 17:16:16 +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>
835 lines
31 KiB
C#
835 lines
31 KiB
C#
/* ========================================================================
|
|
* Copyright (c) 2005-2026 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 Microsoft.Extensions.Configuration;
|
|
using Microsoft.Extensions.Configuration.Memory;
|
|
using Microsoft.Extensions.DependencyInjection;
|
|
using Microsoft.Extensions.Options;
|
|
using Moq;
|
|
using NUnit.Framework;
|
|
using Opc.Ua.Identity;
|
|
using Opc.Ua.Server.AliasNames;
|
|
using Opc.Ua.Server.FileSystem;
|
|
using Opc.Ua.Server.Historian;
|
|
using Opc.Ua.Server.Hosting;
|
|
using Opc.Ua.Tests;
|
|
|
|
namespace Opc.Ua.Server.Tests.Hosting
|
|
{
|
|
/// <summary>
|
|
/// Coverage tests that exercise the DI-registration paths on
|
|
/// <see cref="OpcUaServerBuilderExtensions"/> that are not covered
|
|
/// by the existing hosting-test suite.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Tests only verify that the correct service descriptors are deposited
|
|
/// in the container or that options are projected correctly.
|
|
/// No hosted service is started and no network is used.
|
|
/// </remarks>
|
|
[TestFixture]
|
|
[Category("Hosting")]
|
|
[SetCulture("en-us")]
|
|
[SetUICulture("en-us")]
|
|
[Parallelizable]
|
|
public sealed class OpcUaServerBuilderExtensionsCoverageTests
|
|
{
|
|
private static IOpcUaServerBuilder CreateBuilder()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
return services.AddOpcUa().AddServer(o =>
|
|
{
|
|
o.ApplicationName = "CoverageServer";
|
|
o.ApplicationUri = "urn:localhost:CoverageServer";
|
|
o.ProductUri = "urn:localhost:CoverageServer:Product";
|
|
});
|
|
}
|
|
|
|
private static IConfiguration EmptyConfiguration()
|
|
{
|
|
var source = new MemoryConfigurationSource
|
|
{
|
|
InitialData = []
|
|
};
|
|
|
|
return new ConfigurationBuilder().Add(source).Build();
|
|
}
|
|
|
|
private static IConfiguration CreateConfiguration(IDictionary<string, string?> values)
|
|
{
|
|
var source = new MemoryConfigurationSource { InitialData = values };
|
|
return new ConfigurationBuilder().Add(source).Build();
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerTServerRegistersActivatorFactory()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddOpcUa().AddServer<CustomTestServer>(o =>
|
|
{
|
|
o.ApplicationName = "CustomTypeServer";
|
|
o.ApplicationUri = "urn:test:CustomTypeServer";
|
|
o.ProductUri = "urn:test:product";
|
|
});
|
|
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(d =>
|
|
d.ServiceType == typeof(IOpcUaServerFactory) &&
|
|
d.ImplementationType == typeof(ActivatorOpcUaServerFactory<CustomTestServer>)));
|
|
|
|
_ = new CustomTestServer(
|
|
NUnitTelemetryContext.Create(isServer: true),
|
|
TimeProvider.System);
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerTServerNullBuilderThrowsArgumentNullException()
|
|
{
|
|
IOpcUaBuilder? nullBuilder = null;
|
|
|
|
Assert.That(
|
|
() => nullBuilder!.AddServer<CustomTestServer>(o => { }),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerTServerNullConfigureThrowsArgumentNullException()
|
|
{
|
|
var services = new ServiceCollection();
|
|
IOpcUaBuilder builder = services.AddOpcUa();
|
|
Action<OpcUaServerOptions>? nullConfigure = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddServer<CustomTestServer>(nullConfigure!),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerIConfigurationRegistersHostedService()
|
|
{
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["OpcUa:Server:ApplicationName"] = "ConfigServer",
|
|
["OpcUa:Server:ApplicationUri"] = "urn:test:ConfigServer",
|
|
["OpcUa:Server:ProductUri"] = "urn:test:product"
|
|
});
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
IOpcUaServerBuilder serverBuilder = services.AddOpcUa().AddServer(config);
|
|
|
|
Assert.That(serverBuilder, Is.Not.Null);
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IOpcUaServerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerIConfigurationNullThrowsArgumentNullException()
|
|
{
|
|
var services = new ServiceCollection();
|
|
IOpcUaBuilder builder = services.AddOpcUa();
|
|
IConfiguration? nullConfig = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddServer(nullConfig!),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerIConfigurationSectionRegistersHostedService()
|
|
{
|
|
IConfiguration root = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["ApplicationName"] = "SectionServer",
|
|
["ApplicationUri"] = "urn:test:SectionServer",
|
|
["ProductUri"] = "urn:test:product"
|
|
});
|
|
IConfigurationSection section = root.GetSection(string.Empty);
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
IOpcUaServerBuilder serverBuilder = services.AddOpcUa().AddServer(section);
|
|
|
|
Assert.That(serverBuilder, Is.Not.Null);
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IOpcUaServerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerIConfigurationSectionNullThrowsArgumentNullException()
|
|
{
|
|
var services = new ServiceCollection();
|
|
IOpcUaBuilder builder = services.AddOpcUa();
|
|
IConfigurationSection? nullSection = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddServer(nullSection!),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void ConfigureRolesActionRegistersRoleManagerService()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.ConfigureRoles(o => { });
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IRoleManager)));
|
|
}
|
|
|
|
[Test]
|
|
public void ConfigureRolesConfigurationRegistersRoleManagerService()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.ConfigureRoles(EmptyConfiguration());
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IRoleManager)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddRoleManagerInstanceRegistersExactInstance()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
var roleManager = new RoleManager();
|
|
builder.AddRoleManager(roleManager);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
IRoleManager resolved = sp.GetRequiredService<IRoleManager>();
|
|
|
|
Assert.That(resolved, Is.SameAs(roleManager));
|
|
}
|
|
|
|
[Test]
|
|
public void AddRoleManagerTypeRegistersImplementationType()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddRoleManager<RoleManager>();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(d =>
|
|
d.ServiceType == typeof(IRoleManager) &&
|
|
d.ImplementationType == typeof(RoleManager)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddIdentityAuthenticatorTypeRegistersDescriptor()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddIdentityAuthenticator<StubUserTokenAuthenticator>();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(StubUserTokenAuthenticator)));
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerIdentityAuthenticatorRegistration)));
|
|
|
|
_ = new StubUserTokenAuthenticator();
|
|
}
|
|
|
|
[Test]
|
|
public void AddIdentityAugmenterTypeRegistersAugmenterRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddIdentityAugmenter<StubIdentityAugmenter>();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerIdentityAugmenterRegistration)));
|
|
|
|
_ = new StubIdentityAugmenter();
|
|
}
|
|
|
|
[Test]
|
|
public void AddIdentityAugmenterFactoryRegistersAugmenterRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddIdentityAugmenter(_ => Mock.Of<IIdentityAugmenter>());
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerIdentityAugmenterRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddIdentityAugmenterNullFactoryThrowsArgumentNullException()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
Func<IServiceProvider, IIdentityAugmenter>? nullFactory = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddIdentityAugmenter(nullFactory!),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void WithKeyCredentialPushNoConfigureRegistersSubject()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.WithKeyCredentialPush();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(KeyCredentialPushSubject)));
|
|
}
|
|
|
|
[Test]
|
|
public void WithKeyCredentialPushWithConfigureRegistersSubject()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.WithKeyCredentialPush(o => o.ConfigurationFolderPath = "/Server/Configuration/Keys");
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(KeyCredentialPushSubject)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddDefaultIdentityAuthenticatorsActionRegistersRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddDefaultIdentityAuthenticators(o => o.EnableAnonymous = true);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerIdentityAuthenticatorRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddDefaultIdentityAuthenticatorsConfigRegistersRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["EnableAnonymous"] = "true"
|
|
});
|
|
builder.AddDefaultIdentityAuthenticators(config);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerIdentityAuthenticatorRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddJwtIssuerActionRegistersIssuerKeyResolver()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddJwtIssuer(o =>
|
|
{
|
|
o.IssuerUri = "https://issuer.example.test";
|
|
o.JwksUri = "https://issuer.example.test/.well-known/jwks";
|
|
});
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IIssuerKeyResolver)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddJwtIssuerConfigurationRegistersIssuerKeyResolver()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["IssuerUri"] = "https://issuer.example.test",
|
|
["JwksUri"] = "https://issuer.example.test/.well-known/jwks"
|
|
});
|
|
builder.AddJwtIssuer(config);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IIssuerKeyResolver)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddDurableSubscriptionsRegistersStoreAndFactory()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
ISubscriptionStore store = Mock.Of<ISubscriptionStore>();
|
|
IMonitoredItemQueueFactory queueFactory = Mock.Of<IMonitoredItemQueueFactory>();
|
|
builder.AddDurableSubscriptions(store, queueFactory);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<ISubscriptionStore>(), Is.SameAs(store));
|
|
Assert.That(sp.GetRequiredService<IMonitoredItemQueueFactory>(), Is.SameAs(queueFactory));
|
|
}
|
|
|
|
[Test]
|
|
public void AddDurableSubscriptionsNullStoreThrowsArgumentNullException()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
ISubscriptionStore? nullStore = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddDurableSubscriptions(nullStore!, Mock.Of<IMonitoredItemQueueFactory>()),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void AddDurableSubscriptionsNullFactoryThrowsArgumentNullException()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IMonitoredItemQueueFactory? nullFactory = null;
|
|
|
|
Assert.That(
|
|
() => builder.AddDurableSubscriptions(Mock.Of<ISubscriptionStore>(), nullFactory!),
|
|
Throws.TypeOf<ArgumentNullException>());
|
|
}
|
|
|
|
[Test]
|
|
public void AddSessionManagerFactoryRegistersRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddSessionManager((_, _, _) => Mock.Of<ISessionManager>());
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerSessionManagerRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddSessionManagerTypeRegistersRegistrationAndTransient()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddSessionManager<SessionManager>();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerSessionManagerRegistration)));
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(SessionManager)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddSubscriptionManagerFactoryRegistersRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddSubscriptionManager((_, _, _) => Mock.Of<ISubscriptionManager>());
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerSubscriptionManagerRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddSubscriptionManagerTypeRegistersRegistrationAndTransient()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddSubscriptionManager<SubscriptionManager>();
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerSubscriptionManagerRegistration)));
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(SubscriptionManager)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddHistorianRegistersHistorianProvider()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IHistorianProvider provider = Mock.Of<IHistorianProvider>();
|
|
builder.AddHistorian(provider);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<IHistorianProvider>(), Is.SameAs(provider));
|
|
}
|
|
|
|
[Test]
|
|
public void AddFileSystemProviderRegistersNodeManagerFactory()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IFileSystemProvider provider = Mock.Of<IFileSystemProvider>();
|
|
builder.AddFileSystem(provider);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(FileSystemNodeManagerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddFileSystemDirectoryRegistersPhysicalProvider()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddFileSystem(".", "TestMount", isWritable: false);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(FileSystemNodeManagerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddNodeManagerRegistersFactoryAndRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.AddNodeManager("http://test.org/UA/TestNs/", _ => { });
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IAsyncNodeManagerFactory)));
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerNodeManagerRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddSecretStoreRegistersStore()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
ISecretStore store = Mock.Of<ISecretStore>();
|
|
builder.AddSecretStore(store);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<ISecretStore>(), Is.SameAs(store));
|
|
}
|
|
|
|
[Test]
|
|
public void AddCertificateManagerRegistersCertificateManager()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
ICertificateManager certManager = Mock.Of<ICertificateManager>();
|
|
builder.AddCertificateManager(certManager);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<ICertificateManager>(), Is.SameAs(certManager));
|
|
}
|
|
|
|
[Test]
|
|
public void DefaultContainerDoesNotRegisterASharedTransactionCoordinatorSingleton()
|
|
{
|
|
// The PushManagement transaction coordinator holds mutable
|
|
// per-server transaction state (OPC 10000-12 §§7.10.2-7.10.11).
|
|
// A shared singleton would let two servers created from one
|
|
// container corrupt each other's transactions, so no default is
|
|
// registered - each server's ConfigurationNodeManager owns its own.
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetService<IPushConfigurationTransactionCoordinator>(), Is.Null);
|
|
}
|
|
|
|
[Test]
|
|
public void CustomTransactionCoordinatorRegistrationIsHonored()
|
|
{
|
|
// Custom injection is preserved: a host that registers its own
|
|
// coordinator gets exactly that instance back.
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IPushConfigurationTransactionCoordinator custom =
|
|
Mock.Of<IPushConfigurationTransactionCoordinator>();
|
|
builder.Services.AddSingleton(custom);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetService<IPushConfigurationTransactionCoordinator>(), Is.SameAs(custom));
|
|
}
|
|
|
|
[Test]
|
|
public void WithServerConfigurationResetRegistersProviderInstance()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IServerConfigurationResetProvider provider = Mock.Of<IServerConfigurationResetProvider>();
|
|
builder.WithServerConfigurationReset(provider);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetService<IServerConfigurationResetProvider>(), Is.SameAs(provider));
|
|
}
|
|
|
|
[Test]
|
|
public void WithApplicationConfigurationFileRegistersProviderInstance()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IApplicationConfigurationFileProvider provider = Mock.Of<IApplicationConfigurationFileProvider>();
|
|
builder.WithApplicationConfigurationFile(provider);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetService<IApplicationConfigurationFileProvider>(), Is.SameAs(provider));
|
|
}
|
|
|
|
[Test]
|
|
public void ConfigureServerConfigurationProjectsOptions()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
builder.ConfigureServerConfiguration(o =>
|
|
{
|
|
o.HasSecureElement = true;
|
|
o.InApplicationSetup = false;
|
|
});
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
ServerConfigurationOptions options =
|
|
sp.GetRequiredService<IOptions<ServerConfigurationOptions>>().Value;
|
|
Assert.Multiple(() =>
|
|
{
|
|
Assert.That(options.HasSecureElement, Is.True);
|
|
Assert.That(options.InApplicationSetup, Is.False);
|
|
});
|
|
}
|
|
|
|
[Test]
|
|
public void AddAliasNameStoreRegistersStoreAndRegistration()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IAliasNameStore aliasStore = Mock.Of<IAliasNameStore>();
|
|
builder.AddAliasNameStore(aliasStore);
|
|
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(OpcUaServerAliasNameStoreRegistration)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddAliasNameStoreRegistryRegistersRegistry()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IAliasNameStoreRegistry registry = Mock.Of<IAliasNameStoreRegistry>();
|
|
builder.AddAliasNameStoreRegistry(registry);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<IAliasNameStoreRegistry>(), Is.SameAs(registry));
|
|
}
|
|
|
|
[Test]
|
|
public void AddReverseConnectActionReturnsBuilder()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IOpcUaServerBuilder result = builder.AddReverseConnect(o => o.ConnectIntervalMs = 3000);
|
|
|
|
Assert.That(result, Is.SameAs(builder));
|
|
}
|
|
|
|
[Test]
|
|
public void AddReverseConnectConfigurationReturnsBuilder()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["ConnectIntervalMs"] = "3000"
|
|
});
|
|
IOpcUaServerBuilder result = builder.AddReverseConnect(config);
|
|
|
|
Assert.That(result, Is.SameAs(builder));
|
|
}
|
|
|
|
[Test]
|
|
public void ConfigureOperationLimitsActionReturnsBuilder()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IOpcUaServerBuilder result = builder.ConfigureOperationLimits(
|
|
o => o.MaxNodesPerRead = 500);
|
|
|
|
Assert.That(result, Is.SameAs(builder));
|
|
}
|
|
|
|
[Test]
|
|
public void ConfigureOperationLimitsConfigurationReturnsBuilder()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["MaxNodesPerRead"] = "500"
|
|
});
|
|
IOpcUaServerBuilder result = builder.ConfigureOperationLimits(config);
|
|
|
|
Assert.That(result, Is.SameAs(builder));
|
|
}
|
|
|
|
[Test]
|
|
public void AddReferenceServerRegistersServerFactory()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddOpcUa().AddReferenceServer();
|
|
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IOpcUaServerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddReferenceServerWithConfigureAppliesExtraOptions()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddOpcUa().AddReferenceServer(o =>
|
|
{
|
|
o.EndpointUrls.Clear();
|
|
o.EndpointUrls.Add("opc.tcp://localhost:0/ReferenceServer");
|
|
});
|
|
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IOpcUaServerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddSecureServerRegistersServerFactory()
|
|
{
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddOpcUa().AddSecureServer(o =>
|
|
{
|
|
o.ApplicationName = "SecureServer";
|
|
o.ApplicationUri = "urn:localhost:SecureServer";
|
|
o.ProductUri = "urn:localhost:SecureServer:Product";
|
|
});
|
|
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IOpcUaServerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddHistorianFileStoreRegistersHistorianAndFileSystem()
|
|
{
|
|
IOpcUaServerBuilder builder = CreateBuilder();
|
|
IHistorianProvider historian = Mock.Of<IHistorianProvider>();
|
|
builder.AddHistorianFileStore(historian, ".", "TestMount", isWritable: false);
|
|
|
|
using ServiceProvider sp = builder.Services.BuildServiceProvider();
|
|
|
|
Assert.That(sp.GetRequiredService<IHistorianProvider>(), Is.SameAs(historian));
|
|
Assert.That(
|
|
builder.Services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(FileSystemNodeManagerFactory)));
|
|
}
|
|
|
|
[Test]
|
|
public void AddServerSectionWithRolesRegistersRoleManager()
|
|
{
|
|
IConfiguration config = CreateConfiguration(new Dictionary<string, string?>
|
|
{
|
|
["OpcUa:Server:ApplicationName"] = "RolesServer",
|
|
["OpcUa:Server:ApplicationUri"] = "urn:test:RolesServer",
|
|
["OpcUa:Server:ProductUri"] = "urn:test:product",
|
|
["OpcUa:Server:Roles:Roles:0:RoleName"] = "Observer"
|
|
});
|
|
var services = new ServiceCollection();
|
|
services.AddLogging();
|
|
services.AddOpcUa().AddServer(config);
|
|
|
|
Assert.That(
|
|
services,
|
|
Has.Some.Matches<ServiceDescriptor>(
|
|
d => d.ServiceType == typeof(IRoleManager)));
|
|
}
|
|
|
|
// ── Private test doubles ─────────────────────────────────────────────
|
|
|
|
private sealed class CustomTestServer : StandardServer
|
|
{
|
|
public CustomTestServer(ITelemetryContext telemetry, TimeProvider timeProvider)
|
|
: base(telemetry, timeProvider)
|
|
{
|
|
}
|
|
}
|
|
|
|
private sealed class StubUserTokenAuthenticator : IUserTokenAuthenticator
|
|
{
|
|
/// <inheritdoc/>
|
|
public UserTokenType TokenType => UserTokenType.Anonymous;
|
|
|
|
/// <inheritdoc/>
|
|
public string? IssuedTokenProfileUri => null;
|
|
|
|
/// <inheritdoc/>
|
|
public ValueTask<AuthenticationResult> AuthenticateAsync(
|
|
AuthenticationContext context,
|
|
CancellationToken ct = default)
|
|
{
|
|
return new ValueTask<AuthenticationResult>(AuthenticationResult.NotHandled);
|
|
}
|
|
}
|
|
|
|
private sealed class StubIdentityAugmenter : IIdentityAugmenter
|
|
{
|
|
/// <inheritdoc/>
|
|
public ValueTask<AuthenticationResult> AugmentAsync(
|
|
IUserIdentity identity,
|
|
AuthenticationContext context,
|
|
CancellationToken ct = default)
|
|
{
|
|
return new ValueTask<AuthenticationResult>(AuthenticationResult.NotHandled);
|
|
}
|
|
}
|
|
}
|
|
}
|