tox.ini

# spell-checker:ignore linkcheck basepython changedir envdir envlist envname envsitepackagesdir passenv setenv testenv toxinidir toxworkdir usedevelop doctrees envpython posargs
[tox]
minversion = 4.6.3
envlist =
  lint
  pkg
  hook
  docs
  schemas
  py
  py-devel
  lower
  pre
  eco
isolated_build = true
skip_missing_interpreters = True
requires =
  tox >= 4.6.3
  tox-uv >= 1.16.0
  setuptools >= 65.3.0 # editable installs

[testenv]
description =
  Run the tests under {basepython}
  devel: and ansible devel branch
  pre: and enable --pre when installing dependencies, testing prereleases
deps =
  devel: ansible-core @ git+https://github.com/ansible/ansible.git  # GPLv3+
  devel: ansible-compat @ git+https://github.com/ansible/ansible-compat.git  # GPLv3+
extras =
  test
commands_pre =
  sh -c "rm -f {envdir}/.coverage.* 2>/dev/null || true"
  # safety measure to assure we do not accidentally run tests with broken dependencies
  {envpython} -m pip check
  bash ./tools/install-reqs.sh
  ansible --version
commands =
  sh -c "{envpython} -m pip freeze > {envdir}/log/requirements.txt"
  coverage run -m pytest {posargs:\
    -n auto \
    -ra \
    --showlocals \
    --doctest-modules \
    --durations=10 \
    }
  {py,py310,py311,py312,py313}: sh -c "coverage combine -a -q --data-file={envdir}/.coverage {toxworkdir}/*/.coverage.* && coverage xml --data-file={envdir}/.coverage -o {envdir}/coverage.xml --fail-under=0"

passenv =
  CURL_CA_BUNDLE  # https proxies, https://github.com/tox-dev/tox/issues/1437
  FORCE_COLOR
  HOME
  LANG
  LC_*
  NO_COLOR
  PYTEST_*  # allows developer to define their own preferences
  PYTEST_REQPASS  # needed for CI
  PYTHON*  # PYTHONPYCACHEPREFIX, PYTHONIOENCODING, PYTHONBREAKPOINT,...
  PY_COLORS
  RTD_TOKEN
  REQUESTS_CA_BUNDLE  # https proxies
  SETUPTOOLS_SCM_DEBUG
  SSL_CERT_FILE  # https proxies
  SSH_AUTH_SOCK # may be needed by git
  UV_*
# recreate = True
setenv =
  # Avoid runtime warning that might affect our devel testing
  devel: ANSIBLE_DEVEL_WARNING = false
  COVERAGE_FILE = {env:COVERAGE_FILE:{envdir}/.coverage.{envname}}
  COVERAGE_PROCESS_START={toxinidir}/pyproject.toml
  PIP_CONSTRAINT = {toxinidir}/.config/constraints.txt
  devel,pkg,pre,py310: PIP_CONSTRAINT = /dev/null
  PIP_DISABLE_PIP_VERSION_CHECK = 1
  PRE_COMMIT_COLOR = always
  # Number of expected test passes, safety measure for accidental skip of
  # tests. Update value if you add/remove tests. (tox-extra)
  PYTEST_REQPASS = 906
  FORCE_COLOR = 1
  pre: PIP_PRE = 1
allowlist_externals =
  bash
  find
  git
  pwd
  rm
  sh
  tox
  ./tools/test-hook.sh
  {toxworkdir}/.pipx/bin/ansible-lint
# https://tox.wiki/en/latest/upgrading.html#editable-mode
package = editable

[testenv:lint]
description = Run all linters
# pip compile includes python version in output constraints, so we want to
# be sure that version does not change randomly.
basepython = python3.10
deps =
  pre-commit>=4.0.1
  pre-commit-uv>=4.1.4
  setuptools>=51.1.1
  pytest>=7.2.2  # to updated schemas
skip_install = true
commands_pre =
commands =
  {envpython} -m pre_commit run --all-files --show-diff-on-failure {posargs:}
passenv =
  {[testenv]passenv}
  PRE_COMMIT_HOME
setenv =
  {[testenv]setenv}
  # avoid messing pre-commit with out own constraints
  PIP_CONSTRAINT=

[testenv:lower]
description = Install using lower-constraints.txt file for testing oldest versions.
setenv =
  PIP_CONSTRAINT = {toxinidir}/.github/lower-constraints.txt

[testenv:hook]
description = Validate pre-commit hook definition
deps = pre-commit
commands =
  ./tools/test-hook.sh
setenv =
  PIP_CONSTRAINT=/dev/null

