Deprecate with_mock() and local_mock()

Fixes #1999

Deprecate old mocking functions

Fix news

More news fixes

Merge merge problem

Check revdeps

Author: hadley

NEWS.md

@@ -4,6 +4,7 @@
 
 * Fixed an issue where calling `skip()` outside of an active test could
   cause an unexpected error (@kevinushey, #2039).
+* `local_mock()` and `with_mock()` have been deprecated because they are no longer permitted in R 4.5.
 
 # testthat 3.2.2
 
@@ -49,6 +50,62 @@
 
 * `with_mock()` and `local_mock()` have been unconditionally deprecated as
   they will no longer work in future versions of R (#1999).
+* `with_mock()` and `local_mock()` have been unconditionally deprecated as they will no longer work in future versions of R (#1999).
+* `expect_condition()` and friends now include the `class` of the expected condition in the failure mesage, if used (#1987).
+* `LANGUAGE` is now set to `"C"` in reprocucible environments (i.e.
+  `test_that()` blocks) to disable translations. This fixes warnings
+  about being unable to set the language to `"en"` (#1925).
+* Fixed an issue where `expect_no_error(1)` was failing (#2037).
+
+* Fixed an issue where calling `skip()` outside of an active test could
+  cause an unexpected error (@kevinushey, #2039).
+
+# testthat 3.2.2
+
+## New expectations
+
+* `expect_s7_class()` tests if an object is an S7 class (#1580).
+
+* `expect_no_failure()`, `expect_no_success()` and `expect_snapshot_failure()`
+  provide more options for testing expectations.
+
+## Bug fixes and minor improvements
+
+* testthat now requires waldo 0.6.0 or later to access the latest features
+  (#1955).
+
+* `expect_condition()` and related functions now include the `class` of the
+  expected condition in the failure message, if provided (#1987).
+
+* `expect_error()` and friends now error if you supply `...` but not `pattern`
+  (#1932). They no longer give an uninformative error if they fail inside
+  a magrittr pipe (#1994).
+
+* `expect_no_*()` expectations no longer incorrectly emit a passing test result
+  if they in fact fail (#1997).
+
+* `expect_setequal()` correctly identifies what is missing where (#1962).
+
+* `expect_snapshot()` now strips line breaks in test descriptions
+  (@LDSamson, #1900), and errors when called from a `test_that()` that has an
+  empty description (@kevinushey, #1980).
+
+* `expect_true()` and `expect_false()` give better errors if `actual` isn't a
+  vector (#1996).
+
+* `expect_visible()` and `expect_invisible()` have clearer failure messages
+   (#1966).
+* `local_reproducible_output()` (used in `test_that()` blocks) now sets
+   `LANGUAGE` to `"C"` instead of `"en"` to disable translations,
+   avoiding warnings on some platforms (#1925).
+
+* `skip_if_not_installed()` generates a clearer message that sorts better
+   (@MichaelChirico, #1959).
+
+* `with_mock()` and `local_mock()` have been unconditionally deprecated as
+  they will no longer work in future versions of R (#1999).
+
+* `local_mock()` and `with_mock()` have been deprecated because they are no longer permitted in R 4.5.
 
 # testthat 3.2.1
 

R/mock.R

@@ -1,15 +1,18 @@
 #' Mock functions in a package.
 #'
 #' @description
-#' `r lifecycle::badge("deprecated")`
-#'
 #' `with_mock()` and `local_mock()` are deprecated in favour of
 #' [with_mocked_bindings()] and [local_mocked_bindings()].
 #'
 #' These functions worked by using some C code to temporarily modify the mocked
-#' function _in place_. This was an abuse of R's internals and it is no longer
+#'  function _in place_. This was an abuse of R's internals and it is no longer
 #' permitted.
 #'
+#' @section 3rd edition:
+#' `r lifecycle::badge("deprecated")`
+#'
+#' `with_mock()` and `local_mock()` are deprecated in the third edition.
+#'
 #' @param ... named parameters redefine mocked functions, unnamed parameters
 #'   will be evaluated after mocking the functions
 #' @param .env the environment in which to patch the functions,
@@ -21,116 +24,11 @@
 #' @return The result of the last unnamed parameter
 #' @export
 with_mock <- function(..., .env = topenv()) {
-  lifecycle::deprecate_warn("3.3.0", "with_mock()", "with_mocked_bindings()")
-
-  dots <- eval(substitute(alist(...)))
-  mock_qual_names <- names(dots)
-
-  if (all(mock_qual_names == "")) {
-    warning(
-      "Not mocking anything. Please use named parameters to specify the functions you want to mock.",
-      call. = FALSE
-    )
-    code_pos <- rep(TRUE, length(dots))
-  } else {
-    code_pos <- (mock_qual_names == "")
-  }
-  code <- dots[code_pos]
-
-  mock_funs <- lapply(dots[!code_pos], eval, parent.frame())
-  mocks <- extract_mocks(mock_funs, .env = .env)
-
-  on.exit(lapply(mocks, reset_mock), add = TRUE)
-  lapply(mocks, set_mock)
-
-  # Evaluate the code
-  if (length(code) > 0) {
-    for (expression in code[-length(code)]) {
-      eval(expression, parent.frame())
-    }
-    # Isolate last item for visibility
-    eval(code[[length(code)]], parent.frame())
-  }
+  lifecycle::deprecate_stop("3.3.0", "with_mock()", "with_mocked_bindings()")
 }
 
 #' @export
 #' @rdname with_mock
 local_mock <- function(..., .env = topenv(), .local_envir = parent.frame()) {
-  lifecycle::deprecate_warn("3.3.0", "local_mock()", "local_mocked_bindings()")
-
-  mocks <- extract_mocks(list(...), .env = .env)
-  on_exit <- bquote(
-    on.exit(lapply(.(mocks), .(reset_mock)), add = TRUE),
-  )
-
-  lapply(mocks, set_mock)
-  eval_bare(on_exit, .local_envir)
-  invisible()
-}
-
-pkg_rx <- ".*[^:]"
-colons_rx <- "::(?:[:]?)"
-name_rx <- ".*"
-pkg_and_name_rx <- sprintf("^(?:(%s)%s)?(%s)$", pkg_rx, colons_rx, name_rx)
-
-extract_mocks <- function(funs, .env) {
-  if (is.environment(.env)) {
-    .env <- environmentName(.env)
-  }
-  mock_qual_names <- names(funs)
-
-  lapply(
-    stats::setNames(nm = mock_qual_names),
-    function(qual_name) {
-      pkg_name <- gsub(pkg_and_name_rx, "\\1", qual_name)
-
-      if (is_base_pkg(pkg_name)) {
-        stop(
-          "Can't mock functions in base packages (", pkg_name, ")",
-          call. = FALSE
-        )
-      }
-
-      name <- gsub(pkg_and_name_rx, "\\2", qual_name)
-
-      if (pkg_name == "") {
-        pkg_name <- .env
-      }
-
-      env <- asNamespace(pkg_name)
-
-      if (!exists(name, envir = env, mode = "function")) {
-        stop("Function ", name, " not found in environment ",
-          environmentName(env), ".",
-          call. = FALSE
-        )
-      }
-      mock(name = name, env = env, new = funs[[qual_name]])
-    }
-  )
-}
-
-mock <- function(name, env, new) {
-  target_value <- get(name, envir = env, mode = "function")
-  structure(
-    list(
-      env = env,
-      name = as.name(name),
-      orig_value = .Call(duplicate_, target_value), target_value = target_value,
-      new_value = new
-    ),
-    class = "mock"
-  )
-}
-
-set_mock <- function(mock) {
-  .Call(reassign_function, mock$name, mock$env, mock$target_value, mock$new_value)
-}
-
-reset_mock <- function(mock) {
-  .Call(reassign_function, mock$name, mock$env, mock$target_value, mock$orig_value)
-}
-
-is_base_pkg <- function(x) {
-  x %in% rownames(utils::installed.packages(priority = "base"))
+  lifecycle::deprecate_stop("3.3.0", "local_mock()", "local_mocked_bindings()")
 }