revdep_check tweaks

NEWS.md

@@ -1,5 +1,20 @@
 # devtools 1.12.0.9000
 
+* More tweaks to `revdep_check()` and friends to make debugging easier when
+  something goes wrong. This includes:
+
+    * `revdep_check()` and `revdep_check_resume()` gain a skip argument
+      which takes a character vector of packages to skip.
+
+    * `revdep_check()` and `check_cran()` gain a `quiet_check` argument.
+      You can use `quiet_check = FALSE` to see the actual text of R CMD
+      check as it runs (not recommending with multiple threads).
+
+    * `revdep_check_resume()` now takes `...` which can be used to 
+      override settings from `revdep_check()`. For debugging a problem
+      with package checks, try 
+      `revdep_check(threads = 1, quiet_check = FALSE)`
+
 * New `use_gpl3_license()` sets the license field in `DESCRIPTION` and
   includes a copy of the license in `LICENSE`.
 

R/check-cran.r

@@ -20,6 +20,9 @@
 #' @param threads Number of concurrent threads to use for checking.
 #'   It defaults to the option \code{"Ncpus"} or \code{1} if unset.
 #' @param check_dir Directory to store results.
+#' @param quiet_check If \code{TRUE}, suppresses individual \code{R CMD
+#'   check} output and only prints summaries. Set to \code{FALSE} for
+#'   debugging.
 #' @return Returns (invisibly) the directory where check results are stored.
 #' @keywords internal
 #' @inheritParams check
