Bugfix: fix linux-test-project#253 - broken geninfo_adjust_src_path RC option.

Also deprecate the option in favor of 'substitute = ....' - which is
more general and does better error checking.

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

Author: henry2cox

bin/geninfo

@@ -320,25 +320,18 @@ $buildDirSearchPath =
 # Check regexp
 if (defined($rc_adjust_src_path)) {
     my ($pattern, $replace) = split(/\s*=>\s*/, $rc_adjust_src_path);
-    local $SIG{__DIE__};
-    my $src_pattern;
-    eval '$src_pattern = qr>' . $pattern . '>;';
-    if (!defined($src_pattern)) {
-        my $msg = $@;
-
-        chomp($msg);
-        $msg =~ s/at \(eval.*$//;
+    # If no replacement is specified, simply remove pattern
+    $replace = '' unless defined($replace);
+    my $p = "s#$pattern#$replace#g";
+    $p .= 'i' if $lcovutil::case_insensitive;
+    my $text = 'abc';
+    my $str  = eval { '$test =~ ' . $p . ';' };
+    if ($@) {
         lcovutil::ignorable_error($lcovutil::ERROR_FORMAT,
-                          "invalid pattern in geninfo_adjust_src_path: $msg\n");
-
+            "Invalid 'geninfo_adjust_src_path=$rc_adjust_src_path' syntax: '$@'"
+        );
     } else {
-        if (!defined($replace)) {
-            # If no replacement is specified, simply remove pattern
-            $replace = "";
-        }
-        my $p = 's#$pattern#$replace#g';
-        push(@lcovutil::file_subst_patterns,
-             [lcovutil::transform_pattern($p), $p, 0]);
+        push(@lcovutil::file_subst_patterns, [$p, 0]);
     }
 }
 

lib/lcovutil.pm

@@ -1022,6 +1022,7 @@ my %deprecated_rc = ("genhtml_demangle_cpp"        => "demangle_cpp",
                      "genhtml_demangle_cpp_params" => "demangle_cpp",
                      "geninfo_checksum"            => "checksum",
                      "geninfo_no_exception_branch" => "no_exception_branch",
+                     'geninfo_adjust_src_path'     => 'substitute',
                      "lcov_branch_coverage"        => "branch_coverage",
                      "lcov_function_coverage"      => "function_coverage",
                      "genhtml_function_coverage"   => "function_coverage",
@@ -1294,7 +1295,7 @@ sub parseOptions
             lcovutil::ignorable_warning($lcovutil::ERROR_DEPRECATED,
                 "RC option '$key' is deprecated.  Consider using '" .
                     $deprecated_rc{$key} .
-                    ". instead.  (Backward-compatible support will be removed in the future"
+                    "'. instead.  (Backward-compatible support will be removed in the future"
             );
         }
     }

tests/lcov/extract/extract.sh

@@ -170,6 +170,30 @@ if [ $COUNT != '1' ] ; then
     exit 1
 fi
 
+# use legacy RC 'geninfo_adjust_src_path option (had been a bug)
+$COVER $LCOV_HOME/bin/lcov --capture $LCOV_OPTS --capture --no-external --directory . -o rcOptBug $PARALLEL $PROFILE --rc "geninfo_adjust_src_path='/tmp/foo => /build/bar'" --ignore unused 2>&1 | tee rcOptBug.log
+if [ 0 != $? ] ; then
+    echo "Error:  extract with RC option failed"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+grep -E "'substitute' pattern .+ is unused" rcOptBug.log
+if [ 0 != $? ] ; then
+    echo "Error:  missing RC pattern unused message"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+grep -E "RC option 'geninfo_adjust_src_path' is deprecated" rcOptBug.log
+if [ 0 != $? ] ; then
+    echo "Error:  missing RC pattern unused message"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+
+
 # workaround:  depending on compiler verision, we see a coverpoint on the
 #  close brace line (gcc/6 for example) or we don't (gcc/10 for example)
 BRACE_LINE='^DA:28'
@@ -422,7 +446,7 @@ done
 chmod ugo-rx separate/run/my/test/no_read
 $COVER $LCOV_HOME/bin/lcov --capture --branch-coverage $PARALLEL $PROFILE --build-directory separate/copy -d separate/run/my/test -o unreadable.info $FILTER $IGNORE 2>&1 | tee err.log
 if [ 0 == ${PIPESTATUS[0]} ] ; then
-    echo "Error:  expected fail from unreadable dire"
+    echo "Error:  expected fail from unreadable dir"
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
@@ -438,7 +462,7 @@ fi
 
 $COVER $LCOV_HOME/bin/lcov --capture --branch-coverage $PARALLEL $PROFILE --build-directory separate/copy -d separate/run/my/test -o unreadable.info $FILTER $IGNORE --ignore utility 2>&1 | tee warn.log
 if [ 0 != ${PIPESTATUS[0]} ] ; then
-    echo "Error:  extract from unreadbale failed"
+    echo "Error:  extract from unreadable failed"
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi