Merge "RIC:1060: Change in PTL"
[ric-plt/xapp-frame-py.git] / tox.ini
1 # ==================================================================================
2 #       Copyright (c) 2020 Nokia
3 #       Copyright (c) 2020 AT&T Intellectual Property.
4 #
5 #   Licensed under the Apache License, Version 2.0 (the "License");
6 #   you may not use this file except in compliance with the License.
7 #   You may obtain a copy of the License at
8 #
9 #          http://www.apache.org/licenses/LICENSE-2.0
10 #
11 #   Unless required by applicable law or agreed to in writing, software
12 #   distributed under the License is distributed on an "AS IS" BASIS,
13 #   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 #   See the License for the specific language governing permissions and
15 #   limitations under the License.
16 # ==================================================================================
17 [tox]
18 envlist = code,flake8,docs,docs-linkcheck
19 minversion = 2.0
20
21 [testenv:code]
22 basepython = python3.10
23 deps=
24     pytest
25     coverage
26     pytest-cov
27     six
28 setenv =
29     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
30     RMR_SEED_RT = tests/fixtures/test_local.rt
31     RMR_ASYNC_CONN = 0
32 commands =
33     # add -s flag after pytest to show logs immediately instead of delaying
34     pytest --cov ricxappframe --cov-report xml --cov-report term-missing --cov-report html --cov-fail-under=70 --junitxml=/tmp/tests.xml
35     coverage xml -i
36
37 [testenv:flake8]
38 basepython = python3.10
39 skip_install = true
40 deps = flake8
41 commands = flake8 setup.py ricxappframe tests
42
43 [flake8]
44 extend-ignore = E501,E741,E731
45 exclude = ricxappframe/entities,ricxappframe/subsclient
46
47 [testenv:clm]
48 # use pip to gather dependencies with versions for CLM analysis
49 whitelist_externals = sh
50 commands = sh -c 'pip freeze > requirements.txt'
51
52 # doc jobs
53 [testenv:docs]
54 whitelist_externals = echo
55 skipsdist = true
56 basepython = python3
57 setenv =
58     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
59 deps = sphinx
60        sphinx-rtd-theme
61        sphinxcontrib-httpdomain
62        recommonmark
63        lfdocs-conf
64        numpydoc
65        inotify_simple
66        mdclogpy
67        msgpack
68        ricsdl
69        protobuf
70        inotify
71        urllib3~=1.26.15
72
73 allowlist_externals = echo
74
75 commands =
76     sphinx-build -W -b html -n -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/html
77     echo "Generated docs available in {toxinidir}/docs/_build/html"
78
79 [testenv:docs-linkcheck]
80 skipsdist = true
81 basepython = python3
82 setenv =
83     LD_LIBRARY_PATH = /usr/local/lib/:/usr/local/lib64
84 deps = sphinx
85        sphinx-rtd-theme
86        sphinxcontrib-httpdomain
87        recommonmark
88        lfdocs-conf
89        numpydoc
90        inotify_simple
91        mdclogpy
92        msgpack
93        ricsdl
94        urllib3~=1.26.15
95 commands = sphinx-build -W -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck