Add tests to installed release. They are potentially useful examples,

despite being written to test functionality rather than to serve as
tutorial eamples.
Enable coverage data collection for the LCOV implementation -
for both developer and module user.

To run them from the release:
  $ cp -r $LCOV_HOME/share/lcov/tests path/to/my/tests
  $ cd path/to/my/tests
  $ make [COVERAGE=1]
If eabled, point your browser to path/to/my/tests/cover_db/coverage.html
to view coverage result.

Signed-off-by: Henry Cox <[email protected]>

Author: henry2cox

Makefile

@@ -147,8 +147,13 @@ install:
 		done ;  \
 	done
 	mkdir -p $(SHARE_DIR)
-	find example -type d -exec mkdir -p "$(SHARE_DIR)/{}" \;
-	find example -type f -exec $(INSTALL) -Dm 644 "{}" "$(SHARE_DIR)/{}" \;
+	for d in example tests ; do \
+		( cd $$d ; make clean ) ; \
+		find $$d -type d -exec mkdir -p "$(SHARE_DIR)/{}" \; ; \
+		find $$d -type f -exec $(INSTALL) -Dm 644 "{}" "$(SHARE_DIR)/{}" \; ; \
+	done
+	@chmod -R ugo+x $(SHARE_DIR)/tests/bin
+	@find $(SHARE_DIR)/tests \( -name '*.sh' -o -name '*.pl' \) -exec chmod ugo+x {} \;
 	$(INSTALL) -d -m 755 $(CFG_DIR)
 	$(call echocmd,"  INSTALL $(CFG_DIR)/lcovrc")
 	$(INSTALL) -m 644 lcovrc $(CFG_DIR)/lcovrc
@@ -158,29 +163,32 @@ uninstall:
 		$(call echocmd,"  UNINST  $(BIN_DIR)/$$b") \
 		$(RM) -f $(BIN_DIR)/$$b ; \
 	done
-	for s in $(SCRIPTS) ; do \
-		$(call echocmd,"  UNINST  $(SCRIPT_DIR)/$$s")  \
-		$(RM) -f $(SCRIPT_DIR)/$$s ; \
-	done
-	rmdir --ignore-fail-on-non-empty $(SCRIPT_DIR)
+	rmdir --ignore-fail-on-non-empty $(BIN_DIR) || true
 	for l in $(LIBS) ; do \
 		$(call echocmd,"  UNINST  $(LIB_DIR)/$$l") \
 		$(RM) -f $(LIB_DIR)/$$l ; \
 	done
