Coroutine/Tests/TimeBasedCoroutineTests.cs

using System.Collections.Generic;
using System.Threading;
using Coroutine;
using NUnit.Framework;

namespace Tests {
    public class TimeBasedCoroutineTests {

        [Test]
        public void TestTimerBasedCoroutine() {
            var counter = 0;

            IEnumerator<Wait> OnTimeTickCodeExecuted() {
                counter++;
                yield return new Wait(0.1d);
                counter++;
            }

            var cr = CoroutineHandler.Start(OnTimeTickCodeExecuted());
            Assert.AreEqual(1, counter, "instruction before yield is not executed.");
            Assert.AreEqual(string.Empty, cr.Name, "Incorrect default name found");
            Assert.AreEqual(0, cr.Priority, "Default priority is not minimum");
            for (var i = 0; i < 5; i++)
                this.SimulateTime(1);
            Assert.AreEqual(2, counter, "instruction after yield is not executed.");
            Assert.AreEqual(true, cr.IsFinished, "Incorrect IsFinished value.");
            Assert.AreEqual(false, cr.WasCanceled, "Incorrect IsCanceled value.");
            Assert.AreEqual(cr.MoveNextCount, 2, "Incorrect MoveNextCount value.");
        }

        [Test]
        public void TestCoroutineReturningWeirdYields() {
            var counter = 0;

            IEnumerator<Wait> OnTimeTickNeverReturnYield() {
                counter++; // 1
                // condition that's expected to be false
                if (counter == 100)
                    yield return new Wait(0.1d);
                counter++; // 2
            }

            IEnumerator<Wait> OnTimeTickYieldBreak() {
                counter++; // 3
                yield break;
            }

            var cr = new ActiveCoroutine[2];
            cr[0] = CoroutineHandler.Start(OnTimeTickNeverReturnYield());
            cr[1] = CoroutineHandler.Start(OnTimeTickYieldBreak());
            for (var i = 0; i < 5; i++)
                this.SimulateTime(1);

            Assert.AreEqual(3, counter, "Incorrect counter value.");
            for (var i = 0; i < cr.Length; i++) {
                Assert.AreEqual(true, cr[i].IsFinished, $"Incorrect IsFinished value on index {i}.");
                Assert.AreEqual(false, cr[i].WasCanceled, $"Incorrect IsCanceled value on index {i}");
                Assert.AreEqual(1, cr[i].MoveNextCount, $"Incorrect MoveNextCount value on index {i}");
            }
        }

        [Test]
        public void TestCoroutineReturningDefaultYield() {
            var counter = 0;

            IEnumerator<Wait> OnTimeTickYieldDefault() {
                counter++; // 1
                yield return default;
                counter++; // 2
            }

            var cr = CoroutineHandler.Start(OnTimeTickYieldDefault());
            for (var i = 0; i < 5; i++)
                this.SimulateTime(1);

            Assert.AreEqual(2, counter, "Incorrect counter value.");
            Assert.AreEqual(true, cr.IsFinished, "Incorrect IsFinished value.");
            Assert.AreEqual(false, cr.WasCanceled, "Incorrect IsCanceled value.");
            Assert.AreEqual(2, cr.MoveNextCount, "Incorrect MoveNextCount value.");
        }

        [Test]
        public void TestInfiniteCoroutineNeverFinishesUnlessCanceled() {
            var counter = 0;

            IEnumerator<Wait> OnTimerTickInfinite() {
                while (true) {
                    counter++;
                    yield return new Wait(1);
                }
            }

            void SetCounterToUnreachableValue(ActiveCoroutine coroutine) {
                counter = -100;
            }

            var cr = CoroutineHandler.Start(OnTimerTickInfinite());
            cr.OnFinished += SetCounterToUnreachableValue;
            for (var i = 0; i < 50; i++)
                this.SimulateTime(1);

            Assert.AreEqual(51, counter, "Incorrect counter value.");
            Assert.AreEqual(false, cr.IsFinished, "Incorrect IsFinished value.");
            Assert.AreEqual(false, cr.WasCanceled, "Incorrect IsCanceled value.");
            Assert.AreEqual(51, cr.MoveNextCount, "Incorrect MoveNextCount value.");

            cr.Cancel();
            Assert.AreEqual(true, cr.WasCanceled, "Incorrect IsCanceled value after canceling.");
            Assert.AreEqual(-100, counter, "OnFinished event not triggered when canceled.");
            Assert.AreEqual(51, cr.MoveNextCount, "Incorrect MoveNextCount value.");
            Assert.AreEqual(true, cr.IsFinished, "Incorrect IsFinished value.");
        }

