Refactor tox.ini to prepare parallelized jobs

- split py3 profiles into several profiles
  and regroup tests by OpenROADM devices version
- separate the controller build from tests themselves in a dedicated
  profile
- use "depends" to state profiles dependencies.
  This is necessary so that tox can order tests sequences
  and decides which jobs can be run in parallel.
  This parameter requires tox versions >= 3.7.0

NB: at this stage, tests can no more be run standalone from a dedicated
tox profile.

JIRA: TRNSPRTPCE-482
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I8d583f01003c4d9ee690d866ff602757392c3304

diff --git a/tox.ini b/tox.ini
index 59e210daf700409038b7f3aa8f8270ffced5c5d5..707d38efd9097729cb4f17a6b568896b38d8737c 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -1,6 +1,6 @@
 [tox]
-minversion = 1.6
-envlist = py3
+minversion = 3.7.0
+envlist = buildcontroller,sims121,tests121,sims221,tests221,sims71,tests71,tests_hybrid
     docs
     docs-linkcheck
     checkbashisms
@@ -13,71 +13,116 @@ setupdir = tests/
 passenv = USE_LIGHTY http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY
 setenv =
     USE_LIGHTY = True
-usedevelop = True
+usedevelop = true
 basepython = python3
 deps =
   -r{toxinidir}/tests/requirements.txt
   -r{toxinidir}/tests/test-requirements.txt
+  setuptools>=7.0
+changedir = {toxinidir}/tests
+parallel_show_output = true
+
+[testenv:buildcontroller]
 whitelist_externals = sh
                       sudo
-changedir={toxinidir}/tests
 commands =
 #install maven and JDK11 on the Gate since they are not there by default
