tox.ini

   1 [tox]
   2 minversion = 3.7.0
   3 envlist = buildcontroller,testsPCE,
   4     sims121,build_karaf_tests121,tests121,
   5     sims221,build_karaf_tests221,tests221,tests_tapi,
   6     sims71,build_karaf_tests71,tests71,
   7     build_karaf_tests_hybrid,tests_hybrid,
   8     docs
   9     docs-linkcheck
  10     checkbashisms
  11     pre-commit
  12     gitlint
  13     pylint
  14 skipsdist = true
  15 setupdir = tests/
  16
  17 [testenv]
  18 passenv = USE_LIGHTY http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY OLM_TIMER1 OLM_TIMER2
  19 setenv =
  20 #    USE_LIGHTY=True
  21     OLM_TIMER1=3000
  22     OLM_TIMER2=2000
  23
  24 usedevelop = true
  25 basepython = python3
  26 deps =
  27   -r{toxinidir}/tests/requirements.txt
  28   -r{toxinidir}/tests/test-requirements.txt
  29   setuptools>=7.0
  30 changedir = {toxinidir}/tests
  31 parallel_show_output = true
  32
  33 [testenv:buildcontroller]
  34 whitelist_externals = build_controller.sh
  35 commands =
  36   ./build_controller.sh
  37
  38 [testenv:sims121]
  39 whitelist_externals = install_honeynode.sh
  40 depends = buildcontroller
  41 # sims profiles does not strictly depends on buildcontroller
  42 # but this dependency avoids race condition in the gate
  43 commands =
  44   ./install_honeynode.sh 1.2.1
  45
  46 [testenv:sims221]
  47 whitelist_externals = install_honeynode.sh
  48 depends = buildcontroller
  49 commands =
  50   ./install_honeynode.sh 2.2.1
  51
  52 [testenv:sims71]
  53 whitelist_externals = install_honeynode.sh
  54 depends = buildcontroller
  55 commands =
  56   ./install_honeynode.sh 7.1
  57
  58 [testenv:testsPCE]
  59 depends = buildcontroller
  60 #the following lines retrieve unofficial package of GNPy with REST support from Orange opensource Gitlab repo
  61 setenv =
  62     PIP_EXTRA_INDEX_URL = https://gitlab.com/api/v4/projects/33090323/packages/pypi/simple
  63 #    USE_LIGHTY=True
  64 deps =
  65   -r{toxinidir}/tests/requirements.txt
  66   -r{toxinidir}/tests/test-requirements.txt
  67   setuptools>=7.0
  68   gnpy4tpce==2.4.7
  69 whitelist_externals = launch_tests.sh
  70 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION
  71 basepython = python3.8
  72 commands =
  73   ./launch_tests.sh pce {posargs:}
  74
  75 [testenv:build_karaf_tests121]
  76 depends = buildcontroller
  77 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
  78 whitelist_externals = launch_tests.sh
  79 passenv = LAUNCHER USE_LIGHTY
  80 setenv =
  81 #    USE_LIGHTY=True
  82     USE_ODL_ALT_KARAF_ENV=./karaf121.env
  83     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf121
  84 commands =
  85   ./build_karaf_for_tests.sh
  86
  87 [testenv:tests121]
  88 depends = buildcontroller,build_karaf_tests121,sims121,testsPCE
  89 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
  90 whitelist_externals = launch_tests.sh
  91 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION
  92 setenv =
  93 #    USE_LIGHTY=True
  94     USE_ODL_RESTCONF_VERSION=draft-bierman02
  95     USE_ODL_ALT_KARAF_ENV=./karaf121.env
  96     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf121
  97 commands =
  98   ./launch_tests.sh 1.2.1 {posargs:}
  99 # By default, all tests in the folder transportpce_tests/1.2.1/ are run.
 100 # Though, a restricted list of tests can be passed as argument to 'tox -e tests121'.
 101 # For example, 'tox -e tests121 portmapping' will run only the portmapping test.
 102 # and 'tox -e tests121 "portmapping pce"' will run the portmapping and pce tests.
 103 # Additionnally, a different launcher command than 'nosetests --with-xunit' can be
 104 # used by exporting the variable LAUNCHER. For example 'export LAUNCHER="python3"'
 105 # which is more verbose than nose or 'export LAUNCHER="ls -l"' to only list script
 106 # files attributes.
 107
 108 [testenv:build_karaf_tests221]
 109 depends = buildcontroller
 110 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
 111 whitelist_externals = launch_tests.sh
 112 passenv = LAUNCHER USE_LIGHTY
 113 setenv =
 114 #    USE_LIGHTY=True
 115     USE_ODL_ALT_KARAF_ENV=./karaf221.env
 116     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf221
 117 commands =
 118   ./build_karaf_for_tests.sh
 119
 120 [testenv:tests221]
 121 depends = buildcontroller,build_karaf_tests221,sims221,tests71
 122 # tests71 dependency is only here to chain tests in the gate and avoid ressources starvation
 123 whitelist_externals = launch_tests.sh
 124 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION
 125 setenv =
 126 #    USE_LIGHTY=True
 127     USE_ODL_RESTCONF_VERSION=draft-bierman02
 128     USE_ODL_ALT_KARAF_ENV=./karaf221.env
 129     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf221
 130 commands =
 131   ./launch_tests.sh 2.2.1 {posargs:}
 132
 133 [testenv:build_karaf_tests71]
 134 depends = buildcontroller
 135 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
 136 whitelist_externals = launch_tests.sh
 137 passenv = LAUNCHER USE_LIGHTY
 138 setenv =
 139 #    USE_LIGHTY=True
 140     USE_ODL_ALT_KARAF_ENV=./karaf71.env
 141     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf71
 142 commands =
 143   ./build_karaf_for_tests.sh
 144
 145 [testenv:tests71]
 146 depends = buildcontroller,build_karaf_tests71,sims71,tests_tapi
 147 whitelist_externals = launch_tests.sh
 148 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION
 149 setenv =
 150 #    USE_LIGHTY=True
 151     USE_ODL_RESTCONF_VERSION=draft-bierman02
 152     USE_ODL_ALT_KARAF_ENV=./karaf71.env
 153     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf71
 154 commands =
 155   ./launch_tests.sh 7.1 {posargs:}
 156
 157 [testenv:build_karaf_tests_hybrid]
 158 depends = buildcontroller
 159 # testsPCE dependency is only here to chain tests in the gate and avoid resources starvation
 160 whitelist_externals = launch_tests.sh
 161 passenv = LAUNCHER USE_LIGHTY
 162 setenv =
 163 #    USE_LIGHTY=True
 164     USE_ODL_ALT_KARAF_ENV=./karaf121.env
 165     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf_hybrid
 166 commands =
 167   ./build_karaf_for_tests.sh
 168
 169 [testenv:tests_hybrid]
 170 depends = buildcontroller,build_karaf_tests_hybrid,sims121,sims221,sims71,tests121,tests221,tests71
 171 #the last dependency is to avoid temporarily concurrent ressources problem in parallel mode
 172 whitelist_externals = launch_tests.sh
 173 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION
 174 setenv =
 175 #    USE_LIGHTY=True
 176     USE_ODL_ALT_KARAF_ENV=./karaf121.env
 177     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf_hybrid
 178 commands =
 179 #  nosetests --with-xunit transportpce_tests/hybrid/test01_device_change_notifications.py
 180   ./launch_tests.sh hybrid {posargs:}
 181
 182 [testenv:tests_tapi]
 183 depends = buildcontroller,build_karaf_tests221,sims221
 184 whitelist_externals = launch_tests.sh
 185 passenv = LAUNCHER USE_LIGHTY OLM_TIMER1 OLM_TIMER2 USE_ODL_RESTCONF_VERSION
 186 setenv =
 187 #    USE_LIGHTY=True
 188     USE_ODL_RESTCONF_VERSION=draft-bierman02
 189     USE_ODL_ALT_KARAF_ENV=./karaf221.env
 190     USE_ODL_ALT_KARAF_INSTALL_DIR=karaf221
 191     INSTALL_TAPI=True
 192     OLM_TIMER1=3000
 193     OLM_TIMER2=2000
 194
 195 commands =
 196   ./launch_tests.sh tapi {posargs:}
 197
 198 [testenv:nbinotifications]
 199 depends = buildcontroller,sims221
 200 whitelist_externals = launch_tests.sh
 201                       dockercmd.sh
 202 passenv = LAUNCHER USE_LIGHTY USE_ODL_RESTCONF_VERSION OLM_TIMER1 OLM_TIMER2
 203 setenv =
 204     OLM_TIMER1=3000
 205     OLM_TIMER2=2000
 206     INSTALL_TAPI=True
 207     INSTALL_NBINOTIFICATIONS=True
 208
 209 commands =
 210   ./dockercmd.sh run -d -p 2181:2181 -p 9092:9092 --env ADVERTISED_LISTENERS=PLAINTEXT://localhost:9092 --name tpce_kafka1 teivah/kafka:2.0.0
 211   ./launch_tests.sh with_docker nbinotifications
 212   ./dockercmd.sh container rm -f tpce_kafka1
 213
 214 [testenv:docs]
 215 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
 216 basepython = python3
 217 deps = -rdocs/requirements.txt
 218 commands =
 219     sphinx-build -q -W --keep-going -b html -n -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/html
 220
 221 [testenv:docs-linkcheck]
 222 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
 223 basepython = python3
 224 deps = -rdocs/requirements.txt
 225 commands = sphinx-build -q -b linkcheck -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/linkcheck
 226
 227 [testenv:checkbashisms]
 228 deps =
 229 whitelist_externals = sh
 230                       checkbashisms
 231                       sudo
 232                       find
 233 commands =
 234     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)'
 235     find . -not -path '*/\.*' -name *.sh -exec checkbashisms -f  \{\} +
 236
 237 [testenv:spelling]
 238 basepython = python3
 239 deps =
 240     -rdocs/requirements.txt
 241     sphinxcontrib-spelling
 242     PyEnchant
 243 commands = sphinx-build -b spelling -d {envtmpdir}/doctrees ../docs/ {toxinidir}/docs/_build/spelling
 244
 245 [testenv:autopep8]
 246 basepython = python3
 247 deps = autopep8
 248 commands =
 249     autopep8 --max-line-length 120 --in-place --recursive transportpce_tests/
 250
 251 [testenv:pylint_full]
 252 basepython = python3
 253 deps = pylint>=2.6.0
 254 whitelist_externals = find
 255 commands =
 256     find transportpce_tests/ -name *.py -exec pylint --fail-under=9.22 --max-line-length=120 --disable=missing-docstring --module-rgx="([a-z0-9_]+$)|([0-9.]{1,30}$)" --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  \{\} +
 257
 258 [testenv:pylint]
 259 basepython = python3
 260 deps = pylint>=2.6.0
 261 whitelist_externals = find
 262 commands =
 263     find transportpce_tests/ -name *.py -exec pylint --fail-under=10 --max-line-length=120 --disable=missing-docstring --disable=fixme --disable=duplicate-code --module-rgx="([a-z0-9_]+$)|([0-9.]{1,30}$)" --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}$" \{\} +
 264
 265 [testenv:pyang]
 266 basepython = python3
 267 deps = pyang
 268 whitelist_externals = find
 269 commands =
 270     pyang --version
 271     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/ \{\} +
 272 #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/ \{\} +
 273
 274 [testenv:pyangformat]
 275 basepython = python3
 276 deps = pyang
 277 whitelist_externals = sh
 278 commands =
 279     pyang --version
 280     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'
 281
 282 [testenv:pre-commit-install]
 283 basepython = python3
 284 deps = pre-commit
 285 commands =
 286     pre-commit install
 287     pre-commit install --hook-type commit-msg
 288
 289 [testenv:pre-commit-uninstall]
 290 basepython = python3
 291 deps = pre-commit
 292 commands =
 293     pre-commit uninstall
 294     pre-commit uninstall --hook-type commit-msg
 295
 296 [testenv:pre-commit-autoupdate]
 297 basepython = python3
 298 deps = pre-commit
 299 commands =
 300     pre-commit autoupdate
 301
 302 [testenv:pre-commit]
 303 basepython = python3
 304 deps = pre-commit
 305 passenv = HOME
 306 commands =
 307     pre-commit run --all-files --show-diff-on-failure
 308     pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
 309     # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
 310     # Its default arguments --passed and --msg-filename are different from CI recommandations.
 311     # As a result, the line above is always skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file.
 312     # A dedicated gitlint profile for CI is proposed below. Also to behave fine locally, this profile must have access
 313     # to the HOME variable so that Gitlint can retrieve Git user settings.
 314
 315 [testenv:gitlint]
 316 basepython = python3
 317 deps = gitlint
 318 commands =
 319     gitlint --config ../.gitlint
 320