tox.ini

# Copyright 2021 Canonical Ltd.
# See LICENSE file for licensing details.
[tox]
skipsdist=True
skip_missing_interpreters = True
envlist = lint, unit

[vars]
src_path = {toxinidir}/ops/
tst_path = {toxinidir}/test/
all_path = {[vars]src_path} {[vars]tst_path}

[testenv]
basepython = python3
setenv =
  PYTHONPATH = {toxinidir}:{toxinidir}/lib:{[vars]src_path}
  PYTHONBREAKPOINT=ipdb.set_trace
  PY_COLORS=1
passenv =
  PYTHONPATH
  HOME
  PATH
  MODEL_SETTINGS

[testenv:docs]
description = Build the Sphinx docs
deps =
    -r{toxinidir}/docs/requirements.txt
commands =
    sphinx-build -M html docs/ docs/_build

[testenv:fmt]
description = Apply coding style standards to code
deps =
    isort
    autopep8
commands =
    isort {[vars]all_path}
    autopep8 --in-place {[vars]all_path}

[testenv:lint]
description = Check code against coding style standards
deps =
    autopep8
    isort
    flake8==4.0.1
    flake8-docstrings
    flake8-builtins
    pyproject-flake8
    pep8-naming
commands =
    # pflake8 wrapper suppports config from pyproject.toml
    pflake8 {[vars]all_path}
    isort --check-only --diff {[vars]all_path}
    autopep8 --diff {[vars]all_path}

[testenv:static]
description = Run static type checker
deps =
    pyright==1.1.264
commands =
    pyright {posargs}

[testenv:unit]
description = Run unit tests
passenv =
    RUN_REAL_PEBBLE_TESTS
    PEBBLE
deps =
    pytest
    ipdb
    ipython!=8.1.0 # this version is broken and was causing failures
    logassert
    coverage[toml]
    -r{toxinidir}/requirements.txt
commands =
    coverage run --source={[vars]src_path} \
             -m pytest --ignore={[vars]tst_path}smoke -v --tb native {posargs} 
    coverage report

[testenv:pebble]
description = Run real pebble tests
allowlist_externals = pebble
                      mkdir
                      bash
setenv =
  PEBBLE=/tmp/pebble
  RUN_REAL_PEBBLE_TESTS=1
deps =
    pytest
    logassert
    -r{toxinidir}/requirements.txt
commands =
    bash -c "umask 0; (pebble run --http=':4000' --create-dirs &>/dev/null & ) ; sleep 1; pytest -v --tb native -k RealPebble {posargs} ; killall -y 3m pebble"

[testenv:smoke]
description = Run a smoke test against a Juju controller.
whitelist_externals = juju
                      charmcraft
                      bash
deps =
    pytest
    pytest-operator
commands =
    # Build a source tarball for ops, and drop it into the root directory of the smoke test charm.
    bash -c 'rm -vf ./test/charms/test_smoke/*.tar.gz  # Cleanup old builds'
    python {toxinidir}/setup.py sdist --dist-dir={toxinidir}/test/charms/test_smoke/
    # Inject the tarball into the smoke test charm's requirements.
    bash -c 'echo "./$(ls -1 ./test/charms/test_smoke/ | grep tar.gz)" > ./test/charms/test_smoke/requirements.txt'

    # Run our smoke tests (this will build the charm, then run the tests).
    pytest -v --tb native --log-cli-level=INFO -s {posargs} {toxinidir}/test/smoke/