Add pre-commit

This is helpful to automate code style checks when commiting, avoiding
the need to remember to do this manually.

The run_tests.sh script has been removed from the repository since
it is outdated, unused and had a number of uncaught formatting issues.

Change-Id: Id3f38942972bc6d35427e66bb26f8f1b2f271f7d

.pre-commit-config.yaml

@@ -0,0 +1,39 @@
+---
+default_language_version:
+  # force all unspecified python hooks to run python3
+  python: python3
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+      - id: trailing-whitespace
+      - id: mixed-line-ending
+        args: ['--fix', 'lf']
+        exclude: '.*\.(svg)$'
+      - id: check-byte-order-marker
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: debug-statements
+      - id: check-yaml
+        files: .*\.(yaml|yml)$
+        exclude: '^(zuul.d|rally-jobs)/.*$'
+  - repo: https://github.com/PyCQA/doc8
+    rev: v1.1.1
+    hooks:
+      - id: doc8
+        args: ['--ignore', 'D001']
+  - repo: https://github.com/openstack/bashate
+    rev: 2.1.1
+    hooks:
+      - id: bashate
+        args: ['--ignore', 'E006,E042,E043']
+  - repo: local
+    hooks:
+      - id: flake8
+        name: flake8
+        additional_dependencies:
+          - hacking>=6.1.0,<6.2.0
+        language: python
+        entry: flake8
+        files: '^.*\.py$'
+        exclude: '^(doc|releasenotes|tools)/.*$'

run_tests.sh

@@ -1,195 +0,0 @@
-#!/bin/bash
-
-set -eu
-
-function usage {
-  echo "Usage: $0 [OPTION]..."
-  echo "Run python-manilaclient test suite"
-  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 "  -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."
-  exit
-}
-
-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;;
-    -d|--debug) debug=1;;
-    -*) testropts="$testropts $1";;
-    *) testrargs="$testrargs $1"
-  esac
-}
-
-venv=.venv
-with_venv=tools/with_venv.sh
-always_venv=0
-never_venv=0
-force=0
-no_site_packages=0
-installvenvopts=
-testrargs=
-testropts=
-wrapper=""
-just_pep8=0
-no_pep8=0
-coverage=0
-debug=0
-
-LANG=en_US.UTF-8
-LANGUAGE=en_US:en
-LC_ALL=C
-
-for arg in "$@"; do
-  process_option $arg
-done
-
-if [ $no_site_packages -eq 1 ]; then
-  installvenvopts="--no-site-packages"
-fi
-
-function init_testr {
-  if [ ! -d .testrepository ]; then
-    ${wrapper} testr init
-  fi
-}
-
-function run_tests {
-  # Cleanup *pyc
-  ${wrapper} find . -type f -name "*.pyc" -delete
-
-  if [ $debug -eq 1 ]; then
-    if [ "$testropts" = "" ] && [ "$testrargs" = "" ]; then
-      # Default to running all tests if specific test is not
-      # provided.
-      testrargs="discover ./tests"
-    fi
-    ${wrapper} python -m testtools.run $testropts $testrargs
-
-    # Short circuit because all of the testr and coverage stuff
-    # below does not make sense when running testtools.run for
-    # debugging purposes.
-    return $?
-  fi
-
-  if [ $coverage -eq 1 ]; then
-    # Do not test test_coverage_ext when gathering coverage.
-    if [ "x$testrargs" = "x" ]; then
-      testrargs="^(?!.*test_coverage_ext).*$"
-    fi
-    export PYTHON="${wrapper} coverage run --source manilaclient --parallel-mode"
-  fi
-  # Just run the test suites in current environment
-  set +e
-  TESTRTESTS="$TESTRTESTS $testrargs"
-  echo "Running \`${wrapper} $TESTRTESTS\`"
-  ${wrapper} $TESTRTESTS
-  RESULT=$?
-  set -e
-
-  copy_subunit_log
-
-  return $RESULT
-}
-
-function copy_subunit_log {
-  LOGNAME=`cat .testrepository/next-stream`
-  LOGNAME=$(($LOGNAME - 1))
-  LOGNAME=".testrepository/${LOGNAME}"
-  cp $LOGNAME subunit.log
-}
-
-function run_pep8 {
-  echo "Running pep8 ..."
-  srcfiles="manilaclient"
-  # 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}
-}
-
-TESTRTESTS="testr run --parallel $testropts"
-
-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
-fi
-
-init_testr
-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.
-if [ -z "$testrargs" ]; then
-  if [ $no_pep8 -eq 0 ]; then
-    run_pep8
-  fi
-fi
-
-if [ $coverage -eq 1 ]; then
-    echo "Generating coverage report in covhtml/"
-    ${wrapper} coverage combine
-    ${wrapper} coverage html --include='manilaclient/*' --omit='manilaclient/openstack/common/*' -d covhtml -i
-fi

test-requirements.txt

@@ -1,6 +1,4 @@
-hacking>=6.1.0,<6.2.0 # Apache-2.0
+coverage!=4.4,>=4.0 # Apache-2.0
-
-coverage>=4.4.1 # Apache-2.0
 ddt>=1.0.1 # MIT
 fixtures>=3.0.0 # Apache-2.0/BSD
 stestr>=2.0.0 # Apache-2.0

tox.ini

@@ -31,8 +31,11 @@ deps =
 commands = reno new {posargs}
 
 [testenv:pep8]
+deps =
+  pre-commit
+
 commands =
-  flake8
+  pre-commit run --all-files --show-diff-on-failure
 
 [testenv:venv]
 commands = {posargs}