unity-application/Assets/Courses/Tests/PlayMode/CoursesControllerTests.cs

using NUnit.Framework;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using UnityEditor;
using UnityEngine;
using UnityEngine.SceneManagement;
using UnityEngine.TestTools;
using UnityEngine.UI;

/// <summary>
/// Test the CoursesController class 
/// </summary>
[TestFixture]
public class CoursesControllerTests
{
    /// <summary>
    /// Setup the environment before each test
    /// </summary>
    [UnitySetUp]
    public IEnumerator SetupFunction()
    {
        string path = $"{Application.persistentDataPath}/wesign_unit_test.json";
        string oneUser = $"{{\"version\":1537,\"users\":[{{\"entries\":[],\"username\":\"TEST\",\"avatarIndex\":0,\"playtime\":0.0,\"minigames\":[],\"courses\":[]}}],\"currentUser\":0,\"currentMinigame\":0,\"currentCourse\":0,\"currentTheme\":0,\"useGPU\":false}}";

        File.WriteAllText(path, oneUser);
        PersistentDataController.PATH = path;
        PersistentDataController.GetInstance().Load();
        AssetDatabase.LoadAssetAtPath<UserAvatarList>("Assets/Accounts/ScriptableObjects/UserAvatarList.asset").Awake();
        SceneManager.LoadScene("Common/Scenes/MainMenuScreen");
        yield return null;

        var mainMenuScreen = GameObject.FindObjectOfType<MainMenuScreen>();
        mainMenuScreen.GotoCourses();
        yield return null;
    }

    /// <summary>
    /// Cleanup after testing
    /// </summary>
    [TearDown]
    public void TearDown_CoursesControllerTests()
    {
        PersistentDataController.PATH = null;
    }

    /// <summary>
    /// Function used to spoof the sign predictor. It uses 0.0f as certainty so the sign is "perfect".
    /// </summary>
    /// <param name="sign"></param>
    /// <param name="signPredictor"></param>
    private IEnumerator SignLetter(string sign, SignPredictor signPredictor)
    {
        signPredictor.learnableProbabilities = new Dictionary<string, float>();
        // Loop through all capital letters of the alphabet
        for (char c = 'A'; c <= 'Z'; c++)
        {
            string letter = c.ToString();

            // If the current letter is the input sign, set its value to 0.
            // Otherwise, set it to 20.
            signPredictor.learnableProbabilities[letter] = letter == sign ? 0f : 20f;
        }

        foreach (Listener listener in signPredictor.listeners)
        {
            yield return listener.ProcessIncomingCall();
        }
    }

    /// <summary>
    /// Simulates a little playtrough of a course
    /// </summary>
    [UnityTest]
    public IEnumerator PlaytroughTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        int counter = 0;
        while (counter < 100)
        {
            if (coursesController.GetPanelId() == 0 || coursesController.GetPanelId() == 2)
            {
                yield return SignLetter(coursesController.GetCurrentSign(), signPredictor);
            }
            else
            {
                GameObject buttonObject = GameObject.Find("Choice Fingerspelling(Clone)");
                Assert.IsNotNull(buttonObject);
                Button button = buttonObject.GetComponent<Button>();
                button.onClick.Invoke();
            }
            yield return new WaitForSeconds(1.0f);
            counter++;
        }

