Fix coverage measurement on macos-26

Author: tsjensen

.github/workflows/boxes.yml

@@ -62,11 +62,13 @@ jobs:
         steps:
             - uses: actions/checkout@v6
 
-            # We need to use GNU grep, sed, and xargs on macOS
+            # We need GNU userland tools and a real GCC/gcov pair on macOS
             - name: add-packages
               run: |
                   brew trust coverallsapp/coveralls
-                  brew install flex bison diffutils lcov cmocka grep gnu-sed findutils
+                  brew install flex bison diffutils lcov cmocka gcc grep gnu-sed findutils
+                  echo "CC=$(printf '%s\n' /opt/homebrew/bin/gcc-[0-9]* | sort -t- -k2,2n | tail -n 1)" >> "$GITHUB_ENV"
+                  echo "GCOV_TOOL=$(printf '%s\n' /opt/homebrew/bin/gcov-[0-9]* | sort -t- -k2,2n | tail -n 1)" >> "$GITHUB_ENV"
                   echo '/opt/homebrew/opt/grep/libexec/gnubin' >> $GITHUB_PATH
                   echo '/opt/homebrew/opt/gnu-sed/libexec/gnubin' >> $GITHUB_PATH
                   echo '/opt/homebrew/opt/findutils/libexec/gnubin' >> $GITHUB_PATH

src/Makefile

@@ -14,7 +14,7 @@
 #====================================================================================================================
 
 
-CC         = gcc
+CC         ?= gcc
 
 OUT_DIR    = ../out
 SRC_DIR    = ../src

test/test-sunny-days-all.sh

@@ -31,6 +31,20 @@ declare -r COVERAGE_FILE=${COVERAGE_DIR}/coverage.info
 # Command Line Options
 declare opt_coverage=false
 
+declare branchCoverage=lcov_branch_coverage
+declare -a lcovArgs=(--ignore-errors unused)
+declare -a lcovCaptureArgs=()
+declare -ar lcovExcludeArgs=(--exclude '*/lex.yy.c' --exclude '*/parser.c' --exclude '*/lexer.l' --exclude '*/parser.y')
+
+if [[ $(uname) == "Darwin" ]]; then
+    branchCoverage=branch_coverage
+    lcovArgs+=(--rc derive_function_end_line=0)
+fi
+
+if [[ -n "${GCOV_TOOL:-}" ]]; then
+    lcovCaptureArgs+=(--gcov-tool "${GCOV_TOOL}")
+fi
+
 # Global Variables
 declare result=0
 declare success=0
@@ -93,16 +107,6 @@ function get_executable_name()
 }
 
 
