rdev: R Development Tools

withr::local_dir("test-ci")

# check_renv

test_that("check_renv validates arguments", {
  mockery::stub(check_renv, "renv::status", NULL)
  mockery::stub(check_renv, "renv::clean", NULL)
  mockery::stub(check_renv, "renv::update", NULL)

  expect_error(check_renv(update = NA), "'update'")
})

test_that("All renv functions are called, unless set to FALSE", {
  mockery::stub(check_renv, "renv::status", NULL)
  mockery::stub(check_renv, "renv::clean", NULL)
  mockery::stub(check_renv, "renv::update", NULL)

  begin <- "^"
  end <- "$"
  sep <- "\\n\\n"
  status <- "renv::status\\(dev = TRUE\\)"
  clean <- "renv::clean\\(\\)"
  update <- "renv::update\\(\\)"

  expect_output(check_renv(update = TRUE), paste0(begin, status, sep, clean, sep, update, end))
  expect_output(check_renv(update = FALSE), paste0(begin, status, sep, clean, end))
})

# style_all

test_that("style_all tests all file types", {
  # test files include renv/test.R, packrat/test.R, and R/RcppExports.R which should be excluded
  # set styler.quiet = TRUE to suppress output
  expect_identical(nrow(withr::with_options(list(styler.quiet = TRUE), style_all())), 7L)
})

# lint_all

test_that("lint_all checks all file types", {
  # test files include renv/test.R, packrat/test.R, and R/RcppExports.R which should be excluded
  all_files <- c(
    "test-revealjs.qmd", "test.Rrst", "test.Rtex", "test.Rtxt", "testcode.Rhtml", "testcode.Rmd",
    "testcode.Rnw", "testcode.Rpres", "testcode.qmd", "testcode_1.R", "testcode_2.R"
  )
  withr::local_options(lintr.linter_file = "lintr_test_config")
  expect_named(lint_all(), all_files)
})

# ci

test_that("ci validates arguments", {
  mockery::stub(ci, "renv::status", NULL)
  mockery::stub(ci, "missing_deps", NULL)
  mockery::stub(ci, "fs::file_exists", NULL)
  mockery::stub(ci, "pkgdown::check_pkgdown", NULL)
  mockery::stub(ci, "style_all", NULL)
  mockery::stub(ci, "lint_all", NULL)
  mockery::stub(ci, "gert::git_status", NULL)
  mockery::stub(ci, "devtools::document", NULL)
  mockery::stub(ci, "desc::desc_normalize", NULL)
  mockery::stub(ci, "print_tbl", NULL)
  mockery::stub(ci, "extra_deps", NULL)
  mockery::stub(ci, "url_check", NULL)
  mockery::stub(ci, "html_url_check", NULL)
  mockery::stub(ci, "rcmdcheck::rcmdcheck", NULL)

  expect_error(ci(renv = NA), "'renv'")
  expect_error(ci(missing = NA), "'missing'")
  expect_error(ci(pkgdown = NA), "'pkgdown'")
  expect_error(ci(styler = NA), "'styler'")
  expect_error(ci(lintr = NA), "'lintr'")
  expect_error(ci(document = NA), "'document'")
  expect_error(ci(normalize = NA), "'normalize'")
  expect_error(ci(extra = NA), "'extra'")
  expect_error(ci(urls = NA), "'urls'")
  expect_error(ci(rcmdcheck = NA), "'rcmdcheck'")
})

