third_party/mbedtls/repo/tests/scripts/basic-build-test.sh

   1 #!/bin/sh
   2
   3 # basic-build-tests.sh
   4 #
   5 # This file is part of mbed TLS (https://tls.mbed.org)
   6 #
   7 # Copyright (c) 2016, ARM Limited, All Rights Reserved
   8 #
   9 # Purpose
  10 #
  11 # Executes the basic test suites, captures the results, and generates a simple
  12 # test report and code coverage report.
  13 #
  14 # The tests include:
  15 #   * Unit tests                - executed using tests/scripts/run-test-suite.pl
  16 #   * Self-tests                - executed using the test suites above
  17 #   * System tests              - executed using tests/ssl-opt.sh
  18 #   * Interoperability tests    - executed using tests/compat.sh
  19 #
  20 # The tests focus on functionality and do not consider performance.
  21 #
  22 # Note the tests self-adapt due to configurations in include/mbedtls/config.h
  23 # which can lead to some tests being skipped, and can cause the number of
  24 # available tests to fluctuate.
  25 #
  26 # This script has been written to be generic and should work on any shell.
  27 #
  28 # Usage: basic-build-tests.sh
  29 #
  30
  31 # Abort on errors (and uninitiliased variables)
  32 set -eu
  33
  34 if [ -d library -a -d include -a -d tests ]; then :; else
  35     echo "Must be run from mbed TLS root" >&2
  36     exit 1
  37 fi
  38
  39 : ${OPENSSL:="openssl"}
  40 : ${OPENSSL_LEGACY:="$OPENSSL"}
  41 : ${GNUTLS_CLI:="gnutls-cli"}
  42 : ${GNUTLS_SERV:="gnutls-serv"}
  43 : ${GNUTLS_LEGACY_CLI:="$GNUTLS_CLI"}
  44 : ${GNUTLS_LEGACY_SERV:="$GNUTLS_SERV"}
  45
  46 # To avoid setting OpenSSL and GnuTLS for each call to compat.sh and ssl-opt.sh
  47 # we just export the variables they require
  48 export OPENSSL_CMD="$OPENSSL"
  49 export GNUTLS_CLI="$GNUTLS_CLI"
  50 export GNUTLS_SERV="$GNUTLS_SERV"
  51
  52 CONFIG_H='include/mbedtls/config.h'
  53 CONFIG_BAK="$CONFIG_H.bak"
  54
  55 # Step 0 - print build environment info
  56 OPENSSL="$OPENSSL"                           \
  57     OPENSSL_LEGACY="$OPENSSL_LEGACY"         \
  58     GNUTLS_CLI="$GNUTLS_CLI"                 \
  59     GNUTLS_SERV="$GNUTLS_SERV"               \
  60     GNUTLS_LEGACY_CLI="$GNUTLS_LEGACY_CLI"   \
  61     GNUTLS_LEGACY_SERV="$GNUTLS_LEGACY_SERV" \
  62     scripts/output_env.sh
  63 echo
  64
  65 # Step 1 - Make and instrumented build for code coverage
  66 export CFLAGS=' --coverage -g3 -O0 '
  67 make clean
  68 cp "$CONFIG_H" "$CONFIG_BAK"
  69 scripts/config.pl full
  70 scripts/config.pl unset MBEDTLS_MEMORY_BACKTRACE
  71 make -j
  72
  73
  74 # Step 2 - Execute the tests
  75 TEST_OUTPUT=out_${PPID}
  76 cd tests
  77 if [ ! -f "seedfile" ]; then
  78     dd if=/dev/urandom of="seedfile" bs=32 count=1
  79 fi
  80
  81 # Step 2a - Unit Tests
  82 perl scripts/run-test-suites.pl -v 2 |tee unit-test-$TEST_OUTPUT
  83 echo
  84
  85 # Step 2b - System Tests
  86 sh ssl-opt.sh |tee sys-test-$TEST_OUTPUT
  87 echo
  88
  89 # Step 2c - Compatibility tests
  90 sh compat.sh -m 'tls1 tls1_1 tls1_2 dtls1 dtls1_2' | \
  91     tee compat-test-$TEST_OUTPUT
  92 OPENSSL_CMD="$OPENSSL_LEGACY"                               \
  93     sh compat.sh -m 'ssl3' |tee -a compat-test-$TEST_OUTPUT
  94 OPENSSL_CMD="$OPENSSL_LEGACY"                                       \
  95     GNUTLS_CLI="$GNUTLS_LEGACY_CLI"                                 \
  96     GNUTLS_SERV="$GNUTLS_LEGACY_SERV"                               \
  97     sh compat.sh -e '^$' -f 'NULL\|DES\|RC4\|ARCFOUR' |             \
  98     tee -a compat-test-$TEST_OUTPUT
  99 OPENSSL_CMD="$OPENSSL_NEXT"                     \
 100     sh compat.sh -e '^$' -f 'ARIA\|CHACHA' |    \
 101     tee -a compat-test-$TEST_OUTPUT
 102 echo
 103
 104 # Step 3 - Process the coverage report
 105 cd ..
 106 make lcov |tee tests/cov-$TEST_OUTPUT
 107
 108
 109 # Step 4 - Summarise the test report
 110 echo
 111 echo "========================================================================="
 112 echo "Test Report Summary"
 113 echo
 114
 115 cd tests
 116
 117 # Step 4a - Unit tests
 118 echo "Unit tests - tests/scripts/run-test-suites.pl"
 119
 120 PASSED_TESTS=$(tail -n6 unit-test-$TEST_OUTPUT|sed -n -e 's/test cases passed :[\t]*\([0-9]*\)/\1/p'| tr -d ' ')
 121 SKIPPED_TESTS=$(tail -n6 unit-test-$TEST_OUTPUT|sed -n -e 's/skipped :[ \t]*\([0-9]*\)/\1/p'| tr -d ' ')
 122 TOTAL_SUITES=$(tail -n6 unit-test-$TEST_OUTPUT|sed -n -e 's/.* (\([0-9]*\) .*, [0-9]* tests run)/\1/p'| tr -d ' ')
 123 FAILED_TESTS=$(tail -n6 unit-test-$TEST_OUTPUT|sed -n -e 's/failed :[\t]*\([0-9]*\)/\1/p' |tr -d ' ')
 124
 125 echo "No test suites     : $TOTAL_SUITES"
 126 echo "Passed             : $PASSED_TESTS"
 127 echo "Failed             : $FAILED_TESTS"
 128 echo "Skipped            : $SKIPPED_TESTS"
 129 echo "Total exec'd tests : $(($PASSED_TESTS + $FAILED_TESTS))"
 130 echo "Total avail tests  : $(($PASSED_TESTS + $FAILED_TESTS + $SKIPPED_TESTS))"
 131 echo
 132
 133 TOTAL_PASS=$PASSED_TESTS
 134 TOTAL_FAIL=$FAILED_TESTS
 135 TOTAL_SKIP=$SKIPPED_TESTS
 136 TOTAL_AVAIL=$(($PASSED_TESTS + $FAILED_TESTS + $SKIPPED_TESTS))
 137 TOTAL_EXED=$(($PASSED_TESTS + $FAILED_TESTS))
 138
 139 # Step 4b - TLS Options tests
 140 echo "TLS Options tests - tests/ssl-opt.sh"
 141
 142 PASSED_TESTS=$(tail -n5 sys-test-$TEST_OUTPUT|sed -n -e 's/.* (\([0-9]*\) \/ [0-9]* tests ([0-9]* skipped))$/\1/p')
 143 SKIPPED_TESTS=$(tail -n5 sys-test-$TEST_OUTPUT|sed -n -e 's/.* ([0-9]* \/ [0-9]* tests (\([0-9]*\) skipped))$/\1/p')
 144 TOTAL_TESTS=$(tail -n5 sys-test-$TEST_OUTPUT|sed -n -e 's/.* ([0-9]* \/ \([0-9]*\) tests ([0-9]* skipped))$/\1/p')
 145 FAILED_TESTS=$(($TOTAL_TESTS - $PASSED_TESTS))
 146
 147 echo "Passed             : $PASSED_TESTS"
 148 echo "Failed             : $FAILED_TESTS"
 149 echo "Skipped            : $SKIPPED_TESTS"
 150 echo "Total exec'd tests : $TOTAL_TESTS"
 151 echo "Total avail tests  : $(($TOTAL_TESTS + $SKIPPED_TESTS))"
 152 echo
 153
 154 TOTAL_PASS=$(($TOTAL_PASS+$PASSED_TESTS))
 155 TOTAL_FAIL=$(($TOTAL_FAIL+$FAILED_TESTS))
 156 TOTAL_SKIP=$(($TOTAL_SKIP+$SKIPPED_TESTS))
 157 TOTAL_AVAIL=$(($TOTAL_AVAIL + $TOTAL_TESTS + $SKIPPED_TESTS))
 158 TOTAL_EXED=$(($TOTAL_EXED + $TOTAL_TESTS))
 159
 160
 161 # Step 4c - System Compatibility tests
 162 echo "System/Compatibility tests - tests/compat.sh"
 163
 164 PASSED_TESTS=$(cat compat-test-$TEST_OUTPUT | sed -n -e 's/.* (\([0-9]*\) \/ [0-9]* tests ([0-9]* skipped))$/\1/p' | awk 'BEGIN{ s = 0 } { s += $1 } END{ print s }')
 165 SKIPPED_TESTS=$(cat compat-test-$TEST_OUTPUT | sed -n -e 's/.* ([0-9]* \/ [0-9]* tests (\([0-9]*\) skipped))$/\1/p' | awk 'BEGIN{ s = 0 } { s += $1 } END{ print s }')
 166 EXED_TESTS=$(cat compat-test-$TEST_OUTPUT | sed -n -e 's/.* ([0-9]* \/ \([0-9]*\) tests ([0-9]* skipped))$/\1/p' | awk 'BEGIN{ s = 0 } { s += $1 } END{ print s }')
 167 FAILED_TESTS=$(($EXED_TESTS - $PASSED_TESTS))
 168
 169 echo "Passed             : $PASSED_TESTS"
 170 echo "Failed             : $FAILED_TESTS"
 171 echo "Skipped            : $SKIPPED_TESTS"
 172 echo "Total exec'd tests : $EXED_TESTS"
 173 echo "Total avail tests  : $(($EXED_TESTS + $SKIPPED_TESTS))"
 174 echo
 175
 176 TOTAL_PASS=$(($TOTAL_PASS+$PASSED_TESTS))
 177 TOTAL_FAIL=$(($TOTAL_FAIL+$FAILED_TESTS))
 178 TOTAL_SKIP=$(($TOTAL_SKIP+$SKIPPED_TESTS))
 179 TOTAL_AVAIL=$(($TOTAL_AVAIL + $EXED_TESTS + $SKIPPED_TESTS))
 180 TOTAL_EXED=$(($TOTAL_EXED + $EXED_TESTS))
 181
 182
 183 # Step 4d - Grand totals
 184 echo "-------------------------------------------------------------------------"
 185 echo "Total tests"
 186
 187 echo "Total Passed       : $TOTAL_PASS"
 188 echo "Total Failed       : $TOTAL_FAIL"
 189 echo "Total Skipped      : $TOTAL_SKIP"
 190 echo "Total exec'd tests : $TOTAL_EXED"
 191 echo "Total avail tests  : $TOTAL_AVAIL"
 192 echo
 193
 194
 195 # Step 4e - Coverage
 196 echo "Coverage"
 197
 198 LINES_TESTED=$(tail -n3 cov-$TEST_OUTPUT|sed -n -e 's/  lines......: [0-9]*.[0-9]% (\([0-9]*\) of [0-9]* lines)/\1/p')
 199 LINES_TOTAL=$(tail -n3 cov-$TEST_OUTPUT|sed -n -e 's/  lines......: [0-9]*.[0-9]% ([0-9]* of \([0-9]*\) lines)/\1/p')
 200 FUNCS_TESTED=$(tail -n3 cov-$TEST_OUTPUT|sed -n -e 's/  functions..: [0-9]*.[0-9]% (\([0-9]*\) of [0-9]* functions)$/\1/p')
 201 FUNCS_TOTAL=$(tail -n3 cov-$TEST_OUTPUT|sed -n -e 's/  functions..: [0-9]*.[0-9]% ([0-9]* of \([0-9]*\) functions)$/\1/p')
 202
 203 LINES_PERCENT=$((1000*$LINES_TESTED/$LINES_TOTAL))
 204 LINES_PERCENT="$(($LINES_PERCENT/10)).$(($LINES_PERCENT-($LINES_PERCENT/10)*10))"
 205
 206 FUNCS_PERCENT=$((1000*$FUNCS_TESTED/$FUNCS_TOTAL))
 207 FUNCS_PERCENT="$(($FUNCS_PERCENT/10)).$(($FUNCS_PERCENT-($FUNCS_PERCENT/10)*10))"
 208
 209 echo "Lines Tested       : $LINES_TESTED of $LINES_TOTAL $LINES_PERCENT%"
 210 echo "Functions Tested   : $FUNCS_TESTED of $FUNCS_TOTAL $FUNCS_PERCENT%"
 211 echo
 212
 213
 214 rm unit-test-$TEST_OUTPUT
 215 rm sys-test-$TEST_OUTPUT
 216 rm compat-test-$TEST_OUTPUT
 217 rm cov-$TEST_OUTPUT
 218
 219 cd ..
 220
 221 make clean
 222
 223 if [ -f "$CONFIG_BAK" ]; then
 224     mv "$CONFIG_BAK" "$CONFIG_H"
 225 fi