tox.ini

[tox]
envlist = py{37,38,39}-{linux,macos}{,-all}

#########################################################
# Tox environments
#########################################################

[gh-actions]
python =
    3.7: py37
    3.8: py38
    3.9: py39
    pypy3: pypy3

[gh-actions:env]
PLATFORM =
    ubuntu-latest: linux
    macos-latest: macos
    windows-latest: windows

[testenv]
description = Run tests with coverage with pytest under current Python env
usedevelop = true
setenv = COVERAGE_FILE=.coverage.{envname}
passenv = CI
extras =
    !all: test
    all: all
deps =
    -rexamples/scikitlearn-iris/requirements.txt
    coverage
commands =
    pip install -U {toxinidir}/tests/functional/gradient_descent_algo
    coverage run --source=src --parallel-mode -m pytest --durations=50 --durations-min 1 -vv --timeout=360 \
                 --ignore tests/unittests/algo/long \
                 --ignore tests/functional/backward_compatibility \
                 --ignore tests/functional/serving/test_frontend.py \
                 --ignore tests/stress {posargs}
    coverage combine
    coverage report -m
    coverage xml


[testenv:algo]
description = Run unit tests for algorithms whose tests take a long time to run
usedevelop = true
setenv = COVERAGE_FILE=.coverage.{envname}
passenv = CI
extras =
    all
deps =
    coverage
commands =
    coverage run --source=src --parallel-mode -m pytest --durations=50 --durations-min 1 -vv --timeout=360 {posargs}
    coverage combine
    coverage report -m
    coverage xml

[testenv:mongodb]
description = Run MongoDB tests with coverage with pytest
setenv = COVERAGE_FILE=.coverage.mongodb
passenv = CI
deps =
    coverage
commands =
    pip install -U {toxinidir}/tests/functional/gradient_descent_algo
    coverage run --parallel-mode -m pytest -vv --mongodb tests/unittests/core/database
    coverage combine
    coverage report -m
    coverage xml

[testenv:backward-compatibility]
description = Run all versions of Orion to assert backward compatibility
setenv = COVERAGE_FILE=.coverage.backward_compatibility
passenv = CI ORION_DB_TYPE
deps =
    coverage
commands =
    coverage run --parallel-mode -m pytest -vv tests/functional/backward_compatibility/test_versions.py --timeout=180
    coverage combine
    coverage report -m
    coverage xml

[testenv:stress]
description = Run stress test of Orion
deps =
    -rtests/stress/requirements.txt
commands =
    python tests/stress/client/stress_experiment.py

[testenv:demo-random]
description = Run a demo with random search algorithm
setenv = COVERAGE_FILE=.coverage.random
passenv = CI
deps =
    coverage
commands =
    coverage run --parallel-mode src/orion/core/cli/__init__.py hunt --config tests/functional/demo/orion_config_random.yaml tests/functional/demo/black_box.py -x~'normal(30, 5)'
    coverage combine
    coverage report -m

# Coverage environments
[testenv:final-coverage]
description = Combine coverage data across environments (run after tests)
skip_install = True
setenv = COVERAGE_FILE=.coverage
passenv = {[testenv]passenv}
deps = coverage
commands =
    coverage erase
    coverage combine
    coverage report -m
    coverage xml

[testenv:codecov]
description = Upload coverage data to codecov (only run on CI)
setenv =
    {[testenv:final-coverage]setenv}
passenv = {[testenv]passenv}
deps = codecov
commands = codecov --required

# Linting & Verification environments
[testenv:lint]
description = Lint code and docs against some standard standards
basepython = python3
skip_install = false
deps =
    {[testenv:black]deps}
    {[testenv:pylint]deps}
    {[testenv:doc8]deps}
    {[testenv:packaging]deps}
commands =
    {[testenv:black]commands}
    {[testenv:pylint]commands}
    {[testenv:doc8]commands}
    {[testenv:packaging]commands}

[testenv:black]
description = Verify code style with black
basepython = python3
skip_install = true
deps =
    black == 22.3.0
commands =
    black --check src/orion/ tests/

[testenv:run-black]
description = Run code style modification with black
basepython = python3
skip_install = true
deps =
    {[testenv:black]deps}
commands =
    black src/orion/ tests/

[testenv:isort]
description = Use isort to check import orders
basepython = python3
skip_install = true
deps =
    isort == 5.10.1
commands =
    isort --profile black -c src/orion/ tests/

[testenv:run-isort]
description = Run isort to fix import orders
basepython = python3
skip_install = true
deps =
    {[testenv:isort]deps}
commands =
    isort --profile black src/orion/ tests/

[testenv:pylint] # Will use the configuration file `.pylintrc` automatically
description = Perform static analysis and output code metrics
basepython = python3
skip_install = false
deps =
    pylint == 2.5.*
commands =
    pylint src/orion/core src/orion/client src/orion/algo src/orion/analysis src/orion/plotting


[testenv:doc8]
description = Impose standards on *.rst documentation files
basepython = python3
skip_install = true
deps =
    -rdocs/requirements.txt
    doc8 == 0.8.*
commands =
    doc8 docs/src/

[testenv:packaging]
description = Check whether README.rst is reST and missing from MANIFEST.in
basepython = python3
deps =
    check-manifest
    readme_renderer
commands =
    check-manifest
    python setup.py check -r -s

## Development environments
[testenv:devel]
description = Incremental devel env command, defaults to running tests
deps =
    -rexamples/scikitlearn-iris/requirements.txt
usedevelop = True
commands =
    pip install -U {toxinidir}/tests/functional/gradient_descent_algo
    python setup.py test --addopts '-vvv --exitfirst --looponfail {posargs}'

# Documentation environments
[testenv:build-doc-data]
description = Build database and html plots for the doc
basepython = python3
deps =
    -rdocs/scripts/requirements.txt
commands =
    python docs/scripts/build_database_and_plots.py {posargs}

[testenv:docs]
description = Invoke sphinx to build documentation and API reference
basepython = python3
skip_install = false
extras = 
    docs
    pb2
commands =
    sphinx-build -b html -d build/doctrees -nT docs/src/ docs/build/html

[testenv:serve-docs]
description = Host the documentation of the project and API reference in localhost
basepython = python3
skip_install = true
changedir = docs/build/html
deps =
commands =
    python -m http.server 8000 --bind 127.0.0.1

# Release environments (to be removed in favor of CI with CD)
[testenv:build]
basepython = python3
skip_install = true
deps =
    wheel
    setuptools
commands =
    python setup.py -q sdist

[testenv:release]
basepython = python3
skip_install = true
deps =
    {[testenv:build]deps}
    twine >= 1.5.0
commands =
    {[testenv:build]commands}
    twine upload --skip-existing dist/*

#########################################################
# Packages & Tools configuration
#########################################################

# Pytest configuration
[pytest]
addopts = -ra -q --color=yes
norecursedirs = .* *.egg* config docs dist build
xfail_strict = True
rsyncdirs = src tests
looponfailroots = src tests examples

# Coverage configuration
[coverage:run]
branch = True
source =
    src
    tests
omit = **/_[a-zA-Z0-9]*.py

[coverage:report]
exclude_lines =
    # Don't complain if tests don't hit defensive assertion code:
    pass
    raise AssertionError
    raise NotImplementedError

# Doc8 configuration
[doc8]
max-line-length = 100
file-encoding = utf-8