dev.sh

#!/bin/bash

set -eu

# 1: cd dir
# 2: args and code dir
run_pylint() {
    # we use the column command to format data, but not all shells/distributions have it
    # so just make a passthrough alias
    if ! command -v column >/dev/null; then
        column() {
            cat
        }
    fi

    cd_dir="$1"
    shift
    args_and_code_dir="$*"

    cd "$cd_dir"
    set +e
    # shellcheck disable=SC2086
    output=$(pylint --rcfile ../.sanity-config.ini $args_and_code_dir)
    exit_code="$?"
    set -e
    # shellcheck disable=SC2103
    cd ..

    echo "$output" \
        | jq -r '.[] | .path + "|" + (.line|tostring) + ":" + (.column|tostring) + "|" + .obj + " |" + ."message-id" + "|" + .symbol + "|" + .message' \
        | sort --unique \
        | column -t -s "|"

    return "$exit_code"
}

run_shellcheck() {
    files="$(find . -type f -name "*.sh" -not -path "*.venv*")"

    aggregate_exit_code="0"
    while read -r line; do
        set +e
        shellcheck --format tty "$line"
        exit_code="$?"
        set -e

        aggregate_exit_code="$((aggregate_exit_code + exit_code))"
    done <<< "$files"

    return "$aggregate_exit_code"
}

check_commit_messages() {
    since=231884e0bb63e764ad23b2e55e5a1e726bc2c11e
    echo "Checking git messages from $since to HEAD..."

    commits="$(git log "${since}..HEAD" --pretty=format:"%H %s")"
    echo "Found commits:"
    echo "$commits"
    echo

    # shellcheck disable=SC1117
    commits_with_trailing_period="$(echo -n "$commits" | grep -Ee ".*\.\s*$")"

    if [ -z "$commits_with_trailing_period" ]; then
        number_of_trailing_periods=0
    else
        number_of_trailing_periods="$(echo "$commits_with_trailing_period" | wc -l)"
    fi

    echo "Found $number_of_trailing_periods commits with a trailing period"
    echo "$commits_with_trailing_period"
    echo

    if [ "$number_of_trailing_periods" -gt 0 ]; then
        echo "Commits must not have a trailing period in their commit summary."
        return 7
    fi
    return 0
}

run_sanity() {
    set +e

    echo "Running pylint (source)"
    output_pylint_src=$(run_pylint src/ opera/)
    code_pylint_src="$?"

    echo "Running pylint (tests)"
    output_pylint_test=$(run_pylint tests/ --disable no-self-use --disable expression-not-assigned unit/)
    code_pylint_test="$?"

    echo "Running flake8"
    output_flake8=$(flake8 --statistics --config .sanity-config.ini)
    code_flake8="$?"

    echo "Running mypy"
    output_mypy=$(mypy --config-file .sanity-config.ini src/opera/ tests/unit/)
    code_mypy="$?"

    echo "Running bandit"
    output_bandit=$(bandit --recursive --aggregate file --format txt src/opera/ 2>&1)
    code_bandit="$?"

    echo "Running pydocstyle"
    output_pydocstyle=$(pydocstyle --count --explain --config .sanity-config.ini src/opera/)
    code_pydocstyle="$?"

    echo "Running shellcheck"
    output_shellcheck=$(run_shellcheck)
    code_shellcheck="$?"

    echo "Checking commit messages"
    output_commit_messages=$(check_commit_messages)
    code_commit_messages="$?"

    set -e

    echo "pylint (src) output"
    echo "$code_pylint_src"
    echo "$output_pylint_src"
    echo "### pylint (tests) output ###"
    echo "exit code: $code_pylint_test"
    echo "$output_pylint_test"
    echo "### flake8 output ###"
    echo "exit code: $code_flake8"
    echo "$output_flake8"
    echo "### shellcheck output ###"
    echo "exit code: $code_shellcheck"
    echo "$output_shellcheck"
    echo "### mypy output ###"
    echo "exit code: $code_mypy"
    echo "$output_mypy"
    echo "### bandit output ###"
    echo "exit code: $code_bandit"
    echo "$output_bandit"
    echo "### pydocstyle output ###"
    echo "exit code: $code_pydocstyle"
    echo "$output_pydocstyle"
    echo "### shellcheck output ###"
    echo "exit code: $code_shellcheck"
    echo "$output_shellcheck"
    echo "### commit message check output ###"
    echo "exit code: $code_commit_messages"
    echo "$output_commit_messages"

    echo "Applied overrides:"
    grep -rinEe "noqa:|pylint:|nosec|# shellcheck" \
        --exclude-dir ".venv/" \
        --exclude-dir ".eggs/" \
        --exclude-dir ".git/" \
        --exclude-dir ".mypy_cache/" \
        --exclude-dir ".pytest_cache/" \
        .

    combined_exit_code="$((
        code_pylint_src
        + code_pylint_test
        + code_flake8
        + code_mypy
        + code_bandit
        + code_pydocstyle
        + code_shellcheck
        + code_commit_messages
    ))"
    exit "$combined_exit_code"
}

run_unit() {
    pytest tests/unit/
}

run_coverage() {
    pytest --cov=opera --cov-report=xml tests/unit/
}

run_integration() {
    for dir in tests/integration/*/; do (cd "$dir" && ./runme.sh opera); done
}

run_help() {
    cat <<EOF
usage:
    ./dev.sh <command>

commands:
    sanity              runs sanity tests
    unit                runs unit tests
    integration         runs integration tests
    coverage            calculates code coverage
    help                shows this help
EOF
}


if [ $# -ne 1 ]
  then
    echo -e "No arguments were supplied\n"
    run_help
    exit 1
fi

command="$1"
shift

case "$command" in
    sanity)
        run_sanity
        ;;
    unit)
        run_unit
        ;;
    coverage)
        run_coverage
        ;;
    integration)
        run_integration
        ;;
    help)
        run_help
        ;;
    *)
        echo -e "Invalid command: $command\n"
        run_help
        ;;
esac