afb1143147
This commit deprecates run_tests.sh script and adds a deprecation document. We don't pay attention this script actually however, I suppose new people are coming and see the top of the directory and find this script and try to use this. And if something wrong happens, we need to ask and check 'which runner did you use?'. So I would like to reduce the ways to execute unit tests. Change-Id: Ia764fa3a15dc9faa753d4aca4c76462a8b9dd40b
194 lines
5.1 KiB
Bash
Executable File
194 lines
5.1 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
|
|
function usage {
|
|
echo "Usage: $0 [OPTION]..."
|
|
echo "Run Tempest unit tests"
|
|
echo ""
|
|
echo " -V, --virtual-env Always use virtualenv. Install automatically if not present"
|
|
echo " -N, --no-virtual-env Don't use virtualenv. Run tests in local environment"
|
|
echo " -n, --no-site-packages Isolate the virtualenv from the global Python environment"
|
|
echo " -f, --force Force a clean re-build of the virtual environment. Useful when dependencies have been added."
|
|
echo " -u, --update Update the virtual environment with any newer package versions"
|
|
echo " -t, --serial Run testr serially"
|
|
echo " -p, --pep8 Just run pep8"
|
|
echo " -c, --coverage Generate coverage report"
|
|
echo " -h, --help Print this usage message"
|
|
echo " -d, --debug Run tests with testtools instead of testr. This allows you to use PDB"
|
|
echo " -- [TESTROPTIONS] After the first '--' you can pass arbitrary arguments to testr "
|
|
}
|
|
|
|
function deprecation_warning {
|
|
cat <<EOF
|
|
-------------------------------------------------------------------------
|
|
WARNING: run_tests.sh is deprecated and this script will be removed after
|
|
the Newton release. All tests should be run through testr/ostestr or tox.
|
|
|
|
To run style checks:
|
|
|
|
tox -e pep8
|
|
|
|
To run python 2.7 unit tests
|
|
|
|
tox -e py27
|
|
|
|
To run unit tests and generate coverage report
|
|
|
|
tox -e cover
|
|
|
|
To run a subset of any of these tests:
|
|
|
|
tox -e py27 someregex
|
|
|
|
i.e.: tox -e py27 test_servers
|
|
|
|
Additional tox targets are available in tox.ini. For more information
|
|
see:
|
|
http://docs.openstack.org/project-team-guide/project-setup/python.html
|
|
|
|
NOTE: if you want to use testr to run tests, you can instead use:
|
|
|
|
OS_TEST_PATH=./tempest/tests testr run
|
|
|
|
Documentation on using testr directly can be found at
|
|
http://testrepository.readthedocs.org/en/latest/MANUAL.html
|
|
-------------------------------------------------------------------------
|
|
EOF
|
|
}
|
|
|
|
testrargs=""
|
|
just_pep8=0
|
|
venv=${VENV:-.venv}
|
|
with_venv=tools/with_venv.sh
|
|
serial=0
|
|
always_venv=0
|
|
never_venv=0
|
|
no_site_packages=0
|
|
debug=0
|
|
force=0
|
|
coverage=0
|
|
wrapper=""
|
|
config_file=""
|
|
update=0
|
|
|
|
deprecation_warning
|
|
|
|
if ! options=$(getopt -o VNnfuctphd -l virtual-env,no-virtual-env,no-site-packages,force,update,serial,coverage,pep8,help,debug -- "$@")
|
|
then
|
|
# parse error
|
|
usage
|
|
exit 1
|
|
fi
|
|
|
|
eval set -- $options
|
|
first_uu=yes
|
|
while [ $# -gt 0 ]; do
|
|
case "$1" in
|
|
-h|--help) usage; exit;;
|
|
-V|--virtual-env) always_venv=1; never_venv=0;;
|
|
-N|--no-virtual-env) always_venv=0; never_venv=1;;
|
|
-n|--no-site-packages) no_site_packages=1;;
|
|
-f|--force) force=1;;
|
|
-u|--update) update=1;;
|
|
-d|--debug) debug=1;;
|
|
-p|--pep8) let just_pep8=1;;
|
|
-c|--coverage) coverage=1;;
|
|
-t|--serial) serial=1;;
|
|
--) [ "yes" == "$first_uu" ] || testrargs="$testrargs $1"; first_uu=no ;;
|
|
*) testrargs="$testrargs $1";;
|
|
esac
|
|
shift
|
|
done
|
|
|
|
|
|
cd `dirname "$0"`
|
|
|
|
if [ $no_site_packages -eq 1 ]; then
|
|
installvenvopts="--no-site-packages"
|
|
fi
|
|
|
|
function testr_init {
|
|
if [ ! -d .testrepository ]; then
|
|
${wrapper} testr init
|
|
fi
|
|
}
|
|
|
|
function run_tests {
|
|
testr_init
|
|
${wrapper} find . -type f -name "*.pyc" -delete
|
|
export OS_TEST_PATH=./tempest/tests
|
|
if [ $debug -eq 1 ]; then
|
|
if [ "$testrargs" = "" ]; then
|
|
testrargs="discover ./tempest/tests"
|
|
fi
|
|
${wrapper} python -m testtools.run $testrargs
|
|
return $?
|
|
fi
|
|
|
|
if [ $coverage -eq 1 ]; then
|
|
${wrapper} python setup.py test --coverage
|
|
return $?
|
|
fi
|
|
|
|
if [ $serial -eq 1 ]; then
|
|
${wrapper} testr run --subunit $testrargs | ${wrapper} subunit-trace -n -f
|
|
else
|
|
${wrapper} testr run --parallel --subunit $testrargs | ${wrapper} subunit-trace -n -f
|
|
fi
|
|
}
|
|
|
|
function run_pep8 {
|
|
echo "Running flake8 ..."
|
|
if [ $never_venv -eq 1 ]; then
|
|
echo "**WARNING**:" >&2
|
|
echo "Running flake8 without virtual env may miss OpenStack HACKING detection" >&2
|
|
fi
|
|
${wrapper} flake8
|
|
}
|
|
|
|
if [ $never_venv -eq 0 ]
|
|
then
|
|
# Remove the virtual environment if --force used
|
|
if [ $force -eq 1 ]; then
|
|
echo "Cleaning virtualenv..."
|
|
rm -rf ${venv}
|
|
fi
|
|
if [ $update -eq 1 ]; then
|
|
echo "Updating virtualenv..."
|
|
virtualenv $installvenvopts $venv
|
|
$venv/bin/pip install -U -r requirements.txt -r test-requirements.txt
|
|
fi
|
|
if [ -e ${venv} ]; then
|
|
wrapper="${with_venv}"
|
|
else
|
|
if [ $always_venv -eq 1 ]; then
|
|
# Automatically install the virtualenv
|
|
virtualenv $installvenvopts $venv
|
|
wrapper="${with_venv}"
|
|
${wrapper} pip install -U -r requirements.txt -r test-requirements.txt
|
|
else
|
|
echo -e "No virtual environment found...create one? (Y/n) \c"
|
|
read use_ve
|
|
if [ "x$use_ve" = "xY" -o "x$use_ve" = "x" -o "x$use_ve" = "xy" ]; then
|
|
# Install the virtualenv and run the test suite in it
|
|
virtualenv $installvenvopts $venv
|
|
wrapper=${with_venv}
|
|
${wrapper} pip install -U -r requirements.txt -r test-requirements.txt
|
|
fi
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
if [ $just_pep8 -eq 1 ]; then
|
|
run_pep8
|
|
exit
|
|
fi
|
|
|
|
run_tests
|
|
retval=$?
|
|
|
|
if [ -z "$testrargs" ]; then
|
|
run_pep8
|
|
fi
|
|
|
|
exit $retval
|