using System.Collections;
using NUnit.Framework;
using Unity.Netcode.Components;
using Unity.Netcode.TestHelpers.Runtime;
using UnityEngine;
using UnityEngine.TestTools;
namespace Unity.Netcode.RuntimeTests
{
///
/// This class is for testing general fixes or functionality of NetworkBehaviours
///
internal class NetworkBehaviourGenericTests : NetcodeIntegrationTest
{
protected override int NumberOfClients => 0;
private bool m_AllowServerToStart;
protected override bool CanStartServerAndClients()
{
return m_AllowServerToStart;
}
internal class SimpleNetworkBehaviour : NetworkBehaviour
{
public bool OnNetworkDespawnCalled;
public override void OnNetworkDespawn()
{
OnNetworkDespawnCalled = true;
base.OnNetworkDespawn();
}
}
protected override IEnumerator OnSetup()
{
m_AllowServerToStart = false;
return base.OnSetup();
}
///
/// This validates the fix for when a child GameObject with a NetworkBehaviour
/// is deleted while the parent GameObject with a NetworkObject is spawned and
/// is not deleted until a later time would cause an exception due to the
/// NetworkBehaviour not being removed from the NetworkObject.ChildNetworkBehaviours
/// list.
///
[UnityTest]
public IEnumerator ValidatedDisableddNetworkBehaviourWarning()
{
m_AllowServerToStart = true;
yield return s_DefaultWaitForTick;
// Now just start the Host
yield return StartServerAndClients();
var parentObject = new GameObject();
var childObject = new GameObject
{
name = "ChildObject"
};
childObject.transform.parent = parentObject.transform;
var parentNetworkObject = parentObject.AddComponent();
var childBehaviour = childObject.AddComponent();
// Set the child object to be inactive in the hierarchy
childObject.SetActive(false);
LogAssert.Expect(LogType.Warning, $"{childObject.name} is disabled! Netcode for GameObjects does not support spawning disabled NetworkBehaviours! The {childBehaviour.GetType().Name} component was skipped during spawn!");
parentNetworkObject.Spawn();
yield return s_DefaultWaitForTick;
}
///
/// This test validates a fix to NetworkBehaviour.NetworkObject when
/// the NetworkManager.LogLevel is set to Developer
/// Note: This test does not require any clients, but should not impact this
/// particular test if new tests are added to this class that do require clients
///
[UnityTest]
public IEnumerator ValidateNoSpam()
{
m_AllowServerToStart = true;
var objectToTest = new GameObject();
var simpleNetworkBehaviour = objectToTest.AddComponent();
// Now just start the Host
yield return StartServerAndClients();
// set the log level to developer
m_ServerNetworkManager.LogLevel = LogLevel.Developer;
// The only valid condition for this would be if the NetworkBehaviour is spawned.
simpleNetworkBehaviour.IsSpawned = true;
// Verify the warning gets logged under normal conditions
var isNull = simpleNetworkBehaviour.NetworkObject == null;
LogAssert.Expect(LogType.Warning, $"[Netcode] Could not get {nameof(NetworkObject)} for the {nameof(NetworkBehaviour)}. Are you missing a {nameof(NetworkObject)} component?");
var networkObjectToTest = objectToTest.AddComponent();
networkObjectToTest.NetworkManagerOwner = m_ServerNetworkManager;
networkObjectToTest.Spawn();
// Assure no log messages are logged when they should not be logged
isNull = simpleNetworkBehaviour.NetworkObject != null;
LogAssert.NoUnexpectedReceived();
networkObjectToTest.Despawn();
Object.Destroy(networkObjectToTest);
}
///
/// This validates the fix for when a child GameObject with a NetworkBehaviour
/// is deleted while the parent GameObject with a NetworkObject is spawned and
/// is not deleted until a later time would cause an exception due to the
/// NetworkBehaviour not being removed from the NetworkObject.ChildNetworkBehaviours
/// list.
///
[UnityTest]
public IEnumerator ValidateDeleteChildNetworkBehaviour()
{
m_AllowServerToStart = true;
yield return s_DefaultWaitForTick;
// Now just start the Host
yield return StartServerAndClients();
var parentObject = new GameObject();
var childObject = new GameObject();
childObject.transform.parent = parentObject.transform;
var parentNetworkObject = parentObject.AddComponent();
childObject.AddComponent();
parentNetworkObject.Spawn();
yield return s_DefaultWaitForTick;
// Destroy the child object with child NetworkBehaviour
Object.Destroy(childObject);
yield return s_DefaultWaitForTick;
// Assure no log messages are logged when they should not be logged
LogAssert.NoUnexpectedReceived();
// Destroy the parent object which should not cause any exceptions
// (validating the fix)
Object.Destroy(parentObject);
}
protected override void OnPlayerPrefabGameObjectCreated()
{
// Adds the SimpleNetworkBehaviour before the NetworkObject
// for OnNetworkDespawnInvokedWhenClientDisconnects testing
m_PlayerPrefab.AddComponent();
}
///
/// This validates that upon a client disconnecting, the server-side
/// client's player clone will invoke NetworkBehaviour.OnNetworkDespawn
/// when the component precedes the NetworkObject component.(PR-2323)
///
[UnityTest]
public IEnumerator OnNetworkDespawnInvokedWhenClientDisconnects()
{
m_AllowServerToStart = true;
// Now just start the Host
yield return StartServerAndClients();
// Now create and connect a new client
yield return CreateAndStartNewClient();
var serverSidePlayer = m_PlayerNetworkObjects[NetworkManager.ServerClientId][m_ClientNetworkManagers[0].LocalClientId].GetComponent();
yield return StopOneClient(m_ClientNetworkManagers[0]);
Assert.True(serverSidePlayer.OnNetworkDespawnCalled, $"Server-side player clone did not invoke OnNetworkDespawn!");
}
}
}