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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
|
# mypy: allow-untyped-defs
import threading
import time
import traceback
from queue import Empty
from collections import namedtuple, defaultdict
from typing import Any, Mapping, Optional
from mozlog import structuredlog, capture
from . import mpcontext, testloader
# Special value used as a sentinal in various commands
Stop = object()
def release_mozlog_lock():
try:
from mozlog.structuredlog import StructuredLogger
try:
StructuredLogger._lock.release()
except threading.ThreadError:
pass
except ImportError:
pass
TestImplementation = namedtuple('TestImplementation',
['executor_cls', 'executor_kwargs',
'browser_cls', 'browser_kwargs'])
class LogMessageHandler:
def __init__(self, send_message):
self.send_message = send_message
def __call__(self, data):
self.send_message("log", data)
class TestRunner:
"""Class implementing the main loop for running tests.
This class delegates the job of actually running a test to the executor
that is passed in.
:param logger: Structured logger
:param command_queue: multiprocessing.Queue used to send commands to the
process
:param result_queue: multiprocessing.Queue used to send results to the
parent TestRunnerManager process
:param executor: TestExecutor object that will actually run a test.
"""
def __init__(self, logger, command_queue, result_queue, executor, recording):
self.command_queue = command_queue
self.result_queue = result_queue
self.executor = executor
self.name = mpcontext.get_context().current_process().name
self.logger = logger
self.recording = recording
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
self.teardown()
def setup(self):
self.logger.debug("Executor setup")
try:
self.executor.setup(self)
except Exception:
# The caller is responsible for logging the exception if required
self.send_message("init_failed")
else:
self.send_message("init_succeeded")
self.logger.debug("Executor setup done")
def teardown(self):
self.executor.teardown()
self.send_message("runner_teardown")
self.result_queue = None
self.command_queue = None
self.browser = None
def run(self):
"""Main loop accepting commands over the pipe and triggering
the associated methods"""
try:
self.setup()
except Exception:
self.logger.warning("An error occured during executor setup:\n%s" %
traceback.format_exc())
raise
commands = {"run_test": self.run_test,
"reset": self.reset,
"stop": self.stop,
"wait": self.wait}
while True:
command, args = self.command_queue.get()
try:
rv = commands[command](*args)
except Exception:
self.send_message("error",
"Error running command %s with arguments %r:\n%s" %
(command, args, traceback.format_exc()))
else:
if rv is Stop:
break
def stop(self):
return Stop
def reset(self):
self.executor.reset()
def run_test(self, test):
try:
return self.executor.run_test(test)
except Exception:
message = "TestRunner.run_test caught an exception:\n"
message += traceback.format_exc()
self.logger.error(message)
raise
def wait(self):
rerun = self.executor.wait()
self.send_message("wait_finished", rerun)
def send_message(self, command, *args):
self.result_queue.put((command, args))
def start_runner(runner_command_queue, runner_result_queue,
executor_cls, executor_kwargs,
executor_browser_cls, executor_browser_kwargs,
capture_stdio, stop_flag, recording):
"""Launch a TestRunner in a new process"""
def send_message(command, *args):
runner_result_queue.put((command, args))
def handle_error(e):
logger.critical(traceback.format_exc())
stop_flag.set()
# Ensure that when we start this in a new process we have the global lock
# in the logging module unlocked
release_mozlog_lock()
proc_name = mpcontext.get_context().current_process().name
logger = structuredlog.StructuredLogger(proc_name)
logger.add_handler(LogMessageHandler(send_message))
with capture.CaptureIO(logger, capture_stdio):
try:
browser = executor_browser_cls(**executor_browser_kwargs)
executor = executor_cls(logger, browser, **executor_kwargs)
with TestRunner(logger, runner_command_queue, runner_result_queue, executor, recording) as runner:
try:
runner.run()
except KeyboardInterrupt:
stop_flag.set()
except Exception as e:
handle_error(e)
except Exception as e:
handle_error(e)
class BrowserManager:
def __init__(self, logger, browser, command_queue, no_timeout=False):
self.logger = logger
self.browser = browser
self.no_timeout = no_timeout
self.browser_settings = None
self.last_test = None
self.started = False
self.browser_pid = None
self.init_timer = None
self.command_queue = command_queue
def update_settings(self, test):
browser_settings = self.browser.settings(test)
restart_required = ((self.browser_settings is not None and
self.browser_settings != browser_settings) or
(self.last_test != test and test.expected() == "CRASH"))
self.browser_settings = browser_settings
self.last_test = test
return restart_required
def init(self, group_metadata):
"""Launch the browser that is being tested,
and the TestRunner process that will run the tests."""
# It seems that this lock is helpful to prevent some race that otherwise
# sometimes stops the spawned processes initialising correctly, and
# leaves this thread hung
if self.init_timer is not None:
self.init_timer.cancel()
self.logger.debug("Init called, starting browser and runner")
if not self.no_timeout:
self.init_timer = threading.Timer(self.browser.init_timeout,
self.init_timeout)
try:
if self.init_timer is not None:
self.init_timer.start()
self.logger.debug("Starting browser with settings %r" % self.browser_settings)
self.browser.start(group_metadata=group_metadata, **self.browser_settings)
self.browser_pid = self.browser.pid
except Exception:
self.logger.error(f"Failure during init:\n{traceback.format_exc()}")
if self.init_timer is not None:
self.init_timer.cancel()
succeeded = False
else:
succeeded = True
self.started = True
return succeeded
def send_message(self, command, *args):
self.command_queue.put((command, args))
def init_timeout(self):
# This is called from a separate thread, so we send a message to the
# main loop so we get back onto the manager thread
self.logger.debug("init_failed called from timer")
self.send_message("init_failed")
def after_init(self):
"""Callback when we have started the browser, started the remote
control connection, and we are ready to start testing."""
if self.init_timer is not None:
self.init_timer.cancel()
def stop(self, force=False):
self.browser.stop(force=force)
self.started = False
def cleanup(self):
if self.init_timer is not None:
self.init_timer.cancel()
def check_crash(self, test_id):
return self.browser.check_crash(process=self.browser_pid, test=test_id)
def is_alive(self):
return self.browser.is_alive()
class TestSource:
def __init__(self, logger: structuredlog.StructuredLogger, test_queue: testloader.ReadQueue):
self.logger = logger
self.test_queue = test_queue
self.current_group = testloader.TestGroup(None, None, None, None)
def group(self) -> testloader.TestGroup:
if not self.current_group.group or len(self.current_group.group) == 0:
try:
self.current_group = self.test_queue.get()
self.logger.debug(f"Got new test group subsuite:{self.current_group[1]} "
f"test_type:{self.current_group[2]}")
except Empty:
return testloader.TestGroup(None, None, None, None)
return self.current_group
class _RunnerManagerState:
before_init = namedtuple("before_init", [])
initializing = namedtuple("initializing",
["subsuite", "test_type", "test", "test_group",
"group_metadata", "failure_count"])
running = namedtuple("running", ["subsuite", "test_type", "test", "test_group", "group_metadata"])
restarting = namedtuple("restarting", ["subsuite", "test_type", "test", "test_group",
"group_metadata", "force_stop"])
error = namedtuple("error", [])
stop = namedtuple("stop", ["force_stop"])
RunnerManagerState = _RunnerManagerState()
class TestRunnerManager(threading.Thread):
def __init__(self, suite_name, index, test_queue,
test_implementations, stop_flag, retry_index=0, rerun=1,
pause_after_test=False, pause_on_unexpected=False,
restart_on_unexpected=True, debug_info=None,
capture_stdio=True, restart_on_new_group=True, recording=None, max_restarts=5):
"""Thread that owns a single TestRunner process and any processes required
by the TestRunner (e.g. the Firefox binary).
TestRunnerManagers are responsible for launching the browser process and the
runner process, and for logging the test progress. The actual test running
is done by the TestRunner. In particular they:
* Start the binary of the program under test
* Start the TestRunner
* Tell the TestRunner to start a test, if any
* Log that the test started
* Log the test results
* Take any remedial action required e.g. restart crashed or hung
processes
"""
self.suite_name = suite_name
self.manager_number = index
self.test_implementation_key = None
self.test_implementations = {}
for key, test_implementation in test_implementations.items():
browser_kwargs = test_implementation.browser_kwargs
if browser_kwargs.get("device_serial"):
browser_kwargs = browser_kwargs.copy()
# Assign Android device to runner according to current manager index
browser_kwargs["device_serial"] = browser_kwargs["device_serial"][index]
self.test_implementations[key] = TestImplementation(
test_implementation.executor_cls,
test_implementation.executor_kwargs,
test_implementation.browser_cls,
browser_kwargs)
else:
self.test_implementations[key] = test_implementation
# Flags used to shut down this thread if we get a sigint
self.parent_stop_flag = stop_flag
self.child_stop_flag = mpcontext.get_context().Event()
# Keep track of the current retry index. The retries are meant to handle
# flakiness, so at retry round we should restart the browser after each test.
self.retry_index = retry_index
self.rerun = rerun
self.run_count = 0
self.pause_after_test = pause_after_test
self.pause_on_unexpected = pause_on_unexpected
self.restart_on_unexpected = restart_on_unexpected
self.debug_info = debug_info
self.capture_stdio = capture_stdio
self.restart_on_new_group = restart_on_new_group
self.max_restarts = max_restarts
assert recording is not None
self.recording = recording
self.test_count = 0
self.unexpected_fail_tests = defaultdict(list)
self.unexpected_pass_tests = defaultdict(list)
# Properties we initialize right after the thread is started
self.logger = None
self.test_source = None
self.command_queue = None
self.remote_queue = None
# Properties we initalize later in the lifecycle
self.timer = None
self.test_runner_proc = None
self.browser = None
super().__init__(name=f"TestRunnerManager-{index}", target=self.run_loop, args=[test_queue], daemon=True)
def run_loop(self, test_queue):
"""Main loop for the TestRunnerManager.
TestRunnerManagers generally receive commands from their
TestRunner updating them on the status of a test. They
may also have a stop flag set by the main thread indicating
that the manager should shut down the next time the event loop
spins."""
self.recording.set(["testrunner", "startup"])
self.logger = structuredlog.StructuredLogger(self.suite_name)
self.test_source = TestSource(self.logger, test_queue)
mp = mpcontext.get_context()
self.command_queue = mp.Queue()
self.remote_queue = mp.Queue()
dispatch = {
RunnerManagerState.before_init: self.start_init,
RunnerManagerState.initializing: self.init,
RunnerManagerState.running: self.run_test,
RunnerManagerState.restarting: self.restart_runner,
}
self.state = RunnerManagerState.before_init()
end_states = (RunnerManagerState.stop,
RunnerManagerState.error)
try:
while not isinstance(self.state, end_states):
f = dispatch.get(self.state.__class__)
while f:
self.logger.debug(f"Dispatch {f.__name__}")
if self.should_stop():
return
new_state = f()
if new_state is None:
break
self.state = new_state
self.logger.debug(f"new state: {self.state.__class__.__name__}")
if isinstance(self.state, end_states):
return
f = dispatch.get(self.state.__class__)
new_state = None
while new_state is None:
new_state = self.wait_event()
if self.should_stop():
return
self.state = new_state
self.logger.debug(f"new state: {self.state.__class__.__name__}")
except Exception:
message = "Uncaught exception in TestRunnerManager.run:\n"
message += traceback.format_exc()
self.logger.critical(message)
raise
finally:
self.logger.debug("TestRunnerManager main loop terminating, starting cleanup")
skipped_tests = []
while True:
_, _, test, _, _ = self.get_next_test()
if test is None:
break
skipped_tests.append(test)
if skipped_tests:
self.logger.critical(
f"Tests left in the queue: {skipped_tests[0].id!r} "
f"and {len(skipped_tests) - 1} others"
)
for test in skipped_tests[1:]:
self.logger.debug(f"Test left in the queue: {test.id!r}")
force_stop = (not isinstance(self.state, RunnerManagerState.stop) or
self.state.force_stop)
self.stop_runner(force=force_stop)
self.teardown()
if self.browser is not None:
assert self.browser.browser is not None
self.browser.browser.cleanup()
self.logger.debug("TestRunnerManager main loop terminated")
def wait_event(self):
dispatch = {
RunnerManagerState.before_init: {},
RunnerManagerState.initializing:
{
"init_succeeded": self.init_succeeded,
"init_failed": self.init_failed,
},
RunnerManagerState.running:
{
"test_ended": self.test_ended,
"wait_finished": self.wait_finished,
},
RunnerManagerState.restarting: {},
RunnerManagerState.error: {},
RunnerManagerState.stop: {},
None: {
"runner_teardown": self.runner_teardown,
"log": self.log,
"error": self.error
}
}
try:
command, data = self.command_queue.get(True, 1)
self.logger.debug("Got command: %r" % command)
except OSError:
self.logger.error("Got IOError from poll")
return RunnerManagerState.restarting(self.state.subsuite,
self.state.test_type,
self.state.test,
self.state.test_group,
self.state.group_metadata,
False)
except Empty:
if (self.debug_info and self.debug_info.interactive and
self.browser.started and not self.browser.is_alive()):
self.logger.debug("Debugger exited")
return RunnerManagerState.stop(False)
if (isinstance(self.state, RunnerManagerState.running) and
not self.test_runner_proc.is_alive()):
if not self.command_queue.empty():
# We got a new message so process that
return
# If we got to here the runner presumably shut down
# unexpectedly
self.logger.info("Test runner process shut down")
if self.state.test is not None:
# This could happen if the test runner crashed for some other
# reason
# Need to consider the unlikely case where one test causes the
# runner process to repeatedly die
self.logger.critical("Last test did not complete")
return RunnerManagerState.error()
self.logger.warning("More tests found, but runner process died, restarting")
return RunnerManagerState.restarting(self.state.test_type,
self.state.test,
self.state.test_group,
self.state.group_metadata,
False)
else:
f = (dispatch.get(self.state.__class__, {}).get(command) or
dispatch.get(None, {}).get(command))
if not f:
self.logger.warning("Got command %s in state %s" %
(command, self.state.__class__.__name__))
return
return f(*data)
def should_stop(self):
return self.child_stop_flag.is_set() or self.parent_stop_flag.is_set()
def start_init(self):
subsuite, test_type, test, test_group, group_metadata = self.get_next_test()
self.recording.set(["testrunner", "init"])
if test is None:
return RunnerManagerState.stop(True)
else:
return RunnerManagerState.initializing(subsuite, test_type, test, test_group, group_metadata, 0)
def init(self):
assert isinstance(self.state, RunnerManagerState.initializing)
if self.state.failure_count > self.max_restarts:
self.logger.critical("Max restarts exceeded")
return RunnerManagerState.error()
if (self.state.subsuite, self.state.test_type) != self.test_implementation_key:
if self.browser is not None:
assert self.browser.browser is not None
self.browser.browser.cleanup()
impl = self.test_implementations[(self.state.subsuite, self.state.test_type)]
browser = impl.browser_cls(self.logger, remote_queue=self.command_queue,
**impl.browser_kwargs)
browser.setup()
self.browser = BrowserManager(self.logger,
browser,
self.command_queue,
no_timeout=self.debug_info is not None)
self.test_implementation_key = (self.state.subsuite, self.state.test_type)
assert self.browser is not None
self.browser.update_settings(self.state.test)
result = self.browser.init(self.state.group_metadata)
if not result:
return self.init_failed()
self.start_test_runner()
def start_test_runner(self):
# Note that we need to be careful to start the browser before the
# test runner to ensure that any state set when the browser is started
# can be passed in to the test runner.
assert isinstance(self.state, RunnerManagerState.initializing)
assert self.command_queue is not None
assert self.remote_queue is not None
self.logger.info("Starting runner")
impl = self.test_implementations[(self.state.subsuite, self.state.test_type)]
self.executor_cls = impl.executor_cls
self.executor_kwargs = impl.executor_kwargs
self.executor_kwargs["group_metadata"] = self.state.group_metadata
self.executor_kwargs["browser_settings"] = self.browser.browser_settings
executor_browser_cls, executor_browser_kwargs = self.browser.browser.executor_browser()
args = (self.remote_queue,
self.command_queue,
self.executor_cls,
self.executor_kwargs,
executor_browser_cls,
executor_browser_kwargs,
self.capture_stdio,
self.child_stop_flag,
self.recording)
mp = mpcontext.get_context()
self.test_runner_proc = mp.Process(target=start_runner,
args=args,
name="TestRunner-%i" % self.manager_number)
self.test_runner_proc.start()
self.logger.debug("Test runner started")
# Now we wait for either an init_succeeded event or an init_failed event
def init_succeeded(self):
assert isinstance(self.state, RunnerManagerState.initializing)
self.browser.after_init()
return RunnerManagerState.running(self.state.subsuite,
self.state.test_type,
self.state.test,
self.state.test_group,
self.state.group_metadata)
def init_failed(self):
assert isinstance(self.state, RunnerManagerState.initializing)
self.browser.check_crash(None)
self.browser.after_init()
self.stop_runner(force=True)
return RunnerManagerState.initializing(self.state.subsuite,
self.state.test_type,
self.state.test,
self.state.test_group,
self.state.group_metadata,
self.state.failure_count + 1)
def get_next_test(self):
# returns test_type, test, test_group, group_metadata
test = None
test_group = None
while test is None:
while test_group is None or len(test_group) == 0:
test_group, subsuite, test_type, group_metadata = self.test_source.group()
if test_group is None:
self.logger.info("No more tests")
return None, None, None, None, None
test = test_group.popleft()
self.run_count = 0
return subsuite, test_type, test, test_group, group_metadata
def run_test(self):
assert isinstance(self.state, RunnerManagerState.running)
assert self.state.test is not None
if self.browser.update_settings(self.state.test):
self.logger.info("Restarting browser for new test environment")
return RunnerManagerState.restarting(self.state.subsuite,
self.state.test_type,
self.state.test,
self.state.test_group,
self.state.group_metadata,
False)
self.recording.set(["testrunner", "test"] + self.state.test.id.split("/")[1:])
self.logger.test_start(self.state.test.id, subsuite=self.state.subsuite)
if self.rerun > 1:
self.logger.info(f"Run {self.run_count + 1}/{self.rerun}")
self.send_message("reset")
self.run_count += 1
if self.debug_info is None:
# Factor of 3 on the extra timeout here is based on allowing the executor
# at least test.timeout + 2 * extra_timeout to complete,
# which in turn is based on having several layers of timeout inside the executor
wait_timeout = (self.state.test.timeout * self.executor_kwargs['timeout_multiplier'] +
3 * self.executor_cls.extra_timeout)
self.timer = threading.Timer(wait_timeout, self._timeout)
self.timer.name = f"{self.name}-timeout"
self.send_message("run_test", self.state.test)
if self.timer:
self.timer.start()
def _timeout(self):
# This is executed in a different thread (threading.Timer).
self.logger.info("Got timeout in harness")
test = self.state.test
self.inject_message(
"test_ended",
test,
(test.make_result("EXTERNAL-TIMEOUT",
"TestRunner hit external timeout "
"(this may indicate a hang)"), []),
)
def test_ended(self, test, results):
"""Handle the end of a test.
Output the result of each subtest, and the result of the overall
harness to the logs.
"""
if ((not isinstance(self.state, RunnerManagerState.running)) or
(test != self.state.test)):
# Due to inherent race conditions in EXTERNAL-TIMEOUT, we might
# receive multiple test_ended for a test (e.g. from both Executor
# and TestRunner), in which case we ignore the duplicate message.
self.logger.warning("Received unexpected test_ended for %s" % test)
return
if self.timer is not None:
self.timer.cancel()
# Write the result of each subtest
file_result, test_results = results
subtest_unexpected = False
subtest_all_pass_or_expected = True
for result in test_results:
if test.disabled(result.name):
continue
expected = result.expected
known_intermittent = result.known_intermittent
is_unexpected = expected != result.status and result.status not in known_intermittent
is_expected_notrun = (expected == "NOTRUN" or "NOTRUN" in known_intermittent)
if not is_unexpected and result.status in ["FAIL", "PRECONDITION_FAILED"]:
# subtest is expected FAIL or expected PRECONDITION_FAILED,
# change result to unexpected if expected_fail_message does not
# match
expected_fail_message = test.expected_fail_message(result.name)
if expected_fail_message is not None and result.message.strip() != expected_fail_message:
is_unexpected = True
if result.status in known_intermittent:
known_intermittent.remove(result.status)
elif len(known_intermittent) > 0:
expected = known_intermittent[0]
known_intermittent = known_intermittent[1:]
else:
expected = "PASS"
if is_unexpected:
subtest_unexpected = True
if result.status != "PASS" and not is_expected_notrun:
# Any result against an expected "NOTRUN" should be treated
# as unexpected pass.
subtest_all_pass_or_expected = False
self.logger.test_status(test.id,
result.name,
result.status,
message=result.message,
expected=expected,
known_intermittent=known_intermittent,
stack=result.stack,
subsuite=self.state.subsuite)
expected = file_result.expected
known_intermittent = file_result.known_intermittent
status = file_result.status
if self.browser.check_crash(test.id) and status != "CRASH":
if test.test_type in ["crashtest", "wdspec"] or status == "EXTERNAL-TIMEOUT":
self.logger.info("Found a crash dump file; changing status to CRASH")
status = "CRASH"
else:
self.logger.warning(f"Found a crash dump; should change status from {status} to CRASH but this causes instability")
# We have a couple of status codes that are used internally, but not exposed to the
# user. These are used to indicate that some possibly-broken state was reached
# and we should restart the runner before the next test.
# INTERNAL-ERROR indicates a Python exception was caught in the harness
# EXTERNAL-TIMEOUT indicates we had to forcibly kill the browser from the harness
# because the test didn't return a result after reaching the test-internal timeout
status_subns = {"INTERNAL-ERROR": "ERROR",
"EXTERNAL-TIMEOUT": "TIMEOUT"}
status = status_subns.get(status, status)
self.test_count += 1
is_unexpected = expected != status and status not in known_intermittent
is_pass_or_expected = status in ["OK", "PASS"] or (not is_unexpected)
# A result is unexpected pass if the test or any subtest run
# unexpectedly, and the overall status is expected or passing (OK for test
# harness test, or PASS for reftest), and all unexpected results for
# subtests (if any) are unexpected pass.
is_unexpected_pass = ((is_unexpected or subtest_unexpected) and
is_pass_or_expected and subtest_all_pass_or_expected)
if is_unexpected_pass:
self.unexpected_pass_tests[self.state.subsuite, test.test_type].append(test)
elif is_unexpected or subtest_unexpected:
self.unexpected_fail_tests[self.state.subsuite, test.test_type].append(test)
if "assertion_count" in file_result.extra:
assertion_count = file_result.extra["assertion_count"]
if assertion_count is not None and assertion_count > 0:
self.logger.assertion_count(test.id,
int(assertion_count),
test.min_assertion_count,
test.max_assertion_count)
file_result.extra["test_timeout"] = test.timeout * self.executor_kwargs['timeout_multiplier']
self.logger.test_end(test.id,
status,
message=file_result.message,
expected=expected,
known_intermittent=known_intermittent,
extra=file_result.extra,
stack=file_result.stack,
subsuite=self.state.subsuite)
restart_before_next = (self.retry_index > 0 or test.restart_after or
file_result.status in ("CRASH", "EXTERNAL-TIMEOUT", "INTERNAL-ERROR") or
((subtest_unexpected or is_unexpected) and
self.restart_on_unexpected))
force_stop = test.test_type == "wdspec" and file_result.status == "EXTERNAL-TIMEOUT"
self.recording.set(["testrunner", "after-test"])
if (not file_result.status == "CRASH" and
self.pause_after_test or
(self.pause_on_unexpected and (subtest_unexpected or is_unexpected))):
self.logger.info("Pausing until the browser exits")
self.send_message("wait")
else:
return self.after_test_end(test, restart_before_next, force_stop=force_stop)
def wait_finished(self, rerun=False):
assert isinstance(self.state, RunnerManagerState.running)
self.logger.debug("Wait finished")
# The browser should be stopped already, but this ensures we do any
# post-stop processing
return self.after_test_end(self.state.test, not rerun, force_rerun=rerun)
def after_test_end(self, test, restart, force_rerun=False, force_stop=False):
assert isinstance(self.state, RunnerManagerState.running)
# Mixing manual reruns and automatic reruns is confusing; we currently assume
# that as long as we've done at least the automatic run count in total we can
# continue with the next test.
if not force_rerun and self.run_count >= self.rerun:
subsuite, test_type, test, test_group, group_metadata = self.get_next_test()
if test is None:
return RunnerManagerState.stop(force_stop)
if subsuite != self.state.subsuite:
self.logger.info(f"Restarting browser for new subsuite:{subsuite}")
restart = True
elif test_type != self.state.test_type:
self.logger.info(f"Restarting browser for new test type:{test_type}")
restart = True
elif self.restart_on_new_group and test_group is not self.state.test_group:
self.logger.info("Restarting browser for new test group")
restart = True
else:
subsuite = self.state.subsuite
test_type = self.state.test_type
test_group = self.state.test_group
group_metadata = self.state.group_metadata
if restart:
return RunnerManagerState.restarting(
subsuite, test_type, test, test_group, group_metadata, force_stop)
else:
return RunnerManagerState.running(
subsuite, test_type, test, test_group, group_metadata)
def restart_runner(self):
"""Stop and restart the TestRunner"""
assert isinstance(self.state, RunnerManagerState.restarting)
self.stop_runner(force=self.state.force_stop)
return RunnerManagerState.initializing(
self.state.subsuite, self.state.test_type, self.state.test,
self.state.test_group, self.state.group_metadata, 0)
def log(self, data: Mapping[str, Any]) -> None:
self.logger.log_raw(data)
def error(self, message):
self.logger.error(message)
self.restart_runner()
def stop_runner(self, force=False):
"""Stop the TestRunner and the browser binary."""
self.recording.set(["testrunner", "stop_runner"])
if self.test_runner_proc is None:
return
if self.test_runner_proc.is_alive():
self.send_message("stop")
try:
self.browser.stop(force=force)
self.ensure_runner_stopped()
finally:
self.cleanup()
def teardown(self):
self.logger.debug("TestRunnerManager teardown")
self.test_runner_proc = None
self.command_queue.close()
self.remote_queue.close()
self.command_queue = None
self.remote_queue = None
self.recording.pause()
def ensure_runner_stopped(self):
self.logger.debug("ensure_runner_stopped")
if self.test_runner_proc is None:
return
self.browser.stop(force=True)
self.test_runner_proc.join(10)
mp = mpcontext.get_context()
if self.test_runner_proc.is_alive():
# This might leak a file handle from the queue
self.logger.warning("Forcibly terminating runner process")
self.test_runner_proc.terminate()
self.logger.debug("After terminating runner process")
# Multiprocessing queues are backed by operating system pipes. If
# the pipe in the child process had buffered data at the time of
# forced termination, the queue is no longer in a usable state
# (subsequent attempts to retrieve items may block indefinitely).
# Discard the potentially-corrupted queue and create a new one.
self.logger.debug("Recreating command queue")
self.command_queue.cancel_join_thread()
self.command_queue.close()
self.command_queue = mp.Queue()
self.logger.debug("Recreating remote queue")
self.remote_queue.cancel_join_thread()
self.remote_queue.close()
self.remote_queue = mp.Queue()
else:
self.logger.debug("Runner process exited with code %i" % self.test_runner_proc.exitcode)
def runner_teardown(self):
self.ensure_runner_stopped()
return RunnerManagerState.stop(False)
def send_message(self, command, *args):
"""Send a message to the remote queue (to Executor)."""
self.remote_queue.put((command, args))
def inject_message(self, command, *args):
"""Inject a message to the command queue (from Executor)."""
self.command_queue.put((command, args))
def cleanup(self):
self.logger.debug("TestRunnerManager cleanup")
if self.browser:
self.browser.cleanup()
if self.timer:
self.timer.cancel()
while True:
try:
cmd, data = self.command_queue.get_nowait()
except Empty:
break
else:
if cmd == "log":
self.log(*data)
elif cmd == "runner_teardown":
# It's OK for the "runner_teardown" message to be left in
# the queue during cleanup, as we will already have tried
# to stop the TestRunner in `stop_runner`.
pass
else:
self.logger.warning(f"Command left in command_queue during cleanup: {cmd!r}, {data!r}")
while True:
try:
cmd, data = self.remote_queue.get_nowait()
self.logger.warning(f"Command left in remote_queue during cleanup: {cmd!r}, {data!r}")
except Empty:
break
class ManagerGroup:
"""Main thread object that owns all the TestRunnerManager threads."""
def __init__(self, suite_name, test_queue_builder, test_implementations,
retry_index=0,
rerun=1,
pause_after_test=False,
pause_on_unexpected=False,
restart_on_unexpected=True,
debug_info=None,
capture_stdio=True,
restart_on_new_group=True,
recording=None,
max_restarts=5):
self.suite_name = suite_name
self.test_queue_builder = test_queue_builder
self.test_implementations = test_implementations
self.pause_after_test = pause_after_test
self.pause_on_unexpected = pause_on_unexpected
self.restart_on_unexpected = restart_on_unexpected
self.debug_info = debug_info
self.retry_index = retry_index
self.rerun = rerun
self.capture_stdio = capture_stdio
self.restart_on_new_group = restart_on_new_group
self.recording = recording
assert recording is not None
self.max_restarts = max_restarts
self.pool = set()
# Event that is polled by threads so that they can gracefully exit in the face
# of sigint
self.stop_flag = threading.Event()
self.logger = structuredlog.StructuredLogger(suite_name)
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
self.stop()
def run(self, tests):
"""Start all managers in the group"""
test_queue, size = self.test_queue_builder.make_queue(tests)
self.logger.info("Using %i child processes" % size)
for idx in range(size):
manager = TestRunnerManager(self.suite_name,
idx,
test_queue,
self.test_implementations,
self.stop_flag,
self.retry_index,
self.rerun,
self.pause_after_test,
self.pause_on_unexpected,
self.restart_on_unexpected,
self.debug_info,
self.capture_stdio,
self.restart_on_new_group,
recording=self.recording,
max_restarts=self.max_restarts)
manager.start()
self.pool.add(manager)
self.wait()
def wait(self, timeout: Optional[float] = None) -> None:
"""Wait for all the managers in the group to finish.
Arguments:
timeout: Overall timeout (in seconds) for all threads to join. The
default value indicates an indefinite timeout.
"""
deadline = None if timeout is None else time.time() + timeout
for manager in self.pool:
manager_timeout = None
if deadline is not None:
manager_timeout = max(0, deadline - time.time())
manager.join(manager_timeout)
def stop(self):
"""Set the stop flag so that all managers in the group stop as soon
as possible"""
self.stop_flag.set()
self.logger.debug("Stop flag set in ManagerGroup")
def test_count(self):
return sum(manager.test_count for manager in self.pool)
def unexpected_fail_tests(self):
rv = defaultdict(list)
for manager in self.pool:
for (subsuite, test_type), tests in manager.unexpected_fail_tests.items():
rv[(subsuite, test_type)].extend(tests)
return rv
def unexpected_pass_tests(self):
rv = defaultdict(list)
for manager in self.pool:
for (subsuite, test_type), tests in manager.unexpected_pass_tests.items():
rv[(subsuite, test_type)].extend(tests)
return rv
|