check_all.sh

#!/usr/bin/env bash
#
# script to run Guideline_enforcer checks
#

exeName=$(readlink -f "$0")
dirName=$(dirname "${exeName}")

# shellcheck source=/dev/null
source "${dirName}/logger.sh"

VERBOSE=false
IS_RUST=false

# All available checks ('manifest' must be the first one)
ALL_CHECKS="manifest icons app_load_params makefile readme scan"

#===============================================================================
#
#     help - Prints script help and usage
#
#===============================================================================
# shellcheck disable=SC2154  # var is referenced but not assigned
help() {
    local err="$1"

    [[ -n "${err}" ]] && log_error "${err}"

    echo
    echo "Usage: ${exeName} <options>"
    echo
    echo "Options:"
    echo
    echo "  -c <check>  : Requested check from (${ALL_CHECKS}). Default is all."
    echo "  -d <dir>    : Database directory"
    echo "  -w <dir>    : Workflows directory"
    echo "  -a <dir>    : Application directory"
    echo "  -b <dir>    : Application build directory"
    echo "  -m <file>   : Manifest (file or directory)"
    echo "  -t <device> : Targeted device"
    echo "  -r          : Rust application"
    echo "  -v          : Verbose mode"
    echo "  -h          : Displays this help"
    echo
    exit 1
}

#===============================================================================
#
#     Parsing parameters
#
#===============================================================================

while getopts ":a:b:c:d:m:t:w:rvh" opt; do
    case ${opt} in
        a)  APP_DIR=${OPTARG}   ;;
        b)  BUILD_DIR=${OPTARG} ;;
        c)  REQUESTED_CHECK=${OPTARG} ;;
        d)  DATABASE_DIR=${OPTARG} ;;
        m)  MANIFEST=${OPTARG}  ;;
        t)  TARGET=${OPTARG}    ;;
        w)  WORKFLOWS_DIR=${OPTARG} ;;
        r)  IS_RUST=true ;;
        v)  VERBOSE=true ;;
        h)  help ;;

        \?) echo "Unknown option: -${OPTARG}" >&2; exit 1;;
        : ) echo "Missing option argument for -${OPTARG}" >&2; exit 1;;
        * ) echo "Unimplemented option: -${OPTARG}" >&2; exit 1;;
    esac
done

#===============================================================================
#
#     Checking parameters
#
#===============================================================================

# Check if the requested check is valid
if [[ -n ${REQUESTED_CHECK} ]]; then
    [[ $(wc -w <<< "${REQUESTED_CHECK}") -ne 1 ]] && help "Too many checks requested!"
    [[ ! "${ALL_CHECKS}" =~ ${REQUESTED_CHECK} ]] && help "Unknown check: ${REQUESTED_CHECK}"
fi
if [[ (-z ${REQUESTED_CHECK}) || ("${REQUESTED_CHECK}" =~ (manifest|scan)) ]]; then
    # Check BUILD_DIR environment variable
    [[ -z ${BUILD_DIR} ]] && help "Missing mandatory parameter 'Build directory'!"
fi

if [[ "${REQUESTED_CHECK}" != app_load_params ]]; then
    # Check if APP_DIR is given in parameter
    [[ -z "${APP_DIR}" ]] && help "Missing mandatory parameter 'Application directory'!"
    # Determine REPO_NAME
    REPO_NAME=$(basename "$(git -C "${APP_DIR}" remote get-url origin)")
    REPO_NAME=${REPO_NAME%%.*}
fi

# Init verbose options
make_option=(-j -C "${APP_DIR}/${BUILD_DIR}")
if [[ ${VERBOSE} == false ]]; then
    make_option+=(-s --no-print-directory)
    verbose_mode=(-q)
fi

# Check if TARGET is already setup
if [[ (-z ${TARGET}) && ("${REQUESTED_CHECK}" =~ (manifest|scan)) ]]; then
    TARGET=$(make "${make_option[@]}" listinfo 2>/dev/null | grep -w TARGET | cut -d'=' -f2)
fi

# Check if MANIFEST is given in parameter
if [[ -z ${MANIFEST} ]]; then
    MANIFEST_DIR="/tmp/manifests"
    # Remove the directory if it already exists
    [[ -d "${MANIFEST_DIR}" ]] && rm -rf "${MANIFEST_DIR}"
    mkdir -p "${MANIFEST_DIR}"
    [[ -n ${TARGET} ]] && MANIFEST_FILE="${MANIFEST_DIR}/manifest_${TARGET}.json"
else
    if [[ -d "${MANIFEST}" ]]; then
        MANIFEST_DIR="${MANIFEST}"
    else
        MANIFEST_FILE="${MANIFEST}"
        MANIFEST_DIR=$(dirname "${MANIFEST_FILE}")
    fi