        [Test]
        public void TestOnFinishedEventExecuted() {
            var counter = 0;

            IEnumerator<Wait> OnTimeTick() {
                counter++;
                yield return new Wait(0.1d);
            }

            void SetCounterToUnreachableValue(ActiveCoroutine coroutine) {
                counter = -100;
            }

            var cr = CoroutineHandler.Start(OnTimeTick());
            cr.OnFinished += SetCounterToUnreachableValue;
            this.SimulateTime(50);
            Assert.AreEqual(-100, counter, "Incorrect counter value.");
        }

        [Test]
        public void TestNestedCoroutine() {
            var counterAlwaysRunning = 0;

            IEnumerator<Wait> AlwaysRunning() {
                while (true) {
                    yield return new Wait(1);
                    counterAlwaysRunning++;
                }
            }

            var counterChild = 0;

            IEnumerator<Wait> Child() {
                yield return new Wait(1);
                counterChild++;
            }

            var counterParent = 0;

            IEnumerator<Wait> Parent() {
                yield return new Wait(1);
                counterParent++;
                // OnFinish I will start child.
            }

            var counterGrandParent = 0;

            IEnumerator<Wait> GrandParent() {
                yield return new Wait(1);
                counterGrandParent++;
                // Nested corotuine starting.
                var p = CoroutineHandler.Start(Parent());
                // Nested corotuine starting in OnFinished.
                p.OnFinished += ac => CoroutineHandler.Start(Child());
            }

            CoroutineHandler.Start(AlwaysRunning());
            CoroutineHandler.Start(GrandParent());
            Assert.AreEqual(0, counterAlwaysRunning, "Always running counter is invalid at time 0.");
            Assert.AreEqual(0, counterGrandParent, "Grand Parent counter is invalid at time 0.");
            Assert.AreEqual(0, counterParent, "Parent counter is invalid at time 0.");
            Assert.AreEqual(0, counterChild, "Child counter is invalid at time 0.");
            this.SimulateTime(1);
            Assert.AreEqual(1, counterAlwaysRunning, "Always running counter is invalid at time 1.");
            Assert.AreEqual(1, counterGrandParent, "Grand Parent counter is invalid at time 1.");
            Assert.AreEqual(0, counterParent, "Parent counter is invalid at time 1.");
            Assert.AreEqual(0, counterChild, "Child counter is invalid at time 1.");
            this.SimulateTime(1);
            Assert.AreEqual(2, counterAlwaysRunning, "Always running counter is invalid at time 2.");
            Assert.AreEqual(1, counterGrandParent, "Grand Parent counter is invalid at time 2.");
            Assert.AreEqual(1, counterParent, "Parent counter is invalid at time 2.");
            Assert.AreEqual(0, counterChild, "Child counter is invalid at time 2.");
            this.SimulateTime(1);
            Assert.AreEqual(3, counterAlwaysRunning, "Always running counter is invalid at time 3.");
            Assert.AreEqual(1, counterGrandParent, "Grand Parent counter is invalid at time 3.");
            Assert.AreEqual(1, counterParent, "Parent counter is invalid at time 3.");
            Assert.AreEqual(1, counterChild, "Child counter is invalid at time 3.");
            this.SimulateTime(1);
            Assert.AreEqual(4, counterAlwaysRunning, "Always running counter is invalid at time 4.");
            Assert.AreEqual(1, counterGrandParent, "Grand Parent counter is invalid at time 4.");
            Assert.AreEqual(1, counterParent, "Parent counter is invalid at time 4.");
            Assert.AreEqual(1, counterChild, "Child counter is invalid at time 4.");
        }

        [Test]
        public void TestPriority() {
            var counterShouldExecuteBefore0 = 0;

            IEnumerator<Wait> ShouldExecuteBefore0() {
                while (true) {
                    yield return new Wait(1);
                    counterShouldExecuteBefore0++;
                }
            }

            var counterShouldExecuteBefore1 = 0;

            IEnumerator<Wait> ShouldExecuteBefore1() {
                while (true) {
                    yield return new Wait(1);
                    counterShouldExecuteBefore1++;
                }
            }

            var counterShouldExecuteAfter = 0;

            IEnumerator<Wait> ShouldExecuteAfter() {
                while (true) {
                    yield return new Wait(1);
                    if (counterShouldExecuteBefore0 == 1 &&
                        counterShouldExecuteBefore1 == 1) {
                        counterShouldExecuteAfter++;
                    }
                }
            }

            var counterShouldExecuteFinally = 0;

            IEnumerator<Wait> ShouldExecuteFinally() {
                while (true) {
                    yield return new Wait(1);
                    if (counterShouldExecuteAfter > 0) {
                        counterShouldExecuteFinally++;
                    }
                }
            }

            var highPriority = int.MaxValue;
            CoroutineHandler.Start(ShouldExecuteBefore1(), priority: highPriority);
            CoroutineHandler.Start(ShouldExecuteAfter());
            CoroutineHandler.Start(ShouldExecuteBefore0(), priority: highPriority);
            CoroutineHandler.Start(ShouldExecuteFinally(), priority: -1);
            this.SimulateTime(10);
            Assert.AreEqual(1, counterShouldExecuteAfter, $"ShouldExecuteAfter counter  {counterShouldExecuteAfter} is invalid.");
            Assert.AreEqual(1, counterShouldExecuteFinally, $"ShouldExecuteFinally counter  {counterShouldExecuteFinally} is invalid.");
        }

