diff options
Diffstat (limited to 'tox.ini')
| -rw-r--r-- | tox.ini | 92 |
1 files changed, 37 insertions, 55 deletions
@@ -1,4 +1,4 @@ -# Copyright (c) 2020 Cisco and/or its affiliates. +# Copyright (c) 2024 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -20,82 +20,64 @@ # Usage: # cd to CSIT root (other directories might use different tox.ini) # $ tox -# will execute all checks. +# will execute all default checkers. # $ tox -e pylint -# will execute only checks defined in "pylint" tox environment. +# will execute only checkers (or fixers) defined in "pylint" tox environment. [tox] # Fast and brief checkers to front, slow or verbose checkers to back. -envlist = tc_naming, tc_coverage, copyright_year, new_line_length, line_length, - autogen, pylint, doc_verify +envlist = copyright_year, gpl_license, new_line_length, line_length, autogen, + pylint # The following is needed as tox requires setup.py by default. skipsdist = true # Just a shorthand to avoid long lines. -checker_dir = ./resources/libraries/bash/entry/check +script_dir = ./resources/libraries/bash/entry/tox -# TODO: Tox prints various warnings. Figure them out and fix them. - -# Keep testenvs sorted alphabetically, please. +# Recommended ordering withinn testenv definition: +# + General comments. +# + ignore_outcome for non-voting checkers, +# + setenv (PYTHONPATH) for Python-using checkers and fixers. +# + Other Python stuff (e.g. basepython and deps for pylint). +# + whitelist_externals to enable bash. +# + Commands with a single bash to launch the corresponding script. [testenv:autogen] -whitelist_externals = /bin/bash setenv = PYTHONPATH = {toxinidir} -commands = bash {[tox]checker_dir}/autogen.sh +whitelist_externals = bash +commands = bash {[tox]script_dir}/autogen.sh [testenv:copyright_year] -whitelist_externals = /bin/bash -setenv = PYTHONPATH = {toxinidir} -commands = bash {[tox]checker_dir}/copyright_year.sh +whitelist_externals = bash +commands = bash {[tox]script_dir}/copyright_year.sh + +[testenv:fix_copyright_year] +whitelist_externals = bash +commands = bash {[tox]script_dir}/fix_copyright_year.sh -[testenv:doc_verify] -# Fix all documentaion error before enabling voting. -whitelist_externals = /bin/bash -commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true" +[testenv:gpl_license] +whitelist_externals = bash +commands = bash {[tox]script_dir}/gpl_license.sh [testenv:line_length] -whitelist_externals = /bin/bash -# Fix all transgressions and remove the " || true" workaround. -commands = bash -c "bash {[tox]checker_dir}/line.sh || true" +# Fix all transgressions and remove the ignore_outcome flag. +ignore_outcome = true +whitelist_externals = bash +commands = bash {[tox]script_dir}/line.sh [testenv:new_line_length] -whitelist_externals = /bin/bash # Adding .svg, big .rst tables, .yaml and similar still requires long lines. # As current implementation is too dumb to filter those out, # the checker has to remain non-voting. -commands = bash -c "bash {[tox]checker_dir}/new_line.sh || true" +ignore_outcome = true +whitelist_externals = bash +commands = bash {[tox]script_dir}/new_line.sh [testenv:pylint] -basepython = python3 -deps = - pylint==2.4.3 - -r ./requirements.txt -whitelist_externals = /bin/bash -setenv = PYTHONPATH = {toxinidir} # Run pylint, but hide its return value until python warnings are cleared. -commands = bash -c "bash {[tox]checker_dir}/pylint.sh || true" - -# TODO: See FIXME in https://gerrit.fd.io/r/16423 - -[testenv:tc_coverage] -whitelist_externals = /bin/bash -# Coverage is not needed to be voting. -commands = bash -c "bash {[tox]checker_dir}/tc_coverage.sh || true" - -[testenv:tc_naming] -whitelist_externals = /bin/bash -commands = bash {[tox]checker_dir}/tc_naming.sh - -# Keep testenvs sorted alphabetically, please. - -# TODO: Add a checker against unresolved merge conflicts. -# See: https://gerrit.fd.io/r/c/vpp/+/26956 -# TODO: Create voting "pylint violations should not increase" checker. -# TODO: Create voting checker to reject suites with Force Tags of other suite. -# TODO: Create voting checker against tags not in tag_documentation.rst file. -# TODO: Create Robot suite Documentation checker (backslash if not next mark). -# TODO: Create .yaml specific checker, so people can override long line check. -# TODO: Create .rst specific checker, if there is one allowing -# to override line check. -# TODO: You get the idea, replace line check with something smarter -# wherever possible. +ignore_outcome = true +setenv = PYTHONPATH = {toxinidir} +basepython = python3 +deps = -r ./requirements.txt +whitelist_externals = bash +commands = bash {[tox]script_dir}/pylint.sh |