Add '--msg-log [filename]' option - to save error and warning

messages to another location - to simplify debugging.

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

Author: henry2cox

README

@@ -1,6 +1,6 @@
 -------------------------------------------------
 - README file for the LTP GCOV extension (LCOV) -
-- Last changes: 2024-09-13
+- Last changes: 2024-10-03
 -------------------------------------------------
 
 Description
@@ -317,7 +317,7 @@ New features and capabilities fall into 7 major categories:
      ignored.
 
      Related options:
-        --ignore-error, --expect-message-count, --keep-going
+        --ignore-error, --expect-message-count, --keep-going, --msg-log
 
   c) Navigation and display:
 

bin/genhtml

@@ -6420,7 +6420,10 @@ my %genhtml_options = ("output-directory|o=s" => \$output_directory,
                        "suppress-aliases"  => \$suppress_function_aliases,
                        'validate'          => \$validateHTML,);
 # Parse command line options
-if (!lcovutil::parseOptions(\%genhtml_rc_opts, \%genhtml_options)) {
+if (
+    !lcovutil::parseOptions(\%genhtml_rc_opts, \%genhtml_options,
+                            \$output_directory)
+) {
     print(STDERR "Use $tool_name --help to get usage information\n");
     exit(1);
 }

bin/geninfo

@@ -260,7 +260,8 @@ my %geninfo_opts = ("test-name|t=s"       => \$test_name,
                     "compat=s"            => \$lcovutil::geninfo_opt_compat,);
 
 # Parse command line options
-if (!lcovutil::parseOptions(\%lcovutil::geninfo_rc_opts, \%geninfo_opts)) {
+if (!lcovutil::parseOptions(\%lcovutil::geninfo_rc_opts, \%geninfo_opts,
+                            \$output_filename)) {
     print(STDERR "Use $tool_name --help to get usage information\n");
     exit(1);
 }

bin/lcov

@@ -244,7 +244,8 @@ my %lcov_options = ("directory|d|di=s"     => \@directory,
 my %mergedRcOpts = (%lcov_rc_params, %lcovutil::geninfo_rc_opts);
 
 # Parse command line options
-if (!lcovutil::parseOptions(\%mergedRcOpts, \%lcov_options)) {
+if (!lcovutil::parseOptions(\%mergedRcOpts, \%lcov_options, \$output_filename))
+{
     print(STDERR "Use $tool_name --help to get usage information\n");
     exit(1);
 }

lib/lcovutil.pm

@@ -21,6 +21,7 @@ use Getopt::Long;
 use DateTime;
 use Config;
 use POSIX;
+use Fcntl qw(:flock SEEK_END);
 
 our @ISA       = qw(Exporter);
 our @EXPORT_OK = qw($tool_name $tool_dir $lcov_version $lcov_url $VERSION
@@ -102,6 +103,7 @@ our @ignore;
 our @message_count;
 our @expected_message_count;
 our %message_types;
+our $message_log;
 our $suppressAfter = 100;    # stop warning after this number of messages
 our %ERROR_ID;
 our %ERROR_NAME;
@@ -595,7 +597,15 @@ sub _msg_handler
     $msg =~ s/^(error|warning):\s+//i;
     my $type = $error ? 'ERROR' : 'WARNING';
 
-    return "$tool_name: $type: $msg";
+    my $txt = "$tool_name: $type: $msg";
+    if ($message_log && 'GLOB' eq ref($message_log)) {
+        flock($message_log, LOCK_EX);
+        # don't bother to seek...assume modern O_APPEND semantics
+        #seek($message_log, 0, SEEK_END);
+        print $message_log $txt;
+        flock($message_log, LOCK_UN);
+    }
+    return $txt;
 }
 
 sub warn_handler($$)
@@ -1230,6 +1240,7 @@ our %argCommon = ("tempdir=s"         => \$tempdirname,
                   "demangle-cpp:s"         => \@lcovutil::cpp_demangle,
                   "ignore-errors=s"        => \@opt_ignore_errors,
                   "expect-message-count=s" => \@opt_expected_message_counts,
+                  'msg-log:s'              => \$message_log,
                   "keep-going"             => \$keepGoing,
                   "config-file=s"          => \@unsupported_config,
                   "rc=s%"                  => \%unsupported_rc,
@@ -1429,7 +1440,7 @@ sub apply_rc_params($)
 
 sub parseOptions
 {
-    my ($rcOptions, $cmdLineOpts) = @_;
+    my ($rcOptions, $cmdLineOpts, $output_arg) = @_;
 
     apply_rc_params($rcOptions);
 
@@ -1442,7 +1453,6 @@ sub parseOptions
         die("'" . $d->[0] . "' option name cannot be abbreviated\n")
             if ($d->[1]);
     }
-
     if ($help) {
         main::print_usage(*STDOUT);
         exit(0);
@@ -1452,6 +1462,19 @@ sub parseOptions
         print("$tool_name: $lcov_version\n");
         exit(0);
     }
+    if (defined($message_log)) {
+        if (!$message_log) {
+            # base log file name on output arg (if specified) or tool name otherwise
+            $message_log = (
+                        defined($$output_arg) ?
+                            substr($$output_arg, 0, rindex($$output_arg, '.')) :
+                            $tool_name) .
+                ".msg";
+        }
+        open(LOG, ">", $message_log) or
+            die("unable to write message log '$message_log': $!");
+        $message_log = \*LOG;
+    }
 
     lcovutil::init_verbose_flag($quiet);
     # apply the RC file settings if no command line arg

man/genhtml.1

@@ -83,6 +83,9 @@ genhtml \- Generate HTML view from LCOV coverage data files
 .RB [ \-\-demangle\-cpp
 .IR [ param ] ]
 .br
+.RB [ \-\-msg\-log
+.IR [ log_file_name ] ]
+.br
 .RB [ \-\-ignore\-errors
 .IR errors  ]
 .br
@@ -2717,6 +2720,17 @@ parameter works.  In that case, you callback will be executed as:
 .I | demangle_param0 demangle_param1 ...
 Note that the demangle tool is called as a pipe and is expected to read from stdin and write to stdout.
 
+.RE
+.B \-\-msg\-log
+.I [ log_file_name ]
+.br
+.RS
+Specify location to store error and warning messages (in addition to writing to STDERR).
+If
+.I log_file_name
+is not specified, then default location is used.
+.RE
+
 .RE
 .B \-\-ignore\-errors
 .I errors

man/geninfo.1

@@ -52,6 +52,9 @@ geninfo \- Generate tracefiles from GCOV coverage data files
 .RB [ \-\-memory
 .IR integer_num_Mb ]
 .br
+.RB [ \-\-msg\-log
+.IR [ log_file_name ] ]
+.br
 .RB [ \-\-ignore\-errors
 .IR errors ]
 .br
@@ -786,6 +789,16 @@ option
 .IR forget_testcase_names .
 .RE
 
+.B \-\-msg\-log
+.I [ log_file_name ]
+.br
+.RS
+Specify location to store error and warning messages (in addition to writing to STDERR).
+If
+.I log_file_name
+is not specified, then default location is used.
+.RE
+
 .B \-\-ignore\-errors
 .I errors
 .br

man/lcov.1

@@ -53,6 +53,9 @@ Capture coverage data tracefile (from compiler-generated data):
 .RB [ \-\-compat\-libtool ]
 .RB [ \-\-no\-compat\-libtool ]
 .br
+.RB [ \-\-msg\-log
+.IR [ log_file_name ] ]
+.br
 .RB [ \-\-ignore\-errors
 .IR errors ]
 .br
@@ -1276,6 +1279,16 @@ path of each source file.
 If you specify a pattern which does not seem to be correctly applied - files that you expected to be included in the output do not appear - lcov will generate an error message of type 'unused'.  See the \-\-ignore\-errors option for how to make lcov ignore the error or turn it into a warning.
 .RE
 
+.B \-\-msg\-log
+.I [ log_file_name ]
+.br
+.RS
+Specify location to store error and warning messages (in addition to writing to STDERR).
+If
+.I log_file_name
+is not specified, then default location is used.
+.RE
+
 .B \-\-ignore\-errors
 .I errors
 .br

tests/gendiffcov/simple/script.sh

@@ -133,7 +133,7 @@ DIFFCOV_OPTS="$DIFFCOV_NOFRAME_OPTS --frame"
 #DIFFCOV_OPTS="--function-coverage --branch-coverage --demangle-cpp --frame"
 #DIFFCOV_OPTS='--function-coverage --branch-coverage --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 names.data linked.cpp linked_diff.txt
+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 linked.cpp linked_diff.txt *.msg
 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 no_source linked linked_err linked_elide linked_dir failUnder expect_err expect
 
 if [ "x$COVER" != 'x' ] && [ 0 != $LOCAL_COVERAGE ] ; then
@@ -1606,16 +1606,25 @@ fi
 grep -E "ERROR:.*count.*'usage' contraint .+ is not true" expect_err.log
 
 # now skip the count message too
-echo genhtml $DIFFCOV_OPTS --output-directory ./expect --rc memory_percentage --rc -memory_percentage=50 baseline_orig.info --ignore usage,count --rc expect_message_count=usage:1
-$COVER $GENHTML_TOOL $DIFFCOV_OPTS --output-directory ./expect --rc memory_percentage --rc percent=5 baseline_orig.info --ignore usage,count $IGNORE --rc expect_message_count=usage:1 2>&1 | tee expect.log
+echo genhtml $DIFFCOV_OPTS --output-directory ./expect --rc memory_percentage --rc -memory_percentage=50 baseline_orig.info --ignore usage,count --rc expect_message_count=usage:1 --msg-log
+$COVER $GENHTML_TOOL $DIFFCOV_OPTS --output-directory ./expect --rc memory_percentage --rc percent=5 baseline_orig.info --ignore usage,count $IGNORE --rc expect_message_count=usage:1 --msg-log 2>&1 | tee expect.log
 if [ 0 != ${PIPESTATUS[0]} ] ; then
     echo "ERROR: didn't skip expect count error"
     status=1
     if [ 0 == $KEEP_GOING ] ; then
         exit 1
     fi
 fi
-grep -E "WARNING:.*count.*'usage' contraint .+ is not true" expect_err.log
+
+grep -E "WARNING:.*count.*'usage' contraint .+ is not true" expect.msg
+if [ 0 == $? ] ; then
+    echo "ERROR: didn't find expected msg in log"
+    status=1
+    if [ 0 == $KEEP_GOING ] ; then
+        exit 1
+    fi
+fi
+
 
 
 echo $SPREADSHEET_TOOL -o results.xlsx `find . -name "*.json"`

tests/lcov/extract/extract.sh

@@ -107,7 +107,7 @@ if [ "${VER[0]}" -lt 5 ] ; then
     FILTER='--filter branch'
 fi
 
-rm -rf *.gcda *.gcno a.out *.info* *.txt* *.json dumper* testRC *.gcov *.gcov.* *.log *.o errs
+rm -rf *.gcda *.gcno a.out *.info* *.txt* *.json dumper* testRC *.gcov *.gcov.* *.log *.o errs *.msg
 rm -rf rcOptBug
 
 if [ -d separate ] ; then
@@ -845,28 +845,52 @@ fi
 mkdir -p errs
 rm -f errs/*
 ( cd errs ; ln -s ../extract.gcda ; ln -s ../missing.gcno extract.gcno )
-$COVER $CAPTURE errs $LCOV_OPTS -o err1.info $FILTER $IGNORE
+$COVER $CAPTURE errs $LCOV_OPTS -o err1.info $FILTER $IGNORE --msg-log
 if [ 0 == $? ] ; then
     echo "Error:  expected error code from lcov --capture"
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
 fi
-$COVER $CAPTURE errs $LCOV_OPTS -o err2.info $FILTER $IGNORE --initial
+grep ERROR: err1.msg
+if [ 0 != $? ] ; then
+    echo "Error:  expected error message not foune"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+
+$COVER $CAPTURE errs $LCOV_OPTS -o err2.info $FILTER $IGNORE --initial --msg-log
 if [ 0 == $? ] ; then
     echo "Error:  expected error code from lcov --capture --initial"
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
 fi
-$COVER $CAPTURE errs $LCOV_OPTS -o err3.info $FILTER $IGNORE --initial --ignore path
+grep ERROR: err2.msg
+if [ 0 != $? ] ; then
+    echo "Error:  expected error message 2 not foune"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+
+$COVER $CAPTURE errs $LCOV_OPTS -o err3.info $FILTER $IGNORE --initial --ignore path --msg-log err.3.msg
 if [ 0 == $? ] ; then
     echo "Error:  expected error code from lcov --capture --initial --ignore"
     if [ $KEEP_GOING == 0 ] ; then
         exit 1
     fi
 fi
-$COVER $CAPTURE errs $LCOV_OPTS -o err4.info $FILTER $IGNORE --initial --keep-going
+grep ERROR: err.3.msg
+if [ 0 != $? ] ; then
+    echo "Error:  expected error message 3 not foune"
+    if [ $KEEP_GOING == 0 ] ; then
+        exit 1
+    fi
+fi
+
+$COVER $CAPTURE errs $LCOV_OPTS -o err4.info $FILTER $IGNORE --initial --keep-going --msg-log
 if [ 0 == $? ] ; then
     echo "Error:  expected error code from lcov --capture --initial --keep-going"
     if [ $KEEP_GOING == 0 ] ; then