Add 'spreadsheet.py' to coverage report.

Enable coverage collection for more tests/more test types.
Feature to force parallel execution - even if there is only one
task - to improve testability.

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

Author: henry2cox

bin/geninfo

@@ -1256,7 +1256,10 @@ sub gen_info(@)
     my $filelist = $builder->worklist();
     my $total    = scalar(@$filelist);
     if (1 < $lcovutil::maxParallelism) {
-        my $floor = int($total / $lcovutil::maxParallelism);
+        my $floor =
+            $lcovutil::maxParallelism ?
+            (int($total / $lcovutil::maxParallelism)) :
+            1;
         if (defined($defaultChunkSize)) {
             if ($defaultChunkSize =~ /^(\d+)\s*(%?)$/) {
                 if (defined($2) && $2) {

lib/lcovutil.pm

@@ -6025,9 +6025,11 @@ sub _processFilterWorklist
     my $parallel = $lcovutil::lcov_filter_parallel;
     # not much point in parallel calculation if the number of files is small
     my $workList = $fileList;
-    if ((exists($ENV{LCOV_FORCE_PARALLEL}) || scalar(@$fileList) > 50) &&
-        $parallel &&
-        1 < $lcovutil::maxParallelism) {
+    if (exists($ENV{LCOV_FORCE_PARALLEL}) ||
+        (scalar(@$fileList) > 50 &&
+            $parallel &&
+            1 < $lcovutil::maxParallelism)
+    ) {
 
         $parallel = $lcovutil::maxParallelism;
 
@@ -6049,14 +6051,17 @@ sub _processFilterWorklist
 
         if (!defined($chunkSize)) {
             $chunkSize =
-                int(0.8 * scalar(@$fileList) / $lcovutil::maxParallelism);
+                $maxParallelism ?
+                (int(0.8 * scalar(@$fileList) / $lcovutil::maxParallelism)) :
+                1;
             if ($chunkSize > 100) {
                 $chunkSize = 100;
             } elsif ($chunkSize < 2) {
                 $chunkSize = 1;
             }
         }
-        if ($chunkSize != 1) {
+        if ($chunkSize != 1 ||
+            exists($ENV{LCOV_FORCE_PARALLEL})) {
             $workList = [];
             my $idx     = 0;
             my $current = [];
@@ -6092,7 +6097,9 @@ sub _processFilterWorklist
                           "filter_datXXXX",
                           DIR     => $lcovutil::tmp_dir,
                           CLEANUP => !defined($lcovutil::preserve_intermediates)
-    ) if $parallel > 1;
+        )
+        if (exists($ENV{LCOV_FORCE_PARALLEL}) ||
+            $parallel > 1);
 
     CHUNK: foreach my $d (@$workList) {
         ++$processedChunks;

tests/Makefile

@@ -20,19 +20,17 @@ TESTS := genhtml lcov gendiffcov py2lcov perl2lcov
 #  ignore the potential 'empty glob pattern' error message and a
 #  potential remote repo timestamp issue
 report:
+	$(SPREADSHEET_TOOL) -o report.xlsx `find . -name "*.json"`
 	if [ "x$(COVERAGE)" != 'x' ] ; then \
-	  cover ; \
+	  cover $(COVER_DB) ; \
 	  $(BINDIR)/perl2lcov -o perlcov.info $(COVER_DB) --version-script $(VERSION_SCRIPT) ; \
 	  if [ -f $(PYCOV_DB) ] ; then \
 	    $(BINDIR)/py2lcov -o pycov.info $(PYCOV_DB) --version-script $(VERSION_SCRIPT) ; \
 	  fi ; \
-	  $(BINDIR)/genhtml -o $(HTML_RPT) perlcov.info pycov.i* $(COVER_DB)/*.info --show-navigation --flat --branch --show-proportion --version-script $(VERSION_SCRIPT) --annotate-script $(ANNOTATE_SCRIPT) --ignore empty,inconsistent ; \
+	  $(BINDIR)/genhtml --parallel -o $(HTML_RPT) perlcov.info pycov.i* $(COVER_DB)/*.info --show-navigation --flat --branch --show-proportion --version-script $(VERSION_SCRIPT) --annotate-script $(ANNOTATE_SCRIPT) --ignore empty,inconsistent ; \
 	  echo "Wrote HTML report to ${HTML_RPT}" ; \
 	fi
 
 clean:
-	rm -rf *.info *.counts test.log src
-ifeq ($(COVERAGE), 1)
-	if [ "x$(COVER_DB)" != 'x' ] ; then rm -rf $(COVER_DB) ; fi
-	if [ "x$(HTML_RPT)" != 'x' ] ; then rm -rf $(HTML_RPT) ; fi
-endif
+	rm -rf *.info *.counts test.log src report.xlsx \
+		$(COVER_DB) $(HTML_RPT) $(PYCOV_DB)

tests/README.md

@@ -43,6 +43,15 @@ This directory contains a number of regression tests for LCOV. To start it:
            variable:
               $ make [HTML_RPT=path/to/my/html] COVERAGE=1 ... test
 
+  - environment variables:
+
+      - LCOV_SHOW_LOCATION:
+        if set, show location on die() or warn()
+
+      - LCOV_FORCE_PARALLEL:
+        if set, force parallel processing, regardless of number of tasks -
+        even if only one.  This is useful for regression testing - to make
+        sure that we cover both serial and parallel execution.
 
 You can modify some aspects of testing by specifying additional parameters on
 `make` invocation:

tests/bin/test_run

@@ -35,6 +35,7 @@ while [ $# -gt 0 ] ; do
 
         --coverage )
             COVER_DB=$1
+            export PERL_COVER_ARGS="-MDevel::Cover=-db,$(COVER_DB),-coverage,statement,branch,condition,subroutine,-silent,1"
             shift
             OPTS="$OPTS $OPT $COVER_DB --keep-going"
             ;;
@@ -47,6 +48,10 @@ while [ $# -gt 0 ] ; do
     esac
 done
 
+if [[ "$SCRIPT" =~ '.pl' ]] ; then
+    INVOKE_COVER="perl ${PERL_COVER_ARGS}"
+fi
+
 TIME=$(type -P time 2>/dev/null)
 if [ ! -z "$TIME" ] ; then
         TIME="$TIME -v -o $TIMEFILE"
@@ -70,7 +75,7 @@ t_detail "COMMAND" "\"$SCRIPT $OPTS*\"" >>"$LOGFILE"
 t_detail "OUTPUT" "" >>"$LOGFILE"
 
 # Run command
-$TIME bash -c "$SCRIPT $OPTS" 2>&1 | t_indent >>"$LOGFILE"
+$TIME bash -c "$INVOKE_COVER $SCRIPT $OPTS" 2>&1 | t_indent >>"$LOGFILE"
 RC=$?
 
 # Evaluate output of time command

tests/common.mak

@@ -37,7 +37,8 @@ VERSION_SCRIPT=$(SCRIPTDIR)/getp4version
 endif
 
 ifneq ($(COVER_DB),)
-EXEC_COVER := perl -MDevel::Cover=-db,$(COVER_DB),-coverage,statement,branch,condition,subroutine,-silent,1
+export PERL_COVER_ARGS := -MDevel::Cover=-db,$(COVER_DB),-coverage,statement,branch,condition,subroutine,-silent,1
+EXEC_COVER := perl ${PERL_COVER_ARGS}
 PYCOVER = COVERAGE_FILE=$(PYCOV_DB) coverage run --branch --append
 endif
 
@@ -74,6 +75,7 @@ export GENHTML_TOOL := $(EXEC_COVER) $(BINDIR)/genhtml
 export GENINFO_TOOL := $(EXEC_COVER) $(BINDIR)/geninfo
 export PERL2LCOV_TOOL := $(EXEC_COVER) $(BINDIR)/perl2lcov
 export PY2LCOV_TOOL := $(PYCOVER) $(BINDIR)/py2lcov
+export SPREADSHEET_TOOL := $(PYCOVER) $(SCRIPTDIR)/spreadsheet.py
 
 # Specify programs under test
 export PATH    := $(BINDIR):$(TESTBINDIR):$(PATH)

tests/gendiffcov/filter/filter.pl

@@ -8,6 +8,8 @@
 use lib "$ENV{LCOV_HOME}/lib/lcov";          # install testcase
 use lcovutil;
 
+lcovutil::parseOptions({},{});
+
 foreach my $example (glob('expr*.c')) {
     print("checking conditional in $example\n");
     my $file = ReadCurrentSource->new($example);

tests/gendiffcov/simple/script.sh

@@ -10,6 +10,8 @@ CXX='g++'
 LOCAL_COVERAGE=1
 KEEP_GOING=0
 
+#echo "CMD:  $0 $@"
+
 while [ $# -gt 0 ] ; do
 
     OPT=$1
@@ -91,12 +93,6 @@ fi
 export PATH=${LCOV_HOME}/bin:${LCOV_HOME}/share:${PATH}
 export MANPATH=${MANPATH}:${LCOV_HOME}/man
 
-if [ 'x' == "x$GENHTML_TOOL" ] ; then
-    GENHTML_TOOL=${LCOV_HOME}/bin/genhtml
-    LCOV_TOOL=${LCOV_HOME}/bin/lcov
-    GENINFO_TOOL=${LCOV_HOME}/bin/geninfo
-fi
-
 ROOT=`pwd`
 PARENT=`(cd .. ; pwd)`
 if [ -f $LCOV_HOME/scripts/getp4version ] ; then
@@ -106,6 +102,13 @@ else
     SCRIPT_DIR=$LCOV_HOME/share/lcov/support-scripts
     MD5_OPT='--version-script --md5'
 fi
+if [ 'x' == "x$GENHTML_TOOL" ] ; then
+    GENHTML_TOOL=${LCOV_HOME}/bin/genhtml
+    LCOV_TOOL=${LCOV_HOME}/bin/lcov
+    GENINFO_TOOL=${LCOV_HOME}/bin/geninfo
+    SPREADSHEET_TOOL=${SCRIPT_DIR}/spreadsheet.py
+fi
+
 # is this git or P4?
 git -C . rev-parse > /dev/null 2>&1
 if [ 0 == $? ] ; then
@@ -144,14 +147,19 @@ if ! type "${CXX}" >/dev/null 2>&1 ; then
         echo "Missing tool: $CXX" >&2
         exit 2
 fi
-
+1
 if ! python3 -c "import xlsxwriter" >/dev/null 2>&1 ; then
         echo "Missing python module: xlsxwriter" >&2
         exit 2
 fi
 
 echo *
 
+echo "COVER = '$COVER'"
+echo "COVER_DB = '$COVER_DB'"
+echo "PYCOVER = '$PYCOVER'"
+echo "PYCOV_DB = '$PYCOV_DB'"
+
 status=0
 ln -s simple.cpp test.cpp
 ${CXX} --coverage test.cpp
@@ -1002,8 +1010,8 @@ if [ 0 != $? ] ; then
     fi
 fi
 
-NAME=`(cd select2 ; ls /*.html)`
-if [ "index.html" != $NAME ] ; then
+NAME=`(cd select2 ; ls *.html)`
+if [ "index.html" != "$NAME" ] ; then
     echo "ERROR: expected to find only one HTML file"
     status=1
     if [ 0 == $KEEP_GOING ] ; then
@@ -1274,21 +1282,11 @@ if [ 0 != $? ] ; then
 fi
 
 
-# and generate a spreadsheet..check that we don't crash
-SPREADSHEET=$LCOV_HOME/scripts/spreadsheet.py
-if [ ! -f $SPREADSHEET ] ; then
-    SPREADSHEET=$LCOV_HOME/share/lcov/support-scripts/spreadsheet.py
-fi
-if [ -f $SPREADSHEET ] ; then
-    eval $PYCOVER $SPREADSHEET -o results.xlsx `find . -name "*.json"`
-    if [ 0 != $? ] ; then
-        status=1
-        echo "ERROR:  spreadsheet generation failed"
-        exit 1
-    fi
-else
-    echo "Did not find $SPREADSHEET to run test"
+echo $SPREADSHEET_TOOL -o results.xlsx `find . -name "*.json"`
+eval $SPREADSHEET_TOOL -o results.xlsx `find . -name "*.json"`
+if [ 0 != $? ] ; then
     status=1
+    echo "ERROR:  spreadsheet generation failed"
     exit 1
 fi
 
@@ -1298,12 +1296,20 @@ else
     echo "Tests failed"
 fi
 
-if [ "x$COVER" != "x" ] && [ 0 != $LOCAL_COVERAGE ] ; then
-    cover
-    ${LCOV_HOME}/bin/perl2lcov -o perlcov.info --testname simple --version-script $GET_VERSION $COVER_DB
+if [ "x$COVER" != "x" ] ; then
+    echo "Generating coverage report"
+    echo ${LCOV_HOME}/bin/py2lcov -o pycov.info --testname simple --version-script $GET_VERSION $PYCOV_DB
     ${LCOV_HOME}/bin/py2lcov -o pycov.info --testname simple --version-script $GET_VERSION $PYCOV_DB
-    ${LCOV_HOME}/bin/genhtml -o html_report perlcov.info pycov.info --branch --flat --show-navigation --show-proportion --version-script $GET_VERSION --annotate-script $P4ANNOTATE --parallel --ignore empty,usage
-    echo "see HTML report 'html_report'"
+
+    if [ 0 != $LOCAL_COVERAGE ] ; then
+        cover $COVER_DB
+        ${LCOV_HOME}/bin/perl2lcov -o perlcov.info --testname simple --version-script $GET_VERSION $COVER_DB
+        ${LCOV_HOME}/bin/genhtml -o html_report perlcov.info pycov.info --branch --flat --show-navigation --show-proportion --version-script $GET_VERSION --annotate-script $P4ANNOTATE --parallel --ignore empty,usage
+        echo "see HTML report 'html_report'"
+    else
+        echo cp pycov.info $COVER_DB/spreadsheet.info
+        cp pycov.info $COVER_DB/spreadsheet.info
+    fi
 fi
 
 exit $status

tests/lcov/merge/merge.sh

@@ -80,6 +80,12 @@ fi
 export PATH=${LCOV_HOME}/bin:${LCOV_HOME}/share:${PATH}
 export MANPATH=${MANPATH}:${LCOV_HOME}/man
 
+if [ 'x' == "x$GENHTML_TOOL" ] ; then
+    GENHTML_TOOL=${LCOV_HOME}/bin/genhtml
+    LCOV_TOOL=${LCOV_HOME}/bin/lcov
+    GENINFO_TOOL=${LCOV_HOME}/bin/geninfo
+fi
+
 ROOT=`pwd`
 PARENT=`(cd .. ; pwd)`
 
@@ -108,15 +114,15 @@ if ! type g++ >/dev/null 2>&1 ; then
 fi
 
 status=0
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o intersect.info a.info --intersect b.info
+$COVER $LCOV_TOOL $LCOV_OPTS -o intersect.info a.info --intersect b.info
 if [ 0 != $? ] ; then
     echo "Error:  unexpected error code from intersect"
     status=1
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
 fi
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o intersect_2.info b.info --intersect a.info
+$COVER $LCOV_TOOL $LCOV_OPTS -o intersect_2.info b.info --intersect a.info
 if [ 0 != $? ] ; then
     echo "Error:  unexpected error code from intersect"
     status=1
@@ -144,7 +150,7 @@ if [ 0 != $? ] ; then
 fi
 
 
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o diff.info a.info --subtract b.info
+$COVER $LCOV_TOOL $LCOV_OPTS -o diff.info a.info --subtract b.info
 if [ 0 != $? ] ; then
     echo "Error:  unexpected error code from subtract"
     status=1
@@ -161,7 +167,7 @@ if [ 0 != $? ] ; then
     fi
 fi
 
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o diff2.info b.info --subtract a.info
+$COVER $LCOV_TOOL $LCOV_OPTS -o diff2.info b.info --subtract a.info
 if [ 0 != $? ] ; then
     echo "Error:  unexpected error code from subtract 2"
     status=1
@@ -180,15 +186,15 @@ fi
 
 
 # test some error messages...
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o x.info 'y.?info' --intersect a.info
+$COVER $LCOV_TOOL $LCOV_OPTS -o x.info 'y.?info' --intersect a.info
 if [ 0 == $? ] ; then
     echo "Error:  expected error but did not see one"
     status=1
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
 fi
-$COVER $LCOV_HOME/bin/lcov $LCOV_OPTS -o x.info a.info --intersect 'z.?info'
+$COVER $LCOV_TOOL $LCOV_OPTS -o x.info a.info --intersect 'z.?info'
 if [ 0 == $? ] ; then
     echo "Error:  expected error but did not see one"
     status=1