tox.ini

[tox]
minversion = 4.0
isolated_build = True
requires =
    tox-extra
envlist =
    lint
    pkg
    docs
    py312
    py311
    py310
    py39
ignore_basepython_conflict = True
skip_missing_interpreters = True
skipdist = True

[gh-actions]
python =
    3.9: py39
    3.10: py310
    3.11: py311
    3.12: py312


[testenv]
usedevelop = True
# hide deps from stdout https://github.com/tox-dev/tox/issues/601
# list_dependencies_command=echo
extras =
    cli
    opt
    test
sitepackages=False
commands=
    git clean -xdf jira tests
    python -m pip check
    python make_local_jira_user.py
    python -m pytest {posargs}
setenv =
    PIP_CONSTRAINT={toxinidir}/constraints.txt
    PIP_LOG={envdir}/pip.log
    PIP_DISABLE_PIP_VERSION_CHECK=1
    # Avoid 2020-01-01 warnings: https://github.com/pypa/pip/issues/6207
    PYTHONWARNINGS=ignore:DEPRECATION::pip._internal.cli.base_command
    CI_JIRA_URL=http://localhost:2990/jira
    CI_JIRA_ADMIN=admin
    CI_JIRA_ADMIN_PASSWORD=admin
    CI_JIRA_USER=jira_user
    CI_JIRA_USER_FULL_NAME=Newly Created CI User
    CI_JIRA_USER_PASSWORD=jira
    CI_JIRA_ISSUE=Task
passenv =
    CI
    CI_JIRA_*
    CURL_CA_BUNDLE
    PIP_*
    REQUESTS_CA_BUNDLE
    SSL_CERT_FILE
    TWINE_*
    GITHUB_*
    XDG_CACHE_HOME
    # For Windows users, getpass.get_user() needs USERNAME
    USERNAME
allowlist_externals =
    git
    sh

[testenv:deps]
description = Update dependency lock files
# Force it to use oldest supported version of python or we would lose ability
# to get pinning correctly.
basepython = python3.9
skip_install = true
deps =
    pip-tools >= 6.4.0
    pre-commit >= 2.13.0
commands =
    pip-compile --upgrade -o constraints.txt --extra cli --extra docs --extra opt --extra async --extra test --strip-extras
    {envpython} -m pre_commit autoupdate

[testenv:docs]
extras =
    cli
    docs
# changedir=docs
usedevelop = True
skipdist = False
setenv =
    PYTHONHTTPSVERIFY=0
commands =
    sphinx-build \
      --verbose \
      --write-all \
      --nitpicky --fail-on-warning \
      -b html --color \
      -d "{toxworkdir}/docs_doctree" \
      docs/ "{toxworkdir}/docs_out"

    # Print out the output docs dir and a way to serve html:
    python -c \
    'import pathlib; '\
    'docs_dir = pathlib.Path(r"{toxworkdir}") / "docs_out"; index_file = docs_dir / "index.html"; print(f"\nDocumentation available under `file://\{index_file\}`\n\nTo serve docs, use `python3 -m http.server --directory \{docs_dir\} 0`\n")'

[testenv:pkg]
basepython = python3
description =
  Build package, verify metadata, install package and assert behavior when ansible is missing.
deps =
  build >= 0.7.0
  twine
  pip
skip_install = true
# Ref: https://twitter.com/di_codes/status/1044358639081975813
commands =
  # build wheel and sdist using PEP-517
  {envpython} -c 'import os.path, shutil, sys; \
  dist_dir = os.path.join(r"{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
  twine check --strict {toxinidir}/dist/*
  # Install the wheel
  sh -c "pip3 install {toxinidir}/dist/*.whl"
  # Check if cli was installed
  jirashell --help
  # Uninstall the wheel
  {envpython} -m pip uninstall -y jira

[testenv:lint]
deps = pre-commit>=1.17.0
commands=
    python -m pre_commit run --color=always {posargs:--all}
setenv =
    PIP_CONSTRAINT=
skip_install = true
usedevelop = false

[testenv:maintenance]
# this will obliterate your jira instance, used to clean the CI server
commands=
    python examples/maintenance.py