Chip away at more coverage spots

Author: NWilson

.github/workflows/build.yml

@@ -539,6 +539,8 @@ jobs:
           submodules: true
 
       - name: Configure
+        # We use DEBUG=OFF here in order to suppress the coverage misses due to
+        # assertions, which obviously always pass.
         run: CC="clang -fprofile-instr-generate -fcoverage-mapping" cmake $CMAKE_FLAGS -DCMAKE_BUILD_TYPE=Debug -DPCRE2_DEBUG=OFF -DPCRE2_SUPPORT_JIT=ON -DPCRE2_BUILD_PCRE2_16=ON -DPCRE2_BUILD_PCRE2_32=ON -DPCRE2_SUPPORT_LIBZ=ON -DPCRE2_SUPPORT_LIBBZ2=ON -DPCRE2_SUPPORT_LIBEDIT=ON -DPCRE2_SUPPORT_LIBREADLINE=OFF -B build
 
       - name: Build

RunTest

@@ -197,8 +197,9 @@ checkresult()
 
 checkspecial()
   {
+  expect=${2:-0}
   $sim $valgrind $vjs $pcre2test $1 >>testSoutput
-  if [ $? -ne 0 ] ; then
+  if [ $? -ne "$expect" ] ; then
     echo "** pcre2test $1 failed - check testSoutput"
     yield=1
     return 1
@@ -538,13 +539,19 @@ for bmode in "$test8" "$test16" "$test32"; do
     echo '   abc' >>testSinput
     echo '' >testSoutput
     saverc=0
-    checkspecial '-C' || saverc=$?
+    checkspecial "$bmode -C" || saverc=$?
     checkspecial '--help' || saverc=$?
     checkspecial "$bmode testSinput" || saverc=$?
     checkspecial "$bmode $testdata/testinputheap" || saverc=$?
     if [ $support_setstack -eq 0 ] ; then
       checkspecial "$bmode -S 1 -t 10 testSinput" || saverc=$?
     fi
+    checkspecial "$bmode reallydoesnotexist" 1 || saverc=$?
+    checkspecial "$bmode testSinput reallydoesnotexist/outfile" 1 || saverc=$?
+    checkspecial "$bmode -pattern debug testSinput" || saverc=$?
+    checkspecial "$bmode -pattern INVALID testSinput" 1 2>/dev/null || saverc=$?
+    checkspecial "$bmode -subject notempty testSinput" || saverc=$?
+    checkspecial "$bmode -subject INVALID testSinput" 1 2>/dev/null || saverc=$?
     checkspecial -LM || saverc=$?
     checkspecial -LP || saverc=$?
     checkspecial -LS || saverc=$?

maint/FilterCoverage.py

@@ -27,6 +27,17 @@ def scan_exclusions(srcpath):
             continue
         if in_block:
             excl.add(i)
+
+        # If line matches '^\s*#(if|endif|else|elif)\b', exclude it.
+        # For some reason, Clang likes to output coverage for these lines,
+        # even though they have no executable code.
+        if re.match(r'^\s*#(if|endif|else|elif|ifdef|ifndef)\b', line):
+            excl.add(i)
+
+        # Similarly, Clang seems to generate DA entries for "}" lines inside
+        # switch statements. Exclude these too.
+        if re.match(r'^\s*}\s*(/\*.*?\*/)?$', line):
+            excl.add(i)
     return excl
 
 DA_RE = re.compile(r'^\s*DA:(\d+),(\d+)(,.*)?\s*$')

maint/RunCoverage

@@ -9,11 +9,13 @@
 
 set -e
 
+clang_report=0
 nomalloc=0
 
 while [ $# -gt 0 ] ; do
   case $1 in
    nomalloc|-nomalloc) nomalloc=1;;
+   clang|-clang|clang-report|-clang-report) clang_report=1;;
    *) echo "Unknown option or test selector '$1'"; exit 1;;
   esac
   shift
@@ -44,26 +46,40 @@ PROF_FILES="coverage-*.profraw"
 llvm-profdata-$LLVM_VER merge -sparse $PROF_FILES -o coverage.profdata
 echo ""
 
-# Output LCOV-compatible output, for downstream tools
-echo "== Generating LCOV report =="
-llvm-cov-$LLVM_VER export \
-  -format=lcov \
-  -instr-profile=coverage.profdata \
-  ./pcre2test -object ./pcre2grep -object ./pcre2posix_test -object ./pcre2_jit_test \
-  -sources ../src/ ./ \
-  > ./coverage-lcov.info
-echo ""
+if [ "$clang_report" -eq 1 ]; then
+  echo "== Generating Clang coverage report =="
+  llvm-cov-$LLVM_VER show \
+    -format=html \
+    -show-line-counts-or-regions -show-branches=percent \
+    -instr-profile=coverage.profdata \
+    ./pcre2test -object ./pcre2grep -object ./pcre2posix_test -object ./pcre2_jit_test \
+    -sources ../src/ ./ \
+    -output-dir=coverage-html
+  echo ""
 
