tox.ini

[tox]
minversion = 4.28.0
envlist = py3,pep8,docs

[testenv]
usedevelop = True
allowlist_externals =
  find
  rm
constraints =
  {env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}
setenv =
  OS_STDOUT_CAPTURE=1
  OS_STDERR_CAPTURE=1
  OS_TEST_TIMEOUT=30
  PYTHONDONTWRITEBYTECODE=1
# Optionally install package extras via environment variable, e.g. WATCHER_EXTRAS=monasca tox -e py3
extras =
  {env:WATCHER_EXTRAS:}
deps =
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt
commands =
  rm -f .testrepository/times.dbm
  find . -type f -name "*.py[c|o]" -delete
  stestr run {posargs}
passenv =
  OS_DEBUG
  # NOTE(sean-k-mooney) optimization is enabled by default and when enabled
  # asserts are complied out. Disable optimization to allow asserts in
  # nova to fire in unit and functional tests. This can be useful for
  # debugging issue with fixtures and mocks.
  PYTHONOPTIMIZE

[testenv:{unit,py3,py311,py312,py313,py314}]
commands =
  rm -f .testrepository/times.dbm
  find . -type f -name "*.py[c|o]" -delete
  stestr --test-path=./watcher/tests/unit run {posargs}

[testenv:functional{,-py310,-py311,-py312,-py313,-py314}]
passenv =
  {[testenv]passenv}
  WATCHER_FUNC_TEST_LOG_DIR
commands =
  rm -f .testrepository/times.dbm
  find . -type f -name "*.py[c|o]" -delete
  # --group-regex: all tests in the same gabbit makes tests faster
  stestr --test-path=./watcher/tests/functional --group-regex='watcher\.tests\.functional\.test_gabbi\.[^_]+' run {posargs}

[testenv:pep8]
description =
  Run style checks.
skip_install = true
deps =
  pre-commit
commands =
  pre-commit run --all-files --show-diff-on-failure

[testenv:venv]
setenv =
  PYTHONHASHSEED=0
deps =
  -r{toxinidir}/doc/requirements.txt
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt
commands =
  {posargs}

[testenv:cover]
setenv =
  PYTHON=coverage run --source watcher --parallel-mode
commands =
  stestr --test-path=./watcher/tests/unit run {posargs}
  coverage combine
  coverage html -d cover
  coverage xml -o cover/coverage.xml
  coverage report

[testenv:debug]
commands =
  oslo_debug_helper -t watcher/tests {posargs}

[testenv:genconfig]
commands =
  oslo-config-generator --config-file etc/watcher/oslo-config-generator/watcher.conf

[testenv:genpolicy]
commands =
  oslopolicy-sample-generator --config-file etc/watcher/oslo-policy-generator/watcher-policy-generator.conf

[testenv:docs]
setenv =
  PYTHONHASHSEED=0
deps =
  -r{toxinidir}/doc/requirements.txt
commands =
  rm -fr doc/build doc/source/api/ .autogenerated
  sphinx-build -W --keep-going -b html doc/source doc/build/html

[testenv:pdf-docs]
deps =
  {[testenv:docs]deps}
allowlist_externals =
  rm
  make
commands =
  rm -rf doc/build/pdf
  sphinx-build -W --keep-going -b latex doc/source doc/build/pdf
  make -C doc/build/pdf

[testenv:api-ref]
deps =
  -r{toxinidir}/doc/requirements.txt
allowlist_externals =
  bash
commands =
  bash -c 'rm -rf api-ref/build'
  sphinx-build -W --keep-going -b html -d api-ref/build/doctrees api-ref/source api-ref/build/html

[testenv:releasenotes]
deps =
  {[testenv:docs]deps}
commands =
  rm -rf releasenotes/build
  sphinx-build -W --keep-going -b html -j auto releasenotes/source releasenotes/build/html

[testenv:bandit]
skip_install = true
deps =
  {[testenv:pep8]deps}
commands =
  pre-commit run --all-files --show-diff-on-failure bandit

[flake8]
filename = *.py
show-source = True
select = H,N
# W504 line break after binary operator
# H301 one import per line incorrectly triggers when
# imports need to be wrapped in () due to line length
# H306 ruff handles imports
ignore = H105,H202,H306,H301,N320
builtins = _
enable-extensions = H106,H203,H904
exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,*sqlalchemy/alembic/versions/*,demo/,releasenotes

[hacking]
import_exceptions = watcher._i18n

[flake8:local-plugins]
extension =
   N319 = checks:no_translate_debug_logs
   N321 = checks:use_jsonutils
   N322 = checks:check_assert_called_once_with
   N327 = checks:check_python3_no_iteritems
   N328 = checks:check_asserttrue
   N329 = checks:check_assertfalse
   N330 = checks:check_assertempty
   N331 = checks:check_assertisinstance
   N332 = checks:check_assertequal_for_httpcode
   N340 = checks:check_oslo_i18n_wrapper
   N341 = checks:check_builtins_gettext
   N342 = checks:no_redundant_import_alias
paths = ./watcher/hacking