-# 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:
[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 = 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
# 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 {[tox]checker_dir}/doc_verify.sh
+
+[testenv:gpl_license]
whitelist_externals = /bin/bash
-commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true"
+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]
+[testenv:model_version]
whitelist_externals = /bin/bash
+commands = bash {[tox]checker_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"
+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"
-
-# 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
+commands = bash {[tox]checker_dir}/pylint.sh
# Keep testenvs sorted alphabetically, please.
-# TODO: Migrate current docs check here.
+# 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.