tox.ini

[tox]
envlist = py{38,39,310,311,312}
ignore_basepython_conflict = True
skip_missing_interpreters = True

[testenv]
usedevelop = True
install_command = pip install {opts} {packages}
; XDG_* is used by helm and gcloud among others
; set TF_DATA_DIR so we don't need to download plugins everytime
; for test isolation, map the enviroment vars needed for tests from UNFURL_TEST_* vars
setenv =
  UNFURL_HOME={envtmpdir}/unfurl_home
  UNFURL_TMPDIR={envtmpdir}
  UNFURL_NORUNTIME=1
  UNFURL_APPROVE=1
  UNFURL_VALIDATION_MODE=additionalProperties
  UNFURL_RAISE_LOGGING_EXCEPTIONS=1
  XDG_CACHE_HOME={envtmpdir}/.cache
  XDG_CONFIG_HOME={envtmpdir}/.config
  XDG_DATA_HOME={envtmpdir}/.local/share
  TF_DATA_DIR={toxworkdir}/.terraform
  GOOGLE_APPLICATION_CREDENTIALS={env:UNFURL_TEST_GCP_CRED:}
  CLOUDSDK_COMPUTE_ZONE={env:UNFURL_TEST_GCP_ZONE:}
; XXX set HOME to isolated path

; can also set TOX_TESTENV_PASSENV="ENV_VAR1 ENV_VAR1"
passenv=HOME CI GITHUB_* RUNNER_* ANSIBLE_VERBOSITY ANSIBLE_DEBUG UNFURL_WORKDIR UNFURL_LOGGING UNFURL_LOG_TRUNCATE UNFURL_TEST_* ANDROID_* TRAVIS* DOCKER_*
basepython =
    py38: python3.8
    py39: python3.9
    py310: python3.10
    py311: python3.11
    py312: python3.12
deps =
  -r{toxinidir}/all-requirements.txt
  -r{toxinidir}/test-requirements.txt
  ; docutils
  ; check-manifest
  ; flake8
allowlist_externals = rm
commands =
;   XXX:
;   check-manifest --ignore tox.ini,tests*
;   twine check
;   flake8 .
    rm -f .coverage
    pytest {posargs}

[testenv:py{38,39,310,311,312}-lock]
;  creates Pipfile.lock for distribution, run tox -r -e 'py{38,39,310,311,312}-lock'
changedir =
  unfurl/templates/{basepython}
allowlist_externals = rm
deps =
  pipenv==2023.7.3
commands =
  rm -f Pipfile Pipfile.lock
  pipenv --no-site-packages install --ignore-pipfile -r ../../../all-requirements.txt

; separate environment
[testenv:py38-docker]
setenv =
  HOME={envtmpdir}/home
  USER=unfurl
  UNFURL_HOME={envtmpdir}/unfurl_home
  UNFURL_TMPDIR={envtmpdir}
  UNFURL_NORUNTIME=1
  XDG_CACHE_HOME={envtmpdir}/.cache
  XDG_CONFIG_HOME={envtmpdir}/.config
  XDG_DATA_HOME={envtmpdir}/.local/share
  TF_DATA_DIR={toxworkdir}/.terraform
  GOOGLE_APPLICATION_CREDENTIALS={env:UNFURL_TEST_GCP_CRED:}
  CLOUDSDK_COMPUTE_ZONE={env:UNFURL_TEST_GCP_ZONE:}

[testenv:docs]
basepython = python3.10
deps =
  -r{toxinidir}/requirements.txt
  sphinx==4.5.0
  sphinxcontrib-applehelp==1.0.4
  sphinxcontrib-devhelp==1.0.0
  sphinxcontrib-htmlhelp==2.0.1
  sphinxcontrib-serializinghtml==1.1.5
  sphinxcontrib-qthelp==1.0.3
  typed_ast
  myst-parser
  sphinx-click>=2.5.0
  stevedore>=1.20.0
  sphinxcontrib-documentedlist
  sphinx_rtd_theme

; -W turns warnings into errors
; to rebuild all: tox -e docs -- -E -a
commands = sphinx-build ./docs {toxworkdir}/docs/html -d {toxworkdir}/docs/doctrees --color -bhtml {posargs}
           python -c 'import pathlib; print("documentation available under file://\{0\}".format(pathlib.Path(r"{toxworkdir}") / "docs" / "html" / "index.html"))'

[flake8]
exclude = .tox,*.egg,build,data
select = E,W,F

[pytest]
testpaths = tests
filterwarnings =
  ignore:ast:DeprecationWarning
addopts = --cov=unfurl --cov-report html --cov-report term --cov-append --ignore=unfurl/vendor --ignore=tosca-parser --tb short --no-cov
; -n auto --dist loadfile to run in parallel