tox.ini

[tox]
envlist = linters,docs,unit-tests

[testenv:unit-tests]
basepython = python3
# {posargs} contains additional arguments specified when invoking tox. e.g. tox -- -s -k test_foo.py
deps =
    {[test-deps]deps}
commands =
    pytest {posargs} --cov-report term-missing --cov-report html --cov-report xml --cov=braket
extras = test

[testenv:linters]
basepython = python3
# Remove this to check what versions are installed for the env. This stops running pip freeze.
list_dependencies_command = echo
deps =
    {[testenv:ruff-format]deps}
    {[testenv:ruff-check]deps}
commands =
    {[testenv:ruff-format]commands}
    {[testenv:ruff-check]commands}

# Read only linter env
[testenv:linters_check]
basepython = python3
extras = test
commands =
    {[testenv:ruff-check]commands}

[testenv:ruff-check]
basepython = python3
extras = test
deps = ruff
commands =
    ruff check src {posargs}

[testenv:ruff-format]
basepython = python3
extras = test
deps = ruff
commands =
    ruff format . {posargs}

[testenv:docs]
basepython = python3
deps =
    {[test-deps]deps}
    sphinx
    sphinx-rtd-theme
    sphinxcontrib-apidoc
commands =
    sphinx-build -E -T -b html doc build/documentation/html

[testenv:serve-docs]
basepython = python3
skip_install = true
changedir = build/documentation/html
commands =
    python -m http.server {posargs}

[testenv:zip-build]
basepython = python3
skip_install = true
commands =
    /bin/sh -c 'tar -czvf build_files.tar.gz build/'

[testenv:performance-tests]
basepython = python3
deps =
    {[test-deps]deps}
allowlist_externals =
    sh
changedir = test
commands =
    sh -c performance/compare_performance.sh
extras = test

[test-deps]
deps =
    # If you need to test on a certain branch, add @<branch-name> after .git
    git+https://github.com/amazon-braket/amazon-braket-schemas-python.git

[testenv]
# Python 3.13 tests on Windows break without this
# see https://github.com/gitpython-developers/GitPython/issues/356#issuecomment-552403929
# TODO: Delete after unpinning pytest
passenv = USERNAME