Run coverage with MOOCORE_DEBUG=1 and exclude unreachable lines.

MLopez-Ibanez · MLopez-Ibanez · commit 77fb230b4e69 · 2025-12-01T20:59:53.000Z
* .github/workflows/R.yml: Run coverage with MOOCORE_DEBUG=1.
   Disable LTO when running coverage.
 * r/src/Makevars: Use MOOCORE_DEBUG instead of DEBUG.
 * r/cleanup: Remove .gcda files.
 * c/: Exclude unreachable lines.
 * python/pyproject.toml [tool.coverage.report]: Exclude nocov lines.
 * python/tox.ini (.pkg-cov): Set MOOCORE_DEBUG=1.
diff --git a/.github/workflows/R.yml b/.github/workflows/R.yml
@@ -162,9 +162,11 @@ jobs:
         env:
           NOT_CRAN: false
         run: |
-          coverage <- covr::package_coverage(type="all", quiet=FALSE, clean = FALSE,
+          coverage <- withr::with_makevars(c(MOOCORE_DEBUG="1", LTO_OPT=""),
+                        covr::package_coverage(type="all", quiet=FALSE, clean = FALSE,
                            commentDonttest = FALSE, commentDontrun = FALSE, flags="R",
                            install_path = file.path(normalizePath(Sys.getenv("RUNNER_TEMP"), winslash = "/"), "package"))
+          )
           print(coverage)
           covr::to_cobertura(coverage)
           list.files("../", pattern="*.xml", recursive=TRUE)
diff --git a/c/Makefile b/c/Makefile
@@ -226,7 +226,7 @@ $(CXXSHLIB): $(LIBHV_OBJS)
 	$(CXX) $(CFLAGS) $(CPPFLAGS) $(LDFLAGS) -o $@ $^ $(SHLIB_LDFLAGS)
 
 clean:
-	@-$(RM) *.s *.i
+	@-$(RM) *.s *.i *.gcda mt19937/*.gcda
 	@-$(RM) config.status config.log
 	@-$(RM) Hypervolume_MEX.mex
 	@-$(RM) $(SHLIB) $(CXXSHLIB)
diff --git a/c/cmdline.h b/c/cmdline.h
@@ -270,7 +270,7 @@ static inline void default_cmdline_handler(int opt)
           usage();
           exit(EXIT_SUCCESS);
       default:
-          unreachable();
+          unreachable(); // COVR_EXCL_LINE # nocov
     }
 }
 
diff --git a/c/gcc_attribs.h b/c/gcc_attribs.h
@@ -121,14 +121,14 @@
 
 
 #if (defined(__GNUC__) && __GNUC__ >= 3) || defined(__clang__)
-# define likely(x)	__builtin_expect(!!(x), 1)
-# define unlikely(x)	__builtin_expect(!!(x), 0)
+# define likely(x)	  __builtin_expect(!!(x), 1)
+# define unlikely(x)  __builtin_expect(!!(x), 0)
 #elif (defined(__cplusplus) && __cplusplus >= 202002L) || (defined(_MSVC_LANG) && _MSVC_LANG >= 202002L)
-# define likely(x)	(x) [[likely]]
-# define unlikely(x)	(x) [[unlikely]]
+# define likely(x)	  (x) [[likely]]
+# define unlikely(x)  (x) [[unlikely]]
 #else
-# define likely(x)	(x)
-# define unlikely(x)	(x)
+# define likely(x)	  (x)
+# define unlikely(x)  (x)
 #endif
 
 #ifdef _MSC_VER
diff --git a/c/hv4d_priv.h b/c/hv4d_priv.h
@@ -156,7 +156,7 @@ restart_base_setup_z_and_closest(dlnode_t * restrict list, dlnode_t * restrict n
         }
         p = p->next[0];
     }
-    unreachable();
+    unreachable();  // COVR_EXCL_LINE # nocov
 }
 
 // FIXME: This is very similar to the loop in hvc3d_list() but it doesn't use p->last_slice_z
@@ -211,7 +211,7 @@ one_contribution_3d(dlnode_t * restrict newp)
         lastz = px[2];
         p = p->next[0];
     }
-    unreachable();
+    unreachable();  // COVR_EXCL_LINE # nocov
 }
 
 /* Compute the hypervolume indicator in d=4 by iteratively computing the one
diff --git a/c/hvapprox.c b/c/hvapprox.c
@@ -434,7 +434,7 @@ int_of_power_of_sin_from_0_to_b(dimension_t m, double b)
           return 0.13994993409141898*b - cos_b*sin_b*(
               0.03125*POW(sin_b, 30) + 31/960.*POW(sin_b, 28) + 899/26880.*POW(sin_b, 26) + 8091/232960.*POW(sin_b, 24) + 13485/372736.*POW(sin_b, 22) + 310155/8200192.*POW(sin_b, 20) + 186093/4685824.*POW(sin_b, 18) + 392863/9371648.*POW(sin_b, 16) + 6678671/149946368.*POW(sin_b, 14) + 100180065/2099249152.*POW(sin_b, 12) + 33393355/645922816.*POW(sin_b, 10) + 6678671/117440512.*POW(sin_b, 8) + 60108039/939524096.*POW(sin_b, 6) + 0.07463996484875679*POW(sin_b, 4) + 0.093299956060945988*POW(sin_b, 2) + 0.13994993409141898);
       default:
-          unreachable();
+          unreachable();  // COVR_EXCL_LINE # nocov
     }
 #undef POW
 }
diff --git a/c/main-hvapprox.c b/c/main-hvapprox.c
@@ -173,7 +173,7 @@ hvapprox_file (const char *filename, double *reference,
               volume = hv_approx_hua_wang(&data[nobj * cumsize], nobj, cumsizes[n] - cumsize, reference, maximise, nsamples);
               break;
           default:
-              unreachable();
+              unreachable();  // COVR_EXCL_LINE # nocov
         }
 
         if (volume == 0.0) {
diff --git a/c/nondominated.h b/c/nondominated.h
@@ -474,7 +474,7 @@ find_dominated_point_(const double * restrict points, dimension_t dim, size_t si
           return find_dominated_point_agree_(
               points, dim, size, keep_weakly, AGREE_MAXIMISE, /*minmax=*/NULL);
       default:
-          unreachable();
+          unreachable();  // # nocov
     }
 }
 
@@ -525,7 +525,7 @@ find_nondominated_set_(const double * restrict points, dimension_t dim, size_t s
           return find_nondominated_set_agree_(
               points, dim, size, nondom, keep_weakly, AGREE_MAXIMISE, /*minmax=*/NULL);
       default:
-          unreachable();
+          unreachable();  // # nocov
     }
 }
 
diff --git a/c/pow_int.h b/c/pow_int.h
@@ -42,7 +42,7 @@ fast_pow_uint_max32(double base, uint_fast8_t exp)
       case 30: { b15 = fast_pow_uint_max32(base, 15); return b15 * b15; }
       case 31: { b15 = fast_pow_uint_max32(base, 15); return b15 * b15 * base; }
       case 32: { b16 = fast_pow_uint_max32(base, 16); return b16 * b16; }
-      default: unreachable();
+      default: unreachable(); // COVR_EXCL_LINE # nocov
     }
 }
 
@@ -103,7 +103,7 @@ fast_powl_uint_max32(long double base, uint_fast8_t exp)
       case 30: { b15 = fast_powl_uint_max32(base, 15); return b15 * b15; }
       case 31: { b15 = fast_powl_uint_max32(base, 15); return b15 * b15 * base; }
       case 32: { b16 = fast_powl_uint_max32(base, 16); return b16 * b16; }
-      default: unreachable();
+      default: unreachable(); // COVR_EXCL_LINE # nocov
     }
 }
 
diff --git a/python/pyproject.toml b/python/pyproject.toml
@@ -192,6 +192,11 @@ faulthandler_timeout = 10
 doctest_optionflags = "NUMBER"
 addopts = [ "--import-mode=importlib", "--durations=5", "--durations-min=1.0" ]
 