        yield return new WaitForSeconds(2.0f);
        coursesController.FinishCourse();
        coursesController.ReturnToActivityScreen();
        yield return new WaitForSeconds(1.0f);
    }

    /// <summary>
    /// Tests a preview course
    /// </summary>
    /// <returns></returns>
    [UnityTest]
    public IEnumerator PreviewTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(CourseIndex.CLOTHING);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;
        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);
        Assert.AreEqual(coursesController.GetPanelId(), 0);

        // Check that you reach multiple-choice after 6 NextSigns
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        coursesController.NextSign();
        yield return new WaitForSeconds(1f);
        Assert.AreEqual(coursesController.GetPanelId(), 1);
    }

    /// <summary>
    /// Tests the finisihing of a course
    /// </summary>
    /// <returns></returns>
    [UnityTest]
    public IEnumerator FinishedCourseTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(CourseIndex.FINGERSPELLING);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);
        var course = coursesController.courselist.courses[coursesController.courselist.currentCourseIndex];
        var maxWords = course.theme.learnables.Count;
        User user = UserList.GetCurrentUser();
        var progress = user.GetCourseProgress(CourseIndex.FINGERSPELLING);
        progress.completedLearnables = maxWords;

        coursesController.NextSign();
    }

    /// <summary>
    /// Tests what happens when a panel is being summoned with a none existing ID
    /// </summary>
    /// <returns></returns>
    [UnityTest]
    public IEnumerator BrokenPanelIDTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(CourseIndex.FINGERSPELLING);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);
        coursesController.CorruptPanelID();
        yield return coursesController.CallSetupPanel();
        yield return new WaitForSeconds(0.2f);
    }

    /// <summary>
    /// Tests what happens when the sign is correct but not certain enough
    /// </summary>
    [UnityTest]
    public IEnumerator UnconfidentTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        Course course = coursesController.courselist.courses[coursesController.courselist.currentCourseIndex];
        Learnable sign = course.theme.learnables[0];

        string signletter = "A";
        signPredictor.learnableProbabilities = new Dictionary<string, float>();
        for (char c = 'A'; c <= 'Z'; c++)
        {
            string letter = c.ToString();
            signPredictor.learnableProbabilities[letter] = letter == signletter ? sign.thresholdDistance * 1.2f : 20f;
        }
        foreach (Listener listener in signPredictor.listeners)
        {
            yield return listener.ProcessIncomingCall();
        }

        yield return new WaitForSeconds(1.0f);
        Assert.AreEqual(coursesController.GetCurrentSign(), "A");
    }

    /// <summary>
    /// Test what happens when an incorrect sign is signed
    /// </summary>
    [UnityTest]
    public IEnumerator IncorrectSignTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        yield return SignLetter("B", signPredictor);
        yield return new WaitForSeconds(1.0f);
        Assert.AreEqual(coursesController.GetCurrentSign(), "A");
    }

    /// <summary>
    /// Test what happens when there is no sign being signed
    /// </summary>
    [UnityTest]
    public IEnumerator NoSignTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        yield return SignLetter("-", signPredictor);
        yield return new WaitForSeconds(1.0f);
        Assert.AreEqual(coursesController.GetCurrentSign(), "A");
    }

    /// <summary>
    /// Tests what happens when a wrong sign is performed twice but with a long enough interval
    /// </summary>
    [UnityTest]
    public IEnumerator TwoWrongFastTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;

        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        Course course = coursesController.courselist.courses[coursesController.courselist.currentCourseIndex];
        Learnable sign = course.theme.learnables[0];

        yield return SignLetter("B", signPredictor);

        yield return new WaitForSeconds(2.1f);

        yield return SignLetter("B", signPredictor);

        Assert.AreEqual(coursesController.GetCurrentSign(), "A");
    }

    /// <summary>
    /// Tests what happens when the sign can not be processed but the Feedback is not Null
    /// </summary>
    [UnityTest]
    public IEnumerator FeedbackNotNullTest()
    {
        var courseMenuScreen = GameObject.FindObjectOfType<CourseMenuScreen>();
        var courseList = courseMenuScreen.courseList;
        Assert.IsNotNull(courseList, "Course was not started.");
        courseList.SetCurrentCourse(0);
        SystemController.GetInstance().LoadNextScene("Common/Scenes/CourseActivityScreen");
        yield return null;
        var courseActivityScreen = GameObject.FindObjectOfType<CourseActivityScreen>();
        Assert.IsNotNull(courseActivityScreen);
        courseActivityScreen.StartCourse();
        yield return null;

        var coursesController = GameObject.FindObjectOfType<CoursesController>();
        Assert.IsNotNull(coursesController);

        var signPredictor = GameObject.FindObjectOfType<SignPredictor>();
        Assert.IsNotNull(signPredictor);

        signPredictor.learnableProbabilities = null;
        coursesController.SetFeedbackProgress();

        foreach (Listener listener in signPredictor.listeners)
        {
            yield return listener.ProcessIncomingCall();
        }
    }
}