com.unity.netcode.gameobjects/Tests/Runtime/NetworkManagerTransportTests.cs

using System;
using System.Collections;
using NUnit.Framework;
using Unity.Netcode.TestHelpers.Runtime;
using Unity.Netcode.Transports.UTP;
using Unity.Networking.Transport;
using UnityEngine;
using UnityEngine.TestTools;

namespace Unity.Netcode.RuntimeTests
{
    internal class NetworkManagerTransportTests
    {
        [Test]
        public void ClientDoesNotStartWhenTransportFails()
        {
            bool callbackInvoked = false;
            Action onTransportFailure = () => { callbackInvoked = true; };

            var manager = new GameObject().AddComponent<NetworkManager>();
            manager.OnTransportFailure += onTransportFailure;

            var transport = manager.gameObject.AddComponent<FailedTransport>();
            transport.FailOnStart = true;

            manager.NetworkConfig = new NetworkConfig() { NetworkTransport = transport };

            LogAssert.Expect(LogType.Error, $"[Netcode] Client is shutting down due to network transport start failure of {transport.GetType().Name}!");

            Assert.False(manager.StartClient());
            Assert.False(manager.IsListening);
            Assert.False(manager.IsConnectedClient);

            Assert.True(callbackInvoked);
        }

        [Test]
        public void HostDoesNotStartWhenTransportFails()
        {
            bool callbackInvoked = false;
            Action onTransportFailure = () => { callbackInvoked = true; };

            var manager = new GameObject().AddComponent<NetworkManager>();
            manager.OnTransportFailure += onTransportFailure;

            var transport = manager.gameObject.AddComponent<FailedTransport>();
            transport.FailOnStart = true;

            manager.NetworkConfig = new NetworkConfig() { NetworkTransport = transport };

            LogAssert.Expect(LogType.Error, $"[Netcode] Host is shutting down due to network transport start failure of {transport.GetType().Name}!");

            Assert.False(manager.StartHost());
            Assert.False(manager.IsListening);

            Assert.True(callbackInvoked);
        }

        [Test]
        public void ServerDoesNotStartWhenTransportFails()
        {
            bool callbackInvoked = false;
            Action onTransportFailure = () => { callbackInvoked = true; };

            var manager = new GameObject().AddComponent<NetworkManager>();
            manager.OnTransportFailure += onTransportFailure;

            var transport = manager.gameObject.AddComponent<FailedTransport>();
            transport.FailOnStart = true;

            manager.NetworkConfig = new NetworkConfig() { NetworkTransport = transport };

            LogAssert.Expect(LogType.Error, $"[Netcode] Server is shutting down due to network transport start failure of {transport.GetType().Name}!");

            Assert.False(manager.StartServer());
            Assert.False(manager.IsListening);

            Assert.True(callbackInvoked);
        }

        [UnityTest]
        public IEnumerator ShutsDownWhenTransportFails()
        {
            bool callbackInvoked = false;
            Action onTransportFailure = () => { callbackInvoked = true; };

            var manager = new GameObject().AddComponent<NetworkManager>();
            manager.OnTransportFailure += onTransportFailure;

            var transport = manager.gameObject.AddComponent<FailedTransport>();
            transport.FailOnNextPoll = true;

            manager.NetworkConfig = new NetworkConfig() { NetworkTransport = transport };

            Assert.True(manager.StartServer());
            Assert.True(manager.IsListening);

            LogAssert.Expect(LogType.Error, $"[Netcode] Server is shutting down due to network transport failure of {transport.GetType().Name}!");

            // Need two updates to actually shut down. First one to see the transport failing, which
            // marks the NetworkManager as shutting down. Second one where actual shutdown occurs.
            yield return null;
            yield return null;

            Assert.False(manager.IsListening);
            Assert.True(callbackInvoked);
        }

