Add checksum support to py2lcov, perl2lcov

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

Author: henry2cox

bin/perl2lcov

@@ -192,6 +192,11 @@ foreach my $db (@ARGV) {
                               "unable to process $file without statement data");
             next;
         }
+        if ($lcovutil::verify_checksum &&
+            !-f $file) {
+            lcovutil::ignorable_error($lcovutil::ERROR_SOURCE,
+                              "cannot read '$f': unable to compute --checksum");
+        }
         my $version = lcovutil::extractFileVersion($file) if -f $file;
         $fileData->version($version) if defined($version) && $version ne '';
 
@@ -321,7 +326,7 @@ foreach my $db (@ARGV) {
 
 $info->applyFilters();
 $info->add_comments(@lcovutil::comments);
-$info->write_info_file($output_file);
+$info->write_info_file($output_file, $lcovutil::verify_checksum);
 
 lcovutil::warn_file_patterns();
 lcovutil::summarize_cov_filters();

bin/py2lcov

@@ -44,6 +44,14 @@ import xml.etree.ElementTree as ET
 import fnmatch
 import subprocess
 import copy
+import base64
+import hashlib
+
+def line_hash(line: str) -> str:
+    """Produce a hash of a source line for use in the LCOV file."""
+    hashed = hashlib.md5(line.encode("utf-8")).digest()
+    return base64.b64encode(hashed).decode("ascii").rstrip("=")
+
 
 class ProcessFile:
     def __init__(self, scriptArgs):
@@ -344,7 +352,16 @@ class ProcessFile:
                 self._outf.write("FN:%(start)d,%(end)d,%(name)s\nFNDA:%(hit)d,%(name)s\n" % f)
             # print the LCOV line data.
             for lineNo in sorted(lineData.keys()):
-                self._outf.write("DA:%d,%d\n" % (lineNo, lineData[lineNo]));
+                checksum = ''
+                if self._args.checksum:
+                    try:
+                        checksum = ',' + line_hash(lines[lineNo])
+                    except IndexError as err:
+                        print('"%s":%d: unable to compute checksum for missing line' % (filename, lineNo))
+                        if not self._args.keepGoing:
+                            raise(err)
+
+                self._outf.write("DA:%d,%d%s\n" % (lineNo, lineData[lineNo], checksum));
 
             # print the LCOV totals - not used by lcov, but maybe somebody does
             for key in totals:
@@ -406,6 +423,9 @@ Example:
                         help="print debug messages")
     parser.add_argument('--version-script', dest='version',
                         help="version extract callback")
+    parser.add_argument('--checksum', dest='checksum', action='store_true',
+                        default=False,
+                        help="compute line checksum - see 'man lcov'")
     parser.add_argument("--no-functions", dest='deriveFunctions',
                         default=True, action='store_false',
                         help="do not derive function coverpoints")

lib/lcovutil.pm

@@ -6584,15 +6584,15 @@ sub _read_info
                 }
 
                 # Store line checksum if available
-                if (defined($checksum)) {
+                if (defined($checksum) &&
+                    $lcovutil::verify_checksum) {
                     # Does it match a previous definition
                     if ($fileData->check()->mapped($line) &&
                         ($fileData->check()->value($line) ne $checksum)) {
                         lcovutil::ignorable_error($lcovutil::ERROR_VERSION,
                             "checksum mismatch at $filename:$line in $tracefile"
                         );
                     }
-
                     $fileData->check()->replace($line, $checksum);
                 }
                 last;
@@ -6898,14 +6898,8 @@ sub write_info($$$)
             print(INFO_HANDLE "VER:" . $entry->version() . "\n")
                 if defined($entry->version());
             if (defined($srcReader)) {
-                $srcReader->close();
-                if (is_c_file($source_file)) {
-                    lcovutil::info(1,
-                                   "reading $source_file for lcov checksum\n");
-                    $srcReader->open($source_file);
-                } else {
-                    lcovutil::debug("not reading $source_file: no ext match\n");
-                }
+                lcovutil::info(1, "reading $source_file for lcov checksum\n");
+                $srcReader->open($source_file);
             }
 
             my $functionMap = $testfncdata->{$testname};
@@ -7010,7 +7004,8 @@ sub write_info($$$)
                 if ($verify_checksum) {
                     if (exists($checkdata->{$line})) {
                         $chk = $checkdata->{$line};
-                    } elsif (defined($srcReader)) {
+                    } elsif (defined($srcReader) &&
+                             $srcReader->notEmpty()) {
                         my $content = $srcReader->getLine($line);
                         $chk = Digest::MD5::md5_base64($content);
                     }

tests/perl2lcov/perltest1.sh

@@ -138,6 +138,25 @@ if [ "$G" != 'FN:6,8,global1' ] ; then
     exit 1
 fi
 
+# run again, collecting checksum..
+$COVER ${EXEC_COVER} $PERL2LCOV_TOOL --output checksum.info --testname testCheck ./cover_one --checksum
+if [ 0 != $? ] ; then
+    echo "perl2lcov checksum failed"
+fi
+
+# do we see the checksums we expect?
+# expect to see checksum on each DA line..
+for l in `grep -E '^DA:' checksum.info` ; do
+    echo $l | grep -E 'DA:[0-9]+,[0-9]+,.+'
+    if [ 0 != $? ] ; then
+        echo "no checksum in '$l'"
+        if [ 0 == $KEEP_GOING ] ; then
+            exit 1
+        fi
+    fi
+done
+
+
 $COVER ${EXEC_COVER} $PERL2LCOV_TOOL --help
 if [ 0 != $? ] ; then
     echo "perl2lcov help failed"

tests/py2lcov/py2lcov.sh

@@ -221,6 +221,26 @@ if [ 0 != $? ] ; then
     fi
 fi
 
+# run again, generating checksum data...
+eval ${PYCOV} ${PY2LCOV_TOOL} -o checksum.info functions.dat $VERSION --checksum
+if [ 0 != $? ] ; then
+    echo "py2lcov failed function example"
+    if [ 0 == $KEEP_GOING ] ; then
+        exit 1
+    fi
+fi
+
+# expect to see checksum on each DA line..
+for l in `grep -E '^DA:' checksum.info` ; do
+    echo $l | grep -E 'DA:[0-9]+,[0-9]+,.+'
+    if [ 0 != $? ] ; then
+        echo "no checksum in '$l'"
+        if [ 0 == $KEEP_GOING ] ; then
+            exit 1
+        fi
+    fi
+done
+
 # run without generating function data:
 eval ${PYCOV} ${PY2LCOV_TOOL} functions.dat -o no_functions.info $VERSION --no-function
 if [ 0 != $? ] ; then