X-Git-Url: https://gerrit.fd.io/r/gitweb?p=csit.git;a=blobdiff_plain;f=tox.ini;h=079e689136b21799ee21982500224b0d1a071f78;hp=5fc3172c1a97686efb7d8a3c63ec88ba33ecd077;hb=dc28d6ba2adc598699a71fc5757f08325840d358;hpb=5e6145a4260ffce1c302e94b9b241851f90838e1 diff --git a/tox.ini b/tox.ini index 5fc3172c1a..079e689136 100644 --- a/tox.ini +++ b/tox.ini @@ -1,4 +1,4 @@ -# Copyright (c) 2019 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: @@ -25,7 +25,10 @@ # will execute only checks 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. @@ -33,40 +36,71 @@ checker_dir = ./resources/libraries/bash/entry/check # 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. +# + 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] 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]checker_dir}/autogen.sh + +[testenv:copyright_year] +whitelist_externals = /bin/bash +commands = bash {[tox]checker_dir}/copyright_year.sh + +[testenv:doc_verify] +# Fix all documentation error before enabling voting. +ignore_outcome = true +whitelist_externals = /bin/bash +commands = bash {[tox]checker_dir}/doc_verify.sh -# TODO: See FIXME in https://gerrit.fd.io/r/16423 +[testenv:gpl_license] +whitelist_externals = /bin/bash +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" - -[testenv:autogen] +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} -commands = bash {[tox]checker_dir}/autogen.sh +basepython = python3 +deps = + pylint==2.4.3 + -r ./requirements.txt +whitelist_externals = /bin/bash +commands = bash {[tox]checker_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: 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