From: Vratko Polak <vrpolak@cisco.com>
Date: Mon, 18 Jan 2021 13:35:17 +0000 (+0100)
Subject: Tox: Improve tox.ini
X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=commitdiff_plain;h=52a39f861bb645831130ef109a14e629be9bde7a

Tox: Improve tox.ini

Just stylistic improvements, no functional change.

+ Use "ignore_outcome = true" instead of "|| true".
+ Document and apply recommended ordering within testenv definition.
+ Fix some typos.

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

diff --git a/tox.ini b/tox.ini
index 4eff6ac124..b7573f9358 100644
--- a/tox.ini
+++ b/tox.ini
@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2021 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:
@@ -36,56 +36,67 @@ checker_dir = ./resources/libraries/bash/entry/check
 
 # 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.
+# + Other Python stuff (e.g. basepython and deps for pylint).
+# + whitelist_externals to enable bash.
+# + commands with a single bash to launch the corresponding checker script.
+
 # Keep testenvs sorted alphabetically, please.
 
 [testenv:autogen]
-whitelist_externals = /bin/bash
 setenv = PYTHONPATH = {toxinidir}
+whitelist_externals = /bin/bash
 commands = bash {[tox]checker_dir}/autogen.sh
 
 [testenv:copyright_year]
 whitelist_externals = /bin/bash
-setenv = PYTHONPATH = {toxinidir}
 commands = bash {[tox]checker_dir}/copyright_year.sh
 
 [testenv:doc_verify]
-# Fix all documentaion error before enabling voting.
+# Fix all documentation error before enabling voting.
+ignore_outcome = true
 whitelist_externals = /bin/bash
-commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true"
+commands = bash {[tox]checker_dir}/doc_verify.sh
 
 [testenv:gpl_license]
 whitelist_externals = /bin/bash
-setenv = PYTHONPATH = {toxinidir}
 commands = bash {[tox]checker_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]checker_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 = /bin/bash
+commands = bash {[tox]checker_dir}/new_line.sh
 
 [testenv:pylint]
+# Run pylint, but hide its return value until python warnings are cleared.
+ignore_outcome = true
+setenv = PYTHONPATH = {toxinidir}
 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"
+commands = bash {[tox]checker_dir}/pylint.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"
+ignore_outcome = true
+whitelist_externals = /bin/bash
+commands = bash {[tox]checker_dir}/tc_coverage.sh
 
 [testenv:tc_naming]
 whitelist_externals = /bin/bash