298c8cb3f6895ae4d457af29680e7fc697b7cd1f
[transportpce.git] / tox.ini
1 [tox]
2 minversion = 3.7.0
3 envlist = buildcontroller,testsPCE,sims121,tests121,sims221,tests221,sims71,tests71,tests_hybrid
4     docs
5     docs-linkcheck
6     checkbashisms
7     pre-commit
8     gitlint
9 skipsdist = true
10 setupdir = tests/
11
12 [testenv]
13 passenv = USE_LIGHTY http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
14 setenv =
15     USE_LIGHTY=True
16 usedevelop = true
17 basepython = python3
18 deps =
19   -r{toxinidir}/tests/requirements.txt
20   -r{toxinidir}/tests/test-requirements.txt
21   setuptools>=7.0
22 changedir = {toxinidir}/tests
23 parallel_show_output = true
24
25 [testenv:buildcontroller]
26 whitelist_externals = sh
27                       sudo
28 commands =
29 #install maven and JDK11 on the Gate since they are not there by default
30   sh -c "which mvn >/dev/null || ./installMavenCentOS.sh"
31 #patch OLM constant to speed up tests, unnecessary for PCE tests
32   sh -c "sed -i'_' 's@=.*//#FUNCTESTVAL=@=@g' ../olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java"
33   sh -c 'if [ "$USE_LIGHTY" != "True" ]; then (cd ../; for suffix in 121 221 71; do rm -rf "karaf$suffix"; cp -r karaf "karaf$suffix";done) ; fi'
34 #build controller, source JDK_JAVA_OPTIONS to remove illegal reflective acces warnings introduced by Java11
35   sh -c ". $PWD/reflectwarn.sh && cd .. && mvn clean install -B -q -s tests/odl_settings.xml -DskipTests -Dmaven.javadoc.skip=true -Dodlparent.spotbugs.skip -Dodlparent.checkstyle.skip"
36   sh -c "mv  ../olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java_  ../olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java"
37 #patch Karaf exec for the same reason at runtime and also to have the possibility to use alternative ports
38   sh -c "../karaf/target/assembly/ressources/post_install_for_tests.sh"
39 #build Lighty if needed
40   sh -c 'if [ "$USE_LIGHTY" = "True" ]; then (cd ../lighty && ./build.sh); fi'
41
42 [testenv:sims121]
43 whitelist_externals = install_honeynode.sh
44 depends = buildcontroller
45 # sims profiles does not strictly depends on buildcontroller
46 # but this dependency avoids race condition in the gate
47 commands =
48   ./install_honeynode.sh 1.2.1
49
50 [testenv:sims221]
51 whitelist_externals = install_honeynode.sh
52 depends = buildcontroller
53 commands =
54   ./install_honeynode.sh 2.2.1
55
56 [testenv:sims71]
57 whitelist_externals = install_honeynode.sh
58 depends = buildcontroller
59 commands =
60   ./install_honeynode.sh 7.1
61
62 [testenv:testsPCE]
63 depends = buildcontroller
64 whitelist_externals = launch_tests.sh
65 passenv = LAUNCHER USE_LIGHTY
66 setenv =
67     USE_LIGHTY=True
68 commands =
69   ./launch_tests.sh pce {posargs:}
70
71 [testenv:tests121]
72 depends = buildcontroller,sims121,testsPCE
73 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
74 whitelist_externals = launch_tests.sh
75 passenv = LAUNCHER USE_LIGHTY
76 setenv =
77     USE_LIGHTY=True
78     USE_ODL_ALT_WEBSOCKET_PORT=8186
79     USE_ODL_ALT_AKKA_PORT=2551
80     USE_ODL_ALT_AKKA_MGT_PORT=8559
81     USE_ODL_ALT_SHELL_PORT=8102
82     USE_ODL_ALT_RMI_REGISTRY_PORT=1100
83     USE_ODL_ALT_RMI_SERVER_PORT=44445
84     USE_ODL_ALT_RESTCONF_PORT=8182
85     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf121
86 commands =
87   ./launch_tests.sh 1.2.1 {posargs:}
88 # By default, all tests in the folder transportpce_tests/1.2.1/ are run.
89 # Though, a restricted list of tests can be passed as argument to 'tox -e tests121'.
90 # For example, 'tox -e tests121 portmapping' will run only the portmapping test.
91 # and 'tox -e tests121 "portmapping pce"' will run the portmapping and pce tests.
92 # Additionnally, a different launcher command than 'nosetests --with-xunit' can be
93 # used by exporting the variable LAUNCHER. For example 'export LAUNCHER="python3"'
94 # which is more verbose than nose or 'export LAUNCHER="ls -l"' to only list script
95 # files attributes.
96
97 [testenv:tests221]
98 depends = buildcontroller,sims221,tests71
99 # tests71 dependency is only here to chain tests in the gate and avoid ressources starvation
100 whitelist_externals = launch_tests.sh
101 passenv = LAUNCHER USE_LIGHTY
102 setenv =
103     USE_LIGHTY=True
104     USE_ODL_ALT_WEBSOCKET_PORT=8187
105     USE_ODL_ALT_AKKA_PORT=2552
106     USE_ODL_ALT_AKKA_MGT_PORT=8560
107     USE_ODL_ALT_SHELL_PORT=8103
108     USE_ODL_ALT_RMI_REGISTRY_PORT=1101
109     USE_ODL_ALT_RMI_SERVER_PORT=44446
110     USE_ODL_ALT_RESTCONF_PORT=8183
111     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf221
112 commands =
113   ./launch_tests.sh 2.2.1 {posargs:}
114
115 [testenv:tests71]
116 depends = buildcontroller,sims71
117 whitelist_externals = launch_tests.sh
118 passenv = LAUNCHER USE_LIGHTY
119 setenv =
120     USE_LIGHTY=True
121     USE_ODL_ALT_WEBSOCKET_PORT=8188
122     USE_ODL_ALT_AKKA_PORT=2553
123     USE_ODL_ALT_AKKA_MGT_PORT=8561
124     USE_ODL_ALT_SHELL_PORT=8104
125     USE_ODL_ALT_RMI_REGISTRY_PORT=1102
126     USE_ODL_ALT_RMI_SERVER_PORT=44447
127     USE_ODL_ALT_RESTCONF_PORT=8184
128     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf71
129 commands =
130   ./launch_tests.sh 7.1 {posargs:}
131
132 [testenv:tests_hybrid]
133 depends = buildcontroller,sims121,sims221,sims71,tests121,tests221,tests71
134 #the last dependency is to avoid temporarily concurrent ressources problem in parallel mode
135 whitelist_externals = launch_tests.sh
136 passenv = LAUNCHER USE_LIGHTY
137 setenv =
138     USE_LIGHTY=True
139     USE_ODL_ALT_WEBSOCKET_PORT=8186
140     USE_ODL_ALT_AKKA_PORT=2551
141     USE_ODL_ALT_AKKA_MGT_PORT=8559
142     USE_ODL_ALT_SHELL_PORT=8102
143     USE_ODL_ALT_RMI_REGISTRY_PORT=1100
144     USE_ODL_ALT_RMI_SERVER_PORT=44445
145     USE_ODL_ALT_RESTCONF_PORT=8182
146     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf121
147 commands =
148 #  nosetests --with-xunit transportpce_tests/hybrid/test01_device_change_notifications.py
149   ./launch_tests.sh hybrid {posargs:}
150
151 [testenv:gnpy]
152 depends = buildcontroller
153 whitelist_externals = sh
154                       sudo
155 passenv = LAUNCHER USE_LIGHTY
156 commands =
157   #sudo docker pull atriki/gnpyrest:v1.2
158   sudo docker run -d -p 8008:5000 --name gnpy_tpce_rest1 atriki/gnpyrest:v1.2
159   ./launch_tests.sh with_docker gnpy
160   sudo docker container rm -f gnpy_tpce_rest1
161
162 [testenv:nbinotifications]
163 depends = buildcontroller,sims221
164 whitelist_externals = sh
165                       sudo
166 passenv = LAUNCHER USE_LIGHTY
167 commands =
168   sudo docker-compose -f ./nbinotifications/docker-compose.yml up -d
169   ./launch_tests.sh with_docker nbinotifications
170   sudo docker-compose -f ./nbinotifications/docker-compose.yml down --rmi all
171
172 [testenv:docs]
173 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
174 basepython = python3
175 deps = -rdocs/requirements.txt
176 commands =
177     sphinx-build -q -W -b html -n -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/html
178
179 [testenv:docs-linkcheck]
180 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
181 basepython = python3
182 deps = -rdocs/requirements.txt
183 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/linkcheck
184
185 [testenv:checkbashisms]
186 deps =
187 whitelist_externals = sh
188                       checkbashisms
189                       sudo
190                       find
191 commands =
192     sh -c 'command checkbashisms>/dev/null || sudo yum install devscripts-minimal || (echo "checkbashisms command not found - please install it (e.g. sudo apt-get install devscripts | yum install devscripts-minimal )" >&2 && exit 1)'
193     find . -not -path '*/\.*' -name *.sh -exec checkbashisms -f  \{\} +
194
195 [testenv:spelling]
196 basepython = python3
197 deps =
198     -rdocs/requirements.txt
199     sphinxcontrib-spelling
200     PyEnchant
201 commands = sphinx-build -b spelling  -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/spelling
202
203 [testenv:autopep8]
204 basepython = python3
205 deps = autopep8
206 commands =
207     autopep8 --max-line-length 120 --in-place --recursive transportpce_tests/
208
209 [testenv:pylint]
210 basepython = python3
211 deps = pylint
212 whitelist_externals = find
213 commands =
214     find transportpce_tests/ -name *.py -exec pylint --max-line-length=120 --disable=missing-docstring --method-rgx="(([a-z_][a-zA-Z0-9_]{2,})|(_[a-z0-9_]*)|(__[a-zA-Z][a-zA-Z0-9_]+__))$" --variable-rgx="[a-zA-Z_][a-zA-Z0-9_]{1,30}$" --reports=y --score=y  --output-format=colorized  \{\} +
215
216 [testenv:pyang]
217 basepython = python3
218 deps = pyang
219 whitelist_externals = find
220 commands =
221     pyang --version
222     find ../api/ -name target -prune -o -name *.yang -exec pyang --lint --canonical --max-line-length=120 -p../api/src/main/yang/:../ordmodels/common/src/main/yang/:../ordmodels/service/src/main/yang/:../tapimodels/src/main/yang/ \{\} +
223 #find ../api/ ../ordmodels/ ../tapimodels/ -name target -prune -o -name *.yang -exec pyang --lint --canonical --max-line-length=120 -p../api/src/main/yang/:../ordmodels/common/src/main/yang/:../ordmodels/service/src/main/yang/:../tapimodels/src/main/yang/ \{\} +
224
225 [testenv:pyangformat]
226 basepython = python3
227 deps = pyang
228 whitelist_externals = sh
229 commands =
230     pyang --version
231     sh -c 'find ../api/ -name target -prune -o -name *.yang -print | while read -r fname; do pyang -f yang --yang-canonical --yang-remove-unused-imports --max-line-length=120 --keep-comments -p../api/src/main/yang/:../ordmodels/common/src/main/yang/:../ordmodels/service/src/main/yang/:../tapimodels/src/main/yang/ "$fname"  -o /tmp/tmpfile.$$ && mv /tmp/tmpfile.$$ "$fname";done'
232
233 [testenv:pre-commit-install]
234 basepython = python3
235 deps = pre-commit
236 commands =
237     pre-commit install
238     pre-commit install --hook-type commit-msg
239
240 [testenv:pre-commit-uninstall]
241 basepython = python3
242 deps = pre-commit
243 commands =
244     pre-commit uninstall
245     pre-commit uninstall --hook-type commit-msg
246
247 [testenv:pre-commit]
248 basepython = python3
249 deps = pre-commit
250 passenv = HOME
251 commands =
252     pre-commit run --all-files --show-diff-on-failure
253     pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
254     # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
255     # Its default arguments --passed and --msg-filename are different from CI recommandations.
256     # As a result, the line above is always skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file.
257     # A dedicated gitlint profile for CI is proposed below. Also to behave fine locally, this profile must have access
258     # to the HOME variable so that Gitlint can retrieve Git user settings.
259
260 [testenv:gitlint]
261 basepython = python3
262 deps = gitlint
263 commands =
264     gitlint
265