Better feedback when testing interactively

When a test passes, say so. Includes some refactoring to eliminate a vestigial method.

Author: hadley

NEWS.md

@@ -1,5 +1,6 @@
 # testthat (development version)
 
+* When running a test interactively, testthat now reports the number of succeses.
 * The hints generated by `expect_snapshot()` and `expect_snapshot_file()` now include the path to the package, if its not in the current working directory (#1577).
 * `expect_snapshot_file()` now clearly errors if the `path` doesnt exist (#2191).
 * `expect_snapshot_file()` now considers `.json` to be a text file (#1593).

R/local.R

@@ -201,7 +201,6 @@ local_interactive_reporter <- function(.env = parent.frame()) {
   reporter <- StopReporter$new()
   old <- set_reporter(reporter)
   withr::defer(reporter$end_reporter(), envir = .env)
-  withr::defer(reporter$stop_if_needed(), envir = .env)
   withr::defer(set_reporter(old), envir = .env)
 
   reporter

R/reporter-stop.R

@@ -21,18 +21,18 @@ StopReporter <- R6::R6Class(
     n_fail = 0L,
     # Successful expectations
     n_success = 0L,
-    stop_reporter = TRUE,
     praise = TRUE,
 
-    initialize = function(stop_reporter = TRUE, praise = TRUE) {
+    initialize = function(praise = TRUE) {
       super$initialize()
       self$issues <- Stack$new()
       self$praise <- praise
-      self$stop_reporter <- stop_reporter
     },
 
     start_test = function(context, test) {
       self$issues <- Stack$new()
+      self$n_fail <- 0L
+      self$n_success <- 0L
     },
 
     add_result = function(context, test, result) {
@@ -45,25 +45,32 @@ StopReporter <- R6::R6Class(
         self$n_fail <- self$n_fail + 1
       }
       self$issues$push(result)
-
-      self$local_user_output()
-      self$cat_line(issue_summary(result, rule = TRUE), "\n")
     },
 
-    end_reporter = function(context, test) {
+    end_test = function(context, test) {
       self$local_user_output()
 
-      if (self$issues$size() == 0) {
-        if (self$praise && self$n_success > 0) {
-          emoji <- praise_emoji()
-          self$cat_line(colourise("Test passed", "success"), " ", emoji)
-        }
+      for (issue in self$issues$as_list()) {
+        self$cat_line(issue_summary(issue, rule = TRUE), "\n")
+      }
+
+      if (self$praise && self$n_fail == 0 && self$n_success > 0) {
+        emoji <- praise_emoji()
+        self$cat_line(
+          "Test ",
+          colourise("passed", "success"),
+          " with ",
+          self$n_success,
+          " successes ",
+          emoji
+        )
       }
-    },
 
-    stop_if_needed = function() {
-      if (self$stop_reporter && self$n_fail > 0) {
-        cli::cli_abort("Test failed.", call = NULL)
+      if (self$n_fail > 0) {
+        cli::cli_abort(
+          "Test failed with {self$n_fail} failure{?s} and {self$n_success} success{?es}.",
+          call = NULL
+        )
       }
     }
   )

tests/testthat/_snaps/reporter-stop.md

@@ -1,59 +1,23 @@
 # produces useful output
 
+    Test passed with 1 successes 
     -- Failure ('reporters/tests.R:13:3'): Failure:1 -------------------------------
     Expected `x` to be TRUE.
     Differences:
     `actual`:   FALSE
     `expected`: TRUE 
 
 
-    -- Failure ('reporters/tests.R:17:8'): Failure:2a ------------------------------
-    Expected FALSE to be TRUE.
-    Differences:
-    `actual`:   FALSE
-    `expected`: TRUE 
-    
-    Backtrace:
-        x
-     1. \-f()
-     2.   \-testthat::expect_true(FALSE)
-    
-    -- Error ('reporters/tests.R:24:3'): Error:1 -----------------------------------
-    Error in `eval(code, test_env)`: stop
-    
-    -- Error ('reporters/tests.R:30:8'): errors get tracebacks ---------------------
-    Error in `h()`: !
-    Backtrace:
-        x
-     1. \-f()
-     2.   \-g()
-     3.     \-h()
-    
-    -- Skip ('reporters/tests.R:38:3'): explicit skips are reported ----------------
-    Reason: skip
-    
-    -- Skip ('reporters/tests.R:41:1'): empty tests are implicitly skipped ---------
-    Reason: empty test
-    
-    -- Warning ('reporters/tests.R:47:5'): warnings get backtraces -----------------
-    def
-    Backtrace:
-        x
-     1. \-f()
-    
-    -- Skip ('reporters/tests.R:45:1'): warnings get backtraces --------------------
-    Reason: empty test
-    
 
 # can suppress praise
 
 
 
-# stop if needed errors when needed
+# errors when needed
 
     Code
-      r$stop_if_needed()
+      r$end_test()
     Condition
       Error:
-      ! Test failed.
+      ! Test failed with 1 failure and 0 successes.
 

tests/testthat/test-reporter-stop.R

@@ -9,11 +9,11 @@ test_that("can suppress praise", {
   )
 })
 
-test_that("stop if needed errors when needed", {
+test_that("errors when needed", {
   r <- StopReporter$new()
-  expect_no_error(r$stop_if_needed())
+  expect_no_error(r$end_test())
+
   r$n_fail <- 1
-  expect_snapshot(error = TRUE, r$stop_if_needed())
-  r$stop_reporter <- FALSE
-  expect_no_error(r$stop_if_needed())
+  r$n_success <- 0
+  expect_snapshot(error = TRUE, r$end_test())
 })