tox.ini

[tox]
envlist = py,coverage-report,typing,lint
isolated_build = True

[testenv]
description = Run pytest against {envname}.
setenv =
    # Set up test values configurations that must be obtained through
    # environment variables; pytest can override these for individual test runs
    NOTEBURST_ENVIRONMENT_URL = https://test.example.com
    NOTEBURST_GAFAELFAWR_TOKEN = gt-eOfLolxU8FJ1xr08U7RTbg.Jr-KHSeISXwR5GXHiLemhw
    NOTEBURST_REDIS_URL = redis://localhost:6379
    NOTEBURST_ARQ_MODE = test
    NOTEBURST_WORKER_IDENTITIES_PATH = tests/identities.test.yaml
deps =
    -r{toxinidir}/requirements/main.txt
    -r{toxinidir}/requirements/dev.txt
commands =
    pytest --cov=noteburst --cov-branch --cov-report= {posargs}

[testenv:coverage-report]
description = Compile coverage from each test run.
skip_install = true
deps = coverage[toml]>=5.0.2
depends =
    py
commands = coverage report

[testenv:typing]
description = Run mypy.
commands =
    mypy src/noteburst tests

[testenv:lint]
description = Lint codebase by running pre-commit (Black, isort, Flake8).
skip_install = true
deps =
    pre-commit
commands = pre-commit run --all-files

[testenv:run-api]
description = Run the development server with auto-reload for code changes.
usedevelop = true
setenv =
    SAFIR_PROFILE = development
    NOTEBURST_ENVIRONMENT_URL = https://test.example.com
    NOTEBURST_GAFAELFAWR_TOKEN = gt-eOfLolxU8FJ1xr08U7RTbg.Jr-KHSeISXwR5GXHiLemhw
    NOTEBURST_REDIS_URL = redis://localhost:6379/0
commands = uvicorn noteburst.main:app --reload --port 8010

[testenv:run-worker]
description = Run the development worker node
usedevelop = true
setenv =
    SAFIR_PROFILE = development
    NOTEBURST_ENVIRONMENT_URL = https://test.example.com
    NOTEBURST_GAFAELFAWR_TOKEN = gt-eOfLolxU8FJ1xr08U7RTbg.Jr-KHSeISXwR5GXHiLemhw
    NOTEBURST_REDIS_URL = redis://localhost:6379/0
    NOTEBURST_WORKER_LOCK_REDIS_URL = redis://localhost:6379/1
    NOTEBURST_WORKER_IDENTITIES_PATH = tests/identities.test.yaml
commands = arq noteburst.worker.main.WorkerSettings --watch src

[testenv:run-redis]
description = Run redis (for development environments)
commands = docker run --rm --name redis-dev -p 6379:6379 redis
allowlist_externals =
    docker

[testenv:docs]
description = Build documentation (HTML) with Sphinx.
commands =
    sphinx-build -n -T -b html -d {envtmpdir}/doctrees docs docs/_build/html