Merge lp:~fginther/bamf/add-code-coverage into lp:bamf/0.4

[Francis Ginther]

Add code coverage reporting with coverage-html and coverage-gcovr targets.

Coverage reporting can be enabled with --enable-gcov.

Add code coverage reporting with coverage-html and coverage-gcovr targets.

Coverage reporting can be enabled with --enable-gcov.

Testing:
 - Built coverage targets and verified results.
 - Built in pbuilder chroot with hooks to enable gcovr report.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:503
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/16/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=amd64/16/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=i386/16/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/16//rebuild/?

review: Approve (continuous-integration)

[Allan LeSage (allanlesage)]

I think this might be necessary:

=== modified file 'lib/libbamf/Makefile.am'
--- lib/libbamf/Makefile.am 2012-12-06 21:29:22 +0000
+++ lib/libbamf/Makefile.am 2012-12-13 17:42:59 +0000
@@ -73,7 +73,7 @@
 libbamf3_la_LDFLAGS = \
   -shared \
   -export-symbols-regex "^bamf_" \
- $(COVERAGE_CFLAGS) \
+ $(COVERAGE_LDFLAGS) \
   $(NULL)

 glib_marshal_list = bamf-marshal.list

Otherwise looks good!

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:504
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/17/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=amd64/17/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=i386/17/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/17//rebuild/?

review: Needs Fixing (continuous-integration)

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:504
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/18/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=amd64/18/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/./build=pbuilder,distribution=quantal,flavor=i386/18/console

Click here to trigger a rebuild:
http://jenkins.qa.ubuntu.com/job/bamf-mbs-ci/18//rebuild/?

review: Approve (continuous-integration)

[Francis Ginther (fginther)]

Allan, thanks for catching the error. I've fixed it and also fixed some issues with non-srcdir builds:

# mkdir builddir;cd builddir; ../autogen.sh; make

Retested with local builds, pbuilder and jenkins (the -ci run above includes coverage data).

[Marco Trevisan (Treviño) (3v1n0)]

Looks fine, works ok.

review: Approve

[PS Jenkins bot (ps-jenkins)]

FAILED: Autolanding.
More details in the following jenkins job:
http://jenkins.qa.ubuntu.com/job/bamf-mbs-autolanding/37/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=amd64/37/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/bamf-mbs-autolanding/./build=pbuilder,distribution=quantal,flavor=i386/37/console

review: Needs Fixing (continuous-integration)

[Francis Ginther (fginther)]

Cleaned up stale dbus process on test systems and re-trying.

=== modified file 'Makefile.am'
--- Makefile.am	2012-08-01 13:56:43 +0000
+++ Makefile.am	2012-12-13 21:57:19 +0000
@@ -1,5 +1,7 @@
 ACLOCAL_AMFLAGS = -I m4
 
+include $(top_srcdir)/Makefile.am.coverage
+
 SUBDIRS = \
   lib/libbamf \
   src \