[testenv:deps]
description = Bump all test dependencies
# we reuse the lint environment
envdir = {toxworkdir}/lint
skip_install = true
basepython = python3.10
deps =
  {[testenv:lint]deps}
setenv =
  # without his upgrade would likely not do anything
  PIP_CONSTRAINT = /dev/null
commands_pre =
commands =
  -pre-commit run --all-files --show-diff-on-failure --hook-stage manual lock
  -pre-commit run --all-files --show-diff-on-failure --hook-stage manual deps
  # Update pre-commit hooks
  -pre-commit autoupdate
  # Update npm deps
  -sh -c "cd test/schemas && npm run deps"
  # We fail if files are modified at the end
  git diff --exit-code

[testenv:docs]
description = Builds docs
extras =
  docs
setenv =
  # Disable colors until markdown-exec supports it:
  # https://github.com/pawamoy/markdown-exec/issues/11
  NO_COLOR = 1
  TERM = dump
  # https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#troubleshooting
  DYLD_FALLBACK_LIBRARY_PATH = /opt/homebrew/lib:{env:LD_LIBRARY_PATH}
skip_install = false
usedevelop = true
commands_pre =
  ansible-lint --version
commands =
  mkdocs {posargs:build --strict --site-dir=_readthedocs/html/}

[testenv:redirects]
description = Update documentation redirections for readthedocs
deps =
  readthedocs-cli
commands =
  # This assumes you loaded RTD_TOKEN in your environment
  rtd projects ansible-lint redirects sync -f docs/redirects.yml --wet-run

[testenv:schemas]
description = Rebuild and test JSON Schemas
deps =
  check-jsonschema>=0.26.3
setenv =
  # without this upgrade would likely not do anything
  PIP_CONSTRAINT = /dev/null
skip_install = true
changedir = test/schemas
commands_pre =
  npm install
commands =
  npm test
allowlist_externals =
  npm

[testenv:eco]
description = Perform ecosystem impact (downstream testing) https://github.com/ansible/ansible-lint/discussions/1403
deps =
  {[testenv]deps}
extras =
  test
commands =
  sh -c tools/test-eco.sh
allowlist_externals =
  {[testenv]allowlist_externals}
setenv =
  PYTEST_REQPASS=7

[testenv:pkg]
description =
  Build package, verify metadata, install package and assert behavior when ansible is missing.
deps =
  build >= 0.9.0
  twine >= 4.0.1
  pip
  pipx
skip_install = true
# Ref: https://twitter.com/di_codes/status/1044358639081975813
commands_pre =
commands =
  # Testing pipx usage
  bash -c "PIPX_BIN_DIR={toxworkdir}/.pipx/bin PIPX_HOME={toxworkdir}/.pipx pipx install --force -e ."
  # Testing that calling the pipx installation does return 0 return code and no output in stderr
  bash -c "if stderr=$({toxworkdir}/.pipx/bin/ansible-lint --version >/dev/null) && test -z \"$stderr\"; then echo "ok"; fi"
  # build wheel and sdist using PEP-517
  {envpython} -c 'import os.path, shutil, sys; \
  dist_dir = os.path.join("{toxinidir}", "dist"); \
  os.path.isdir(dist_dir) or sys.exit(0); \
  print("Removing \{!s\} contents...".format(dist_dir), file=sys.stderr); \
  shutil.rmtree(dist_dir)'
  {envpython} -m build --outdir {toxinidir}/dist/ {toxinidir}
  # Validate metadata using twine
  python3 -m twine check --strict {toxinidir}/dist/*
  # Install the wheel
  sh -c 'python3 -m pip install "ansible-lint @ file://$(echo {toxinidir}/dist/*.whl)"'
  # Uninstall it
  python3 -m pip uninstall -y ansible-lint

[testenv:clean]
description = Remove temporary files
skip_install = true
deps =
commands_pre =
commands_post =
commands =
  find . -type d \( -name __pycache__ -o -name .mypy_cache \) -delete
  find . -type f \( -name '*.py[co]' -o -name ".coverage*" -o -name coverage.xml \) -delete

[testenv:coverage]
description = Combines and displays coverage results
skip_install = true
usedevelop = false
setenv =
  COVERAGE_PROCESS_START={toxinidir}/pyproject.toml
commands_pre =
commands =
  python3 -m coverage --version
  # needed by codecov github actions, also ignored result to reach report one.
  python3 -m coverage xml --fail-under=0
  # just for humans running it:
  python3 -m coverage report
deps =
  coverage[toml]>=7.0.5