tox.ini

[tox]
minversion=4.4
toxworkdir=.tox
skipsdist=True
envlist =
    py{37,38,39,310}-{cov,nocov}
    code-linters
    pcluster-diag

# Default testenv. Used to run tests on all python versions.
[testenv]
passenv =
    CI
    GITHUB_*
deps =
    -rtest/unit/requirements.txt
    py{37,38,39,310}: pytest-asyncio
setenv =
    PYTHONPATH = \
        {toxinidir}/cookbooks/aws-parallelcluster-platform/files/dcv:\
        {toxinidir}/cookbooks/aws-parallelcluster-environment/files/cloudwatch:\
        {toxinidir}/cookbooks/aws-parallelcluster-computefleet/files/compute_fleet_status:\
        {toxinidir}/cookbooks/aws-parallelcluster-computefleet/files/clusterstatusmgtd:\
        {toxinidir}/cookbooks/aws-parallelcluster-environment/files/custom_action_executor:\
        {toxinidir}/cookbooks/aws-parallelcluster-environment/files/default/ec2_udev_rules:\
        {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/head_node_checks:\
        {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/head_node_slurm/slurm:\
        {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/config_slurm/scripts
commands =
    nocov: pytest -l -v --basetemp={envtmpdir} {[vars]test_dirs}
    cov: pytest -l -v --basetemp={envtmpdir} --cov-report=xml --cov={[vars]cov_dirs} --cov-append {[vars]test_dirs}

# Section used to define common variables used by multiple testenvs.
[vars]
src_dirs =
    {toxinidir}/cookbooks/aws-parallelcluster-environment/files/cloudwatch \
    {toxinidir}/cookbooks/aws-parallelcluster-platform/files/dcv \
    {toxinidir}/cookbooks/aws-parallelcluster-computefleet/files/compute_fleet_status \
    {toxinidir}/cookbooks/aws-parallelcluster-computefleet/files/clusterstatusmgtd \
    {toxinidir}/cookbooks/aws-parallelcluster-environment/files/custom_action_executor \
    {toxinidir}/cookbooks/aws-parallelcluster-environment/files/default/ec2_udev_rules \
    {toxinidir}/cookbooks/aws-parallelcluster-environment/files/cfn_hup_configuration \
    {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/head_node_slurm \
    {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/head_node_checks \
    {toxinidir}/cookbooks/aws-parallelcluster-slurm/files/default/config_slurm/scripts
cov_dirs =
    {toxinidir}/cookbooks/
test_dirs = {toxinidir}/test/unit/
code_dirs = {[vars]src_dirs} {[vars]test_dirs}

##############################
###     AUTO-FORMATTER     ###
##############################

# black is a code formatter for python: https://github.com/ambv/black.
# The following target formats python files with black formatter.
[testenv:black]
basepython = python3
skip_install = true
deps =
    black
commands =
    black -l 120 \
    {[vars]code_dirs} \
    {posargs}

# Checks that python files are correctly formatted.
[testenv:black-check]
basepython = python3
skip_install = true
deps =
    {[testenv:black]deps}
commands =
    {[testenv:black]commands} --check --diff

# isort is an imports sorter for python: https://github.com/timothycrosley/isort
# The following target sorts the import according to .isort.cfg file.
# Pin isort to the last release prior to 5.0.0, which resulted in import
# statements being flagged as improperly sorted where previously they were
# not. See https://timothycrosley.github.io/isort/docs/major_releases/introducing_isort_5/.
[testenv:isort]
basepython = python3
skip_install = true
deps =
    isort
    seed-isort-config
commands =
    isort -w 120 \
    {[vars]code_dirs} \
    {posargs}

# Checks that python imports are correctly sorted.
[testenv:isort-check]
basepython = python3
skip_install = true
deps = {[testenv:isort]deps}
commands = {[testenv:isort]commands} --check --diff

# Reformats code with black and isort.
[testenv:autoformat]
basepython = python3
skip_install = true
deps =
    {[testenv:isort]deps}
    {[testenv:black]deps}
commands =
    {[testenv:isort]commands}
    {[testenv:black]commands}


#############################
###        LINTERS        ###
#############################

# flake8 python linter: https://github.com/PyCQA/flake8.
# flake8 config is located in .flake8 file
[testenv:flake8]
basepython = python3
skip_install = true
deps =
    flake8
    flake8-docstrings
    flake8-bugbear
    # flake8-import-order # delegated to isort
    flake8-colors
    pep8-naming
commands =
    flake8 \
    {[vars]code_dirs} \
    {posargs}

# bandit security linter for python: https://github.com/PyCQA/bandit
[testenv:bandit]
basepython = python3
skip_install = true
deps =
    bandit
commands =
    bandit -r \
        -c .bandit.ini \
        {[vars]code_dirs} \
        {posargs}

# Pylint linter for python: https://www.pylint.org/
# Pylint config is located in .pylintrc file.
[testenv:pylint]
basepython = python3
deps =
    pyflakes
    pylint
commands =
    pylint \
    --recursive=y \
    {[vars]code_dirs} \
    {posargs}


# Vulture finds unused code in python: https://github.com/jendrikseipp/vulture
[testenv:vulture]
basepython = python3
skip_install = true
deps =
    vulture
commands =
    vulture \
    {[vars]code_dirs} \
    {posargs}

# Static type checker for Python: http://mypy-lang.org/
[testenv:mypy]
basepython = python3
deps =
    mypy
commands =
    mypy \
    {[vars]code_dirs} \
    {posargs}

# semgrep is used to check for security issues
# https://semgrep.dev/
[testenv:semgrep]
basepython = python3
deps =
    semgrep>=1.8.0
commands =
    semgrep \
        --config p/r2c-security-audit \
        --config p/secrets \
        --exclude 'cookbooks/iptables/**' \
        --exclude 'cookbooks/line/**' \
        --exclude 'cookbooks/nfs/**' \
        --exclude 'cookbooks/openssh/**' \
        --exclude 'cookbooks/yum/**' \
        --exclude 'cookbooks/yum-epel/**' \
        --exclude 'files/default/jq-*' \
        --exclude 'files/default/*.tar.gz' \
        --error

# Target that groups all code linters to run in CI
[testenv:code-linters]
basepython = python3
skip_install = true
deps =
    {[testenv:black-check]deps}
    {[testenv:isort-check]deps}
    {[testenv:flake8]deps}
    {[testenv:bandit]deps}
    {[testenv:semgrep]deps}
    {[testenv:pylint]deps}
commands =
    {[testenv:black-check]commands}
    {[testenv:isort-check]commands}
    {[testenv:flake8]commands}
    {[testenv:bandit]commands}
    {[testenv:semgrep]commands}
    {[testenv:pylint]commands}


#############################
###     PCLUSTER-DIAG     ###
#############################

# The pcluster-diag package ships its own self-contained tox configuration at
# cookbooks/aws-parallelcluster-platform/files/pcluster-diag/tox.ini.
# This environment delegates to that tox project so the root tox includes it.
#
# Examples:
#   tox -e pcluster-diag                          # run its default envlist (tests + coverage, linters)
#   tox -e pcluster-diag -- -e test               # run only its unit tests (no coverage)
#   tox -e pcluster-diag -- -e test-with-coverage # run only its tests-with-coverage target
#   tox -e pcluster-diag -- -e code-linters       # run only its linters target
[testenv:pcluster-diag]
basepython = python3
skip_install = true
changedir = {toxinidir}/cookbooks/aws-parallelcluster-platform/files/pcluster-diag
# Pass posargs through verbatim; without this tox rewrites path-like args (e.g. an env named like an
# existing directory) relative to changedir.
args_are_paths = false
deps =
    tox
commands =
    tox {posargs}

# The pcluster-diag package is measured separately by its own tox suite (see [testenv:pcluster-diag])
# and uploaded to Codecov under a distinct flag. Omit it here so it never appears in the main
# coverage report, keeping the two reports from overlapping.
[coverage:run]
omit =
    */files/pcluster-diag/*