basic-build-test.sh 7.6 KB

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