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

[testenv]
description =
  Run unit tests.
usedevelop = true
allowlist_externals =
  find
  rm
  make
passenv =
  ZUUL_CACHE_DIR
  REQUIREMENTS_PIP_LOCATION
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt
commands =
  find . -type f -name "*.pyc" -delete
  stestr run {posargs}

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

[testenv:bandit]
description =
  Run security checks.
deps =
  pre-commit
commands =
  pre-commit run --all-files --show-diff-on-failure bandit

[testenv:venv]
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
  -r{toxinidir}/test-requirements.txt
  -r{toxinidir}/requirements.txt
  -r{toxinidir}/doc/requirements.txt
commands = {posargs}

[testenv:docs]
description =
  Build documentation in HTML format.
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
  -r{toxinidir}/doc/requirements.txt
commands =
  rm -rf doc/build/html doc/build/doctrees
  sphinx-build -W -b html -d doc/build/doctrees doc/source doc/build/html
  # Test the redirects. This must run after the main docs build
  whereto doc/build/html/.htaccess doc/test/redirect-tests.txt

[testenv:pdf-docs]
description =
  Build documentation in PDF format.
deps = {[testenv:docs]deps}
commands =
  rm -rf doc/build/pdf
  sphinx-build -W -b latex doc/source doc/build/pdf
  make -C doc/build/pdf

[testenv:releasenotes]
description =
  Build release notes.
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2026.1}
  -r{toxinidir}/doc/requirements.txt
commands =
  sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

[testenv:functional{,-py310,-py311,-py312,-py313}]
description =
  Run functional tests.
passenv =
  OS_*
commands =
  stestr --test-path=./novaclient/tests/functional run --concurrency=1 {posargs}
  python novaclient/tests/functional/hooks/check_resources.py

[testenv:cover]
description =
  Run unit tests and print coverage information.
setenv =
  PYTHON=coverage run --source novaclient --parallel-mode
commands =
  stestr run {posargs}
  coverage combine
  coverage html -d cover
  coverage xml -o cover/coverage.xml
  coverage report

[flake8]
# Following checks should be enabled in the future.
#
# H404 multi line docstring should start without a leading new line
# H405 multi line docstring summary not separated with an empty line
#
# Following checks are ignored on purpose.
#
# Additional checks are also ignored on purpose: F811, F821, W504
ignore = E731,F811,F821,H404,H405,W504
show-source = true
exclude=.venv,.git,.tox,dist,*lib/python*,*egg,build,doc/source/conf.py,releasenotes

[hacking]
import_exceptions = novaclient.i18n

[testenv:bindep]
description =
  Check for installed binary dependencies.
# Do not install any requirements. We want this to be fast and work even if
# system dependencies are missing, since it's used to tell you what system
# dependencies are missing! This also means that bindep must be installed
# separately, outside of the requirements files.
deps = bindep
skip_install = true
commands = bindep test