xref: /kvm-unit-tests/scripts/runtime.bash (revision d9de80518112e083dfe412546e422c4e044c31d9)
1: "${RUNTIME_arch_run?}"
2: ${MAX_SMP:=$(getconf _NPROCESSORS_ONLN)}
3: ${TIMEOUT:=90s}
4
5PASS() { echo -ne "\e[32mPASS\e[0m"; }
6SKIP() { echo -ne "\e[33mSKIP\e[0m"; }
7FAIL() { echo -ne "\e[31mFAIL\e[0m"; }
8
9extract_summary()
10{
11    local cr=$'\r'
12    tail -3 | grep '^SUMMARY: ' | sed 's/^SUMMARY: /(/;s/'"$cr"'\{0,1\}$/)/'
13}
14
15# We assume that QEMU is going to work if it tried to load the kernel
16premature_failure()
17{
18    local log="$(eval $(get_cmdline _NO_FILE_4Uhere_) 2>&1)"
19
20    echo "$log" | grep "_NO_FILE_4Uhere_" |
21        grep -q -e "could not \(load\|open\) kernel" -e "error loading" &&
22        return 1
23
24    RUNTIME_log_stderr <<< "$log"
25
26    echo "$log"
27    return 0
28}
29
30get_cmdline()
31{
32    local kernel=$1
33    echo "TESTNAME=$testname TIMEOUT=$timeout ACCEL=$accel $RUNTIME_arch_run $kernel -smp $smp $opts"
34}
35
36skip_nodefault()
37{
38    [ "$run_all_tests" = "yes" ] && return 1
39    [ "$KUT_STANDALONE" != "yes" ] && return 0
40
41    while true; do
42        read -r -p "Test marked not to be run by default, are you sure (y/N)? " yn
43        case $yn in
44            "Y" | "y" | "Yes" | "yes")
45                return 1
46                ;;
47            "" | "N" | "n" | "No" | "no" | "q" | "quit" | "exit")
48                return 0
49                ;;
50        esac
51    done
52}
53
54function print_result()
55{
56    local status="$1"
57    local testname="$2"
58    local summary="$3"
59    local reason="$4"
60
61    if [ -z "$reason" ]; then
62        echo "`$status` $testname $summary"
63    else
64        echo "`$status` $testname ($reason)"
65    fi
66}
67
68function find_word()
69{
70    grep -Fq " $1 " <<< " $2 "
71}
72
73function run()
74{
75    local testname="$1"
76    local groups="$2"
77    local smp="$3"
78    local kernel="$4"
79    local opts="$5"
80    local arch="$6"
81    local check="${CHECK:-$7}"
82    local accel="$8"
83    local timeout="${9:-$TIMEOUT}" # unittests.cfg overrides the default
84
85    if [ "${CONFIG_EFI}" == "y" ]; then
86        kernel=$(basename $kernel .flat)
87    fi
88
89    if [ -z "$testname" ]; then
90        return
91    fi
92
93    if [ -n "$only_tests" ] && ! find_word "$testname" "$only_tests"; then
94        return
95    fi
96
97    if [ -n "$only_group" ] && ! find_word "$only_group" "$groups"; then
98        return
99    fi
100
101    if [ -z "$only_group" ] && find_word nodefault "$groups" &&
102            skip_nodefault; then
103        print_result "SKIP" $testname "" "test marked as manual run only"
104        return;
105    fi
106
107    if [ -n "$arch" ] && [ "$arch" != "$ARCH" ]; then
108        print_result "SKIP" $testname "" "$arch only"
109        return 2
110    fi
111
112    if [ -n "$accel" ] && [ -n "$ACCEL" ] && [ "$accel" != "$ACCEL" ]; then
113        print_result "SKIP" $testname "" "$accel only, but ACCEL=$ACCEL"
114        return 2
115    elif [ -n "$ACCEL" ]; then
116        accel="$ACCEL"
117    fi
118
119    # check a file for a particular value before running a test
120    # the check line can contain multiple files to check separated by a space
121    # but each check parameter needs to be of the form <path>=<value>
122    if [ "$check" ]; then
123        for check_param in "${check[@]}"; do
124            path=${check_param%%=*}
125            value=${check_param#*=}
126            if ! [ -f "$path" ] || [ "$(cat $path)" != "$value" ]; then
127                print_result "SKIP" $testname "" "$path not equal to $value"
128                return 2
129            fi
130        done
131    fi
132
133    log=$(premature_failure) && {
134        skip=true
135        if [ "${CONFIG_EFI}" == "y" ]; then
136            if [ "$ARCH" == "x86_64" ] &&
137               [[ "$(tail -1 <<<"$log")" =~ "Dummy Hello World!" ]]; then
138                   skip=false
139            elif [ "$ARCH" == "arm64" ] &&
140               [[ "$(tail -2 <<<"$log" | head -1)" =~ "Dummy Hello World!" ]]; then
141                   skip=false
142            fi
143        fi
144
145        if [ ${skip} == true ]; then
146            print_result "SKIP" $testname "" "$last_line"
147            return 77
148        fi
149    }
150
151    cmdline=$(get_cmdline $kernel)
152    if find_word "migration" "$groups"; then
153        cmdline="MIGRATION=yes $cmdline"
154    fi
155    if find_word "panic" "$groups"; then
156        cmdline="PANIC=yes $cmdline"
157    fi
158    if [ "$verbose" = "yes" ]; then
159        echo $cmdline
160    fi
161
162    # extra_params in the config file may contain backticks that need to be
163    # expanded, so use eval to start qemu.  Use "> >(foo)" instead of a pipe to
164    # preserve the exit status.
165    summary=$(eval $cmdline 2> >(RUNTIME_log_stderr $testname) \
166                             > >(tee >(RUNTIME_log_stdout $testname $kernel) | extract_summary))
167    ret=$?
168    [ "$KUT_STANDALONE" != "yes" ] && echo > >(RUNTIME_log_stdout $testname $kernel)
169
170    if [ $ret -eq 0 ]; then
171        print_result "PASS" $testname "$summary"
172    elif [ $ret -eq 77 ]; then
173        print_result "SKIP" $testname "$summary"
174    elif [ $ret -eq 124 ]; then
175        print_result "FAIL" $testname "" "timeout; duration=$timeout"
176        if [ "$tap_output" = "yes" ]; then
177            echo "not ok TEST_NUMBER - ${testname}: timeout; duration=$timeout" >&3
178        fi
179    elif [ $ret -gt 127 ]; then
180        signame="SIG"$(kill -l $(($ret - 128)))
181        print_result "FAIL" $testname "" "terminated on $signame"
182        if [ "$tap_output" = "yes" ]; then
183            echo "not ok TEST_NUMBER - ${testname}: terminated on $signame" >&3
184        fi
185    elif [ $ret -eq 127 ] && [ "$tap_output" = "yes" ]; then
186        echo "not ok TEST_NUMBER - ${testname}: aborted" >&3
187    else
188        print_result "FAIL" $testname "$summary"
189    fi
190
191    return $ret
192}
193
194#
195# Probe for MAX_SMP, in case it's less than the number of host cpus.
196#
197# This probing currently only works for ARM, as x86 bails on another
198# error first, so this check is only run for ARM and ARM64. The
199# parameter expansion takes the last number from the QEMU error
200# message, which gives the allowable MAX_SMP.
201if [[ $ARCH == 'arm' || $ARCH == 'arm64' ]] &&
202   smp=$($RUNTIME_arch_run _NO_FILE_4Uhere_ -smp $MAX_SMP |& grep 'exceeds max CPUs'); then
203	smp=${smp##*(}
204	MAX_SMP=${smp:0:-1}
205fi
206