Tweak the new mocking helpers (#1835)

* Tweak the new mocking helpers

* Incorporate feedback

Author: jennybc

tests/testthat/helper-mocks.R

@@ -0,0 +1,42 @@
+local_cran_version <- function(version, .env = caller_env()) {
+  local_mocked_bindings(cran_version = function() version, .env = .env)
+}
+
+local_check_installed <- function(.env = caller_env()) {
+  local_mocked_bindings(check_installed = function(...) NULL, .env = .env)
+}
+
+local_rstudio_available <- function(val, .env = caller_env()) {
+  local_mocked_bindings(rstudio_available = function(...) val, .env = .env)
+}
+
+local_target_repo_spec <- function(spec, .env = caller_env()) {
+  local_mocked_bindings(target_repo_spec = function(...) spec, .env = .env)
+}
+
+local_roxygen_update_ns <- function(.env = caller_env()) {
+  local_mocked_bindings(roxygen_update_ns = function(...) NULL, .env = .env)
+}
+
+local_check_fun_exists <- function(.env = caller_env()) {
+  local_mocked_bindings(check_fun_exists = function(...) NULL, .env = .env)
+}
+
+local_ui_yeah <- function(.env = caller_env()) {
+  local_mocked_bindings(ui_yeah = function(...) TRUE, .env = .env)
+}
+
+local_git_default_branch_remote <- function(.env = caller_env()) {
+  local_mocked_bindings(
+    git_default_branch_remote = function(remote) {
+      list(
+        name = remote,
+        is_configured = TRUE,
+        url = NA_character_,
+        repo_spec = NA_character_,
+        default_branch = as.character(glue("default-branch-of-{remote}"))
+      )
+    },
+    .env = .env
+  )
+}

tests/testthat/helper.R

@@ -128,75 +128,7 @@ test_file <- function(fname) testthat::test_path("ref", fname)
 expect_proj_file <- function(...) expect_true(file_exists(proj_path(...)))
 expect_proj_dir <- function(...) expect_true(dir_exists(proj_path(...)))
 
-mock_cran_version <- function(version, .env = caller_env()) {
-  local_mocked_bindings(cran_version = function() version, .env = .env)
-}
-
 scrub_checklist_footer <- function(text) {
   gsub("(^<sup>.+on )[-/0-9]{10}(.+ v)[0-9.]{3,12}(.+</sup>$)",
        "\\1DATE\\2VERSION\\3", text)
 }
-
-mock_check_installed <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    check_installed = function(...) TRUE,
-    .env = .env
-  )
-}
-
-mock_check_is_package <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    check_is_package = function(...) invisible(),
-    .env = .env
-  )
-}
-
-mock_rstudio_not_available <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    rstudio_available = function(...) FALSE,
-    .env = .env
-  )
-}
-
-mock_target_repo_spec <- function(spec = "OWNER/REPO", .env = caller_env()) {
-  local_mocked_bindings(
-    target_repo_spec = function(...) spec,
-    .env = .env
-  )
-}
-
-mock_roxygen_update_ns <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    roxygen_update_ns = function(...) NULL,
-    .env = .env
-  )
-}
-
-mock_check_functions_exist <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    check_functions_exist = function(...) TRUE,
-    .env = .env
-  )
-}
-
-mock_git_default_branch_remote <- function(remote = "upstream", .env = caller_env()) {
-  local_mocked_bindings(
-    git_default_branch_remote = function(remote) {
-      list(
-        name = remote,
-        is_configured = TRUE,
-        url = NA_character_,
-        repo_spec = NA_character_,
-        default_branch = as.character(glue("default-branch-of-{remote}"))
-      )
-    },
-    .env = .env
-  )
-}
-
-mock_ui_yeah <- function(.env = caller_env()) {
-  local_mocked_bindings(
-    ui_yeah = function(...) TRUE,
-    .env = .env
-  )
-}

tests/testthat/test-ci.R

