[tox]
minversion = 3.1.1
skipsdist = True
envlist = docs,linters,functional
ignore_basepython_conflict = True

[testenv]
usedevelop = False
basepython = python3
commands =
    /usr/bin/find . -type f -name "*.pyc" -delete
passenv =
    COMMON_TESTS_PATH
    HOME
    http_proxy
    HTTP_PROXY
    https_proxy
    HTTPS_PROXY
    no_proxy
    NO_PROXY
    TESTING_BRANCH
    TESTING_HOME
    USER
allowlist_externals =
    bash
setenv =
    PYTHONUNBUFFERED=1
    ROLE_NAME=lxc_container_create
    TEST_IDEMPOTENCE=false
    VIRTUAL_ENV={envdir}
    WORKING_DIR={toxinidir}

[testenv:docs]
deps =
  -c{env:TOX_CONSTRAINTS_FILE:https://releases.openstack.org/constraints/upper/2023.1}
  -r{toxinidir}/doc/requirements.txt
commands =
    bash -c "rm -rf doc/build"
    doc8 doc
    sphinx-build -W --keep-going -b html doc/source doc/build/html

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

[doc8]
# Settings for doc8:
extensions = .rst

[testenv:releasenotes]
deps = {[testenv:docs]deps}
commands =
    sphinx-build -a -E -W -d releasenotes/build/doctrees --keep-going -b html releasenotes/source releasenotes/build/html

[testenv:venv]
commands =
    {posargs}

[testenv:pep8]
commands =
    bash -c "{toxinidir}/tests/common/test-pep8.sh"

[flake8]
# Ignores the following rules due to how ansible modules work in general
#     F403 'from ansible.module_utils.basic import *' used;
#          unable to detect undefined names
ignore=F403

[testenv:bashate]
commands =
    bash -c "{toxinidir}/tests/common/test-bashate.sh"

[testenv:ansible-syntax]
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-syntax.sh"

[testenv:ansible-lint]
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-lint.sh"

# Functional testing for BTRFS backed containers
[testenv:btrfs]
setenv =
    {[testenv]setenv}
    ANSIBLE_OVERRIDES={toxinidir}/tests/overrides-btrfs.yml
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"

# Functional testing for Directory backed containers
[testenv:dir]
setenv =
    {[testenv]setenv}
    ANSIBLE_OVERRIDES={toxinidir}/tests/overrides-dir.yml
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"

# Functional testing for machinectl backed containers
[testenv:mnctl]
setenv =
    {[testenv]setenv}
    ANSIBLE_OVERRIDES={toxinidir}/tests/overrides-machinectl.yml
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"

# Functional testing for OverlayFS backed containers
[testenv:ofs]
setenv =
    {[testenv]setenv}
    ANSIBLE_OVERRIDES={toxinidir}/tests/overrides-overlayfs.yml
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"

# Functional testing for ZFS backed containers
[testenv:zfs]
setenv =
    {[testenv]setenv}
    ANSIBLE_OVERRIDES={toxinidir}/tests/overrides-zfs.yml
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-functional.sh"

[testenv:functional]
setenv =
    {[testenv:dir]setenv}
commands =
    {[testenv:dir]commands}

[testenv:linters]
commands =
    bash -c "{toxinidir}/tests/common/test-ansible-env-prep.sh"
    {[testenv:pep8]commands}
    {[testenv:bashate]commands}
    {[testenv:ansible-lint]commands}
    {[testenv:ansible-syntax]commands}