forked from flutter/engine
-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathrun_tests.py
executable file
·1395 lines (1193 loc) · 45.6 KB
/
run_tests.py
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
#!/usr/bin/env python3
#
# Copyright 2013 The Flutter Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""
A top level harness to run all unit-tests in a specific engine build.
"""
from pathlib import Path
import argparse
import errno
import glob
import logging
import logging.handlers
import multiprocessing
import os
import re
import shutil
import subprocess
# Explicitly import the parts of sys that are needed. This is to avoid using
# sys.stdout and sys.stderr directly. Instead, only the logger defined below
# should be used for output.
from sys import exit as sys_exit, platform as sys_platform, path as sys_path
import tempfile
import time
import typing
import xvfb
THIS_DIR = os.path.abspath(os.path.dirname(__file__))
sys_path.insert(0, os.path.join(THIS_DIR, '..', 'third_party', 'pyyaml', 'lib'))
import yaml # pylint: disable=import-error, wrong-import-position
SCRIPT_DIR = os.path.dirname(os.path.realpath(__file__))
BUILDROOT_DIR = os.path.abspath(os.path.join(os.path.realpath(__file__), '..', '..', '..'))
OUT_DIR = os.path.join(BUILDROOT_DIR, 'out')
GOLDEN_DIR = os.path.join(BUILDROOT_DIR, 'flutter', 'testing', 'resources')
FONTS_DIR = os.path.join(BUILDROOT_DIR, 'flutter', 'third_party', 'txt', 'third_party', 'fonts')
ROBOTO_FONT_PATH = os.path.join(FONTS_DIR, 'Roboto-Regular.ttf')
FONT_SUBSET_DIR = os.path.join(BUILDROOT_DIR, 'flutter', 'tools', 'font_subset')
ENCODING = 'UTF-8'
LOG_FILE = os.path.join(OUT_DIR, 'run_tests.log')
logger = logging.getLogger(__name__)
console_logger_handler = logging.StreamHandler()
file_logger_handler = logging.FileHandler(LOG_FILE)
# Override print so that it uses the logger instead of stdout directly.
def print(*args, **kwargs): # pylint: disable=redefined-builtin
logger.info(*args, **kwargs)
def print_divider(char='='):
logger.info('\n')
for _ in range(4):
logger.info(''.join([char for _ in range(80)]))
logger.info('\n')
def is_asan(build_dir):
with open(os.path.join(build_dir, 'args.gn')) as args:
if 'is_asan = true' in args.read():
return True
return False
def run_cmd( # pylint: disable=too-many-arguments
cmd: typing.List[str],
cwd: str = None,
forbidden_output: typing.List[str] = None,
expect_failure: bool = False,
env: typing.Dict[str, str] = None,
allowed_failure_output: typing.List[str] = None,
**kwargs
) -> None:
if forbidden_output is None:
forbidden_output = []
if allowed_failure_output is None:
allowed_failure_output = []
command_string = ' '.join(cmd)
print_divider('>')
logger.info('Running command "%s" in "%s"', command_string, cwd)
start_time = time.time()
process = subprocess.Popen(
cmd,
cwd=cwd,
stdout=subprocess.PIPE,
stderr=subprocess.STDOUT,
env=env,
universal_newlines=True,
**kwargs
)
output = ''
for line in iter(process.stdout.readline, ''):
output += line
logger.info(line.rstrip())
process.wait()
end_time = time.time()
if process.returncode != 0 and not expect_failure:
print_divider('!')
logger.error(
'Failed Command:\n\n%s\n\nExit Code: %s\n\nOutput:\n%s', command_string, process.returncode,
output
)
print_divider('!')
allowed_failure = False
for allowed_string in allowed_failure_output:
if allowed_string in output:
allowed_failure = True
if not allowed_failure:
raise RuntimeError(
'Command "%s" (in %s) exited with code %s.' % (command_string, cwd, process.returncode)
)
for forbidden_string in forbidden_output:
if forbidden_string in output:
raise RuntimeError(
'command "%s" contained forbidden string "%s"' % (command_string, forbidden_string)
)
print_divider('<')
logger.info(
'Command run successfully in %.2f seconds: %s (in %s)', end_time - start_time, command_string,
cwd
)
def is_mac():
return sys_platform == 'darwin'
def is_aarm64():
assert is_mac()
output = subprocess.check_output(['sysctl', 'machdep.cpu'])
text = output.decode('utf-8')
aarm64 = text.find('Apple') >= 0
if not aarm64:
assert text.find('GenuineIntel') >= 0
return aarm64
def is_linux():
return sys_platform.startswith('linux')
def is_windows():
return sys_platform.startswith(('cygwin', 'win'))
def executable_suffix():
return '.exe' if is_windows() else ''
def find_executable_path(path):
if os.path.exists(path):
return path
if is_windows():
exe_path = path + '.exe'
if os.path.exists(exe_path):
return exe_path
bat_path = path + '.bat'
if os.path.exists(bat_path):
return bat_path
raise Exception('Executable %s does not exist!' % path)
def vulkan_validation_env(build_dir):
extra_env = {
# pylint: disable=line-too-long
# Note: built from //third_party/swiftshader
'VK_ICD_FILENAMES': os.path.join(build_dir, 'vk_swiftshader_icd.json'),
# Note: built from //third_party/vulkan_validation_layers:vulkan_gen_json_files
# and //third_party/vulkan_validation_layers.
'VK_LAYER_PATH': os.path.join(build_dir, 'vulkan-data'),
'VK_INSTANCE_LAYERS': 'VK_LAYER_KHRONOS_validation',
}
return extra_env
def metal_validation_env():
extra_env = {
# pylint: disable=line-too-long
# See https://developer.apple.com/documentation/metal/diagnosing_metal_programming_issues_early?language=objc
'MTL_SHADER_VALIDATION': '1', # Enables all shader validation tests.
'MTL_SHADER_VALIDATION_GLOBAL_MEMORY':
'1', # Validates accesses to device and constant memory.
'MTL_SHADER_VALIDATION_THREADGROUP_MEMORY': '1', # Validates accesses to threadgroup memory.
'MTL_SHADER_VALIDATION_TEXTURE_USAGE': '1', # Validates that texture references are not nil.
}
if is_aarm64():
extra_env.update({
'METAL_DEBUG_ERROR_MODE': '0', # Enables metal validation.
'METAL_DEVICE_WRAPPER_TYPE': '1', # Enables metal validation.
})
return extra_env
def build_engine_executable_command(
build_dir, executable_name, flags=None, coverage=False, gtest=False
):
if flags is None:
flags = []
unstripped_exe = os.path.join(build_dir, 'exe.unstripped', executable_name)
# We cannot run the unstripped binaries directly when coverage is enabled.
if is_linux() and os.path.exists(unstripped_exe) and not coverage:
# Use unstripped executables in order to get better symbolized crash
# stack traces on Linux.
executable = unstripped_exe
else:
executable = find_executable_path(os.path.join(build_dir, executable_name))
coverage_script = os.path.join(BUILDROOT_DIR, 'flutter', 'build', 'generate_coverage.py')
if coverage:
coverage_flags = [
'-t', executable, '-o',
os.path.join(build_dir, 'coverage', executable_name), '-f', 'html'
]
updated_flags = ['--args=%s' % ' '.join(flags)]
test_command = [coverage_script] + coverage_flags + updated_flags
else:
test_command = [executable] + flags
if gtest:
gtest_parallel = os.path.join(
BUILDROOT_DIR, 'flutter', 'third_party', 'gtest-parallel', 'gtest-parallel'
)
test_command = ['python3', gtest_parallel] + test_command
return test_command
def run_engine_executable( # pylint: disable=too-many-arguments
build_dir,
executable_name,
executable_filter,
flags=None,
cwd=BUILDROOT_DIR,
forbidden_output=None,
allowed_failure_output=None,
expect_failure=False,
coverage=False,
extra_env=None,
gtest=False,
):
if executable_filter is not None and executable_name not in executable_filter:
logger.info('Skipping %s due to filter.', executable_name)
return
if flags is None:
flags = []
if forbidden_output is None:
forbidden_output = []
if allowed_failure_output is None:
allowed_failure_output = []
if extra_env is None:
extra_env = {}
unstripped_exe = os.path.join(build_dir, 'exe.unstripped', executable_name)
env = os.environ.copy()
if is_linux():
env['LD_LIBRARY_PATH'] = build_dir
env['VK_DRIVER_FILES'] = os.path.join(build_dir, 'vk_swiftshader_icd.json')
if os.path.exists(unstripped_exe):
unstripped_vulkan = os.path.join(build_dir, 'lib.unstripped', 'libvulkan.so.1')
if os.path.exists(unstripped_vulkan):
vulkan_path = unstripped_vulkan
else:
vulkan_path = os.path.join(build_dir, 'libvulkan.so.1')
try:
os.symlink(vulkan_path, os.path.join(build_dir, 'exe.unstripped', 'libvulkan.so.1'))
except OSError as err:
if err.errno == errno.EEXIST:
pass
else:
raise
elif is_mac():
env['DYLD_LIBRARY_PATH'] = build_dir
else:
env['PATH'] = build_dir + ':' + env['PATH']
logger.info('Running %s in %s', executable_name, cwd)
test_command = build_engine_executable_command(
build_dir,
executable_name,
flags=flags,
coverage=coverage,
gtest=gtest,
)
env['FLUTTER_BUILD_DIRECTORY'] = build_dir
for key, value in extra_env.items():
env[key] = value
try:
run_cmd(
test_command,
cwd=cwd,
forbidden_output=forbidden_output,
expect_failure=expect_failure,
env=env,
allowed_failure_output=allowed_failure_output,
)
except:
# The LUCI environment may provide a variable containing a directory path
# for additional output files that will be uploaded to cloud storage.
# If the command generated a core dump, then run a script to analyze
# the dump and output a report that will be uploaded.
luci_test_outputs_path = os.environ.get('FLUTTER_TEST_OUTPUTS_DIR')
core_path = os.path.join(cwd, 'core')
if luci_test_outputs_path and os.path.exists(core_path) and os.path.exists(unstripped_exe):
dump_path = os.path.join(
luci_test_outputs_path, '%s_%s.txt' % (executable_name, sys_platform)
)
logger.error('Writing core dump analysis to %s', dump_path)
subprocess.call([
os.path.join(BUILDROOT_DIR, 'flutter', 'testing', 'analyze_core_dump.sh'),
BUILDROOT_DIR,
unstripped_exe,
core_path,
dump_path,
])
os.unlink(core_path)
raise
class EngineExecutableTask(): # pylint: disable=too-many-instance-attributes
def __init__( # pylint: disable=too-many-arguments
self,
build_dir,
executable_name,
executable_filter,
flags=None,
cwd=BUILDROOT_DIR,
forbidden_output=None,
allowed_failure_output=None,
expect_failure=False,
coverage=False,
extra_env=None,
):
self.build_dir = build_dir
self.executable_name = executable_name
self.executable_filter = executable_filter
self.flags = flags
self.cwd = cwd
self.forbidden_output = forbidden_output
self.allowed_failure_output = allowed_failure_output
self.expect_failure = expect_failure
self.coverage = coverage
self.extra_env = extra_env
def __call__(self, *args):
run_engine_executable(
self.build_dir,
self.executable_name,
self.executable_filter,
flags=self.flags,
cwd=self.cwd,
forbidden_output=self.forbidden_output,
allowed_failure_output=self.allowed_failure_output,
expect_failure=self.expect_failure,
coverage=self.coverage,
extra_env=self.extra_env,
)
def __str__(self):
command = build_engine_executable_command(
self.build_dir, self.executable_name, flags=self.flags, coverage=self.coverage
)
return ' '.join(command)
shuffle_flags = [
'--gtest_repeat=2',
'--gtest_shuffle',
]
repeat_flags = [
'--repeat=2',
]
def run_cc_tests(build_dir, executable_filter, coverage, capture_core_dump):
logger.info('Running Engine Unit-tests.')
if capture_core_dump and is_linux():
import resource # pylint: disable=import-outside-toplevel
resource.setrlimit(resource.RLIMIT_CORE, (resource.RLIM_INFINITY, resource.RLIM_INFINITY))
def make_test(name, flags=None, extra_env=None):
if flags is None:
flags = repeat_flags
if extra_env is None:
extra_env = {}
return (name, flags, extra_env)
unittests = [
make_test('client_wrapper_glfw_unittests'),
make_test('client_wrapper_unittests'),
make_test('common_cpp_core_unittests'),
make_test('common_cpp_unittests'),
make_test('dart_plugin_registrant_unittests'),
make_test('display_list_rendertests'),
make_test('display_list_unittests'),
make_test('embedder_a11y_unittests'),
make_test('embedder_proctable_unittests'),
make_test('embedder_unittests'),
make_test('fml_unittests'),
make_test('fml_arc_unittests'),
make_test('no_dart_plugin_registrant_unittests'),
make_test('runtime_unittests'),
make_test('testing_unittests'),
make_test('tonic_unittests'),
# The image release unit test can take a while on slow machines.
make_test('ui_unittests', flags=repeat_flags + ['--timeout=90']),
]
if not is_windows():
unittests += [
# https://github.com/google/googletest/issues/2490
make_test('android_external_view_embedder_unittests'),
make_test('jni_unittests'),
make_test('platform_view_android_delegate_unittests'),
# https://github.com/flutter/flutter/issues/36295
make_test('shell_unittests'),
]
if is_windows():
unittests += [
# The accessibility library only supports Mac and Windows.
make_test('accessibility_unittests'),
make_test('client_wrapper_windows_unittests'),
make_test('flutter_windows_unittests'),
]
# These unit-tests are Objective-C and can only run on Darwin.
if is_mac():
unittests += [
# The accessibility library only supports Mac and Windows.
make_test('accessibility_unittests'),
make_test('availability_version_check_unittests'),
make_test('framework_common_unittests'),
make_test('spring_animation_unittests'),
make_test('gpu_surface_metal_unittests'),
]
if is_linux():
flow_flags = [
'--golden-dir=%s' % GOLDEN_DIR,
'--font-file=%s' % ROBOTO_FONT_PATH,
]
icu_flags = ['--icu-data-file-path=%s' % os.path.join(build_dir, 'icudtl.dat')]
unittests += [
make_test('flow_unittests', flags=repeat_flags + ['--'] + flow_flags),
make_test('flutter_glfw_unittests'),
make_test('flutter_linux_unittests', extra_env={'G_DEBUG': 'fatal-criticals'}),
# https://github.com/flutter/flutter/issues/36296
make_test('txt_unittests', flags=repeat_flags + ['--'] + icu_flags),
]
else:
flow_flags = ['--gtest_filter=-PerformanceOverlayLayer.Gold']
unittests += [
make_test('flow_unittests', flags=repeat_flags + flow_flags),
]
build_name = os.path.basename(build_dir)
try:
if is_linux():
xvfb.start_virtual_x(build_name, build_dir)
for test, flags, extra_env in unittests:
run_engine_executable(
build_dir,
test,
executable_filter,
flags,
coverage=coverage,
extra_env=extra_env,
gtest=True
)
finally:
if is_linux():
xvfb.stop_virtual_x(build_name)
if is_mac():
# flutter_desktop_darwin_unittests uses global state that isn't handled
# correctly by gtest-parallel.
# https://github.com/flutter/flutter/issues/104789
if not os.path.basename(build_dir).startswith('host_debug'):
# Test is disabled for flaking in debug runs:
# https://github.com/flutter/flutter/issues/127441
run_engine_executable(
build_dir,
'flutter_desktop_darwin_unittests',
executable_filter,
shuffle_flags,
coverage=coverage
)
extra_env = metal_validation_env()
extra_env.update(vulkan_validation_env(build_dir))
mac_impeller_unittests_flags = repeat_flags + [
'--gtest_filter=-*OpenGLES', # These are covered in the golden tests.
'--',
'--enable_vulkan_validation',
]
# Impeller tests are only supported on macOS for now.
run_engine_executable(
build_dir,
'impeller_unittests',
executable_filter,
mac_impeller_unittests_flags,
coverage=coverage,
extra_env=extra_env,
gtest=True,
# TODO(https://github.com/flutter/flutter/issues/123733): Remove this allowlist.
# See also https://github.com/flutter/flutter/issues/114872.
allowed_failure_output=[
'[MTLCompiler createVertexStageAndLinkPipelineWithFragment:',
'[MTLCompiler pipelineStateWithVariant:',
]
)
# Run one interactive Vulkan test with validation enabled.
#
# TODO(matanlurey): https://github.com/flutter/flutter/issues/134852; enable
# more of the suite, and ideally we'd like to use Skia gold and take screen
# shots as well.
run_engine_executable(
build_dir,
'impeller_unittests',
executable_filter,
shuffle_flags + [
'--enable_vulkan_validation',
'--enable_playground',
'--playground_timeout_ms=4000',
'--gtest_filter="*ColorWheel/Vulkan"',
],
coverage=coverage,
extra_env=extra_env,
)
# Run the Flutter GPU test suite.
run_engine_executable(
build_dir,
'impeller_dart_unittests',
executable_filter,
shuffle_flags + [
'--enable_vulkan_validation',
# TODO(https://github.com/flutter/flutter/issues/145036)
# TODO(https://github.com/flutter/flutter/issues/142642)
'--gtest_filter=*Metal',
],
coverage=coverage,
extra_env=extra_env,
)
def run_engine_benchmarks(build_dir, executable_filter):
logger.info('Running Engine Benchmarks.')
icu_flags = ['--icu-data-file-path=%s' % os.path.join(build_dir, 'icudtl.dat')]
run_engine_executable(build_dir, 'shell_benchmarks', executable_filter, icu_flags)
run_engine_executable(build_dir, 'fml_benchmarks', executable_filter, icu_flags)
run_engine_executable(build_dir, 'ui_benchmarks', executable_filter, icu_flags)
run_engine_executable(build_dir, 'display_list_builder_benchmarks', executable_filter, icu_flags)
run_engine_executable(build_dir, 'geometry_benchmarks', executable_filter, icu_flags)
if is_linux():
run_engine_executable(build_dir, 'txt_benchmarks', executable_filter, icu_flags)
class FlutterTesterOptions():
def __init__(
self,
multithreaded=False,
enable_impeller=False,
enable_observatory=False,
expect_failure=False
):
self.multithreaded = multithreaded
self.enable_impeller = enable_impeller
self.enable_observatory = enable_observatory
self.expect_failure = expect_failure
def apply_args(self, command_args):
if not self.enable_observatory:
command_args.append('--disable-observatory')
if self.enable_impeller:
command_args += ['--enable-impeller']
else:
command_args += ['--no-enable-impeller']
if self.multithreaded:
command_args.insert(0, '--force-multithreading')
def threading_description(self):
if self.multithreaded:
return 'multithreaded'
return 'single-threaded'
def impeller_enabled(self):
if self.enable_impeller:
return 'impeller swiftshader'
return 'skia software'
def gather_dart_test(build_dir, dart_file, options):
kernel_file_name = os.path.basename(dart_file) + '.dill'
kernel_file_output = os.path.join(build_dir, 'gen', kernel_file_name)
error_message = "%s doesn't exist. Please run the build that populates %s" % (
kernel_file_output, build_dir
)
assert os.path.isfile(kernel_file_output), error_message
command_args = []
options.apply_args(command_args)
dart_file_contents = open(dart_file, 'r')
custom_options = re.findall('// FlutterTesterOptions=(.*)', dart_file_contents.read())
dart_file_contents.close()
command_args.extend(custom_options)
command_args += [
'--use-test-fonts',
'--icu-data-file-path=%s' % os.path.join(build_dir, 'icudtl.dat'),
'--flutter-assets-dir=%s' % os.path.join(build_dir, 'gen', 'flutter', 'lib', 'ui', 'assets'),
'--disable-asset-fonts',
kernel_file_output,
]
tester_name = 'flutter_tester'
logger.info(
"Running test '%s' using '%s' (%s, %s)", kernel_file_name, tester_name,
options.threading_description(), options.impeller_enabled()
)
forbidden_output = [] if 'unopt' in build_dir or options.expect_failure else ['[ERROR']
return EngineExecutableTask(
build_dir,
tester_name,
None,
command_args,
forbidden_output=forbidden_output,
expect_failure=options.expect_failure,
)
def ensure_ios_tests_are_built(ios_out_dir):
"""Builds the engine variant and the test dylib containing the XCTests"""
tmp_out_dir = os.path.join(OUT_DIR, ios_out_dir)
ios_test_lib = os.path.join(tmp_out_dir, 'libios_test_flutter.dylib')
message = []
message.append('gn --ios --unoptimized --runtime-mode=debug --no-lto --simulator')
message.append('ninja -C %s ios_test_flutter' % ios_out_dir)
final_message = "%s or %s doesn't exist. Please run the following commands: \n%s" % (
ios_out_dir, ios_test_lib, '\n'.join(message)
)
assert os.path.exists(tmp_out_dir) and os.path.exists(ios_test_lib), final_message
def assert_expected_xcode_version():
"""Checks that the user has a version of Xcode installed"""
version_output = subprocess.check_output(['xcodebuild', '-version'])
# TODO ricardoamador: remove this check when python 2 is deprecated.
version_output = version_output if isinstance(version_output,
str) else version_output.decode(ENCODING)
version_output = version_output.strip()
match = re.match(r'Xcode (\d+)', version_output)
message = 'Xcode must be installed to run the iOS embedding unit tests'
assert match, message
def java_home():
script_path = os.path.dirname(os.path.realpath(__file__))
if is_mac():
return os.path.join(script_path, '..', 'third_party', 'java', 'openjdk', 'Contents', 'Home')
return os.path.join(script_path, '..', 'third_party', 'java', 'openjdk')
def java_bin():
return os.path.join(java_home(), 'bin', 'java.exe' if is_windows() else 'java')
def run_java_tests(executable_filter, android_variant='android_debug_unopt'):
"""Runs the Java JUnit unit tests for the Android embedding"""
test_runner_dir = os.path.join(
BUILDROOT_DIR, 'flutter', 'shell', 'platform', 'android', 'test_runner'
)
gradle_bin = os.path.join(
BUILDROOT_DIR, 'flutter', 'third_party', 'gradle', 'bin',
'gradle.bat' if is_windows() else 'gradle'
)
flutter_jar = os.path.join(OUT_DIR, android_variant, 'flutter.jar')
android_home = os.path.join(BUILDROOT_DIR, 'flutter', 'third_party', 'android_tools', 'sdk')
build_dir = os.path.join(OUT_DIR, android_variant, 'robolectric_tests', 'build')
gradle_cache_dir = os.path.join(OUT_DIR, android_variant, 'robolectric_tests', '.gradle')
test_class = executable_filter if executable_filter else '*'
command = [
gradle_bin,
'-Pflutter_jar=%s' % flutter_jar,
'-Pbuild_dir=%s' % build_dir,
'testDebugUnitTest',
'--tests=%s' % test_class,
'--rerun-tasks',
'--no-daemon',
'--project-cache-dir=%s' % gradle_cache_dir,
'--gradle-user-home=%s' % gradle_cache_dir,
]
env = dict(os.environ, ANDROID_HOME=android_home, JAVA_HOME=java_home())
run_cmd(command, cwd=test_runner_dir, env=env)
def run_android_unittest(test_runner_name, android_variant, adb_path):
tests_path = os.path.join(OUT_DIR, android_variant, test_runner_name)
remote_path = '/data/local/tmp'
remote_tests_path = os.path.join(remote_path, test_runner_name)
run_cmd([adb_path, 'push', tests_path, remote_path], cwd=BUILDROOT_DIR)
try:
run_cmd([adb_path, 'shell', remote_tests_path])
except:
luci_test_outputs_path = os.environ.get('FLUTTER_TEST_OUTPUTS_DIR')
if luci_test_outputs_path:
print('>>>>> Test %s failed. Capturing logcat.' % test_runner_name)
logcat_path = os.path.join(luci_test_outputs_path, '%s_logcat' % test_runner_name)
logcat_file = open(logcat_path, 'w')
subprocess.run([adb_path, 'logcat', '-d'], stdout=logcat_file, check=False)
raise
def run_android_tests(android_variant='android_debug_unopt', adb_path=None):
if adb_path is None:
adb_path = 'adb'
run_android_unittest('flutter_shell_native_unittests', android_variant, adb_path)
run_android_unittest('impeller_toolkit_android_unittests', android_variant, adb_path)
systrace_test = os.path.join(BUILDROOT_DIR, 'flutter', 'testing', 'android_systrace_test.py')
scenario_apk = os.path.join(OUT_DIR, android_variant, 'firebase_apks', 'scenario_app.apk')
run_cmd([
systrace_test, '--adb-path', adb_path, '--apk-path', scenario_apk, '--package-name',
'dev.flutter.scenarios', '--activity-name', '.PlatformViewsActivity'
])
def run_objc_tests(ios_variant='ios_debug_sim_unopt', test_filter=None):
"""Runs Objective-C XCTest unit tests for the iOS embedding"""
assert_expected_xcode_version()
ios_out_dir = os.path.join(OUT_DIR, ios_variant)
ensure_ios_tests_are_built(ios_out_dir)
new_simulator_name = 'IosUnitTestsSimulator'
# Delete simulators with this name in case any were leaked
# from another test run.
delete_simulator(new_simulator_name)
create_simulator = [
'xcrun '
'simctl '
'create '
'%s com.apple.CoreSimulator.SimDeviceType.iPhone-11' % new_simulator_name
]
run_cmd(create_simulator, shell=True)
try:
ios_unit_test_dir = os.path.join(BUILDROOT_DIR, 'flutter', 'testing', 'ios', 'IosUnitTests')
with tempfile.TemporaryDirectory(suffix='ios_embedding_xcresult') as result_bundle_temp:
result_bundle_path = os.path.join(result_bundle_temp, 'ios_embedding')
# Avoid using xcpretty unless the following can be addressed:
# - Make sure all relevant failure output is printed on a failure.
# - Make sure that a failing exit code is set for CI.
# See https://github.com/flutter/flutter/issues/63742
test_command = [
'xcodebuild '
'-sdk iphonesimulator '
'-scheme IosUnitTests '
'-resultBundlePath ' + result_bundle_path + ' '
'-destination name=' + new_simulator_name + ' '
'test '
'FLUTTER_ENGINE=' + ios_variant
]
if test_filter is not None:
test_command[0] = test_command[0] + ' -only-testing:%s' % test_filter
try:
run_cmd(test_command, cwd=ios_unit_test_dir, shell=True)
except:
# The LUCI environment may provide a variable containing a directory path
# for additional output files that will be uploaded to cloud storage.
# Upload the xcresult when the tests fail.
luci_test_outputs_path = os.environ.get('FLUTTER_TEST_OUTPUTS_DIR')
xcresult_bundle = os.path.join(result_bundle_temp, 'ios_embedding.xcresult')
if luci_test_outputs_path and os.path.exists(xcresult_bundle):
dump_path = os.path.join(luci_test_outputs_path, 'ios_embedding.xcresult')
# xcresults contain many little files. Archive the bundle before upload.
shutil.make_archive(dump_path, 'zip', root_dir=xcresult_bundle)
raise
finally:
delete_simulator(new_simulator_name)
def delete_simulator(simulator_name):
# Will delete all simulators with this name.
command = [
'xcrun',
'simctl',
'delete',
simulator_name,
]
# Let this fail if the simulator was never created.
run_cmd(command, expect_failure=True)
def gather_dart_tests(build_dir, test_filter):
dart_tests_dir = os.path.join(
BUILDROOT_DIR,
'flutter',
'testing',
'dart',
)
# Now that we have the Sky packages at the hardcoded location, run `dart pub get`.
run_engine_executable(
build_dir,
os.path.join('dart-sdk', 'bin', 'dart'),
None,
flags=['pub', '--suppress-analytics', 'get', '--offline'],
cwd=dart_tests_dir,
)
dart_observatory_tests = glob.glob('%s/observatory/*_test.dart' % dart_tests_dir)
dart_tests = glob.glob('%s/*_test.dart' % dart_tests_dir)
if 'release' not in build_dir:
for dart_test_file in dart_observatory_tests:
if test_filter is not None and os.path.basename(dart_test_file) not in test_filter:
logger.info("Skipping '%s' due to filter.", dart_test_file)
else:
logger.info("Gathering dart test '%s' with observatory enabled", dart_test_file)
for multithreaded in [False, True]:
for enable_impeller in [False, True]:
yield gather_dart_test(
build_dir, dart_test_file,
FlutterTesterOptions(
multithreaded=multithreaded,
enable_impeller=enable_impeller,
enable_observatory=True
)
)
for dart_test_file in dart_tests:
if test_filter is not None and os.path.basename(dart_test_file) not in test_filter:
logger.info("Skipping '%s' due to filter.", dart_test_file)
else:
logger.info("Gathering dart test '%s'", dart_test_file)
for multithreaded in [False, True]:
for enable_impeller in [False, True]:
yield gather_dart_test(
build_dir, dart_test_file,
FlutterTesterOptions(multithreaded=multithreaded, enable_impeller=enable_impeller)
)
def gather_dart_smoke_test(build_dir, test_filter):
smoke_test = os.path.join(
BUILDROOT_DIR,
'flutter',
'testing',
'smoke_test_failure',
'fail_test.dart',
)
if test_filter is not None and os.path.basename(smoke_test) not in test_filter:
logger.info("Skipping '%s' due to filter.", smoke_test)
else:
yield gather_dart_test(
build_dir, smoke_test, FlutterTesterOptions(multithreaded=True, expect_failure=True)
)
yield gather_dart_test(
build_dir, smoke_test, FlutterTesterOptions(multithreaded=False, expect_failure=True)
)
def gather_dart_package_tests(build_dir, package_path):
if uses_package_test_runner(package_path):
opts = ['test', '--reporter=expanded']
yield EngineExecutableTask(
build_dir,
os.path.join('dart-sdk', 'bin', 'dart'),
None,
flags=opts,
cwd=package_path,
)
else:
dart_tests = glob.glob('%s/test/*_test.dart' % package_path)
if not dart_tests:
raise Exception('No tests found for Dart package at %s' % package_path)
for dart_test_file in dart_tests:
opts = [dart_test_file]
yield EngineExecutableTask(
build_dir, os.path.join('dart-sdk', 'bin', 'dart'), None, flags=opts, cwd=package_path
)
# Returns whether the given package path should be tested with `dart test`.
#
# Inferred by a dependency on the `package:test` package in the pubspec.yaml.
def uses_package_test_runner(package):
pubspec = os.path.join(package, 'pubspec.yaml')
if not os.path.exists(pubspec):
return False
with open(pubspec, 'r') as file:
# Check if either "dependencies" or "dev_dependencies" contains "test".
data = yaml.safe_load(file)
if data is None:
return False
deps = data.get('dependencies', {})
if 'test' in deps:
return True
dev_deps = data.get('dev_dependencies', {})
if 'test' in dev_deps:
return True
return False
# Returns a list of Dart packages to test.
#
# The first element of each tuple in the returned list is the path to the Dart
# package to test. It is assumed that the packages follow the convention that
# tests are named as '*_test.dart', and reside under a directory called 'test'.
#
# The second element of each tuple is a list of additional command line
# arguments to pass to each of the packages tests.
def build_dart_host_test_list(build_dir):
dart_host_tests = [
os.path.join('flutter', 'ci'),
os.path.join('flutter', 'flutter_frontend_server'),
os.path.join('flutter', 'testing', 'skia_gold_client'),
os.path.join('flutter', 'testing', 'scenario_app'),
os.path.join('flutter', 'tools', 'api_check'),
os.path.join('flutter', 'tools', 'build_bucket_golden_scraper'),
os.path.join('flutter', 'tools', 'clang_tidy'),
os.path.join('flutter', 'tools', 'const_finder'),
os.path.join('flutter', 'tools', 'dir_contents_diff'),
os.path.join('flutter', 'tools', 'engine_tool'),
os.path.join('flutter', 'tools', 'githooks'),
os.path.join('flutter', 'tools', 'header_guard_check'),
os.path.join('flutter', 'tools', 'pkg', 'engine_build_configs'),
os.path.join('flutter', 'tools', 'pkg', 'engine_repo_tools'),
os.path.join('flutter', 'tools', 'pkg', 'git_repo_tools'),
]
if not is_asan(build_dir):
dart_host_tests += [os.path.join('flutter', 'tools', 'path_ops', 'dart')]
return dart_host_tests
def run_benchmark_tests(build_dir):
test_dir = os.path.join(BUILDROOT_DIR, 'flutter', 'testing', 'benchmark')
dart_tests = glob.glob('%s/test/*_test.dart' % test_dir)
for dart_test_file in dart_tests:
opts = [dart_test_file]
run_engine_executable(
build_dir, os.path.join('dart-sdk', 'bin', 'dart'), None, flags=opts, cwd=test_dir
)
def worker_init(queue, level):