tox.ini

[tox]
minversion = 1.6
envlist = docs,docs-linkcheck,jjb-version,prefix,robot
skipsdist = true

[testenv:docs]
deps = -rdocs/requirements.txt
commands = sphinx-build -q -W -b html -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html

[testenv:docs-linkcheck]
passenv = http_proxy, https_proxy, no_proxy
basepython = python3
deps = -rdocs/requirements.txt
commands = sphinx-build -q -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck

[testenv:jenkins-jobs]
deps =
    jenkins-job-builder=={env:JJB_VERSION:6.3.0}
commands =
    jenkins-jobs {posargs:--help}

[testenv:jjb-version]
commands = python {toxinidir}/check_jjb_version.py

[testenv:pre-commit-install]
basepython = python3
deps = pre-commit
commands =
    pre-commit install
    pre-commit install --hook-type commit-msg

[testenv:pre-commit-uninstall]
basepython = python3
deps = pre-commit
commands =
    pre-commit uninstall
    pre-commit uninstall --hook-type commit-msg

[testenv:pre-commit]
basepython = python3
deps = pre-commit
passenv = HOME
commands =
    pre-commit run --all-files --show-diff-on-failure
    pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
    # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
    # Its default arguments --passed and --msg-filename are different from CI recommandations.
    # As a result, the line above is always skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file.

[testenv:prefix]
commands = python {toxinidir}/check_prefix.py

[testenv:robot]
basepython = python3
commands = python {toxinidir}/check_robot.py

[testenv:cut-branch-jobs]
basepython = python3
deps =
    pre-commit
    ruamel.yaml
commands =
    python scripts/cut-branch-jobs.py {posargs:--help} {toxinidir}/jjb
    - pre-commit run --all-files prettier

[testenv:checkbashisms]
deps =
allowlist_externals = sh
                      find
                      checkbashisms
commands =
    sh -c 'which checkbashisms>/dev/null  || sudo yum install devscripts-minimal || sudo apt-get install devscripts \
        || (echo "checkbashisms command not found - please install it (e.g. sudo apt-get install devscripts | \
        yum install devscripts-minimal )" >&2 && exit 1)'
    find . -not -path '*/\.*' -name *.sh -exec checkbashisms -f  \{\} +

[testenv:pylint]
basepython = python3
deps = pylint>=2.6.0
allowlist_externals = find
commands =
# .tox folder and submodules directories global-jjb/ & packer/common-packer/ must be excluded since they are not maintained here
    find . -name *.py -not -path "./.tox/*" -not -path "./global-jjb/*" -not -path "./packer/common-packer/*" -exec \
    pylint --fail-under=6.50 --max-line-length=120 --disable=missing-docstring --disable=fixme --disable=duplicate-code \{\} +