run-code-assessment.sh

#!/bin/bash

declare -a RESULT

# specifies a set of variables to declare CLI output color
FAILED_OUT="\033[0;31m"
PASSED_OUT="\033[0;32m"
NONE_OUT="\033[0m"

# specifies a set of variables to declare files to be used for code assessment
PROJECT_FILES="./"
TESTS_FILES="tests"
LIB_FILES="lib"
PY_FILES="*.py"


function store-failures {
    RESULT+=("$1")
}


function remove-pycache-trash {
    local PYCACHE_DIR="__pycache__"
    echo "Removing ${PYCACHE_DIR} directories if present ..."
    ( find . -d -name ${PYCACHE_DIR} | xargs rm -r ) || echo -e "No ${PYCACHE_DIR} found"
}


function remove-analysis-trash {
    local PYTEST_CACHE_DIR='.pytest_cache'
    local MYPY_CACHE_DIR='.mypy_cache'
    echo "Removing code analysis trash if present ..."
    [[ -d "$PYTEST_CACHE_DIR" ]] && rm -rf ${PYTEST_CACHE_DIR} && echo "pytest trash is removed"
    [[ -d "$MYPY_CACHE_DIR" ]] && rm -rf ${MYPY_CACHE_DIR} && echo "mypy trash is removed"
}


function install-dependencies {
   echo "Installing python code analysis packages ..." \
   && ( pip install --no-cache-dir --upgrade pip ) \
   && ( pip install --no-cache-dir -r requirements-dev.txt )
}


function run-unittests {
    echo "Running unittests ..." && ( pytest )
}


function run-flake8-analysis {
    echo "Running flake8 analysis ..." && ( flake8 ${LIB_FILES} )
}


function run-black-analysis {
    echo "Running black analysis ..." && ( black --check ${PROJECT_FILES} )
}


function run-pylint-analysis {
    echo "Running pylint analysis ..." && ( pylint $(find ${PROJECT_FILES} -iname ${LIB_FILES}) )
}


function run-mypy-analysis {
    echo "Running mypy analysis ..." && ( mypy --package ${LIB_FILES} ) && ( mypy --package ${TESTS_FILES} )
}


function run-pydocstyle-analysis {
    echo "Running pydocstyle analysis ..." && ( pydocstyle --explain --count ${PY_FILES} ${LIB_FILES}} )
}


function start-analysis {
    run-unittests || store-failures "Unittests are failed!"
    run-pylint-analysis || store-failures "pylint analysis is failed!"
    run-mypy-analysis || store-failures "mypy analysis is failed!"
    run-flake8-analysis || store-failures "flake8 analysis is failed!"
    run-black-analysis || store-failures "black analysis is failed!"
    run-pydocstyle-analysis || store-failures "pydocstyle analysis is failed!"
}


function run-code-assessment {
    echo "Running code analysis ..."
    remove-pycache-trash
    start-analysis

    if [[ ${#RESULT[@]} -ne 0 ]];
        then echo -e "${FAILED_OUT}Some errors occurred while analysing the code quality.${NONE_OUT}"
        for failed_item in "${RESULT[@]}"; do
            echo -e "${FAILED_OUT}- ${failed_item}${NONE_OUT}"
        done
        remove-analysis-trash
        exit 1
    fi
    remove-analysis-trash
    echo -e "${PASSED_OUT}Code analysis is passed${NONE_OUT}"
}


function main() {
    if [[ "$1" == "install-dependencies" ]];
        then install-dependencies || store-failures "Python packages installation is failed!";
    fi
    run-code-assessment
}


main $@