Add and run some linters via tox and pre-commit
[transportpce.git] / tox.ini
1 [tox]
2 minversion = 1.6
3 envlist = py3
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 whitelist_externals = sh
22                       sudo
23 changedir={toxinidir}/tests
24 commands =
25 #install maven and JDK11 on the Gate since they are not there by default
26   {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,flexgrid,olm221,tapi221,otnend2end,end2end221,pce400g,gnpy,devicenotif}: - sh -c "which mvn >/dev/null || ./installMavenCentOS.sh"
27 #install honeynode 1.2.1 simulators
28   {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,devicenotif}: - sh -c "./install_honeynode.sh 1.2.1"
29 #patch OLM constant to speed up tests, unnecessary for PCE
30   {py3,portmapping,topoPortMapping,rspn,topology,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,olm221,otnend2end,end2end221,tapi221,nbinotifications,devicenotif}: - sh -c "sed -i'_' 's@=.*//#FUNCTESTVAL=@=@g' ../olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java"
31 #build controller, source JDK_JAVA_OPTIONS to remove illegal reflective acces warnings introduced by Java11
32   {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,flexgrid,olm221,tapi221,otnend2end,end2end221,pce400g,gnpy,nbinotifications,devicenotif}: - 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"
33   {py3,portmapping,topoPortMapping,rspn,topology,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,olm221,otnend2end,end2end221,tapi221,nbinotifications,devicenotif}: - 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"
34 #patch Karaf exec for the same reason at runtime
35   {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,flexgrid,olm221,tapi221,otnend2end,end2end221,pce400g,gnpy,nbinotifications,devicenotif}: - sh -c "sed -i'_' 's@!/bin/sh@!/bin/sh\'$'\n. $(dirname $0)/../../../../tests/reflectwarn.sh@' ../karaf/target/assembly/bin/karaf"
36   # the following command would be the straight and right way to support both BSD and GNU sed versions
37   # sh -c "sed -i'_' '1 a\'$'\n. \$(dirname \$0)/\.\./\.\./\.\./\.\./tests/reflectwarn.sh\n' ../karaf/target/assembly/bin/karaf"
38   # but tox reinterprets the quotes as
39   # sh -c 'sed -i'"'"'_'"'"' '"'"'1 a\'"'"'$'"'"'\n. \$(dirname \$0)/\.\./\.\./\.\./\.\./tests/reflectwarn.sh\n'"'"' ../karaf/target/assembly/bin/karaf'
40   # ,what results in an unexpected different formating (with a $ on the second line and the dot on the third)
41 #build Lighty if needed
42   {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,olm221,tapi221,otnend2end,end2end221,pce400g,gnpy,nbinotifications,devicenotif}: - sh -c 'if [ "$USE_LIGHTY" = "True" ]; then (cd ../lighty && ./build.sh); fi'
43 #run 1.2.1 functional tests
44   {py3,portmapping}: nosetests --with-xunit transportpce_tests/1.2.1/test_portmapping.py
45   {py3,topoPortMapping}: nosetests --with-xunit transportpce_tests/1.2.1/test_topo_portmapping.py
46   {py3,topology}: nosetests --with-xunit transportpce_tests/1.2.1/test_topology.py
47   {py3,rspn}: nosetests --with-xunit transportpce_tests/1.2.1/test_renderer_service_path_nominal.py
48   {py3,pce}: nosetests --with-xunit transportpce_tests/1.2.1/test_pce.py
49   {py3,olm}: nosetests --with-xunit transportpce_tests/1.2.1/test_olm.py
50   #E2E 1.2.1 moved at the end before 2.2.1 E2E
51 #run 2.2.1 functional tests
52 #install honeynode 2.2.1 simulators
53   {py3,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,flexgrid,olm221,tapi221,otnend2end,end2end221,nbinotifications,devicenotif}: - sh -c "./install_honeynode.sh 2.2.1"
54   {py3,portmapping221}: nosetests --with-xunit transportpce_tests/2.2.1/test_portmapping.py
55   {py3,topology221}: nosetests --with-xunit transportpce_tests/2.2.1/test_topology.py
56   {py3,otntopology}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_topology.py
57   {py3,flexgrid}: nosetests --with-xunit transportpce_tests/2.2.1/test_flex_grid.py
58   {py3,rspn221}: nosetests --with-xunit transportpce_tests/2.2.1/test_renderer_service_path_nominal.py
59   {py3,otnrenderer}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_renderer.py
60   {py3,otnshrenderer}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_sh_renderer.py
61   {py3,olm221}: nosetests --with-xunit transportpce_tests/2.2.1/test_olm.py
62   {py3,tapi221}: nosetests --with-xunit transportpce_tests/2.2.1/test_tapi.py
63   {py3,otnend2end}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_end2end.py
64 #run 7.1 functional tests
65   {py3,pce400g}: nosetests --with-xunit transportpce_tests/7.1/test_pce_400G.py
66 #install honeynode 7.1 simulators
67   {py3,portmapping71,devicenotif}: - sh -c "./install_honeynode.sh 7.1"
68   {py3,portmapping71}: nosetests --with-xunit transportpce_tests/7.1/test_portmapping.py
69 #End-to-End
70   {py3,end2end}: nosetests --with-xunit transportpce_tests/1.2.1/test_end2end.py
71   {py3,end2end221}: nosetests --with-xunit transportpce_tests/2.2.1/test_end2end.py
72   #{gnpy}: - sudo docker pull atriki/gnpyrest:v1.2
73   {gnpy}: - sudo docker run -d -p 8008:5000 --name gnpy_tpce_rest1 atriki/gnpyrest:v1.2
74   {gnpy}: nosetests --with-xunit transportpce_tests/1.2.1/test_gnpy.py
75   {gnpy}: - sudo docker container rm -f gnpy_tpce_rest1
76   {nbinotifications}: - sudo docker-compose -f ./nbinotifications/docker-compose.yml up -d
77   {nbinotifications}: nosetests --with-xunit transportpce_tests/2.2.1/test_nbinotifications.py
78   {nbinotifications}: - sudo docker-compose -f ./nbinotifications/docker-compose.yml down --rmi all
79 # Hybrid tests
80   {py3,devicenotif}: nosetests --with-xunit transportpce_tests/hybrid/test_device_change_notifications.py
81
82 [testenv:docs]
83 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
84 basepython = python3
85 deps = -rdocs/requirements.txt
86 commands =
87     sphinx-build -q -W -b html -n -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/html
88
89 [testenv:docs-linkcheck]
90 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
91 basepython = python3
92 deps = -rdocs/requirements.txt
93 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/linkcheck
94
95 [testenv:checkbashisms]
96 deps =
97 whitelist_externals = sh
98                       checkbashisms
99                       sudo
100                       find
101 commands =
102     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)'
103     find . -not -path '*/\.*' -name *.sh -exec checkbashisms -f  \{\} +
104
105 [testenv:spelling]
106 basepython = python3
107 deps =
108     -rdocs/requirements.txt
109     sphinxcontrib-spelling
110     PyEnchant
111 commands = sphinx-build -b spelling  -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/spelling
112
113 [testenv:autopep8]
114 basepython = python3
115 deps = autopep8
116 commands =
117     autopep8 --max-line-length 120 --in-place --recursive transportpce_tests/
118
119 [testenv:pylint]
120 basepython = python3
121 deps = pylint
122 whitelist_externals = find
123 commands =
124     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  \{\} +
125
126 [testenv:pyang]
127 basepython = python3
128 deps = pyang
129 whitelist_externals = find
130 commands =
131     pyang --version
132     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/ \{\} +
133 #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/ \{\} +
134
135 [testenv:pyangformat]
136 basepython = python3
137 deps = pyang
138 whitelist_externals = sh
139 commands =
140     pyang --version
141     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'
142
143 [testenv:pre-commit-install]
144 basepython = python3
145 deps = pre-commit
146 commands =
147     pre-commit install
148     pre-commit install --hook-type commit-msg
149
150 [testenv:pre-commit-uninstall]
151 basepython = python3
152 deps = pre-commit
153 commands =
154     pre-commit uninstall
155     pre-commit uninstall --hook-type commit-msg
156
157 [testenv:pre-commit]
158 basepython = python3
159 deps = pre-commit
160 passenv = HOME
161 commands =
162     pre-commit run --all-files --show-diff-on-failure
163     pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
164     # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
165     # Its default arguments --passed and --msg-filename are different from CI recommandations.
166     # As a result, the line above is always skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file.
167     # A dedicated gitlint profile for CI is proposed below. Also to behave fine locally, this profile must have access
168     # to the HOME variable so that Gitlint can retrieve Git user settings.
169
170 [testenv:gitlint]
171 basepython = python3
172 deps = gitlint
173 commands =
174     gitlint
175