暂无描述
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

EditModeRunner.cs 15KB

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