tox.ini

[tox]
minversion=2.9.0
envlist = py310,lint,docs
skipsdist = True

[testenv]
description = run test suite for the application with {basepython}
setenv =
    PYTHONPATH={toxinidir}/readthedocs:{toxinidir}
    DJANGO_SETTINGS_MODULE=readthedocs.settings.test
    LANG=en_US.UTF-8
    LC_ALL=en_US.UTF-8
    DJANGO_SETTINGS_SKIP_LOCAL=True
passenv = CI TRAVIS TRAVIS_* HOME
deps =
  -r requirements/testing.txt
  debug: -r requirements/debug.txt
basepython =
    python3.10
commands =
    /bin/sh -c '\
        export DJANGO_SETTINGS_MODULE=readthedocs.settings.test; \
        pytest --cov-report=xml --cov-config .coveragerc --cov=. --pyargs readthedocs --suppress-no-test-exit-code -m "not proxito and not embed_api" {posargs:{env:TOX_POSARGS:-m "not search and not proxito and not embed_api"}}'

    /bin/sh -c '\
        export DJANGO_SETTINGS_MODULE=readthedocs.settings.proxito.test; \
        pytest --cov-report=xml --cov-config .coveragerc --cov=. --cov-append --pyargs readthedocs -m proxito --suppress-no-test-exit-code {posargs}'

[testenv:docs]
description = Build readthedocs user documentation
changedir = {toxinidir}/docs
deps =
  -r{toxinidir}/requirements/testing.txt
  -r{toxinidir}/requirements/docs.txt
setenv =
    PROJECT=user
commands =
    sphinx-build -W --keep-going -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

[testenv:docs-dev]
description = Build readthedocs developer documentation
changedir = {toxinidir}/docs
deps =
  -r{toxinidir}/requirements/testing.txt
  -r{toxinidir}/requirements/docs.txt
setenv =
    PROJECT=dev
commands =
    sphinx-build -W --keep-going -b html -d {envtmpdir}/doctrees . {envtmpdir}/html

[testenv:docs-linkcheck]
description = Check for broken links in the user docs
changedir = {toxinidir}/docs
deps =
  -r{toxinidir}/requirements/testing.txt
  -r{toxinidir}/requirements/docs.txt
commands =
    sphinx-build -W --keep-going -q -b linkcheck -d {envtmpdir}/doctrees . {envtmpdir}/linkcheck

[testenv:docs-dev-linkcheck]
description = Check for broken links in the developer docs
changedir = {toxinidir}/docs
deps =
  -r{toxinidir}/requirements/testing.txt
  -r{toxinidir}/requirements/docs.txt
setenv =
    RTD_DOCSET=dev
commands =
    sphinx-build -W --keep-going -q -b linkcheck -d {envtmpdir}/doctrees . {envtmpdir}/linkcheck

[testenv:migrations]
description = check for missing migrations
commands =
    ./manage.py makemigrations --check --dry-run

[testenv:docs-lint]
description = run linter (rstcheck) to ensure there aren't errors on our docs
deps = -r{toxinidir}/requirements/docs.txt
changedir = {toxinidir}/docs
commands =
    rstcheck -r .

[testenv:lint]
description = run linter (prospector) to ensure the source code corresponds to our coding standards
deps = -r{toxinidir}/requirements/lint.txt
changedir = {toxinidir}/readthedocs
commands =
    prospector \
    --profile-path={toxinidir} \
    --profile=prospector-more \
    --die-on-tool-error {posargs}
    prospector \
    --profile-path={toxinidir} \
    --profile=prospector \
    --die-on-tool-error {posargs}

[testenv:pre-commit]
description = run pre-commit to ensure the changes are valid against our lintings
deps =
   pre-commit
commands =
    # FIXME: use `github.event.pull_request.base.sha` in `--from-ref` because if
    # the base branch is different, this won't work as expected
    pre-commit run --from-ref main --to-ref HEAD

[testenv:eslint]
whitelist_externals = npm
description = run the JavaScript linter (requires `npm install`)
commands =
    npm run lint

[testenv:coverage]
description = shows the coverage report
deps = coverage
whitelist_externals = echo
commands =
    coverage report --show-missing
    coverage html
    echo Annotated HTML coverage report is in {toxinidir}/htmlcov/index.html