@@ -29,7 +32,8 @@ check_cran <- function(pkgs, libpath = file.path(tempdir(), "R-lib"),
                        type = getOption("pkgType"),
                        threads = getOption("Ncpus", 1),
                        check_dir = tempfile("check_cran"),
-                       env_vars = NULL) {
+                       env_vars = NULL,
+                       quiet_check = TRUE) {
 
   stopifnot(is.character(pkgs))
   if (length(pkgs) == 0) return()
@@ -47,25 +51,30 @@ check_cran <- function(pkgs, libpath = file.path(tempdir(), "R-lib"),
 
   # Add the temporary library and remove on exit
   libpaths_orig <- withr::with_libpaths(libpath, {
-
-    rule("Installing dependencies") # --------------------------------------------
     repos <- c(CRAN = cran_mirror())
     if (bioconductor) {
       check_suggested("BiocInstaller")
       repos <- c(repos, BiocInstaller::biocinstallRepos())
     }
-    available_src <- available_packages(repos, "source")
 
-    message("Determining packages to update... ", appendLF = FALSE) # ------------
+    rule("Installing dependencies") # ------------------------------------------
+
     deps <- package_deps(pkgs, repos = repos, type = type, dependencies = TRUE)
-    message(paste(deps$package, collapse = ", "))
-    update(deps, Ncpus = threads, quiet = TRUE)
+    needed <- deps$diff != CURRENT
+    if (any(needed)) {
+      message("Installing ", sum(needed), " packages: ", comma(pkgs))
+      update(deps, Ncpus = threads, quiet = TRUE)
+    }
 
-    message("Downloading source packages for checking") #-------------------------
+    # Download source packages
+    available_src <- available_packages(repos, "source")
     urls <- lapply(pkgs, package_url, repos = repos, available = available_src)
     ok <- vapply(urls, function(x) !is.na(x$name), logical(1))
     if (any(!ok)) {
-      message("Couldn't find source for: ", paste(pkgs[!ok], collapse = ", "))
+      message(
+        "Skipping ", sum(!ok), " packages without source:",
+        comma(pkgs[!ok])
+      )
       urls <- urls[ok]
       pkgs <- pkgs[ok]
     }
@@ -75,12 +84,17 @@ check_cran <- function(pkgs, libpath = file.path(tempdir(), "R-lib"),
 
     needs_download <- !vapply(local_urls, is_source_pkg, logical(1))
     if (any(needs_download)) {
-      message("Downloading ", sum(needs_download), " packages")
+      message(
+        "Downloading ", sum(needs_download), " source packages: ",
+        comma(pkgs[needs_download])
+      )
       Map(utils::download.file, remote_urls[needs_download],
         local_urls[needs_download], quiet = TRUE)
     }
 
-    rule("Checking packages") # --------------------------------------------------
+    rule("Checking packages") # ------------------------------------------------
+    message("Checking ", length(pkgs), " packages: ", comma(pkgs))
+
     check_start <- Sys.time()
     pkg_names <- format(pkgs)
     check_pkg <- function(i) {
@@ -90,7 +104,7 @@ check_cran <- function(pkgs, libpath = file.path(tempdir(), "R-lib"),
         args = "--no-multiarch --no-manual --no-codoc",
         env_vars = env_vars,
         check_dir = check_dir,
-        quiet = TRUE
+        quiet = quiet_check
       )
       end_time <- Sys.time()
 

R/revdep.R

@@ -93,6 +93,8 @@ print.maintainers <- function(x, ...) {
 #'
 #' @inheritParams revdep
 #' @param pkg Path to package. Defaults to current directory.
+#' @param skip A character vector of package names to exclude from the
+#'   checks.
 #' @inheritParams check_cran
 #' @param check_dir A temporary directory to hold the results of the package
 #'   checks. This should not exist as after the revdep checks complete
@@ -113,12 +115,14 @@ print.maintainers <- function(x, ...) {
 #' }
 revdep_check <- function(pkg = ".", recursive = FALSE, ignore = NULL,
                          dependencies = c("Depends", "Imports", "Suggests", "LinkingTo"),
+                         skip = character(),
                          libpath = getOption("devtools.revdep.libpath"),
                          srcpath = libpath, bioconductor = FALSE,
                          type = getOption("pkgType"),
                          threads = getOption("Ncpus", 1),
                          env_vars = NULL,
-                         check_dir = NULL) {
+                         check_dir = NULL,
+                         quiet_check = TRUE) {
 
   pkg <- as.package(pkg)
 
@@ -145,22 +149,27 @@ revdep_check <- function(pkg = ".", recursive = FALSE, ignore = NULL,
       call. = FALSE)
   }
 
-  message("Computing reverse dependencies... ", appendLF = FALSE)
+  message("Computing reverse dependencies... ")
   revdeps <- revdep(pkg$package, recursive = recursive, ignore = ignore,
     bioconductor = bioconductor, dependencies = dependencies)
 
-  message(paste(revdeps, collapse = ", "))
+  if (length(skip) > 0) {
+    message("Skipping: ", comma(skip))
+    revdeps <- setdiff(revdeps, skip)
+  }
 
   # Save arguments and revdeps to a cache
   cache <- list(
     pkgs = revdeps,
+    skip = skip,
     libpath = libpath,
     srcpath = srcpath,
     bioconductor = bioconductor,
     type = type,
     threads = threads,
     check_dir = check_dir,
-    env_vars = env_vars
+    env_vars = env_vars,
+    quiet_check = quiet_check
   )
   saveRDS(cache, revdep_cache_path(pkg))
 
@@ -169,7 +178,9 @@ revdep_check <- function(pkg = ".", recursive = FALSE, ignore = NULL,
 
 #' @export
 #' @rdname revdep_check
-revdep_check_resume <- function(pkg = ".") {
+#' @param ... Optionally, override original value of arguments to
+#'   \code{revdep_check}. Use with care.
+revdep_check_resume <- function(pkg = ".", ..., skip = character()) {
   pkg <- as.package(pkg)
 
   cache_path <- revdep_cache_path(pkg)
@@ -179,6 +190,12 @@ revdep_check_resume <- function(pkg = ".") {
   }
 
   cache <- readRDS(cache_path)
+  cache <- utils::modifyList(cache, list(...))
+
+  if (length(cache$pkgs) > 0) {
+    message("Skipping: ", comma(skip))
+    cache$pkgs <- setdiff(cache$pkgs, skip)
+  }
 
   # Don't need to check packages that we've already checked.
   check_dirs <- dir(cache$check_dir, full.names = TRUE)

R/utils.r

@@ -236,3 +236,10 @@ strip_internal_calls <- function(x, package) {
     x
   }
 }
+
+comma <- function(x, at_most = 20) {
+  if (length(x) > at_most) {
+    x <- c(x[seq_len(at_most)], "...")
+  }
+  paste(x, collapse = ", ")
+}