minversion = 4.3.0

envlist = py3,pep8

description =

Run unit tests.

usedevelop = true

setenv =

OS_STDOUT_CAPTURE=1

OS_STDERR_CAPTURE=1

OS_TEST_TIMEOUT=60

deps =

-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}

-r{toxinidir}/test-requirements.txt

-r{toxinidir}/requirements.txt

commands =

stestr run {posargs}

description =

Run style checks.

deps =

pre-commit

{[testenv:mypy]deps}

commands =

pre-commit run --all-files --show-diff-on-failure

{[testenv:mypy]commands}

description =

Run type checks.

deps =

{[testenv]deps}

mypy

types-requests

commands =

mypy --cache-dir="{envdir}/mypy_cache" {posargs:openstackclient}

commands =

python -m pip install -q -U -e {toxinidir}/../cliff#egg=cliff

python -m pip install -q -U -e {toxinidir}/../keystoneauth#egg=keystoneauth

python -m pip install -q -U -e {toxinidir}/../osc-lib#egg=osc_lib

python -m pip install -q -U -e {toxinidir}/../openstacksdk#egg=openstacksdk

python -m pip freeze

stestr run {posargs}

description =

Run functional tests.

setenv =

OS_TEST_PATH=./openstackclient/tests/functional

passenv =

OS_*

commands =

tips: python -m pip install -q -U -e {toxinidir}/../cliff#egg=cliff

tips: python -m pip install -q -U -e {toxinidir}/../keystoneauth#egg=keystoneauth1

tips: python -m pip install -q -U -e {toxinidir}/../osc-lib#egg=osc_lib

tips: python -m pip install -q -U -e {toxinidir}/../openstacksdk#egg=openstacksdk

tips: python -m pip freeze

{[testenv]commands}

description =

Run specified command in a virtual environment with all dependencies installed.

deps =

-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}

-r{toxinidir}/requirements.txt

-r{toxinidir}/doc/requirements.txt

commands =

{posargs}

description =

Run unit tests and generate coverage report.

setenv =

{[testenv]setenv}

PYTHON=coverage run --source openstackclient --parallel-mode

commands =

stestr run {posargs}

coverage combine

coverage html -d cover

coverage xml -o cover/coverage.xml

description =

Run specified tests through oslo_debug_helper, which allows use of pdb.

passenv =

OS_*

commands =

oslo_debug_helper -t openstackclient/tests {posargs}

description =

Build documentation in HTML format.

deps =

-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}

-r{toxinidir}/doc/requirements.txt

commands =

sphinx-build -a -E -W -d doc/build/doctrees -b html doc/source doc/build/html

sphinx-build -a -E -W -d doc/build/doctrees -b man doc/source doc/build/man

# Validate redirects (must be done after the docs build

whereto doc/build/html/.htaccess doc/test/redirect-tests.txt

description =

Build release note documentation in HTML format.

deps =

-c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/master}

-r{toxinidir}/doc/requirements.txt

commands =

sphinx-build -a -E -W -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html

show-source = true

exclude = .venv,.git,.tox,dist,doc,*lib/python*,*egg,build,tools,releasenotes

select = H,O

ignore = H301

import-order-style = pep8

application_import_names = openstackclient

extension =

O400 = checks:assert_no_oslo

O401 = checks:assert_no_duplicated_setup

O402 = checks:assert_use_of_client_aliases

O403 = checks:assert_find_ignore_missing_kwargs

O404 = checks:assert_use_of_osc_command

paths = ./hacking

import_exceptions =

collections.abc

openstackclient.i18n

typing