@@ -5,7 +5,7 @@ test_that("use_circleci() configures CircleCI", {
   create_local_package()
   use_git()
 
-  mock_target_repo_spec()
+  local_target_repo_spec("OWNER/REPO")
 
   use_circleci(browse = FALSE)
 

tests/testthat/test-cpp11.R

@@ -1,6 +1,6 @@
 test_that("use_cpp11() requires a package", {
   create_local_project()
-  mock_check_installed()
+  local_check_installed()
   expect_usethis_error(use_cpp11(), "not an R package")
 })
 
@@ -9,7 +9,7 @@ test_that("use_cpp11() creates files/dirs, edits DESCRIPTION and .gitignore", {
   use_roxygen_md()
 
   local_interactive(FALSE)
-  mock_check_installed()
+  local_check_installed()
   local_mocked_bindings(check_cpp_register_deps = function() invisible())
 
   use_cpp11()

tests/testthat/test-create.R

@@ -113,7 +113,7 @@ test_that("create_*() works w/ non-existing rel path, open = TRUE, not in RStudi
   withr::defer(dir_delete(sandbox))
   withr::defer(proj_set(orig_proj, force = TRUE))
   withr::local_dir(sandbox)
-  mock_rstudio_not_available()
+  local_rstudio_available(FALSE)
 
   # package
   rel_path_pkg <- path_file(file_temp(pattern = "ghi"))

tests/testthat/test-data-table.R

@@ -6,9 +6,9 @@ test_that("use_data_table() requires a package", {
 test_that("use_data_table() Imports data.table", {
   create_local_package()
   use_package_doc()
-  mock_check_installed()
-  mock_roxygen_update_ns()
-  mock_check_functions_exist()
+  local_check_installed()
+  local_roxygen_update_ns()
+  local_check_fun_exists()
 
   use_data_table()
 
@@ -22,9 +22,9 @@ test_that("use_data_table() blocks use of Depends", {
   create_local_package()
   use_package_doc()
   desc::desc_set("Depends", "data.table")
-  mock_check_installed()
-  mock_roxygen_update_ns()
-  mock_check_functions_exist()
+  local_check_installed()
+  local_roxygen_update_ns()
+  local_check_fun_exists()
 
   expect_warning(
     use_data_table(),

tests/testthat/test-git-default-branch.R

@@ -29,7 +29,7 @@ test_that("git_default_branch() consults the default branch candidates, in order
 
   # finally, prefer something that matches what upstream says is default
   gert::git_branch_create("default-branch-of-upstream", checkout = TRUE, repo = repo)
-  mock_git_default_branch_remote()
+  local_git_default_branch_remote()
   expect_equal(git_default_branch(), "default-branch-of-upstream")
 })
 
@@ -63,13 +63,13 @@ test_that("git_default_branch() errors for local vs remote mismatch", {
   gert::git_add(".gitignore", repo = repo)
   gert::git_commit("a commit, so we are not on an unborn branch", repo = repo)
   git_default_branch_rename(from = git_branch(), to = "foofy")
-  mock_git_default_branch_remote()
+  local_git_default_branch_remote()
 
   expect_error(git_default_branch(), class = "error_default_branch")
 
-   gert::git_branch_create("blarg", checkout = TRUE, repo = repo)
-   mock_git_default_branch_remote()
-   expect_error(git_default_branch(), class = "error_default_branch")
+  gert::git_branch_create("blarg", checkout = TRUE, repo = repo)
+  local_git_default_branch_remote()
+  expect_error(git_default_branch(), class = "error_default_branch")
 })
 
 test_that("git_default_branch_rename() surfaces files that smell fishy", {

tests/testthat/test-news.R

@@ -1,6 +1,6 @@
 test_that("use_news_md() sets (development version)/'Initial submission' in new pkg", {
   create_local_package()
-  mock_cran_version(NULL)
+  local_cran_version(NULL)
 
   use_news_md()
 
@@ -13,7 +13,7 @@ test_that("use_news_md() sets bullet to 'Added a NEWS.md file...' when on CRAN",
 
   # on CRAN, local dev version
   proj_desc_field_update(key = "Version", value = "0.1.0.9000")
-  mock_cran_version("0.1.0")
+  local_cran_version("0.1.0")
 
   use_news_md()
 
@@ -25,7 +25,7 @@ test_that("use_news_md() sets version number when 'production version'", {
   create_local_package()
 
   proj_desc_field_update(key = "Version", value = "0.2.0")
-  mock_cran_version(NULL)
+  local_cran_version(NULL)
 
   use_news_md()
 

tests/testthat/test-package.R

@@ -40,7 +40,7 @@ test_that("use_package(type = 'Suggests') guidance w/o and w/ rlang", {
 
 test_that("use_dev_package() writes a remote", {
   create_local_package()
-  mock_ui_yeah()
+  local_ui_yeah()
 
   use_dev_package("usethis")
   expect_equal(proj_desc()$get_remotes(), "r-lib/usethis")
@@ -59,7 +59,7 @@ test_that("package_remote() works for an installed package with github URL", {
     "Package: test",
     "URL: https://github.com/OWNER/test"
   ))
-  mock_ui_yeah()
+  local_ui_yeah()
   expect_equal(package_remote(d), "OWNER/test")
 })
 

tests/testthat/test-pkgdown.R

@@ -6,7 +6,7 @@ test_that("use_pkgdown() requires a package", {
 test_that("use_pkgdown() creates and ignores the promised file/dir", {
   create_local_package()
   local_interactive(FALSE)
-  mock_check_installed()
+  local_check_installed()
   local_mocked_bindings(pkgdown_version = function() "1.9000")
 
   use_pkgdown()
@@ -28,7 +28,7 @@ test_that("pkgdown helpers behave in the absence of pkgdown", {
 test_that("pkgdown_config_meta() returns a list", {
   create_local_package()
   local_interactive(FALSE)
-  mock_check_installed()
+  local_check_installed()
   local_mocked_bindings(pkgdown_version = function() "1.9000")
 
   use_pkgdown()
@@ -44,7 +44,7 @@ test_that("pkgdown_config_meta() returns a list", {
 test_that("pkgdown_url() returns correct data, warns if pedantic", {
   create_local_package()
   local_interactive(FALSE)
-  mock_check_installed()
+  local_check_installed()
   local_mocked_bindings(pkgdown_version = function() "1.9000")
 
   use_pkgdown()