echo_text=${1:-}

if [ "${VERBOSE_MODE}" -ne 0 ]; then

echo "${echo_text}"

fi

verbose_echo "{Loading 'project.properties file'...}"

while IFS='=' read -r key_value; do

if [[ ${key_value} == \#* ]]; then

continue

fi

key=$(echo "${key_value}" | cut -d '=' -f1)

value=$(echo "${key_value}" | cut -d '=' -f2-)

export "${key}=${value}"

done <"${SCRIPT_DIR}/project.properties"

if [[ -z ${PYTHON_MODULE_NAME} ]]; then

complete_process 1 "Property 'PYTHON_MODULE_NAME' must be defined in the project.properties file."

fi

# If the temp file was used, get rid of it.

if [ -f "${TEMP_FILE}" ]; then

rm "${TEMP_FILE}"

fi

# Restore the current directory.

popd >/dev/null 2>&1 || exit

if [ "${VERBOSE_MODE}" -ne 0 ]; then

echo "Saving current directory prior to execution."

fi

if ! pushd "${SCRIPT_DIR}" >"${TEMP_FILE}" 2>&1; then

cat "${TEMP_FILE}"

complete_process 1 "Script cannot save the current directory before proceeding."

fi

trap cleanup_function EXIT

if [ "${VERBOSE_MODE}" -ne 0 ]; then

echo "${SCRIPT_TITLE}..."

fi

local SCRIPT_RETURN_CODE=${1}

local COMPLETE_REASON=${2:-}

if [ -n "${COMPLETE_REASON}" ]; then

echo "${COMPLETE_REASON}"

fi

if [ "${SCRIPT_RETURN_CODE}" -ne 0 ]; then

echo "${SCRIPT_TITLE} failed."

else

if [ "${VERBOSE_MODE}" -ne 0 ]; then

echo "${SCRIPT_TITLE} succeeded."

fi

fi

exit "${SCRIPT_RETURN_CODE}"

local SCRIPT_NAME=${0}

echo "Usage:"

echo " $(basename "${SCRIPT_NAME}") [flags]"

echo ""

echo "Summary:"

echo " Executes the tests for the project."

echo ""

echo "Flags:"

echo " -a,--all Show all errors. Otherwise, pytest will stop after the first 5 failures."

echo " -c,--coverage Calculate the coverage for the tests."

echo " -d,--capture-directory Capture the markdown for the test cases in the specified directory."

echo " -f,--full-report Produce a full report for the executed tests instead of a 'changes only' report."

echo " -w,--workers Enabled testing with multiple workers."

echo " -k,--keyword [keyword] Execute only the tests matching the specified keyword."

echo " -m,--markers [markers] Execute only the tests matching the specified markers."

echo " -i,--individual Show a line for each test as it completed, for further processing."

echo " -p,--publish Publish the project summaries of previously executed tests."

echo " -v,--test-verbose Display a log debug information about each test execution."

echo " -x,--debug Display debug information about the script as it executes."

echo " -q,--quiet Do not display detailed information during execution."

echo " -h,--help Display this help text."

echo ""

exit 1

PYSCAN_FULL_REPORT_MODE=0

VERBOSE_MODE=1

DEBUG_MODE=0

COVERAGE_MODE=0

PUBLISH_MODE=0

MULTIPLE_WORKER_ARGS=

KEYWORD_ARG=

MARKER_ARG=

TEST_VERBOSE_MODE=

FAILURE_ARGS="--maxfail=5"

CAPTURE_DIRECTORY=

GENERATE_HTML_MODE=1

INDIVIDUAL_MODE=0

PARAMS=()

while (("$#")); do

case "$1" in

-a | --all)

FAILURE_ARGS=

shift

;;

-c | --coverage)

COVERAGE_MODE=1

shift

;;

-i | --individual)

INDIVIDUAL_MODE=1

shift

;;

-d | --capture-directory)

if [[ -z ${2:-} ]]; then

echo "Error: Argument ${1} must be followed by the path to the directory to use." >&2

