modules/platforms/dotnet/Apache.Ignite.Tests/RawSocketConnectionTests.cs

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// ReSharper disable MustUseReturnValue
namespace Apache.Ignite.Tests
{
    using System;
    using System.Buffers;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Net;
    using System.Net.Sockets;
    using System.Text;
    using System.Threading.Tasks;
    using MessagePack;
    using NUnit.Framework;

    /// <summary>
    /// Tests protocol basics with simple socket connection.
    /// </summary>
    public class RawSocketConnectionTests : IgniteTestsBase
    {
        private static readonly byte[] Magic = "IGNI".Select(c => (byte)c).ToArray();

        [Test]
        public async Task TestCorrectHandshakeReturnsSuccess()
        {
            await using var stream = await Connect();

            await stream.WriteAsync(Magic);
            WriteHandshake(stream);

            await stream.FlushAsync();
            await CheckResponseMagic(stream);

            ReadHandshake(stream);
        }

        [Test]
        public async Task TestUnsupportedVersionHandshakeReturnsError()
        {
            await using var stream = await Connect();

            await stream.WriteAsync(Magic);
            WriteHandshake(stream, majorVersion: 33);

            await stream.FlushAsync();
            await CheckResponseMagic(stream);

            var ex = Assert.Throws<AssertionException>(() => ReadHandshake(stream));
            StringAssert.Contains("Unsupported version: 33.0.0", ex!.Message);
        }

        [Test]
        public async Task TestServerIgnoresUnknownFeaturesAndExtensions()
        {
            await using var stream = await Connect();

            await stream.WriteAsync(Magic);

            WriteHandshake(
                stream,
                features: Guid.NewGuid().ToByteArray(),
                extensions: new Dictionary<string, object>
                {
                    { "foobar", 1 },
                    { "foobar2", "s" }
                });

            await stream.FlushAsync();
            await CheckResponseMagic(stream);

            ReadHandshake(stream);
        }

        private static async Task CheckResponseMagic(NetworkStream stream)
        {
            var responseMagic = new byte[4];
            await stream.ReadAsync(responseMagic);

            CollectionAssert.AreEqual(Magic, responseMagic);
        }

        private static unsafe void ReadHandshake(NetworkStream stream)
        {
            var msgSize = 0;
            stream.ReadExactly(new Span<byte>(&msgSize, 4));
            msgSize = IPAddress.NetworkToHostOrder(msgSize);

            var msg = new byte[msgSize];
            stream.ReadExactly(msg);

            var str = Encoding.UTF8.GetString(msg);

            StringAssert.Contains("PlatformTestNodeRunner", str);

            // Protocol version.
            Assert.AreEqual(3, msg[0]);
            Assert.AreEqual(0, msg[1]);
            Assert.AreEqual(0, msg[2]);

            // Result code (null = success).
            Assert.AreEqual(MessagePackCode.Nil, msg[3]);
        }

        private static unsafe void WriteHandshake(
            Stream stream,
            int majorVersion = 3,
            byte[]? features = null,
            Dictionary<string, object>? extensions = null)
        {
            var bufferWriter = new ArrayBufferWriter<byte>();
            var writer = new MessagePackWriter(bufferWriter);

            // Version.
            writer.Write(majorVersion);
            writer.Write(0);
            writer.Write(0);

            writer.Write(2); // Client type: general purpose.

            if (features == null)
            {
                writer.WriteBinHeader(0);
            }
            else
            {
                writer.Write(features);
            }

            if (extensions == null)
            {
                writer.Write(0);
            }
            else
            {
                writer.Write(extensions.Count);

                foreach (var (key, value) in extensions)
                {
                    writer.Write(key);

                    if (value is string s)
                    {
                        writer.Write(s);
                    }
                    else
                    {
                        writer.Write((int)value);
                    }
                }
            }

            writer.Flush();

            // Write big-endian message size.
            var msgSize = IPAddress.HostToNetworkOrder(bufferWriter.WrittenCount);

            stream.Write(new ReadOnlySpan<byte>(&msgSize, 4));

            // Write message.
            stream.Write(bufferWriter.WrittenSpan);
        }

        private static async Task<NetworkStream> Connect()
        {
            Socket socket = new(SocketType.Stream, ProtocolType.Tcp)
            {
                NoDelay = true
            };

            await socket.ConnectAsync(IPAddress.Loopback, ServerPort);

            return new NetworkStream(socket, ownsSocket: true);
        }
    }
}