=== added file 'Makefile.am.coverage'
--- Makefile.am.coverage	1970-01-01 00:00:00 +0000
+++ Makefile.am.coverage	2012-12-13 21:57:19 +0000
@@ -0,0 +1,48 @@
+
+# Coverage targets
+
+.PHONY: clean-gcno clean-gcda \
+	coverage-html generate-coverage-html clean-coverage-html \
+	coverage-gcovr generate-coverage-gcovr clean-coverage-gcovr
+
+clean-local: clean-gcno clean-coverage-html clean-coverage-gcovr
+
+if HAVE_GCOV
+
+clean-gcno:
+	@echo Removing old coverage instrumentation
+	-find -name '*.gcno' -print | xargs -r rm
+
+clean-gcda:
+	@echo Removing old coverage results
+	-find -name '*.gcda' -print | xargs -r rm
+  
+coverage-html:
+	-$(MAKE) $(AM_MAKEFLAGS) -k check
+	$(MAKE) $(AM_MAKEFLAGS) generate-coverage-html
+  
+generate-coverage-html:
+	@echo Collecting coverage data
+	$(LCOV) --directory $(top_builddir) --capture --output-file coverage.info --no-checksum --compat-libtool
+	LANG=C $(GENHTML) --prefix $(top_builddir) --output-directory coveragereport --title "Code Coverage" --legend --show-details coverage.info
+  
+clean-coverage-html: clean-gcda
+	-$(LCOV) --directory $(top_builddir) -z
+	-rm -rf coverage.info coveragereport
+
+if HAVE_GCOVR
+
+coverage-gcovr:
+	-$(MAKE) $(AM_MAKEFLAGS) -k check
+	$(MAKE) $(AM_MAKEFLAGS) generate-coverage-gcovr
+	
+generate-coverage-gcovr:
+	@echo Generating coverage GCOVR report
+	$(GCOVR) --xml -r $(top_builddir) -o $(top_builddir)/coverage.xml
+	
+clean-coverage-gcovr: clean-gcda
+	-rm -rf $(top_builddir)/coverage.xml
+
+endif # HAVE_GCOVR
+
+endif # HAVE_GCOV

=== modified file 'configure.ac'
--- configure.ac	2012-11-15 17:45:29 +0000
+++ configure.ac	2012-12-13 21:57:19 +0000
@@ -129,6 +129,16 @@
   AC_PATH_PROG([DBUS_LAUNCH],[dbus-launch])
 fi
 
+###########################
+# gcov coverage reporting
+###########################
+AC_TDD_GCOV
+AM_CONDITIONAL([HAVE_GCOV], [test "x$ac_cv_check_gcov" = xyes])
+AM_CONDITIONAL([HAVE_LCOV], [test "x$ac_cv_check_lcov" = xyes])
+AM_CONDITIONAL([HAVE_GCOVR], [test "x$ac_cv_check_gcovr" = xyes])
+AC_SUBST(COVERAGE_CFLAGS)
+AC_SUBST(COVERAGE_LDFLAGS)
+
 #
 # Gnome/GTK checks
 #
@@ -169,5 +179,6 @@
     Introspection:      ${enable_introspection}
     Unity Webapps:      ${enable_webapps}
     Headless tests:     ${enable_headless_tests}
+    Coverage Reporting: ${use_gcov}
 
 EOF

=== modified file 'lib/libbamf/Makefile.am'
--- lib/libbamf/Makefile.am	2012-11-14 19:30:00 +0000
+++ lib/libbamf/Makefile.am	2012-12-13 21:57:19 +0000
@@ -67,11 +67,13 @@
   $(LIBWSBIND_CFLAGS) \
   $(GLIB_CFLAGS) \
   $(DBUS_CFLAGS) \
+  $(COVERAGE_CFLAGS) \
   $(NULL)
 
 libbamf3_la_LDFLAGS = \
   -shared \
   -export-symbols-regex "^bamf_" \
+  $(COVERAGE_LDFLAGS) \
   $(NULL)
 
 glib_marshal_list = bamf-marshal.list

