RobustToolbox/Robust.Shared.IntegrationTests/GameObjects/EntitySystemManager_Tests.cs

using NUnit.Framework;
using Robust.Shared.Analyzers;
using Robust.Shared.Configuration;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.IoC.Exceptions;
using Robust.Shared.Physics.Components;

namespace Robust.UnitTesting.Shared.GameObjects
{
    [TestFixture, TestOf(typeof(EntitySystemManager))]
    internal sealed class EntitySystemManager_Tests: OurRobustUnitTest
    {

        public abstract class ESystemBase : IEntitySystem
        {
            public virtual IEnumerable<Type> UpdatesAfter => Enumerable.Empty<Type>();
            public virtual IEnumerable<Type> UpdatesBefore => Enumerable.Empty<Type>();
            public bool UpdatesOutsidePrediction => true;
            public void Initialize() { }
            public void Shutdown() { }
            public void Update(float frameTime) { }
            public void FrameUpdate(float frameTime) { }
        }
        [Virtual]
        public class ESystemA : ESystemBase { }
        internal sealed class ESystemC : ESystemA { }
        public abstract class ESystemBase2 : ESystemBase { }
        internal sealed class ESystemB : ESystemBase2 { }

        internal sealed class ESystemDepA : ESystemBase
        {
            [Dependency] public readonly ESystemDepB ESystemDepB = default!;
        }

        internal sealed class ESystemDepB : ESystemBase
        {
            [Dependency] public readonly ESystemDepA ESystemDepA = default!;
        }

        internal sealed class ESystemDepAll : EntitySystem
        {
            [Dependency] public readonly ESystemDepA ESystemDepA = default!;
            [Dependency] public readonly IConfigurationManager Config = default!;
            [Dependency] public readonly EntityQuery<TransformComponent> TransformQuery = default!;
            [Dependency] public readonly EntityQuery<PhysicsComponent> PhysicsQuery = default!;
        }

        /*
         ESystemBase (Abstract)
           - ESystemA
             - ESystemC
           - EsystemBase2 (Abstract)
             - ESystemB

         */

        [OneTimeSetUp]
        public void Setup()
        {
            var syssy = IoCManager.Resolve<IEntitySystemManager>();
            syssy.Clear();
            syssy.LoadExtraSystemType<ESystemA>();
            syssy.LoadExtraSystemType<ESystemB>();
            syssy.LoadExtraSystemType<ESystemC>();
            syssy.LoadExtraSystemType<ESystemDepA>();
            syssy.LoadExtraSystemType<ESystemDepB>();
            syssy.LoadExtraSystemType<ESystemDepAll>();
            syssy.Initialize(false);
        }

        [Test]
        public void GetsByTypeOrSupertype()
        {
            var esm = IoCManager.Resolve<IEntitySystemManager>();

            // getting type by the exact type should work fine
            Assert.That(esm.GetEntitySystem<ESystemB>(), Is.TypeOf<ESystemB>());

            // getting type by an abstract supertype should work fine
            // because there are no other subtypes of that supertype it would conflict with
            // it should return the only concrete subtype
            Assert.That(esm.GetEntitySystem<ESystemBase2>(), Is.TypeOf<ESystemB>());

            // getting ESystemA type by its exact type should work fine,
            // even though EsystemC is a subtype - it should return an instance of ESystemA
            var esysA = esm.GetEntitySystem<ESystemA>();
            Assert.That(esysA, Is.TypeOf<ESystemA>());
            Assert.That(esysA, Is.Not.TypeOf<ESystemC>());

            var esysC = esm.GetEntitySystem<ESystemC>();
            Assert.That(esysC, Is.TypeOf<ESystemC>());

            // this should not work - it's abstract and there are multiple
            // concrete subtypes
            Assert.Throws<UnregisteredTypeException>(() =>
            {
                esm.GetEntitySystem<ESystemBase>();
            });
        }

        [Test]
        public void DependencyTest()
        {
            var esm = IoCManager.Resolve<IEntitySystemManager>();

            var sysA = esm.GetEntitySystem<ESystemDepA>();
            var sysB = esm.GetEntitySystem<ESystemDepB>();

            Assert.That(sysA.ESystemDepB, Is.EqualTo(sysB));
            Assert.That(sysB.ESystemDepA, Is.EqualTo(sysA));
        }

        [Test]
        public void DependencyInjectionTest()
        {
            var esm = IoCManager.Resolve<IEntitySystemManager>();
            var sys = esm.GetEntitySystem<ESystemDepAll>();

            Assert.That(sys.ESystemDepA, Is.Not.Null);
            Assert.That(sys.Config, Is.Not.Null);
            Assert.That(sys.TransformQuery, Is.Not.Default);
            Assert.That(sys.PhysicsQuery, Is.Not.Default);
        }
    }
}