Enable 'genhtml --show-details' in '--flat' and '--hierarchical' modes.

henry2cox · henry2cox · commit aa03ec10cdde · 2024-02-28T07:16:17.000-05:00
Fix bug that caused per-testcase summary to not be generated.

Signed-off-by: Henry Cox &lt;henry.cox@mediatek.com&gt;
diff --git a/bin/genhtml b/bin/genhtml
@@ -4948,11 +4948,15 @@ sub new
     my $worklist          = $self->[$WORKLIST_IDX];
     my $top_level_summary = $self->[0];
     # no parent data for top-level
+    my $toplevelPerTestData =
+        ($main::hierarchical || $main::flat) ? [{}, {}, {}] : undef;
     $pending->{""} = [
                       ['top',
-                       [$top_level_summary, undef, $top_level_summary->name()]
-                       ,    # summary, per-test data, name
-                       ['root'], ['root'],
+                       [$top_level_summary, $toplevelPerTestData,
+                        $top_level_summary->name()
+                       ],
+                       ['root'],
+                       ['root'],
                        [undef, undef]
                       ],
                       {}
@@ -5146,17 +5150,16 @@ sub merge_one
 
 sub compute_one
 {
-    my ($type, $name, $summary, $parentSummary, $rel_dir, $base_dir, $trunc_dir)
+    my ($type, $name, $summary, $parentSummary, $perTestData,
+        $rel_dir, $base_dir, $trunc_dir)
         = @_;
 
-    my $perTestData;
     if ('file' eq $type) {
         my ($testdata, $testfncdata, $testbrdata) =
             main::process_file($summary, $parentSummary,
                                $trunc_dir, $rel_dir, $name);
         $perTestData = [$testdata, $testfncdata, $testbrdata];
     } elsif ('dir' eq $type) {
-        $perTestData = [{}, {}, {}];
         # process the directory...
         main::write_summary_pages($name, 1,    # this is a directory,
                                   $summary, $main::show_details,
@@ -5166,11 +5169,12 @@ sub compute_one
         die("unexpected task")
             unless 'top' eq $type;
         # Create sorted pages
-        main::write_summary_pages(
-                       $name, 0,               # 0 == list directories
-                       $summary,
-                       0,  # don't generate 'details' links for top-level report
-                       ".", "", undef, undef);
+        main::write_summary_pages($name, 0,    # 0 == list directories
+                                  $summary,
+                                  # generate top-level 'details' in flat or hierarchical modes
+                                  $main::show_details &&
+                                      ($main::flat || $main::hierarchical),
+                                  ".", "", undef, $perTestData);
     }
     $summary->checkCoverageCriteria();
     return $perTestData;
@@ -5295,9 +5299,10 @@ sub compute
 
                     eval {
                         $thisTestData =
-                            compute_one($type, $name, $selfSummary,
-                                        $parentSummary, $rel_dir, $base_dir,
-                                        $trunc_dir);
+                            compute_one($type, $name,
+                                        $selfSummary, $parentSummary,
+                                        $perTestData, $rel_dir,
+                                        $base_dir, $trunc_dir);
 
                         # clear the parent pointer that we hacked into place.  Don't want that
                         #   extra data returned by dumper.
@@ -5332,7 +5337,8 @@ sub compute
                 $lcovutil::profileData{child}{$name} = $childEnd - $childStart;
                 eval {
                     Storable::store(
-                                 [$perTestData,
+                                 [$thisTestData,
+                                  $parentPerTestData,
                                   $selfSummary,
                                   $criteria,
                                   [$SourceFile::annotatedFiles - $annotateCount,
@@ -5356,9 +5362,9 @@ sub compute
 
             my $thisTestData =
                 compute_one($type, $name, $selfSummary, $parentSummary,
-                            $rel_dir, $base_dir, $trunc_dir);
+                            $perTestData, $rel_dir, $base_dir, $trunc_dir);
 
-            $self->merge_one($perTestData, $name, $thisTestData,
+            $self->merge_one($parentPerTestData, $name, $thisTestData,
                              $selfSummary, $parentSummary, $parentPath);
             my $end = Time::HiRes::gettimeofday();
             $lcovutil::profileData{$type}{$name} = $end - $start;
@@ -5433,7 +5439,9 @@ sub merge_child($$$)
         if -f $dumpfile;
     if (defined($data)) {
         eval {
-            my ($perTest, $summary, $criteria, $countData, $update) = @$data;
+            my ($perTest, $pPerTestData, $summary, $criteria, $countData,
+                $update)
+                = @$data;
             die("unexpected restored count data")
                 if (($type eq 'file' && $countData->[1] != 1) ||
                     ($type ne 'file' &&
@@ -6881,19 +6889,21 @@ sub get_relative_base_path($)
 
 sub read_testfile($)
 {
+    my $file = shift;
     my %result;
     my $test_name;
     my $changed_testname;
     local *TEST_HANDLE;
 
-    open(TEST_HANDLE, "<", $_[0]) or
-        die("cannot open $_[0]: $!\n");
+    open(TEST_HANDLE, "<", $file) or
+        die("cannot open $file]: $!\n");
 
     while (<TEST_HANDLE>) {
         chomp($_);
         s/\r//g;
         # Match lines beginning with TN:<whitespace(s)>
-        if (/^TN:\s+(.*?)\s*$/) {
+        next if /^#/;    # skip comment
+        if (/^TN:\s*(.*?)\s*$/) {
             # Store name for later use
             $test_name = $1;
             if ($test_name =~ s/\W/_/g) {
@@ -6902,10 +6912,12 @@ sub read_testfile($)
         }
 
         # Match lines beginning with TD:<whitespace(s)>
-        if (/^TD:\s+(.*?)\s*$/) {
+        if (/^TD:\s*(.*?)\s*$/) {
             if (!defined($test_name)) {
-                die("Found test description without prior test name in $_[0]:$.\n"
+                lcovutil::ignorable_error($lcovutil::ERROR_FORMAT,
+                    "\"$file\":$.: Found test description without prior test name."
                 );
+                next;
             }
             # Check for empty line
             if ($1) {
@@ -6919,10 +6931,15 @@ sub read_testfile($)
     }
 
     close(TEST_HANDLE) or die("unable to close HTML file: $!\n");
+    if (!%result) {
+        lcovutil::ignorable_error($lcovutil::ERROR_EMPTY,
+                                  "no test descriptions found in '$file'.");
+    }
 
     if ($changed_testname) {
         lcovutil::ignorable_error($lcovutil::ERROR_FORMAT,
-         "invalid characters removed from testname in descriptions file $_[0]");
+            "invalid characters removed from testname in descriptions file '$file'."
+        );
     }
 
     return \%result;
@@ -8675,24 +8692,17 @@ END_OF_HTML
             write_html($handle, "    <td class=\"testPer\"></td>\n");
         }
         write_html($handle, "    <td class=\"testPer\">$rate</td>\n");
-        if ($covtype != SummaryInfo::FUNCTION_DATA) {
+        write_html($handle, "              <td class='testNum'>$found</td>\n");
+        if ($main::show_hitTotalCol) {
             write_html($handle,
-                       "              <td class='testNum'>$found</td>\n");
-            if ($main::show_hitTotalCol) {
-                write_html($handle,
-                           "              <td class='testNum'>$hit</td>\n");
-            }
-            if ($main::show_tla) {
-                foreach my $tla (@{$activeTlaCols->{$covtype}}) {
-                    my $count = $callback->count($tla);
-                    $count = "" if 0 == $count;
-                    write_html($handle,
-                               "    <td class=coverNumDflt>$count</td>\n");
-                }
+                       "              <td class='testNum'>$hit</td>\n");
+        }
+        if ($main::show_tla) {
+            foreach my $tla (@{$activeTlaCols->{$covtype}}) {
+                my $count = $callback->count($tla);
+                $count = "" if 0 == $count;
+                write_html($handle, "    <td class=coverNumDflt>$count</td>\n");
             }
-        } else {
-            write_html($handle,
-                    "    <td class=\"testNum\">$found&nbsp;/&nbsp;$hit</td>\n");
         }
     }
     write_html($handle, "    </tr>\n");
@@ -10685,7 +10695,11 @@ sub write_file_table(*$$$$$)
     # Determine HTML code for column headings
     my $hide = $HEAD_NO_DETAIL;
     my $show = $HEAD_NO_DETAIL;
-    if ($dirSummary->type() eq 'directory' && $show_details) {
+    if (($dirSummary->type() eq 'directory' ||
+         $main::flat ||
+         $main::hierarchical) &&
+        $show_details
+    ) {
         # "detailed" if line coverage hash not empty
         my $detailed =
             defined($perTestcaseData) && scalar(%{$perTestcaseData->[0]});
diff --git a/man/genhtml.1 b/man/genhtml.1
@@ -883,10 +883,23 @@ Generate detailed directory view.
 
 When this option is enabled,
 .B genhtml
-generates two versions of each
-file view. One containing the standard information plus a link to a
-"detailed" version. The latter additionally contains information about
-which test case covered how many lines of each source file.
+generates two versions of each source file file entry in the corresponding summary table:
+.IP
+one containing the standard information plus a link to a
+"detailed" version, and
+.PP
+.IP
+a second which contains the number of coverpoints in the hit by each
+testcase.
+.br
+Note that missed coverpoints are not shown in the per-testcase table entry data.
+.PP
+
+The corresponding summary table is found on the 'directory' page of the default 3-level genthm report, or on the top-level page of the 'flat' report (see
+.I genhtml \-\-flat ...
+), or on the parent directory page of the 'hierarchical' report (see
+.I genhtml \-\-hierarchical ...
+).
 
 .RE
 .BI "\-b " baseline\-file\-pattern
diff --git a/tests/gendiffcov/simple/script.sh b/tests/gendiffcov/simple/script.sh
@@ -128,8 +128,8 @@ DIFFCOV_OPTS="--function-coverage --branch-coverage --highlight --demangle-cpp -
 #DIFFCOV_OPTS="--function-coverage --branch-coverage --highlight --demangle-cpp --frame"
 #DIFFCOV_OPTS='--function-coverage --branch-coverage --highlight --demangle-cpp'
 
-rm -f test.cpp *.gcno *.gcda a.out *.info *.info.gz diff.txt diff_r.txt diff_broken.txt *.log *.err *.json dumper* results.xlsx annotate.{cpp,exe} c d ./cover_db_py
-rm -rf ./baseline ./current ./differential* ./reverse ./diff_no_baseline ./no_baseline ./no_annotation ./no_owners differential_nobranch reverse_nobranch baseline-filter* noncode_differential* broken mismatchPath elidePath ./cover_db ./criteria ./mismatched ./navigation differential_prop proportion ./annotate ./current-* ./current_prefix* select select2 html_report
+rm -f test.cpp *.gcno *.gcda a.out *.info *.info.gz diff.txt diff_r.txt diff_broken.txt *.log *.err *.json dumper* results.xlsx annotate.{cpp,exe} c d ./cover_db_py names.data
+rm -rf ./baseline ./current ./differential* ./reverse ./diff_no_baseline ./no_baseline ./no_annotation ./no_owners differential_nobranch reverse_nobranch baseline-filter* noncode_differential* broken mismatchPath elidePath ./cover_db ./criteria ./mismatched ./navigation differential_prop proportion ./annotate ./current-* ./current_prefix* select select2 html_report ./usage ./errOut ./noNames
 
 if [ "x$COVER" != 'x' ] && [ 0 != $LOCAL_COVERAGE ] ; then
     cover -delete -db $COVER_DB
@@ -377,22 +377,67 @@ if [ 0 != $? ] ; then
     fi
 fi
 
+echo '' > names.data
+echo  -o noNames $DIFFCOV_OPTS $IGNORE --show-details --description names.data current_name.info.gz
+$COVER $GENHTML_TOOL -o noNames $DIFFCOV_OPTS $IGNORE --show-details --description names.data current_name.info.gz
+if [ 0 == $? ] ; then
+    echo "ERROR: expected fail due to missing descriptions - but passed"
+    status=1
+    if [ 0 == $KEEP_GOING ] ; then
+        exit 1
+    fi
+fi
+echo "TD: out of sequence" > names.data
+echo genhtml -o noNames $DIFFCOV_OPTS $IGNORE --show-details --description names.data current_name.info.gz
+$COVER $GENHTML_TOOL -o noNames $DIFFCOV_OPTS $IGNORE --show-details --description names.data current_name.info.gz
+if [ 0 == $? ] ; then
+    echo "ERROR: expected fail due to invalid sequence - but passed"
+    status=1
+    if [ 0 == $KEEP_GOING ] ; then
+        exit 1
+    fi
+fi
+
+
 # check that vanilla, flat, hierarchical work with and without prefix
+cat > names.data <<EOF
+TN:myTest
+TD:faking some test data
+# test empty description
+TN:unusedTest
+TD:
+EOF
+
     now=`date`
 for mode in '' '--flat' '--hierarchical' ; do
-    echo genhtml $DIFFCOV_OPTS $mode --show-details current.info --output-directory ./current$mode $IGNORE
-    $COVER $GENHTML_TOOL $mode $DIFFCOV_OPTS current.info --show-details --output-directory ./current$mode $IGNORE --current-date "$now"
+    echo genhtml $DIFFCOV_OPTS $mode --show-details current_name.info.gz --output-directory ./current$mode $IGNORE --description names.data
+    $COVER $GENHTML_TOOL $mode $DIFFCOV_OPTS current_name.info.gz --show-details --output-directory ./current$mode $IGNORE --current-date "$now" --description names.data
     if [ 0 != $? ] ; then
         echo "ERROR: genhtml current $mode failed"
         status=1
         if [ 0 == $KEEP_GOING ] ; then
             exit 1
         fi
     fi
+    # verify that the 'details' link is there:
+    #   index.html file should refer to 'show details'
+    if [ '' == "$mode" ] ; then
+        FILE=./current/simple/index.html
+    else
+        FILE=./current$mode/index.html
+    fi
+    grep 'show details' $FILE
+    if [ 0 != $? ] ; then
+        echo "ERROR: no testcase 'details' link"
+        status=1
+        if [ 0 == $KEEP_GOING ] ; then
+            exit 1
+        fi
+    fi
 
     # run again with prefix
-    echo genhtml $DIFFCOV_OPTS $mode --show-details current.info --output-directory ./current_prefix$mode $IGNORE --prefix `pwd`
-    $COVER $GENHTML_TOOL $mode $DIFFCOV_OPTS current.info --show-details --output-directory ./current_prefix$mode $IGNORE --prefix `pwd` --current-date "$now"
+    echo genhtml $DIFFCOV_OPTS $mode --show-details current_name.info.gz --output-directory ./current_prefix$mode $IGNORE --prefix `pwd`  --description names.data
+    $COVER $GENHTML_TOOL $mode $DIFFCOV_OPTS current_name.info.gz --show-details --output-directory ./current_prefix$mode $IGNORE --prefix `pwd` --current-date "$now"  --description names.data
     if [ 0 != $? ] ; then
         echo "ERROR: genhtml current $mode --prefix failed"
         status=1
@@ -476,8 +521,8 @@ for opt in "" --dark-mode --flat ; do
 done
 
 # check that this works with test names
-echo ${LCOV_HOME}/bin/genhtml $DIFFCOV_OPTS  --baseline-file ./baseline_name.info.gz --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode --ignore-errors source --simplified-colors -o differential_named ./current_name.info.gz $IGNORE
-$COVER ${GENHTML_TOOL} $DIFFCOV_OPTS --baseline-file ./baseline_name.info.gz --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode --ignore-errors source --simplified-colors -o differential_named ./current_name.info.gz $GENHTML_PORT $IGNORE
+echo ${LCOV_HOME}/bin/genhtml $DIFFCOV_OPTS  --baseline-file ./baseline_name.info.gz --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode --ignore-errors source --simplified-colors -o differential_named ./current_name.info.gz $IGNORE --description names.data
+$COVER ${GENHTML_TOOL} $DIFFCOV_OPTS --baseline-file ./baseline_name.info.gz --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode --ignore-errors source --simplified-colors -o differential_named ./current_name.info.gz $GENHTML_PORT $IGNORE --description names.data
 if [ 0 != $? ] ; then
     echo "ERROR: genhtml differential testname failed"
     status=1
