No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

EditModeRunner.cs 15KB

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