EditModeRunner.cs 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438
  1. using System;
  2. using System.Collections;
  3. using System.Collections.Generic;
  4. using System.Linq;
  5. using NUnit.Framework.Interfaces;
  6. using NUnit.Framework.Internal;
  7. using NUnit.Framework.Internal.Filters;
  8. using UnityEngine;
  9. using UnityEngine.TestTools.NUnitExtensions;
  10. using UnityEngine.TestTools.TestRunner;
  11. using UnityEngine.TestTools;
  12. using UnityEngine.TestTools.TestRunner.GUI;
  13. using UnityEditor.Callbacks;
  14. using UnityEditor.TestTools.TestRunner.Api;
  15. using UnityEngine.TestRunner.NUnitExtensions;
  16. using UnityEngine.TestRunner.NUnitExtensions.Runner;
  17. namespace UnityEditor.TestTools.TestRunner
  18. {
  19. internal interface IUnityTestAssemblyRunnerFactory
  20. {
  21. IUnityTestAssemblyRunner Create(TestPlatform testPlatform, WorkItemFactory factory);
  22. }
  23. internal class UnityTestAssemblyRunnerFactory : IUnityTestAssemblyRunnerFactory
  24. {
  25. public IUnityTestAssemblyRunner Create(TestPlatform testPlatform, WorkItemFactory factory)
  26. {
  27. return new UnityTestAssemblyRunner(new UnityTestAssemblyBuilder(), factory);
  28. }
  29. }
  30. [Serializable]
  31. internal class EditModeRunner : ScriptableObject, IDisposable
  32. {
  33. [SerializeField]
  34. private Filter[] m_Filters;
  35. //The counter from the IEnumerator object
  36. [SerializeField]
  37. private int m_CurrentPC;
  38. [SerializeField]
  39. private bool m_ExecuteOnEnable;
  40. [SerializeField]
  41. private List<string> m_AlreadyStartedTests;
  42. [SerializeField]
  43. private List<TestResultSerializer> m_ExecutedTests;
  44. [SerializeField]
  45. private List<ScriptableObject> m_CallbackObjects = new List<ScriptableObject>();
  46. [SerializeField]
  47. private TestStartedEvent m_TestStartedEvent = new TestStartedEvent();
  48. [SerializeField]
  49. private TestFinishedEvent m_TestFinishedEvent = new TestFinishedEvent();
  50. [SerializeField]
  51. private RunStartedEvent m_RunStartedEvent = new RunStartedEvent();
  52. [SerializeField]
  53. private RunFinishedEvent m_RunFinishedEvent = new RunFinishedEvent();
  54. [SerializeField]
  55. private TestRunnerStateSerializer m_TestRunnerStateSerializer = new TestRunnerStateSerializer();
  56. [SerializeField]
  57. private bool m_RunningTests;
  58. [SerializeField]
  59. private TestPlatform m_TestPlatform;
  60. [SerializeField]
  61. private object m_CurrentYieldObject;
  62. [SerializeField]
  63. private BeforeAfterTestCommandState m_SetUpTearDownState;
  64. [SerializeField]
  65. private BeforeAfterTestCommandState m_OuterUnityTestActionState;
  66. [SerializeField]
  67. public bool RunFinished = false;
  68. public bool RunningSynchronously { get; private set; }
  69. internal IUnityTestAssemblyRunner m_Runner;
  70. private ConstructDelegator m_ConstructDelegator;
  71. private IEnumerator m_RunStep;
  72. public IUnityTestAssemblyRunnerFactory UnityTestAssemblyRunnerFactory { get; set; }
  73. public void Init(Filter[] filters, TestPlatform platform, bool runningSynchronously)
  74. {
  75. m_Filters = filters;
  76. m_TestPlatform = platform;
  77. m_AlreadyStartedTests = new List<string>();
  78. m_ExecutedTests = new List<TestResultSerializer>();
  79. RunningSynchronously = runningSynchronously;
  80. InitRunner();
  81. }
  82. private void InitRunner()
  83. {
  84. //We give the EditMode platform here so we dont suddenly create Playmode work items in the test Runner.
  85. m_Runner = (UnityTestAssemblyRunnerFactory ?? new UnityTestAssemblyRunnerFactory()).Create(TestPlatform.EditMode, new EditmodeWorkItemFactory());
  86. var testAssemblyProvider = new EditorLoadedTestAssemblyProvider(new EditorCompilationInterfaceProxy(), new EditorAssembliesProxy());
  87. var assemblies = testAssemblyProvider.GetAssembliesGroupedByType(m_TestPlatform).Select(x => x.Assembly).ToArray();
  88. var loadedTests = m_Runner.Load(assemblies, TestPlatform.EditMode,
  89. UnityTestAssemblyBuilder.GetNUnitTestBuilderSettings(m_TestPlatform));
  90. loadedTests.ParseForNameDuplicates();
  91. CallbacksDelegator.instance.TestTreeRebuild(loadedTests);
  92. hideFlags |= HideFlags.DontSave;
  93. EnumerableSetUpTearDownCommand.ActivePcHelper = new EditModePcHelper();
  94. OuterUnityTestActionCommand.ActivePcHelper = new EditModePcHelper();
  95. }
  96. public void OnEnable()
  97. {
  98. if (m_ExecuteOnEnable)
  99. {
  100. InitRunner();
  101. m_ExecuteOnEnable = false;
  102. foreach (var callback in m_CallbackObjects)
  103. {
  104. AddListeners(callback as ITestRunnerListener);
  105. }
  106. m_ConstructDelegator = new ConstructDelegator(m_TestRunnerStateSerializer);
  107. EnumeratorStepHelper.SetEnumeratorPC(m_CurrentPC);
  108. UnityWorkItemDataHolder.alreadyExecutedTests = m_ExecutedTests.Select(x => x.uniqueName).ToList();
  109. UnityWorkItemDataHolder.alreadyStartedTests = m_AlreadyStartedTests;
  110. Run();
  111. }
  112. }
  113. public void TestStartedEvent(ITest test)
  114. {
  115. m_AlreadyStartedTests.Add(test.GetUniqueName());
  116. }
  117. public void TestFinishedEvent(ITestResult testResult)
  118. {
  119. m_AlreadyStartedTests.Remove(testResult.Test.GetUniqueName());
  120. m_ExecutedTests.Add(TestResultSerializer.MakeFromTestResult(testResult));
  121. }
  122. public void Run()
  123. {
  124. EditModeTestCallbacks.RestoringTestContext += OnRestoringTest;
  125. var context = m_Runner.GetCurrentContext();
  126. if (m_SetUpTearDownState == null)
  127. {
  128. m_SetUpTearDownState = CreateInstance<BeforeAfterTestCommandState>();
  129. }
  130. context.SetUpTearDownState = m_SetUpTearDownState;
  131. if (m_OuterUnityTestActionState == null)
  132. {
  133. m_OuterUnityTestActionState = CreateInstance<BeforeAfterTestCommandState>();
  134. }
  135. context.OuterUnityTestActionState = m_OuterUnityTestActionState;
  136. if (!m_RunningTests)
  137. {
  138. m_RunStartedEvent.Invoke(m_Runner.LoadedTest);
  139. }
  140. if (m_ConstructDelegator == null)
  141. m_ConstructDelegator = new ConstructDelegator(m_TestRunnerStateSerializer);
  142. Reflect.ConstructorCallWrapper = m_ConstructDelegator.Delegate;
  143. m_TestStartedEvent.AddListener(TestStartedEvent);
  144. m_TestFinishedEvent.AddListener(TestFinishedEvent);
  145. AssemblyReloadEvents.beforeAssemblyReload += OnBeforeAssemblyReload;
  146. RunningTests = true;
  147. EditorApplication.LockReloadAssemblies();
  148. var testListenerWrapper = new TestListenerWrapper(m_TestStartedEvent, m_TestFinishedEvent);
  149. m_RunStep = m_Runner.Run(testListenerWrapper, GetFilter()).GetEnumerator();
  150. m_RunningTests = true;
  151. if (!RunningSynchronously)
  152. EditorApplication.update += TestConsumer;
  153. }
  154. public void CompleteSynchronously()
  155. {
  156. while (!m_Runner.IsTestComplete)
  157. TestConsumer();
  158. }
  159. private void OnBeforeAssemblyReload()
  160. {
  161. EditorApplication.update -= TestConsumer;
  162. if (m_ExecuteOnEnable)
  163. {
  164. AssemblyReloadEvents.beforeAssemblyReload -= OnBeforeAssemblyReload;
  165. return;
  166. }
  167. if (m_Runner != null && m_Runner.TopLevelWorkItem != null)
  168. m_Runner.TopLevelWorkItem.ResultedInDomainReload = true;
  169. if (RunningTests)
  170. {
  171. Debug.LogError("TestRunner: Unexpected assembly reload happened while running tests");
  172. EditorUtility.ClearProgressBar();
  173. if (m_Runner.GetCurrentContext() != null && m_Runner.GetCurrentContext().CurrentResult != null)
  174. {
  175. m_Runner.GetCurrentContext().CurrentResult.SetResult(ResultState.Cancelled, "Unexpected assembly reload happened");
  176. }
  177. OnRunCancel();
  178. }
  179. }
  180. private bool RunningTests;
  181. private Stack<IEnumerator> StepStack = new Stack<IEnumerator>();
  182. private bool MoveNextAndUpdateYieldObject()
  183. {
  184. var result = m_RunStep.MoveNext();
  185. if (result)
  186. {
  187. m_CurrentYieldObject = m_RunStep.Current;
  188. while (m_CurrentYieldObject is IEnumerator) // going deeper
  189. {
  190. var currentEnumerator = (IEnumerator)m_CurrentYieldObject;
  191. // go deeper and add parent to stack
  192. StepStack.Push(m_RunStep);
  193. m_RunStep = currentEnumerator;
  194. m_CurrentYieldObject = m_RunStep.Current;
  195. }
  196. if (StepStack.Count > 0 && m_CurrentYieldObject != null) // not null and not IEnumerator, nested
  197. {
  198. Debug.LogError("EditMode test can only yield null, but not <" + m_CurrentYieldObject.GetType().Name + ">");
  199. }
  200. return true;
  201. }
  202. if (StepStack.Count == 0) // done
  203. return false;
  204. m_RunStep = StepStack.Pop(); // going up
  205. return MoveNextAndUpdateYieldObject();
  206. }
  207. private void TestConsumer()
  208. {
  209. var moveNext = MoveNextAndUpdateYieldObject();
  210. if (m_CurrentYieldObject != null)
  211. {
  212. InvokeDelegator();
  213. }
  214. if (!moveNext && !m_Runner.IsTestComplete)
  215. {
  216. CompleteTestRun();
  217. throw new IndexOutOfRangeException("There are no more elements to process and IsTestComplete is false");
  218. }
  219. if (m_Runner.IsTestComplete)
  220. {
  221. CompleteTestRun();
  222. }
  223. }
  224. private void CompleteTestRun()
  225. {
  226. if (!RunningSynchronously)
  227. EditorApplication.update -= TestConsumer;
  228. TestLauncherBase.ExecutePostBuildCleanupMethods(this.GetLoadedTests(), this.GetFilter(), Application.platform);
  229. m_RunFinishedEvent.Invoke(m_Runner.Result);
  230. RunFinished = true;
  231. if (m_ConstructDelegator != null)
  232. m_ConstructDelegator.DestroyCurrentTestObjectIfExists();
  233. Dispose();
  234. UnityWorkItemDataHolder.alreadyExecutedTests = null;
  235. }
  236. private void OnRestoringTest()
  237. {
  238. var item = m_ExecutedTests.Find(t => t.fullName == UnityTestExecutionContext.CurrentContext.CurrentTest.FullName);
  239. if (item != null)
  240. {
  241. item.RestoreTestResult(UnityTestExecutionContext.CurrentContext.CurrentResult);
  242. }
  243. }
  244. private static bool IsCancelled()
  245. {
  246. return UnityTestExecutionContext.CurrentContext.ExecutionStatus == TestExecutionStatus.AbortRequested || UnityTestExecutionContext.CurrentContext.ExecutionStatus == TestExecutionStatus.StopRequested;
  247. }
  248. private void InvokeDelegator()
  249. {
  250. if (m_CurrentYieldObject == null)
  251. {
  252. return;
  253. }
  254. if (IsCancelled())
  255. {
  256. return;
  257. }
  258. if (m_CurrentYieldObject is RestoreTestContextAfterDomainReload)
  259. {
  260. if (m_TestRunnerStateSerializer.ShouldRestore())
  261. {
  262. m_TestRunnerStateSerializer.RestoreContext();
  263. }
  264. return;
  265. }
  266. try
  267. {
  268. if (m_CurrentYieldObject is IEditModeTestYieldInstruction)
  269. {
  270. var editModeTestYieldInstruction = (IEditModeTestYieldInstruction)m_CurrentYieldObject;
  271. if (editModeTestYieldInstruction.ExpectDomainReload)
  272. {
  273. PrepareForDomainReload();
  274. }
  275. return;
  276. }
  277. }
  278. catch (Exception e)
  279. {
  280. UnityTestExecutionContext.CurrentContext.CurrentResult.RecordException(e);
  281. return;
  282. }
  283. Debug.LogError("EditMode test can only yield null");
  284. }
  285. private void CompilationFailureWatch()
  286. {
  287. if (EditorApplication.isCompiling)
  288. return;
  289. EditorApplication.update -= CompilationFailureWatch;
  290. if (EditorUtility.scriptCompilationFailed)
  291. {
  292. EditorUtility.ClearProgressBar();
  293. OnRunCancel();
  294. }
  295. }
  296. private void PrepareForDomainReload()
  297. {
  298. m_TestRunnerStateSerializer.SaveContext();
  299. m_CurrentPC = EnumeratorStepHelper.GetEnumeratorPC(TestEnumerator.Enumerator);
  300. m_ExecuteOnEnable = true;
  301. RunningTests = false;
  302. }
  303. public T AddEventHandler<T>() where T : ScriptableObject, ITestRunnerListener
  304. {
  305. var eventHandler = CreateInstance<T>();
  306. eventHandler.hideFlags |= HideFlags.DontSave;
  307. m_CallbackObjects.Add(eventHandler);
  308. AddListeners(eventHandler);
  309. return eventHandler;
  310. }
  311. private void AddListeners(ITestRunnerListener eventHandler)
  312. {
  313. m_TestStartedEvent.AddListener(eventHandler.TestStarted);
  314. m_TestFinishedEvent.AddListener(eventHandler.TestFinished);
  315. m_RunStartedEvent.AddListener(eventHandler.RunStarted);
  316. m_RunFinishedEvent.AddListener(eventHandler.RunFinished);
  317. }
  318. public void Dispose()
  319. {
  320. Reflect.MethodCallWrapper = null;
  321. EditorApplication.update -= TestConsumer;
  322. DestroyImmediate(this);
  323. if (m_CallbackObjects != null)
  324. {
  325. foreach (var obj in m_CallbackObjects)
  326. {
  327. DestroyImmediate(obj);
  328. }
  329. m_CallbackObjects.Clear();
  330. }
  331. RunningTests = false;
  332. EditorApplication.UnlockReloadAssemblies();
  333. }
  334. public void OnRunCancel()
  335. {
  336. UnityWorkItemDataHolder.alreadyExecutedTests = null;
  337. m_ExecuteOnEnable = false;
  338. m_Runner.StopRun();
  339. RunFinished = true;
  340. }
  341. public ITest GetLoadedTests()
  342. {
  343. return m_Runner.LoadedTest;
  344. }
  345. public ITestFilter GetFilter()
  346. {
  347. return new OrFilter(m_Filters.Select(filter => filter.BuildNUnitFilter(RunningSynchronously)).ToArray());
  348. }
  349. }
  350. }