Polish parallel errors

Author: hadley

NAMESPACE

@@ -192,6 +192,7 @@ export(skip_on_os)
 export(skip_on_travis)
 export(skip_unless_r)
 export(snapshot_accept)
+export(snapshot_reject)
 export(snapshot_review)
 export(source_dir)
 export(source_file)

NEWS.md

@@ -1,5 +1,6 @@
 # testthat (development version)
 
+* New `snapshot_reject()` rejects all modified snapshots by deleting the `.new` variants (#1923).
 * New `SlowReporter` makes it easier to find the slowest tests in your package. The easiest way to run it is with `devtools::test(reporter = "slow")` (#1466).
 * Power `expect_mapequal()` with `waldo::compare(list_as_map = TRUE)` (#1521).
 * On CRAN, `test_that()` now automatically skips if a package is not installed (#1585). Practically, this means that you no longer need to check that suggested packages are installed. (We don't do this in the tidyverse because we think it has limited payoff, but other styles advise differently.)
@@ -19,7 +20,7 @@
 * `vignette("custom-expectations)` has been overhauled to make it much clearer how to create high-quality expectations (#2113, #2132, #2072).
 * `expect_snapshot()` and friends will now fail when creating a new snapshot on CI. This is usually a signal that you've forgotten to run it locally before committing (#1461).
 * `expect_snapshot_value()` can now handle expressions that generate `-` (#1678) or zero length atomic vectors (#2042).
-* `expect_matches()` failures should be a little easier to read (#2135).
+* `expect_matches()` failures should be a little easier to read (#2135, #2181).
 * New `local_on_cran(TRUE)` allows you to simulate how your tests will run on CRAN (#2112).
 * `expect_no_*()` now executes the entire code block, rather than stopping at the first message or warning (#1991).
 * `expect_no_failures()` and `expect_no_successes()` are now deprecated as `expect_success()` now test for no failures and `expect_failure()` tests for no successes (#)

R/expect-match.R

@@ -106,6 +106,7 @@ expect_match_ <- function(
   info = NULL,
   label = NULL,
   negate = FALSE,
+  title = "Text",
   trace_env = caller_env()
 ) {
   matches <- grepl(regexp, act$val, perl = perl, fixed = fixed, ...)
@@ -118,14 +119,24 @@ expect_match_ <- function(
 
   text <- encodeString(act$val)
   if (length(act$val) == 1) {
-    values <- paste0('Text: "', text, '"')
+    values <- paste0(title, ': "', text, '"')
+    which <- ""
   } else {
-    values <- paste0("Text:\n", paste0("* ", text, collapse = "\n"))
+    bullet <- ifelse(
+      condition,
+      cli::col_green(cli::symbol$tick),
+      cli::col_red(cli::symbol$cross)
+    )
+    values <- paste0(title, ":\n", paste0(bullet, " ", text, collapse = "\n"))
+    which <- if (all) "Every element of " else "Some element of "
   }
+  match <- if (negate) "matches" else "does not match"
 
   msg <- sprintf(
-    if (negate) "%s matches %s %s.\n%s" else "%s does not match %s %s.\n%s",
+    "%s%s %s %s %s.\n%s",
+    which,
     act$lab,
+    match,
     if (fixed) "string" else "regexp",
     encodeString(regexp, quote = '"'),
     values

R/expect-output.R

@@ -48,6 +48,6 @@ expect_output <- function(
     pass(act$val)
   } else {
     act <- labelled_value(act$cap, act$lab)
-    expect_match_(act, enc2native(regexp), ...)
+    expect_match_(act, enc2native(regexp), ..., title = "Output")
   }
 }

R/snapshot-file.R

@@ -188,11 +188,13 @@ snapshot_review_hint <- function(
   )
 }
 
+
 snapshot_file_equal <- function(
-  snap_test_dir,
-  snap_name,
-  snap_variant,
-  path,
+  snap_dir, # _snaps/
+  snap_test, # test file name
+  snap_name, # snapshot file name
+  snap_variant, # variant (optional)
+  path, # path to new file
   file_equal = compare_file_binary,
   fail_on_new = FALSE,
   trace_env = caller_env()
@@ -201,8 +203,14 @@ snapshot_file_equal <- function(
     cli::cli_abort("{.path {path}} not found.")
   }
 
+  if (is.null(snap_variant)) {
+    snap_test_dir <- file.path(snap_dir, snap_test)
+  } else {
+    snap_test_dir <- file.path(snap_dir, snap_variant, snap_test)
+  }
+
   cur_path <- file.path(snap_test_dir, snap_name)
-  new_path <- new_name(cur_path)
+  new_path <- file.path(snap_test_dir, new_name(snap_name))
 
   if (file.exists(cur_path)) {
     eq <- file_equal(cur_path, path)
@@ -217,10 +225,10 @@ snapshot_file_equal <- function(
     dir.create(snap_test_dir, showWarnings = FALSE, recursive = TRUE)
     file.copy(path, cur_path)
 
-    message <- paste0(
+    message <- paste_c(
       "Adding new file snapshot: 'tests/testthat/_snaps/",
-      snap_variant,
-      if (!is.null(snap_variant)) "/",
+      c(snap_variant, if (!is.null(snap_variant)) "/"),
+      c(snap_test, "/"),
       snap_name,
       "'"
     )

R/snapshot-manage.R

@@ -1,6 +1,7 @@
 #' Accept or reject modified snapshots
 #'
 #' * `snapshot_accept()` accepts all modified snapshots.
+#' * `snapshot_reject()` rejects all modified snapshots by deleting the `.new` variants.
 #' * `snapshot_review()` opens a Shiny app that shows a visual diff of each
 #'    modified snapshot. This is particularly useful for whole file snapshots
 #'    created by `expect_snapshot_file()`.
@@ -26,6 +27,22 @@ snapshot_accept <- function(files = NULL, path = "tests/testthat") {
   invisible()
 }
 
+#' @rdname snapshot_accept
+#' @export
+snapshot_reject <- function(files = NULL, path = "tests/testthat") {
+  changed <- snapshot_meta(files, path)
+  if (nrow(changed) == 0) {
+    inform("No snapshots to reject")
+    return(invisible())
+  }
+
+  inform(c("Rejecting snapshots:", changed$name))
+  unlink(changed$new)
+
+  rstudio_tickle()
+  invisible()
+}
+
 #' @rdname snapshot_accept
 #' @export
 snapshot_review <- function(files = NULL, path = "tests/testthat") {

R/snapshot-reporter.R

@@ -108,13 +108,9 @@ SnapshotReporter <- R6::R6Class(
     ) {
       self$announce_file_snapshot(name)
 
-      if (is.null(variant)) {
-        snap_dir <- file.path(self$snap_dir, self$file)
-      } else {
-        snap_dir <- file.path(self$snap_dir, variant, self$file)
-      }
       snapshot_file_equal(
-        snap_test_dir = snap_dir,
+        snap_dir = self$snap_dir,
+        snap_test = self$file,
         snap_name = name,
         snap_variant = variant,
         path = path,

R/utils.R

@@ -63,3 +63,7 @@ no_wrap <- function(x) {
   x <- gsub("\n", "\f", x, fixed = TRUE)
   x
 }
+
+paste_c <- function(...) {
+  paste0(c(...), collapse = "")
+}

man/snapshot_accept.Rd

@@ -9,13 +9,19 @@
 
 ---
 
-    `many` does not match regexp "asdf".
+    Every element of `many` does not match regexp "a".
     Text:
-    * a
-    * b
-    * c
-    * d
-    * e
+    ✔ a
+    ✔ a
+    ✖ b
+
+---
+
+    Some element of `many` does not match regexp "c".
+    Text:
+    ✖ a
+    ✖ a
+    ✖ b
 
 # expect_match validates its inputs