X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=tox.ini;h=b235bf3ab80c7dfa8945d95c5eb0c379b56210e5;hp=5fc3172c1a97686efb7d8a3c63ec88ba33ecd077;hb=HEAD;hpb=5e6145a4260ffce1c302e94b9b241851f90838e1

diff --git a/tox.ini b/tox.ini
index 5fc3172c1a..e0ac85c22a 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright (c) 2019 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,56 +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]
-envlist = new_line_length, line_length, autogen, pylint
+# Fast and brief checkers to front, slow or verbose checkers to back.
+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.
+# 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:pylint]
-deps =
-    pylint==1.5.4
-    -r ./requirements.txt
-whitelist_externals = /bin/bash
+[testenv:autogen]
 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"
+whitelist_externals = bash
+commands = bash {[tox]script_dir}/autogen.sh
+
+[testenv:copyright_year]
+whitelist_externals = bash
+commands = bash {[tox]script_dir}/copyright_year.sh
 
-# TODO: See FIXME in https://gerrit.fd.io/r/16423
+[testenv:fix_copyright_year]
+whitelist_externals = bash
+commands = bash {[tox]script_dir}/fix_copyright_year.sh
+
+[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:autogen]
-whitelist_externals = /bin/bash
+[testenv:pylint]
+# Run pylint, but hide its return value until python warnings are cleared.
+ignore_outcome = true
 setenv = PYTHONPATH = {toxinidir}
-commands = bash {[tox]checker_dir}/autogen.sh
-
-# 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 voting "pylint violations should not increase" checker.
-# TODO: Figure out how to make new_line checker voting.
-# TODO: Migrate current docs check here.
-# TODO: Create license checker.
-# 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.
+basepython = python3
+deps = -r ./requirements.txt
+whitelist_externals = bash
+commands = bash {[tox]script_dir}/pylint.sh