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