Unit Testing with Unity Ash and Unity Test Tools

So I promised in my last post to show how how Unity-Ash can make things easyier when it comes to Unit Testing.

I have added some tests to the Unity Asteroids example game. Lets take a look at one of the simpler systems as an example, the DeathThroesSystem:

[code lang="csharp"] public class DeathThroesSystem : NodelessSystem<DeathThroes, Entity, Audio> { public DeathThroesSystem() { _updateCallback = OnUpdate; _nodeAddedCallback = OnNodeAdded; }

private void OnNodeAdded(DeathThroes death, Entity entity, Audio audio)
{
    audio.Play(death.deathSound);
}

private void OnUpdate(float delta, DeathThroes death, Entity entity, Audio audio)
{
    death.countdown -= delta;
    if (death.countdown <= 0)
        entity.Destroy();
}

} [/code]

We can see its a really simple system that does a couple of things.

First we want to test that when a node is added to the system we play a sound effect. Using Unity-Test tools you can quickly whip up a test case:

[code lang="csharp"][testfixture] public class DeathThroesSystemTests : UnityUnitTest { private IEngine _engine; private DeathThroesSystem _system;

[SetUp]
public void Setup()
{
    _system = new DeathThroesSystem();
    _engine = new Engine();
    _engine.AddSystem(_system, 0);
}

[Test]
public void WhenANodeIsAdded_DeathSoundPlays()
{
    var e = AddEntityToEngine();

    Assert.AreEqual(1, e.GetComponent<Audio>().toPlay.Count);
    Assert.AreEqual(e.GetComponent<DeathThroes>().deathSound, e.GetComponent<Audio>().toPlay[0]);
}

private GameObject AddEntityToEngine()
{
    var obj = CreateGameObject();
    obj.AddComponent<DeathThroes>();
    obj.AddComponent<Audio>();
    obj.AddComponent<Entity>();
    _engine.AddEntity(obj.AddComponent<Entity>());
    return obj;
}

} [/code]

I wrote a little helper that adds an entity to the engine with the necessary components. In the future we could use reflection to looup the types on the Nodeless system, but for now its enough to satisfy the test:

Next we want to check that after update the countdown is decremented.

[code lang="csharp"][test] public void AfterUpdate_CountdownDecremented() { var e = AddEntityToEngine();

var before = e.GetComponent<DeathThroes>().countdown;

_engine.Update(1.5f);

Assert.AreEqual(before - 1.5f, e.GetComponent<DeathThroes>().countdown, 0.01f);

} [/code]

Easy, now we want to check that when the countdown is less than or equal to zero, the entity is destroyed:

[code lang="csharp"][test] public void AfterCountdownTimerEnds_EntityDestroyed() { var e = AddEntityToEngine();

var before = e.GetComponent<DeathThroes>().countdown;

_engine.Update(before + 1);

Assert.IsTrue(e.GetComponent<Entity>().IsDestroyed);

} [/code]

Sweet and thats it! Sure we could add a few more tests for some of the corner cases but as an example I think it serves its purpose.

Let me know in the comments or email me: mike.cann@gmail.com with what you think!