+	rmdir --ignore-fail-on-non-empty $(LIB_DIR) || true
+	rmdir --ignore-fail-on-non-empty $(DESTDIR)/lib || true
 	for section in 1 5 ; do \
 		DEST=$(MAN_DIR)/man$$section ; \
 		for m in man/*.$$section ; do  \
 			F=`basename $$m` ; \
-			$(call echocmd,"  UNINST  $$DEST/$$F") \
-			$(RM) -f $$DEST/$$F ; \
+                        if [ -e man/$$F ] ; then \
+			   $(call echocmd,"  UNINST  $$DEST/$$F") \
+                           $(RM) -f $$DEST/$$F ; \
+                        fi ; \
 		done ; \
-		rmdir --ignore-fail-on-non-empty $$DEST ; \
+		rmdir --ignore-fail-on-non-empty $$DEST || true ; \
 	done ; \
-	rmdir --ignore-fail-on-non-empty $(MAN_DIR)
-	$(RM) -rf $(SHARE_DIR)/example
-
+	rmdir --ignore-fail-on-non-empty $(MAN_DIR) || true
+	rm -rf $(SHARE_DIR)
+	rmdir --ignore-fail-on-non-empty $(DESTDIR)/share 
 	$(call echocmd,"  UNINST  $(CFG_DIR)/lcovrc")
 	$(RM) -f $(CFG_DIR)/lcovrc
+	rmdir --ignore-fail-on-non-empty $(CFG_DIR) || true
+	rmdir --ignore-fail-on-non-empty $(DESTDIR) || true
+
 
 dist: lcov-$(VERSION).tar.gz lcov-$(VERSION)-$(RELEASE).noarch.rpm \
       lcov-$(VERSION)-$(RELEASE).src.rpm
@@ -233,17 +241,17 @@ ifeq ($(COVERAGE), 1)
 # write to .../tests/cover_db
 export COVER_DB := ./cover_db
 endif
-export TESTCASE_ARGS COVER_DB
+export TESTCASE_ARGS
 
 test: check
 
 check:
 	if [ "x$(COVERAGE)" != 'x' ] && [ ! -d tests/$(COVER_DB) ]; then \
 	  mkdir tests/$(COVER_DB) ; \
 	fi
-	@$(MAKE) -s -C tests check
-	if [ "x$(COVERAGE)" != 'x' ] ; then \
-	  ( cd tests ; cover ) ; \
+	@$(MAKE) -s -C tests check LCOV_HOME=`pwd`
+	@if [ "x$(COVERAGE)" != 'x' ] ; then \
+	  $(MAKE) -s -C tests report ; \
 	fi
 
 # Files to be checked for coding style issue issues -

README

@@ -89,6 +89,20 @@ To install in a different location - for example, your home directory, run:
 
 your PREFIX should be an absolute path.
 
+To run the LCOV regression test suite on your installation:
+
+  $ cp -r $LCOV_HOME/share/test path/to/myTestDir
+  $ cd path/to/myTestDir
+  $ make [COVERAGE=1]
+
+If desired, you can collect coverage data for the LCOV module by setting
+the COVERAGE makefile variable.
+Note that the Devel::Cover package must be installed if COVERAGE is enabled
+To view the collected coverage information, point your browser to
+.../cover_db/coverage.html after running the tests.
+
+Note that the testcases are intended to test LCOV functionality and
+not to be easily readable tutorial examples.
 
 3. Dependencies:
 ----------------

tests/Makefile

@@ -1,6 +1,24 @@
+ifeq ($(COVERAGE), 1)
+ifeq ($(COVER_DB),)
+export COVER_DB := ./cover_db
+endif
+endif
+
+.PHONY: report
+
+all: check report
+
 include common.mak
 
 TESTS := genhtml/ lcov/ gendiffcov/ py2lcov
 
+report:
+	if [ "x$(COVERAGE)" != 'x' ] ; then \
+	  cover ; \
+	fi
+
 clean:
-	rm -rf *.info *.counts test.log src/ ./cover_db
+	rm -rf *.info *.counts test.log src
+ifeq ($(COVERAGE), 1)
+	if [ "x$(COVER_DB)" != 'x' ] ; then rm -rf $(COVER_DB) ; fi
+endif

tests/README.md

@@ -1,9 +1,30 @@
 LCOV test suite
 ===============
 
-This directory contains a number of regression tests for LCOV. To start it,
-simply run `make check`. The resulting output is written to the terminal and
-stored in a log file.
+This directory contains a number of regression tests for LCOV. To start it:
+
+  - if you are running in a build/development directory:
+
+      - run `make check`
+
+      - The resulting output is written to the terminal and
+        stored in a log file.
+
+  - if you are running in or from an installed 'release' (e.g., from
+    $LCOV_HOME/share/lcov/tests):
+
+       - (optional):  cp -r $LCOV_HOME/share/lcov/tests myTestDir ; cd myTestDir
+
+       - make [COVERAGE=1]
+
+       - results will be written to the terminal and stored in 'test.log'
+         If enabled, coverage data can be viewed by pointing your browser
+         to .../cover_db/coverage.html.  The coverage data can be redirected
+         to a different location via the COVER_DB variable.
+
+       - to generate coverage data for the lcov module, the 'Devel::Cover'
+         perl package must be available.
+
 
 You can modify some aspects of testing by specifying additional parameters on
 `make` invocation:

tests/bin/common

@@ -37,6 +37,12 @@ function t_detail()
 function t_announce()
 {
 	local TESTNAME="$1"
+	local len=`echo "$1" | wc -c`
+	local start=`expr $len - 31`
+	if [[ $len > 32 ]] ; then
+	   # test name too long - trim from left
+	   TESTNAME="...`echo $TESTNAME | cut -c ${start}-`"
+	fi
 
 	printf "$BOLD%-.35s$RESET " "$TESTNAME .............................."
 	t_marker >> "$LOGFILE"

tests/bin/test_run

@@ -28,31 +28,31 @@ while [ $# -gt 0 ] ; do
     shift
     case $OPT in
 
-	--script-args )
-	    OPTS="$OPTS $1"
-	    shift
-	    ;;
-
-	--coverage )
-	    COVER_DB=$1
-	    shift
-	    OPTS="$OPTS $OPT $COVER_DB"
-	    ;;
-
-	* )
-	    echo "Error: test_run: unexpected option '$OPT'"
-	    exit 1
-	    ;;
+        --script-args )
+            OPTS="$OPTS $1"
+            shift
+            ;;
+
+        --coverage )
+            COVER_DB=$1
+            shift
+            OPTS="$OPTS $OPT $COVER_DB --keep-going"
+            ;;
+
+        * )
+            echo "Error: test_run: unexpected option '$OPT'"
+            exit 1
+            ;;
 
     esac
 done
 
 TIME=$(type -P time 2>/dev/null)
 if [ ! -z "$TIME" ] ; then
-	TIME="$TIME -v -o $TIMEFILE"
-	if ! $TIME true 2>/dev/null ; then
-		TIME=""
-	fi
+        TIME="$TIME -v -o $TIMEFILE"
+        if ! $TIME true 2>/dev/null ; then
+                TIME=""
+        fi
 fi
 
 t_announce "$TESTNAME"
@@ -78,15 +78,15 @@ ELAPSED=
 RESIDENT=
 SIGNAL=
 if [ ! -z "$TIME" ] ; then
-	while read LINE ; do
-		case "$LINE" in
-		"Command terminated by signal"*) SIGNAL=${LINE##* } ;;
-		"Elapsed"*) ELAPSED=$(elapsed_to_ms ${LINE##* }) ;;
-		"Maximum resident"*) RESIDENT=${LINE##* } ;;
-		"Exit status"*) RC=${LINE##* } ;;
-		esac
-	done < "$TIMEFILE"
-	rm -f "$TIMEFILE"
+        while read LINE ; do
+                case "$LINE" in
+                "Command terminated by signal"*) SIGNAL=${LINE##* } ;;
+                "Elapsed"*) ELAPSED=$(elapsed_to_ms ${LINE##* }) ;;
+                "Maximum resident"*) RESIDENT=${LINE##* } ;;
+                "Exit status"*) RC=${LINE##* } ;;
+                esac
+        done < "$TIMEFILE"
+        rm -f "$TIMEFILE"
 fi
 
 # Save last output line as reason in case of skip result
@@ -96,56 +96,56 @@ t_detail "EXITCODE" "$RC" >>"$LOGFILE"
 
 # Show result
 if [ $RC -eq 0 -a -z "$SIGNAL" ] ; then
-	RESULT="pass"
-	t_pass "$TESTNAME"
+        RESULT="pass"
+        t_pass "$TESTNAME"
 else
-	if [ $RC -eq 2 ] ; then
-		RESULT="skip"
-		t_skip "$TESTNAME"
-	else
-		if [ -z "$SIGNAL" ] ; then
-			RESULT="fail"
-			t_fail "$TESTNAME"
-		else
-			RESULT="kill"
-			t_kill "$TESTNAME"
-		fi
-	fi
+        if [ $RC -eq 2 ] ; then
+                RESULT="skip"
+                t_skip "$TESTNAME"
+        else
+                if [ -z "$SIGNAL" ] ; then
+                        RESULT="fail"
+                        t_fail "$TESTNAME"
+                else
+                        RESULT="kill"
+                        t_kill "$TESTNAME"
+                fi
+        fi
 fi
 
 if [ ! -z "$SIGNAL" ] ; then
-	t_detail "SIGNAL" "$SIGNAL" >>"$LOGFILE"
+        t_detail "SIGNAL" "$SIGNAL" >>"$LOGFILE"
 fi
 
 if [ ! -z "$ELAPSED" ] ; then
-	echo -n " (time $(($ELAPSED/1000)).$(($ELAPSED%1000/100))s, "
-	echo "elapsed $TESTNAME $ELAPSED" >> "$COUNTFILE"
+        echo -n " (time $(($ELAPSED/1000)).$(($ELAPSED%1000/100))s, "
+        echo "elapsed $TESTNAME $ELAPSED" >> "$COUNTFILE"
 fi
 
 if [ ! -z "$RESIDENT" ] ; then
-	echo -n "mem $(($RESIDENT/1024)).$((($RESIDENT%1024)/100))MB)"
-	echo "resident $TESTNAME $RESIDENT" >> "$COUNTFILE"
+        echo -n "mem $(($RESIDENT/1024)).$((($RESIDENT%1024)/100))MB)"
+        echo "resident $TESTNAME $RESIDENT" >> "$COUNTFILE"
 fi
 
 echo
 
 # Show skip reason
 if [ $RC -eq 2 ] ; then
-	t_detail "REASON" "$LAST" | t_indent
-	t_detail "REASON" "$LAST" >>"$LOGFILE"
+        t_detail "REASON" "$LAST" | t_indent
+        t_detail "REASON" "$LAST" >>"$LOGFILE"
 fi
 
 # Show log excerpt on failure or if requested
 if [ $RC -ne 0 -a $RC -ne 2 -o "$V" == "1" ] ; then
-	LEN=$(tail -c "+$POS" "$LOGFILE" | wc -l)
-	if [ "$LEN" -gt "$EXCERPTLEN" -a "$V" != "1" ] ; then
-		echo "    Skipping $LEN previous lines (see $LOGFILE)"
-		echo "    ..."
-		tail -c "+$POS" "$LOGFILE" | tail -n $EXCERPTLEN | t_indent
-		let LEN=$LEN-$EXCERPTLEN
-	else
-		tail -c "+$POS" "$LOGFILE" | t_indent
-	fi
+        LEN=$(tail -c "+$POS" "$LOGFILE" | wc -l)
+        if [ "$LEN" -gt "$EXCERPTLEN" -a "$V" != "1" ] ; then
+                echo "    Skipping $LEN previous lines (see $LOGFILE)"
+                echo "    ..."
+                tail -c "+$POS" "$LOGFILE" | tail -n $EXCERPTLEN | t_indent
+                let LEN=$LEN-$EXCERPTLEN
+        else
+                tail -c "+$POS" "$LOGFILE" | t_indent
+        fi
 fi
 
 # Log more details

tests/common.mak

@@ -1,5 +1,24 @@
-export TOPDIR       := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
-export TESTDIR      := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
+
+# TOPDIR == root of test directory - either build dir or copied from share/lcov
+TOPDIR       := $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
+# TESTDIR == path to this particular testcase
+TESTDIR      := $(dir $(realpath $(firstword $(MAKEFILE_LIST))))
+
+ifeq ($(LCOV_HOME),)
+BINDIR = $(realpath $(TOPDIR)/../bin)
+else
+BINDIR  := $(LCOV_HOME)/bin
+endif
+
+ifeq ($(DEBUG),1)
+$(warning TOPDIR = $(TOPDIR))
+$(warning TESTDIR = $(TESTDIR))
+$(warning BINDIR = $(BINDIR))
+endif
+
+TESTBINDIR := $(TOPDIR)bin
+
+export TOPDIR TESTDIR
 export PARENTDIR    := $(dir $(patsubst %/,%,$(TOPDIR)))
 export RELDIR       := $(TESTDIR:$(PARENTDIR)%=%)
 
@@ -27,9 +46,9 @@ SIZE         := small
 CC           := gcc
 
 # Specify programs under test
-export PATH    := $(realpath $(TOPDIR)/../bin):$(realpath $(TOPDIR)/bin):$(PATH)
-export LCOV    := $(realpath $(TOPDIR)/../bin/lcov) --config-file $(LCOVRC) $(LCOVFLAGS)
-export GENHTML := $(realpath $(TOPDIR)/../bin/genhtml) --config-file $(LCOVRC) $(GENHTMLFLAGS)
+export PATH    := $(BINDIR):$(TESTBINDIR):$(PATH)
+export LCOV    := $(BINDIR)/lcov --config-file $(LCOVRC) $(LCOVFLAGS)
+export GENHTML := $(BINDIR)/genhtml --config-file $(LCOVRC) $(GENHTMLFLAGS)
 
 # Ensure stable output
 export LANG    := C
@@ -66,7 +85,7 @@ export _ONCE := 1
 check: checkdeps prepare
 
 checkdeps:
-	checkdeps $(TOPDIR)/../bin/* $(TOPDIR)/bin/*
+	checkdeps $(BINDIR)/* $(TESTBINDIR)/*
 
 prepare: $(INFOFILES) $(COUNTFILES)
 

tests/gendiffcov/filter/filter.pl

@@ -4,7 +4,8 @@
 use warnings;
 use FindBin;
 
-use lib "$FindBin::RealBin/../../../lib";
+use lib "$FindBin::RealBin/../../../lib";    # build dir testcase
+use lib "$ENV{LCOV_HOME}/lib/lcov";          # install testcase
 use lcovutil;
 
 foreach my $example (glob('expr*.c')) {