Extract basic-components into a separate file.
Signed-off-by: David Horstmann <david.horstmann@arm.com>
Signed-off-by: Thomas Daubney <thomas.daubney@arm.com>
Signed-off-by: Minos Galanakis <minos.galanakis@arm.com>
diff --git a/tests/scripts/components-basic-checks.sh b/tests/scripts/components-basic-checks.sh
index d8578cd..42e824c 100644
--- a/tests/scripts/components-basic-checks.sh
+++ b/tests/scripts/components-basic-checks.sh
@@ -9,4 +9,168 @@
#### Basic checks
################################################################
+#
+# Test Suites to be executed
+#
+# The test ordering tries to optimize for the following criteria:
+# 1. Catch possible problems early, by running first tests that run quickly
+# and/or are more likely to fail than others (eg I use Clang most of the
+# time, so start with a GCC build).
+# 2. Minimize total running time, by avoiding useless rebuilds
+#
+# Indicative running times are given for reference.
+
+component_check_recursion () {
+ msg "Check: recursion.pl" # < 1s
+ tests/scripts/recursion.pl library/*.c
+ tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
+ tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
+}
+
+component_check_generated_files () {
+ msg "Check: check-generated-files, files generated with make" # 2s
+ make generated_files
+ tests/scripts/check-generated-files.sh
+
+ msg "Check: check-generated-files -u, files present" # 2s
+ tests/scripts/check-generated-files.sh -u
+ # Check that the generated files are considered up to date.
+ tests/scripts/check-generated-files.sh
+
+ msg "Check: check-generated-files -u, files absent" # 2s
+ command make neat
+ tests/scripts/check-generated-files.sh -u
+ # Check that the generated files are considered up to date.
+ tests/scripts/check-generated-files.sh
+
+ # This component ends with the generated files present in the source tree.
+ # This is necessary for subsequent components!
+}
+
+component_check_doxy_blocks () {
+ msg "Check: doxygen markup outside doxygen blocks" # < 1s
+ tests/scripts/check-doxy-blocks.pl
+}
+
+component_check_files () {
+ msg "Check: file sanity checks (permissions, encodings)" # < 1s
+ tests/scripts/check_files.py
+}
+
+component_check_changelog () {
+ msg "Check: changelog entries" # < 1s
+ rm -f ChangeLog.new
+ scripts/assemble_changelog.py -o ChangeLog.new
+ if [ -e ChangeLog.new ]; then
+ # Show the diff for information. It isn't an error if the diff is
+ # non-empty.
+ diff -u ChangeLog ChangeLog.new || true
+ rm ChangeLog.new
+ fi
+}
+
+component_check_names () {
+ msg "Check: declared and exported names (builds the library)" # < 3s
+ tests/scripts/check_names.py -v
+}
+
+component_check_test_cases () {
+ msg "Check: test case descriptions" # < 1s
+ if [ $QUIET -eq 1 ]; then
+ opt='--quiet'
+ else
+ opt=''
+ fi
+ tests/scripts/check_test_cases.py -q $opt
+ unset opt
+}
+
+component_check_test_dependencies () {
+ msg "Check: test case dependencies: legacy vs PSA" # < 1s
+ # The purpose of this component is to catch unjustified dependencies on
+ # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
+ # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
+ # MBEDTLS_PSA_xxx).
+ #
+ # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
+ # this component is meant to catch. However a few of them are justified,
+ # mostly by the absence of a PSA equivalent, so this component includes a
+ # list of expected exceptions.
+
+ found="check-test-deps-found-$$"
+ expected="check-test-deps-expected-$$"
+
+ # Find legacy dependencies in PSA tests
+ grep 'depends_on' \
+ tf-psa-crypto/tests/suites/test_suite_psa*.data \
+ tf-psa-crypto/tests/suites/test_suite_psa*.function |
+ grep -Eo '!?MBEDTLS_[^: ]*' |
+ grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
+ sort -u > $found
+
+ # Expected ones with justification - keep in sorted order by ASCII table!
+ rm -f $expected
+ # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
+ echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
+ # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
+ echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
+ # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
+ # in order to build a fake RSA key of the wanted size based on
+ # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
+ # the test code and that's probably the most convenient way of achieving
+ # the test's goal.
+ echo "MBEDTLS_ASN1_WRITE_C" >> $expected
+ # No PSA equivalent - we should probably have one in the future.
+ echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
+ # No PSA equivalent - needed by some init tests
+ echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
+ # No PSA equivalent - required to run threaded tests.
+ echo "MBEDTLS_THREADING_PTHREAD" >> $expected
+
+ # Compare reality with expectation.
+ # We want an exact match, to ensure the above list remains up-to-date.
+ #
+ # The output should be empty. When it's not:
+ # - Each '+' line is a macro that was found but not expected. You want to
+ # find where that macro occurs, and either replace it with PSA macros, or
+ # add it to the exceptions list above with a justification.
+ # - Each '-' line is a macro that was expected but not found; it means the
+ # exceptions list above should be updated by removing that macro.
+ diff -U0 $expected $found
+
+ rm $found $expected
+}
+
+component_check_doxygen_warnings () {
+ msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
+ tests/scripts/doxygen.sh
+}
+
+component_check_code_style () {
+ msg "Check C code style"
+ ./scripts/code_style.py
+}
+
+support_check_code_style() {
+ case $(uncrustify --version) in
+ *0.75.1*) true;;
+ *) false;;
+ esac
+}
+
+component_check_python_files () {
+ msg "Lint: Python scripts"
+ tests/scripts/check-python-files.sh
+}
+
+component_check_test_helpers () {
+ msg "unit test: generate_test_code.py"
+ # unittest writes out mundane stuff like number or tests run on stderr.
+ # Our convention is to reserve stderr for actual errors, and write
+ # harmless info on stdout so it can be suppress with --quiet.
+ ./framework/scripts/test_generate_test_code.py 2>&1
+
+ msg "unit test: translate_ciphers.py"
+ python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
+}
diff --git a/tests/scripts/components.sh b/tests/scripts/components.sh
index 15f8d23..82d18c3 100644
--- a/tests/scripts/components.sh
+++ b/tests/scripts/components.sh
@@ -73,149 +73,6 @@
}
################################################################
-#### Basic checks
-################################################################
-
-#
-# Test Suites to be executed
-#
-# The test ordering tries to optimize for the following criteria:
-# 1. Catch possible problems early, by running first tests that run quickly
-# and/or are more likely to fail than others (eg I use Clang most of the
-# time, so start with a GCC build).
-# 2. Minimize total running time, by avoiding useless rebuilds
-#
-# Indicative running times are given for reference.
-
-component_check_recursion () {
- msg "Check: recursion.pl" # < 1s
- tests/scripts/recursion.pl library/*.c
- tests/scripts/recursion.pl ${PSA_CORE_PATH}/*.c
- tests/scripts/recursion.pl ${BUILTIN_SRC_PATH}/*.c
-}
-
-component_check_generated_files () {
- msg "Check: check-generated-files, files generated with make" # 2s
- make generated_files
- tests/scripts/check-generated-files.sh
-
- msg "Check: check-generated-files -u, files present" # 2s
- tests/scripts/check-generated-files.sh -u
- # Check that the generated files are considered up to date.
- tests/scripts/check-generated-files.sh
-
- msg "Check: check-generated-files -u, files absent" # 2s
- command make neat
- tests/scripts/check-generated-files.sh -u
- # Check that the generated files are considered up to date.
- tests/scripts/check-generated-files.sh
-
- # This component ends with the generated files present in the source tree.
- # This is necessary for subsequent components!
-}
-
-component_check_doxy_blocks () {
- msg "Check: doxygen markup outside doxygen blocks" # < 1s
- tests/scripts/check-doxy-blocks.pl
-}
-
-component_check_files () {
- msg "Check: file sanity checks (permissions, encodings)" # < 1s
- tests/scripts/check_files.py
-}
-
-component_check_changelog () {
- msg "Check: changelog entries" # < 1s
- rm -f ChangeLog.new
- scripts/assemble_changelog.py -o ChangeLog.new
- if [ -e ChangeLog.new ]; then
- # Show the diff for information. It isn't an error if the diff is
- # non-empty.
- diff -u ChangeLog ChangeLog.new || true
- rm ChangeLog.new
- fi
-}
-
-component_check_names () {
- msg "Check: declared and exported names (builds the library)" # < 3s
- tests/scripts/check_names.py -v
-}
-
-component_check_test_cases () {
- msg "Check: test case descriptions" # < 1s
- if [ $QUIET -eq 1 ]; then
- opt='--quiet'
- else
- opt=''
- fi
- tests/scripts/check_test_cases.py -q $opt
- unset opt
-}
-
-component_check_test_dependencies () {
- msg "Check: test case dependencies: legacy vs PSA" # < 1s
- # The purpose of this component is to catch unjustified dependencies on
- # legacy feature macros (MBEDTLS_xxx) in PSA tests. Generally speaking,
- # PSA test should use PSA feature macros (PSA_WANT_xxx, more rarely
- # MBEDTLS_PSA_xxx).
- #
- # Most of the time, use of legacy MBEDTLS_xxx macros are mistakes, which
- # this component is meant to catch. However a few of them are justified,
- # mostly by the absence of a PSA equivalent, so this component includes a
- # list of expected exceptions.
-
- found="check-test-deps-found-$$"
- expected="check-test-deps-expected-$$"
-
- # Find legacy dependencies in PSA tests
- grep 'depends_on' \
- tf-psa-crypto/tests/suites/test_suite_psa*.data \
- tf-psa-crypto/tests/suites/test_suite_psa*.function |
- grep -Eo '!?MBEDTLS_[^: ]*' |
- grep -v -e MBEDTLS_PSA_ -e MBEDTLS_TEST_ |
- sort -u > $found
-
- # Expected ones with justification - keep in sorted order by ASCII table!
- rm -f $expected
- # No PSA equivalent - WANT_KEY_TYPE_AES means all sizes
- echo "!MBEDTLS_AES_ONLY_128_BIT_KEY_LENGTH" >> $expected
- # No PSA equivalent - used to skip decryption tests in PSA-ECB, CBC/XTS/NIST_KW/DES
- echo "!MBEDTLS_BLOCK_CIPHER_NO_DECRYPT" >> $expected
- # MBEDTLS_ASN1_WRITE_C is used by import_rsa_made_up() in test_suite_psa_crypto
- # in order to build a fake RSA key of the wanted size based on
- # PSA_VENDOR_RSA_MAX_KEY_BITS. The legacy module is only used by
- # the test code and that's probably the most convenient way of achieving
- # the test's goal.
- echo "MBEDTLS_ASN1_WRITE_C" >> $expected
- # No PSA equivalent - we should probably have one in the future.
- echo "MBEDTLS_ECP_RESTARTABLE" >> $expected
- # No PSA equivalent - needed by some init tests
- echo "MBEDTLS_ENTROPY_NV_SEED" >> $expected
- # No PSA equivalent - required to run threaded tests.
- echo "MBEDTLS_THREADING_PTHREAD" >> $expected
-
- # Compare reality with expectation.
- # We want an exact match, to ensure the above list remains up-to-date.
- #
- # The output should be empty. When it's not:
- # - Each '+' line is a macro that was found but not expected. You want to
- # find where that macro occurs, and either replace it with PSA macros, or
- # add it to the exceptions list above with a justification.
- # - Each '-' line is a macro that was expected but not found; it means the
- # exceptions list above should be updated by removing that macro.
- diff -U0 $expected $found
-
- rm $found $expected
-}
-
-component_check_doxygen_warnings () {
- msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
- tests/scripts/doxygen.sh
-}
-
-
-
-################################################################
#### Build and test many configurations and targets
################################################################
@@ -4984,34 +4841,6 @@
[ "$ver_major" -eq 3 ] && [ "$ver_minor" -ge 10 ]
}
-component_check_code_style () {
- msg "Check C code style"
- ./scripts/code_style.py
-}
-
-support_check_code_style() {
- case $(uncrustify --version) in
- *0.75.1*) true;;
- *) false;;
- esac
-}
-
-component_check_python_files () {
- msg "Lint: Python scripts"
- tests/scripts/check-python-files.sh
-}
-
-component_check_test_helpers () {
- msg "unit test: generate_test_code.py"
- # unittest writes out mundane stuff like number or tests run on stderr.
- # Our convention is to reserve stderr for actual errors, and write
- # harmless info on stdout so it can be suppress with --quiet.
- ./framework/scripts/test_generate_test_code.py 2>&1
-
- msg "unit test: translate_ciphers.py"
- python3 -m unittest tests/scripts/translate_ciphers.py 2>&1
-}
-
component_test_psasim () {
msg "build server library and application"
scripts/config.py crypto
@@ -5067,4 +4896,4 @@
make PSASIM=1 test
helper_psasim_server kill
-}
\ No newline at end of file
+}