/* ========================================================================
* 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/
* ======================================================================*/
// CA2007: tests run without a SynchronizationContext; ConfigureAwait(false)
// adds noise without a behavioural benefit. Disabled file-level for the suite.
#pragma warning disable CA2007
using System;
using System.Linq;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Redundancy;
using Opc.Ua.Redundancy.Server;
using Opc.Ua.Server.TestFramework;
using Quickstarts.ReferenceServer;
namespace Opc.Ua.Server.Tests.Redundancy
{
///
/// Integration test that drives a real, fully-started whose
/// is a configured , and verifies
/// end to end that a GetEndpoints request on the balancing URL is answered with a peer's endpoints while a
/// normal request serves the local server. Closes the seam-wiring gap the director unit tests cannot exercise.
///
[TestFixture]
[Category("Distributed")]
[NonParallelizable]
public class LoadDirectionServerIntegrationTests
{
private const string BalancingUrl = "opc.tcp://balance.invalid:4840";
private InMemorySharedKeyValueStore m_kv = null!;
private LoadDirectionOptions m_options = null!;
private ServerLoadDirector m_director = null!;
private ServerFixture m_fixture = null!;
private StandardServer m_server = null!;
[OneTimeSetUp]
public async Task OneTimeSetUpAsync()
{
m_kv = new InMemorySharedKeyValueStore();
m_options = new LoadDirectionOptions { BalancingEndpointUrl = BalancingUrl };
m_director = new ServerLoadDirector(
new ConstantServiceLevelProvider(100), // local is a Degraded standby
new ConstantLoadWeightProvider(200),
m_options);
m_fixture = new ServerFixture(t => new ReferenceServer(t)
{
GetEndpointsDirector = m_director
});
m_server = await m_fixture.StartAsync().ConfigureAwait(false);
IServiceMessageContext context = m_server.CurrentInstance.MessageContext;
string localServerUri = m_server.CurrentInstance.ServerUris.ToArray()[0];
var view = new SharedPeerDirectionView(
m_kv, context, NullRecordProtector.Instance, m_options, TimeProvider.System);
var policy = new BandedServerDirectionPolicy(view, m_options, _ => 0);
var directory = new SharedPeerEndpointDirectory(m_kv, context, NullRecordProtector.Instance, m_options);
var publisher = new SharedPeerEndpointPublisher(
m_kv, context, NullRecordProtector.Instance, m_options, localServerUri);
m_director.Configure(policy, directory, publisher, localServerUri);
// Seed peer B: healthy, unloaded, with endpoints.
var bDirection = new SharedPeerDirectionPublisher(
m_kv, context, NullRecordProtector.Instance, m_options, TimeProvider.System, "urn:B");
await bDirection.PublishServiceLevelAsync(255).ConfigureAwait(false);
await bDirection.PublishLoadWeightAsync(0).ConfigureAwait(false);
var bEndpoints = new SharedPeerEndpointPublisher(
m_kv, context, NullRecordProtector.Instance, m_options, "urn:B");
await bEndpoints.PublishAsync([MakeEndpoint("opc.tcp://b.example:4840", "urn:B")]).ConfigureAwait(false);
}
[OneTimeTearDown]
public async Task OneTimeTearDownAsync()
{
if (m_fixture != null)
{
await m_fixture.StopAsync().ConfigureAwait(false);
}
m_kv?.Dispose();
}
[Test]
public async Task GetEndpointsOnBalancingUrlRedirectsToHealthierPeerAsync()
{
GetEndpointsResponse response = await m_server.GetEndpointsAsync(
CreateChannelContext(), new RequestHeader(), BalancingUrl, default, default, RequestLifetime.None).ConfigureAwait(false);
EndpointDescription[] endpoints = response.Endpoints.ToArray()!;
Assert.That(endpoints, Has.Length.EqualTo(1));
Assert.That(endpoints[0].Server?.ApplicationUri, Is.EqualTo("urn:B"));
}
[Test]
public async Task GetEndpointsOnNormalUrlServesLocalServerAsync()
{
string normalUrl = m_server.GetEndpoints().ToArray()![0].EndpointUrl!;
GetEndpointsResponse response = await m_server.GetEndpointsAsync(
CreateChannelContext(), new RequestHeader(), normalUrl, default, default, RequestLifetime.None).ConfigureAwait(false);
EndpointDescription[] endpoints = response.Endpoints.ToArray()!;
Assert.That(endpoints, Is.Not.Empty, "a normal request returns the local server's own endpoints");
Assert.That(
endpoints.Any(e => string.Equals(e.Server?.ApplicationUri, "urn:B", StringComparison.Ordinal)),
Is.False,
"a normal request must not be redirected to a peer");
}
private SecureChannelContext CreateChannelContext()
{
EndpointDescription endpoint = m_server.GetEndpoints().ToArray()![0];
return new SecureChannelContext("loaddir-test", endpoint, RequestEncoding.Binary, null, null, null);
}
private static EndpointDescription MakeEndpoint(string url, string serverUri)
{
return new EndpointDescription
{
EndpointUrl = url,
SecurityMode = MessageSecurityMode.None,
SecurityPolicyUri = SecurityPolicies.None,
Server = new ApplicationDescription
{
ApplicationUri = serverUri,
ApplicationType = ApplicationType.Server
}
};
}
}
}