[R-package] [docs] fix calculation of R test coverage (fixes #4919)

microsoft · Dec 31, 2021 · 850d717 · 850d717
1 parent af5b40e
commit 850d717
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/R-package/README.md b/R-package/README.md
@@ -265,10 +265,13 @@ The example below shows how to generate code coverage for the R package on a mac
 
 ```shell
 # Install
-sh build-cran-package.sh
+sh build-cran-package.sh \
+    --no-build-vignettes
 
 # Get coverage
+LIGHTGBM_TEST_COVERAGE=true \
 Rscript -e " \
+    library(covr);
     coverage  <- covr::package_coverage('./lightgbm_r', type = 'tests', quiet = FALSE);
     print(coverage);
     covr::report(coverage, file = file.path(getwd(), 'coverage.html'), browse = TRUE);

diff --git a/R-package/tests/testthat/test_lgb.unloader.R b/R-package/tests/testthat/test_lgb.unloader.R
@@ -2,7 +2,13 @@ VERBOSITY <- as.integer(
     Sys.getenv("LIGHTGBM_TEST_VERBOSITY", "-1")
 )
 
+CALCULATING_TEST_COVERAGE <- Sys.getenv("LIGHTGBM_TEST_COVERAGE") == "true"
+
 test_that("lgb.unloader works as expected", {
+    testthat::skip_if(
+        condition = CALCULATING_TEST_COVERAGE
+        , message = "lgb.unloader() tests are skipped when calculating test coverage"
+    )
     data(agaricus.train, package = "lightgbm")
     train <- agaricus.train
     dtrain <- lgb.Dataset(train$data, label = train$label)
@@ -24,6 +30,10 @@ test_that("lgb.unloader works as expected", {
 })
 
 test_that("lgb.unloader finds all boosters and removes them", {
+    testthat::skip_if(
+        condition = CALCULATING_TEST_COVERAGE
+        , message = "lgb.unloader() tests are skipped when calculating test coverage"
+    )
     data(agaricus.train, package = "lightgbm")
     train <- agaricus.train
     dtrain <- lgb.Dataset(train$data, label = train$label)