X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=tox.ini;h=126af2d454267a767e3909a80bf7b9952e3386e1;hp=110ad15fca11431d5fd3e8df69bb49b2110a74e1;hb=f14292d2b8f946263ee9160830908050c002c2fc;hpb=89940bb19f015b4cc57d36a1e95cf9d935293b36

diff --git a/tox.ini b/tox.ini
index 110ad15fca..126af2d454 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright (c) 2019 Cisco and/or its affiliates.
+# Copyright (c) 2022 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,54 +20,90 @@
 # 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 = job_spec, copyright_year, gpl_license, model_version,
+    new_line_length, line_length, autogen, pylint, doc_verify
+
 # 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.
 
-[testenv:pylint]
-deps =
-    pylint==1.5.4
-    -r ./requirements.txt
-whitelist_externals = /bin/bash
+# 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.
+
+# Keep testenvs sorted alphabetically, please.
+
+[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 = /bin/bash
+commands = bash {[tox]script_dir}/autogen.sh
 
-# TODO: See FIXME in https://gerrit.fd.io/r/16423
+[testenv:copyright_year]
+whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/copyright_year.sh
+
+[testenv:doc_verify]
+# Fix all documentation error before enabling voting.
+ignore_outcome = true
+whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/doc_verify.sh
+
+[testenv:gpl_license]
+whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/gpl_license.sh
 
 [testenv:line_length]
+# Fix all transgressions and remove the ignore_outcome flag.
+ignore_outcome = true
 whitelist_externals = /bin/bash
-# Fix all transgressions and remove the " || true" workaround.
-commands = bash -c "bash {[tox]checker_dir}/line.sh || true"
+commands = bash {[tox]script_dir}/line.sh
 
-[testenv:new_line_length]
+[testenv:model_version]
 whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/model_version.sh
+
+[testenv:new_line_length]
 # 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"
-
-[testenv:autogen]
+ignore_outcome = true
 whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/new_line.sh
+
+[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
+basepython = python3
+deps =
+    pylint==2.4.3
+    -r ./requirements.txt
+whitelist_externals = /bin/bash
+commands = bash {[tox]script_dir}/pylint.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: Figure out how to make new_line checker voting.
-# TODO: Migrate current docs check here.
-# TODO: Create license 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
+# TODO: You get the idea, replace line checker with something smarter
 #       wherever possible.