-# Filter out lines marked with "LCOV_EXCL_LINE" or "LCOV_EXCL_START"/"LCOV_EXCL_STOP"
-echo "== Filtering LCOV report =="
-python3 ../maint/FilterCoverage.py ./coverage-lcov.info > ./coverage-lcov.filtered.info
-mv ./coverage-lcov.filtered.info ./coverage-lcov.info
-echo ""
+else
+  # Output LCOV-compatible output, for downstream tools
+  echo "== Generating LCOV report =="
+  llvm-cov-$LLVM_VER export \
+    -format=lcov \
+    -instr-profile=coverage.profdata \
+    ./pcre2test -object ./pcre2grep -object ./pcre2posix_test -object ./pcre2_jit_test \
+    -sources ../src/ ./ \
+    > ./coverage-lcov.info
+  echo ""
 
-# Use genhtml to generate an HTML report from the LCOV data
-echo "== Generating HTML report =="
-mkdir -p coverage-html
-genhtml \
-  --highlight --branch-coverage --legend --title "PCRE2 code coverage report" --num-spaces 2 \
-  -o coverage-html ./coverage-lcov.info
-echo ""
+  # Filter out lines marked with "LCOV_EXCL_LINE" or "LCOV_EXCL_START"/"LCOV_EXCL_STOP"
+  echo "== Filtering LCOV report =="
+  python3 ../maint/FilterCoverage.py ./coverage-lcov.info > ./coverage-lcov.filtered.info
+  mv ./coverage-lcov.filtered.info ./coverage-lcov.info
+  echo ""
+
+  # Use genhtml to generate an HTML report from the LCOV data
+  echo "== Generating HTML report =="
+  mkdir -p coverage-html
+  genhtml \
+    --highlight --branch-coverage --legend --title "PCRE2 code coverage report" --num-spaces 2 \
+    -o coverage-html ./coverage-lcov.info
+  echo ""
+
+fi

src/pcre2_context.c

@@ -502,10 +502,7 @@ return 0;
 }
 
 /* These functions became obsolete at release 10.30. The first is kept as a
-synonym for backwards compatibility. The second now does nothing. Exclude both
-from coverage reports. */
-
-/* LCOV_EXCL_START */
+synonym for backwards compatibility. The second now does nothing. */
 
 PCRE2_EXP_DEFN int PCRE2_CALL_CONVENTION
 pcre2_set_recursion_limit(pcre2_match_context *mcontext, uint32_t limit)
@@ -525,8 +522,6 @@ pcre2_set_recursion_memory_management(pcre2_match_context *mcontext,
 return 0;
 }
 
-/* LCOV_EXCL_STOP */
-
 
 /* ------------ Convert context ------------ */
 

src/pcre2_util.h

@@ -71,6 +71,8 @@ side-effects. */
 } while(0)
 #endif
 
+/* LCOV_EXCL_START */
+
 /* PCRE2_UNREACHABLE() can be used to mark locations on the code that
 shouldn't be reached. In non debug builds is defined as a hint for
 the compiler to eliminate any code after it, so it is useful also for
@@ -107,8 +109,16 @@ the reason and the actions that should be taken if it ever triggers. */
 
 #define PCRE2_DEBUG_UNREACHABLE() PCRE2_UNREACHABLE()
 
+/* LCOV_EXCL_STOP */
+
 #endif /* PCRE2_DEBUG */
 
+#ifndef PCRE2_ASSERT
+#define PCRE2_ASSERT(x) do {} while(0)
+#endif
+
+/* LCOV_EXCL_START */
+
 #ifndef PCRE2_DEBUG_UNREACHABLE
 #define PCRE2_DEBUG_UNREACHABLE() do {} while(0)
 #endif
@@ -123,9 +133,7 @@ the reason and the actions that should be taken if it ever triggers. */
 #endif
 #endif /* !PCRE2_UNREACHABLE */
 
-#ifndef PCRE2_ASSERT
-#define PCRE2_ASSERT(x) do {} while(0)
-#endif
+/* LCOV_EXCL_STOP */
 
 /* We define this fallthrough macro for suppressing -Wimplicit-fallthrough warnings.
 Clang only allows this via an attribute, whereas other compilers (eg. GCC) match attributes

src/pcre2posix.c

@@ -331,10 +331,8 @@ preg->re_erroffset = (size_t)(-1);  /* No meaning after successful compile */
 
 if (preg->re_match_data == NULL)
   {
-  /* LCOV_EXCL_START */
   pcre2_code_free(preg->re_pcre2_code);
   return REG_ESPACE;
-  /* LCOV_EXCL_STOP */
   }
 
 return 0;

src/pcre2test.c

@@ -781,7 +781,7 @@ static modstruct modlist[] = {
   { "never_callout",               MOD_CTC,  MOD_OPT, PCRE2_EXTRA_NEVER_CALLOUT,  CO(extra_options) },
   { "never_ucp",                   MOD_PAT,  MOD_OPT, PCRE2_NEVER_UCP,            PO(options) },
   { "never_utf",                   MOD_PAT,  MOD_OPT, PCRE2_NEVER_UTF,            PO(options) },
-  { "newline",                     MOD_CTC,  MOD_NL,  0,                          CO(newline_convention) },
+  { "newline",                     MOD_CTC,  MOD_NL,  0,                          0 },
   { "no_auto_capture",             MOD_PAT,  MOD_OPT, PCRE2_NO_AUTO_CAPTURE,      PO(options) },
   { "no_auto_possess",             MOD_PATP, MOD_OPT, PCRE2_NO_AUTO_POSSESS,      PO(options) },
   { "no_bs0",                      MOD_CTC,  MOD_OPT, PCRE2_EXTRA_NO_BS0,         CO(extra_options) },