fi

if [[ (-z ${REQUESTED_CHECK}) || ("${REQUESTED_CHECK}" == app_load_params) ]]; then
    if [[ -z "${DATABASE_DIR}" ]]; then
        # Check if DATABASE_DIR is already present
        DATABASE_DIR="/tmp/ledger-app-database"
        git clone "${verbose_mode[@]}" https://github.com/LedgerHQ/ledger-app-database.git "${DATABASE_DIR}"
    fi
fi

if [[ (-z ${REQUESTED_CHECK}) || ("${REQUESTED_CHECK}" == makefile) ]]; then
    if [[ -z "${WORKFLOWS_DIR}" ]]; then
        # Check if WORKFLOWS_DIR is already present
        WORKFLOWS_DIR="/tmp/ledger-app-workflows"
        if [[ ! -d "$WORKFLOWS_DIR" ]]; then
            git clone "${verbose_mode[@]}" https://github.com/LedgerHQ/ledger-app-workflows.git "${WORKFLOWS_DIR}"
        fi
    fi
fi

#===============================================================================
#
#     log functions
#
#===============================================================================
BG_TITLE="\e[48;6;3;1;44m"
FG_TITLE="\e[38;5;44m"
FG_BOLD="\e[${BOLD}m"

(( STEP=1 ))
log_step() {
    echo
    _log_colored_line "${BG_WARNING}" "[STEP ${STEP}]: " "${FG_WARNING}" "$1"
    (( STEP++ ))
}

log_title() {
    echo
    _log_colored_line "${BG_TITLE}" "Starting: " "${FG_TITLE}" "$1"
}

log_bold () {
    local msg="$1"
    echo -e "${FG_BOLD}${msg}${COLOR_OFF}"
}

#===============================================================================
#
#     step function
#
#===============================================================================