=== added file 'm4/gcov.m4'
--- m4/gcov.m4	1970-01-01 00:00:00 +0000
+++ m4/gcov.m4	2012-12-13 21:57:19 +0000
@@ -0,0 +1,89 @@
+# Checks for existence of coverage tools:
+#  * gcov
+#  * lcov
+#  * genhtml
+#  * gcovr
+# 
+# Sets ac_cv_check_gcov to yes if tooling is present
+# and reports the executables to the variables LCOV, GCOVR and GENHTML.
+AC_DEFUN([AC_TDD_GCOV],
+[
+  AC_ARG_ENABLE(gcov,
+  AS_HELP_STRING([--enable-gcov],
+		 [enable coverage testing with gcov]),
+  [use_gcov=$enableval], [use_gcov=no])
+
+  AM_CONDITIONAL(HAVE_GCOV, test "x$use_gcov" = "xyes")
+
+  if test "x$use_gcov" = "xyes"; then
+  # we need gcc:
+  if test "$GCC" != "yes"; then
+    AC_MSG_ERROR([GCC is required for --enable-gcov])
+  fi
+
+  # Check if ccache is being used
+  AC_CHECK_PROG(SHTOOL, shtool, shtool)
+  if test "$SHTOOL"; then
+    AS_CASE([`$SHTOOL path $CC`],
+                [*ccache*], [gcc_ccache=yes],
+                [gcc_ccache=no])
+  fi
+
+  if test "$gcc_ccache" = "yes" && (test -z "$CCACHE_DISABLE" || test "$CCACHE_DISABLE" != "1"); then
+    AC_MSG_ERROR([ccache must be disabled when --enable-gcov option is used. You can disable ccache by setting environment variable CCACHE_DISABLE=1.])
+  fi
+
+  lcov_version_list="1.6 1.7 1.8 1.9"
+  AC_CHECK_PROG(LCOV, lcov, lcov)
+  AC_CHECK_PROG(GENHTML, genhtml, genhtml)
+
+  if test "$LCOV"; then
+    AC_CACHE_CHECK([for lcov version], glib_cv_lcov_version, [
+      glib_cv_lcov_version=invalid
+      lcov_version=`$LCOV -v 2>/dev/null | $SED -e 's/^.* //'`
+      for lcov_check_version in $lcov_version_list; do
+        if test "$lcov_version" = "$lcov_check_version"; then
+          glib_cv_lcov_version="$lcov_check_version (ok)"
+        fi
+      done
+    ])
+  else
+    lcov_msg="To enable code coverage reporting you must have one of the following lcov versions installed: $lcov_version_list"
+    AC_MSG_ERROR([$lcov_msg])
+  fi
+
+  case $glib_cv_lcov_version in
+    ""|invalid[)]
+      lcov_msg="You must have one of the following versions of lcov: $lcov_version_list (found: $lcov_version)."
+      AC_MSG_ERROR([$lcov_msg])
+      LCOV="exit 0;"
+      ;;
+  esac
+
+  if test -z "$GENHTML"; then
+    AC_MSG_ERROR([Could not find genhtml from the lcov package])
+  fi
+
+  ac_cv_check_gcov=yes
+  ac_cv_check_lcov=yes
+
+  # Remove all optimization flags from CFLAGS
+  changequote({,})
+  CFLAGS=`echo "$CFLAGS" | $SED -e 's/-O[0-9]*//g'`
+  changequote([,])
+
+  # Add the special gcc flags
+  COVERAGE_CFLAGS="-O0 --coverage"
+  COVERAGE_CXXFLAGS="-O0 --coverage"
+  COVERAGE_LDFLAGS="-lgcov"
+
+  # Check availability of gcovr
+  AC_CHECK_PROG(GCOVR, gcovr, gcovr)
+  if test -z "$GCOVR"; then
+    ac_cv_check_gcovr=no
+  else
+    ac_cv_check_gcovr=yes
+  fi
+fi
+]) # AC_TDD_GCOV
+

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2012-11-07 19:51:56 +0000
+++ src/Makefile.am	2012-12-13 21:57:19 +0000
@@ -138,10 +138,12 @@
 		$(WNCK_CFLAGS) \
 		$(GTOP_CFLAGS) \
 		$(LIBUNITY_WEBAPPS_CFLAGS) \
+		$(COVERAGE_CFLAGS) \
 		$(NULL)
 
 bamfdaemon_LDFLAGS = \
 		-Xlinker -export-dynamic -Wl,-O1 -Wl,-Bsymbolic-functions \
+		$(COVERAGE_LDFLAGS) \
 		$(NULL)
 
 bamf-gdbus-generated.c bamf-gdbus-generated.h: org.ayatana.bamf.xml