From: Vratko Polak <vrpolak@cisco.com>
Date: Fri, 31 Jan 2020 13:34:00 +0000 (+0100)
Subject: Tox: Sort items and add comments on sort criterion
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=commitdiff_plain;h=72fa59b1c11aaf884136fece19999fc80c59d45e

Tox: Sort items and add comments on sort criterion

Change-Id: I8d8619f5a0b7ec7ee45b85ef78ff6bb8e9ea88a1
Signed-off-by: Vratko Polak <vrpolak@cisco.com>
---

diff --git a/tox.ini b/tox.ini
index 4617e73e54..0e1c6bc52c 100644
--- a/tox.ini
+++ b/tox.ini
@@ -25,7 +25,8 @@
 # will execute only checks defined in "pylint" tox environment.
 
 [tox]
-envlist = new_line_length, line_length, autogen, pylint, tc_naming, tc_coverage,
+# Fast and brief checkers to front, slow or verbose checkers to back.
+envlist = tc_naming, tc_coverage, new_line_length, line_length, autogen, pylint,
     doc_verify
 
 # The following is needed as tox requires setup.py by default.
@@ -35,17 +36,17 @@ checker_dir = ./resources/libraries/bash/entry/check
 
 # TODO: Tox prints various warnings. Figure them out and fix them.
 
-[testenv:pylint]
-basepython = python3
-deps =
-    pylint==2.4.3
-    -r ./requirements.txt
+# Keep testenvs sorted alphabetically, please.
+
+[testenv:autogen]
 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"
+commands = bash {[tox]checker_dir}/autogen.sh
 
-# TODO: See FIXME in https://gerrit.fd.io/r/16423
+[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:line_length]
 whitelist_externals = /bin/bash
@@ -59,24 +60,28 @@ whitelist_externals = /bin/bash
 # the checker has to remain non-voting.
 commands = bash -c "bash {[tox]checker_dir}/new_line.sh || true"
 
-[testenv:autogen]
+[testenv:pylint]
+basepython = python3
+deps =
+    pylint==2.4.3
+    -r ./requirements.txt
 whitelist_externals = /bin/bash
 setenv = PYTHONPATH = {toxinidir}
-commands = bash {[tox]checker_dir}/autogen.sh
+# Run pylint, but hide its return value until python warnings are cleared.
+commands = bash -c "bash {[tox]checker_dir}/pylint.sh || true"
 
-[testenv:tc_naming]
-whitelist_externals = /bin/bash
-commands = bash {[tox]checker_dir}/tc_naming.sh
+# 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:doc_verify]
-# Fix all documentaion error before enabling voting.
+[testenv:tc_naming]
 whitelist_externals = /bin/bash
-commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true"
+commands = bash {[tox]checker_dir}/tc_naming.sh
+
+# Keep testenvs sorted alphabetically, please.
 
 # TODO: Migrate current docs check here.
 # TODO: Create voting "pylint violations should not increase" checker.