show_usage

fi

CAPTURE_DIRECTORY=${2}

if ! [[ -d ${CAPTURE_DIRECTORY} ]]; then

echo "Error: Argument ${1} must be followed by a path to an existing directory." >&2

show_usage

fi

shift

shift

;;

-f | --full-report)

PYSCAN_FULL_REPORT_MODE=1

shift

;;

-w | --workers)

MULTIPLE_WORKER_ARGS=100

shift

;;

-k | --keyword)

if [ -z "${2:-}" ]; then

echo "Error: Argument ${1} must be followed by the keyword or keyword expression to use." >&2

show_usage

fi

KEYWORD_ARG="${2}"

shift

shift

;;

-m | --markers)

if [ -z "${2:-}" ]; then

echo "Error: Argument ${1} must be followed by the marker expression to use." >&2

show_usage

fi

MARKER_ARG="${2}"

shift

shift

;;

-p | --publish)

PUBLISH_MODE=1

shift

;;

-nh)

GENERATE_HTML_MODE=0

shift

;;

-q | --quiet)

VERBOSE_MODE=0

shift

;;

-v | --test-verbose)

TEST_VERBOSE_MODE="--log-cli-level=DEBUG"

shift

;;

-x | --debug)

DEBUG_MODE=1

shift

;;

-h | --help)

show_usage

;;

-*) # unsupported flags

echo "Error: Unsupported flag ${1}" >&2

show_usage

;;

*) # preserve positional arguments

PARAMS+=("${1}")

shift

;;

esac

done

if [[ ${DEBUG_MODE} -ne 0 ]]; then

set -x

fi

if [[ ${PYTHON_MODULE_NAME} == "project_summarizer" ]]; then

PYSCAN_SCRIPT_PATH=(python "${SCRIPT_DIR}/main.py")

else

PYSCAN_SCRIPT_PATH=(project_summarizer)

fi

if [[ ${PUBLISH_MODE} -ne 0 ]]; then

echo "{Publishing summaries from last test run.}"

if ! pipenv run "${PYSCAN_SCRIPT_PATH[@]}" --publish; then

complete_process 1 "{Publishing of test run summaries failed.}"

fi

complete_process 0 "{Publishing of test run summaries succeeded.}"

fi

# If we are testing by keyword, coverage and multi-core do not make sense.

if [[ -n ${KEYWORD_ARG} ]]; then

COVERAGE_MODE=

MULTIPLE_WORKER_ARGS=

KEYWORD_ARG=(-k "${KEYWORD_ARG}")

fi

if [[ -n ${MARKER_ARG} ]]; then

MARKER_ARG=(-m "${MARKER_ARG}")

fi

# If we are not told to do a full report, only do the changes.

PYSCAN_OPTIONS=

if [[ ${PYSCAN_FULL_REPORT_MODE} -eq 0 ]]; then

PYSCAN_OPTIONS="--only-changes"

fi

# For multiple workers, default to half of the existing cores.

if [[ -n ${MULTIPLE_WORKER_ARGS} ]]; then

CORES_TO_USE=${MULTIPLE_WORKER_ARGS}

PROCESSOR_COUNT=$(python -c "import multiprocessing; print(multiprocessing.cpu_count())")

if [[ ${MULTIPLE_WORKER_ARGS} -gt ${PROCESSOR_COUNT} ]]; then

CORES_TO_USE=$((PROCESSOR_COUNT / 2))

fi

if [ ${CORES_TO_USE} -lt 1 ]; then

CORES_TO_USE=1

fi

MULTIPLE_WORKER_ARGS="-n ${CORES_TO_USE} --dist loadscope"

fi

local pytest_args=()

TEST_EXECUTION_SUCCEEDED=1

# Setup the args to reflect the mode in which the tests are to be invoked.

pytest_args=(--strict-markers -ra --junitxml="${TEST_RESULTS_XML_PATH}")

if [[ ${INDIVIDUAL_MODE} -ne 0 ]]; then

pytest_args+=(-v)

