Add and run some linters via tox and pre-commit

[transportpce.git] / tox.ini

diff --git a/tox.ini b/tox.ini
index c8e91e4974643ab628083d9bf1e0cf1c3c1eca33..59e210daf700409038b7f3aa8f8270ffced5c5d5 100644 (file)
--- a/tox.ini
+++ b/tox.ini
@@ -4,6 +4,8 @@ envlist = py3
     docs
     docs-linkcheck
     checkbashisms
+    pre-commit
+    gitlint
 skipsdist = true
 setupdir = tests/
 
@@ -61,6 +63,10 @@ commands =
   {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
@@ -70,8 +76,7 @@ commands =
   {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
-#install honeynode 7.1 simulators
-  {py3,devicenotif}: - sh -c "./install_honeynode.sh 7.1"
+# Hybrid tests
   {py3,devicenotif}: nosetests --with-xunit transportpce_tests/hybrid/test_device_change_notifications.py
 
 [testenv:docs]
@@ -134,3 +139,37 @@ whitelist_externals = sh
 commands =
     pyang --version
     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'
+
+[testenv:pre-commit-install]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit install
+    pre-commit install --hook-type commit-msg
+
+[testenv:pre-commit-uninstall]
+basepython = python3
+deps = pre-commit
+commands =
+    pre-commit uninstall
+    pre-commit uninstall --hook-type commit-msg
+
+[testenv:pre-commit]
+basepython = python3
+deps = pre-commit
+passenv = HOME
+commands =
+    pre-commit run --all-files --show-diff-on-failure
+    pre-commit run gitlint --hook-stage commit-msg --commit-msg-filename .git/COMMIT_EDITMSG
+    # Gitlint only proposes a pre-commit configuration for the commit-msg stage but none for the commit stage.
+    # Its default arguments --passed and --msg-filename are different from CI recommandations.
+    # As a result, the line above is always skipped in jenkins CI since there cannot be a .git/COMMIT_EDITMSG file.
+    # A dedicated gitlint profile for CI is proposed below. Also to behave fine locally, this profile must have access
+    # to the HOME variable so that Gitlint can retrieve Git user settings.
+
+[testenv:gitlint]
+basepython = python3
+deps = gitlint
+commands =
+    gitlint
+