Add some error checking to 'select.pm' callback: (linux-test-project#453)

check that annotation and diff prerequisites are present and
generate 'select' criteria application count.
Goal is to aid user debugging - e.g., for typos in selection criteria:
"why does my expected data not appear in the report?"

Signed-off-by: Henry Cox <henry.cox@mediatek.com>

Author: henry2cox

Makefile

@@ -267,9 +267,7 @@ test: check
 #   once without - so we can merge the result
 check:
 	if [ "x$(COVERAGE)" != 'x' ] ; then                                 \
-	  if [ ! -d $(COVER_DB) ]; then                                     \
-	    mkdir $(COVER_DB) ;                                             \
-	  fi ;                                                              \
+	  mkdir -p $(COVER_DB) ;                                            \
 	  echo "*** Run once, force parallel ***" ;                         \
 	  LCOV_FORCE_PARALLEL=1 $(MAKE) -s -C tests check LCOV_HOME=`pwd` ; \
 	  echo "*** Run again, no force ***" ;                              \
@@ -279,6 +277,10 @@ check:
 	  $(MAKE) -s -C example LCOV_HOME=`pwd`;   \
 	  $(MAKE) -s -C tests report ;             \
 	fi
+	grep uninitialized tests/test.log ; \
+	if [ 1 != $$? ] ; then              \
+	   echo "found 'uninitialized'" ;   \
+	fi
 
 # Files to be checked for coding style issue issues -
 #   - anything containing "#!/usr/bin/env perl" or the like

bin/genhtml

@@ -7538,11 +7538,17 @@ sub print_overall_rate($$$$$$)
         my $plural = "ch" eq substr($name, -2, 2) ? "es" : "s";
         my $label  = "$name$plural";
         my $fill   = '.' x ($width - length($label));
+        my $found  = $summary->get("found", $type);
+        # user was confused about why there was no coverage data
+        my $explain =
+            ($type == SummaryInfo::LINE_DATA &&
+             0 == $found &&
+             $SummaryInfo::selectCallback) ?
+            " (your '--select-script' criteria may not match any coverpoints)" :
+            '';
         info(-1,
-             "  $name$plural$fill: %s\n",
-             get_overall_line($summary->get("found", $type),
-                              $summary->get("hit", $type),
-                              $name));
+             "  $name$plural$fill: %s$explain\n",
+             get_overall_line($found, $summary->get("hit", $type), $name));
         if ($main::show_tla) {
             for my $tla (@SummaryInfo::tlaPriorityOrder) {
                 my $v = $summary->get($tla, $type);

man/genhtml.1

@@ -639,6 +639,12 @@ to a shell interpreter to be executed.
 The command line includes the script path followed by optional additional parameters
 separated by spaces. Care must be taken to provide proper quoting if script
 path or any parameter contains spaces or shell special characters.
+.br
+Note that module callbacks must be called via the 'list' method: they cannot be called as an executable with a space-separated set of arguments.
+.br
+For convenience: your callback module may need to implement its own
+'split_char' so that you can pass multiple parameters to your callback
+without interacting with genhtml's split mechanism.
 .PP
 
 .IP 3. 3

scripts/criteria.pm

@@ -47,8 +47,10 @@ use Getopt::Long qw(GetOptionsFromArray);
 our @ISA       = qw(Exporter);
 our @EXPORT_OK = qw(new);
 
-use constant {SIGNOFF => 0,
-	      TYPES =>1,};
+use constant {
+              SIGNOFF => 0,
+              TYPES   => 1,
+};
 
 sub new
 {
@@ -57,27 +59,28 @@ sub new
     my $script     = shift;
     my $standalone = $script eq $0;
     my @options    = @_;
-    my $function = 0;
-    my $branch = 0;
-    my $mcdc = 0;
+    my $function   = 0;
+    my $branch     = 0;
+    my $mcdc       = 0;
 
-    if (!GetOptionsFromArray(\@_, ('signoff' => \$signoff,
-				   'function' => \$function,
-				   'branch' => \$branch,
-				   'mcdc' => \$mcdc,
-			     )) ||
-        (!$standalone && @_)) {
+    if (!GetOptionsFromArray(\@_,
+                             ('signoff'  => \$signoff,
+                              'function' => \$function,
+                              'branch'   => \$branch,
+                              'mcdc'     => \$mcdc,)) ||
+        (!$standalone && @_)
+    ) {
         print(STDERR "Error: unexpected option:\n  " .
-              join(' ', @options) .
-              "\nusage: name type json-string [--signoff] [--branch] [--mcdc] [--function]\n");
+                join(' ', @options) .
+                "\nusage: name type json-string [--signoff] [--branch] [--mcdc] [--function]\n"
+        );
         exit(1) if $standalone;
         return undef;
     }
     my @types = ('line');
-    foreach my $t (['function', $function],
-		   ['MC/DC', $mcdc],
-		   ['branch', $branch]) {
-	push(@types, $t->[0]) if $t->[1];
+    foreach
+        my $t (['function', $function], ['MC/DC', $mcdc], ['branch', $branch]) {
+        push(@types, $t->[0]) if $t->[1];
     }
     my $self = [$signoff, \@types];
     return bless $self, $class;
@@ -92,20 +95,20 @@ sub check_criteria
     if ($type eq 'top') {
         # for the moment - only worry about the top-level coverage
 
-	my $s = '';
-	foreach my $t (@{$self->[TYPES]}) {
-	    next unless exists($db->{$t});
+        my $s = '';
+        foreach my $t (@{$self->[TYPES]}) {
+            next unless exists($db->{$t});
 
             # our criteria is LBC + UNC + UIC == 0
             my $sep    = '';
             my $sum    = 0;
             my $msg    = '';
             my $counts = '';
-            my $data  = $db->{$t};
-	    # say which type - if there is more than one
-	    $msg .= "$s$t: " if 1 <= $#{$self->[TYPES]};
-	    $s = ' ';
-	    
+            my $data   = $db->{$t};
+            # say which type - if there is more than one
+            $msg .= "$s$t: " if 1 <= $#{$self->[TYPES]};
+            $s = ' ';
+
             foreach my $tla ('UNC', 'LBC', 'UIC') {
                 $msg    .= $sep . $tla;
                 $counts .= $sep;