tox.ini

   1 # Copyright (c) 2021 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 # Idea of this file is motivated by OpenDylight,
  15 # especially its Integration/Test sub-project.
  16
  17 # This file requires active virtualenv with tox package installed,
  18 # or python-tox system package installed.
  19
  20 # Usage:
  21 # cd to CSIT root (other directories might use different tox.ini)
  22 #   $ tox
  23 # will execute all checks.
  24 #  $ tox -e pylint
  25 # will execute only checks defined in "pylint" tox environment.
  26
  27 [tox]
  28 # Fast and brief checkers to front, slow or verbose checkers to back.
  29 envlist = tc_naming, tc_coverage, copyright_year, gpl_license, new_line_length,
  30     line_length, autogen, pylint, doc_verify
  31
  32 # The following is needed as tox requires setup.py by default.
  33 skipsdist = true
  34 # Just a shorthand to avoid long lines.
  35 checker_dir = ./resources/libraries/bash/entry/check
  36
  37 # TODO: Tox prints various warnings. Figure them out and fix them.
  38
  39 # Recommended ordering withinn testenv definition:
  40 # + General comments.
  41 # + ignore_outcome for non-voting checkers,
  42 # + setenv (PYTHONPATH) for Python-using checkers.
  43 # + Other Python stuff (e.g. basepython and deps for pylint).
  44 # + whitelist_externals to enable bash.
  45 # + commands with a single bash to launch the corresponding checker script.
  46
  47 # Keep testenvs sorted alphabetically, please.
  48
  49 [testenv:autogen]
  50 setenv = PYTHONPATH = {toxinidir}
  51 whitelist_externals = /bin/bash
  52 commands = bash {[tox]checker_dir}/autogen.sh
  53
  54 [testenv:copyright_year]
  55 whitelist_externals = /bin/bash
  56 commands = bash {[tox]checker_dir}/copyright_year.sh
  57
  58 [testenv:doc_verify]
  59 # Fix all documentation error before enabling voting.
  60 ignore_outcome = true
  61 whitelist_externals = /bin/bash
  62 commands = bash {[tox]checker_dir}/doc_verify.sh
  63
  64 [testenv:gpl_license]
  65 whitelist_externals = /bin/bash
  66 commands = bash {[tox]checker_dir}/gpl_license.sh
  67
  68 [testenv:line_length]
  69 # Fix all transgressions and remove the ignore_outcome flag.
  70 ignore_outcome = true
  71 whitelist_externals = /bin/bash
  72 commands = bash {[tox]checker_dir}/line.sh
  73
  74 [testenv:new_line_length]
  75 # Adding .svg, big .rst tables, .yaml and similar still requires long lines.
  76 # As current implementation is too dumb to filter those out,
  77 # the checker has to remain non-voting.
  78 ignore_outcome = true
  79 whitelist_externals = /bin/bash
  80 commands = bash {[tox]checker_dir}/new_line.sh
  81
  82 [testenv:pylint]
  83 # Run pylint, but hide its return value until python warnings are cleared.
  84 ignore_outcome = true
  85 setenv = PYTHONPATH = {toxinidir}
  86 basepython = python3
  87 deps =
  88     pylint==2.4.3
  89     -r ./requirements.txt
  90 whitelist_externals = /bin/bash
  91 commands = bash {[tox]checker_dir}/pylint.sh
  92
  93 # TODO: See FIXME in https://gerrit.fd.io/r/16423
  94
  95 [testenv:tc_coverage]
  96 # Coverage is not needed to be voting.
  97 ignore_outcome = true
  98 whitelist_externals = /bin/bash
  99 commands = bash {[tox]checker_dir}/tc_coverage.sh
 100
 101 [testenv:tc_naming]
 102 whitelist_externals = /bin/bash
 103 commands = bash {[tox]checker_dir}/tc_naming.sh
 104
 105 # Keep testenvs sorted alphabetically, please.
 106
 107 # TODO: Add a checker against unresolved merge conflicts.
 108 #       See: https://gerrit.fd.io/r/c/vpp/+/26956
 109 # TODO: Create voting "pylint violations should not increase" checker.
 110 # TODO: Create voting checker to reject suites with Force Tags of other suite.
 111 # TODO: Create voting checker against tags not in tag_documentation.rst file.
 112 # TODO: Create Robot suite Documentation checker (backslash if not next mark).
 113 # TODO: Create .yaml specific checker, so people can override long line check.
 114 # TODO: Create .rst specific checker, if there is one allowing
 115 #       to override line check.
 116 # TODO: You get the idea, replace line check with something smarter
 117 #       wherever possible.