Check for consistency between baseline coverage DB, current coverage

DB, and 'diff' file data:
If file is present in both baseline and current coverage data:
  - if version is not the same:  expect to find file in 'diff' data.
  - if version is the same:  expect to NOT find in 'diff' data.

If file is not in 'current' DB: then it is no longer part of the project -
so we dont' care about differences.
If file is not present in 'baseline':  then it was recently added to the
project - so we are not looking at differences.

Checks motivated by report in issue #315.

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

Author: henry2cox

bin/genhtml

@@ -3339,6 +3339,51 @@ sub dump_map
     return $self;
 }
 
+sub check_version_match
+{
+    my ($self, $baseline, $current) = @_;
+    return unless $lcovutil::versionCallback;
+
+    # skip files which were dropped (no longer in project) or were
+    #  just added to the project (was not in the baseline - so we aren't
+    #  looking for differences.
+    foreach my $curr ($current->files()) {
+        next unless $baseline->file_exists($curr);
+        my $currData     = $current->data($curr);
+        my $curr_version = $currData->version();
+        my $baseData     = $baseline->data($curr);
+        my $base_version = $baseData->version();
+
+        # silently compare version...
+        my $versionMatch =
+            lcovutil::checkVersionMatch($curr, $base_version, $curr_version,
+                                        "diff entry compare", 1);
+        if ($self->containsFile($curr)) {
+            # file is in 'diff' data:  we expect the version to be different
+            #   between baseline/current
+            if ($versionMatch) {
+                lcovutil::ignorable_error($lcovutil::ERROR_INCONSISTENT_DATA,
+                               "File \"$curr\" appears in 'diff' data file '" .
+                                   $self->[DIFF_FILENAME] .
+                                   "' but 'baseline' and 'current' versions '" .
+                                   ($curr_version ? $curr_version : '<undef>') .
+                                   "' match");
+            }
+        } else {
+            # not in 'diff':  we expect the versions to be identical
+            if (!$versionMatch) {
+                lcovutil::ignorable_error($lcovutil::ERROR_INCONSISTENT_DATA,
+                              "File \"$curr\" version changed from '" .
+                                  ($base_version ? $base_version : '<undef') .
+                                  "' to '" .
+                                  ($curr_version ? $curr_version : '<undef>') .
+                                  "' but file not found in 'diff' data file '" .
+                                  $self->[DIFF_FILENAME] . "'.");
+            }
+        }
+    }
+}
+
 sub check_path_consistency
 {
     # check that paths which appear in diff also appear in baseline or current
@@ -3350,6 +3395,11 @@ sub check_path_consistency
     (ref($baseline) eq 'TraceFile' && ref($current) eq 'TraceFile') or
         die("wrong arg types");
 
+    # check that files which are in both baseline and current and are NOT
+    # in the 'diff' data have the same version.
+    # That is:  files whose version differs should appear in the diff data
+    $self->check_version_match($baseline, $current);
+
     my %diffMap;
     my %diffBaseMap;
     foreach my $f ($self->files()) {

lib/lcovutil.pm

@@ -6338,6 +6338,13 @@ sub _filterFile
     my $path = ReadCurrentSource::resolve_path($source_file);
     lcovutil::info(1, "extractVersion($path) for $source_file\n")
         if $path ne $source_file;
+    # Note:  this is checking the version of the 'current' file - even if
+    #   we are actually reading the baseline version.
+    #   - This is what we want, as the 'baseline read' is actually recovering/
+    #     recreating the baseline source fromthe current source and the diff.
+    #   - We already checked that the diff and the coverage DB baseline/current
+    #     version data is consistent - so filtering will be accurate as long as
+    #     we see the right 'current' source version.
     my $fileVersion = lcovutil::extractFileVersion($path)
         if $srcReader->notEmpty();
     if (defined($fileVersion) &&

tests/gendiffcov/function/function.sh

@@ -265,8 +265,8 @@ fi
 for base in baseline_call baseline_nocall ; do
     for curr in current_call current_nocall ; do
         OUT=${base}_${curr}
-        echo genhtml -o $OUT $DIFFCOV_OPTS --baseline-file ${base}.info --diff-file diff.txt ${curr}.info
-        $COVER $GENHTML_TOOL -o $OUT $DIFFCOV_OPTS --baseline-file ${base}.info --diff-file diff.txt ${curr}.info --elide-path
+        echo genhtml -o $OUT $DIFFCOV_OPTS --baseline-file ${base}.info --diff-file diff.txt ${curr}.info --ignore inconsistent
+        $COVER $GENHTML_TOOL -o $OUT $DIFFCOV_OPTS --baseline-file ${base}.info --diff-file diff.txt ${curr}.info --elide-path --ignore inconsistent
         if [ $? != 0 ] ; then
             echo "genhtml $OUT failed"
             if [ 0 == $KEEP_GOING ] ; then

tests/gendiffcov/insensitive/insensitive.sh

@@ -233,8 +233,8 @@ ln -s ../simple/simple2.cpp.annotated TEst.cpp.annotated
 #  need to not do the exiistence callback because the 'insensitive' name
 #  won't be found but the version-check in the .info file already contains
 #  a value - so we would get a version check error
-echo genhtml $DIFFCOV_OPTS  --baseline-file ./baseline.info --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode -o differential ./current.info --rc case_insensitive=1 --ignore-annotate,source $IGNORE --rc check_existence_before_callback=0
-$COVER $GENHTML_TOOL $DIFFCOV_OPTS  --baseline-file ./baseline.info --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode -o differential ./current.info --rc case_insensitive=1 $GENHTML_PORT --ignore annotate,source $IGNORE --rc check_existence_before_callback=0
+echo genhtml $DIFFCOV_OPTS  --baseline-file ./baseline.info --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode -o differential ./current.info --rc case_insensitive=1 --ignore-annotate,source $IGNORE --rc check_existence_before_callback=0 --ignore inconsistent
+$COVER $GENHTML_TOOL $DIFFCOV_OPTS  --baseline-file ./baseline.info --diff-file diff.txt --annotate-script `pwd`/annotate.sh --show-owners all --show-noncode -o differential ./current.info --rc case_insensitive=1 $GENHTML_PORT --ignore annotate,source $IGNORE --rc check_existence_before_callback=0 --ignore inconsistent
 if [ 0 != $? ] ; then
     echo "ERROR: genhtml differential failed"
     if [ 0 == $KEEP_GOING ] ; then