Merge lp:~allanlesage/libindicate/TDD into lp:libindicate/0.7

[Ted Gould]

Adding a code coverage target

[lp:~allanlesage/libindicate/TDD]

445. By Ted Gould on 2012-02-10

Adding in a code coverage targe

=== modified file 'Makefile.am'
--- Makefile.am	2011-11-21 06:53:14 +0000
+++ Makefile.am	2012-02-10 03:13:19 +0000
@@ -57,3 +57,39 @@
         else \
 			echo Failed to generate AUTHORS: not a branch >&2; \
 	fi
+
+
+# Coverage targets
+
+.PHONY: clean-gcda
+clean-gcda:
+	@echo Removing old coverage results
+	-find -name '*.gcda' -print | xargs -r rm
+
+.PHONY: coverage-html generate-coverage-html clean-coverage-html
+coverage-html: clean-gcda
+	-$(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
+
+.PHONY: coverage-xml generate-coverage-xml clean-coverage-xml
+coverage-xml: clean-gcda
+	-$(MAKE) $(AM_MAKEFLAGS) -k check
+	$(MAKE) $(AM_MAKEFLAGS) generate-coverage-xml
+
+generate-coverage-xml:
+	@echo Generating coverage XML report
+	$(GCOVR) -x -r $(top_builddir) -o $(top_builddir)/coverage.xml
+
+clean-coverage-xml: clean-gcda
+	-rm -rf $(top_builddir)/coverage.xml
+
+clean-local: clean-coverage-html clean-coverage-xml

=== modified file 'autogen.sh'
--- autogen.sh	2009-08-18 16:28:35 +0000
+++ autogen.sh	2012-02-10 03:13:19 +0000
@@ -9,4 +9,4 @@
 
 USE_GNOME2_MACROS=1 \
 USE_COMMON_DOC_BUILD=yes \
-gnome-autogen.sh --enable-gtk-doc
+. gnome-autogen.sh --enable-gtk-doc

=== modified file 'configure.ac'
--- configure.ac	2011-11-21 06:53:14 +0000
+++ configure.ac	2012-02-10 03:13:19 +0000
@@ -112,6 +112,16 @@
 AM_CONDITIONAL(USE_GTK3, [test "x$with_gtk" = x3])
 
 ###########################
+# gcov Coverage Reporting
+###########################
+
+m4_include([m4/gcov.m4])
+AC_TDD_GCOV
+AC_SUBST(COVERAGE_CFLAGS)
+AC_SUBST(COVERAGE_CXXFLAGS)
+AC_SUBST(COVERAGE_LDFLAGS)
+
+###########################
 # GObject Introspection
 ###########################
 
@@ -357,8 +367,16 @@
 	[AC_MSG_NOTICE([	Gtk:                    no])],
 	[AC_MSG_NOTICE([	Gtk:                    yes])]
 )
+<<<<<<< TREE
 
 AS_IF([test "x$enable_tests" != "xno"],
 	[AC_MSG_NOTICE([	Tests:                  yes])],
 	[AC_MSG_NOTICE([	Tests:                  no])]
 )
+=======
+
+AS_IF([test "x$use_gcov" = "xyes"],
+	[AC_MSG_NOTICE([	gcov:                   yes])],
+	[AC_MSG_NOTICE([	gcov:                   no])]
+)
+>>>>>>> MERGE-SOURCE

=== modified file 'libindicate-gtk/Makefile.am'
--- libindicate-gtk/Makefile.am	2012-01-05 20:03:32 +0000
+++ libindicate-gtk/Makefile.am	2012-02-10 03:13:19 +0000
@@ -35,11 +35,13 @@
 	listener.c
 
 libindicate_gtk_la_LDFLAGS = \
+	$(COVERAGE_LDFLAGS) \
 	-version-info $(LIBINDICATEGTK_CURRENT):$(LIBINDICATEGTK_REVISION):$(LIBINDICATEGTK_AGE) \
 	-no-undefined \
 	-export-symbols-regex "^[^_d].*"
 
 libindicate_gtk_la_CFLAGS = \
+	$(COVERAGE_FLAGS) \
 	-I $(top_srcdir) \
 	-Wall -Werror \
 	$(LIBINDICATEGTK_CFLAGS)
@@ -96,7 +98,13 @@
 	GLib-2.0 \
 	GdkPixbuf-2.0 \
 	Indicate-0.6
