tox.ini

# SPDX-FileCopyrightText: oVirt Developers
# SPDX-License-Identifier: GPL-2.0-or-later

[tox]
envlist = flake8, pylint, reuse, tests, storage-user, storage-root, lib, network, virt, gluster, hooks

skipsdist = true
skip_missing_interpreters = True

[testenv]
basepython=python3
sitepackages = True
whitelist_externals = profile

[base]
passenv = *
setenv =
    PYTHONPATH = {toxinidir}/lib
    LC_ALL = C.UTF8
deps =
    pytest
    pytest-cov
    pytest-timeout
    pyasyncore  # Python 3.12+ compatibility for asyncore module
changedir = {toxinidir}/tests
markers = "not (integration or slow or stress)"

# PYTHONHASHSEED: Using random hash seed expose bad tests assuming order of
# unorder things.
# TODO: remove this option after the failing tests are fixed.

[testenv:tests]
passenv =
    {[base]passenv}
setenv =
    {[base]setenv}
    PYTHONHASHSEED = 0
deps =
    {[base]deps}
    yappi
whitelist_externals = make
changedir = {[base]changedir}
commands =
    python profile {envname} make check

[testenv:lib]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-lib
deps = {[base]deps}
changedir = {[base]changedir}
commands =
    python profile {envname} pytest -m {[base]markers} --durations=10 {posargs} \
        --cov=vdsm \
        --cov=yajsonrpc \
        --cov-report=html:htmlcov-lib \
        common/commands_test.py \
        common/concurrent_test.py \
        common/properties_test.py \
        common/systemctl_test.py \
        common/systemd_test.py \
        common/time_test.py \
        lib/ \
        hooking_test.py \
        prlimit_test.py \
        pywatch_test.py \
        ssl_test.py \
        tool_configurators_lvm_test.py

[testenv:network]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-network
deps = {[base]deps}
changedir = {[base]changedir}
commands =
    python profile {envname} pytest \
        --durations=5 \
        --cov=vdsm.network \
        --cov-report=html:htmlcov-network \
        --cov-fail-under={env:NETWORK_COVERAGE:42} \
        {posargs} \
        network/integration \
        network/unit

[testenv:storage-user]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-storage-user
changedir = {[base]changedir}
commands =
    python -I -m pip install packaging>=22.0
    python -I -m pip install pytest pytest-cov pytest-timeout userstorage>=0.5.1
    python profile {envname} pytest -m {[base]markers}" and not root" \
    --durations=20 \
    --cov=vdsm.storage \
    --cov-report=html:htmlcov-storage-user \
    --cov-fail-under={env:STORAGE_USER_COVERAGE:61} \
    {posargs:storage}

[testenv:storage-root]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-storage-root
changedir = {[base]changedir}
commands =
    python -I -m pip install packaging>=22.0
    python -I -m pip install pytest pytest-cov pytest-timeout userstorage>=0.5.1
    python profile {envname} pytest -m {[base]markers}" and root" \
    --durations=20 \
    --cov=vdsm.storage \
    --cov-report=html:htmlcov-storage-root \
    --cov-fail-under={env:STORAGE_ROOT_COVERAGE:47} \
    {posargs:storage}

[testenv:virt]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-virt
deps = {[base]deps}
changedir = {[base]changedir}
commands =
    python profile {envname} pytest \
        --durations=5 \
        --cov=vdsm.virt \
        --cov-report=html:htmlcov-virt \
        {posargs:virt}

[testenv:gluster]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-gluster
deps = {[base]deps}
changedir = {[base]changedir}
commands =
    python profile {envname} pytest \
        --durations=5 \
        --cov=vdsm.gluster \
        --cov-report=html:htmlcov-gluster \
        {posargs:gluster}

[testenv:hooks]
passenv = {[base]passenv}
setenv =
    {[base]setenv}
    COVERAGE_FILE=.coverage-hooks
    PYTHONPATH = {toxinidir}/lib:{toxinidir}/lib/vdsm/hook:{toxinidir}/vdsm_hooks
deps = {[base]deps}
changedir = {[base]changedir}
commands =
    python profile {envname} pytest -m {[base]markers} --durations=10 {posargs} \
        hooks

[testenv:pylint]
setenv =
    PYTHONPATH = vdsm:lib
commands =
    python -I -m pip install packaging>=22.0
    python -I -m pip install pylint>=3.2.0,<4.0.0
    python {toxinidir}/tests/profile {envname} pylint -j{env:PYLINT_JOBS:4} --reports=no --score=no {posargs}

[testenv:flake8]
deps =
    flake8>=6.0.0
commands=
    python {toxinidir}/tests/profile {envname} flake8 --statistics {posargs} \
        lib \
        tests \
        vdsm_hooks \
        contrib \
        build-aux/vercmp \
        contrib/logdb \
        contrib/logstat \
        contrib/lvs-stats \
        contrib/profile-stats \
        init/daemonAdapter \
        lib/vdsm/storage/curl-img-wrap \
        lib/vdsm/storage/fc-scan \
        static/libexec/vdsm/get-conf-item \
        static/usr/bin/vdsm-tool

[testenv:black]
sitepackages = false
skip_install = true
deps =
    black==25.11.0
commands =
    black \
        -l 79 \
        -S \
        --check \
        --diff \
        {posargs} \
        ./lib/ \
        ./tests/

[reuse]
deps =
    reuse
commands =
    reuse lint

[pytest]
# -r chars: (s)skipped, (x)failed, (X)passed
# --strict-markers: ensure no unregistered markers are used
# --color=yes: force colored output even in non-TTY environments
addopts = -rxXs --basetemp=/var/tmp/vdsm --strict-markers --color=yes

# Registration of all pytest markers (e.g., pytest.mark.slow)
# https://docs.pytest.org/en/latest/mark.html
markers =
    integration
    legacy_switch
    ovs_switch
    root
    slow
    stress
    unit

# Fail if test marks as xfail succeeds. To handle flaky tests You can override
# the value:
#     @pytest.mark.xfail(reason="Fails randomly" strict=False)
xfail_strict = True

# Include time with pytest logs for easier identification of related events
log_format=%(asctime)s,%(msecs)03d %(levelname)-7s (%(threadName)s) [%(name)s] %(message)s (%(module)s:%(lineno)d)

log_level=DEBUG

# Kill test process if a test is too slow. Slow tests can override this
# value using:
#
#   @pytest.mark.timeout(60)
#   def very_slow_test():
#
timeout = 30

# Fail by kiling the test process from another thread.
timeout_method = thread

[flake8]

# Ignore errors in current code to make the build pass
# TODO: fix the code and eliminate these ignores:
# - 18    E731 do not assign a lambda expression, use a def
# - 151   E722 do not use bare 'except'
# - 238   W504 line break after binary operator
#
# The following test must be skipped as this rule goes against the
# PEP 8 recommended style, which was changed on April 16th, 2016:
# - W503 line break before binary operator
# 
# There are false positives with whitespace around : in slices,
# If there would be an issue with whitespace around : black would notice it and fix it, so we can ignore this error:
# - E203 whitespace before ':'
# For more details see: https://github.com/PyCQA/pycodestyle/issues/373
ignore = E731, E722, W504, W503, E203

# Per-file ignores for specific cases
per-file-ignores =
    # Ignore long lines in test files with XML strings - breaking these would hurt readability
    tests/virt/devicexml_test.py:E501
    tests/virt/metadata_test.py:E501
    tests/testValidation.py:E501
    tests/testlib.py:E501
    # Ignore false positive for global _client usage in statsd.py
    lib/vdsm/metrics/statsd.py:F824

show_source = True