# Copyright (c) 2020 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: # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # Idea of this file is motivated by OpenDylight, # especially its Integration/Test sub-project. # This file requires active virtualenv with tox package installed, # or python-tox system package installed. # Usage: # cd to CSIT root (other directories might use different tox.ini) # $ tox # will execute all checks. # $ tox -e pylint # will execute only checks defined in "pylint" tox environment. [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 # 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 # TODO: Tox prints various warnings. Figure them out and fix them. # Keep testenvs sorted alphabetically, please. [testenv:autogen] whitelist_externals = /bin/bash setenv = PYTHONPATH = {toxinidir} 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. whitelist_externals = /bin/bash commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true" [testenv:line_length] whitelist_externals = /bin/bash # Fix all transgressions and remove the " || true" workaround. commands = bash -c "bash {[tox]checker_dir}/line.sh || true" [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" [testenv:pylint] 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 # 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 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 # wherever possible.