-  {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"
+  sh -c "which mvn >/dev/null || ./installMavenCentOS.sh"
 #install honeynode 1.2.1 simulators
-  {py3,portmapping,topoPortMapping,rspn,topology,pce,olm,end2end,devicenotif}: - sh -c "./install_honeynode.sh 1.2.1"
-#patch OLM constant to speed up tests, unnecessary for PCE
-  {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"
+#patch OLM constant to speed up tests, unnecessary for PCE tests
+  sh -c "sed -i'_' 's@=.*//#FUNCTESTVAL=@=@g' ../olm/src/main/java/org/opendaylight/transportpce/olm/util/OlmUtils.java"
 #build controller, source JDK_JAVA_OPTIONS to remove illegal reflective acces warnings introduced by Java11
-  {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"
-  {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"
+  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"
+  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"
 #patch Karaf exec for the same reason at runtime
-  {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"
+  sh -c "sed -i'_' 's@!/bin/sh@!/bin/sh\'$'\n. $(dirname $0)/../../../../tests/reflectwarn.sh@' ../karaf/target/assembly/bin/karaf"
   # the following command would be the straight and right way to support both BSD and GNU sed versions
   # sh -c "sed -i'_' '1 a\'$'\n. \$(dirname \$0)/\.\./\.\./\.\./\.\./tests/reflectwarn.sh\n' ../karaf/target/assembly/bin/karaf"
   # but tox reinterprets the quotes as
   # sh -c 'sed -i'"'"'_'"'"' '"'"'1 a\'"'"'$'"'"'\n. \$(dirname \$0)/\.\./\.\./\.\./\.\./tests/reflectwarn.sh\n'"'"' ../karaf/target/assembly/bin/karaf'
   # ,what results in an unexpected different formating (with a $ on the second line and the dot on the third)
 #build Lighty if needed
-  {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'
-#run 1.2.1 functional tests
-  {py3,portmapping}: nosetests --with-xunit transportpce_tests/1.2.1/test_portmapping.py
-  {py3,topoPortMapping}: nosetests --with-xunit transportpce_tests/1.2.1/test_topo_portmapping.py
-  {py3,topology}: nosetests --with-xunit transportpce_tests/1.2.1/test_topology.py
-  {py3,rspn}: nosetests --with-xunit transportpce_tests/1.2.1/test_renderer_service_path_nominal.py
-  {py3,pce}: nosetests --with-xunit transportpce_tests/1.2.1/test_pce.py
-  {py3,olm}: nosetests --with-xunit transportpce_tests/1.2.1/test_olm.py
-  #E2E 1.2.1 moved at the end before 2.2.1 E2E
-#run 2.2.1 functional tests
-#install honeynode 2.2.1 simulators
-  {py3,portmapping221,rspn221,otnrenderer,otnshrenderer,topology221,otntopology,flexgrid,olm221,tapi221,otnend2end,end2end221,nbinotifications,devicenotif}: - sh -c "./install_honeynode.sh 2.2.1"
-  {py3,portmapping221}: nosetests --with-xunit transportpce_tests/2.2.1/test_portmapping.py
-  {py3,topology221}: nosetests --with-xunit transportpce_tests/2.2.1/test_topology.py
-  {py3,otntopology}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_topology.py
-  {py3,flexgrid}: nosetests --with-xunit transportpce_tests/2.2.1/test_flex_grid.py
-  {py3,rspn221}: nosetests --with-xunit transportpce_tests/2.2.1/test_renderer_service_path_nominal.py
-  {py3,otnrenderer}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_renderer.py
-  {py3,otnshrenderer}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_sh_renderer.py
-  {py3,olm221}: nosetests --with-xunit transportpce_tests/2.2.1/test_olm.py
-  {py3,tapi221}: nosetests --with-xunit transportpce_tests/2.2.1/test_tapi.py
-  {py3,otnend2end}: nosetests --with-xunit transportpce_tests/2.2.1/test_otn_end2end.py
-#run 7.1 functional tests
-  {py3,pce400g}: nosetests --with-xunit transportpce_tests/7.1/test_pce_400G.py
-#install honeynode 7.1 simulators
-  {py3,portmapping71,devicenotif}: - sh -c "./install_honeynode.sh 7.1"
-  {py3,portmapping71}: nosetests --with-xunit transportpce_tests/7.1/test_portmapping.py
-#End-to-End
-  {py3,end2end}: nosetests --with-xunit transportpce_tests/1.2.1/test_end2end.py
-  {py3,end2end221}: nosetests --with-xunit transportpce_tests/2.2.1/test_end2end.py
-  #{gnpy}: - sudo docker pull atriki/gnpyrest:v1.2
-  {gnpy}: - sudo docker run -d -p 8008:5000 --name gnpy_tpce_rest1 atriki/gnpyrest:v1.2
-  {gnpy}: nosetests --with-xunit transportpce_tests/1.2.1/test_gnpy.py
-  {gnpy}: - sudo docker container rm -f gnpy_tpce_rest1
-  {nbinotifications}: - sudo docker-compose -f ./nbinotifications/docker-compose.yml up -d
-  {nbinotifications}: nosetests --with-xunit transportpce_tests/2.2.1/test_nbinotifications.py
-  {nbinotifications}: - sudo docker-compose -f ./nbinotifications/docker-compose.yml down --rmi all
-# Hybrid tests
-  {py3,devicenotif}: nosetests --with-xunit transportpce_tests/hybrid/test_device_change_notifications.py
+  sh -c 'if [ "$USE_LIGHTY" = "True" ]; then (cd ../lighty && ./build.sh); fi'
+
+[testenv:sims121]
+whitelist_externals = sh
+depends = buildcontroller
+# sims profiles does not strictly depends on buildcontroller
+# but this dependency avoids race condition in the gate
+commands =
+  - sh -c "./install_honeynode.sh 1.2.1"
+
+[testenv:sims221]
+whitelist_externals = sh
+depends = buildcontroller
+commands =
+  - sh -c "./install_honeynode.sh 2.2.1"
+
+[testenv:sims71]
+whitelist_externals = sh
+depends = buildcontroller
+commands =
+  - sh -c "./install_honeynode.sh 7.1"
+
+[testenv:tests121]
+depends = buildcontroller,sims121
+commands =
+  nosetests --with-xunit transportpce_tests/1.2.1/test_portmapping.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_topo_portmapping.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_topology.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_renderer_service_path_nominal.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_pce.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_olm.py
+  nosetests --with-xunit transportpce_tests/1.2.1/test_end2end.py
+
+[testenv:tests221]
+depends = buildcontroller,sims221,tests121
+#the last dependency is to avoid temporarily concurrent ressources problem to fix in parallel mode
+commands =
+  nosetests --with-xunit transportpce_tests/2.2.1/test_portmapping.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_topology.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_otn_topology.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_flex_grid.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_renderer_service_path_nominal.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_otn_renderer.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_otn_sh_renderer.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_olm.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_tapi.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_otn_end2end.py
+  nosetests --with-xunit transportpce_tests/2.2.1/test_end2end.py
+
+[testenv:tests71]
+depends = buildcontroller,sims71,tests221
+#the last dependency is to avoid temporarily concurrent ressources problem to fix in parallel mode
+commands =
+  nosetests --with-xunit transportpce_tests/7.1/test_pce_400G.py
+  #NB: test pce_400G above does not depend on sims71
+  nosetests --with-xunit transportpce_tests/7.1/test_portmapping.py
+
+[testenv:tests_hybrid]
+depends = buildcontroller,sims121,sims221,sims71,tests71
+#the last dependency is to avoid temporarily concurrent ressources problem to fix in parallel mode
+commands =
+  nosetests --with-xunit transportpce_tests/hybrid/test_device_change_notifications.py
+
+[testenv:gnpy]
+depends = buildcontroller
+whitelist_externals = sh
+                      sudo
+commands =
+  #sudo docker pull atriki/gnpyrest:v1.2
+  sudo docker run -d -p 8008:5000 --name gnpy_tpce_rest1 atriki/gnpyrest:v1.2
+  nosetests --with-xunit transportpce_tests/1.2.1/test_gnpy.py
+  sudo docker container rm -f gnpy_tpce_rest1
+
+[testenv:nbinotifications]
+depends = buildcontroller,sims221
+whitelist_externals = sh
+                      sudo
+commands =
+  sudo docker-compose -f ./nbinotifications/docker-compose.yml up -d
+  nosetests --with-xunit transportpce_tests/2.2.1/test_nbinotifications.py
+  sudo docker-compose -f ./nbinotifications/docker-compose.yml down --rmi all
 
 [testenv:docs]
 passenv = http_proxy HTTP_PROXY https_proxy HTTPS_PROXY no_proxy NO_PROXY