| | | 1 | | using DCL.Tutorial; |
| | | 2 | | using NUnit.Framework; |
| | | 3 | | using System.Collections; |
| | | 4 | | using System.Collections.Generic; |
| | | 5 | | using UnityEngine; |
| | | 6 | | using UnityEngine.TestTools; |
| | | 7 | | |
| | | 8 | | namespace DCL.Tutorial_Tests |
| | | 9 | | { |
| | | 10 | | public class TutorialControllerShould |
| | | 11 | | { |
| | | 12 | | private TutorialController tutorialController; |
| | | 13 | | private int currentStepIndex = 0; |
| | 1 | 14 | | private List<TutorialStep> currentSteps = new List<TutorialStep>(); |
| | | 15 | | |
| | | 16 | | [SetUp] |
| | 20 | 17 | | public void SetUp() { CreateAndConfigureTutorial(); } |
| | | 18 | | |
| | | 19 | | [TearDown] |
| | 20 | 20 | | public void TearDown() { DestroyTutorial(); } |
| | | 21 | | |
| | | 22 | | [UnityTest] |
| | | 23 | | public IEnumerator ExecuteTutorialStepsFromGenesisPlazaCorrectly() |
| | | 24 | | { |
| | 1 | 25 | | ConfigureTutorialForGenesisPlaza(); |
| | | 26 | | |
| | 1 | 27 | | yield return tutorialController.StartTutorialFromStep(0); |
| | | 28 | | |
| | 1 | 29 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 30 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 31 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 32 | | } |
| | | 33 | | |
| | | 34 | | [Test] |
| | | 35 | | public void SkipTutorialStepsFromGenesisPlazaCorrectly() |
| | | 36 | | { |
| | 1 | 37 | | ConfigureTutorialForGenesisPlaza(); |
| | | 38 | | |
| | 1 | 39 | | tutorialController.SkipTutorial(); |
| | | 40 | | |
| | 1 | 41 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 42 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 43 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 44 | | } |
| | | 45 | | |
| | | 46 | | [UnityTest] |
| | | 47 | | public IEnumerator ExecuteTutorialStepsFromDeepLinkCorrectly() |
| | | 48 | | { |
| | 1 | 49 | | ConfigureTutorialForDeepLink(); |
| | | 50 | | |
| | 1 | 51 | | yield return tutorialController.StartTutorialFromStep(0); |
| | | 52 | | |
| | 1 | 53 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 54 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 55 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 56 | | } |
| | | 57 | | |
| | | 58 | | [Test] |
| | | 59 | | public void SkipTutorialStepsFromDeepLinkCorrectly() |
| | | 60 | | { |
| | 1 | 61 | | ConfigureTutorialForDeepLink(); |
| | | 62 | | |
| | 1 | 63 | | tutorialController.SkipTutorial(); |
| | | 64 | | |
| | 1 | 65 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 66 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 67 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 68 | | } |
| | | 69 | | |
| | | 70 | | [UnityTest] |
| | | 71 | | public IEnumerator ExecuteTutorialStepsForResetTutorialCorrectly() |
| | | 72 | | { |
| | 1 | 73 | | ConfigureTutorialForResetTutorial(); |
| | | 74 | | |
| | 1 | 75 | | yield return tutorialController.StartTutorialFromStep(0); |
| | | 76 | | |
| | 1 | 77 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 78 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 79 | | Assert.IsFalse(tutorialController.tutorialReset); |
| | 1 | 80 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 81 | | } |
| | | 82 | | |
| | | 83 | | [Test] |
| | | 84 | | public void SkipTutorialStepsForResetTutorialCorrectly() |
| | | 85 | | { |
| | 1 | 86 | | ConfigureTutorialForResetTutorial(); |
| | | 87 | | |
| | 1 | 88 | | tutorialController.SkipTutorial(); |
| | | 89 | | |
| | 1 | 90 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 91 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 92 | | Assert.IsFalse(tutorialController.tutorialReset); |
| | 1 | 93 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 94 | | } |
| | | 95 | | |
| | | 96 | | [UnityTest] |
| | | 97 | | public IEnumerator ExecuteTutorialStepsFromUserThatAlreadyDidTheTutorialCorrectly() |
| | | 98 | | { |
| | 1 | 99 | | ConfigureTutorialForUserThatAlreadyDidTheTutorial(); |
| | | 100 | | |
| | 1 | 101 | | yield return tutorialController.StartTutorialFromStep(0); |
| | | 102 | | |
| | 1 | 103 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 104 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 105 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 106 | | } |
| | | 107 | | |
| | | 108 | | [Test] |
| | | 109 | | public void SkipTutorialStepsFromUserThatAlreadyDidTheTutorialCorrectly() |
| | | 110 | | { |
| | 1 | 111 | | ConfigureTutorialForUserThatAlreadyDidTheTutorial(); |
| | | 112 | | |
| | 1 | 113 | | tutorialController.SkipTutorial(); |
| | | 114 | | |
| | 1 | 115 | | Assert.IsFalse(tutorialController.isRunning); |
| | 1 | 116 | | Assert.IsNull(tutorialController.runningStep); |
| | 1 | 117 | | Assert.IsFalse(CommonScriptableObjects.tutorialActive.Get()); |
| | 1 | 118 | | } |
| | | 119 | | |
| | | 120 | | [Test] |
| | | 121 | | public void ShowHideTutorialTeacherCorrectly() |
| | | 122 | | { |
| | 1 | 123 | | tutorialController.ShowTeacher3DModel(true); |
| | 1 | 124 | | Assert.IsTrue(tutorialController.teacherRawImage.gameObject.activeSelf); |
| | | 125 | | |
| | 1 | 126 | | tutorialController.ShowTeacher3DModel(false); |
| | 1 | 127 | | Assert.IsFalse(tutorialController.teacherRawImage.gameObject.activeSelf); |
| | 1 | 128 | | } |
| | | 129 | | |
| | | 130 | | [Test] |
| | | 131 | | public void SetTutorialTeacherPositionCorrectly() |
| | | 132 | | { |
| | 1 | 133 | | Vector3 oldPosition = tutorialController.teacherRawImage.rectTransform.position; |
| | 1 | 134 | | tutorialController.SetTeacherPosition(new Vector2(10, 30), false); |
| | 1 | 135 | | Assert.IsTrue(tutorialController.teacherRawImage.rectTransform.position != oldPosition); |
| | | 136 | | |
| | 1 | 137 | | oldPosition = tutorialController.teacherRawImage.rectTransform.position; |
| | 1 | 138 | | tutorialController.SetTeacherPosition(new Vector2(50, 20), false); |
| | 1 | 139 | | Assert.IsTrue(tutorialController.teacherRawImage.rectTransform.position != oldPosition); |
| | 1 | 140 | | } |
| | | 141 | | |
| | | 142 | | private void CreateAndConfigureTutorial() |
| | | 143 | | { |
| | 10 | 144 | | tutorialController = GameObject.Instantiate(Resources.Load<GameObject>("TutorialController")).GetComponent<T |
| | 10 | 145 | | tutorialController.stepsOnGenesisPlaza.Clear(); |
| | 10 | 146 | | tutorialController.stepsFromDeepLink.Clear(); |
| | 10 | 147 | | tutorialController.stepsFromReset.Clear(); |
| | 10 | 148 | | tutorialController.stepsFromUserThatAlreadyDidTheTutorial.Clear(); |
| | 10 | 149 | | tutorialController.timeBetweenSteps = 0f; |
| | 10 | 150 | | tutorialController.sendStats = false; |
| | 10 | 151 | | tutorialController.debugRunTutorial = false; |
| | 10 | 152 | | tutorialController.tutorialReset = false; |
| | 10 | 153 | | tutorialController.userAlreadyDidTheTutorial = false; |
| | 10 | 154 | | } |
| | | 155 | | |
| | | 156 | | private void DestroyTutorial() |
| | | 157 | | { |
| | 100 | 158 | | foreach (var step in currentSteps) |
| | | 159 | | { |
| | 40 | 160 | | GameObject.Destroy(step); |
| | | 161 | | } |
| | | 162 | | |
| | 10 | 163 | | GameObject.Destroy(tutorialController.gameObject); |
| | 10 | 164 | | currentSteps.Clear(); |
| | 10 | 165 | | currentStepIndex = 0; |
| | 10 | 166 | | } |
| | | 167 | | |
| | | 168 | | private void ConfigureTutorialForGenesisPlaza() |
| | | 169 | | { |
| | 24 | 170 | | for (int i = 0; i < 5; i++) |
| | | 171 | | { |
| | 10 | 172 | | tutorialController.stepsOnGenesisPlaza.Add(CreateNewFakeStep()); |
| | | 173 | | } |
| | | 174 | | |
| | 2 | 175 | | currentStepIndex = 0; |
| | 2 | 176 | | currentSteps = tutorialController.stepsOnGenesisPlaza; |
| | | 177 | | |
| | 2 | 178 | | tutorialController.playerIsInGenesisPlaza = true; |
| | 2 | 179 | | tutorialController.isRunning = true; |
| | 2 | 180 | | CommonScriptableObjects.tutorialActive.Set(true); |
| | 2 | 181 | | } |
| | | 182 | | |
| | | 183 | | private void ConfigureTutorialForDeepLink() |
| | | 184 | | { |
| | 24 | 185 | | for (int i = 0; i < 5; i++) |
| | | 186 | | { |
| | 10 | 187 | | tutorialController.stepsFromDeepLink.Add(CreateNewFakeStep()); |
| | | 188 | | } |
| | | 189 | | |
| | 2 | 190 | | currentStepIndex = 0; |
| | 2 | 191 | | currentSteps = tutorialController.stepsFromDeepLink; |
| | | 192 | | |
| | 2 | 193 | | tutorialController.playerIsInGenesisPlaza = false; |
| | 2 | 194 | | tutorialController.openedFromDeepLink = true; |
| | 2 | 195 | | tutorialController.isRunning = true; |
| | 2 | 196 | | CommonScriptableObjects.tutorialActive.Set(true); |
| | 2 | 197 | | } |
| | | 198 | | |
| | | 199 | | private void ConfigureTutorialForResetTutorial() |
| | | 200 | | { |
| | 24 | 201 | | for (int i = 0; i < 5; i++) |
| | | 202 | | { |
| | 10 | 203 | | tutorialController.stepsFromReset.Add(CreateNewFakeStep()); |
| | | 204 | | } |
| | | 205 | | |
| | 2 | 206 | | currentStepIndex = 0; |
| | 2 | 207 | | currentSteps = tutorialController.stepsFromReset; |
| | | 208 | | |
| | 2 | 209 | | tutorialController.tutorialReset = true; |
| | 2 | 210 | | tutorialController.playerIsInGenesisPlaza = false; |
| | 2 | 211 | | tutorialController.isRunning = true; |
| | 2 | 212 | | CommonScriptableObjects.tutorialActive.Set(true); |
| | 2 | 213 | | } |
| | | 214 | | |
| | | 215 | | private void ConfigureTutorialForUserThatAlreadyDidTheTutorial() |
| | | 216 | | { |
| | 24 | 217 | | for (int i = 0; i < 5; i++) |
| | | 218 | | { |
| | 10 | 219 | | tutorialController.stepsFromUserThatAlreadyDidTheTutorial.Add(CreateNewFakeStep()); |
| | | 220 | | } |
| | | 221 | | |
| | 2 | 222 | | currentStepIndex = 0; |
| | 2 | 223 | | currentSteps = tutorialController.stepsFromUserThatAlreadyDidTheTutorial; |
| | | 224 | | |
| | 2 | 225 | | tutorialController.userAlreadyDidTheTutorial = true; |
| | 2 | 226 | | tutorialController.isRunning = true; |
| | 2 | 227 | | CommonScriptableObjects.tutorialActive.Set(true); |
| | 2 | 228 | | } |
| | | 229 | | |
| | | 230 | | private TutorialStep_Mock CreateNewFakeStep() |
| | | 231 | | { |
| | 40 | 232 | | GameObject newStepObject = new GameObject("FakeStep"); |
| | 40 | 233 | | TutorialStep_Mock newStep = newStepObject.AddComponent<TutorialStep_Mock>(); |
| | 40 | 234 | | newStep.letInstantiation = false; |
| | 40 | 235 | | newStep.customOnStepStart = WaitForOnStepStart; |
| | 40 | 236 | | newStep.customOnStepExecute = WaitForOnStepExecute; |
| | 40 | 237 | | newStep.customOnStepPlayAnimationForHidding = WaitForOnStepPlayAnimationForHidding; |
| | 40 | 238 | | newStep.customOnStepFinished = WaitForOnStepFinished; |
| | 40 | 239 | | return newStep; |
| | | 240 | | } |
| | | 241 | | |
| | 40 | 242 | | private void WaitForOnStepStart() { CheckRunningStep(); } |
| | | 243 | | |
| | | 244 | | private IEnumerator WaitForOnStepExecute() |
| | | 245 | | { |
| | 0 | 246 | | CheckRunningStep(); |
| | 0 | 247 | | yield return null; |
| | 0 | 248 | | } |
| | | 249 | | |
| | | 250 | | private IEnumerator WaitForOnStepPlayAnimationForHidding() |
| | | 251 | | { |
| | 0 | 252 | | CheckRunningStep(); |
| | 0 | 253 | | yield return null; |
| | 0 | 254 | | } |
| | | 255 | | |
| | | 256 | | private void WaitForOnStepFinished() |
| | | 257 | | { |
| | 20 | 258 | | CheckRunningStep(); |
| | 20 | 259 | | currentStepIndex++; |
| | 20 | 260 | | } |
| | | 261 | | |
| | | 262 | | private void CheckRunningStep() |
| | | 263 | | { |
| | 40 | 264 | | Assert.IsTrue(tutorialController.isRunning); |
| | 40 | 265 | | Assert.IsNotNull(tutorialController.runningStep); |
| | 40 | 266 | | Assert.IsTrue(currentSteps[currentStepIndex] == tutorialController.runningStep); |
| | 40 | 267 | | Assert.IsTrue(CommonScriptableObjects.tutorialActive.Get()); |
| | 40 | 268 | | } |
| | | 269 | | } |
| | | 270 | | } |