tox.ini

[tox]
skipsdist = true
minversion = 3.18.0
requires = virtualenv >= 20.0

[testenv]
whitelist_externals = bash
basepython = python3
skip_install = true
setenv =
    VIRTUALENV_NO_DOWNLOAD=1

[testenv:pip-compile]
description =
    Update the requirements.txt files.
basepython = python3.6
skip_install = true
deps =
    pip==20.3.3
    pip-tools==5.4.0
setenv =
    CUSTOM_COMPILE_COMMAND = tox -e pip-compile
commands =
    bash -c ' \
        pip-compile \
            --emit-index-url --emit-trusted-host --annotate --generate-hashes \
            --allow-unsafe \
            {posargs:--upgrade} \
            -o "{toxinidir}/buildchain/requirements.tmp" \
            "{toxinidir}/buildchain/requirements.in" \
        && \
        ( \
            gawk "/^[^ ]/\{e=1\}; /^pyinotify/\{e=0\}; /^macfsevents/\{e=0\}; e\{print\}" \
                < "{toxinidir}/buildchain/requirements.tmp" \
            && \
            cat "{toxinidir}/buildchain/platform-requirements.txt" \
        ) > "{toxinidir}/buildchain/requirements.txt" \
        && \
        rm -f "{toxinidir}/buildchain/requirements.tmp" \
    '
    pip-compile \
        --emit-index-url --emit-trusted-host --annotate --generate-hashes \
        --allow-unsafe \
        {posargs:--upgrade} \
        -o "{toxinidir}/buildchain/requirements-dev.txt" \
        "{toxinidir}/buildchain/requirements-dev.in"
    pip-compile \
        --emit-index-url --emit-trusted-host --annotate \
        --allow-unsafe \
        {posargs:--upgrade} \
        -o "{toxinidir}/docs/requirements.txt" \
        "{toxinidir}/docs/requirements.in"
    pip-compile \
        --emit-index-url --emit-trusted-host --annotate --generate-hashes \
        --allow-unsafe \
        {posargs:--upgrade} \
        -o "{toxinidir}/tests/requirements.txt" \
        "{toxinidir}/tests/requirements.in"
    pip-compile \
        --emit-index-url --emit-trusted-host --annotate --generate-hashes \
        --allow-unsafe \
        {posargs:--upgrade} \
        -o "{toxinidir}/salt/tests/requirements.txt" \
        "{toxinidir}/salt/tests/requirements.in"

[testenv:docs]
description = Render and lint documentation.
skip_install = true
deps =
    -r{toxinidir}/docs/requirements.txt
commands =
    doc8 docs/
    {toxinidir}/docs/build.cmd {posargs:html}
passenv =
    O
    READTHEDOCS
setenv =
    SPHINXOPTS=-j4 -n -W

[doc8]
ignore-path = docs/_build,docs/requirements.txt
ignore-path-errors = docs/installation/introduction.rst;D001

[coverage:run]
omit =
  salt/_modules/metalk8s_package_manager_apt.py

[testenv:unit-tests]
description =
    Run Python unit tests.
deps =
  -r{toxinidir}/salt/tests/requirements.txt
commands =
    pytest --cov-report=term-missing \
           --cov=salt/_modules \
           --cov-fail-under=100 \
          {posargs} salt/tests/unit

[testenv:lint-python]
description =
    Lint Python files using pylint and mypy.
# Set Python version to Python3 as shipped with RHEL/CentOS 7
basepython = python3.6
deps =
    -r{toxinidir}/buildchain/requirements.txt
    -r{toxinidir}/buildchain/requirements-dev.txt
commands =
    bash -c " \
        typed_files=( \
            buildchain/dodo.py \
            buildchain/buildchain \
            packages/debian/download_packages.py \
        ); \
        untyped_files=( \
            salt/metalk8s/volumes/files/sparse_volume_cleanup.py \
        ); \
        pylint $\{untyped_files[@]\} $\{typed_files[@]\}; PYLINT_RC=$?; \
        mypy --strict $\{typed_files[@]\}; MYPY_RC=$?; \
        if [[ $PYLINT_RC -gt 0 || $MYPY_RC -gt 0 ]]; then \
            echo Failed: pylint [$PYLINT_RC] - mypy [$MYPY_RC]; exit 1; \
        else \
            echo Success!; \
        fi \
    "

[testenv:lint-shell]
description =
    Lint Shell scripts using shellcheck.
whitelist_externals =
    {[testenv]whitelist_externals}
    shellcheck
commands =
    bash -c "shellcheck $(git ls-files | grep -P '\.sh$')"
    bash -c "shellcheck $(git ls-files | grep -P '\.sh\.in$')"

[testenv:lint-yaml]
description =
    Lint Salt and Eve YAML files using yamllint.
deps =
    yamllint==1.15.0
commands =
    bash -c "yamllint eve/main.yml salt/metalk8s/defaults.yaml"

[testenv:tests]
description =
    Run tests suite remotely (uses local Vagrant configuration by default).
deps =
    -r{toxinidir}/tests/requirements.txt
passenv =
    SSH_CONFIG_FILE
    TEST_HOSTS_LIST
    ISO_MOUNTPOINT
    BOOTSTRAP_BACKUP_ARCHIVE
setenv =
    VAGRANT_CWD={toxinidir}
commands_pre =
    - bash -c "vagrant ssh-config > {envdir}/vagrant_ssh_config"
commands =
    pytest \
         --ssh-config={env:SSH_CONFIG_FILE:{envdir}/vagrant_ssh_config} \
         --hosts={env:TEST_HOSTS_LIST:bootstrap} \
         --iso-root={env:ISO_MOUNTPOINT:/vagrant/_build/root} \
         {posargs:-m local} tests

[testenv:tests-local]
description =
    Run tests suite on the bootstrap node of an installation.
deps = {[testenv:tests]deps}
passenv =
    ISO_MOUNTPOINT
    BOOTSTRAP_BACKUP_ARCHIVE
commands =
    pytest \
        --iso-root={env:ISO_MOUNTPOINT:_build/root} \
        {posargs:-m local} tests

[pytest]
bdd_strict_gherkin = false
markers =
    ci: tag a BDD feature as part of CI test suite
    install: tag a BDD feature as an installation scenario
    local: tag a BDD feature as part of local test suite
    multinodes: tag a BDD feature requiring more than one node to run
    post: tag a BDD feature as a post-installation test
    slow: tag a BDD feature as a long running test
    ui: tag a BDD feature as related to MetalK8s UI
    salt: tag a BDD feature as related to Salt operations
    monitoring: tag a BDD feature as related to monitoring
    ingress: tag a BDD feature as related to ingress
    volume: tag a BDD feature as related to Volume management
    bootstrap: tag a BDD feature as related to bootstrap
    authentication: tag a BDD feature as related to authentication
    csc: tag a BDD feature related to Cluster and Service configuration
    solution: tag a BDD feature as related to solution
    restore: tag a BDD feature as related to bootstrap node recovery
filterwarnings =
    ignore:encode_point has been deprecated on EllipticCurvePublicNumbers and will be removed in a future version. Please use EllipticCurvePublicKey.public_bytes to obtain both compressed and uncompressed point encoding.:UserWarning
    ignore:Support for unsafe construction of public numbers from encoded data will be removed in a future version. Please use EllipticCurvePublicKey.from_encoded_point:UserWarning