monasca-log-api/tox.ini

[tox]
envlist = py{27,35},pep8,cover
minversion = 2.7
skipsdist = True

[testenv]
usedevelop = True
setenv = VIRTUAL_ENV={envdir}
         OS_TEST_PATH=monasca_log_api/tests
passenv = *_proxy
          *_PROXY
whitelist_externals = bash
                      find
                      rm
install_command = pip install {opts} {packages}
deps =
  -c{env:UPPER_CONSTRAINTS_FILE:https://git.openstack.org/cgit/openstack/requirements/plain/upper-constraints.txt}
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt
commands =
  find ./ -type f -name '*.pyc' -delete

[testenv:py27]
description = Runs unit test using Python2.7
basepython = python2.7
commands =
  {[testenv]commands}
  stestr run {posargs}

[testenv:py35]
description = Runs unit test using Python3.5
basepython = python3.5
commands =
  {[testenv]commands}
  stestr run {posargs}

[testenv:py36]
description = Runs unit test using Python3.6
basepython = python3.6
commands =
  {[testenv]commands}
  stestr run {posargs}

[testenv:cover]
description = Calculates code coverage
basepython = python2.7
commands =
  {[testenv]commands}
  coverage erase
  python setup.py test --coverage --testr-args='{posargs}' --coverage-package-name=monasca_log_api
  coverage report

[testenv:debug]
basepython = python3
description = Allows to run unit-test with debug mode enabled
commands =
  {[testenv]commands}
  oslo_debug_helper -t {toxinidir}/monasca_log_api/tests {posargs}

[testenv:bashate]
basepython = python3
description = Validates (pep8-like) devstack plugins
skip_install = True
usedevelop = False
commands = bash {toxinidir}/tools/bashate.sh {toxinidir}/devstack

[testenv:bandit]
basepython = python3
description = Validates codebase with bandit
skip_install = True
usedevelop = False
commands =
  # FIXME(dmllr); B101 needs to be fixed first
  bandit -r monasca_log_api -n5 -s B101 -x monasca_log_api/tests

[testenv:pep8]
basepython = python3
description = Runs set of linters against codebase (flake8, bandit, bashate, checkniceness)
commands =
  {[testenv]commands}
  {[testenv:flake8]commands}
  {[testenv:bandit]commands}
  {[testenv:bashate]commands}
  {[testenv:checkniceness]commands}

[testenv:flake8]
basepython = python3
description = Validates codebase with flake
commands =
  {[testenv]commands}
  flake8 monasca_log_api

[testenv:genconfig]
basepython = python3
description = Generates sample documentation file for monasca-log-api
commands = oslo-config-generator --config-file=config-generator/monasca-log-api.conf

[testenv:docs]
basepython = python3
description = Builds api-ref, api-guide, releasenotes and devdocs
commands =
  {[testenv]commands}
  {[testenv:devdocs]commands}
  {[testenv:api-guide]commands}
  {[testenv:api-ref]commands}
  {[testenv:releasenotes]commands}

[testenv:api-guide]
basepython = python3
description = Called from CI scripts to test and publish the API Guide
commands =
  {[testenv]commands}
  rm -rf api-guide/build
  {[testenv:checkjson]commands}
  sphinx-build -W -b html -d api-guide/build/doctrees api-guide/source api-guide/build/html

[testenv:api-ref]
basepython = python3
description = Called from CI scripts to test and publish the API Ref
commands =
  {[testenv]commands}
  rm -rf api-ref/build
  {[testenv:checkjson]commands}
  sphinx-build -W -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html

[testenv:releasenotes]
basepython = python3
description = Called from CI script to test and publish the Release Notes
commands =
  rm -rf releasenotes/build
  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

[testenv:devdocs]
basepython = python3
description = Builds developer documentation
commands =
  {[testenv]commands}
  rm -rf doc/build
  rm -rf doc/source/contributor/api
  {[testenv:checkjson]commands}
  python setup.py build_sphinx

[testenv:checkniceness]
basepython = python3
description = Validates (pep-like) documenation
skip_install = True
usedevelop = False
commands =
  {[testenv]commands}
  doc8 --file-encoding utf-8 {toxinidir}/doc
  doc8 --file-encoding utf-8 {toxinidir}/api-ref
  doc8 --file-encoding utf-8 {toxinidir}/api-guide
  doc8 --file-encoding utf-8 {toxinidir}/releasenotes

[testenv:checkjson]
basepython = python3
description = Validates all json samples inside doc folder
skip_install = True
usedevelop = False
deps =
whitelist_externals =
    bash
    python
    find
    rm
commands =
  {[testenv]commands}
  bash -c "! find doc/ -type f -name *.json | xargs grep -U -n $'\r'"
  bash -c '! find doc/ -type f -name *.json | xargs -t -n1 python -m json.tool 2>&1 > /dev/null | grep -B1 -v ^python'

[testenv:venv]
basepython = python3
commands = {posargs}

[flake8]
max-line-length = 100
exclude = .git,.tox,dist,doc,api-ref,api-guide,releasenotes,documentation,*.egg,build
show-source = True
enable-extensions = H203,H106

[hacking]
import_exceptions =
  six.moves

[testenv:lower-constraints]
basepython = python3
deps =
  -c{toxinidir}/lower-constraints.txt
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt