ali@38: # ===========================================================================
ali@38: #     http://www.gnu.org/software/autoconf-archive/ax_code_coverage.html
ali@38: # ===========================================================================
ali@38: #
ali@38: # SYNOPSIS
ali@38: #
ali@38: #   AX_CODE_COVERAGE()
ali@38: #
ali@38: # DESCRIPTION
ali@38: #
ali@38: #   Defines CODE_COVERAGE_CPPFLAGS, CODE_COVERAGE_CFLAGS,
ali@38: #   CODE_COVERAGE_CXXFLAGS and CODE_COVERAGE_LDFLAGS which should be
ali@38: #   included in the CPPFLAGS, CFLAGS CXXFLAGS and LIBS/LDFLAGS variables of
ali@38: #   every build target (program or library) which should be built with code
ali@38: #   coverage support. Also defines CODE_COVERAGE_RULES which should be
ali@38: #   substituted in your Makefile; and $enable_code_coverage which can be
ali@38: #   used in subsequent configure output. CODE_COVERAGE_ENABLED is defined
ali@38: #   and substituted, and corresponds to the value of the
ali@38: #   --enable-code-coverage option, which defaults to being disabled.
ali@38: #
ali@38: #   Test also for gcov program and create GCOV variable that could be
ali@38: #   substituted.
ali@38: #
ali@38: #   Note that all optimisation flags in CFLAGS must be disabled when code
ali@38: #   coverage is enabled.
ali@38: #
ali@38: #   Usage example:
ali@38: #
ali@38: #   configure.ac:
ali@38: #
ali@38: #     AX_CODE_COVERAGE
ali@38: #
ali@38: #   Makefile.am:
ali@38: #
ali@38: #     @CODE_COVERAGE_RULES@
ali@38: #     my_program_LIBS = ... $(CODE_COVERAGE_LDFLAGS) ...
ali@38: #     my_program_CPPFLAGS = ... $(CODE_COVERAGE_CPPFLAGS) ...
ali@38: #     my_program_CFLAGS = ... $(CODE_COVERAGE_CFLAGS) ...
ali@38: #     my_program_CXXFLAGS = ... $(CODE_COVERAGE_CXXFLAGS) ...
ali@38: #
ali@38: #   This results in a "check-code-coverage" rule being added to any
ali@38: #   Makefile.am which includes "@CODE_COVERAGE_RULES@" (assuming the module
ali@38: #   has been configured with --enable-code-coverage). Running `make
ali@38: #   check-code-coverage` in that directory will run the module's test suite
ali@38: #   (`make check`) and build a code coverage report detailing the code which
ali@38: #   was touched, then print the URI for the report.
ali@38: #
ali@38: #   This code was derived from Makefile.decl in GLib, originally licenced
ali@38: #   under LGPLv2.1+.
ali@38: #
ali@38: # LICENSE
ali@38: #
ali@38: #   Copyright (c) 2012, 2016 Philip Withnall
ali@38: #   Copyright (c) 2012 Xan Lopez
ali@38: #   Copyright (c) 2012 Christian Persch
ali@38: #   Copyright (c) 2012 Paolo Borelli
ali@38: #   Copyright (c) 2012 Dan Winship
ali@38: #   Copyright (c) 2015 Bastien ROUCARIES
ali@38: #
ali@38: #   This library is free software; you can redistribute it and/or modify it
ali@38: #   under the terms of the GNU Lesser General Public License as published by
ali@38: #   the Free Software Foundation; either version 2.1 of the License, or (at
ali@38: #   your option) any later version.
ali@38: #
ali@38: #   This library is distributed in the hope that it will be useful, but
ali@38: #   WITHOUT ANY WARRANTY; without even the implied warranty of
ali@38: #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
ali@38: #   General Public License for more details.
ali@38: #
ali@38: #   You should have received a copy of the GNU Lesser General Public License
ali@38: #   along with this program. If not, see <http://www.gnu.org/licenses/>.
ali@38: 
ali@38: #serial 16
ali@38: 
ali@38: AC_DEFUN([AX_CODE_COVERAGE],[
ali@38: 	dnl Check for --enable-code-coverage
ali@38: 	AC_REQUIRE([AC_PROG_SED])
ali@38: 
ali@38: 	# allow to override gcov location
ali@38: 	AC_ARG_WITH([gcov],
ali@38: 	  [AS_HELP_STRING([--with-gcov[=GCOV]], [use given GCOV for coverage (GCOV=gcov).])],
ali@38: 	  [_AX_CODE_COVERAGE_GCOV_PROG_WITH=$with_gcov],
ali@38: 	  [_AX_CODE_COVERAGE_GCOV_PROG_WITH=gcov])
ali@38: 
ali@38: 	AC_MSG_CHECKING([whether to build with code coverage support])
ali@38: 	AC_ARG_ENABLE([code-coverage],
ali@38: 	  AS_HELP_STRING([--enable-code-coverage],
ali@38: 	  [Whether to enable code coverage support]),,
ali@38: 	  enable_code_coverage=no)
ali@38: 
ali@38: 	AM_CONDITIONAL([CODE_COVERAGE_ENABLED], [test x$enable_code_coverage = xyes])
ali@38: 	AC_SUBST([CODE_COVERAGE_ENABLED], [$enable_code_coverage])
ali@38: 	AC_MSG_RESULT($enable_code_coverage)
ali@38: 
ali@38: 	AS_IF([ test "$enable_code_coverage" = "yes" ], [
ali@38: 		# check for gcov
ali@38: 		AC_CHECK_TOOL([GCOV],
ali@38: 		  [$_AX_CODE_COVERAGE_GCOV_PROG_WITH],
ali@38: 		  [:])
ali@38: 		AS_IF([test "X$GCOV" = "X:"],
ali@38: 		  [AC_MSG_ERROR([gcov is needed to do coverage])])
ali@38: 		AC_SUBST([GCOV])
ali@38: 
ali@38: 		dnl Check if gcc is being used
ali@38: 		AS_IF([ test "$GCC" = "no" ], [
ali@38: 			AC_MSG_ERROR([not compiling with gcc, which is required for gcov code coverage])
ali@38: 		])
ali@38: 
ali@38: 		# List of supported lcov versions.
ali@38: 		lcov_version_list="1.6 1.7 1.8 1.9 1.10 1.11 1.12"
ali@38: 
ali@38: 		AC_CHECK_PROG([LCOV], [lcov], [lcov])
ali@38: 		AC_CHECK_PROG([GENHTML], [genhtml], [genhtml])
ali@38: 
ali@38: 		AS_IF([ test "$LCOV" ], [
ali@38: 			AC_CACHE_CHECK([for lcov version], ax_cv_lcov_version, [
ali@38: 				ax_cv_lcov_version=invalid
ali@38: 				lcov_version=`$LCOV -v 2>/dev/null | $SED -e 's/^.* //'`
ali@38: 				for lcov_check_version in $lcov_version_list; do
ali@38: 					if test "$lcov_version" = "$lcov_check_version"; then
ali@38: 						ax_cv_lcov_version="$lcov_check_version (ok)"
ali@38: 					fi
ali@38: 				done
ali@38: 			])
ali@38: 		], [
ali@38: 			lcov_msg="To enable code coverage reporting you must have one of the following lcov versions installed: $lcov_version_list"
ali@38: 			AC_MSG_ERROR([$lcov_msg])
ali@38: 		])
ali@38: 
ali@38: 		case $ax_cv_lcov_version in
ali@38: 			""|invalid[)]
ali@38: 				lcov_msg="You must have one of the following versions of lcov: $lcov_version_list (found: $lcov_version)."
ali@38: 				AC_MSG_ERROR([$lcov_msg])
ali@38: 				LCOV="exit 0;"
ali@38: 			;;
ali@38: 		esac
ali@38: 
ali@38: 		AS_IF([ test -z "$GENHTML" ], [
ali@38: 			AC_MSG_ERROR([Could not find genhtml from the lcov package])
ali@38: 		])
ali@38: 
ali@38: 		dnl Build the code coverage flags
ali@38: 		CODE_COVERAGE_CPPFLAGS="-DNDEBUG"
ali@38: 		CODE_COVERAGE_CFLAGS="-O0 -g -fprofile-arcs -ftest-coverage"
ali@38: 		CODE_COVERAGE_CXXFLAGS="-O0 -g -fprofile-arcs -ftest-coverage"
ali@38: 		CODE_COVERAGE_LDFLAGS="-lgcov"
ali@38: 
ali@38: 		AC_SUBST([CODE_COVERAGE_CPPFLAGS])
ali@38: 		AC_SUBST([CODE_COVERAGE_CFLAGS])
ali@38: 		AC_SUBST([CODE_COVERAGE_CXXFLAGS])
ali@38: 		AC_SUBST([CODE_COVERAGE_LDFLAGS])
ali@38: 	])
ali@38: 
ali@38: [CODE_COVERAGE_RULES='
ali@38: # Code coverage
ali@38: #
ali@38: # Optional:
ali@38: #  - CODE_COVERAGE_DIRECTORY: Top-level directory for code coverage reporting.
ali@38: #    Multiple directories may be specified, separated by whitespace.
ali@38: #    (Default: $(top_builddir))
ali@38: #  - CODE_COVERAGE_OUTPUT_FILE: Filename and path for the .info file generated
ali@38: #    by lcov for code coverage. (Default:
ali@38: #    $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage.info)
ali@38: #  - CODE_COVERAGE_OUTPUT_DIRECTORY: Directory for generated code coverage
ali@38: #    reports to be created. (Default:
ali@38: #    $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage)
ali@38: #  - CODE_COVERAGE_BRANCH_COVERAGE: Set to 1 to enforce branch coverage,
ali@38: #    set to 0 to disable it and leave empty to stay with the default.
ali@38: #    (Default: empty)
ali@38: #  - CODE_COVERAGE_LCOV_SHOPTS_DEFAULT: Extra options shared between both lcov
ali@38: #    instances. (Default: based on $CODE_COVERAGE_BRANCH_COVERAGE)
ali@38: #  - CODE_COVERAGE_LCOV_SHOPTS: Extra options to shared between both lcov
ali@38: #    instances. (Default: $CODE_COVERAGE_LCOV_SHOPTS_DEFAULT)
ali@38: #  - CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH: --gcov-tool pathtogcov
ali@38: #  - CODE_COVERAGE_LCOV_OPTIONS_DEFAULT: Extra options to pass to the
ali@38: #    collecting lcov instance. (Default: $CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH)
ali@38: #  - CODE_COVERAGE_LCOV_OPTIONS: Extra options to pass to the collecting lcov
ali@38: #    instance. (Default: $CODE_COVERAGE_LCOV_OPTIONS_DEFAULT)
ali@38: #  - CODE_COVERAGE_LCOV_RMOPTS_DEFAULT: Extra options to pass to the filtering
ali@38: #    lcov instance. (Default: empty)
ali@38: #  - CODE_COVERAGE_LCOV_RMOPTS: Extra options to pass to the filtering lcov
ali@38: #    instance. (Default: $CODE_COVERAGE_LCOV_RMOPTS_DEFAULT)
ali@38: #  - CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT: Extra options to pass to the
ali@38: #    genhtml instance. (Default: based on $CODE_COVERAGE_BRANCH_COVERAGE)
ali@38: #  - CODE_COVERAGE_GENHTML_OPTIONS: Extra options to pass to the genhtml
ali@38: #    instance. (Default: $CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT)
ali@38: #  - CODE_COVERAGE_IGNORE_PATTERN: Extra glob pattern of files to ignore
ali@38: #
ali@38: # The generated report will be titled using the $(PACKAGE_NAME) and
ali@38: # $(PACKAGE_VERSION). In order to add the current git hash to the title,
ali@38: # use the git-version-gen script, available online.
ali@38: 
ali@38: # Optional variables
ali@38: CODE_COVERAGE_DIRECTORY ?= $(top_builddir)
ali@38: CODE_COVERAGE_OUTPUT_FILE ?= $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage.info
ali@38: CODE_COVERAGE_OUTPUT_DIRECTORY ?= $(PACKAGE_NAME)-$(PACKAGE_VERSION)-coverage
ali@38: CODE_COVERAGE_BRANCH_COVERAGE ?=
ali@38: CODE_COVERAGE_LCOV_SHOPTS_DEFAULT ?= $(if $(CODE_COVERAGE_BRANCH_COVERAGE),\
ali@38: --rc lcov_branch_coverage=$(CODE_COVERAGE_BRANCH_COVERAGE))
ali@38: CODE_COVERAGE_LCOV_SHOPTS ?= $(CODE_COVERAGE_LCOV_SHOPTS_DEFAULT)
ali@38: CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH ?= --gcov-tool "$(GCOV)"
ali@38: CODE_COVERAGE_LCOV_OPTIONS_DEFAULT ?= $(CODE_COVERAGE_LCOV_OPTIONS_GCOVPATH)
ali@38: CODE_COVERAGE_LCOV_OPTIONS ?= $(CODE_COVERAGE_LCOV_OPTIONS_DEFAULT)
ali@38: CODE_COVERAGE_LCOV_RMOPTS_DEFAULT ?=
ali@38: CODE_COVERAGE_LCOV_RMOPTS ?= $(CODE_COVERAGE_LCOV_RMOPTS_DEFAULT)
ali@38: CODE_COVERAGE_GENHTML_OPTIONS_DEFAULT ?=\
ali@38: $(if $(CODE_COVERAGE_BRANCH_COVERAGE),\
ali@38: --rc genhtml_branch_coverage=$(CODE_COVERAGE_BRANCH_COVERAGE))
ali@38: CODE_COVERAGE_GENHTML_OPTIONS ?= $(CODE_COVERAGE_GENHTML_OPTIONS_DEFAULTS)
ali@38: CODE_COVERAGE_IGNORE_PATTERN ?=
ali@38: 
ali@38: code_coverage_v_lcov_cap = $(code_coverage_v_lcov_cap_$(V))
ali@38: code_coverage_v_lcov_cap_ = $(code_coverage_v_lcov_cap_$(AM_DEFAULT_VERBOSITY))
ali@38: code_coverage_v_lcov_cap_0 = @echo "  LCOV   --capture"\
ali@38:  $(CODE_COVERAGE_OUTPUT_FILE);
ali@38: code_coverage_v_lcov_ign = $(code_coverage_v_lcov_ign_$(V))
ali@38: code_coverage_v_lcov_ign_ = $(code_coverage_v_lcov_ign_$(AM_DEFAULT_VERBOSITY))
ali@38: code_coverage_v_lcov_ign_0 = @echo "  LCOV   --remove /tmp/*"\
ali@38:  $(CODE_COVERAGE_IGNORE_PATTERN);
ali@38: code_coverage_v_genhtml = $(code_coverage_v_genhtml_$(V))
ali@38: code_coverage_v_genhtml_ = $(code_coverage_v_genhtml_$(AM_DEFAULT_VERBOSITY))
ali@38: code_coverage_v_genhtml_0 = @echo "  GEN   " $(CODE_COVERAGE_OUTPUT_DIRECTORY);
ali@38: code_coverage_quiet = $(code_coverage_quiet_$(V))
ali@38: code_coverage_quiet_ = $(code_coverage_quiet_$(AM_DEFAULT_VERBOSITY))
ali@38: code_coverage_quiet_0 = --quiet
ali@38: 
ali@38: # sanitizes the test-name: replaces with underscores: dashes and dots
ali@38: code_coverage_sanitize = $(subst -,_,$(subst .,_,$(1)))
ali@38: 
ali@38: # Use recursive makes in order to ignore errors during check
ali@38: check-code-coverage:
ali@38: ifeq ($(CODE_COVERAGE_ENABLED),yes)
ali@38: 	-$(A''M_V_at)$(MAKE) $(AM_MAKEFLAGS) -k check
ali@38: 	$(A''M_V_at)$(MAKE) $(AM_MAKEFLAGS) code-coverage-capture
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-code-coverage"
ali@38: endif
ali@38: 
ali@38: # Capture code coverage data
ali@38: code-coverage-capture: code-coverage-capture-hook
ali@38: ifeq ($(CODE_COVERAGE_ENABLED),yes)
ali@38: 	$(code_coverage_v_lcov_cap)$(LCOV) $(code_coverage_quiet) $(addprefix --directory ,$(CODE_COVERAGE_DIRECTORY)) --capture --output-file "$(CODE_COVERAGE_OUTPUT_FILE).tmp" --test-name "$(call code_coverage_sanitize,$(PACKAGE_NAME)-$(PACKAGE_VERSION))" --no-checksum --compat-libtool $(CODE_COVERAGE_LCOV_SHOPTS) $(CODE_COVERAGE_LCOV_OPTIONS)
ali@38: 	$(code_coverage_v_lcov_ign)$(LCOV) $(code_coverage_quiet) $(addprefix --directory ,$(CODE_COVERAGE_DIRECTORY)) --remove "$(CODE_COVERAGE_OUTPUT_FILE).tmp" "/tmp/*" $(CODE_COVERAGE_IGNORE_PATTERN) --output-file "$(CODE_COVERAGE_OUTPUT_FILE)" $(CODE_COVERAGE_LCOV_SHOPTS) $(CODE_COVERAGE_LCOV_RMOPTS)
ali@38: 	-@rm -f $(CODE_COVERAGE_OUTPUT_FILE).tmp
ali@38: 	$(code_coverage_v_genhtml)LANG=C $(GENHTML) $(code_coverage_quiet) $(addprefix --prefix ,$(CODE_COVERAGE_DIRECTORY)) --output-directory "$(CODE_COVERAGE_OUTPUT_DIRECTORY)" --title "$(PACKAGE_NAME)-$(PACKAGE_VERSION) Code Coverage" --legend --show-details "$(CODE_COVERAGE_OUTPUT_FILE)" $(CODE_COVERAGE_GENHTML_OPTIONS)
ali@38: 	@echo "file://$(abs_builddir)/$(CODE_COVERAGE_OUTPUT_DIRECTORY)/index.html"
ali@38: else
ali@38: 	@echo "Need to reconfigure with --enable-code-coverage"
ali@38: endif
ali@38: 
ali@38: # Hook rule executed before code-coverage-capture, overridable by the user
ali@38: code-coverage-capture-hook:
ali@38: 
ali@38: ifeq ($(CODE_COVERAGE_ENABLED),yes)
ali@38: clean: code-coverage-clean
ali@38: distclean: code-coverage-clean
ali@38: code-coverage-clean:
ali@38: 	-$(LCOV) --directory $(top_builddir) -z
ali@38: 	-rm -rf $(CODE_COVERAGE_OUTPUT_FILE) $(CODE_COVERAGE_OUTPUT_FILE).tmp $(CODE_COVERAGE_OUTPUT_DIRECTORY)
ali@38: 	-find . \( -name "*.gcda" -o -name "*.gcno" -o -name "*.gcov" \) -delete
ali@38: endif
ali@38: 
ali@38: GITIGNOREFILES ?=
ali@38: GITIGNOREFILES += $(CODE_COVERAGE_OUTPUT_FILE) $(CODE_COVERAGE_OUTPUT_DIRECTORY)
ali@38: 
ali@38: A''M_DISTCHECK_CONFIGURE_FLAGS ?=
ali@38: A''M_DISTCHECK_CONFIGURE_FLAGS += --disable-code-coverage
ali@38: 
ali@38: .PHONY: check-code-coverage code-coverage-capture code-coverage-capture-hook code-coverage-clean
ali@38: ']
ali@38: 
ali@38: 	AC_SUBST([CODE_COVERAGE_RULES])
ali@38: 	m4_ifdef([_AM_SUBST_NOTMAKE], [_AM_SUBST_NOTMAKE([CODE_COVERAGE_RULES])])
ali@38: ])