-IndicateGtk_0_6_gir_CFLAGS = $(LIBINDICATEGTK_CFLAGS) -I$(top_builddir) -I$(top_srcdir) -I$(top_builddir)/libindicate
+IndicateGtk_0_6_gir_CFLAGS = \
+	$(LIBINDICATEGTK_CFLAGS) \
+	$(COVERAGE_CFLAGS) \
+	-I$(top_builddir) \
+	-I$(top_srcdir) \
+	-I$(top_builddir)/libindicate
+IndicateGtk_0_6_gir_LDFLAGS = $(COVERAGE_LDFLAGS)
 IndicateGtk_0_6_gir_LIBS = libindicate-gtk$(VER).la
 IndicateGtk_0_6_gir_SCANNERFLAGS = $(INTROSPECTION_SCANNER_ARGS)
 IndicateGtk_0_6_gir_FILES = $(introspection_sources)
@@ -105,6 +113,7 @@
 # Gotta be a better way
 IndicateGtk3_0_6_gir_INCLUDES = $(IndicateGtk_0_6_gir_INCLUDES)
 IndicateGtk3_0_6_gir_CFLAGS = $(IndicateGtk_0_6_gir_CFLAGS)
+IndicateGtk3_0_6_gir_LDFLAGS = $(IndicateGtk_0_6_gir_LDFLAGS)
 IndicateGtk3_0_6_gir_LIBS = $(IndicateGtk_0_6_gir_LIBS)
 IndicateGtk3_0_6_gir_SCANNERFLAGS = $(IndicateGtk_0_6_gir_SCANNERFLAGS)
 IndicateGtk3_0_6_gir_FILES = $(IndicateGtk_0_6_gir_FILES)

=== modified file 'libindicate/Makefile.am'
--- libindicate/Makefile.am	2011-08-10 20:26:17 +0000
+++ libindicate/Makefile.am	2012-02-10 03:13:19 +0000
@@ -66,12 +66,14 @@
 	indicate-marshal.c
 
 libindicate_la_LDFLAGS = \
+	$(COVERAGE_LDFLAGS) \
 	-version-info $(LIBINDICATE_CURRENT):$(LIBINDICATE_REVISION):$(LIBINDICATE_AGE) \
 	-no-undefined \
 	-export-symbols-regex "^[^_d].*"
 
 libindicate_la_CFLAGS = \
 	$(LIBINDICATE_CFLAGS) \
+	$(COVERAGE_LDFLAGS) \
 	-Wall -Werror
 
 libindicate_la_LIBADD = \
@@ -135,8 +137,9 @@
         GObject-2.0 \
         GLib-2.0 \
         Dbusmenu-0.4
-Indicate_0_6_gir_CFLAGS = $(LIBINDICATE_CFLAGS) -I$(top_srcdir)
+Indicate_0_6_gir_CFLAGS = $(LIBINDICATE_CFLAGS) $(COVERAGE_CFLAGS) -I$(top_srcdir)
 Indicate_0_6_gir_LIBS = libindicate.la
+Indicate_0_6_gir_LDFLAGS = $(COVERAGE_LDFLAGS)
 Indicate_0_6_gir_FILES = $(introspection_sources)
 Indicate_0_6_gir_NAMESPACE = Indicate
 Indicate_0_6_gir_VERSION = 0.6

=== added file 'm4/gcov.m4'
--- m4/gcov.m4	1970-01-01 00:00:00 +0000
+++ m4/gcov.m4	2012-02-10 03:13:19 +0000
@@ -0,0 +1,83 @@
+# 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_CACHE_CHECK([whether code coverage tools are available], ac_cv_check_gcov,
+[
+AC_ARG_ENABLE(gcov,
+  AS_HELP_STRING([--enable-gcov],
+		 [enable coverage testing with gcov]),
+  [use_gcov=$enableval], [use_gcov=no])
+
+  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)
+  case `$SHTOOL path $CC` in
+    *ccache*[)] gcc_ccache=yes;;
+    *[)] gcc_ccache=no;;
+  esac
+
+  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)
+  AC_CHECK_PROG(GCOVR, gcovr, gcovr)
+
+  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
+
+  if test -z "$GCOVR"; then
+    AC_MSG_ERROR([Could not find gcovr; easy_install (or pip) gcovr])
+  fi
+
+
+  # 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 -fprofile-arcs -ftest-coverage"
+  COVERAGE_CXXFLAGS="-O0 -fprofile-arcs -ftest-coverage"	
+  COVERAGE_LDFLAGS="-lgcov"
+
+fi
+])]) # AC_TDD_GCOV
+