WIP: [ci] [R-package] add a CI job to run R reverse dependency checks

.ci/download-r-revdeps.R

@@ -0,0 +1,75 @@
+loadNamespace("crandep")
+
+PKG_DIR <- commandArgs(trailing = TRUE)[[1L]]
+
+.log <- function(msg) {
+    cat(sprintf("[download-revdeps] %s\n", msg))
+}
+
+# get all of lightgbm's reverse dependencies
+depDF <- crandep::get_dep(
+    name = "lightgbm"
+    , type = "all"
+    , reverse = TRUE
+)
+reverse_deps <- depDF[["to"]]
+.log(sprintf("found %i reverse deps", length(reverse_deps)))
+
+# skip some dependencies with known issues:
+#
+#   * 'misspi' (https://github.com/microsoft/LightGBM/issues/6741)
+#   * 'qeML'   (checks take 45+ minutes to run)
+deps_to_skip <- c(
+    "misspi"
+    , "qeML"
+)
+.log(sprintf("excluding %i reverse deps: %s", length(deps_to_skip), toString(deps_to_skip)))
+reverse_deps <- reverse_deps[!reverse_deps %in% deps_to_skip]
+
+.log(sprintf("checking the following packages: %s", toString(reverse_deps)))
+
+# get the superset of all their dependencies
+# (all of the packages needed to run 'R CMD check' on lightgbm's reverse deps)
+their_deps <- unlist(
+    unname(
+        sapply(
+            X = reverse_deps
+            , FUN = function(pkg) {
+                return(
+                    crandep::get_dep(
+                        name = pkg
+                        , type = "all"
+                        , reverse = FALSE
+                    )[["to"]]
+                )
+            }
+        )
+    )
+)
+
+all_deps <- sort(unique(c(their_deps, reverse_deps)))
+
+# don't try to install 'lightgbm', or packages that ship with the R standard library
+all_deps <- all_deps[!all_deps %in% c("grid", "methods", "lightgbm", "parallel", "stats", "utils")]
+
+.log(sprintf("packages required to run these checks: %i", length(all_deps)))
+
+.log("installing all packages required to check reverse dependencies")
+
+# install only the strong dependencies of all those packages
+install.packages(  # nolint: undesirable_function
+    pkgs = all_deps
+    , repos = "https://cran.r-project.org"
+    , dependencies = c("Depends", "Imports", "LinkingTo")
+    , type = "both"
+    , Ncpus = parallel::detectCores()
+)
+
+# get source tarballs, to be checked with 'R CMD check'
+print(sprintf("--- downloading reverse dependencies to check (%i)", length(reverse_deps)))
+download.packages(
+    pkgs = reverse_deps
+    , destdir = PKG_DIR
+    , repos = "https://cran.r-project.org"
+    , type = "source"
+)

.ci/run-r-revdepchecks.R

@@ -0,0 +1,30 @@
+options(repos = "https://cran.r-project.org")
+
+check_dir <- commandArgs(trailing = TRUE)[[1L]]
+
+tools::check_packages_in_dir(
+    dir = check_dir
+    , check_args = c("--no-manual", "--run-dontrun", "--run-donttest")
+    , clean = TRUE
+    , all = TRUE
+    # only check one package at a time, to avoid oversubscribing CPUs
+    , Ncpus = 2L
+    # only test the libraries found in `check_dir`
+    , reverse = FALSE
+)
+
+all_checks_passed <- tools::summarize_check_packages_in_dir_results(
+    dir = check_dir
+    , all = TRUE
+)
+
+if (!isTRUE(all_checks_passed)) {
+    invisible(
+        tools::summarize_check_packages_in_dir_results(
+            dir = check_dir
+            , all = TRUE
+            , full = TRUE
+        )
+    )
+    stop("Some checks failed! See results above.")
+}

.ci/run-revdep-checks.sh

@@ -0,0 +1,40 @@
+#!/bin/bash
+set -e -u -o pipefail
+
+CHECKS_OUTPUT_DIR=/tmp/lgb-revdepchecks
+mkdir -p "${CHECKS_OUTPUT_DIR}"
+
+# Pre-install all of lightgbm's reverse dependencies, and all of their dependencies,
+# preferring precompiled binaries where available.
+#
+# This is done for speed... tools::check_packages_in_dir() only performs source
+# installs of all packages, which results in lots of compilation.
+#
+# ref: https://github.com/wch/r-source/blob/594b842678e932088b16ec0cd3c39714a141eed9/src/library/tools/R/checktools.R#L295
+#
+# {lightgbm} checks do not need to care about that... as of this writing, nothing has {lightgbm} as a
+# 'LinkingTo' dependency or otherwise needs {lightgbm} at build time.
+Rscript ./.ci/download-r-revdeps.R "${CHECKS_OUTPUT_DIR}"
+
+# build and install 'lightgbm'
+sh ./build-cran-package.sh --no-build-vignettes
+R CMD INSTALL --with-keep.source ./lightgbm_*.tar.gz
+
+# run 'R CMD check' on lightgbm's reverse dependencies
+Rscript ./.ci/run-r-revdepchecks.R "${CHECKS_OUTPUT_DIR}"
+
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/EIX_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/SHAPforxgboost_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/cbl_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/bonsai_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/fastshap_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/fastml_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/fastshap_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/predhy.GUI_*.tar.gz || true
+# qeML vignettes take a very very long time to run
+#R CMD check --no-manual --run-dontrun --run-donttest --ignore-vignettes ${CHECKS_OUTPUT_DIR}/qeML_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/mllrns_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/predhy_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/r2pmml_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/stackgbm_*.tar.gz || true
+# R CMD check --no-manual --run-dontrun --run-donttest ${CHECKS_OUTPUT_DIR}/vip_*.tar.gz || true