Add GCOV / LCOV C coverage support

Signed-off-by: Christian Heimes <cheimes@redhat.com>
python-ldap · encukou · Nov 25, 2017 · Nov 24, 2017 · Nov 25, 2017 · Nov 25, 2017
commit 94777ca10b74f8576f847838501df9c8b45501b7
diff --git a/.travis.yml b/.travis.yml
@@ -1,13 +1,5 @@
 language: python
 
-python:
-- '2.7'
-- '3.3'
-- '3.4'
-- '3.5'
-- '3.6'
-# Note: when updating Python versions, also change setup.py and tox.ini
-
 sudo: false
 
 cache: pip
@@ -18,12 +10,37 @@ addons:
       - ldap-utils
       - slapd
 
+matrix:
+  include:
+    - python: 2.7
+      env:
+        - TOXENV=py27
+        - WITH_GCOV=1
+    - python: 3.3
+      env:
+        - TOXENV=py33
+        - WITH_GCOV=1
+    - python: 3.4
+      env:
+        - TOXENV=py34
+        - WITH_GCOV=1
+    - python: 3.5
+      env:
+        - TOXENV=py35
+        - WITH_GCOV=1
+    - python: 3.6
+      env:
+        - TOXENV=py36
+        - WITH_GCOV=1
+
 install:
   - pip install "pip>=7.1.0"
   - pip install tox-travis tox codecov coverage
 
 script: tox
 
 after_success:
+  # gather Python coverage
   - python -m coverage combine
+  # send Python and GCOV coverage
   - codecov
diff --git a/Makefile b/Makefile
@@ -1,3 +1,8 @@
+LCOV_INFO=build/lcov.info
+LCOV_REPORT=build/lcov_report
+LCOV_REPORT_OPTIONS=--show-details -no-branch-coverage \
+	--title "python-ldap LCOV report"
+
 .NOTPARALLEL:
 
 .PHONY: all
@@ -9,3 +14,28 @@ clean:
 	rm -f .coverage .coverage.*
 	find . -name '*.py[co]' -or -name '*.so*' -or -name '*.dylib' -delete
 	find . -depth -name __pycache__ -exec rm -rf {} \;
+
+# LCOV report (measuring test coverage for C code)
+.PHONY: lcov-clean lcov-coverage lcov-report lcov-open lcov
+lcov-clean:
+	rm -rf $(LCOV_INFO) $(LCOV_REPORT)
+	find build -name '*.gc??' -delete
+
+lcov-coverage:
+	WITH_GCOV=1 tox -e py27,py36
+
+$(LCOV_INFO):
+	lcov --capture --directory build --output-file $(LCOV_INFO)
+
+$(LCOV_REPORT): $(LCOV_INFO)
+	genhtml --output-directory $(LCOV_REPORT) \
+		$(LCOV_REPORT_OPTIONS) $(LCOV_INFO)
+
+lcov-report: $(LCOV_REPORT)
+
+lcov-open: $(LCOV_REPORT)
+	xdg-open $(LCOV_REPORT)/index.html
+
+lcov: lcov-clean
+	$(MAKE) lcov-coverage
+	$(MAKE) lcov-report
diff --git a/setup.py b/setup.py
@@ -34,7 +34,7 @@ class OpenLDAP2:
   extra_link_args = []
   extra_objects = []
   libs = ['ldap', 'lber']
-  defines = [ ]
+  defines = []
   extra_files = []
 
 LDAP_CLASS = OpenLDAP2
@@ -55,6 +55,13 @@ class OpenLDAP2:
   origfileslist = origfiles.split(',')
   LDAP_CLASS.extra_files[i]=(destdir, origfileslist)
 
+if os.environ.get('WITH_GCOV'):
+  LDAP_CLASS.extra_compile_args.extend(
+    ['-O0', '-pg', '-fprofile-arcs', '-ftest-coverage']
+  )
+  LDAP_CLASS.extra_link_args.append('-pg')
+  LDAP_CLASS.libs.append('gcov')
+
 #-- Let distutils/setuptools do the rest
 name = 'python-ldap'
 

diff --git a/tox.ini b/tox.ini
@@ -13,6 +13,7 @@ deps =
     pyasn1
     pyasn1_modules
 commands = {envpython} -m coverage run --parallel setup.py test
+passenv = WITH_GCOV
 
 [testenv:coverage-report]
 deps = coverage