R/sysreqs.R

In zkamvar/vise: Package Discovery and Management Based on 'renv'

#' detect and execute system requirements from a lockfile
#'
#' This function converts a renv lockfile to a description file and then 
#' determines the system requirements via [remotes::system_requirements()] using
#' the RStudio online resource. This is intended to be run on continuous
#' integration, so will probably error on macos and windows
#'
#' @param lockfile the path to a {renv} lockfile
#' @param execute if `TRUE` (default), the commands from [remotes::system_requirements()]
#'   will be executed via [base::system()].
#' @param sudo if `TRUE` (default), the command runs as root
#' @param exclude packages to exclude from installation because they already
#'   exist on the system.
#' @return a vector of exectutible system calls to install the dependencies
#' @export
#' @examples
#' lock <- system.file("renv.lock", package = "vise")
#'
#' # The system requirements for a typical {knitr} installation
#' if (startsWith(tolower(R.version$os), "linux")) {
#'   print(vise::ci_sysreqs(lock, execute = FALSE))
#' }
ci_sysreqs <- function(lockfile, execute = TRUE, sudo = TRUE, exclude = c("git", "make", "pandoc")) {
  # convert the lockfile to a temporary DESCRIPTION file
  if (!requireNamespace("remotes", quietly = TRUE)) {
    stop("The {remotes} package is required for this function.")
  }
  desc <- lock2desc(lockfile)
  ver  <- tolower(system("lsb_release -irs", intern = TRUE))
  print(ver)
  reqs <- remotes::system_requirements(ver[1], ver[2], path = dirname(desc))

  # exclude packages that we already have on the system
  for (e in paste0("\\b", exclude, "\\b")) {
    reqs <- reqs[!grepl(e, reqs)]
  }

  if (length(reqs) == 0) {
    return(reqs)
  }

  # on ubuntu, we can assume apt, so we can compress this to a single call
  if (ver[1] == "ubuntu") {
    nz <- nzchar(reqs)
    deps <- paste(substring(reqs[nz], 20, nchar(reqs[nz])), collapse = " ")
    reqs <- paste("apt-get install -y", deps)
  }

  #nocov start
  if (execute) {
    if (ver[1] == "ubuntu") system("sudo apt-get update")
    for (r in reqs) {
      su <- if (sudo) "sudo" else ""
      system(trimws(paste(su, r)))
    }
  }
  #nocov end
  return(reqs)
}

ci_new_pkgs_sysreqs <- function(pkgs, ...) {
  d <- desc::description$new("!new")
  for (pkg in pkgs) {
    d$set_dep(pkg$package)
  }
  ci_sysreqs(d, ...)
}