Merge branch 'main' into expect-visible

Author: hadley

NEWS.md

@@ -1,6 +1,11 @@
 # testthat (development version)
 
 * `expect_visible()` and `expect_invisible()` have improved failure messages (#1966).
+* `expect_snapshot()` now strips line breaks in test descriptions (@LDSamson, #1900).
+* `expect_snapshot()` now errors when called from a `test_that()` that has an empty description (@kevinushey, #1980).
+* `skip_if_not_installed()` produces a clearer message (@MichaelChirico, #1959).
+* `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).

R/edition.R

@@ -60,7 +60,6 @@ edition_name <- function(x) {
 #' @export
 #' @param x Edition Should be a single integer.
 #' @param .env Environment that controls scope of changes. For expert use only.
-#' @keywords internal
 local_edition <- function(x, .env = parent.frame()) {
   stopifnot(is_zap(x) || (is.numeric(x) && length(x) == 1))
 

R/expect-condition.R

@@ -278,7 +278,7 @@ expect_condition_matching <- function(base_class,
   )
 
   expected <- !identical(regexp, NA)
-  msg <- compare_condition_3e(base_class, act$cap, act$lab, expected)
+  msg <- compare_condition_3e(base_class, class, act$cap, act$lab, expected)
 
   # Access error fields with `[[` rather than `$` because the
   # `$.Throwable` from the rJava package throws with unknown fields
@@ -375,10 +375,14 @@ capture_matching_condition <- function(expr, matches) {
 
 # Helpers -----------------------------------------------------------------
 
-compare_condition_3e <- function(cond_type, cond, lab, expected) {
+compare_condition_3e <- function(cond_type, cond_class, cond, lab, expected) {
   if (expected) {
     if (is.null(cond)) {
-      sprintf("%s did not throw the expected %s.", lab, cond_type)
+      if (is.null(cond_class)) {
+        sprintf("%s did not throw the expected %s.", lab, cond_type)
+      } else {
+        sprintf("%s did not throw a %s with class <%s>.", lab, cond_type, cond_class)
+      }
     } else {
       NULL
     }

R/expect-constant.R

@@ -50,7 +50,6 @@ expect_false <- function(object, info = NULL, label = NULL) {
 #' check for it either with `expect_equal(x, NULL)` or `expect_type(x, "NULL")`.
 #'
 #' @inheritParams expect_that
-#' @keywords internal
 #' @export
 #' @family expectations
 #' @examples
@@ -83,4 +82,3 @@ expect_waldo_constant <- function(act, constant, info) {
 
   invisible(act$val)
 }
-

R/expect-self-test.R

@@ -7,7 +7,6 @@
 #' @param expr Expression that evaluates a single expectation.
 #' @param message Check that the failure message matches this regexp.
 #' @param ... Other arguments passed on to [expect_match()].
-#' @keywords internal
 #' @export
 expect_success <- function(expr) {
   exp <- capture_expectation(expr)
@@ -114,4 +113,3 @@ local_output_override <- function(width = 80, crayon = TRUE, unicode = TRUE,
     reporter$unicode <- old_unicode
   }, .env)
 }
-

R/expectation.R

@@ -89,7 +89,6 @@ expect <- function(ok, failure_message,
 #' @param message Message describing test failure
 #' @param srcref Optional `srcref` giving location of test.
 #' @inheritParams expect
-#' @keywords internal
 #' @export
 expectation <- function(type, message, srcref = NULL, trace = NULL) {
   new_expectation(type, message, srcref = srcref, trace = trace)

R/expectations-matches.R

@@ -15,7 +15,6 @@
 #'   (not a regular expressions). Overrides `perl`.
 #' @inheritDotParams base::grepl -pattern -x -perl -fixed
 #' @family expectations
-#' @keywords internal
 #' @export
 #' @examples
 #' expect_match("Testing is fun", "fun")

R/mock.R

@@ -1,19 +1,14 @@
 #' Mock functions in a package.
 #'
 #' @description
-#' `r lifecycle::badge("superseded")`
+#' `r lifecycle::badge("deprecated")`
 #'
-#' `with_mock()` and `local_mock()` are superseded in favour of
+#' `with_mock()` and `local_mock()` are deprecated in favour of
 #' [with_mocked_bindings()] and [local_mocked_bindings()].
 #'
-#' These works by using some C code to temporarily modify the mocked function
-#' _in place_. This is abusive of R's internals, which makes it dangerous, and
-#' no longer recommended.
-#'
-#' @section 3rd edition:
-#' `r lifecycle::badge("deprecated")`
-#'
-#' `with_mock()` and `local_mock()` are deprecated in the third edition.
+#' 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
+#' permitted.
 #'
 #' @param ... named parameters redefine mocked functions, unnamed parameters
 #'   will be evaluated after mocking the functions
@@ -26,7 +21,7 @@
 #' @return The result of the last unnamed parameter
 #' @export
 with_mock <- function(..., .env = topenv()) {
-  edition_deprecate(3, "with_mock()", "Please use with_mocked_bindings() instead")
+  lifecycle::deprecate_warn("3.3.0", "with_mock()", "with_mocked_bindings()")
 
   dots <- eval(substitute(alist(...)))
   mock_qual_names <- names(dots)
@@ -61,7 +56,7 @@ with_mock <- function(..., .env = topenv()) {
 #' @export
 #' @rdname with_mock
 local_mock <- function(..., .env = topenv(), .local_envir = parent.frame()) {
-  edition_deprecate(3, "local_mock()", "Please use local_mocked_bindings() instead")
+  lifecycle::deprecate_warn("3.3.0", "local_mock()", "local_mocked_bindings()")
 
   mocks <- extract_mocks(list(...), .env = .env)
   on_exit <- bquote(

R/skip.R

@@ -19,7 +19,7 @@
 #'
 #' * `skip_if_offline()` skips if an internet connection is not available
 #'   (using [curl::nslookup()]) or if the test is run on CRAN. Requires
-#'   the curl packages to be installed.
+#'   \{curl\} to be installed and included in the dependencies of your package.
 #'
 #' * `skip_if_translated("msg")` skips tests if the "msg" is translated.
 #'
@@ -100,8 +100,14 @@ skip_if <- function(condition, message = NULL) {
 #' @param minimum_version Minimum required version for the package
 #' @rdname skip
 skip_if_not_installed <- function(pkg, minimum_version = NULL) {
+  # most common case: it's not installed
+  tryCatch(
+    find.package(pkg),
+    error = function(e) skip(paste0("{", pkg, "} is not installed"))
+  )
+  # rarer: it's installed, but fails to load
   if (!requireNamespace(pkg, quietly = TRUE)) {
-    skip(paste0(pkg, " cannot be loaded"))
+    skip(paste0("{", pkg, "} cannot be loaded"))
   }
 
   if (!is.null(minimum_version)) {

R/snapshot-reporter.R

@@ -35,7 +35,7 @@ SnapshotReporter <- R6::R6Class("SnapshotReporter",
     },
 
     start_test = function(context, test) {
-      self$test <- test
+      self$test <- gsub("\n", "", test)
     },
 
     # Called by expectation
@@ -46,6 +46,7 @@ SnapshotReporter <- R6::R6Class("SnapshotReporter",
                              tolerance = testthat_tolerance(),
                              variant = NULL,
                              trace_env = NULL) {
+      check_string(self$test, allow_empty = FALSE)
       i <- self$new_snaps$append(self$test, variant, save(value))
 
       old_raw <- self$old_snaps$get(self$test, variant, i)