tox.ini

# Copyright 2024 Canonical Ltd.
# See LICENSE file for licensing details.

[tox]
no_package = True
skip_missing_interpreters = True
env_list = format, lint, static, unit
min_version = 4.0.0

[vars]
src_path = {tox_root}/src
tests_path = {tox_root}/tests
;lib_path = {tox_root}/lib/charms/operator_name_with_underscores
all_path = {[vars]src_path} {[vars]tests_path}

[testenv]
set_env =
    PYTHONPATH = {[vars]src_path}:{tox_root}/lib
    PY_COLORS = 1
allowlist_externals =
    poetry

[testenv:format]
description = Apply coding style standards to code
commands_pre =
    poetry install --only format
commands =
    poetry lock
    poetry run ruff check --fix {[vars]all_path}
    poetry run ruff format {[vars]all_path}

[testenv:lint]
description = Check code against coding style standards
allowlist_externals =
    {[testenv]allowlist_externals}
    find
commands_pre =
    poetry install --only lint
commands =
    poetry check --lock
    # uncomment the following line if this charm owns a lib
    # codespell {[vars]lib_path}
    poetry run codespell {[vars]all_path}
    poetry run ruff check {[vars]all_path}
    poetry run ruff format --check --diff {[vars]all_path}
    find {[vars]all_path} -type f \( -name "*.sh" -o -name "*.bash" \) -exec poetry run shellcheck --color=always \{\} +

[testenv:unit]
description = Run unit tests
set_env =
    {[testenv]set_env}
commands_pre =
    poetry install --only main,charm-libs,unit
commands =
    poetry run coverage run --source={[vars]src_path},{[vars]lib_path} \
        -m pytest -v --tb native -s {posargs} {[vars]tests_path}/unit
    poetry run coverage report
    poetry run coverage xml

[testenv:integration]
description = Run integration tests
pass_env =
    CI
    GITHUB_OUTPUT
    SECRETS_FROM_GITHUB
allowlist_externals =
    {[testenv]allowlist_externals}
    # Set the testing host before starting the lxd cloud
    sudo
    apt-get
    tar
    mv
    wget
    etcdctl
    sh
commands_pre =
    poetry install --only integration
    # workaround to install etcdctl from release archive
    # in 22.04 only etcdctl v3.3.25 is included, which is incompatible to v3.4.x
    # this workaround will be removed once we can run on "noble" runners
    sudo apt install wget -y
    wget https://github.com/etcd-io/etcd/releases/download/v3.4.35/etcd-v3.4.35-linux-amd64.tar.gz -P /tmp/etcd_install/
    tar -xvf /tmp/etcd_install/etcd-v3.4.35-linux-amd64.tar.gz -C /tmp/etcd_install/
    sudo mv /tmp/etcd_install/etcd-v3.4.35-linux-amd64/etcdctl /usr/local/bin
commands =
    # https://github.com/canonical/data-platform-workflows/blob/main/python/pytest_plugins/pytest_operator_cache/deprecation_notice.md
    sh -c "if [ -z "$CI" ]; then charmcraft pack; fi;"
    poetry run pytest -v --tb native --log-cli-level=INFO -s --ignore={[vars]tests_path}/unit/ {posargs}