test_that("All renv functions are called according to ci logic", {
  renv_sync_true <- list(library = list(), lockfile = list(), synchronized = TRUE)
  renv_sync_false <- list(library = list(), lockfile = list(), synchronized = FALSE)
  missing_deps_empty <- structure(
    list(
      Source = character(0), Package = character(0), Require = character(0),
      Version = character(0), Dev = logical(0)
    ),
    row.names = integer(0), class = "data.frame"
  )
  missing_deps_missing <- structure(
    list(Source = "R/missing.R", Package = "missing", Require = "", Version = "", Dev = FALSE),
    row.names = 88L, class = "data.frame"
  )
  git_status_empty <- structure(
    list(file = character(0), status = character(0), staged = logical(0)),
    row.names = integer(0), class = c("tbl_df", "tbl", "data.frame")
  )
  git_status_changed <- structure(
    list(file = "test", status = "new", staged = FALSE),
    row.names = c(NA, -1L), class = c("tbl_df", "tbl", "data.frame")
  )
  mockery::stub(ci, "renv::status", renv_sync_true)
  mockery::stub(ci, "missing_deps", missing_deps_empty)
  mockery::stub(ci, "fs::file_exists", TRUE)
  mockery::stub(ci, "pkgdown::check_pkgdown", NULL)
  mockery::stub(ci, "style_all", NULL)
  mockery::stub(ci, "lint_all", NULL)
  mockery::stub(ci, "gert::git_status", git_status_empty)
  mockery::stub(ci, "devtools::document", NULL)
  mockery::stub(ci, "desc::desc_normalize", NULL)
  mockery::stub(ci, "print_tbl", NULL)
  mockery::stub(ci, "extra_deps", NULL)
  mockery::stub(ci, "url_check", NULL)
  mockery::stub(ci, "html_url_check", NULL)
  mockery::stub(ci, "rcmdcheck::rcmdcheck", NULL)

  begin <- "^"
  end <- "$"
  sep <- "\\n\\n"
  renv <- "renv::status\\(dev = TRUE\\)"
  missing <- "missing_deps\\(\\)"
  pkgdown <- "pkgdown::check_pkgdown\\(\\)"
  styler <- "style_all\\(\\)"
  lintr <- "lint_all\\(\\)"
  document <- "devtools::document\\(\\)"
  normalize <- "desc::desc_normalize\\(\\)"
  extra <- "extra_deps\\(\\)"
  urls <- "url_check\\((\\))\nhtml_url_check\\(\\)"
  rcmdcheck <- paste0(
    'Setting env vars: NOT_CRAN="true", CI="true"\\n',
    'rcmdcheck::rcmdcheck\\(args = "--no-manual", error_on = "warning"\\)'
  )

  # default
  expect_output(
    ci(),
    paste0(
      begin, renv, sep, missing, sep, pkgdown, sep, styler, sep, lintr, sep, document, sep,
      normalize, sep, extra, sep, urls, sep, rcmdcheck, end
    )
  )

  # all
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = TRUE, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(
      begin, renv, sep, missing, sep, pkgdown, sep, styler, sep, lintr, sep, document, sep,
      normalize, sep, extra, sep, urls, sep, rcmdcheck, end
    )
  )

  # none
  expect_output(
    ci(
      renv = FALSE, missing = FALSE, pkgdown = FALSE, styler = FALSE, lintr = FALSE,
      document = FALSE, normalize = FALSE, extra = FALSE, urls = FALSE, rcmdcheck = FALSE
    ), NA
  )

  # uncommitted changes
  mockery::stub(ci, "gert::git_status", git_status_changed)
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = NULL, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(
      begin, renv, sep, missing, sep, pkgdown, sep, lintr, sep, document, sep, normalize, sep,
      extra, sep, urls, sep, rcmdcheck, end
    )
  )

  # lints found
  mockery::stub(ci, "gert::git_status", git_status_empty)
  mockery::stub(ci, "lint_all", list("lint"))
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = NULL, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(begin, renv, sep, missing, sep, pkgdown, sep, styler, sep, lintr, end)
  )

  # no _pkgdown.yml
  mockery::stub(ci, "fs::file_exists", FALSE)
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = NULL, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(begin, renv, sep, missing, sep, styler, sep, lintr, end)
  )

  # missing dependencies
  mockery::stub(ci, "missing_deps", missing_deps_missing)
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = NULL, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(begin, renv, sep, missing, end)
  )

  # renv not synchronized
  mockery::stub(ci, "renv::status", renv_sync_false)
  expect_output(
    ci(
      renv = TRUE, missing = TRUE, pkgdown = TRUE, styler = NULL, lintr = TRUE, document = TRUE,
      normalize = TRUE, extra = TRUE, urls = TRUE, rcmdcheck = TRUE
    ),
    paste0(begin, renv, end)
  )
})