        /// <summary>
        /// Does nothing but simulate a transport that can fail at startup and/or when polling events.
        /// </summary>
        internal class FailedTransport : TestingNetworkTransport
        {
            public bool FailOnStart = false;
            public bool FailOnNextPoll = false;

            public override bool StartClient() => !FailOnStart;

            public override bool StartServer() => !FailOnStart;

            public override NetworkEvent PollEvent(out ulong clientId, out ArraySegment<byte> payload, out float receiveTime)
            {
                clientId = 0;
                payload = new ArraySegment<byte>();
                receiveTime = 0;

                if (FailOnNextPoll)
                {
                    FailOnNextPoll = false;
                    return NetworkEvent.TransportFailure;
                }
                else
                {
                    return NetworkEvent.Nothing;
                }
            }

            public override ulong ServerClientId => 0;

            public override void Send(ulong clientId, ArraySegment<byte> payload, NetworkDelivery networkDelivery)
            {
            }

            public override void Initialize(NetworkManager networkManager = null)
            {
            }

            public override void Shutdown()
            {
            }

            public override ulong GetCurrentRtt(ulong clientId) => 0;

            public override void DisconnectRemoteClient(ulong clientId)
            {
            }

            public override void DisconnectLocalClient()
            {
            }
        }
    }

    /// <summary>
    /// Verifies the UnityTransport.GetEndpoint method returns
    /// valid NetworkEndpoint information.
    /// </summary>
    internal class TransportEndpointTests : NetcodeIntegrationTest
    {
        protected override int NumberOfClients => 2;

        [UnityTest]
        public IEnumerator GetEndpointReportedCorrectly()
        {
            var serverUnityTransport = m_ServerNetworkManager.NetworkConfig.NetworkTransport as UnityTransport;
            var serverEndpoint = new NetworkEndpoint();
            var clientEndpoint = new NetworkEndpoint();
            foreach (var client in m_ClientNetworkManagers)
            {
                var unityTransport = client.NetworkConfig.NetworkTransport as UnityTransport;
                serverEndpoint = unityTransport.GetEndpoint(m_ServerNetworkManager.LocalClientId);
                clientEndpoint = serverUnityTransport.GetEndpoint(client.LocalClientId);
                Assert.IsTrue(serverEndpoint.IsValid);
                Assert.IsTrue(clientEndpoint.IsValid);
                Assert.IsTrue(clientEndpoint.Address.Split(":")[0] == unityTransport.ConnectionData.Address);
                Assert.IsTrue(serverEndpoint.Address.Split(":")[0] == serverUnityTransport.ConnectionData.Address);
                Assert.IsTrue(serverEndpoint.Port == unityTransport.ConnectionData.Port);
                Assert.IsTrue(clientEndpoint.Port >= serverUnityTransport.ConnectionData.Port);
            }

            // Now validate that when disconnected it returns a non-valid NetworkEndPoint
            var clientId = m_ClientNetworkManagers[0].LocalClientId;
            m_ClientNetworkManagers[0].Shutdown();
            yield return s_DefaultWaitForTick;

            serverEndpoint = (m_ClientNetworkManagers[0].NetworkConfig.NetworkTransport as UnityTransport).GetEndpoint(m_ServerNetworkManager.LocalClientId);
            clientEndpoint = serverUnityTransport.GetEndpoint(clientId);
            Assert.IsFalse(serverEndpoint.IsValid);
            Assert.IsFalse(clientEndpoint.IsValid);

            // Validate that invalid client identifiers return an invalid NetworkEndPoint
            serverEndpoint = (m_ClientNetworkManagers[0].NetworkConfig.NetworkTransport as UnityTransport).GetEndpoint((ulong)UnityEngine.Random.Range(NumberOfClients + 1, 30));
            clientEndpoint = serverUnityTransport.GetEndpoint((ulong)UnityEngine.Random.Range(NumberOfClients + 1, 30));
            Assert.IsFalse(serverEndpoint.IsValid);
            Assert.IsFalse(clientEndpoint.IsValid);
        }
    }
}