using NUnit.Framework; using FluentAssertions; using Encompass; using System; using System.Linq; using System.Collections.Generic; using Encompass.Exceptions; namespace Tests { struct MockComponent : IComponent { public int myInt; public string myString; } public class EngineTest { static List> resultComponents; static MockComponent resultComponent; static List resultMessages = new List(); [Reads(typeof(MockComponent))] public class ReadComponentsTestEngine : Engine { public override void Update(double dt) { resultComponents = ReadComponents().ToList(); } } [Reads(typeof(MockComponent))] public class ReadComponentTestEngine : Engine { public override void Update(double dt) { resultComponent = ReadComponent().Item2; } } [Test] public void ReadComponents() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ReadComponentsTestEngine()); var entity = worldBuilder.CreateEntity(); var entityB = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 0; mockComponent.myString = "hello"; MockComponent mockComponentB; mockComponentB.myInt = 1; mockComponentB.myString = "howdy"; var componentAID = worldBuilder.SetComponent(entity, mockComponent); var componentBID = worldBuilder.SetComponent(entityB, mockComponentB); var world = worldBuilder.Build(); world.Update(0.01f); var resultComponentValues = resultComponents.Select((kv) => kv.Item2); resultComponentValues.Should().Contain(mockComponent); resultComponentValues.Should().Contain(mockComponentB); } [Test] public void ReadComponent() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ReadComponentTestEngine()); var entity = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 0; mockComponent.myString = "hello"; worldBuilder.SetComponent(entity, mockComponent); var world = worldBuilder.Build(); world.Update(0.01f); Assert.AreEqual(mockComponent, resultComponent); } [Test] public void ReadComponentWhenMultipleComponents() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ReadComponentTestEngine()); var entity = worldBuilder.CreateEntity(); var entityB = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 0; mockComponent.myString = "hello"; MockComponent mockComponentB; mockComponentB.myInt = 1; mockComponentB.myString = "howdy"; worldBuilder.SetComponent(entity, mockComponent); worldBuilder.SetComponent(entityB, mockComponentB); var world = worldBuilder.Build(); world.Update(0.01); Assert.That(resultComponent, Is.EqualTo(mockComponent).Or.EqualTo(mockComponentB)); } [Reads(typeof(MockComponent))] [Writes(typeof(MockComponent))] public class UpdateComponentTestEngine : Engine { public override void Update(double dt) { (var componentID, var component) = ReadComponent(); component.myInt = 420; component.myString = "blaze it"; SetComponent(GetEntityByComponentID(componentID), component); } } // this test needs to be improved... [Test] public void UpdateComponent() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new UpdateComponentTestEngine()); worldBuilder.AddEngine(new ReadComponentTestEngine()); var entity = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 0; mockComponent.myString = "hello"; worldBuilder.SetComponent(entity, mockComponent); var world = worldBuilder.Build(); world.Update(0.01); world.Update(0.01); Assert.AreEqual(420, resultComponent.myInt); Assert.AreEqual("blaze it", resultComponent.myString); } [Reads(typeof(MockComponent))] public class UndeclaredUpdateComponentTestEngine : Engine { public override void Update(double dt) { (var componentID, var component) = ReadComponent(); component.myInt = 420; component.myString = "blaze it"; SetComponent(componentID, component); component = ReadComponent().Item2; } } [Test] public void UpdateUndeclaredComponent() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new UndeclaredUpdateComponentTestEngine()); var entity = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 0; mockComponent.myString = "hello"; worldBuilder.SetComponent(entity, mockComponent); var world = worldBuilder.Build(); var ex = Assert.Throws(() => world.Update(0.01f)); Assert.That(ex.Message, Is.EqualTo("Engine UndeclaredUpdateComponentTestEngine tried to update undeclared Component MockComponent")); } struct MockMessage : IMessage { public string myString; } [Sends(typeof(MockMessage))] public class MessageEmitEngine : Engine { public override void Update(double dt) { MockMessage message; message.myString = "howdy"; this.SendMessage(message); } } [Receives(typeof(MockMessage))] public class MessageReadEngine : Engine { public override void Update(double dt) { resultMessages = this.ReadMessages().ToList(); } } [Test] public void EmitAndReadMessage() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new MessageEmitEngine()); worldBuilder.AddEngine(new MessageReadEngine()); var world = worldBuilder.Build(); world.Update(0.01f); Assert.AreEqual(resultMessages.First().myString, "howdy"); } public class UndeclaredMessageEmitEngine : Engine { public override void Update(double dt) { MockMessage message; message.myString = "howdy"; this.SendMessage(message); } } static IEnumerable emptyReadMessagesResult; [Receives(typeof(MockMessage))] class ReadMessagesWhenNoneExistEngine : Engine { public override void Update(double dt) { emptyReadMessagesResult = ReadMessages(); } } [Test] public void ReadMessagesWhenNoneHaveBeenEmitted() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ReadMessagesWhenNoneExistEngine()); var world = worldBuilder.Build(); world.Update(0.01f); emptyReadMessagesResult.Should().BeEmpty(); } [Test] public void EmitUndeclaredMessage() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new UndeclaredMessageEmitEngine()); var world = worldBuilder.Build(); var ex = Assert.Throws(() => world.Update(0.01f)); Assert.That(ex.Message, Is.EqualTo("Engine UndeclaredMessageEmitEngine tried to send undeclared Message MockMessage")); } static bool someTest; [Sends(typeof(MockMessage))] class EmitMockMessageEngine : Engine { public override void Update(double dt) { MockMessage message; message.myString = "howdy"; this.SendMessage(message); } } [Receives(typeof(MockMessage))] class SomeMessageTestEngine : Engine { public override void Update(double dt) { someTest = this.SomeMessage(); } } [Test] public void SomeMessage() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new EmitMockMessageEngine()); worldBuilder.AddEngine(new SomeMessageTestEngine()); var world = worldBuilder.Build(); world.Update(0.01f); Assert.That(someTest, Is.True); } class UndeclaredSomeMessageEngine : Engine { public override void Update(double dt) { someTest = this.SomeMessage(); } } [Test] public void UndeclaredSomeMessage() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new EmitMockMessageEngine()); worldBuilder.AddEngine(new UndeclaredSomeMessageEngine()); var world = worldBuilder.Build(); Assert.Throws(() => world.Update(0.01f)); } class SomeComponentTestEngine : Engine { public override void Update(double dt) { Assert.IsTrue(SomeComponent()); } } [Test] public void SomeComponent() { var worldBuilder = new WorldBuilder(); var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, new MockComponent()); var world = worldBuilder.Build(); world.Update(0.01); } static ValueTuple pairA; static ValueTuple pairB; [Reads(typeof(MockComponent))] class SameValueComponentReadEngine : Engine { public override void Update(double dt) { var components = ReadComponents(); pairA = components.First(); pairB = components.Last(); } } // Tests that components with identical values should be distinguishable by ID [Test] public void SameValueComponents() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new SameValueComponentReadEngine()); MockComponent componentA; componentA.myInt = 20; componentA.myString = "hello"; MockComponent componentB; componentB.myInt = 20; componentB.myString = "hello"; var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, componentA); var entityB = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entityB, componentB); var world = worldBuilder.Build(); world.Update(0.01f); Assert.That(pairA, Is.Not.EqualTo(pairB)); Assert.That(pairA.Item2, Is.EqualTo(pairB.Item2)); } static IEnumerable> emptyComponentReadResult; [Reads(typeof(MockComponent))] class ReadEmptyMockComponentsEngine : Engine { public override void Update(double dt) { emptyComponentReadResult = ReadComponents(); } } [Test] public void ReadComponentsOfTypeWhereNoneExist() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ReadEmptyMockComponentsEngine()); var world = worldBuilder.Build(); world.Update(0.01f); Assert.That(emptyComponentReadResult, Is.Empty); } struct DestroyerComponent : IComponent { } [Reads(typeof(DestroyerComponent))] class DestroyerEngine : Engine { public override void Update(double dt) { foreach (var componentPair in ReadComponents()) { var componentID = componentPair.Item1; var entityID = GetEntityIDByComponentID(componentID); Destroy(entityID); } } } static List<(Guid, MockComponent)> results; [Reads(typeof(MockComponent))] class ReaderEngine : Engine { public override void Update(double dt) { results = ReadComponents().ToList(); } } [Test] public void DestroyEntity() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new DestroyerEngine()); worldBuilder.AddEngine(new ReaderEngine()); var entity = worldBuilder.CreateEntity(); var entityB = worldBuilder.CreateEntity(); var entityC = worldBuilder.CreateEntity(); DestroyerComponent destroyerComponent; MockComponent mockComponent; mockComponent.myInt = 2; mockComponent.myString = "blah"; worldBuilder.SetComponent(entity, destroyerComponent); var componentID = worldBuilder.SetComponent(entity, mockComponent); worldBuilder.SetComponent(entityB, destroyerComponent); var componentBID = worldBuilder.SetComponent(entityB, mockComponent); var componentCID = worldBuilder.SetComponent(entityC, mockComponent); var world = worldBuilder.Build(); world.Update(0.01); world.Update(0.01); Assert.That(results, Does.Not.Contain((componentID, mockComponent))); Assert.That(results, Does.Not.Contain((componentBID, mockComponent))); Assert.That(results, Does.Contain((componentCID, mockComponent))); } [Reads(typeof(DestroyerComponent), typeof(MockComponent))] class DestroyAndAddComponentEngine : Engine { public override void Update(double dt) { foreach (var componentPair in ReadComponents()) { var componentID = componentPair.Item1; var entity = GetEntityByComponentID(componentID); var (id, _) = GetComponent(entity); RemoveComponent(id); Destroy(entity.ID); } } } [Test] public void DestroyEntityWhileRemovingComponent() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new DestroyAndAddComponentEngine()); worldBuilder.AddEngine(new ReaderEngine()); var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, new DestroyerComponent()); worldBuilder.SetComponent(entity, new MockComponent()); var world = worldBuilder.Build(); Assert.DoesNotThrow(() => world.Update(0.01)); } static Entity entityFromComponentIDResult; [Reads(typeof(MockComponent))] class GetEntityFromComponentIDEngine : Engine { public override void Update(double dt) { var componentID = ReadComponent().Item1; entityFromComponentIDResult = GetEntityByComponentID(componentID); } } [Test] public void GetEntityFromComponentID() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new GetEntityFromComponentIDEngine()); MockComponent component; component.myInt = 2; component.myString = "howdy"; var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, component); var world = worldBuilder.Build(); world.Update(0.01); Assert.That(entity, Is.EqualTo(entityFromComponentIDResult)); } [Reads(typeof(MockComponent))] [WritesPending(typeof(MockComponent))] [Writes(typeof(MockComponent))] class AddAndRemoveMockComponentEngine : Engine { public override void Update(double dt) { foreach (var (mockComponentID, mockComponent) in ReadComponents()) { var entity = GetEntityByComponentID(mockComponentID); RemoveComponent(mockComponentID); SetComponent(entity, new MockComponent()); } } } [ReadsPending(typeof(MockComponent))] class GetEntityFromPendingComponentIDEngine : Engine { public override void Update(double dt) { foreach (var (mockComponentID, mockComponent) in ReadComponents()) { entityFromComponentIDResult = GetEntityByComponentID(mockComponentID); } } } [Test] public void GetEntityFromPendingComponentID() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new AddAndRemoveMockComponentEngine()); worldBuilder.AddEngine(new GetEntityFromPendingComponentIDEngine()); var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, new MockComponent()); var world = worldBuilder.Build(); Assert.DoesNotThrow(() => world.Update(0.01)); } [ReadsPending(typeof(MockComponent))] class GetPendingComponentFromIDEngine : Engine { public override void Update(double dt) { foreach (var (mockComponentID, mockComponent) in ReadComponents()) { GetComponentByID(mockComponentID); } } } [Test] public void GetComponentFromID() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new AddAndRemoveMockComponentEngine()); worldBuilder.AddEngine(new GetPendingComponentFromIDEngine()); var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, new MockComponent()); var world = worldBuilder.Build(); Assert.DoesNotThrow(() => world.Update(0.01)); } static MockComponent mockComponentByIDResult; [Reads(typeof(MockComponent))] class GetComponentByIDEngine : Engine { public override void Update(double dt) { var componentID = ReadComponent().Item1; mockComponentByIDResult = GetComponentByID(componentID); } } [Test] public void GetComponentByID() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new GetComponentByIDEngine()); MockComponent component; component.myInt = 2; component.myString = "howdy"; var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, component); var world = worldBuilder.Build(); world.Update(0.01f); Assert.That(component, Is.EqualTo(mockComponentByIDResult)); } struct OtherComponent : IComponent { } [Reads(typeof(MockComponent), typeof(OtherComponent))] class GetComponentByIDWithTypeMismatchEngine : Engine { public override void Update(double dt) { var componentID = ReadComponent().Item1; GetComponentByID(componentID); } } [Test] public void GetComponentByIDWithTypeMismatch() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new GetComponentByIDWithTypeMismatchEngine()); MockComponent component; component.myInt = 2; component.myString = "howdy"; var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, component); var world = worldBuilder.Build(); Assert.Throws(() => world.Update(0.01f)); } struct EntityIDComponent : IComponent { public Guid entityID; } static bool hasEntity; [Reads(typeof(EntityIDComponent))] class HasEntityTestEngine : Engine { public override void Update(double dt) { foreach (var (mockComponentID, mockComponent) in ReadComponents()) { hasEntity = EntityExists(mockComponent.entityID); if (hasEntity) { Destroy(mockComponent.entityID); } } } } [Test] public void EntityExists() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new HasEntityTestEngine()); var entity = worldBuilder.CreateEntity(); var entityTwo = worldBuilder.CreateEntity(); EntityIDComponent entityIDComponent; entityIDComponent.entityID = entityTwo.ID; worldBuilder.SetComponent(entity, entityIDComponent); var world = worldBuilder.Build(); world.Update(0.01); Assert.IsTrue(hasEntity); world.Update(0.01); Assert.IsFalse(hasEntity); } struct MockComponentUpdateMessage : IMessage { public Guid componentID; public MockComponent mockComponent; } [Reads(typeof(MockComponent))] [Receives(typeof(MockComponentUpdateMessage))] [Writes(typeof(MockComponent))] class UpdateByComponentIDEngine : Engine { public override void Update(double dt) { foreach (var mockComponentUpdateMessage in ReadMessages()) { SetComponent(mockComponentUpdateMessage.componentID, mockComponentUpdateMessage.mockComponent); SetComponent(mockComponentUpdateMessage.componentID, mockComponentUpdateMessage.mockComponent); } } } [Test] public void EngineUpdateByComponentID() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new UpdateByComponentIDEngine()); var entity = worldBuilder.CreateEntity(); MockComponent mockComponent; mockComponent.myInt = 1; mockComponent.myString = "5"; var mockComponentID = worldBuilder.SetComponent(entity, mockComponent); MockComponentUpdateMessage mockComponentUpdateMessage; mockComponentUpdateMessage.componentID = mockComponentID; mockComponentUpdateMessage.mockComponent = mockComponent; worldBuilder.SendMessage(mockComponentUpdateMessage); var world = worldBuilder.Build(); Assert.DoesNotThrow(() => world.Update(0.01)); } [Reads(typeof(MockComponent))] class DelayedMessageEngine : Engine { public override void Update(double dt) { foreach (var (componentID, component) in ReadComponents()) { RemoveComponent(componentID); SendMessageDelayed(new MockMessage {}, 1); } } } [Test] public void EngineSendMessageDelayed() { resultMessages.Clear(); var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new DelayedMessageEngine()); worldBuilder.AddEngine(new MessageReadEngine()); var entity = worldBuilder.CreateEntity(); worldBuilder.SetComponent(entity, new MockComponent {}); var world = worldBuilder.Build(); world.Update(0.01); resultMessages.Should().BeEmpty(); world.Update(0.5); resultMessages.Should().BeEmpty(); world.Update(0.5); resultMessages.Should().NotBeEmpty(); resultMessages.First().Should().BeOfType(); } [Receives(typeof(MockMessage))] [WritesPending(typeof(MockComponent))] [Writes(typeof(MockComponent))] class ActivateComponentEngine : Engine { public override void Update(double dt) { foreach (var message in ReadMessages()) { var entity = CreateEntity(); SetComponent(entity, new MockComponent {}); } } } [ReadsPending(typeof(MockComponent))] class RemoveComponentEngine : Engine { public override void Update(double dt) { foreach (var (componentID, component) in ReadComponents()) { RemoveComponent(componentID); } } } [Test] public void EngineAddAndRemoveComponentSameFrame() { var worldBuilder = new WorldBuilder(); worldBuilder.AddEngine(new ActivateComponentEngine()); worldBuilder.AddEngine(new RemoveComponentEngine()); worldBuilder.SendMessage(new MockMessage {}); var world = worldBuilder.Build(); Assert.DoesNotThrow(() => world.Update(0.01)); } } }