Added a new testing stub for simulating the animator

Author: ashblue

Assets/AdncAnimatorHelpers/Editor/Testing/AnimatorStub.meta

@@ -0,0 +1,135 @@
+using AdncAnimatorHelpers.Editor.Testing.Utilities;
+using NUnit.Framework;
+using UnityEngine;
+
+namespace Adnc.AnimatorHelpers.Editors.Testing.Examples {
+    [Category("Examples")]
+    public class TestAnimatorStub {
+        private GameObject _go;
+        private AnimatorStub _animStub;
+
+        [SetUp]
+        public void Setup () {
+            _go = new GameObject("AnimatorStub");
+        }
+
+        [TearDown]
+        public void Teardown () {
+            Object.DestroyImmediate(_go);
+        }
+
+        [Test]
+        public void FailsCreationIfNoGameObject () {
+            var stub = new AnimatorStub(null);
+
+            Assert.IsFalse(stub.IsValid);
+        }
+
+        [Test]
+        public void CreatesIfGameObjectPassedIn () {
+            var stub = new AnimatorStub(_go);
+
+            Assert.IsTrue(stub.IsValid);
+        }
+
+        [Test]
+        public void AttachRuntimeController () {
+            var stub = new AnimatorStub(_go);
+
+            stub.InjectCtrl();
+
+            Assert.AreSame(stub.Animator.runtimeAnimatorController, stub.AnimatorCtrl);
+        }
+
+        [Test]
+        public void GetAnimatorParameter () {
+            var stub = new AnimatorStub(_go);
+            const string param = "test";
+
+            stub.AnimatorCtrl.AddParameter(param, AnimatorControllerParameterType.Bool);
+            stub.InjectCtrl();
+            var result = stub.Animator.GetBool(param);
+
+            Assert.IsFalse(result);
+        }
+
+        [Test]
+        public void SetAnimatorParameter () {
+            var stub = new AnimatorStub(_go);
+            const string param = "test";
+
+            stub.AnimatorCtrl.AddParameter(param, AnimatorControllerParameterType.Bool);
+            stub.InjectCtrl();
+            stub.Animator.SetBool(param, true);
+            var result = stub.Animator.GetBool(param);
+
+            Assert.IsTrue(result);
+        }
+
+        [Test]
+        public void CreateNewLayerReturnsLayer () {
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AddLayer("Test");
+
+            Assert.IsNotNull(layer);
+        }
+
+        [Test]
+        public void CreateNewLayerAddsAnotherLayer () {
+            var stub = new AnimatorStub(_go);
+            stub.AddLayer("Test");
+
+            Assert.AreEqual(stub.AnimatorCtrl.layers.Length, 2);
+        }
+
+        [Test]
+        public void CreateNewLayerSetsName () {
+            var layerName = "Test";
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AddLayer(layerName);
+
+            Assert.AreEqual(layerName, layer.name);
+        }
+
+        [Test]
+        public void CreateNewLayerSetsStateMachine () {
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AddLayer("Test");
+
+            Assert.IsNotNull(layer.stateMachine);
+        }
+
+        [Test]
+        public void CreateNewLayerCreatesAtLeastOneState () {
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AddLayer("Test");
+
+            Assert.IsTrue(layer.stateMachine.states.Length >= 1);
+        }
+
+        [Test]
+        public void CreateNewLayerSetsDefaultState () {
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AddLayer("Test");
+
+            Assert.IsNotNull(layer.stateMachine.defaultState);
+        }
+
+        [Test]
+        public void PlayAdvancesToTheNextState () {
+            var stub = new AnimatorStub(_go);
+            var layer = stub.AnimatorCtrl.layers[0];
+            const string stateName = "New State";
+            var state = layer.stateMachine.AddState(stateName);
+            var trans = layer.stateMachine.defaultState.AddTransition(state);
+
+            layer.stateMachine.defaultState.AddTransition(state);
+            trans.hasExitTime = true;
+            stub.InjectCtrl();
+            stub.Animator.Update(10);
+
+            var stateInfo = stub.Animator.GetCurrentAnimatorStateInfo(0);
+            Assert.IsTrue(stateInfo.IsName(stateName));
+        }
+    }
+}

Assets/AdncAnimatorHelpers/Editor/Testing/AnimatorStub/TestAnimatorStub.cs

@@ -0,0 +1,75 @@
+using UnityEditor.Animations;
+using UnityEngine;
+
+namespace AdncAnimatorHelpers.Editor.Testing.Utilities {
+    public class AnimatorStub {
+        /// <summary>
+        /// Reference to the Animator attached to the passed GameObject
+        /// </summary>
+        public Animator Animator { get; private set; }
+
+        /// <summary>
+        /// Reference to an automatically generated AnimatorController
+        /// </summary>
+        public AnimatorController AnimatorCtrl { get; private set; }
+
+        /// <summary>
+        /// Is this a valid AnimatorStub?
+        /// </summary>
+        public bool IsValid {
+            get { return Animator != null && AnimatorCtrl != null; }
+        }
+
+        /// <summary>
+        /// Inject the animator stub onto a GameObject
+        /// </summary>
+        /// <param name="target"></param>
+        public AnimatorStub (GameObject target) {
+            if (target == null) {
+                LogError("Please pass in a target to verify. Failed to generate an animator stub");
+
+                return;
+            }
+
+            Animator = target.AddComponent<Animator>();
+            AnimatorCtrl = new AnimatorController {name = "AnimatorDefault"};
+
+            AddLayer("Default");
+        }
+
+        /// <summary>
+        /// Create new layers on the Animator with a specific name
+        /// </summary>
+        /// <param name="name"></param>
+        /// <returns></returns>
+        public AnimatorControllerLayer AddLayer (string name) {
+            var layer = new AnimatorControllerLayer {
+                name = name,
+                stateMachine = new AnimatorStateMachine {
+                    name = "Default"
+                }
+            };
+
+            layer.stateMachine.defaultState = layer.stateMachine.AddState("Default");
+            AnimatorCtrl.AddLayer(layer);
+
+            return layer;
+        }
+
+        /// <summary>
+        /// Should be called when you want to inject your AnimatorController into you Animator. WARNING! Once you
+        /// do this it creates a static instance of your AnimatorController and you cannot change it.
+        /// </summary>
+        public void InjectCtrl () {
+            Animator.runtimeAnimatorController = AnimatorCtrl;
+        }
+
+        void LogError (string error) {
+            if (!Application.isPlaying) {
+                return;
+            }
+
+            Debug.LogError(error);
+        }
+    }
+}