        [Test]
        public void TestTimeBasedCoroutineIsAccurate() {
            var counter0 = 0;

            IEnumerator<Wait> IncrementCounter0Ever10Seconds() {
                while (true) {
                    yield return new Wait(10);
                    counter0++;
                }
            }

            var counter1 = 0;

            IEnumerator<Wait> IncrementCounter1Every5Seconds() {
                while (true) {
                    yield return new Wait(5);
                    counter1++;
                }
            }

            CoroutineHandler.Start(IncrementCounter0Ever10Seconds());
            CoroutineHandler.Start(IncrementCounter1Every5Seconds());
            this.SimulateTime(3);
            Assert.AreEqual(0, counter0, "Incorrect counter0 value after 3 seconds.");
            Assert.AreEqual(0, counter1, "Incorrect counter1 value after 3 seconds.");
            this.SimulateTime(3);
            Assert.AreEqual(0, counter0, "Incorrect counter0 value after 6 seconds.");
            Assert.AreEqual(1, counter1, "Incorrect counter1 value after 6 seconds.");

            // it's 5 over here because IncrementCounter1Every5Seconds
            // increments 5 seconds after last yield. not 5 seconds since start.
            // So the when we send 3 seconds in the last SimulateTime,
            // the 3rd second was technically ignored.
            this.SimulateTime(5);
            Assert.AreEqual(1, counter0, "Incorrect counter0 value after 10 seconds.");
            Assert.AreEqual(2, counter1, "Incorrect counter1 value after next 5 seconds.");
        }

        [Test]
        public void InvokeLaterAndNameTest() {
            var counter = 0;
            var cr = CoroutineHandler.InvokeLater(new Wait(10), () => {
                counter++;
            }, "Bird");

            this.SimulateTime(5);
            Assert.AreEqual(0, counter, "Incorrect counter value after 5 seconds.");
            this.SimulateTime(5);
            Assert.AreEqual(1, counter, "Incorrect counter value after 10 seconds.");
            Assert.AreEqual(true, cr.IsFinished, "Incorrect IsFinished value.");
            Assert.AreEqual(false, cr.WasCanceled, "Incorrect IsCanceled value.");
            Assert.AreEqual(cr.MoveNextCount, 2, "Incorrect MoveNextCount value.");
            Assert.AreEqual(cr.Name, "Bird", "Incorrect name of the coroutine.");
        }

        [Test]
        public void CoroutineStatsAre95PercentAccurate() {
            IEnumerator<Wait> CoroutineTakesMax500Ms() {
                Thread.Sleep(200);
                yield return new Wait(10);
                Thread.Sleep(500);
            }

            var cr = CoroutineHandler.Start(CoroutineTakesMax500Ms());
            for (var i = 0; i < 5; i++)
                this.SimulateTime(50);

            const int expected1 = 350;
            const float errorbar1 = 5 / 100f * expected1;
            var gTa = cr.AverageMoveNextTime.Milliseconds > expected1 - errorbar1; // 95% accuracy.
            var lTb = cr.AverageMoveNextTime.Milliseconds < expected1 + errorbar1; // 95% accuracy.
            Assert.IsTrue(gTa && lTb, $"Average Move Next Time {cr.AverageMoveNextTime.Milliseconds} is invalid.");

            const int expected2 = 500;
            const float errorbar2 = 5 / 100f * expected2;
            var gTc = cr.MaxMoveNextTime.Milliseconds > expected2 - errorbar2; // 95% accuracy.
            var lTd = cr.MaxMoveNextTime.Milliseconds < expected2 + errorbar2; // 95% accuracy.
            Assert.IsTrue(gTc && lTd, $"Maximum Move Next Time {cr.MaxMoveNextTime.Milliseconds} is invalid.");
        }

        private void SimulateTime(double totalSeconds) {
            CoroutineHandler.Tick(totalSeconds);
        }

    }
}