Add openstack-common and test infrastructure.

Fix pep8 errors (project is pep8 clean now).

Update setup.py to use openstack-common style dependencies.

Remove the unused novaclient dependency.

Change the keystoneclient dependency to a git URL.

Add test-requires, and move some pip-requires dependencies
into it.

Remove the test_utils unit test which wasn't testing anything
that is actually present in the project.

Add the test_authors unit test.

Use tox for running tests locally.

See: http://wiki.openstack.org/ProjectTestingInterface

Tox can manage virtualenvs, and is currently doing so for running
tests in Jenkins. It's just as, or more, useful for running tests
locally, so this starts the migration from the run_tests system to
tox. The goal is to reduce duplicate testing infrastructure, and
get what's running locally on developer workstations as close to
what is run by Jenkins as possible.

Run_tests.sh will now call tox to facilitate the transition for
developers used to typing "run_tests.sh".

Developers will need tox installed on their workstations. It can
be installed from PyPI with "pip install tox". run_tests.sh outputs
those instructions if tox is not present.

New facilities are available using tox directly, including:

tox -e py26 # run tests under python 2.6
tox -e py27 # run tests under python 2.7
tox -e pep8 # run pep8 tests
tox # run all of the above
tox -e venv foo # run the command "foo" inside a virtualenv

The OpenStack nose plugin is used when running tox from the
command line, so the enhanced, colorized output is visible to
developers running the test suite locally. However, when Jenkins
runs tox, xunit output will be used instead, which is natively
understood by jenkins and much more readable in that context.

Change-Id: Ib627be3b37b5a09d3795006d412ddcc35f8c6c1e

1 files changed, 22 insertions, 125 deletions

diff --git a/run_tests.sh b/run_tests.sh
index 26d32e8b..b9252cac 100755
--- a/run_tests.sh
+++ b/run_tests.sh
@@ -1,152 +1,49 @@
 #!/bin/bash
 
-set -eu
-
 function usage {
   echo "Usage: $0 [OPTION]..."
-  echo "Run openstackclient test suite"
+  echo "Run python-openstackclient's test suite(s)"
   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 "  -s, --no-site-packages   Isolate the virtualenv from the global Python environment"
-  echo "  -x, --stop               Stop running tests after the first error or failure."
-  echo "  -f, --force              Force a clean re-build of the virtual environment. Useful when dependencies have been added."
   echo "  -p, --pep8               Just run pep8"
-  echo "  -P, --no-pep8            Don't run pep8"
-  echo "  -c, --coverage           Generate coverage report"
   echo "  -h, --help               Print this usage message"
-  echo "  --hide-elapsed           Don't print the elapsed time for each test along with slow test list"
   echo ""
-  echo "Note: with no options specified, the script will try to run the tests in a virtual environment,"
-  echo "      If no virtualenv is found, the script will ask if you would like to create one.  If you "
-  echo "      prefer to run tests NOT in a virtual environment, simply pass the -N option."
+  echo "This script is deprecated and currently retained for compatibility."
+  echo 'You can run the full test suite for multiple environments by running "tox".'
+  echo 'You can run tests for only python 2.7 by running "tox -e py27", or run only'
+  echo 'the pep8 tests with "tox -e pep8".'
   exit
 }
 
+command -v tox > /dev/null 2>&1
+if [ $? -ne 0 ]; then
+  echo 'This script requires "tox" to run.'
+  echo 'You can install it with "pip install tox".'
+  exit 1; 
+fi
+
+just_pep8=0
+
 function process_option {
   case "$1" in
     -h|--help) usage;;
-    -V|--virtual-env) always_venv=1; never_venv=0;;
-    -N|--no-virtual-env) always_venv=0; never_venv=1;;
-    -s|--no-site-packages) no_site_packages=1;;
-    -f|--force) force=1;;
-    -p|--pep8) just_pep8=1;;
-    -P|--no-pep8) no_pep8=1;;
-    -c|--coverage) coverage=1;;
-    -*) noseopts="$noseopts $1";;
-    *) noseargs="$noseargs $1"
+    -p|--pep8) let just_pep8=1;;
   esac
 }
 
-venv=.venv
-with_venv=tools/with_venv.sh
-always_venv=0
-never_venv=0
-force=0
-no_site_packages=0
-installvenvopts=
-noseargs=
-noseopts=
-wrapper=""
-just_pep8=0
-no_pep8=0
-coverage=0
-
 for arg in "$@"; do
   process_option $arg
 done
 
-# If enabled, tell nose to collect coverage data 
-if [ $coverage -eq 1 ]; then
-    noseopts="$noseopts --with-coverage --cover-package=openstackclient"
-fi
-
-if [ $no_site_packages -eq 1 ]; then
-  installvenvopts="--no-site-packages"
-fi
-
-function run_tests {
-  # Just run the test suites in current environment
-  ${wrapper} $NOSETESTS
-  # If we get some short import error right away, print the error log directly
-  RESULT=$?
-  return $RESULT
-}
-
-function run_pep8 {
-  echo "Running pep8 ..."
-  srcfiles="openstackclient tests"
-  # Just run PEP8 in current environment
-  #
-  # NOTE(sirp): W602 (deprecated 3-arg raise) is being ignored for the
-  # following reasons:
-  #
-  #  1. It's needed to preserve traceback information when re-raising
-  #     exceptions; this is needed b/c Eventlet will clear exceptions when
-  #     switching contexts.
-  #
-  #  2. There doesn't appear to be an alternative, "pep8-tool" compatible way of doing this
-  #     in Python 2 (in Python 3 `with_traceback` could be used).
-  #
-  #  3. Can find no corroborating evidence that this is deprecated in Python 2
-  #     other than what the PEP8 tool claims. It is deprecated in Python 3, so,
-  #     perhaps the mistake was thinking that the deprecation applied to Python 2
-  #     as well.
-  pep8_opts="--ignore=E202,W602 --repeat"
-  ${wrapper} pep8 ${pep8_opts} ${srcfiles}
-}
-
-NOSETESTS="nosetests $noseopts $noseargs"
-
-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 [ -e ${venv} ]; then
-    wrapper="${with_venv}"
-  else
-    if [ $always_venv -eq 1 ]; then
-      # Automatically install the virtualenv
-      python tools/install_venv.py $installvenvopts
-      wrapper="${with_venv}"
-    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
-        python tools/install_venv.py $installvenvopts
-        wrapper=${with_venv}
-      fi
-    fi
-  fi
-fi
-
-# Delete old coverage data from previous runs
-if [ $coverage -eq 1 ]; then
-    ${wrapper} coverage erase
-fi
-
 if [ $just_pep8 -eq 1 ]; then
-    run_pep8
-    exit
+  tox -e pep8
+  exit
 fi
 
-run_tests
-
-# NOTE(sirp): we only want to run pep8 when we're running the full-test suite,
-# not when we're running tests individually. To handle this, we need to
-# distinguish between options (noseopts), which begin with a '-', and
-# arguments (noseargs).
-if [ -z "$noseargs" ]; then
-  if [ $no_pep8 -eq 0 ]; then
-    run_pep8
-  fi
+tox -e py27 $toxargs 2>&1 | tee run_tests.err.log  || exit
+if [ ${PIPESTATUS[0]} -ne 0 ]; then
+  exit ${PIPESTATUS[0]}
 fi
 
-if [ $coverage -eq 1 ]; then
-    echo "Generating coverage report in covhtml/"
-    ${wrapper} coverage html -d covhtml -i
+if [ -z "$toxargs" ]; then
+  tox -e pep8
 fi