using System;
using System.Collections;
using System.Collections.Generic;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
using Object = UnityEngine.Object;
namespace Unity.Netcode.RuntimeTests
{
public class NetworkBehaviourUpdaterTests : BaseMultiInstanceTest
{
protected override int NbClients => throw new NotSupportedException("handled per test");
private static Type[] s_TypesToTest = new[] { null, typeof(ZeroNetVar), typeof(OneNetVar), typeof(TwoNetVar) };
[UnitySetUp]
public override IEnumerator Setup()
{
yield break;
}
///
/// This runs test combinations for the following
/// test with 0, 1, 2 clients
/// test with host and server mode
/// test with 0, 1, 2 spawned objects
/// test with 0, 1, 2 network behaviour per prefab
/// test with 0, 1, 2 network variable per network behaviour
/// for each, update netvar
/// for each check value changed
/// check that all network variables are no longer dirty after update
///
///
///
///
///
///
///
///
[UnityTest]
public IEnumerator BehaviourUpdaterAllTests([Values(0, 1, 2)] int nbClients, [Values] bool useHost, [Values(0, 1, 2)] int nbSpawnedObjects,
[ValueSource(nameof(s_TypesToTest))] Type firstNetworkBehaviour, [ValueSource(nameof(s_TypesToTest))] Type secondNetworkBehaviour)
{
// Create multiple NetworkManager instances
if (!MultiInstanceHelpers.Create(nbClients, out NetworkManager server, out NetworkManager[] clients))
{
Debug.LogError("Failed to create instances");
Assert.Fail("Failed to create instances");
}
m_ClientNetworkManagers = clients;
m_ServerNetworkManager = server;
Assert.That(m_ClientNetworkManagers.Length, Is.EqualTo(nbClients));
Assert.That(m_ServerNetworkManager, Is.Not.Null);
// setup prefab to spawn
void AddNetworkBehaviour(Type type, GameObject prefab)
{
if (type != null)
{
var info = prefab.AddComponent(type) as INetVarInfo;
}
}
var prefabToSpawn = new GameObject();
var networkObjectPrefab = prefabToSpawn.AddComponent();
AddNetworkBehaviour(firstNetworkBehaviour, prefabToSpawn);
AddNetworkBehaviour(secondNetworkBehaviour, prefabToSpawn);
MultiInstanceHelpers.MakeNetworkObjectTestPrefab(networkObjectPrefab);
m_ServerNetworkManager.NetworkConfig.NetworkPrefabs.Add(new NetworkPrefab() { Prefab = prefabToSpawn });
foreach (var clientNetworkManager in m_ClientNetworkManagers)
{
clientNetworkManager.NetworkConfig.NetworkPrefabs.Add(new NetworkPrefab() { Prefab = prefabToSpawn });
}
// Start the instances
if (!MultiInstanceHelpers.Start(useHost, server, clients))
{
Debug.LogError("Failed to start instances");
Assert.Fail("Failed to start instances");
}
// Wait for connection on client side
yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clients));
// Wait for connection on server side
yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnectedToServer(server, clientCount: useHost ? nbClients + 1 : nbClients));
// gathering netvars to test on
var serverNetVarsToUpdate = new List>();
for (int i = 0; i < nbSpawnedObjects; i++)
{
var spawnedObject = Object.Instantiate(prefabToSpawn);
var networkSpawnedObject = spawnedObject.GetComponent();
networkSpawnedObject.NetworkManagerOwner = m_ServerNetworkManager;
networkSpawnedObject.Spawn();
int nbBehaviours = 0;
foreach (var networkBehaviour in spawnedObject.GetComponents())
{
serverNetVarsToUpdate.AddRange(((INetVarInfo)networkBehaviour).AllNetVars);
nbBehaviours++;
}
Assert.That(nbBehaviours, Is.EqualTo((firstNetworkBehaviour == null ? 0 : 1) + (secondNetworkBehaviour == null ? 0 : 1)));
}
var serverNetVarCount = serverNetVarsToUpdate.Count;
yield return new WaitForSeconds(0); // wait a frame to make sure spawn is done
// todo: with Snapshot spawns enabled and the current race condition, the following line is needed:
// yield return new WaitForSeconds(0.2f); // wait a bit to fix the spawn/update race condition
foreach (var netVar in serverNetVarsToUpdate)
{
Assert.That(netVar.Value, Is.EqualTo(0)); // sanity check
}
// test updating all netvars
int updatedValue = 1;
foreach (var netVar in serverNetVarsToUpdate)
{
netVar.Value = updatedValue;
Assert.That(netVar.IsDirty, Is.True);
}
m_ServerNetworkManager.BehaviourUpdater.NetworkBehaviourUpdate(m_ServerNetworkManager);
// make sure we're not dirty anymore and that clients will receive that new value
foreach (var netVar in serverNetVarsToUpdate)
{
// if we don't have connected clients, netvars remain dirty
Assert.That(netVar.IsDirty, nbClients > 0 || useHost ? Is.Not.True : Is.True);
}
foreach (var client in m_ClientNetworkManagers)
{
var nbVarsCheckedClientSide = 0;
var countSpawnObjectResult = new MultiInstanceHelpers.CoroutineResultWrapper();
yield return MultiInstanceHelpers.WaitForCondition(() => client.SpawnManager.SpawnedObjects.Count == nbSpawnedObjects, countSpawnObjectResult);
Assert.That(countSpawnObjectResult.Result, Is.True);
foreach (var spawnedObject in client.SpawnManager.SpawnedObjects)
{
foreach (var behaviour in spawnedObject.Value.GetComponentsInChildren())
{
foreach (var networkVariable in behaviour.NetworkVariableFields)
{
var varInt = networkVariable as NetworkVariable;
var varUpdateResult = new MultiInstanceHelpers.CoroutineResultWrapper();
yield return MultiInstanceHelpers.WaitForCondition(() => varInt.Value == updatedValue, varUpdateResult);
Assert.That(varUpdateResult.Result, Is.True);
nbVarsCheckedClientSide++;
Assert.That(varInt.Value, Is.EqualTo(updatedValue));
}
}
}
Assert.That(nbVarsCheckedClientSide, Is.EqualTo(m_ClientNetworkManagers.Length > 0 ? serverNetVarCount : 0));
}
}
}
public interface INetVarInfo
{
public List> AllNetVars { get; }
}
public class ZeroNetVar : NetworkBehaviour, INetVarInfo
{
public List> AllNetVars => new List>(); // Needed to be independant from NetworkBehaviour's list of fields. This way, if that changes, we can still do this validation in this test
}
public class OneNetVar : NetworkBehaviour, INetVarInfo
{
private NetworkVariable m_SomeValue = new NetworkVariable();
public List> AllNetVars => new List>() { m_SomeValue };
}
public class TwoNetVar : NetworkBehaviour, INetVarInfo
{
private NetworkVariable m_SomeValue = new NetworkVariable();
private NetworkVariable m_SomeOtherValue = new NetworkVariable();
public List> AllNetVars => new List>() { m_SomeValue, m_SomeOtherValue };
}
}