pytest_args+=(--log-format="%(asctime)s %(levelname)s %(message)s")

pytest_args+=(--log-date-format="%Y-%m-%dT%H:%M:%S.%f")

fi

if [[ ${GENERATE_HTML_MODE} -ne 0 ]]; then

pytest_args+=(--html=report/report.html)

fi

if [[ ${COVERAGE_MODE} -ne 0 ]]; then

pytest_args+=(--cov --cov-branch --cov-report xml:"${TEST_COVERAGE_XML_PATH}")

if [[ ${GENERATE_HTML_MODE} -ne 0 ]]; then

pytest_args+=(--cov-report html:report/coverage)

fi

fi

if [[ -n ${KEYWORD_ARG[*]} ]] || [[ -n ${MARKER_ARG[*]} ]]; then

if [[ ${COVERAGE_MODE} -ne 0 ]]; then

echo "{Executing partial test suite with coverage...}"

else

echo "{Executing partial test suite...}"

fi

else

if [[ ${COVERAGE_MODE} -ne 0 ]]; then

echo "{Executing full test suite with coverage...}"

else

echo "{Executing full test suite...}"

fi

fi

# If asked to capture input markdown documents, set the environment variable to allow the

# testing of the application to know to write them out to that directory.

if [[ -n ${CAPTURE_DIRECTORY} ]]; then

export PTEST_KEEP_DIRECTORY="${CAPTURE_DIRECTORY}"

rm "${PTEST_KEEP_DIRECTORY}"/*.md >"${TEMP_FILE}" 2>&1

fi

# Run the tests.

if [[ ${VERBOSE_MODE} -ne 0 ]]; then

# shellcheck disable=SC2086 # Double quote to prevent splitting and globbing.

if ! pipenv run pytest \

${TEST_VERBOSE_MODE} \

${MULTIPLE_WORKER_ARGS} ${FAILURE_ARGS} "${KEYWORD_ARG[@]}" "${MARKER_ARG[*]}" "${pytest_args[@]}"; then

TEST_EXECUTION_SUCCEEDED=0

fi

else

# shellcheck disable=SC2086 # Double quote to prevent splitting and globbing.

if ! pipenv run pytest \

${TEST_VERBOSE_MODE} \

${MULTIPLE_WORKER_ARGS} ${FAILURE_ARGS} "${KEYWORD_ARG[@]}" "${MARKER_ARG[*]}" "${pytest_args[@]}" >"${TEMP_FILE}" 2>&1; then

TEST_EXECUTION_SUCCEEDED=0

fi

fi

# If there are "incomplete" testcases in the file, then we were interupted.

if grep "<testcase time=" "${TEST_RESULTS_XML_PATH}" >"${TEMP_FILE}" 2>&1; then

complete_process 1 "{Execution of full tests was interupted. Additional processing skipped.}"

fi

if [[ ${PYTHON_MODULE_NAME} == "project_summarizer" ]]; then

PYSCAN_SCRIPT_PATH=(python "${SCRIPT_DIR}/main.py")

else

PYSCAN_SCRIPT_PATH=(project_summarizer)

fi

# Determine if we report on the tests, or tests + coverage.

PYSCAN_REPORT_OPTIONS=(--junit "${TEST_RESULTS_XML_PATH}")

if [[ ${COVERAGE_MODE} -ne 0 ]]; then

if [[ ${TEST_EXECUTION_SUCCEEDED} -ne 0 ]]; then

PYSCAN_REPORT_OPTIONS+=(--cobertura "${TEST_COVERAGE_XML_PATH}")

else

echo "{Coverage was specified, but one or more tests failed. Skipping reporting of coverage.}"

fi

fi

echo "{Summarizing changes in execution of full test suite.}"

if ! pipenv run "${PYSCAN_SCRIPT_PATH[@]}" ${PYSCAN_OPTIONS} "${PYSCAN_REPORT_OPTIONS[@]}"; then

echo ""

complete_process 1 "{Summarizing changes in execution of full test suite failed.}"

fi