Merge eddfffd into d88b445

microsoft · Oct 22, 2021 · d3763ec · d3763ec
2 parents d88b445 + eddfffd
commit d3763ec
Show file tree

Hide file tree

Showing 2 changed files with 52 additions and 23 deletions.
diff --git a/.github/workflows/r_package.yml b/.github/workflows/r_package.yml
@@ -173,16 +173,19 @@ jobs:
           $env:TASK = "${{ matrix.task }}"
           & "$env:GITHUB_WORKSPACE/.ci/test_windows.ps1"
   test-r-sanitizers:
-    name: r-package (ubuntu-latest, R-devel, GCC ASAN/UBSAN)
-    timeout-minutes: 60
+    name: r-sanitizers (ubuntu-latest, R-devel, ${{ matrix.compiler }} ASAN/UBSAN)
     runs-on: ubuntu-latest
-    container: rhub/rocker-gcc-san
+    container: wch1/r-debug
+    timeout-minutes: 60
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - r_customization: san
+            compiler: gcc
+          - r_customization: csan
+            compiler: clang
     steps:
-      - name: Install Git before checkout
-        shell: bash
-        run: |
-          apt-get update --allow-releaseinfo-change
-          apt-get install --no-install-recommends -y git
       - name: Checkout repository
         uses: actions/checkout@v2.3.4
         with:
@@ -191,16 +194,17 @@ jobs:
       - name: Install packages
         shell: bash
         run: |
-          Rscript -e "install.packages(c('R6', 'data.table', 'jsonlite', 'Matrix', 'testthat'), repos = 'https://cran.r-project.org', Ncpus = parallel::detectCores())"
+          RDscript${{ matrix.r_customization }} -e "install.packages(c('R6', 'data.table', 'jsonlite', 'Matrix', 'testthat'), repos = 'https://cran.r-project.org', Ncpus = parallel::detectCores())"
           sh build-cran-package.sh
-          Rdevel CMD INSTALL lightgbm_*.tar.gz || exit -1
+          RD${{ matrix.r_customization }} CMD INSTALL lightgbm_*.tar.gz || exit -1
       - name: Run tests with sanitizers
         shell: bash
         run: |
           cd R-package/tests
-          Rscriptdevel testthat.R 2>&1 > ubsan-tests.log
-          cat ubsan-tests.log
-          exit $(cat ubsan-tests.log | grep --count "runtime error")
+          exit_code=0
+          RDscript${{ matrix.r_customization }} testthat.R >> tests.log 2>&1 || exit_code=1
+          cat ./tests.log
+          exit ${exit_code}
   test-r-debian-clang:
     name: r-package (debian, R-devel, clang)
     timeout-minutes: 60

diff --git a/R-package/README.md b/R-package/README.md
@@ -363,24 +363,49 @@ Alternatively, GitHub Actions can run code above for you. On a pull request, cre
 
 #### UBSAN
 
-All packages uploaded to CRAN must pass a build using `gcc` instrumented with two sanitizers: the Address Sanitizer (ASAN) and the Undefined Behavior Sanitizer (UBSAN). For more background, see [this blog post](http://dirk.eddelbuettel.com/code/sanitizers.html).
+All packages uploaded to CRAN must pass builds using `gcc` and `clang`, instrumented with two sanitizers: the Address Sanitizer (ASAN) and the Undefined Behavior Sanitizer (UBSAN).
+
+For more background, see
+
+* [this blog post](http://dirk.eddelbuettel.com/code/sanitizers.html)
+* [top-level CRAN documentation on these checks](https://cran.r-project.org/web/checks/check_issue_kinds.html)
+* [CRAN's configuration of these checks](https://www.stats.ox.ac.uk/pub/bdr/memtests/README.txt)
 
 You can replicate these checks locally using Docker.
+For more information on the image used for testing, see https://github.com/wch/r-debug.
 
-```shell
-docker run \
-    -v $(pwd):/opt/LightGBM \
-    -w /opt/LightGBM \
-    -it rhub/rocker-gcc-san \
-    /bin/bash
+In the code below, environment variable `R_CUSTOMIZATION` should be set to one of two environment variables.
 
-Rscript -e "install.packages(c('R6', 'data.table', 'jsonlite', 'Matrix', 'testthat'), repos = 'https://cran.rstudio.com', Ncpus = parallel::detectCores())"
+* `"san"` = replicates CRAN's `gcc-ASAN` and `gcc-UBSAN` checks
+* `"csan"` = replicates CRAN's `clang-ASAN` and `clang-UBSAN` checks
 
+```shell
+docker run \
+  --rm \
+  -it \
+  -v $(pwd):/opt/LightGBM \
+  -w /opt/LightGBM \
+  --env R_CUSTOMIZATION=san \
+  wch1/r-debug:latest \
+  /bin/bash
+
+# install dependencies
+RDscript${R_CUSTOMIZATION} \
+  -e "install.packages(c('R6', 'data.table', 'jsonlite', 'Matrix', 'testthat'), repos = 'https://cran.r-project.org', Ncpus = parallel::detectCores())"
+
+# install lightgbm
 sh build-cran-package.sh
+RD${R_CUSTOMIZATION} \
+  CMD INSTALL lightgbm_*.tar.gz
 
-Rdevel CMD install lightgbm_*.tar.gz
+# run tests
 cd R-package/tests
-Rscriptdevel testthat.R
+rm -f ./tests.log
+RDscript${R_CUSTOMIZATION} testthat.R >> tests.log 2>&1
+
+# check that tests passed
+echo "test exit code: $?"
+tail -300 ./tests.log
 ```
 
 #### Valgrind