/* ========================================================================
* 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.IO;
using System.Threading;
using System.Threading.Tasks;
using NUnit.Framework;
using Opc.Ua.Tests;
namespace Opc.Ua.Core.Tests
{
[TestFixture]
[SetCulture("en-us")]
[SetUICulture("en-us")]
public class ApplicationConfigurationTests
{
private ITelemetryContext m_telemetry;
[SetUp]
public void SetUp()
{
m_telemetry = NUnitTelemetryContext.Create();
}
[Test]
///
/// Parameterless constructor creates a valid instance.
///
public void ConstructorDefault()
{
var config = new ApplicationConfiguration();
Assert.That(config, Is.Not.Null);
}
[Test]
///
/// Constructor with telemetry creates a valid instance.
///
public void ConstructorWithTelemetry()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config, Is.Not.Null);
}
[Test]
///
/// Copy constructor copies all supported properties.
///
public void ConstructorCopy()
{
var original = new ApplicationConfiguration(m_telemetry)
{
ApplicationName = "TestApp",
ApplicationUri = "urn:test:app",
ApplicationType = ApplicationType.Server,
DisableHiResClock = true
};
var copy = new ApplicationConfiguration(original);
Assert.That(copy.ApplicationName, Is.EqualTo("TestApp"));
Assert.That(copy.ApplicationUri, Is.EqualTo("urn:test:app"));
Assert.That(copy.ApplicationType, Is.EqualTo(ApplicationType.Server));
Assert.That(copy.DisableHiResClock, Is.True);
}
[Test]
///
/// ApplicationName get/set round-trips correctly.
///
public void ApplicationNameGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
ApplicationName = "MyApp"
};
Assert.That(config.ApplicationName, Is.EqualTo("MyApp"));
}
[Test]
///
/// ApplicationName defaults to null.
///
public void ApplicationNameDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ApplicationName, Is.Null);
}
[Test]
///
/// ApplicationUri get/set round-trips correctly.
///
public void ApplicationUriGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
ApplicationUri = "urn:test:myapp"
};
Assert.That(config.ApplicationUri, Is.EqualTo("urn:test:myapp"));
}
[Test]
///
/// ApplicationUri defaults to null.
///
public void ApplicationUriDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ApplicationUri, Is.Null);
}
[Test]
///
/// ProductUri get/set round-trips correctly.
///
public void ProductUriGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
ProductUri = "urn:test:product"
};
Assert.That(config.ProductUri, Is.EqualTo("urn:test:product"));
}
[Test]
///
/// ProductUri defaults to null.
///
public void ProductUriDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ProductUri, Is.Null);
}
[Test]
///
/// ApplicationType get/set round-trips correctly.
///
public void ApplicationTypeGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
ApplicationType = ApplicationType.ClientAndServer
};
Assert.That(config.ApplicationType, Is.EqualTo(ApplicationType.ClientAndServer));
}
[Test]
///
/// ApplicationType defaults to Server.
///
public void ApplicationTypeDefaultIsServer()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ApplicationType, Is.EqualTo(ApplicationType.Server));
}
[Test]
///
/// ServerConfiguration get/set round-trips correctly.
///
public void ServerConfigurationGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
var serverConfig = new ServerConfiguration();
config.ServerConfiguration = serverConfig;
Assert.That(config.ServerConfiguration, Is.SameAs(serverConfig));
}
[Test]
///
/// ServerConfiguration defaults to null.
///
public void ServerConfigurationDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ServerConfiguration, Is.Null);
}
[Test]
///
/// ClientConfiguration get/set round-trips correctly.
///
public void ClientConfigurationGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
var clientConfig = new ClientConfiguration();
config.ClientConfiguration = clientConfig;
Assert.That(config.ClientConfiguration, Is.SameAs(clientConfig));
}
[Test]
///
/// ClientConfiguration defaults to null.
///
public void ClientConfigurationDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.ClientConfiguration, Is.Null);
}
[Test]
///
/// SecurityConfiguration is created by default constructor.
///
public void SecurityConfigurationDefaultIsNotNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.SecurityConfiguration, Is.Not.Null);
}
[Test]
///
/// SecurityConfiguration set with null reverts to default.
///
public void SecurityConfigurationSetNullReturnsDefault()
{
var config = new ApplicationConfiguration(m_telemetry)
{
SecurityConfiguration = null
};
Assert.That(config.SecurityConfiguration, Is.Not.Null);
}
[Test]
///
/// SecurityConfiguration get/set round-trips correctly.
///
public void SecurityConfigurationGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
var secConfig = new SecurityConfiguration();
config.SecurityConfiguration = secConfig;
Assert.That(config.SecurityConfiguration, Is.SameAs(secConfig));
}
[Test]
///
/// TransportQuotas get/set round-trips correctly.
///
public void TransportQuotasGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
var quotas = new TransportQuotas();
config.TransportQuotas = quotas;
Assert.That(config.TransportQuotas, Is.SameAs(quotas));
}
[Test]
///
/// TransportQuotas defaults to null.
///
public void TransportQuotasDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.TransportQuotas, Is.Null);
}
[Test]
///
/// TransportConfigurations is created by default constructor.
///
public void TransportConfigurationsDefaultIsNotNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.TransportConfigurations.IsNull, Is.False);
}
[Test]
///
/// TransportConfigurations get/set round-trips correctly.
///
public void TransportConfigurationsGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
TransportConfigurations = new List
{
new("opc.tcp", typeof(object))
}.ToArrayOf()
};
Assert.That(config.TransportConfigurations.Count, Is.EqualTo(1));
}
[Test]
///
/// CertificateManager is null by default before validation.
///
public void CertificateManagerDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.CertificateManager, Is.Null);
}
[Test]
///
/// CertificateManager get/set round-trips correctly.
///
public void CertificateManagerGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
using var manager = new CertificateManager(m_telemetry);
config.CertificateManager = manager;
Assert.That(config.CertificateManager, Is.SameAs(manager));
}
[Test]
///
/// TraceConfiguration get/set round-trips correctly.
///
public void TraceConfigurationGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
TraceConfiguration = new TraceConfiguration { OutputFilePath = "trace.log" }
};
Assert.That(config.TraceConfiguration, Is.Not.Null);
Assert.That(config.TraceConfiguration.OutputFilePath, Is.EqualTo("trace.log"));
}
[Test]
///
/// TraceConfiguration defaults to null.
///
public void TraceConfigurationDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.TraceConfiguration, Is.Null);
}
[Test]
///
/// DisableHiResClock get/set round-trips correctly.
///
public void DisableHiResClockGetSet()
{
var config = new ApplicationConfiguration(m_telemetry)
{
DisableHiResClock = true
};
Assert.That(config.DisableHiResClock, Is.True);
}
[Test]
///
/// DisableHiResClock defaults to false.
///
public void DisableHiResClockDefaultIsFalse()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.DisableHiResClock, Is.False);
}
[Test]
///
/// DiscoveryServerConfiguration get/set round-trips correctly.
///
public void DiscoveryServerConfigurationGetSet()
{
var config = new ApplicationConfiguration(m_telemetry);
var dsc = new DiscoveryServerConfiguration();
config.DiscoveryServerConfiguration = dsc;
Assert.That(config.DiscoveryServerConfiguration, Is.SameAs(dsc));
}
[Test]
///
/// DiscoveryServerConfiguration defaults to null.
///
public void DiscoveryServerConfigurationDefaultIsNull()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.DiscoveryServerConfiguration, Is.Null);
}
[Test]
///
/// Properties dictionary is accessible and initially empty.
///
public void PropertiesDictionaryIsAccessible()
{
var config = new ApplicationConfiguration(m_telemetry);
Assert.That(config.Properties, Is.Not.Null);
Assert.That(config.Properties, Is.Empty);
}
[Test]
///
/// GetOrAddProperty runs the factory once when the key is absent.
///
public void GetOrAddPropertyAddsWhenKeyIsAbsent()
{
var config = new ApplicationConfiguration(m_telemetry);
int calls = 0;
string value = config.GetOrAddProperty("key", () => { calls++; return "made"; });
Assert.That(value, Is.EqualTo("made"));
Assert.That(calls, Is.EqualTo(1));
Assert.That(config.Properties["key"], Is.EqualTo("made"));
}
[Test]
///
/// GetOrAddProperty does not run the factory when a value is present.
///
public void GetOrAddPropertyDoesNotRunFactoryWhenKeyIsPresent()
{
var config = new ApplicationConfiguration(m_telemetry);
config.Properties["key"] = "existing";
string value = config.GetOrAddProperty(
"key",
() => throw new InvalidOperationException("factory must not run"));
Assert.That(value, Is.EqualTo("existing"));
}
[Test]
///
/// Concurrent callers all observe the same instance, which is what the
/// removed PropertiesLock was taken for.
///
public void GetOrAddPropertyPublishesOneInstanceToConcurrentCallers()
{
var config = new ApplicationConfiguration(m_telemetry);
const int callers = 32;
using var start = new ManualResetEventSlim(false);
var results = new object[callers];
var threads = new Thread[callers];
for (int i = 0; i < callers; i++)
{
int index = i;
threads[i] = new Thread(() =>
{
start.Wait();
results[index] = config.GetOrAddProperty