call_step() {
    local step="$1"

    case ${step} in
        "manifest")
            if [[ -n ${MANIFEST_FILE} ]]; then
                log_bold "********* Processing target: ${TARGET}"
                eval BOLOS_SDK="$(echo "\$${TARGET}" | sed 's/[2+]/p/' | tr '[:lower:]' '[:upper:]')_SDK"
                if [[ "${IS_RUST}" == true ]]; then
                    COMMAND="(cd ${APP_DIR} && python3 ${dirName}/cargo_metadata_dump.py --device ${TARGET} --app_build_path ${BUILD_DIR} --json_path ${MANIFEST_FILE})"
                else
                    COMMAND="(cd ${APP_DIR} && python3 ${dirName}/makefile_dump.py --app_build_path ${BUILD_DIR} --json_path ${MANIFEST_FILE})"
                fi
            else
                log_step "Get ${step} (All targets)"
                ALL_TARGETS=$(ledger-manifest --output-devices ledger_app.toml | tail -n +2 | awk -F" " '{print $2}' | sed 's/[2+]/p/')
                for tgt in ${ALL_TARGETS}; do
                    gh_group "  Processing target ${tgt}"
                    log_bold "********* Processing target: ${tgt}"
                    eval BOLOS_SDK="$(echo "\$${tgt}" | tr '[:lower:]' '[:upper:]')_SDK"
                    if [[ "${IS_RUST}" == true ]]; then
                        COMMAND="(cd ${APP_DIR} && python3 ${dirName}/cargo_metadata_dump.py --device ${tgt} --app_build_path ${BUILD_DIR} --json_path ${MANIFEST_DIR}/manifest_${tgt}.json)"
                    else
                        COMMAND="(cd ${APP_DIR} && python3 ${dirName}/makefile_dump.py --app_build_path ${BUILD_DIR} --json_path ${MANIFEST_DIR}/manifest_${tgt}.json)"
                    fi
                    [[ "${VERBOSE}" == true ]] && echo "Running: ${COMMAND}"
                    eval "${COMMAND}"
                    err=$?
                    gh_endgroup
                    if [[ ${err} -ne 0 ]]; then
                        log_error "Check ${step} failed for target ${tgt}"
                        echo -n "|:x:" >> "${FILE_STATUS}"
                        exit 1
                    fi
                done
                echo -n "|:white_check_mark:" >> "${FILE_STATUS}"
                return
            fi
            ;;
        "icons")
            COMMAND="${dirName}/check_icons.sh ${APP_DIR} ${REPO_NAME} ${MANIFEST_DIR} ${TARGET}"
            ;;
        "app_load_params")
            COMMAND="python3 ${DATABASE_DIR}/scripts/app_load_params_check.py --database_path ${DATABASE_DIR}/app-load-params-db.json --app_manifests_path ${MANIFEST_DIR}"
            ;;
        "makefile")
            COMMAND="${dirName}/check_makefile.sh ${APP_DIR} ${REPO_NAME} ${MANIFEST_DIR} ${WORKFLOWS_DIR} ${IS_RUST} ${TARGET}"
            ;;
        "readme")
            COMMAND="${dirName}/check_readme.sh ${APP_DIR} ${REPO_NAME}"
            ;;
        "scan")
            if [[ -n ${TARGET} ]]; then
                log_bold "********* Processing target: ${TARGET}"
                eval BOLOS_SDK="$(echo "\$${TARGET}" | sed 's/[2+]/p/' | tr '[:lower:]' '[:upper:]')_SDK"
                if [[ "${IS_RUST}" == true ]]; then
                    COMMAND="(cd ${APP_DIR}/${BUILD_DIR} && cargo +$RUST_NIGHTLY clippy --target ${TARGET/nanosp/nanosplus} -- -Dwarnings)"
                else
                    COMMAND="make ${make_option[*]} ENABLE_SDK_WERROR=1 scan-build"
                fi
            else
                log_step "Check ${step} (All targets)"
                ALL_TARGETS=$(ledger-manifest --output-devices ledger_app.toml | tail -n +2 | awk -F" " '{print $2}' | sed 's/[2+]/p/')
                for tgt in ${ALL_TARGETS}; do
                    gh_group "  Processing target ${tgt}"
                    log_bold "********* Processing target: ${tgt}"
                    eval BOLOS_SDK="$(echo "\$${tgt}" | tr '[:lower:]' '[:upper:]')_SDK"
                    if [[ "${IS_RUST}" == true ]]; then
                        COMMAND="(cd ${APP_DIR}/${BUILD_DIR} && cargo +$RUST_NIGHTLY clippy --target ${tgt/nanosp/nanosplus} -- -Dwarnings)"
                    else
                        COMMAND="make ${make_option[*]} ENABLE_SDK_WERROR=1 scan-build"
                    fi
                    [[ "${VERBOSE}" == true ]] && echo "Running: ${COMMAND}"
                    eval "${COMMAND}"
                    err=$?
                    gh_endgroup
                    if [[ ${err} -ne 0 ]]; then
                        log_error "Check ${step} failed for target ${tgt}"
                        echo -n "|:x:" >> "${FILE_STATUS}"
                        return
                    fi
                done
                echo -n "|:white_check_mark:" >> "${FILE_STATUS}"
                return
            fi
            ;;
        * ) echo "Unimplemented step: ${step}" >&2; exit 1;;
    esac

    if [[ "${step}" == manifest ]]; then
        log_step "Get ${step}"
    else
        log_step "Check ${step}"
    fi

    [[ "${VERBOSE}" == true ]] && echo "Running: ${COMMAND}"
    # Groups are managed inside the dedicated scripts for icons and glyphs
    [[ "${step}" != icons ]] && gh_group "  Step ${step}"
    eval "${COMMAND}"
    err=$?
    [[ "${step}" != icons ]] && gh_endgroup
    if [[ ${err} -ne 0 ]]; then
        log_error "Check ${step} failed"
        echo -n "|:x:" >> "${FILE_STATUS}"
        [[ "${step}" == manifest ]] && exit 1
    else
        echo -n "|:white_check_mark:" >> "${FILE_STATUS}"
    fi
}

#===============================================================================
#
#     Main
#
#===============================================================================

if [[ -z "${TARGET}" ]]; then
    log_title "Running Guideline_enforcer checks"
else
    log_title "Running Guideline_enforcer checks for '${TARGET}'"
fi

FILE_STATUS="/tmp/check_status.md"
rm -f "${FILE_STATUS}"
if [[ -z ${REQUESTED_CHECK} ]]; then
    REQUESTED_CHECK="${ALL_CHECKS}"
else
    # 1st mandatory step to retrieve the app configuration if directory is empty
    if [[ ("${REQUESTED_CHECK}" =~ (icons|app_load_params|makefile) ) && ( ! $( ls -A "${MANIFEST_DIR}")) ]]; then
        call_step "manifest"
    fi
fi

# Run requested checks
for check in ${REQUESTED_CHECK}; do
    call_step "${check}"
done

nb_errors=$(grep -o ":x:" "${FILE_STATUS}" | wc -l)
echo ""

[[ -n "${TARGET}" ]] && SUBSTR="for '${TARGET}'"
if [[ "${nb_errors}" -eq 0 ]]; then
    log_success "Successful Guideline_enforcer checks ${SUBSTR}"
    exit 0
else
    log_error_no_header "Fail with ${nb_errors} error(s) during Guideline_enforcer checks ${SUBSTR}"
    exit 1
fi