# components-basic-checks.sh
#
# Copyright The Mbed TLS Contributors
# SPDX-License-Identifier: Apache-2.0 OR GPL-2.0-or-later

# This file contains test components that are executed by all.sh

################################################################
#### Basic checks
################################################################

component_check_recursion () {
    msg "Check: recursion.pl" # < 1s
    ./framework/scripts/recursion.pl library/*.c
}

component_check_generated_files () {
    msg "Check make_generated_files.py consistency"
    $MAKE_COMMAND neat
    scripts/make_generated_files.py
    scripts/make_generated_files.py --check
    $MAKE_COMMAND neat

    msg "Check files generated with make"
    MBEDTLS_ROOT_DIR="$PWD"
    $MAKE_COMMAND generated_files
    scripts/make_generated_files.py --check

    cd $TF_PSA_CRYPTO_ROOT_DIR
    ./framework/scripts/make_generated_files.py --check

    msg "Check files generated with cmake"
    cd "$MBEDTLS_ROOT_DIR"
    mkdir "$OUT_OF_SOURCE_DIR"
    cd "$OUT_OF_SOURCE_DIR"
    cmake -D GEN_FILES=ON "$MBEDTLS_ROOT_DIR"
    make
    cd "$MBEDTLS_ROOT_DIR"

    scripts/make_generated_files.py --root "$OUT_OF_SOURCE_DIR" --check

    cd $TF_PSA_CRYPTO_ROOT_DIR
    ./framework/scripts/make_generated_files.py --root "$OUT_OF_SOURCE_DIR/tf-psa-crypto" --check
    cd "$MBEDTLS_ROOT_DIR"

    # This component ends with the generated files present in the source tree.
    # This is necessary for subsequent components!
}

support_check_committed_generated_files () {
    # Add requirements on the Python installation here for
    # the sake of check_committed_generated_files.py in mbedtls.
    #
    # Check the Python version, not the presence of the package,
    # because the CI runs `all.sh --list-components` outside of the
    # venv that has our desired packages.
    :
}

component_check_committed_generated_files () {
    msg "Check committed generated files"
    tests/scripts/check_committed_generated_files.py
}

component_check_doxy_blocks () {
    msg "Check: doxygen markup outside doxygen blocks" # < 1s
    ./framework/scripts/check-doxy-blocks.pl
}

component_check_files () {
    msg "Check: file sanity checks (permissions, encodings)" # < 1s
    framework/scripts/check_files.py
}

component_check_changelog () {
    msg "Check: changelog entries" # < 1s
    rm -f ChangeLog.new
    ./framework/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
    framework/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
    framework/scripts/check_test_cases.py -q $opt
    unset opt
}

component_check_test_dependencies () {
    msg "Check: test cases dependencies: no crypto internals"
    # The purpose of this component is to catch unjustified dependencies from
    # mbedtls test on crypto internal feature macros.
    #
    # Most of the time, use of crypto internal feature macros are mistakes,
    # which this component is meant to catch. However a few of them are
    # justified, or known issues yet to be resolved, so this component includes
    # a list of expected exceptions.

    crypto="check-test-deps-crypto-$$"
    used="check-test-deps-used-$$"
    found="check-test-deps-found-$$"
    expected="check-test-deps-expected-$$"

    (
        cd tf-psa-crypto
        PYTHONPATH=framework/scripts python \
            -c 'from mbedtls_framework import config_macros; \
                print("\n".join(config_macros.Current().internal()))'
    ) | sort -u > $crypto

    (
          grep depends_on \
            tests/suites/test_suite_*.data \
            tests/suites/test_suite_*.function |
            sed -e 's/.*depends_on:\([^ ]*\).*/\1/' -e's/!//g' |
            tr ':' '\n'
        egrep -oh '(PSA|MBEDTLS)_[A-Z0-9_]*' tests/ssl-opt.sh tests/opt-testcases/*.sh
    ) | sort -u > $used

    # Find macros that are both used in mbedtls tests and crypto-internal.
    comm -12 $crypto $used > $found

    # Expected ones with justification - keep in sorted order!
    rm -f $expected
    # Acceptable: these are light wrappers around official PSA_WANT macros,
    # to hide the fact that ECDSA and RSA could be randomized or deterministic.
    echo "PSA_HAVE_ALG_ECDSA_SIGN" >> $expected
    echo "PSA_HAVE_ALG_ECDSA_VERIFY" >> $expected
    echo "PSA_HAVE_ALG_RSA_PKCS1V15_SIGN" >> $expected
    echo "PSA_HAVE_ALG_RSA_PKCS1V15_VERIFY" >> $expected
    echo "PSA_HAVE_ALG_SOME_ECDSA" >> $expected
    echo "PSA_HAVE_ALG_SOME_RSA_SIGN" >> $expected
    echo "PSA_HAVE_ALG_SOME_RSA_VERIFY" >> $expected
    echo "PSA_WANT_ALG_ECDSA_ANY" >> $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 $crypto $used
}

component_check_doxygen_warnings () {
    msg "Check: doxygen warnings (builds the documentation)" # ~ 3s
    ./framework/scripts/doxygen.sh
}

component_check_code_style () {
    msg "Check C code style"
    ./framework/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"
    ./framework/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 framework/scripts/translate_ciphers.py 2>&1

    msg "unit test: generate_config_checks.py"
    tests/scripts/test_config_checks.py 2>&1
}