Deprecate check_cassette_names()

NEWS.md

@@ -3,6 +3,7 @@ vcr (development version)
 
 ### BREAKING CHANGES
 
+* `check_cassette_names()` has been deprecated since it can't be implemented 100% correctly and diagnoses a relatively rare problem (#166).
 * `RequestHandler` and its subclasses are no longer exported.
 * Internal `real_http_connections_allowed()` is no longer exported and has been removed.
 * Internal `Request` and `VcrResponse` classes are no longer exported and have been removed.

R/check_cassette_names.R

@@ -1,15 +1,14 @@
 #' Check cassette names
 #'
 #' @description
-#' This function is meant to be run during your tests, from a
-#' [`helper-*.R` file](https://testthat.r-lib.org/reference/test_dir.html#special-files)
-#' inside the `tests/testthat` directory.
+#' `r lifecycle::badge("deprecated")`
 #'
-#' It only checks that cassette names are not duplicated. Note that if you do
-#' need to have duplicated cassette names you can do so by using the
-#' `allowed_duplicates` parameter in `check_cassette_names()`.
+#' This function has been deprecated because it's not possible for it to
+#' detect re-used cassette names 100% correctly and the problem of duplicated
+#' cassette names is relatively easy to debug by hand.
 #'
 #' @export
+#' @keywords internal
 #' @param pattern (character) regex pattern for file paths to check.
 #' This is done inside of `tests/testthat/`. Default: "test-".
 #' @param behavior (character) "stop" (default) or "warning". If "warning",
@@ -23,9 +22,11 @@ check_cassette_names <- function(
   behavior = "stop",
   allowed_duplicates = NULL
 ) {
+  lifecycle::deprecate_warn("2.0.0", "check_cassette_names()")
+
   assert(allowed_duplicates, "character")
   files <- list.files(".", pattern = pattern, full.names = TRUE)
-  if (length(files) == 0) return()
+  if (length(files) == 0) return(invisible())
   cassette_names <- function(x) {
     tmp <- parse(x, keep.source = TRUE)
     df <- utils::getParseData(tmp)
@@ -59,4 +60,5 @@ check_cassette_names <- function(
       warning = warning(mssg, call. = FALSE, immediate. = TRUE)
     )
   }
+  invisible()
 }

_pkgdown.yml

@@ -11,14 +11,12 @@ reference:
       - cassette_path
       - cassettes
       - current_cassette
-      - check_cassette_names
   - title: Other helpers
     contents:
       - vcr_last_error
       - skip_if_vcr_off
       - vcr_test_path
       - turn_off
-      - use_vcr
 
 articles:
   - title: All vignettes

tests/testthat/_snaps/check_cassette_names.md

@@ -0,0 +1,17 @@
+# check_cassette_names is deprecated
+
+    Code
+      check_cassette_names(dir)
+    Condition
+      Warning:
+      `check_cassette_names()` was deprecated in vcr 2.0.0.
+
+# check_cassette_names
+
+    Code
+      check_cassette_names()
+    Condition
+      Error:
+      ! you should not have duplicated cassette names:
+          testing (found in test-catbar.R, test-single.R)
+

tests/testthat/helper-vcr.R

@@ -20,6 +20,7 @@ make_pkg <- function(frame = parent.frame()) {
 
   dir_create(file.path(dir, "man"))
   dir_create(file.path(dir, "R"))
+  dir_create(file.path(dir, "tests", "testthat"))
   cat(sprintf(desc_text, basename(dir)), file = file.path(dir, "DESCRIPTION"))
 
   dir

tests/testthat/test-check_cassette_names.R

@@ -1,27 +1,34 @@
-test_that("check_cassette_names", {
-  withr::local_options(lifecycle_verbosity = "quiet")
-
+test_that("check_cassette_names is deprecated", {
   dir <- make_pkg()
+  expect_snapshot(check_cassette_names(dir))
+})
 
-  res <- use_vcr(dir, verbose = FALSE)
-  strg_dup <- 'test_that("bar", {\n  vcr::use_cassette("testing", cat("bar"))\n  vcr::use_cassette("testing", cat("bar"))\n})'
-  cat(strg_dup, file = file.path(dir, "tests/testthat/test-catbar.R"))
-  strg_single <- 'test_that("bar", {\n  expect_true(TRUE)\n  vcr::use_cassette("testing", cat("bar"))\n})'
-  cat(strg_single, file = file.path(dir, "tests/testthat/test-single.R"))
-  strg_not_used <- 'hi'
-  cat(strg_not_used, file = file.path(dir, "tests/testthat/cat.R"))
+test_that("check_cassette_names", {
+  withr::local_options(lifecycle_verbosity = "quiet")
 
-  withr::local_dir(file.path(dir, "tests/testthat"))
-  expect_error(
-    check_cassette_names(),
-    "you should not have duplicated cassette names",
-    class = "error"
+  test_path <- file.path(make_pkg(), "tests/testthat")
+  writeLines(
+    c(
+      'test_that("bar", {',
+      '  vcr::use_cassette("testing", cat("bar"))',
+      '  vcr::use_cassette("testing", cat("bar"))',
+      '})'
+    ),
+    file.path(test_path, "test-catbar.R")
   )
-  mssg <- tryCatch(check_cassette_names(), error = function(e) e)
-  expect_match(mssg$message, "you should not have duplicated cassette names")
-  expect_match(mssg$message, "testing \\(found in ")
-  expect_match(mssg$message, "test-catbar.R, test-single.R, test-vcr_example.R")
+  writeLines(
+    c(
+      'test_that("bar", {',
+      '  vcr::use_cassette("testing", cat("bar"))',
+      '})'
+    ),
+    file.path(test_path, "test-single.R")
+  )
+  writeLines("hi", con = file.path(test_path, "cat.R"))
+
+  withr::local_dir(test_path)
+  expect_snapshot(check_cassette_names(), error = TRUE)
 
   # can allow duplicated names via the allowed_duplicates param
-  expect_error(check_cassette_names(allowed_duplicates = "testing"), NA)
+  expect_no_error(check_cassette_names(allowed_duplicates = "testing"))
 })

vignettes/debugging.Rmd

@@ -143,3 +143,7 @@ Make sure you ejected the cassette you were using!
 
 Unless your vcr helper/setup file tweaked more things than you would like, 
 you do not even need to re-start R, but you could, just to be on the safe side.
+
+### Re-used cassestte name
+
+You need to make sure that every test has it's own unique cassette name, otherwise you won't find the responses that you're expecting. This is generally a fairly easy problem to diagnose if you're aware of it: if you re-record the cassette to fix the test you're currently in, a different test will break.