5 echo 'CoreCLR test runner script.'
7 echo 'Typical command line:'
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 ' --coreOverlayDir="coreclr/bin/tests/Linux.x64.Debug/Tests/Core_Root"'
13 echo ' --copyNativeTestBin'
15 echo 'Required arguments:'
16 echo ' --testRootDir=<path> : Root directory of the test build (e.g. coreclr/bin/tests/Windows_NT.x64.Debug).'
17 echo ' --testNativeBinDir=<path> : Directory of the native CoreCLR test build (e.g. coreclr/bin/obj/Linux.x64.Debug/tests).'
18 echo ' (Also required: Either --coreOverlayDir, or all of the switches --coreOverlayDir overrides)'
20 echo 'Optional arguments:'
21 echo ' --coreOverlayDir=<path> : Directory containing core binaries and test dependencies. If not specified, the'
22 echo ' default is testRootDir/Tests/coreoverlay. This switch overrides --coreClrBinDir,'
23 echo ' --mscorlibDir, and --coreFxBinDir.'
24 echo ' --coreClrBinDir=<path> : Directory of the CoreCLR build (e.g. coreclr/bin/Product/Linux.x64.Debug).'
25 echo ' --mscorlibDir=<path> : Directory containing the built mscorlib.dll. If not specified, it is expected to be'
26 echo ' in the directory specified by --coreClrBinDir.'
27 echo ' --coreFxBinDir="<path>" : Directory with CoreFX build outputs'
28 echo ' (e.g. "corefx/bin/runtime/netcoreapp-Linux-Debug-x64")'
29 echo ' If files with the same name are present in multiple directories, the first one wins.'
30 echo ' --testDir=<path> : Run tests only in the specified directory. The path is relative to the directory'
31 echo ' specified by --testRootDir. Multiple of this switch may be specified.'
32 echo ' --testDirFile=<path> : Run tests only in the directories specified by the file at <path>. Paths are listed'
33 echo ' one line, relative to the directory specified by --testRootDir.'
34 echo ' --build-overlay-only : Build coreoverlay only, and skip running tests.'
35 echo ' --runFailingTestsOnly : Run only the tests that are disabled on this platform due to unexpected failures.'
36 echo ' Failing tests are listed in coreclr/tests/failingTestsOutsideWindows.txt, one per'
37 echo ' line, as paths to .sh files relative to the directory specified by --testRootDir.'
38 echo ' --disableEventLogging : Disable the events logged by both VM and Managed Code'
39 echo ' --sequential : Run tests sequentially (default is to run in parallel).'
40 echo ' --playlist=<path> : Run only the tests that are specified in the file at <path>, in the same format as'
41 echo ' runFailingTestsOnly'
42 echo ' -v, --verbose : Show output from each test.'
43 echo ' -h|--help : Show usage information.'
44 echo ' --useServerGC : Enable server GC for this test run'
45 echo ' --test-env : Script to set environment variables for tests'
46 echo ' --copyNativeTestBin : Explicitly copy native test components into the test dir'
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 ' --gcname=<n> : Runs the tests with COMPlus_GCName=n'
56 echo ' --ilasmroundtrip : Runs ilasm round trip on the tests'
57 echo ' 0: None 1: GC on all allocs and '"'easy'"' places'
58 echo ' 2: GC on transitions to preemptive GC 4: GC on every allowable JITed instr'
59 echo ' 8: GC on every allowable NGEN instr 16: GC only on a unique stack trace'
60 echo ' --long-gc : Runs the long GC tests'
61 echo ' --gcsimulator : Runs the GCSimulator tests'
62 echo ' --tieredcompilation : Runs the tests with COMPlus_EXPERIMENTAL_TieredCompilation=1'
63 echo ' --link <ILlink> : Runs the tests after linking via ILlink'
64 echo ' --show-time : Print execution sequence and running time for each test'
65 echo ' --no-lf-conversion : Do not execute LF conversion before running test script'
66 echo ' --limitedDumpGeneration : Enables the generation of a limited number of core dumps if test(s) crash, even if ulimit'
67 echo ' is zero when launching this script. This option is intended for use in CI.'
68 echo ' --xunitOutputPath=<path> : Create xUnit XML report at the specifed path (default: <test root>/coreclrtests.xml)'
70 echo 'Runtime Code Coverage options:'
71 echo ' --coreclr-coverage : Optional argument to get coreclr code coverage reports'
72 echo ' --coreclr-objs=<path> : Location of root of the object directory'
73 echo ' containing the linux/mac coreclr build'
74 echo ' --coreclr-src=<path> : Location of root of the directory'
75 echo ' containing the coreclr source files'
76 echo ' --coverage-output-dir=<path> : Directory where coverage output will be written to'
80 function print_results {
82 echo "======================="
84 echo "======================="
85 echo "# CoreCLR Bin Dir : $coreClrBinDir"
86 echo "# Tests Discovered : $countTotalTests"
87 echo "# Passed : $countPassedTests"
88 echo "# Failed : $countFailedTests"
89 echo "# Skipped : $countSkippedTests"
90 echo "======================="
93 # Initialize counters for bookkeeping.
99 # Variables for xUnit-style XML output. XML format: https://xunit.github.io/docs/format-xml-v2.html
103 # libExtension determines extension for dynamic library files
104 # runtimeName determines where CoreFX Runtime files will be located
121 echo "Unsupported OS $OSName detected, configuring as if for Linux"
126 function xunit_output_begin {
127 if [ -z "$xunitOutputPath" ]; then
128 xunitOutputPath=$testRootDir/coreclrtests.xml
130 if ! [ -e $(basename "$xunitOutputPath") ]; then
131 xunitOutputPath=$testRootDir/coreclrtests.xml
133 xunitTestOutputPath=${xunitOutputPath}.test
134 if [ -e "$xunitOutputPath" ]; then
135 rm -f -r "$xunitOutputPath"
137 if [ -e "$xunitTestOutputPath" ]; then
138 rm -f -r "$xunitTestOutputPath"
142 function xunit_output_add_test {
146 # <test .../> <!-- Write this element here -->
148 local scriptFilePath=$1
149 local outputFilePath=$2
150 local testResult=$3 # Pass, Fail, or Skip
151 local testScriptExitCode=$4
152 local testRunningTime=$5
154 local testPath=${scriptFilePath%.sh} # Remove trailing ".sh"
155 local testDir=$(dirname "$testPath")
156 local testName=$(basename "$testPath")
158 # Replace '/' with '.'
159 testPath=$(echo "$testPath" | tr / .)
160 testDir=$(echo "$testDir" | tr / .)
166 line="${line} name=\"${testPath}\""
167 line="${line} type=\"${testDir}\""
168 line="${line} method=\"${testName}\""
169 line="${line} result=\"${testResult}\""
170 if [ -n "$testRunningTime" ] && [ "$testResult" != "Skip" ]; then
171 line="${line} time=\"${testRunningTime}\""
174 if [ "$testResult" == "Pass" ]; then
176 echo "$line" >>"$xunitTestOutputPath"
181 echo "$line" >>"$xunitTestOutputPath"
184 if [ "$testResult" == "Skip" ]; then
185 line="${line}<reason><![CDATA[$(cat "$outputFilePath")]]></reason>"
186 echo "$line" >>"$xunitTestOutputPath"
188 line="${line}<failure exception-type=\"Exit code: ${testScriptExitCode}\">"
189 echo "$line" >>"$xunitTestOutputPath"
192 line="${line}<message>"
193 echo "$line" >>"$xunitTestOutputPath"
195 line="${line}<![CDATA["
196 echo "$line" >>"$xunitTestOutputPath"
197 cat "$outputFilePath" >>"$xunitTestOutputPath"
200 echo "$line" >>"$xunitTestOutputPath"
202 line="${line}</message>"
203 echo "$line" >>"$xunitTestOutputPath"
206 line="${line}</failure>"
207 echo "$line" >>"$xunitTestOutputPath"
211 line="${line}</test>"
212 echo "$line" >>"$xunitTestOutputPath"
215 function xunit_output_end {
217 local errorMessage=$2
220 if [ -z "$errorSource" ]; then
226 echo '<?xml version="1.0" encoding="utf-8"?>' >>"$xunitOutputPath"
227 echo '<assemblies>' >>"$xunitOutputPath"
233 line="${line}<assembly"
234 line="${line} name=\"CoreClrTestAssembly\""
235 line="${line} total=\"${countTotalTests}\""
236 line="${line} passed=\"${countPassedTests}\""
237 line="${line} failed=\"${countFailedTests}\""
238 line="${line} skipped=\"${countSkippedTests}\""
239 line="${line} errors=\"${errorCount}\""
241 echo "$line" >>"$xunitOutputPath"
245 line="${line}<collection"
246 line="${line} name=\"CoreClrTestCollection\""
247 line="${line} total=\"${countTotalTests}\""
248 line="${line} passed=\"${countPassedTests}\""
249 line="${line} failed=\"${countFailedTests}\""
250 line="${line} skipped=\"${countSkippedTests}\""
252 echo "$line" >>"$xunitOutputPath"
254 # <test .../> <test .../> ...
255 if [ -f "$xunitTestOutputPath" ]; then
256 cat "$xunitTestOutputPath" >>"$xunitOutputPath"
257 rm -f "$xunitTestOutputPath"
262 line="${line}</collection>"
263 echo "$line" >>"$xunitOutputPath"
265 if [ -n "$errorSource" ]; then
268 line="${line}<errors>"
269 echo "$line" >>"$xunitOutputPath"
274 line="${line} type=\"TestHarnessError\""
275 line="${line} name=\"${errorSource}\""
277 echo "$line" >>"$xunitOutputPath"
281 line="${line}<failure>${errorMessage}</failure>"
282 echo "$line" >>"$xunitOutputPath"
286 line="${line}</error>"
287 echo "$line" >>"$xunitOutputPath"
291 line="${line}</errors>"
292 echo "$line" >>"$xunitOutputPath"
297 line="${line}</assembly>"
298 echo "$line" >>"$xunitOutputPath"
301 echo '</assemblies>' >>"$xunitOutputPath"
304 function exit_with_error {
306 local errorMessage=$2
309 if [ -z "$printUsage" ]; then
314 xunit_output_end "$errorSource" "$errorMessage"
315 if ((printUsage != 0)); then
318 exit $EXIT_CODE_EXCEPTION
321 # Handle Ctrl-C. We will stop execution and print the results that
322 # we gathered so far.
323 function handle_ctrl_c {
324 local errorSource='handle_ctrl_c'
327 echo "*** Stopping... ***"
329 exit_with_error "$errorSource" "Test run aborted by Ctrl+C."
332 # Register the Ctrl-C handler
333 trap handle_ctrl_c INT
335 function create_core_overlay {
336 local errorSource='create_core_overlay'
339 if [ -n "$coreOverlayDir" ]; then
340 export CORE_ROOT="$coreOverlayDir"
342 if [ -n "$copyNativeTestBin" ]; then
343 copy_test_native_bin_to_test_root $coreOverlayDir
349 # Check inputs to make sure we have enough information to create the core layout. $testRootDir/Tests/Core_Root should
350 # already exist and contain test dependencies that are not built.
351 local testDependenciesDir=$testRootDir/Tests/Core_Root
352 if [ ! -d "$testDependenciesDir" ]; then
353 exit_with_error "$errorSource" "Did not find the test dependencies directory: $testDependenciesDir"
355 if [ -z "$coreClrBinDir" ]; then
356 exit_with_error "$errorSource" "One of --coreOverlayDir or --coreClrBinDir must be specified." "$printUsage"
358 if [ ! -d "$coreClrBinDir" ]; then
359 exit_with_error "$errorSource" "Directory specified by --coreClrBinDir does not exist: $coreClrBinDir"
361 if [ -z "$coreFxBinDir" ]; then
362 exit_with_error "$errorSource" "One of --coreOverlayDir or --coreFxBinDir must be specified." "$printUsage"
366 coreOverlayDir=$testRootDir/Tests/coreoverlay
367 export CORE_ROOT="$coreOverlayDir"
368 if [ -e "$coreOverlayDir" ]; then
369 rm -f -r "$coreOverlayDir"
371 mkdir "$coreOverlayDir"
373 cp -f -v "$coreFxBinDir/"* "$coreOverlayDir/" 2>/dev/null
374 cp -f -p -v "$coreClrBinDir/"* "$coreOverlayDir/" 2>/dev/null
375 if [ -d "$mscorlibDir/bin" ]; then
376 cp -f -v "$mscorlibDir/bin/"* "$coreOverlayDir/" 2>/dev/null
378 cp -f -v "$testDependenciesDir/"xunit* "$coreOverlayDir/" 2>/dev/null
379 cp -n -v "$testDependenciesDir/"* "$coreOverlayDir/" 2>/dev/null
380 if [ -f "$coreOverlayDir/mscorlib.ni.dll" ]; then
381 # Test dependencies come from a Windows build, and mscorlib.ni.dll would be the one from Windows
382 rm -f "$coreOverlayDir/mscorlib.ni.dll"
384 if [ -f "$coreOverlayDir/System.Private.CoreLib.ni.dll" ]; then
385 # Test dependencies come from a Windows build, and System.Private.CoreLib.ni.dll would be the one from Windows
386 rm -f "$coreOverlayDir/System.Private.CoreLib.ni.dll"
388 copy_test_native_bin_to_test_root $coreOverlayDir
391 declare -a skipCrossGenFiles
393 function is_skip_crossgen_test {
394 for skip in "${skipCrossGenFiles[@]}"; do
395 if [ "$1" == "$skip" ]; then
402 function precompile_overlay_assemblies {
403 skipCrossGenFiles=($(read_array "$(dirname "$0")/skipCrossGenFiles.$ARCH.txt"))
405 if [ $doCrossgen == 1 ]; then
406 local overlayDir=$CORE_ROOT
408 filesToPrecompile=$(find -L $overlayDir -iname \*.dll -not -iname \*.ni.dll -not -iname \*-ms-win-\* -type f )
409 for fileToPrecompile in ${filesToPrecompile}
411 local filename=${fileToPrecompile}
412 if [ $jitdisasm == 1 ]; then
413 $overlayDir/corerun $overlayDir/jit-dasm.dll --crossgen $overlayDir/crossgen --platform $overlayDir --output $testRootDir/dasm $filename
415 if [ $exitCode != 0 ]; then
416 echo Unable to generate dasm for $filename
419 if is_skip_crossgen_test "$(basename $filename)"; then
422 echo Precompiling $filename
423 $overlayDir/crossgen /Platform_Assemblies_Paths $overlayDir $filename 1> $filename.stdout 2>$filename.stderr
425 if [[ $exitCode != 0 ]]; then
426 if grep -q -e '0x80131018' $filename.stderr; then
427 printf "\n\t$filename is not a managed assembly.\n\n"
429 echo Unable to precompile $filename.
435 rm $filename.{stdout,stderr}
440 echo Skipping crossgen of FX assemblies.
444 function copy_test_native_bin_to_test_root {
445 local errorSource='copy_test_native_bin_to_test_root'
448 if [ -z "$testNativeBinDir" ]; then
449 exit_with_error "$errorSource" "--testNativeBinDir is required."
451 testNativeBinDir=$testNativeBinDir/src
452 if [ ! -d "$testNativeBinDir" ]; then
453 exit_with_error "$errorSource" "Directory specified by --testNativeBinDir does not exist: $testNativeBinDir"
456 # Copy native test components from the native test build into the respective test directory in the test root directory
457 find "$testNativeBinDir" -type f -iname "*.$libExtension" |
458 while IFS='' read -r filePath || [ -n "$filePath" ]; do
459 local dirPath=$(dirname "$filePath")
460 cp -f "$filePath" "$coreRootDir"
464 # Variables for unsupported and failing tests
465 declare -a unsupportedTests
466 declare -a failingTests
467 declare -a playlistTests
468 ((runFailingTestsOnly = 0))
470 # Get an array of items by reading the specified file line by line.
471 function read_array {
474 # bash in Mac OS X doesn't support 'readarray', so using alternate way instead.
475 # readarray -t theArray < "$1"
476 while IFS='' read -r line || [ -n "$line" ]; do
477 theArray[${#theArray[@]}]=$line
482 function load_unsupported_tests {
483 # Load the list of tests that are not supported on this platform. These tests are disabled (skipped) permanently.
484 unsupportedTests=($(read_array "$(dirname "$0")/testsUnsupportedOutsideWindows.txt"))
485 if [ "$ARCH" == "arm" ]; then
486 unsupportedTests+=($(read_array "$(dirname "$0")/testsUnsupportedOnARM32.txt"))
490 function load_failing_tests {
491 # Load the list of tests that fail on this platform. These tests are disabled (skipped) temporarily, pending investigation.
492 failingTests=($(read_array "$(dirname "$0")/testsFailingOutsideWindows.txt"))
494 if [ "$ARCH" == "arm64" ]; then
495 failingTests+=($(read_array "$(dirname "$0")/testsFailingOnArm64.txt"))
499 function load_playlist_tests {
500 # Load the list of tests that are enabled as a part of this test playlist.
501 playlistTests=($(read_array "${playlistFile}"))
504 function is_unsupported_test {
505 for unsupportedTest in "${unsupportedTests[@]}"; do
506 if [ "$1" == "$unsupportedTest" ]; then
513 function is_failing_test {
514 for failingTest in "${failingTests[@]}"; do
515 if [ "$1" == "$failingTest" ]; then
522 function is_playlist_test {
523 for playlistTest in "${playlistTests[@]}"; do
524 if [ "$1" == "$playlistTest" ]; then
531 function skip_unsupported_test {
532 # This function runs in a background process. It should not echo anything, and should not use global variables. This
533 # function is analogous to run_test, and causes the test to be skipped with the message below.
535 local scriptFilePath=$1
536 local outputFilePath=$2
538 echo "Not supported on this platform." >"$outputFilePath"
539 return 2 # skip the test
542 function skip_failing_test {
543 # This function runs in a background process. It should not echo anything, and should not use global variables. This
544 # function is analogous to run_test, and causes the test to be skipped with the message below.
546 local scriptFilePath=$1
547 local outputFilePath=$2
549 echo "Temporarily disabled on this platform due to unexpected failures." >"$outputFilePath"
550 return 2 # skip the test
553 function skip_non_playlist_test {
554 # This function runs in a background process. It should not echo anything, and should not use global variables. This
555 # function is analogous to run_test, and causes the test to be skipped with the message below.
557 local scriptFilePath=$1
558 local outputFilePath=$2
560 echo "Test is not included in the running playlist." >"$outputFilePath"
561 return 2 # skip the test
564 function set_up_core_dump_generation {
565 # We will only enable dump generation here if we're on Mac or Linux
566 if [[ ! ( "$(uname -s)" == "Darwin" || "$(uname -s)" == "Linux" ) ]]; then
570 # We won't enable dump generation on OS X/macOS if the machine hasn't been
571 # configured with the kern.corefile pattern we expect.
572 if [[ ( "$(uname -s)" == "Darwin" && "$(sysctl -n kern.corefile)" != "core.%P" ) ]]; then
573 echo "WARNING: Core dump generation not being enabled due to unexpected kern.corefile value."
577 # Allow dump generation
580 if [ "$(uname -s)" == "Linux" ]; then
581 if [ -e /proc/self/coredump_filter ]; then
582 # Include memory in private and shared file-backed mappings in the dump.
583 # This ensures that we can see disassembly from our shared libraries when
584 # inspecting the contents of the dump. See 'man core' for details.
585 echo 0x3F > /proc/self/coredump_filter
590 function print_info_from_core_file {
593 if [ "$ARCH" == "arm64" ]; then
594 echo "Not inspecting core dumps on arm64 at the moment."
599 local core_file_name=$1
600 local executable_name=$2
602 if ! [ -e $executable_name ]; then
603 echo "Unable to find executable $executable_name"
605 elif ! [ -e $core_file_name ]; then
606 echo "Unable to find core file $core_file_name"
610 # Use LLDB to inspect the core dump on Mac, and GDB everywhere else.
611 if [[ "$OSName" == "Darwin" ]]; then
612 hash lldb 2>/dev/null || { echo >&2 "LLDB was not found. Unable to print core file."; return; }
614 echo "Printing info from core file $core_file_name"
615 lldb -c $core_file_name -b -o 'bt'
617 # Use GDB to print the backtrace from the core file.
618 hash gdb 2>/dev/null || { echo >&2 "GDB was not found. Unable to print core file."; return; }
620 echo "Printing info from core file $core_file_name"
621 gdb --batch -ex "thread apply all bt full" -ex "quit" $executable_name $core_file_name
625 function download_dumpling_script {
626 echo "Downloading latest version of dumpling script."
627 wget "https://dumpling.azurewebsites.net/api/client/dumpling.py"
629 local dumpling_script="dumpling.py"
630 chmod +x $dumpling_script
633 function upload_core_file_to_dumpling {
634 local core_file_name=$1
635 local dumpling_script="dumpling.py"
636 local dumpling_file="local_dumplings.txt"
638 # dumpling requires that the file exist before appending.
639 touch ./$dumpling_file
641 if [ ! -x $dumpling_script ]; then
642 download_dumpling_script
645 if [ ! -x $dumpling_script ]; then
646 echo "Failed to download dumpling script. Dump cannot be uploaded."
650 echo "Uploading $core_file_name to dumpling service."
652 local paths_to_add=""
653 if [ -d "$coreClrBinDir" ]; then
654 echo "Uploading CoreCLR binaries with dump."
655 paths_to_add=$coreClrBinDir
658 # Ensure the script has Unix line endings
659 perl -pi -e 's/\r\n|\n|\r/\n/g' "$dumpling_script"
661 # The output from this will include a unique ID for this dump.
662 ./$dumpling_script "upload" "--dumppath" "$core_file_name" "--incpaths" $paths_to_add "--properties" "Project=CoreCLR" "--squelch" | tee -a $dumpling_file
665 function preserve_core_file {
666 local core_file_name=$1
667 local storage_location="/tmp/coredumps_coreclr"
669 # Create the directory (this shouldn't fail even if it already exists).
670 mkdir -p $storage_location
672 # Only preserve the dump if the directory is empty. Otherwise, do nothing.
673 # This is a way to prevent us from storing/uploading too many dumps.
674 if [ ! "$(ls -A $storage_location)" ]; then
675 echo "Copying core file $core_file_name to $storage_location"
676 cp $core_file_name $storage_location
678 upload_core_file_to_dumpling $core_file_name
682 function inspect_and_delete_core_files {
683 # This function prints some basic information from core files in the current
684 # directory and deletes them immediately. Based on the state of the system, it may
685 # also upload a core file to the dumpling service.
686 # (see preserve_core_file).
688 # Depending on distro/configuration, the core files may either be named "core"
689 # or "core.<PID>" by default. We will read /proc/sys/kernel/core_uses_pid to
690 # determine which one it is.
691 # On OS X/macOS, we checked the kern.corefile value before enabling core dump
692 # generation, so we know it always includes the PID.
693 local core_name_uses_pid=0
694 if [[ (( -e /proc/sys/kernel/core_uses_pid ) && ( "1" == $(cat /proc/sys/kernel/core_uses_pid) ))
695 || ( "$(uname -s)" == "Darwin" ) ]]; then
699 if [ $core_name_uses_pid == "1" ]; then
700 # We don't know what the PID of the process was, so let's look at all core
701 # files whose name matches core.NUMBER
703 [[ $f =~ core.[0-9]+ ]] && print_info_from_core_file "$f" $CORE_ROOT/"corerun" && preserve_core_file "$f" && rm "$f"
705 elif [ -f core ]; then
706 print_info_from_core_file "core" $CORE_ROOT/"corerun"
707 preserve_core_file "core"
713 # This function runs in a background process. It should not echo anything, and should not use global variables.
715 local scriptFilePath=$1
716 local outputFilePath=$2
718 # Switch to directory where the script is
719 cd "$(dirname "$scriptFilePath")"
721 local scriptFileName=$(basename "$scriptFilePath")
722 local outputFileName=$(basename "$outputFilePath")
724 if [ "$limitedCoreDumps" == "ON" ]; then
725 set_up_core_dump_generation
728 "./$scriptFileName" >"$outputFileName" 2>&1
729 local testScriptExitCode=$?
731 # We will try to print some information from generated core dumps if a debugger
732 # is available, and possibly store a dump in a non-transient location.
733 if [ "$limitedCoreDumps" == "ON" ]; then
734 inspect_and_delete_core_files
737 return $testScriptExitCode
740 # Variables for running tests in the background
741 if [ `uname` = "NetBSD" ]; then
742 NumProc=$(getconf NPROCESSORS_ONLN)
743 elif [ `uname` = "Darwin" ]; then
744 NumProc=$(getconf _NPROCESSORS_ONLN)
746 if [ -x "$(command -v nproc)" ]; then
747 NumProc=$(nproc --all)
748 elif [ -x "$(command -v getconf)" ]; then
749 NumProc=$(getconf _NPROCESSORS_ONLN)
754 ((maxProcesses = $NumProc * 3 / 2)) # long tests delay process creation, use a few more processors
757 declare -a scriptFilePaths
758 declare -a outputFilePaths
759 declare -a processIds
760 declare -a testStartTimes
768 for (( i=0; i<$maxProcesses; i++ )); do
769 pid=${processIds[$i]}
770 if [ -z "$pid" ] || [ "$pid" == "$pidNone" ]; then
773 if ! kill -0 $pid 2>/dev/null; then
777 processIds[$i]=$pidNone
785 function get_available_process_index {
788 for (( i=0; i<$maxProcesses; i++ )); do
789 pid=${processIds[$i]}
790 if [ -z "$pid" ] || [ "$pid" == "$pidNone" ]; then
797 function finish_test {
799 local testScriptExitCode=$?
800 local finishedProcessIndex=$waitProcessIndex
803 local scriptFilePath=${scriptFilePaths[$finishedProcessIndex]}
804 local outputFilePath=${outputFilePaths[$finishedProcessIndex]}
805 local scriptFileName=$(basename "$scriptFilePath")
808 local testRunningTime=
811 if ((verbose == 1)); then
812 header=$(printf "[%4d]" $countTotalTests)
815 if [ "$showTime" == "ON" ]; then
816 testEndTime=$(date +%s)
817 testRunningTime=$(( $testEndTime - ${testStartTimes[$finishedProcessIndex]} ))
818 header=$header$(printf "[%4ds]" $testRunningTime)
821 local xunitTestResult
822 case $testScriptExitCode in
824 let countPassedTests++
825 xunitTestResult='Pass'
826 if ((verbose == 1 || runFailingTestsOnly == 1)); then
827 echo "PASSED - ${header}${scriptFilePath}"
829 echo " - ${header}${scriptFilePath}"
833 let countSkippedTests++
834 xunitTestResult='Skip'
835 echo "SKIPPED - ${header}${scriptFilePath}"
838 let countFailedTests++
839 xunitTestResult='Fail'
840 echo "FAILED - ${header}${scriptFilePath}"
843 let countTotalTests++
845 if ((verbose == 1 || testScriptExitCode != 0)); then
846 while IFS='' read -r line || [ -n "$line" ]; do
848 done <"$outputFilePath"
851 xunit_output_add_test "$scriptFilePath" "$outputFilePath" "$xunitTestResult" "$testScriptExitCode" "$testRunningTime"
854 function finish_remaining_tests {
855 # Finish the remaining tests in the order in which they were started
856 while ((processCount > 0)); do
862 local scriptFilePath=$1
863 local scriptFileDir=$(dirname "$scriptFilePath")
865 test "$verbose" == 1 && echo "Preparing $scriptFilePath"
867 if [ ! "$noLFConversion" == "ON" ]; then
868 # Convert DOS line endings to Unix if needed
869 perl -pi -e 's/\r\n|\n|\r/\n/g' "$scriptFilePath"
872 # Add executable file mode bit if needed
873 chmod +x "$scriptFilePath"
875 #remove any NI and Locks
876 rm -f $scriptFileDir/*.ni.*
877 rm -rf $scriptFileDir/lock
880 function start_test {
881 local nextProcessIndex=$(get_available_process_index)
882 local scriptFilePath=$1
883 if ((runFailingTestsOnly == 1)) && ! is_failing_test "$scriptFilePath"; then
887 # Skip any test that's not in the current playlist, if a playlist was
889 if [ -n "$playlistFile" ] && ! is_playlist_test "$scriptFilePath"; then
893 if ((nextProcessIndex == maxProcesses)); then
895 nextProcessIndex=$(get_available_process_index)
898 scriptFilePaths[$nextProcessIndex]=$scriptFilePath
899 local scriptFileName=$(basename "$scriptFilePath")
900 local outputFilePath=$(dirname "$scriptFilePath")/${scriptFileName}.out
901 outputFilePaths[$nextProcessIndex]=$outputFilePath
903 if [ "$showTime" == "ON" ]; then
904 testStartTimes[$nextProcessIndex]=$(date +%s)
907 test "$verbose" == 1 && echo "Starting $scriptFilePath"
908 if is_unsupported_test "$scriptFilePath"; then
909 skip_unsupported_test "$scriptFilePath" "$outputFilePath" &
910 elif ((runFailingTestsOnly == 0)) && is_failing_test "$scriptFilePath"; then
911 skip_failing_test "$scriptFilePath" "$outputFilePath" &
913 run_test "$scriptFilePath" "$outputFilePath" &
915 processIds[$nextProcessIndex]=$!
920 # Get a list of directories in which to scan for tests by reading the
921 # specified file line by line.
922 function set_test_directories {
923 local errorSource='set_test_directories'
925 local listFileName=$1
927 if [ ! -f "$listFileName" ]
929 exit_with_error "$errorSource" "Test directories file not found at $listFileName"
931 testDirectories=($(read_array "$listFileName"))
934 function run_tests_in_directory {
937 # Recursively search through directories for .sh files to prepare them.
938 # Note: This needs to occur before any test runs as some of the .sh files
939 # depend on other .sh files
940 for scriptFilePath in $(find "$testDir" -type f -iname '*.sh' | sort)
942 prep_test "${scriptFilePath:2}"
944 echo "The tests have been prepared"
945 # Recursively search through directories for .sh files to run.
946 for scriptFilePath in $(find "$testDir" -type f -iname '*.sh' | sort)
948 start_test "${scriptFilePath:2}"
952 function coreclr_code_coverage {
953 local coverageDir="$coverageOutputDir/Coverage"
954 local toolsDir="$coverageOutputDir/Coverage/tools"
955 local reportsDir="$coverageOutputDir/Coverage/reports"
956 local packageName="unix-code-coverage-tools.1.0.0.nupkg"
959 mkdir -p $coverageDir
962 pushd $toolsDir > /dev/null
964 echo "Pulling down code coverage tools"
965 wget -q https://www.myget.org/F/dotnet-buildtools/api/v2/package/unix-code-coverage-tools/1.0.0 -O $packageName
966 echo "Unzipping to $toolsDir"
967 unzip -q -o $packageName
971 chmod a+rwx ./$OSName/llvm-cov
974 echo "Generating coreclr code coverage reports at $reportsDir/coreclr.html"
975 echo "./gcovr $coreClrObjs --gcov-executable=$toolsDir/$OS/llvm-cov -r $coreClrSrc --html --html-details -o $reportsDir/coreclr.html"
977 ./gcovr $coreClrObjs --gcov-executable=$toolsDir/$OSName/llvm-cov -r $coreClrSrc --html --html-details -o $reportsDir/coreclr.html
983 function check_cpu_architecture {
984 local CPUName=$(uname -m)
1001 echo "Unknown CPU $CPUName detected, configuring as if for x64"
1009 ARCH=$(check_cpu_architecture)
1010 echo "Running on CPU- $ARCH"
1012 # Exit code constants
1013 readonly EXIT_CODE_SUCCESS=0 # Script ran normally.
1014 readonly EXIT_CODE_EXCEPTION=1 # Script exited because something exceptional happened (e.g. bad arguments, Ctrl-C interrupt).
1015 readonly EXIT_CODE_TEST_FAILURE=2 # Script completed successfully, but one or more tests failed.
1017 # Argument variables
1036 ((disableEventLogging = 0))
1050 exit $EXIT_CODE_SUCCESS
1059 export COMPlus_JitStress=${i#*=}
1062 export COMPlus_JitStressRegs=${i#*=}
1065 export COMPlus_JITMinOpts=1
1067 --copyNativeTestBin)
1068 export copyNativeTestBin=1
1071 export COMPlus_ForceRelocs=1
1074 export ILLINK=${i#*=}
1077 --tieredcompilation)
1078 export COMPlus_EXPERIMENTAL_TieredCompilation=1
1084 ((ilasmroundtrip = 1))
1089 --testNativeBinDir=*)
1090 testNativeBinDir=${i#*=}
1093 coreOverlayDir=${i#*=}
1096 coreClrBinDir=${i#*=}
1102 coreFxBinDir=${i#*=}
1105 testDirectories[${#testDirectories[@]}]=${i#*=}
1108 set_test_directories "${i#*=}"
1110 --runFailingTestsOnly)
1111 ((runFailingTestsOnly = 1))
1113 --disableEventLogging)
1114 ((disableEventLogging = 1))
1117 export RunCrossGen=1
1120 ((maxProcesses = 1))
1132 playlistFile=${i#*=}
1143 --coverage-output-dir=*)
1144 coverageOutputDir=${i#*=}
1150 export COMPlus_GCStress=${i#*=}
1153 export COMPlus_GCName=${i#*=}
1161 --build-overlay-only)
1164 --limitedDumpGeneration)
1167 --xunitOutputPath=*)
1168 xunitOutputPath=${i#*=}
1171 echo "Unknown switch: $i"
1173 exit $EXIT_CODE_SUCCESS
1178 if [ -n "$coreOverlayDir" ] && [ "$buildOverlayOnly" == "ON" ]; then
1179 echo "Can not use \'--coreOverlayDir=<path>\' and \'--build-overlay-only\' at the same time."
1180 exit $EXIT_CODE_EXCEPTION
1183 if ((disableEventLogging == 0)); then
1184 export COMPlus_EnableEventLog=1
1187 export CORECLR_SERVER_GC="$serverGC"
1189 if [ -z "$testRootDir" ]; then
1190 echo "--testRootDir is required."
1192 exit $EXIT_CODE_EXCEPTION
1194 if [ ! -d "$testRootDir" ]; then
1195 echo "Directory specified by --testRootDir does not exist: $testRootDir"
1196 exit $EXIT_CODE_EXCEPTION
1199 # Copy native interop test libraries over to the mscorlib path in
1200 # order for interop tests to run on linux.
1201 if [ -z "$mscorlibDir" ]; then
1202 mscorlibDir=$coreClrBinDir
1205 if [ ! -z "$longgc" ]; then
1206 echo "Running Long GC tests"
1207 export RunningLongGCTests=1
1210 if [ ! -z "$gcsimulator" ]; then
1211 echo "Running GC simulator tests"
1212 export RunningGCSimulatorTests=1
1215 if [[ ! "$jitdisasm" -eq 0 ]]; then
1216 echo "Running jit disasm"
1217 export RunningJitDisasm=1
1220 if [ ! -z "$ilasmroundtrip" ]; then
1221 echo "Running Ilasm round trip"
1222 export RunningIlasmRoundTrip=1
1225 # If this is a coverage run, make sure the appropriate args have been passed
1226 if [ "$CoreClrCoverage" == "ON" ]
1228 echo "Code coverage is enabled for this run"
1230 if [ ! "$OSName" == "Darwin" ] && [ ! "$OSName" == "Linux" ]
1232 echo "Code Coverage not supported on $OS"
1236 if [ -z "$coreClrObjs" ]
1238 echo "Coreclr obj files are required to generate code coverage reports"
1239 echo "Coreclr obj files root path can be passed using '--coreclr-obj' argument"
1243 if [ -z "$coreClrSrc" ]
1245 echo "Coreclr src files are required to generate code coverage reports"
1246 echo "Coreclr src files root path can be passed using '--coreclr-src' argument"
1250 if [ -z "$coverageOutputDir" ]
1252 echo "Output directory for coverage results must be specified"
1253 echo "Output path can be specified '--coverage-output-dir' argument"
1260 precompile_overlay_assemblies
1262 if [ "$buildOverlayOnly" == "ON" ];
1264 echo "Build overlay directory '$coreOverlayDir' complete."
1268 if [ -n "$playlistFile" ]
1270 # Use a playlist file exclusively, if it was provided
1271 echo "Executing playlist $playlistFile"
1274 load_unsupported_tests
1278 # Other architectures are not supported yet.
1279 if [ "$ARCH" == "x64" ]
1281 scriptPath=$(dirname $0)
1282 ${scriptPath}/setup-stress-dependencies.sh --outputDir=$coreOverlayDir
1284 if [ "$ARCH" != "arm64" ]
1286 echo "Skip preparing for GC stress test. Dependent package is not supported on this architecture."
1290 export __TestEnv=$testEnv
1294 dumplingsListPath="$testRootDir/dumplings.txt"
1296 # clean up any existing dumpling remnants from previous runs.
1297 rm -f "$dumplingsListPath"
1298 find $testRootDir -type f -name "local_dumplings.txt" -exec rm {} \;
1300 time_start=$(date +"%s")
1301 if [ -z "$testDirectories" ]
1303 # No test directories were specified, so run everything in the current
1304 # directory and its subdirectories.
1305 run_tests_in_directory "."
1307 # Otherwise, run all the tests in each specified test directory.
1308 for testDir in "${testDirectories[@]}"
1310 if [ ! -d "$testDir" ]; then
1311 echo "Test directory does not exist: $testDir"
1313 run_tests_in_directory "./$testDir"
1317 finish_remaining_tests
1321 find $testRootDir -type f -name "local_dumplings.txt" -exec cat {} \; > $dumplingsListPath
1323 if [ -s $dumplingsListPath ]; then
1324 cat $dumplingsListPath
1326 rm $dumplingsListPath
1329 time_end=$(date +"%s")
1330 time_diff=$(($time_end-$time_start))
1331 echo "$(($time_diff / 60)) minutes and $(($time_diff % 60)) seconds taken to run CoreCLR tests."
1335 if [ "$CoreClrCoverage" == "ON" ]
1337 coreclr_code_coverage
1340 if ((countFailedTests > 0)); then
1341 exit $EXIT_CODE_TEST_FAILURE
1344 exit $EXIT_CODE_SUCCESS