Merge pull request #12092 from wtgodbe/CoreDisTools
[platform/upstream/coreclr.git] / tests / runtest.sh
1 #!/usr/bin/env bash
2
3 function print_usage {
4     echo ''
5     echo 'CoreCLR test runner script.'
6     echo ''
7     echo 'Typical command line:'
8     echo ''
9     echo 'coreclr/tests/runtest.sh'
10     echo '    --testRootDir="temp/Windows_NT.x64.Debug"'
11     echo '    --testNativeBinDir="coreclr/bin/obj/Linux.x64.Debug/tests"'
12     echo '    --coreClrBinDir="coreclr/bin/Product/Linux.x64.Debug"'
13     echo '    --mscorlibDir="windows/coreclr/bin/Product/Linux.x64.Debug"'
14     echo '    --coreFxBinDir="corefx/bin/runtime/netcoreapp-Linux-Debug-x64'
15     echo ''
16     echo 'Required arguments:'
17     echo '  --testRootDir=<path>             : Root directory of the test build (e.g. coreclr/bin/tests/Windows_NT.x64.Debug).'
18     echo '  --testNativeBinDir=<path>        : Directory of the native CoreCLR test build (e.g. coreclr/bin/obj/Linux.x64.Debug/tests).'
19     echo '  (Also required: Either --coreOverlayDir, or all of the switches --coreOverlayDir overrides)'
20     echo ''
21     echo 'Optional arguments:'
22     echo '  --coreOverlayDir=<path>          : Directory containing core binaries and test dependencies. If not specified, the'
23     echo '                                     default is testRootDir/Tests/coreoverlay. This switch overrides --coreClrBinDir,'
24     echo '                                     --mscorlibDir, and --coreFxBinDir.'
25     echo '  --coreClrBinDir=<path>           : Directory of the CoreCLR build (e.g. coreclr/bin/Product/Linux.x64.Debug).'
26     echo '  --mscorlibDir=<path>             : Directory containing the built mscorlib.dll. If not specified, it is expected to be'
27     echo '                                       in the directory specified by --coreClrBinDir.'
28     echo '  --coreFxBinDir="<path>"          : Directory with CoreFX build outputs'
29     echo '                                     (e.g. "corefx/bin/runtime/netcoreapp-Linux-Debug-x64")'
30     echo '                                     If files with the same name are present in multiple directories, the first one wins.'
31     echo '  --testDir=<path>                 : Run tests only in the specified directory. The path is relative to the directory'
32     echo '                                     specified by --testRootDir. Multiple of this switch may be specified.'
33     echo '  --testDirFile=<path>             : Run tests only in the directories specified by the file at <path>. Paths are listed'
34     echo '                                     one line, relative to the directory specified by --testRootDir.'
35     echo '  --build-overlay-only             : Build coreoverlay only, and skip running tests.'
36     echo '  --runFailingTestsOnly            : Run only the tests that are disabled on this platform due to unexpected failures.'
37     echo '                                     Failing tests are listed in coreclr/tests/failingTestsOutsideWindows.txt, one per'
38     echo '                                     line, as paths to .sh files relative to the directory specified by --testRootDir.'
39     echo '  --disableEventLogging            : Disable the events logged by both VM and Managed Code'
40     echo '  --sequential                     : Run tests sequentially (default is to run in parallel).'
41     echo '  --playlist=<path>                : Run only the tests that are specified in the file at <path>, in the same format as'
42     echo '                                     runFailingTestsOnly'
43     echo '  -v, --verbose                    : Show output from each test.'
44     echo '  -h|--help                        : Show usage information.'
45     echo '  --useServerGC                    : Enable server GC for this test run'
46     echo '  --test-env                       : Script to set environment variables for tests'
47     echo '  --crossgen                       : Precompiles the framework managed assemblies'
48     echo '  --runcrossgentests               : Runs the ready to run tests' 
49     echo '  --jitstress=<n>                  : Runs the tests with COMPlus_JitStress=n'
50     echo '  --jitstressregs=<n>              : Runs the tests with COMPlus_JitStressRegs=n'
51     echo '  --jitminopts                     : Runs the tests with COMPlus_JITMinOpts=1'
52     echo '  --jitforcerelocs                 : Runs the tests with COMPlus_ForceRelocs=1'
53     echo '  --jitdisasm                      : Runs jit-dasm on the tests'
54     echo '  --gcstresslevel=<n>              : Runs the tests with COMPlus_GCStress=n'
55     echo '  --ilasmroundtrip                 : Runs ilasm round trip on the tests'
56     echo '    0: None                                1: GC on all allocs and '"'easy'"' places'
57     echo '    2: GC on transitions to preemptive GC  4: GC on every allowable JITed instr'
58     echo '    8: GC on every allowable NGEN instr   16: GC only on a unique stack trace'
59     echo '  --long-gc                        : Runs the long GC tests'
60     echo '  --gcsimulator                    : Runs the GCSimulator tests'
61     echo '  --link <ILlink>                  : Runs the tests after linking via ILlink'
62     echo '  --show-time                      : Print execution sequence and running time for each test'
63     echo '  --no-lf-conversion               : Do not execute LF conversion before running test script'
64     echo '  --build-overlay-only             : Exit after overlay directory is populated'
65     echo '  --limitedDumpGeneration          : Enables the generation of a limited number of core dumps if test(s) crash, even if ulimit'
66     echo '                                     is zero when launching this script. This option is intended for use in CI.'
67     echo '  --xunitOutputPath=<path>         : Create xUnit XML report at the specifed path (default: <test root>/coreclrtests.xml)'
68     echo ''
69     echo 'Runtime Code Coverage options:'
70     echo '  --coreclr-coverage               : Optional argument to get coreclr code coverage reports'
71     echo '  --coreclr-objs=<path>            : Location of root of the object directory'
72     echo '                                     containing the linux/mac coreclr build'
73     echo '  --coreclr-src=<path>             : Location of root of the directory'
74     echo '                                     containing the coreclr source files'
75     echo '  --coverage-output-dir=<path>     : Directory where coverage output will be written to'
76     echo ''
77 }
78
79 function print_results {
80     echo ""
81     echo "======================="
82     echo "     Test Results"
83     echo "======================="
84     echo "# CoreCLR Bin Dir  : $coreClrBinDir"
85     echo "# Tests Discovered : $countTotalTests"
86     echo "# Passed           : $countPassedTests"
87     echo "# Failed           : $countFailedTests"
88     echo "# Skipped          : $countSkippedTests"
89     echo "======================="
90 }
91
92 # Initialize counters for bookkeeping.
93 countTotalTests=0
94 countPassedTests=0
95 countFailedTests=0
96 countSkippedTests=0
97
98 # Variables for xUnit-style XML output. XML format: https://xunit.github.io/docs/format-xml-v2.html
99 xunitOutputPath=
100 xunitTestOutputPath=
101
102 # libExtension determines extension for dynamic library files
103 # runtimeName determines where CoreFX Runtime files will be located
104 OSName=$(uname -s)
105 libExtension=
106 case $OSName in
107     Darwin)
108         libExtension="dylib"
109         ;;
110
111     Linux)
112         libExtension="so"
113         ;;
114
115     NetBSD)
116         libExtension="so"
117         ;;
118
119     *)
120         echo "Unsupported OS $OSName detected, configuring as if for Linux"
121         libExtension="so"
122         ;;
123 esac
124
125 function xunit_output_begin {
126     xunitOutputPath=$testRootDir/coreclrtests.xml
127     xunitTestOutputPath=${xunitOutputPath}.test
128     if [ -e "$xunitOutputPath" ]; then
129         rm -f -r "$xunitOutputPath"
130     fi
131     if [ -e "$xunitTestOutputPath" ]; then
132         rm -f -r "$xunitTestOutputPath"
133     fi
134 }
135
136 function xunit_output_add_test {
137     # <assemblies>
138     #   <assembly>
139     #     <collection>
140     #       <test .../> <!-- Write this element here -->
141
142     local scriptFilePath=$1
143     local outputFilePath=$2
144     local testResult=$3 # Pass, Fail, or Skip
145     local testScriptExitCode=$4
146
147     local testPath=${scriptFilePath%.sh} # Remove trailing ".sh"
148     local testDir=$(dirname "$testPath")
149     local testName=$(basename "$testPath")
150
151     # Replace '/' with '.'
152     testPath=$(echo "$testPath" | tr / .)
153     testDir=$(echo "$testDir" | tr / .)
154
155     local line
156
157     line="      "
158     line="${line}<test"
159     line="${line} name=\"${testPath}\""
160     line="${line} type=\"${testDir}\""
161     line="${line} method=\"${testName}\""
162     line="${line} result=\"${testResult}\""
163
164     if [ "$testResult" == "Pass" ]; then
165         line="${line}/>"
166         echo "$line" >>"$xunitTestOutputPath"
167         return
168     fi
169
170     line="${line}>"
171     echo "$line" >>"$xunitTestOutputPath"
172
173     line="        "
174     if [ "$testResult" == "Skip" ]; then
175         line="${line}<reason><![CDATA[$(cat "$outputFilePath")]]></reason>"
176         echo "$line" >>"$xunitTestOutputPath"
177     else
178         line="${line}<failure exception-type=\"Exit code: ${testScriptExitCode}\">"
179         echo "$line" >>"$xunitTestOutputPath"
180
181         line="          "
182         line="${line}<message>"
183         echo "$line" >>"$xunitTestOutputPath"
184         line="            "
185         line="${line}<![CDATA["
186         echo "$line" >>"$xunitTestOutputPath"
187         cat "$outputFilePath" >>"$xunitTestOutputPath"
188         line="            "
189         line="${line}]]>"
190         echo "$line" >>"$xunitTestOutputPath"
191         line="          "
192         line="${line}</message>"
193         echo "$line" >>"$xunitTestOutputPath"
194
195         line="        "
196         line="${line}</failure>"
197         echo "$line" >>"$xunitTestOutputPath"
198     fi
199
200     line="      "
201     line="${line}</test>"
202     echo "$line" >>"$xunitTestOutputPath"
203 }
204
205 function xunit_output_end {
206     local errorSource=$1
207     local errorMessage=$2
208
209     local errorCount
210     if [ -z "$errorSource" ]; then
211         ((errorCount = 0))
212     else
213         ((errorCount = 1))
214     fi
215
216     echo '<?xml version="1.0" encoding="utf-8"?>' >>"$xunitOutputPath"
217     echo '<assemblies>' >>"$xunitOutputPath"
218
219     local line
220
221     # <assembly ...>
222     line="  "
223     line="${line}<assembly"
224     line="${line} name=\"CoreClrTestAssembly\""
225     line="${line} total=\"${countTotalTests}\""
226     line="${line} passed=\"${countPassedTests}\""
227     line="${line} failed=\"${countFailedTests}\""
228     line="${line} skipped=\"${countSkippedTests}\""
229     line="${line} errors=\"${errorCount}\""
230     line="${line}>"
231     echo "$line" >>"$xunitOutputPath"
232
233     # <collection ...>
234     line="    "
235     line="${line}<collection"
236     line="${line} name=\"CoreClrTestCollection\""
237     line="${line} total=\"${countTotalTests}\""
238     line="${line} passed=\"${countPassedTests}\""
239     line="${line} failed=\"${countFailedTests}\""
240     line="${line} skipped=\"${countSkippedTests}\""
241     line="${line}>"
242     echo "$line" >>"$xunitOutputPath"
243
244     # <test .../> <test .../> ...
245     if [ -f "$xunitTestOutputPath" ]; then
246         cat "$xunitTestOutputPath" >>"$xunitOutputPath"
247         rm -f "$xunitTestOutputPath"
248     fi
249
250     # </collection>
251     line="    "
252     line="${line}</collection>"
253     echo "$line" >>"$xunitOutputPath"
254
255     if [ -n "$errorSource" ]; then
256         # <errors>
257         line="    "
258         line="${line}<errors>"
259         echo "$line" >>"$xunitOutputPath"
260
261         # <error ...>
262         line="      "
263         line="${line}<error"
264         line="${line} type=\"TestHarnessError\""
265         line="${line} name=\"${errorSource}\""
266         line="${line}>"
267         echo "$line" >>"$xunitOutputPath"
268
269         # <failure .../>
270         line="        "
271         line="${line}<failure>${errorMessage}</failure>"
272         echo "$line" >>"$xunitOutputPath"
273
274         # </error>
275         line="      "
276         line="${line}</error>"
277         echo "$line" >>"$xunitOutputPath"
278
279         # </errors>
280         line="    "
281         line="${line}</errors>"
282         echo "$line" >>"$xunitOutputPath"
283     fi
284
285     # </assembly>
286     line="  "
287     line="${line}</assembly>"
288     echo "$line" >>"$xunitOutputPath"
289
290     # </assemblies>
291     echo '</assemblies>' >>"$xunitOutputPath"
292 }
293
294 function exit_with_error {
295     local errorSource=$1
296     local errorMessage=$2
297     local printUsage=$3
298
299     if [ -z "$printUsage" ]; then
300         ((printUsage = 0))
301     fi
302
303     echo "$errorMessage"
304     xunit_output_end "$errorSource" "$errorMessage"
305     if ((printUsage != 0)); then
306         print_usage
307     fi
308     exit $EXIT_CODE_EXCEPTION
309 }
310
311 # Handle Ctrl-C. We will stop execution and print the results that
312 # we gathered so far.
313 function handle_ctrl_c {
314     local errorSource='handle_ctrl_c'
315
316     echo ""
317     echo "*** Stopping... ***"
318     print_results
319     exit_with_error "$errorSource" "Test run aborted by Ctrl+C."
320 }
321
322 # Register the Ctrl-C handler
323 trap handle_ctrl_c INT
324
325 function create_core_overlay {
326     local errorSource='create_core_overlay'
327     local printUsage=1
328
329     if [ -n "$coreOverlayDir" ]; then
330         export CORE_ROOT="$coreOverlayDir"
331         return
332     fi
333
334     # Check inputs to make sure we have enough information to create the core layout. $testRootDir/Tests/Core_Root should
335     # already exist and contain test dependencies that are not built.
336     local testDependenciesDir=$testRootDir/Tests/Core_Root
337     if [ ! -d "$testDependenciesDir" ]; then
338         exit_with_error "$errorSource" "Did not find the test dependencies directory: $testDependenciesDir"
339     fi
340     if [ -z "$coreClrBinDir" ]; then
341         exit_with_error "$errorSource" "One of --coreOverlayDir or --coreClrBinDir must be specified." "$printUsage"
342     fi
343     if [ ! -d "$coreClrBinDir" ]; then
344         exit_with_error "$errorSource" "Directory specified by --coreClrBinDir does not exist: $coreClrBinDir"
345     fi
346     if [ -z "$coreFxBinDir" ]; then
347         exit_with_error "$errorSource" "One of --coreOverlayDir or --coreFxBinDir must be specified." "$printUsage"
348     fi
349
350     # Create the overlay
351     coreOverlayDir=$testRootDir/Tests/coreoverlay
352     export CORE_ROOT="$coreOverlayDir"
353     if [ -e "$coreOverlayDir" ]; then
354         rm -f -r "$coreOverlayDir"
355     fi
356     mkdir "$coreOverlayDir"
357
358     cp -f -v "$coreFxBinDir/"* "$coreOverlayDir/" 2>/dev/null
359     cp -f -p -v "$coreClrBinDir/"* "$coreOverlayDir/" 2>/dev/null
360     if [ -d "$mscorlibDir/bin" ]; then
361         cp -f -v "$mscorlibDir/bin/"* "$coreOverlayDir/" 2>/dev/null
362     fi
363     cp -f -v "$testDependenciesDir/"xunit* "$coreOverlayDir/" 2>/dev/null
364     cp -n -v "$testDependenciesDir/"* "$coreOverlayDir/" 2>/dev/null
365     if [ -f "$coreOverlayDir/mscorlib.ni.dll" ]; then
366         # Test dependencies come from a Windows build, and mscorlib.ni.dll would be the one from Windows
367         rm -f "$coreOverlayDir/mscorlib.ni.dll"
368     fi
369     if [ -f "$coreOverlayDir/System.Private.CoreLib.ni.dll" ]; then
370         # Test dependencies come from a Windows build, and System.Private.CoreLib.ni.dll would be the one from Windows
371         rm -f "$coreOverlayDir/System.Private.CoreLib.ni.dll"
372     fi
373     copy_test_native_bin_to_test_root
374 }
375
376 declare -a skipCrossGenFiles
377
378 function is_skip_crossgen_test {
379     for skip in "${skipCrossGenFiles[@]}"; do
380         if [ "$1" == "$skip" ]; then
381             return 0
382         fi
383     done
384     return 1
385 }
386
387 function precompile_overlay_assemblies {
388     skipCrossGenFiles=($(read_array "$(dirname "$0")/skipCrossGenFiles.$ARCH.txt"))
389
390     if [ $doCrossgen == 1 ]; then
391         local overlayDir=$CORE_ROOT
392
393         filesToPrecompile=$(find -L $overlayDir -iname \*.dll -not -iname \*.ni.dll -not -iname \*-ms-win-\* -type f )
394         for fileToPrecompile in ${filesToPrecompile}
395         do
396             local filename=${fileToPrecompile}
397             if [ $jitdisasm == 1 ]; then
398                 $overlayDir/corerun $overlayDir/jit-dasm.dll --crossgen $overlayDir/crossgen --platform $overlayDir --output $testRootDir/dasm $filename
399                 local exitCode=$?
400                 if [ $exitCode != 0 ]; then
401                     echo Unable to generate dasm for $filename
402                 fi
403             else
404                 if is_skip_crossgen_test "$(basename $filename)"; then
405                     continue
406                 fi
407                 echo Precompiling $filename
408                 $overlayDir/crossgen /Platform_Assemblies_Paths $overlayDir $filename 1> $filename.stdout 2>$filename.stderr
409                 local exitCode=$?
410                 if [[ $exitCode != 0 ]]; then
411                     if grep -q -e '0x80131018' $filename.stderr; then
412                         printf "\n\t$filename is not a managed assembly.\n\n"
413                     else
414                         echo Unable to precompile $filename.
415                         cat $filename.stdout
416                         cat $filename.stderr
417                         exit $exitCode
418                     fi
419                 else
420                     rm $filename.{stdout,stderr}
421                 fi
422             fi
423         done
424     else
425         echo Skipping crossgen of FX assemblies.
426     fi
427 }
428
429 function copy_test_native_bin_to_test_root {
430     local errorSource='copy_test_native_bin_to_test_root'
431
432     if [ -z "$testNativeBinDir" ]; then
433         exit_with_error "$errorSource" "--testNativeBinDir is required."
434     fi
435     testNativeBinDir=$testNativeBinDir/src
436     if [ ! -d "$testNativeBinDir" ]; then
437         exit_with_error "$errorSource" "Directory specified by --testNativeBinDir does not exist: $testNativeBinDir"
438     fi
439
440     # Copy native test components from the native test build into the respective test directory in the test root directory
441     find "$testNativeBinDir" -type f -iname '*.$libExtension' |
442         while IFS='' read -r filePath || [ -n "$filePath" ]; do
443             local dirPath=$(dirname "$filePath")
444             local destinationDirPath=${testRootDir}${dirPath:${#testNativeBinDir}}
445             if [ ! -d "$destinationDirPath" ]; then
446                 exit_with_error "$errorSource" "Cannot copy native test bin '$filePath' to '$destinationDirPath/', as the destination directory does not exist."
447             fi
448             cp -f "$filePath" "$destinationDirPath/"
449         done
450 }
451
452 # Variables for unsupported and failing tests
453 declare -a unsupportedTests
454 declare -a failingTests
455 declare -a playlistTests
456 ((runFailingTestsOnly = 0))
457
458 # Get an array of items by reading the specified file line by line.
459 function read_array {
460     local theArray=()
461
462     # bash in Mac OS X doesn't support 'readarray', so using alternate way instead.
463     # readarray -t theArray < "$1"
464     while IFS='' read -r line || [ -n "$line" ]; do
465         theArray[${#theArray[@]}]=$line
466     done < "$1"
467     echo ${theArray[@]}
468 }
469
470 function load_unsupported_tests {
471     # Load the list of tests that are not supported on this platform. These tests are disabled (skipped) permanently.
472     unsupportedTests=($(read_array "$(dirname "$0")/testsUnsupportedOutsideWindows.txt"))
473     if [ "$ARCH" == "arm" ]; then
474         unsupportedTests+=($(read_array "$(dirname "$0")/testsUnsupportedOnARM32.txt"))
475     fi
476 }
477
478 function load_failing_tests {
479     # Load the list of tests that fail on this platform. These tests are disabled (skipped) temporarily, pending investigation.
480     failingTests=($(read_array "$(dirname "$0")/testsFailingOutsideWindows.txt"))
481 }
482
483 function load_playlist_tests {
484     # Load the list of tests that are enabled as a part of this test playlist.
485     playlistTests=($(read_array "${playlistFile}"))
486 }
487
488 function is_unsupported_test {
489     for unsupportedTest in "${unsupportedTests[@]}"; do
490         if [ "$1" == "$unsupportedTest" ]; then
491             return 0
492         fi
493     done
494     return 1
495 }
496
497 function is_failing_test {
498     for failingTest in "${failingTests[@]}"; do
499         if [ "$1" == "$failingTest" ]; then
500             return 0
501         fi
502     done
503     return 1
504 }
505
506 function is_playlist_test {
507     for playlistTest in "${playlistTests[@]}"; do
508         if [ "$1" == "$playlistTest" ]; then
509             return 0
510         fi
511     done
512     return 1
513 }
514
515 function skip_unsupported_test {
516     # This function runs in a background process. It should not echo anything, and should not use global variables. This
517     # function is analogous to run_test, and causes the test to be skipped with the message below.
518
519     local scriptFilePath=$1
520     local outputFilePath=$2
521
522     echo "Not supported on this platform." >"$outputFilePath"
523     return 2 # skip the test
524 }
525
526 function skip_failing_test {
527     # This function runs in a background process. It should not echo anything, and should not use global variables. This
528     # function is analogous to run_test, and causes the test to be skipped with the message below.
529
530     local scriptFilePath=$1
531     local outputFilePath=$2
532
533     echo "Temporarily disabled on this platform due to unexpected failures." >"$outputFilePath"
534     return 2 # skip the test
535 }
536
537 function skip_non_playlist_test {
538     # This function runs in a background process. It should not echo anything, and should not use global variables. This
539     # function is analogous to run_test, and causes the test to be skipped with the message below.
540
541     local scriptFilePath=$1
542     local outputFilePath=$2
543
544     echo "Test is not included in the running playlist." >"$outputFilePath"
545     return 2 # skip the test
546 }
547
548 function set_up_core_dump_generation {
549     # We will only enable dump generation here if we're on Mac or Linux
550     if [[ ! ( "$(uname -s)" == "Darwin" || "$(uname -s)" == "Linux" ) ]]; then
551         return
552     fi
553
554     # We won't enable dump generation on OS X/macOS if the machine hasn't been
555     # configured with the kern.corefile pattern we expect.
556     if [[ ( "$(uname -s)" == "Darwin" && "$(sysctl -n kern.corefile)" != "core.%P" ) ]]; then
557         echo "WARNING: Core dump generation not being enabled due to unexpected kern.corefile value."
558         return
559     fi
560
561     # Allow dump generation
562     ulimit -c unlimited
563
564     if [ "$(uname -s)" == "Linux" ]; then
565         if [ -e /proc/self/coredump_filter ]; then
566             # Include memory in private and shared file-backed mappings in the dump.
567             # This ensures that we can see disassembly from our shared libraries when
568             # inspecting the contents of the dump. See 'man core' for details.
569             echo 0x3F > /proc/self/coredump_filter
570         fi
571     fi
572 }
573
574 function print_info_from_core_file {
575     local core_file_name=$1
576     local executable_name=$2
577
578     if ! [ -e $executable_name ]; then
579         echo "Unable to find executable $executable_name"
580         return
581     elif ! [ -e $core_file_name ]; then
582         echo "Unable to find core file $core_file_name"
583         return
584     fi
585
586     # Use LLDB to inspect the core dump on Mac, and GDB everywhere else.
587     if [[ "$OSName" == "Darwin" ]]; then
588         hash lldb 2>/dev/null || { echo >&2 "LLDB was not found. Unable to print core file."; return; }
589
590         echo "Printing info from core file $core_file_name"
591         lldb -c $core_file_name -b -o 'bt'
592     else
593         # Use GDB to print the backtrace from the core file.
594         hash gdb 2>/dev/null || { echo >&2 "GDB was not found. Unable to print core file."; return; }
595
596         echo "Printing info from core file $core_file_name"
597         gdb --batch -ex "thread apply all bt full" -ex "quit" $executable_name $core_file_name
598     fi
599 }
600
601 function download_dumpling_script {
602     echo "Downloading latest version of dumpling script."
603     wget "https://dumpling.azurewebsites.net/api/client/dumpling.py"
604
605     local dumpling_script="dumpling.py"
606     chmod +x $dumpling_script
607 }
608
609 function upload_core_file_to_dumpling {
610     local core_file_name=$1
611     local dumpling_script="dumpling.py"
612     local dumpling_file="local_dumplings.txt"
613
614     # dumpling requires that the file exist before appending.
615     touch ./$dumpling_file
616
617     if [ ! -x $dumpling_script ]; then
618         download_dumpling_script
619     fi
620
621     if [ ! -x $dumpling_script ]; then
622         echo "Failed to download dumpling script. Dump cannot be uploaded."
623         return
624     fi
625
626     echo "Uploading $core_file_name to dumpling service."
627
628     local paths_to_add=""
629     if [ -d "$coreClrBinDir" ]; then
630         echo "Uploading CoreCLR binaries with dump."
631         paths_to_add=$coreClrBinDir
632     fi
633
634     # Ensure the script has Unix line endings
635     perl -pi -e 's/\r\n|\n|\r/\n/g' "$dumpling_script"
636
637     # The output from this will include a unique ID for this dump.
638     ./$dumpling_script "upload" "--dumppath" "$core_file_name" "--incpaths" $paths_to_add "--properties" "Project=CoreCLR" "--squelch" | tee -a $dumpling_file
639 }
640
641 function preserve_core_file {
642     local core_file_name=$1
643     local storage_location="/tmp/coredumps_coreclr"
644
645     # Create the directory (this shouldn't fail even if it already exists).
646     mkdir -p $storage_location
647
648     # Only preserve the dump if the directory is empty. Otherwise, do nothing.
649     # This is a way to prevent us from storing/uploading too many dumps.
650     if [ ! "$(ls -A $storage_location)" ]; then
651         echo "Copying core file $core_file_name to $storage_location"
652         cp $core_file_name $storage_location
653
654         upload_core_file_to_dumpling $core_file_name
655     fi
656 }
657
658 function inspect_and_delete_core_files {
659     # This function prints some basic information from core files in the current
660     # directory and deletes them immediately. Based on the state of the system, it may
661     # also upload a core file to the dumpling service.
662     # (see preserve_core_file).
663     
664     # Depending on distro/configuration, the core files may either be named "core"
665     # or "core.<PID>" by default. We will read /proc/sys/kernel/core_uses_pid to 
666     # determine which one it is.
667     # On OS X/macOS, we checked the kern.corefile value before enabling core dump
668     # generation, so we know it always includes the PID.
669     local core_name_uses_pid=0
670     if [[ (( -e /proc/sys/kernel/core_uses_pid ) && ( "1" == $(cat /proc/sys/kernel/core_uses_pid) )) 
671           || ( "$(uname -s)" == "Darwin" ) ]]; then
672         core_name_uses_pid=1
673     fi
674
675     if [ $core_name_uses_pid == "1" ]; then
676         # We don't know what the PID of the process was, so let's look at all core
677         # files whose name matches core.NUMBER
678         for f in core.*; do
679             [[ $f =~ core.[0-9]+ ]] && print_info_from_core_file "$f" $CORE_ROOT/"corerun" && preserve_core_file "$f" && rm "$f"
680         done
681     elif [ -f core ]; then
682         print_info_from_core_file "core" $CORE_ROOT/"corerun"
683         preserve_core_file "core"
684         rm "core"
685     fi
686 }
687
688 function run_test {
689     # This function runs in a background process. It should not echo anything, and should not use global variables.
690
691     local scriptFilePath=$1
692     local outputFilePath=$2
693
694     # Switch to directory where the script is
695     cd "$(dirname "$scriptFilePath")"
696
697     local scriptFileName=$(basename "$scriptFilePath")
698     local outputFileName=$(basename "$outputFilePath")
699
700     if [ "$limitedCoreDumps" == "ON" ]; then
701         set_up_core_dump_generation
702     fi
703
704     "./$scriptFileName" >"$outputFileName" 2>&1
705     local testScriptExitCode=$?
706
707     # We will try to print some information from generated core dumps if a debugger
708     # is available, and possibly store a dump in a non-transient location.
709     if [ "$limitedCoreDumps" == "ON" ]; then
710         inspect_and_delete_core_files
711     fi
712
713     return $testScriptExitCode
714 }
715
716 # Variables for running tests in the background
717 if [ `uname` = "NetBSD" ]; then
718     NumProc=$(getconf NPROCESSORS_ONLN)
719 else
720     NumProc=$(getconf _NPROCESSORS_ONLN)
721 fi
722 ((maxProcesses = $NumProc * 3 / 2)) # long tests delay process creation, use a few more processors
723
724 ((nextProcessIndex = 0))
725 ((processCount = 0))
726 declare -a scriptFilePaths
727 declare -a outputFilePaths
728 declare -a processIds
729 declare -a testStartTimes
730
731 function finish_test {
732     wait ${processIds[$nextProcessIndex]}
733     local testScriptExitCode=$?
734     ((--processCount))
735
736     local scriptFilePath=${scriptFilePaths[$nextProcessIndex]}
737     local outputFilePath=${outputFilePaths[$nextProcessIndex]}
738     local scriptFileName=$(basename "$scriptFilePath")
739
740     local testEndTime=
741     local testRunningTime=
742     local header=
743
744     if ((verbose == 1)); then
745         header=$(printf "[%4d]" $countTotalTests)
746     fi
747
748     if [ "$showTime" == "ON" ]; then
749         testEndTime=$(date +%s)
750         testRunningTime=$(( $testEndTime - ${testStartTimes[$nextProcessIndex]} ))
751         header=$header$(printf "[%4ds]" $testRunningTime)
752     fi
753
754     local xunitTestResult
755     case $testScriptExitCode in
756         0)
757             let countPassedTests++
758             xunitTestResult='Pass'
759             if ((verbose == 1 || runFailingTestsOnly == 1)); then
760                 echo "PASSED   - ${header}${scriptFilePath}"
761             else
762                 echo "         - ${header}${scriptFilePath}"
763             fi
764             ;;
765         2)
766             let countSkippedTests++
767             xunitTestResult='Skip'
768             echo "SKIPPED  - ${header}${scriptFilePath}"
769             ;;
770         *)
771             let countFailedTests++
772             xunitTestResult='Fail'
773             echo "FAILED   - ${header}${scriptFilePath}"
774             ;;
775     esac
776     let countTotalTests++
777
778     if ((verbose == 1 || testScriptExitCode != 0)); then
779         while IFS='' read -r line || [ -n "$line" ]; do
780             echo "               $line"
781         done <"$outputFilePath"
782     fi
783
784     xunit_output_add_test "$scriptFilePath" "$outputFilePath" "$xunitTestResult" "$testScriptExitCode"
785 }
786
787 function finish_remaining_tests {
788     # Finish the remaining tests in the order in which they were started
789     if ((nextProcessIndex >= processCount)); then
790         ((nextProcessIndex = 0))
791     fi
792     while ((processCount > 0)); do
793         finish_test
794         ((nextProcessIndex = (nextProcessIndex + 1) % maxProcesses))
795     done
796     ((nextProcessIndex = 0))
797 }
798
799 function prep_test {
800     local scriptFilePath=$1
801     local scriptFileDir=$(dirname "$scriptFilePath")
802
803     test "$verbose" == 1 && echo "Preparing $scriptFilePath"
804
805     if [ ! "$noLFConversion" == "ON" ]; then
806         # Convert DOS line endings to Unix if needed
807         perl -pi -e 's/\r\n|\n|\r/\n/g' "$scriptFilePath"
808     fi
809         
810     # Add executable file mode bit if needed
811     chmod +x "$scriptFilePath"
812
813     #remove any NI and Locks
814     rm -f $scriptFileDir/*.ni.*
815     rm -rf $scriptFileDir/lock
816 }
817
818 function start_test {
819     local scriptFilePath=$1
820     if ((runFailingTestsOnly == 1)) && ! is_failing_test "$scriptFilePath"; then
821         return
822     fi
823
824     # Skip any test that's not in the current playlist, if a playlist was
825     # given to us.
826     if [ -n "$playlistFile" ] && ! is_playlist_test "$scriptFilePath"; then
827         return
828     fi
829
830     if ((nextProcessIndex < processCount)); then
831         finish_test
832     fi
833
834     scriptFilePaths[$nextProcessIndex]=$scriptFilePath
835     local scriptFileName=$(basename "$scriptFilePath")
836     local outputFilePath=$(dirname "$scriptFilePath")/${scriptFileName}.out
837     outputFilePaths[$nextProcessIndex]=$outputFilePath
838
839     if [ "$showTime" == "ON" ]; then
840         testStartTimes[$nextProcessIndex]=$(date +%s)
841     fi
842
843     test "$verbose" == 1 && echo "Starting $scriptFilePath"
844     if is_unsupported_test "$scriptFilePath"; then
845         skip_unsupported_test "$scriptFilePath" "$outputFilePath" &
846     elif ((runFailingTestsOnly == 0)) && is_failing_test "$scriptFilePath"; then
847         skip_failing_test "$scriptFilePath" "$outputFilePath" &
848     else
849         run_test "$scriptFilePath" "$outputFilePath" &
850     fi
851     processIds[$nextProcessIndex]=$!
852
853     ((nextProcessIndex = (nextProcessIndex + 1) % maxProcesses))
854     ((++processCount))
855 }
856
857 # Get a list of directories in which to scan for tests by reading the
858 # specified file line by line.
859 function set_test_directories {
860     local errorSource='set_test_directories'
861
862     local listFileName=$1
863
864     if [ ! -f "$listFileName" ]
865     then
866         exit_with_error "$errorSource" "Test directories file not found at $listFileName"
867     fi
868     testDirectories=($(read_array "$listFileName"))
869 }
870
871 function run_tests_in_directory {
872     local testDir=$1
873
874     # Recursively search through directories for .sh files to prepare them.
875     # Note: This needs to occur before any test runs as some of the .sh files
876     # depend on other .sh files
877     for scriptFilePath in $(find "$testDir" -type f -iname '*.sh' | sort)
878     do
879         prep_test "${scriptFilePath:2}"
880     done
881     echo "The tests have been prepared"
882     # Recursively search through directories for .sh files to run.
883     for scriptFilePath in $(find "$testDir" -type f -iname '*.sh' | sort)
884     do
885         start_test "${scriptFilePath:2}"
886     done
887 }
888
889 function coreclr_code_coverage {
890     local coverageDir="$coverageOutputDir/Coverage"
891     local toolsDir="$coverageOutputDir/Coverage/tools"
892     local reportsDir="$coverageOutputDir/Coverage/reports"
893     local packageName="unix-code-coverage-tools.1.0.0.nupkg"
894
895     rm -rf $coverageDir
896     mkdir -p $coverageDir
897     mkdir -p $toolsDir
898     mkdir -p $reportsDir
899     pushd $toolsDir > /dev/null
900
901     echo "Pulling down code coverage tools"
902     wget -q https://www.myget.org/F/dotnet-buildtools/api/v2/package/unix-code-coverage-tools/1.0.0 -O $packageName
903     echo "Unzipping to $toolsDir"
904     unzip -q -o $packageName
905
906     # Invoke gcovr
907     chmod a+rwx ./gcovr
908     chmod a+rwx ./$OSName/llvm-cov
909
910     echo
911     echo "Generating coreclr code coverage reports at $reportsDir/coreclr.html"
912     echo "./gcovr $coreClrObjs --gcov-executable=$toolsDir/$OS/llvm-cov -r $coreClrSrc --html --html-details -o $reportsDir/coreclr.html"
913     echo
914     ./gcovr $coreClrObjs --gcov-executable=$toolsDir/$OSName/llvm-cov -r $coreClrSrc --html --html-details -o $reportsDir/coreclr.html
915     exitCode=$?
916     popd > /dev/null
917     exit $exitCode
918 }
919
920 function check_cpu_architecture {
921     local CPUName=$(uname -m)
922     local __arch=
923
924     case $CPUName in
925         i686)
926             __arch=x86
927             ;;
928         x86_64)
929             __arch=x64
930             ;;
931         armv7l)
932             __arch=arm
933             ;;
934         aarch64)
935             __arch=arm64
936             ;;
937         *)
938             echo "Unknown CPU $CPUName detected, configuring as if for x64"
939             __arch=x64
940             ;;
941     esac
942
943     echo "$__arch"
944 }
945
946 ARCH=$(check_cpu_architecture)
947 echo "Running on  CPU- $ARCH"
948
949 # Exit code constants
950 readonly EXIT_CODE_SUCCESS=0       # Script ran normally.
951 readonly EXIT_CODE_EXCEPTION=1     # Script exited because something exceptional happened (e.g. bad arguments, Ctrl-C interrupt).
952 readonly EXIT_CODE_TEST_FAILURE=2  # Script completed successfully, but one or more tests failed.
953
954 # Argument variables
955 testRootDir=
956 testNativeBinDir=
957 coreOverlayDir=
958 coreClrBinDir=
959 mscorlibDir=
960 coreFxBinDir=
961 coreClrObjs=
962 coreClrSrc=
963 coverageOutputDir=
964 testEnv=
965 playlistFile=
966 showTime=
967 noLFConversion=
968 buildOverlayOnly=
969 gcsimulator=
970 longgc=
971 limitedCoreDumps=
972 illinker=
973 ((disableEventLogging = 0))
974 ((serverGC = 0))
975
976 # Handle arguments
977 verbose=0
978 doCrossgen=0
979 jitdisasm=0
980 ilasmroundtrip=
981
982 for i in "$@"
983 do
984     case $i in
985         -h|--help)
986             print_usage
987             exit $EXIT_CODE_SUCCESS
988             ;;
989         -v|--verbose)
990             verbose=1
991             ;;
992         --crossgen)
993             doCrossgen=1
994             ;;
995         --jitstress=*)
996             export COMPlus_JitStress=${i#*=}
997             ;;
998         --jitstressregs=*)
999             export COMPlus_JitStressRegs=${i#*=}
1000             ;;
1001         --jitminopts)
1002             export COMPlus_JITMinOpts=1
1003             ;;
1004         --jitforcerelocs)
1005             export COMPlus_ForceRelocs=1
1006             ;;
1007         --link=*)
1008             export ILLINK=${i#*=}
1009             export DoLink=true
1010             ;;
1011         --jitdisasm)
1012             jitdisasm=1
1013             ;;
1014         --ilasmroundtrip)
1015             ((ilasmroundtrip = 1))
1016             ;;
1017         --testRootDir=*)
1018             testRootDir=${i#*=}
1019             ;;
1020         --testNativeBinDir=*)
1021             testNativeBinDir=${i#*=}
1022             ;;
1023         --coreOverlayDir=*)
1024             coreOverlayDir=${i#*=}
1025             ;;
1026         --coreClrBinDir=*)
1027             coreClrBinDir=${i#*=}
1028             ;;
1029         --mscorlibDir=*)
1030             mscorlibDir=${i#*=}
1031             ;;
1032         --coreFxBinDir=*)
1033             coreFxBinDir=${i#*=}
1034             ;;
1035         --testDir=*)
1036             testDirectories[${#testDirectories[@]}]=${i#*=}
1037             ;;
1038         --testDirFile=*)
1039             set_test_directories "${i#*=}"
1040             ;;
1041         --runFailingTestsOnly)
1042             ((runFailingTestsOnly = 1))
1043             ;;
1044         --disableEventLogging)
1045             ((disableEventLogging = 1))
1046             ;;
1047         --runcrossgentests)
1048             export RunCrossGen=1
1049             ;;
1050         --sequential)
1051             ((maxProcesses = 1))
1052             ;;
1053         --useServerGC)
1054             ((serverGC = 1))
1055             ;;
1056         --long-gc)
1057             ((longgc = 1))
1058             ;;
1059         --gcsimulator)
1060             ((gcsimulator = 1))
1061             ;;
1062         --playlist=*)
1063             playlistFile=${i#*=}
1064             ;;
1065         --coreclr-coverage)
1066             CoreClrCoverage=ON
1067             ;;
1068         --coreclr-objs=*)
1069             coreClrObjs=${i#*=}
1070             ;;
1071         --coreclr-src=*)
1072             coreClrSrc=${i#*=}
1073             ;;
1074         --coverage-output-dir=*)
1075             coverageOutputDir=${i#*=}
1076             ;;
1077         --test-env=*)
1078             testEnv=${i#*=}
1079             ;;            
1080         --gcstresslevel=*)
1081             export COMPlus_GCStress=${i#*=}
1082             ;;            
1083         --show-time)
1084             showTime=ON
1085             ;;
1086         --no-lf-conversion)
1087             noLFConversion=ON
1088             ;;
1089         --build-overlay-only)
1090             buildOverlayOnly=ON
1091             ;;
1092         --limitedDumpGeneration)
1093             limitedCoreDumps=ON
1094             ;;
1095         --xunitOutputPath=*)
1096             xunitOutputPath=${i#*=}
1097             ;;
1098         *)
1099             echo "Unknown switch: $i"
1100             print_usage
1101             exit $EXIT_CODE_SUCCESS
1102             ;;
1103     esac
1104 done
1105
1106 if [ -n "$coreOverlayDir" ] && [ "$buildOverlayOnly" == "ON" ]; then
1107     echo "Can not use \'--coreOverlayDir=<path>\' and \'--build-overlay-only\' at the same time."
1108     exit $EXIT_CODE_EXCEPTION
1109 fi
1110
1111 if ((disableEventLogging == 0)); then
1112     export COMPlus_EnableEventLog=1
1113 fi
1114
1115 export CORECLR_SERVER_GC="$serverGC"
1116
1117 if [ -z "$testRootDir" ]; then
1118     echo "--testRootDir is required."
1119     print_usage
1120     exit $EXIT_CODE_EXCEPTION
1121 fi
1122 if [ ! -d "$testRootDir" ]; then
1123     echo "Directory specified by --testRootDir does not exist: $testRootDir"
1124     exit $EXIT_CODE_EXCEPTION
1125 fi
1126
1127 # Copy native interop test libraries over to the mscorlib path in
1128 # order for interop tests to run on linux.
1129 if [ -z "$mscorlibDir" ]; then
1130     mscorlibDir=$coreClrBinDir
1131 fi
1132
1133 if [ ! -z "$longgc" ]; then
1134     echo "Running Long GC tests"
1135     export RunningLongGCTests=1
1136 fi
1137
1138 if [ ! -z "$gcsimulator" ]; then
1139     echo "Running GC simulator tests"
1140     export RunningGCSimulatorTests=1
1141 fi
1142
1143 if [[ ! "$jitdisasm" -eq 0 ]]; then
1144     echo "Running jit disasm"
1145     export RunningJitDisasm=1
1146 fi
1147
1148 if [ ! -z "$ilasmroundtrip" ]; then
1149     echo "Running Ilasm round trip"
1150     export RunningIlasmRoundTrip=1
1151 fi
1152
1153 # If this is a coverage run, make sure the appropriate args have been passed
1154 if [ "$CoreClrCoverage" == "ON" ]
1155 then
1156     echo "Code coverage is enabled for this run"
1157     echo ""
1158     if [ ! "$OSName" == "Darwin" ] && [ ! "$OSName" == "Linux" ]
1159     then
1160         echo "Code Coverage not supported on $OS"
1161         exit 1
1162     fi
1163
1164     if [ -z "$coreClrObjs" ]
1165     then
1166         echo "Coreclr obj files are required to generate code coverage reports"
1167         echo "Coreclr obj files root path can be passed using '--coreclr-obj' argument"
1168         exit 1
1169     fi
1170
1171     if [ -z "$coreClrSrc" ]
1172     then
1173         echo "Coreclr src files are required to generate code coverage reports"
1174         echo "Coreclr src files root path can be passed using '--coreclr-src' argument"
1175         exit 1
1176     fi
1177
1178     if [ -z "$coverageOutputDir" ]
1179     then
1180         echo "Output directory for coverage results must be specified"
1181         echo "Output path can be specified '--coverage-output-dir' argument"
1182         exit 1
1183     fi
1184 fi
1185
1186 xunit_output_begin
1187 create_core_overlay
1188 precompile_overlay_assemblies
1189
1190 if [ "$buildOverlayOnly" == "ON" ];
1191 then
1192     echo "Build overlay directory \'$coreOverlayDir\' complete."
1193     exit 0
1194 fi
1195
1196 if [ -n "$playlistFile" ]
1197 then
1198     # Use a playlist file exclusively, if it was provided
1199     echo "Executing playlist $playlistFile"
1200     load_playlist_tests
1201 else
1202     load_unsupported_tests
1203     load_failing_tests
1204 fi
1205
1206 # Other architectures are not supported yet.
1207 if [ "$ARCH" == "x64" ]
1208 then
1209     scriptPath=$(dirname $0)
1210     ${scriptPath}/setup-stress-dependencies.sh --outputDir=$coreOverlayDir
1211 else
1212     if [ "$ARCH" != "arm64" ]
1213     then
1214         echo "Skip preparing for GC stress test. Dependent package is not supported on this architecture."
1215     fi
1216 fi
1217
1218 export __TestEnv=$testEnv
1219
1220 cd "$testRootDir"
1221
1222 dumplingsListPath="$testRootDir/dumplings.txt"
1223
1224 # clean up any existing dumpling remnants from previous runs.
1225 rm -f "$dumplingsListPath"
1226 find $testRootDir -type f -name "local_dumplings.txt" -exec rm {} \;
1227
1228 time_start=$(date +"%s")
1229 if [ -z "$testDirectories" ]
1230 then
1231     # No test directories were specified, so run everything in the current
1232     # directory and its subdirectories.
1233     run_tests_in_directory "."
1234 else
1235     # Otherwise, run all the tests in each specified test directory.
1236     for testDir in "${testDirectories[@]}"
1237     do
1238         if [ ! -d "$testDir" ]; then
1239             echo "Test directory does not exist: $testDir"
1240         else
1241             run_tests_in_directory "./$testDir"
1242         fi
1243     done
1244 fi
1245 finish_remaining_tests
1246
1247 print_results
1248
1249 find $testRootDir -type f -name "local_dumplings.txt" -exec cat {} \; > $dumplingsListPath
1250
1251 if [ -s $dumplingsListPath ]; then
1252     cat $dumplingsListPath
1253 else
1254     rm $dumplingsListPath
1255 fi
1256
1257 time_end=$(date +"%s")
1258 time_diff=$(($time_end-$time_start))
1259 echo "$(($time_diff / 60)) minutes and $(($time_diff % 60)) seconds taken to run CoreCLR tests."
1260
1261 xunit_output_end
1262
1263 if [ "$CoreClrCoverage" == "ON" ]
1264 then
1265     coreclr_code_coverage
1266 fi
1267
1268 if ((countFailedTests > 0)); then
1269     exit $EXIT_CODE_TEST_FAILURE
1270 fi
1271
1272 exit $EXIT_CODE_SUCCESS