+[tool.coverage.report]
+exclude_also = [
+  '# nocov',
+]
+
 [tool.mypy]
 python_version = "3.11"
 # Strictness (recommended for library code)
diff --git a/python/tox.ini b/python/tox.ini
@@ -35,7 +35,7 @@ commands =
     coverage run --source={envsitepackagesdir}/moocore,tests -m pytest --doctest-modules --import-mode=importlib {envsitepackagesdir}/moocore tests
     coverage report -m
     coverage xml
-    gcovr --print-summary --delete -r {toxinidir} {toxinidir} --xml=c_coverage.xml --exclude '.*/moocore\._libmoocore.c' --fail-under-line 1
+    gcovr --exclude-unreachable-branches --print-summary --delete -r {toxinidir} {toxinidir} --xml=c_coverage.xml --exclude '.*/moocore\._libmoocore.c' --fail-under-line 1
 
 [testenv:docs]
 description = Build documentation
@@ -55,6 +55,7 @@ passenv = MOOCORE_DEBUG
 setenv =
     .pkg-cov: CFLAGS={env:CFLAGS:--coverage -UNDEBUG -DDEBUG=1}
     .pkg-cov: LDFLAGS=--coverage
+    .pkg-cov: MOOCORE_DEBUG=1
     .pkg-release: MOOCORE_DEBUG=0
     .pkg-debug: MOOCORE_DEBUG=1
 
diff --git a/r/Makefile b/r/Makefile
@@ -89,7 +89,7 @@ check: build
 ifdef TEST
 	_R_CHECK_FORCE_SUGGESTS_=false NOT_CRAN=true $(Reval) 'devtools::test(filter="$(TEST)")'
 else
-	cd $(BINDIR) && (_R_CHECK_FORCE_SUGGESTS_=false NOT_CRAN=true DEBUG=1 R CMD check --run-donttest --run-dontrun --timings $(PACKAGE)_$(PACKAGEVERSION).tar.gz; cat $(PACKAGE).Rcheck/$(PACKAGE)-Ex.timings)
+	cd $(BINDIR) && (_R_CHECK_FORCE_SUGGESTS_=false NOT_CRAN=true MOOCORE_DEBUG=1 R CMD check --run-donttest --run-dontrun --timings $(PACKAGE)_$(PACKAGEVERSION).tar.gz; cat $(PACKAGE).Rcheck/$(PACKAGE)-Ex.timings)
 endif
 
 show:
@@ -112,7 +112,7 @@ winbuild winbuild_:
 	$(Reval) "devtools::check_win_devel()"
 
 covr:
-	$(Reval) "Sys.setenv(NOT_CRAN='true');covr::report(covr::package_coverage(type='all', quiet=FALSE), browse=TRUE)"
+	$(Reval) "Sys.setenv(NOT_CRAN='true');covr::report(withr::with_makevars(c(MOOCORE_DEBUG='1', LTO_OPT=''), covr::package_coverage(type='all', commentDonttest=FALSE, commentDontrun=FALSE, quiet=FALSE)), browse=TRUE)"
 
 benchmarks: quick-install
 	$(RM) ./vignettes/articles/bench/*.rds
diff --git a/r/cleanup b/r/cleanup
@@ -1,11 +1,11 @@
 #!/bin/sh
 rm -f  \
    *-Ex.R *.html config.* confdefs.h tests/testthat/*.pdf \
-   src/*.o src/*.so src/symbols.rds \
+   src/*.o src/*.so src/*.gcda src/symbols.rds \
    inst/doc/*.blg inst/doc/*.bbl \
    vignettes/*.R vignettes/*.html \
-   vignettes/articles/*.R vignettes/articles/*.html \
+   vignettes/articles/*.R vignettes/articles/*.html
 
 rm -rf autom4te.cache benchmarks_files
+rm -f src/libmoocore/*.o src/libmoocore/*.gcda src/libmoocore/*/*.gcda
 find . -name '*.orig' -o -name '.Rhistory' -o -name '*.Rout' -print0 | xargs -0 rm -f
