tox.ini

[tox]
# Differences in tox configuration from starbase:
# 1. Docs not included
# 2. Charmcraft currently doesn't distinguish unit from integration tests
env_list =  # Environments to run when called with no parameters.
    format-{ruff,codespell}
    pre-commit
    lint-{ruff,mypy,pyright,shellcheck,codespell,yaml}
    test-py3.10
# By default, only run tests on core22's Python 3.10
minversion = 4.6
# Tox will use these requirements to bootstrap a venv if necessary.
# tox-igore-env-name-mismatch allows us to have one virtualenv for all linting.
# By setting requirements here, we make this INI file compatible with older
# versions of tox. Tox >= 3.8 will automatically provision the version provided
# inside of a virtual environment, so users of Ubuntu >= focal can simply
# install tox from apt. Older than that, the user gets an upgrade warning.
requires =
    # renovate: datasource=pypi
    tox-ignore-env-name-mismatch>=0.2.0.post2
    # renovate: datasource=pypi
    tox-gh==1.3.1
# Allow tox to access the user's $TMPDIR environment variable if set.
# This workaround is required to avoid circular dependencies for TMPDIR,
# since tox will otherwise attempt to use the environment's TMPDIR variable.
user_tmp_dir = {env:TMPDIR}

[testenv]  # Default config for all environments. Overridable in each env.
# We have many tests that create temporary files. Unless the user has set a
# TMPDIR, this will prefer putting those temp files in $XDG_RUNTIME_DIR,
# which will speed up those tests since they'll run on a ramdisk.
env_tmp_dir = {user_tmp_dir:{env:XDG_RUNTIME_DIR:{work_dir}}}/tox_tmp/{env_name}
set_env =
    TMPDIR={env_tmp_dir}
    COVERAGE_FILE={env_tmp_dir}/.coverage_{env_name}
    RUNNING_TOX=1
pass_env =
    CI
    CRAFT_*
    PYTEST_ADDOPTS

[test]  # Base configuration for unit and integration tests
package = editable
extras = dev
allowlist_externals = mkdir
commands_pre = mkdir -p {tox_root}/results

[testenv:{test}-py3.{10,11,12}]  # Configuration for all tests using pytest
base = testenv, test
deps =
    -rrequirements-dev.txt
    -rrequirements-jammy.txt
description = Run tests with pytest
labels =
    py3.{10,11,12}: tests
commands = pytest {tty:--color=yes} --cov={tox_root}/charmcraft --cov-config={tox_root}/pyproject.toml --cov-report=xml:{tox_root}/results/coverage-{env_name}.xml --junit-xml={tox_root}/results/test-results-{env_name}.xml {posargs}

[lint]  # Standard linting configuration
package = editable
extras = lint
env_dir = {work_dir}/linting
runner = ignore_env_name_mismatch

[shellcheck]
find = git ls-files
filter = file --mime-type -Nnf- | grep shellscript | cut -f1 -d:

[testenv:lint-{ruff,shellcheck,codespell,yaml}]
description = Lint the source code
base = testenv, lint
labels = lint
allowlist_externals =
    shellcheck: bash, xargs
    ruff: ruff
commands_pre =
    shellcheck: bash -c '{[shellcheck]find} | {[shellcheck]filter} > {env_tmp_dir}/shellcheck_files'
commands =
    ruff: ruff check --respect-gitignore {posargs:.}
    ruff: ruff format --diff {posargs:.}
    shellcheck: xargs -ra {env_tmp_dir}/shellcheck_files shellcheck
    codespell: codespell --toml {tox_root}/pyproject.toml {posargs}
    yaml: yamllint {posargs} .

[testenv:lint-{mypy,pyright}]
description = Static type checking
base = testenv, lint
env_dir = {work_dir}/typing
extras = dev, types
labels = lint, type
allowlist_externals =
    mypy: mkdir
commands_pre =
    mypy: mkdir -p {tox_root}/.mypy_cache
commands =
    pyright: pyright {posargs}
    mypy: mypy --install-types --non-interactive {posargs}

[testenv:format-{ruff,codespell}]
description = Automatically format source code
base = testenv, lint
labels = format
allowlist_externals =
    ruff: ruff
commands =
    ruff: ruff check --fix --respect-gitignore {posargs:.}
    ruff: ruff format {posargs:.}
    codespell: codespell --toml {tox_root}/pyproject.toml --write-changes {posargs}

[testenv:pre-commit]
base =
deps = pre-commit
package = skip
no_package = true
env_dir = {work_dir}/pre-commit
runner = ignore_env_name_mismatch
description = Run pre-commit on staged files or arbitrary pre-commit commands (tox run -e pre-commit -- [args])
commands = pre-commit {posargs:run}

[docs]  # Sphinx documentation configuration
extras = docs
package = editable
no_package = true
env_dir = {work_dir}/docs
runner = ignore_env_name_mismatch
source_dir = {tox_root}/{project_name}

[testenv:build-docs]
description = Build sphinx documentation
base = docs
allowlist_externals = bash
commands_pre = bash -c 'if [[ ! -e docs ]];then echo "No docs directory. Run `tox run -e sphinx-quickstart` to create one.;";return 1;fi'
# "-W" is to treat warnings as errors
commands =
;     sphinx-apidoc -o docs/reference/_autogen charmcraft
    sphinx-build {posargs:-b html} -W {tox_root}/docs {tox_root}/docs/_build

[testenv:autobuild-docs]
description = Build documentation with an autoupdating server
base = docs
commands = sphinx-autobuild {posargs:-b html --open-browser --port 8080} --watch {tox_root} --re-ignore ".*.kate-swp" --re-ignore "docs/reference/commands/" {tox_root}/docs {tox_root}/docs/_build

[lint-docs]
find = git ls-files

[testenv:lint-docs]
description = Lint the documentation with sphinx-lint
base = docs
labels = lint
allowlist_externals = bash, xargs
commands_pre = bash -c '{[lint-docs]find} > {env_tmp_dir}/lint_docs_files'
commands = xargs --no-run-if-empty --arg-file {env_tmp_dir}/lint_docs_files sphinx-lint --max-line-length 88 --enable all {posargs}

[testenv:clean]
description = Clean up bytecode and build artifacts
skip_install = true
deps = pyclean
commands = pyclean {posargs:. --debris --erase results/* results/ --yes}

[testenv:ensure_version_matches]
description = Verify package version is same as Git tag
deps =
commands = python -c 'import os; from importlib.metadata import version; pkg, tag = os.environ["PKG_NAME"], os.environ["GIT_TAG"]; ver = version(pkg); error = f"`{ver}` != `{tag}`"; abort = f"Package version does not match the Git tag ({error}). ABORTING."; raise SystemExit(0 if ver and tag and ver == tag else abort)'
set_env =
    PKG_NAME=charmcraft
    GIT_TAG={posargs}

[testenv:package]
description = Build package and check metadata (or upload package)
skip_install = true
deps =
    build
    twine
commands =
    python -m build
    twine {posargs:check --strict} dist/*
passenv =
    TWINE_USERNAME
    TWINE_PASSWORD
    TWINE_REPOSITORY_URL