-function get_coverage_option()
-{
-    local coverageOption=lcov_branch_coverage
-    if [[ $(uname) == "Darwin" ]]; then
-        coverageOption=branch_coverage
-    fi
-    echo ${coverageOption}
-}
-
-
 function list_designs()
 {
     ${boxesBinary} -f ../boxes-config -q '(all)' | grep -v ' (alias)'
@@ -195,7 +199,7 @@ function measure_coverage()
         mkdir -p "${COVERAGE_DIR}"
         cp ${OUT_DIR}/*.gc* "${COVERAGE_DIR}"
         lcov --capture --directory "${COVERAGE_DIR}" --base-directory "${SRC_DIR}" --test-name SunnyDayTests \
-            --quiet --exclude '*/lex.yy.c' --exclude '*/parser.c' --rc "${branchCoverage}=1" \
+            --quiet "${lcovCaptureArgs[@]}" "${lcovExcludeArgs[@]}" "${lcovArgs[@]}" --rc "${branchCoverage}=1" \
             --output-file "${COVERAGE_FILE}"
         echo -n "    Coverage: "
         lcov --summary "${COVERAGE_FILE}" 2>&1 | grep 'lines...' | grep -oP '\d+\.\d*%'
@@ -222,9 +226,6 @@ clear_gcda_traces
 declare boxesBinary
 boxesBinary=$(get_executable_name)
 
-declare branchCoverage
-branchCoverage=$(get_coverage_option)
-
 echo "Performing sunny-day tests on all box designs"
 
 mkdir -p ${TEST_DIR}

test/testrunner.sh

@@ -30,6 +30,20 @@ declare opt_coverage_per_test=false
 declare opt_suite=false
 declare opt_testCase=""
 
+declare branchCoverage=lcov_branch_coverage
+declare -a lcovArgs=(--ignore-errors unused)
+declare -a lcovCaptureArgs=()
+declare -ar lcovExcludeArgs=(--exclude '*/lex.yy.c' --exclude '*/parser.c' --exclude '*/lexer.l' --exclude '*/parser.y')
+
+if [[ $(uname) == "Darwin" ]]; then
+    branchCoverage=branch_coverage
+    lcovArgs+=(--rc derive_function_end_line=0)
+fi
+
+if [[ -n "${GCOV_TOOL:-}" ]]; then
+    lcovCaptureArgs+=(--gcov-tool "${GCOV_TOOL}")
+fi
+
 
 function print_usage()
 {
@@ -111,7 +125,8 @@ function cov_baseline()
         if [ ! -f ${BASELINE_FILE} ]; then
             echo "Creating coverage baseline ..."
             lcov --capture --initial --no-recursion --directory ${OUT_DIR} --base-directory ${SRC_DIR} \
-                --exclude '*/lex.yy.c' --exclude '*/parser.c' --output-file ${BASELINE_FILE}
+                "${lcovCaptureArgs[@]}" "${lcovExcludeArgs[@]}" "${lcovArgs[@]}" --rc "${branchCoverage}=1" \
+                --output-file ${BASELINE_FILE}
             echo -e "Coverage baseline created in ${BASELINE_FILE}\n"
         fi
     fi
@@ -160,7 +175,7 @@ function measure_coverage()
         mkdir -p "${testResultsDir}"
         cp ${OUT_DIR}/*.gc* "${testResultsDir}"
         lcov --capture --directory "${testResultsDir}" --base-directory ${SRC_DIR} --test-name "${tcBaseName}" --quiet \
-            --exclude '*/lex.yy.c' --exclude '*/parser.c' --rc "${branchCoverage}=1" \
+            "${lcovCaptureArgs[@]}" "${lcovExcludeArgs[@]}" "${lcovArgs[@]}" --rc "${branchCoverage}=1" \
             --output-file "${testResultsDir}/coverage.info"
         echo -n "    Coverage: "
         lcov --summary "${testResultsDir}/coverage.info" 2>&1 | grep 'lines...' | grep -oP '\d+\.\d*%'
@@ -174,7 +189,7 @@ function consolidate_coverage()
         echo -e "\nConsolidating test coverage ..."
         pushd ${OUT_DIR}/test-results || exit 1
         find . -name "*.info" | xargs printf -- '--add-tracefile %s\n' | xargs --exit \
-            lcov --rc "${branchCoverage}=1" --exclude '*/lex.yy.c' --exclude '*/parser.c' \
+            lcov --rc "${branchCoverage}=1" "${lcovExcludeArgs[@]}" "${lcovArgs[@]}" \
                 --output-file ../${COVERAGE_FILE} --add-tracefile ../${BASELINE_FILE}
         popd || exit 1
         echo ""
@@ -305,10 +320,6 @@ check_prereqs
 cov_baseline
 
 declare tcBaseName=${opt_testCase%.txt}
-declare branchCoverage=lcov_branch_coverage
-if [[ $(uname) == "Darwin" ]]; then
-    branchCoverage=branch_coverage
-fi
 
 # Execute the entire test suite
 if [ ${opt_suite} == true ]; then
@@ -317,7 +328,7 @@ if [ ${opt_suite} == true ]; then
     execute_suite
 
     if [ ${opt_coverage_per_test} == false ]; then
-        tcBaseName=black-box-all
+        tcBaseName=black_box_all
         measure_coverage
     fi
     if [ ${opt_coverage} == true ]; then

utest/Makefile

@@ -13,7 +13,7 @@
 #____________________________________________________________________________________________________________________
 #====================================================================================================================
 
-CC         = gcc
+CC         ?= gcc
 
 OUT_DIR    = ../out
 SRC_DIR    = ../src

utest/report.sh

@@ -23,8 +23,17 @@ declare -r testResultsDir=${OUT_DIR}/test-results/${tcBaseName}
 declare -r testReportDir=${OUT_DIR}/report-utest
 
 declare branchCoverage=lcov_branch_coverage
+declare -a lcovArgs=(--ignore-errors unused)
+declare -a lcovCaptureArgs=()
+declare -ar lcovExcludeArgs=(--exclude '*/lex.yy.c' --exclude '*/parser.c' --exclude '*/lexer.l' --exclude '*/parser.y')
+
 if [[ $(uname) == "Darwin" ]]; then
     branchCoverage=branch_coverage
+    lcovArgs+=(--rc derive_function_end_line=0)
+fi
+
+if [[ -n "${GCOV_TOOL:-}" ]]; then
+    lcovCaptureArgs+=(--gcov-tool "${GCOV_TOOL}")
 fi
 
 if test -n "$(find "${OUT_DIR}" -maxdepth 1 -name '*.gcda' -print -quit)" \
@@ -35,7 +44,7 @@ then
     mkdir -p "${testReportDir}"
     cp "${OUT_DIR}"/*.gc* "${testResultsDir}"
     lcov --capture --directory "${testResultsDir}" --base-directory "${SRC_DIR}" --test-name ${tcBaseName} --quiet \
-        --exclude '*/lex.yy.c' --exclude '*/parser.c' --rc "${branchCoverage}=1" \
+        "${lcovCaptureArgs[@]}" "${lcovExcludeArgs[@]}" "${lcovArgs[@]}" --rc "${branchCoverage}=1" \
         --output-file "${testResultsDir}/coverage.info"
     echo -n "[ Coverage ] "
     genhtml --title "Boxes / Unit Tests" --branch-coverage --legend --output-directory "${testReportDir}" \