Remove leftovers related to Xenial
[csit.git] / tox.ini
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:
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 envlist = new_line_length, line_length, autogen, pylint, tc_naming, tc_coverage,
29     doc_verify
30
31 # The following is needed as tox requires setup.py by default.
32 skipsdist = true
33 # Just a shorthand to avoid long lines.
34 checker_dir = ./resources/libraries/bash/entry/check
35
36 # TODO: Tox prints various warnings. Figure them out and fix them.
37
38 [testenv:pylint]
39 basepython = python3
40 deps =
41     pylint==2.4.3
42     -r ./requirements.txt
43 whitelist_externals = /bin/bash
44 setenv = PYTHONPATH = {toxinidir}
45 # Run pylint, but hide its return value until python warnings are cleared.
46 commands = bash -c "bash {[tox]checker_dir}/pylint.sh || true"
47
48 # TODO: See FIXME in https://gerrit.fd.io/r/16423
49
50 [testenv:line_length]
51 whitelist_externals = /bin/bash
52 # Fix all transgressions and remove the " || true" workaround.
53 commands = bash -c "bash {[tox]checker_dir}/line.sh || true"
54
55 [testenv:new_line_length]
56 whitelist_externals = /bin/bash
57 # Adding .svg, big .rst tables, .yaml and similar still requires long lines.
58 # As current implementation is too dumb to filter those out,
59 # the checker has to remain non-voting.
60 commands = bash -c "bash {[tox]checker_dir}/new_line.sh || true"
61
62 [testenv:autogen]
63 whitelist_externals = /bin/bash
64 setenv = PYTHONPATH = {toxinidir}
65 commands = bash {[tox]checker_dir}/autogen.sh
66
67 [testenv:tc_naming]
68 whitelist_externals = /bin/bash
69 commands = bash {[tox]checker_dir}/tc_naming.sh
70
71 [testenv:tc_coverage]
72 whitelist_externals = /bin/bash
73 # Coverage is not needed to be voting.
74 commands = bash -c "bash {[tox]checker_dir}/tc_coverage.sh || true"
75
76 [testenv:doc_verify]
77 # Fix all documentaion error before enabling voting.
78 whitelist_externals = /bin/bash
79 commands = bash -c "bash {[tox]checker_dir}/doc_verify.sh || true"
80
81 # TODO: Migrate current docs check here.
82 # TODO: Create voting "pylint violations should not increase" checker.
83 # TODO: Create voting checker to reject suites with Force Tags of other suite.
84 # TODO: Create voting checker against tags not in tag_documentation.rst file.
85 # TODO: Create Robot suite Documentation checker (backslash if not next mark).
86 # TODO: Create .yaml specific checker, so people can override long line check.
87 # TODO: Create .rst specific checker, if there is one allowing
88 #       to override line check.
89 # TODO: You get the idea, replace line check with something smarter
90 #       wherever possible.

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.