provide a custom testthat skipper

NAMESPACE

@@ -33,6 +33,7 @@ export(real_http_connections_allowed)
 export(request_summary)
 export(response_summary)
 export(serializer_fetch)
+export(skip_if_vcr_off)
 export(turn_off)
 export(turn_on)
 export(turned_off)

R/skip-vcr-off.R

@@ -0,0 +1,26 @@
+#' Skip tests if vcr is off
+#'
+#' Custom testthat skippers to skip tests if vcr is turned off via the
+#' environment variable `VCR_TURN_OFF`.
+#'
+#' @details This might be useful if your test will fail when the cassette was e.g.
+#'  edited (a real request produced a 200 status code but you made it a 502
+#'  status code for testing the behavior of your code when the API errors)
+#'  or if the tests are very specific (e.g. testing
+#'  a date was correctly parsed, but making a real request would produce a different
+#'  date).
+#'
+#' @return Nothing, skip test.
+#' @export
+#'
+#' @seealso lightswitch
+skip_if_vcr_off <- function() {
+
+  if (is(try(find.package("testthat"), silent = TRUE), "try-error")) {
+    stop("This function is meant to be use within testthat tests. Install testthat.")
+  }
+
+  if (nzchar(Sys.getenv("VCR_TURN_OFF")) && as.logical(Sys.getenv("VCR_TURN_OFF"))) {
+    testthat::skip("Not run when vcr is off")
+  }
+}

tests/testthat/test-skip-vcr-off.R

@@ -0,0 +1,9 @@
+test_that("skip_if_vcr_off works when vcr on", {
+  expect_silent(skip_if_vcr_off())
+})
+
+test_that("skip_if_vcr_off works when vcr off", {
+  withr::local_envvar("VCR_TURN_OFF" = TRUE)
+  expect_error(skip_if_vcr_off(), class = "skip")
+})
+