UA-.NETStandard/tests/Opc.Ua.Redundancy.Client.Tests/RaftClientSharedStoreTests.cs

/* ========================================================================
 * 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/
 * ======================================================================*/

// IDE0230: byte-array literals below are opaque binary test vectors, not text; a
// UTF-8 "..."u8 literal would misrepresent their intent, so keep the explicit byte arrays.
#pragma warning disable IDE0230 // Use UTF-8 string literal

// 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.Threading.Tasks;
using Crdt;
using Crdt.Transport;
using Microsoft.Extensions.DependencyInjection;
using NUnit.Framework;
using Opc.Ua.Redundancy;
using Opc.Ua.Redundancy.Client;

namespace Opc.Ua.Client.Redundancy.Tests
{
    /// <summary>
    /// Coverage for the Raft-backed client shared-store dependency-injection registrations.
    /// </summary>
    [TestFixture]
    [Category("ClientRedundancy")]
    public sealed class RaftClientSharedStoreTests
    {
        [Test]
        public async Task AddRaftClientSharedStoreRegistersStoreAndElectionAsync()
        {
            var services = new ServiceCollection();
            services.AddRaftClientSharedStore();
            await using ServiceProvider provider = services.BuildServiceProvider();

            ISharedKeyValueStore store = provider.GetRequiredService<ISharedKeyValueStore>();
            ILeaderElection election = provider.GetRequiredService<ILeaderElection>();

            Assert.That(store, Is.InstanceOf<RaftSharedKeyValueStore>());
            Assert.That(election, Is.InstanceOf<RaftLeaderElection>());

            bool created = await store.CompareAndSwapAsync(
                "session/a", default, new ByteString(new byte[] { 1, 2, 3 })).ConfigureAwait(false);
            Assert.That(created, Is.True, "the client store provides a linearizable compare-and-swap");
        }

        [Test]
        public async Task AddRedundantClientSharedStoreStrongUsesRaftStoreAsync()
        {
            var services = new ServiceCollection();
            services.AddRedundantClientSharedStore(RedundancyConsistencyMode.Strong, ReplicaId.New());
            await using ServiceProvider provider = services.BuildServiceProvider();

            Assert.That(
                provider.GetRequiredService<ISharedKeyValueStore>(),
                Is.InstanceOf<RaftSharedKeyValueStore>());
        }

        [Test]
        public async Task AddRedundantClientSharedStoreEventualUsesHybridStoreAsync()
        {
            await using var network = new InMemoryNetwork();
            var services = new ServiceCollection();
            services.AddRedundantClientSharedStore(
                RedundancyConsistencyMode.Eventual, ReplicaId.New(), _ => network.CreateTransport());
            await using ServiceProvider provider = services.BuildServiceProvider();

            ISharedKeyValueStore store = provider.GetRequiredService<ISharedKeyValueStore>();
            Assert.That(store, Is.InstanceOf<HybridSharedKeyValueStore>());

            // The strong-prefix keyspace gets linearizable CAS via Raft.
            bool created = await store.CompareAndSwapAsync(
                "nonce/x", default, new ByteString(new byte[] { 9 })).ConfigureAwait(false);
            Assert.That(created, Is.True);
        }

        [Test]
        public void AddRedundantClientSharedStoreEventualRequiresCrdtTransport()
        {
            var services = new ServiceCollection();

            Assert.That(
                () => services.AddRedundantClientSharedStore(
                    RedundancyConsistencyMode.Eventual, ReplicaId.New()),
                Throws.TypeOf<ArgumentNullException>());
        }
    }
}