-rm -f src/libmoocore/*.o
diff --git a/r/src/Makevars b/r/src/Makevars
@@ -4,8 +4,8 @@
 # In particular, add the following to ~/.R/Makevars:
 # LTO_OPT=-flto
 LTO=$(LTO_OPT)
-DEBUG=0
-PKG_CPPFLAGS=-DR_PACKAGE -DDEBUG=$(DEBUG) -I./libmoocore/
+MOOCORE_DEBUG ?=0
+PKG_CPPFLAGS=-DR_PACKAGE -DDEBUG=$(MOOCORE_DEBUG) -I./libmoocore/
 
 MOOCORE_SRC_FILES = hv3dplus.c hv4d.c hv_contrib.c hv.c hvapprox.c hvc3d.c pareto.c whv.c whv_hype.c avl.c eaf3d.c eaf.c io.c rng.c mt19937/mt19937.c
 SOURCES = $(MOOCORE_SRC_FILES:%=libmoocore/%) init.c Rmoocore.c
@@ -18,9 +18,14 @@ all: exes $(SHLIB)
 # We need this to force building order in parallel builds
 $(SHLIB): $(OBJECTS)
 
+# Compile exes only when MOOCORE_DEBUG=0. Otherwise we get problems with
+# coverage and sanitizers.  We must use a shell 'if', not a make 'ifeq',
+# because make parses this file before ~/.R/Makevars is applied.
 exes: $(SHLIB)
-	$(MAKE) -C libmoocore all march=none CC="$(CC)" CFLAGS="$(CFLAGS)" WARN_CFLAGS="" OPT_CFLAGS="" DEBUG=$(DEBUG) EXE=$(EXEEXT) BINDIR=$(PWD)
-	@-$(RM) libmoocore/*.o
+	@if [ "$(MOOCORE_DEBUG)" = "0" ]; then \
+	  $(MAKE) -C libmoocore all march=none CC="$(CC)" CFLAGS="$(CFLAGS)" WARN_CFLAGS="" OPT_CFLAGS="" DEBUG=$(MOOCORE_DEBUG) EXE=$(EXEEXT) BINDIR=$(PWD); \
+	  $(RM) libmoocore/*.o; \
+        fi
 
 clean:
 	@-$(RM) $(SHLIB) $(OBJECTS)

Original file line number	Diff line number	Diff line change
`@@ -270,7 +270,7 @@ static inline void default_cmdline_handler(int opt)`
`270`	`270`	`usage();`
`271`	`271`	`exit(EXIT_SUCCESS);`
`272`	`272`	`default:`
`273`		`- unreachable();`
	`273`	`+ unreachable(); // COVR_EXCL_LINE # nocov`
`274`	`274`	`}`
`275`	`275`	`}`
`276`	`276`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ restart_base_setup_z_and_closest(dlnode_t * restrict list, dlnode_t * restrict n`
`156`	`156`	`}`
`157`	`157`	`p = p->next[0];`
`158`	`158`	`}`
`159`		`- unreachable();`
	`159`	`+ unreachable(); // COVR_EXCL_LINE # nocov`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`// FIXME: This is very similar to the loop in hvc3d_list() but it doesn't use p->last_slice_z`
`@@ -211,7 +211,7 @@ one_contribution_3d(dlnode_t * restrict newp)`
`211`	`211`	`lastz = px[2];`
`212`	`212`	`p = p->next[0];`
`213`	`213`	`}`
`214`		`- unreachable();`
	`214`	`+ unreachable(); // COVR_EXCL_LINE # nocov`
`215`	`215`	`}`
`216`	`216`
`217`	`217`	`/* Compute the hypervolume indicator in d=4 by iteratively computing the one`
Original file line number	Diff line number	Diff line change
`@@ -434,7 +434,7 @@ int_of_power_of_sin_from_0_to_b(dimension_t m, double b)`
`434`	`434`	`return 0.13994993409141898b - cos_bsin_b*(`
`435`	`435`	0.03125POW(sin_b, 30) + 31/960.POW(sin_b, 28) + 899/26880.POW(sin_b, 26) + 8091/232960.POW(sin_b, 24) + 13485/372736.POW(sin_b, 22) + 310155/8200192.POW(sin_b, 20) + 186093/4685824.POW(sin_b, 18) + 392863/9371648.POW(sin_b, 16) + 6678671/149946368.POW(sin_b, 14) + 100180065/2099249152.POW(sin_b, 12) + 33393355/645922816.POW(sin_b, 10) + 6678671/117440512.POW(sin_b, 8) + 60108039/939524096.POW(sin_b, 6) + 0.07463996484875679POW(sin_b, 4) + 0.093299956060945988*POW(sin_b, 2) + 0.13994993409141898);
`436`	`436`	`default:`
`437`		`- unreachable();`
	`437`	`+ unreachable(); // COVR_EXCL_LINE # nocov`
`438`	`438`	`}`
`439`	`439`	`#undef POW`
`440`	`440`	`}`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ hvapprox_file (const char filename, double reference,`
`173`	`173`	`volume = hv_approx_hua_wang(&data[nobj * cumsize], nobj, cumsizes[n] - cumsize, reference, maximise, nsamples);`
`174`	`174`	`break;`
`175`	`175`	`default:`
`176`		`- unreachable();`
	`176`	`+ unreachable(); // COVR_EXCL_LINE # nocov`
`177`	`177`	`}`
`178`	`178`
`179`	`179`	`if (volume == 0.0) {`
Original file line number	Diff line number	Diff line change
`@@ -474,7 +474,7 @@ find_dominated_point_(const double * restrict points, dimension_t dim, size_t si`
`474`	`474`	`return find_dominated_point_agree_(`
`475`	`475`	`points, dim, size, keep_weakly, AGREE_MAXIMISE, /minmax=/NULL);`
`476`	`476`	`default:`
`477`		`- unreachable();`
	`477`	`+ unreachable(); // # nocov`
`478`	`478`	`}`
`479`	`479`	`}`
`480`	`480`
`@@ -525,7 +525,7 @@ find_nondominated_set_(const double * restrict points, dimension_t dim, size_t s`
`525`	`525`	`return find_nondominated_set_agree_(`
`526`	`526`	`points, dim, size, nondom, keep_weakly, AGREE_MAXIMISE, /minmax=/NULL);`
`527`	`527`	`default:`
`528`		`- unreachable();`
	`528`	`+ unreachable(); // # nocov`
`529`	`529`	`}`
`530`	`530`	`}`
`531`	`531`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ fast_pow_uint_max32(double base, uint_fast8_t exp)`
`42`	`42`	`case 30: { b15 = fast_pow_uint_max32(base, 15); return b15 * b15; }`
`43`	`43`	`case 31: { b15 = fast_pow_uint_max32(base, 15); return b15 * b15 * base; }`
`44`	`44`	`case 32: { b16 = fast_pow_uint_max32(base, 16); return b16 * b16; }`
`45`		`- default: unreachable();`
	`45`	`+ default: unreachable(); // COVR_EXCL_LINE # nocov`
`46`	`46`	`}`
`47`	`47`	`}`
`48`	`48`
`@@ -103,7 +103,7 @@ fast_powl_uint_max32(long double base, uint_fast8_t exp)`
`103`	`103`	`case 30: { b15 = fast_powl_uint_max32(base, 15); return b15 * b15; }`
`104`	`104`	`case 31: { b15 = fast_powl_uint_max32(base, 15); return b15 * b15 * base; }`
`105`	`105`	`case 32: { b16 = fast_powl_uint_max32(base, 16); return b16 * b16; }`
`106`		`- default: unreachable();`
	`106`	`+ default: unreachable(); // COVR_EXCL_LINE # nocov`
`107`	`107`	`}`
`108`	`108`	`}`
`109`	`109`