5a785482ab
All CI used to go through scripts/generic-ci-tests.sh, which is a wrapper around various `paver` test/linting/check invocations. These days, most edx-platform CI checks just invoke their tools (pylint, pycodestyle, pytest, etc.) directly. In anticipation of the proposed Paver deprecation [1], let's remove the parts of this script that aren't used any more, including several `paver` command invocations. This should have no impact on CI. Furthermore, we are able to remove the SHARD environment variable, which was formely used to split unit and quality checks up into smaller pieces. Unit tests and pylint checks now have their own separate sharding logic, so there is only one "quality" shard remaining (SHARD=4, ie generic quality checks), thus we don't need a SHARD variable at all. [1] https://github.com/openedx/edx-platform/issues/34467
125 lines
4.2 KiB
Bash
Executable File
125 lines
4.2 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
set -e
|
|
|
|
###############################################################################
|
|
#
|
|
# generic-ci-tests.sh
|
|
#
|
|
# Execute some tests for edx-platform.
|
|
# (Most other tests are run by invoking `pytest`, `pylint`, etc. directly)
|
|
#
|
|
# This script can be called from CI jobs that define
|
|
# these environment variables:
|
|
#
|
|
# `TEST_SUITE` defines which kind of test to run.
|
|
# Possible values are:
|
|
#
|
|
# - "quality": Run the quality (pycodestyle/pylint) checks
|
|
# - "js-unit": Run the JavaScript tests
|
|
# - "pavelib-js-unit": Run the JavaScript tests and the Python unit
|
|
# tests from the pavelib/lib directory
|
|
#
|
|
###############################################################################
|
|
|
|
# Clean up previous builds
|
|
git clean -qxfd
|
|
|
|
function emptyxunit {
|
|
|
|
cat > "reports/$1.xml" <<END
|
|
<?xml version="1.0" encoding="UTF-8"?>
|
|
<testsuite name="$1" tests="1" errors="0" failures="0" skip="0">
|
|
<testcase classname="pavelib.quality" name="$1" time="0.604"></testcase>
|
|
</testsuite>
|
|
END
|
|
|
|
}
|
|
|
|
# if specified tox environment is supported, prepend paver commands
|
|
# with tox env invocation
|
|
if [ -z ${TOX_ENV+x} ] || [[ ${TOX_ENV} == 'null' ]]; then
|
|
echo "TOX_ENV: ${TOX_ENV}"
|
|
TOX=""
|
|
elif tox -l |grep -q "${TOX_ENV}"; then
|
|
if [[ "${TOX_ENV}" == 'quality' ]]; then
|
|
TOX=""
|
|
else
|
|
TOX="tox -r -e ${TOX_ENV} --"
|
|
fi
|
|
else
|
|
echo "${TOX_ENV} is not currently supported. Please review the"
|
|
echo "tox.ini file to see which environments are supported"
|
|
exit 1
|
|
fi
|
|
|
|
PAVER_ARGS="-v"
|
|
export SUBSET_JOB=$JOB_NAME
|
|
|
|
function run_paver_quality {
|
|
QUALITY_TASK=$1
|
|
shift
|
|
mkdir -p test_root/log/
|
|
LOG_PREFIX="test_root/log/$QUALITY_TASK"
|
|
$TOX paver "$QUALITY_TASK" "$@" 2> "$LOG_PREFIX.err.log" > "$LOG_PREFIX.out.log" || {
|
|
echo "STDOUT (last 100 lines of $LOG_PREFIX.out.log):";
|
|
tail -n 100 "$LOG_PREFIX.out.log"
|
|
echo "STDERR (last 100 lines of $LOG_PREFIX.err.log):";
|
|
tail -n 100 "$LOG_PREFIX.err.log"
|
|
return 1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
case "$TEST_SUITE" in
|
|
|
|
"quality")
|
|
EXIT=0
|
|
|
|
mkdir -p reports
|
|
|
|
echo "Finding fixme's and storing report..."
|
|
run_paver_quality find_fixme || { EXIT=1; }
|
|
echo "Finding pycodestyle violations and storing report..."
|
|
run_paver_quality run_pep8 || { EXIT=1; }
|
|
echo "Finding ESLint violations and storing report..."
|
|
run_paver_quality run_eslint -l "$ESLINT_THRESHOLD" || { EXIT=1; }
|
|
echo "Finding Stylelint violations and storing report..."
|
|
run_paver_quality run_stylelint || { EXIT=1; }
|
|
echo "Running xss linter report."
|
|
run_paver_quality run_xsslint -t "$XSSLINT_THRESHOLDS" || { EXIT=1; }
|
|
echo "Running PII checker on all Django models..."
|
|
run_paver_quality run_pii_check || { EXIT=1; }
|
|
echo "Running reserved keyword checker on all Django models..."
|
|
run_paver_quality check_keywords || { EXIT=1; }
|
|
|
|
# Need to create an empty test result so the post-build
|
|
# action doesn't fail the build.
|
|
emptyxunit "stub"
|
|
exit "$EXIT"
|
|
;;
|
|
|
|
"js-unit")
|
|
$TOX paver test_js --coverage
|
|
$TOX paver diff_coverage
|
|
;;
|
|
|
|
"pavelib-js-unit")
|
|
EXIT=0
|
|
$TOX paver test_js --coverage --skip-clean || { EXIT=1; }
|
|
paver test_lib --skip-clean $PAVER_ARGS || { EXIT=1; }
|
|
|
|
# This is to ensure that the build status of the shard is properly set.
|
|
# Because we are running two paver commands in a row, we need to capture
|
|
# their return codes in order to exit with a non-zero code if either of
|
|
# them fail. We put the || clause there because otherwise, when a paver
|
|
# command fails, this entire script will exit, and not run the second
|
|
# paver command in this case statement. So instead of exiting, the value
|
|
# of a variable named EXIT will be set to 1 if either of the paver
|
|
# commands fail. We then use this variable's value as our exit code.
|
|
# Note that by default the value of this variable EXIT is not set, so if
|
|
# neither command fails then the exit command resolves to simply exit
|
|
# which is considered successful.
|
|
exit "$EXIT"
|
|
;;
|
|
esac
|