5e9566704120976705db43c4d620bb2546d08120
[ric-app/qp-driver.git] / tox.ini
1 # ==================================================================================
2 #       Copyright (c) 2020 AT&T Intellectual Property.
3 #
4 #   Licensed under the Apache License, Version 2.0 (the "License");
5 #   you may not use this file except in compliance with the License.
6 #   You may obtain a copy of the License at
7 #
8 #          http://www.apache.org/licenses/LICENSE-2.0
9 #
10 #   Unless required by applicable law or agreed to in writing, software
11 #   distributed under the License is distributed on an "AS IS" BASIS,
12 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 #   See the License for the specific language governing permissions and
14 #   limitations under the License.
15 # ==================================================================================
16 [tox]
17 envlist = code,flake8,docs,docs-linkcheck
18 minversion = 2.0
19
20 [testenv:code]
21 basepython = python3.8
22 deps=
23     pytest
24     coverage
25     pytest-cov
26 setenv =
27     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
28     RMR_SEED_RT = tests/fixtures/test_local.rt
29     RMR_ASYNC_CONN = 0
30     USE_FAKE_SDL = 1
31
32 # add -s after pytest to stream the logs as they come in, rather than saving for the end
33 commands =
34     pytest -v --cov qpdriver --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70
35     coverage xml -i
36
37 [testenv:flake8]
38 basepython = python3.8
39 skip_install = true
40 deps = flake8
41 commands = flake8 setup.py qpdriver tests
42
43 [flake8]
44 extend-ignore = E501,E741,E731
45
46 [testenv:clm]
47 # use pip to gather dependencies with versions for CLM analysis
48 whitelist_externals = sh
49 commands = sh -c 'pip freeze > requirements.txt'
50
51 # doc jobs
52 [testenv:docs]
53 whitelist_externals = echo
54 skipsdist = true
55 basepython = python3.8
56 deps =
57     sphinx
58     sphinx-rtd-theme
59     sphinxcontrib-httpdomain
60     recommonmark
61     lfdocs-conf
62 commands =
63     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
64     echo "Generated docs available in {toxinidir}/docs/_build/html"
65
66 [testenv:docs-linkcheck]
67 skipsdist = true
68 basepython = python3.8
69 deps = sphinx
70        sphinx-rtd-theme
71        sphinxcontrib-httpdomain
72        recommonmark
73        lfdocs-conf
74 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck