1 # Copyright (c) 2019 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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 # Idea of this file is motivated by OpenDylight,
15 # especially its Integration/Test sub-project.
17 # This file requires active virtualenv with tox package installed,
18 # or python-tox system package installed.
21 # cd to CSIT root (other directories might use different tox.ini)
23 # will execute all checks.
25 # will execute only checks defined in "pylint" tox environment.
28 envlist = new_line_length, line_length, autogen, pylint, tc_naming, tc_coverage
29 # The following is needed as tox requires setup.py by default.
31 # Just a shorthand to avoid long lines.
32 checker_dir = ./resources/libraries/bash/entry/check
34 # TODO: Tox prints various warnings. Figure them out and fix them.
40 whitelist_externals = /bin/bash
41 setenv = PYTHONPATH = {toxinidir}
42 # Run pylint, but hide its return value until python warnings are cleared.
43 commands = bash -c "bash {[tox]checker_dir}/pylint.sh || true"
45 # TODO: See FIXME in https://gerrit.fd.io/r/16423
48 whitelist_externals = /bin/bash
49 # Fix all transgressions and remove the " || true" workaround.
50 commands = bash -c "bash {[tox]checker_dir}/line.sh || true"
52 [testenv:new_line_length]
53 whitelist_externals = /bin/bash
54 # Adding .svg, big .rst tables, .yaml and similar still requires long lines.
55 # As current implementation is too dumb to filter those out,
56 # the checker has to remain non-voting.
57 commands = bash -c "bash {[tox]checker_dir}/new_line.sh || true"
60 whitelist_externals = /bin/bash
61 setenv = PYTHONPATH = {toxinidir}
62 commands = bash {[tox]checker_dir}/autogen.sh
65 whitelist_externals = /bin/bash
66 # Fix all TC namings and remove the " || true" workaround.
67 commands = bash -c "bash {[tox]checker_dir}/tc_naming.sh || true"
70 whitelist_externals = /bin/bash
71 # Coverage is not needed to be voting.
72 commands = bash -c "bash {[tox]checker_dir}/tc_coverage.sh || true"
74 # TODO: Migrate current docs check here.
75 # TODO: Create voting "pylint violations should not increase" checker.
76 # TODO: Create voting checker to reject suites with Force Tags of other suite.
77 # TODO: Create voting checker against tags not in tag_documentation.rst file.
78 # TODO: Create Robot suite Documentation checker (backslash if not next mark).
79 # TODO: Create .yaml specific checker, so people can override long line check.
80 # TODO: Create .rst specific checker, if there is one allowing
81 # to override line check.
82 # TODO: You get the idea, replace line check with something smarter