Clean up temporary file in verify_exec() (#1876)

And reduce tempfile creation in tests

Author: hadley

NEWS.md

@@ -31,6 +31,9 @@
 * `expect_setequal()` correctly displays results when only one of actual and
   expected is missing values (#1835).
 
+* `expect_snapshot()` and friends no longer create a temporary file for every
+  invocation.
+
 * `expect_snapshot_file()` now generates clickable links to review changes 
   (#1821).
 

R/reporter-junit.R

@@ -136,7 +136,7 @@ JunitReporter <- R6::R6Class("JunitReporter",
       if (is.character(self$out)) {
         xml2::write_xml(self$doc, self$out, format = TRUE)
       } else if (inherits(self$out, "connection")) {
-        file <- tempfile()
+        file <- withr::local_tempfile()
         xml2::write_xml(self$doc, file, format = TRUE)
         cat(brio::read_file(file), file = self$out)
       } else {

R/snapshot-file.R

@@ -239,14 +239,14 @@ split_path <- function(path) {
   )
 }
 
-write_tmp_lines <- function(lines, ext = ".txt", eol = "\n") {
-  path <- tempfile(fileext = ext)
+write_tmp_lines <- function(lines, ext = ".txt", eol = "\n", envir = caller_env()) {
+  path <- withr::local_tempfile(fileext = ext, .local_envir = envir)
   brio::write_lines(lines, path, eol = eol)
   path
 }
 
 local_snap_dir <- function(paths, .env = parent.frame()) {
-  dir <- tempfile()
+  dir <- withr::local_tempfile(.local_envir = .env)
   withr::defer(unlink(paths), envir = .env)
 
   dirs <- file.path(dir, unique(dirname(paths)))

R/test-example.R

@@ -53,7 +53,7 @@ test_rd <- function(rd, title = attr(rd, "Rdfile")) {
 #' @export
 #' @rdname test_examples
 test_example <- function(path, title = path) {
-  ex_path <- tempfile(fileext = ".R")
+  ex_path <- withr::local_tempfile(pattern = "test_example-", fileext = ".R")
   tools::Rd2ex(path, ex_path)
   if (!file.exists(ex_path)) {
     return(invisible(FALSE))

R/verify-output.R

@@ -71,7 +71,8 @@ verify_exec <- function(expr, env = caller_env(), replay = output_replay) {
     exprs <- list(expr)
   }
 
-  withr::local_pdf(tempfile())
+  device_path <- withr::local_tempfile(pattern = "verify_exec_")
+  withr::local_pdf(device_path)
   grDevices::dev.control(displaylist = "enable")
 
   exprs <- lapply(exprs, function(x) if (is.character(x)) paste0("# ", x) else expr_deparse(x))

tests/testthat/test-expect-known.R

@@ -11,7 +11,7 @@ test_that("uses specified width", {
 })
 
 test_that("creates file on first run", {
-  file <- tempfile()
+  file <- withr::local_tempfile()
   expect_success(
     expect_warning(
       expect_known_output(cat("ok!\n"), file),
@@ -23,7 +23,7 @@ test_that("creates file on first run", {
 })
 
 test_that("ignores incomplete last line", {
-  file <- tempfile()
+  file <- withr::local_tempfile()
   writeLines("Hi!", file)
   expect_success(expect_known_output(cat("Hi!"), file))
   expect_success(expect_known_output(cat("Hi!\n"), file))
@@ -32,7 +32,7 @@ test_that("ignores incomplete last line", {
 })
 
 test_that("updates by default", {
-  file <- tempfile()
+  file <- withr::local_tempfile()
   writeLines("Hi!", file)
   expect_failure(expect_known_output(cat("oops"), file, update = FALSE))
 

tests/testthat/test-reporter.R

@@ -1,7 +1,6 @@
 test_that("can control output with file arg/option", {
   # powered through Reporter base class so we only test one reporter
-  path <- tempfile()
-  withr::defer(unlink(path))
+  path <- withr::local_tempfile()
 
   with_reporter(
     MinimalReporter$new(file = path),

tests/testthat/test-snapshot-file.R

@@ -6,13 +6,13 @@ test_that("expect_snapshot_file works", {
     compare = compare_file_text
   )
 
-  path <- tempfile()
+  path <- withr::local_tempfile()
   png(path, width = 300, height = 300, type = "cairo")
   plot(1:10, xlab = "", ylab = "", pch = 20, cex = 5, axes = FALSE)
   dev.off()
   expect_snapshot_file(path, "foo.png")
 
-  path <- tempfile()
+  path <- withr::local_tempfile()
   mtcars2 <- mtcars
   # mtcars2$wt[10] <- NA
   write.csv(mtcars2, path)

tests/testthat/test-test-files.R

@@ -20,7 +20,7 @@ test_that("runs all tests and records output", {
 
 test_that("complains if no files", {
   withr::local_envvar(TESTTHAT_PARALLEL = "FALSE")
-  path <- tempfile()
+  path <- withr::local_tempfile()
   dir.create(path)
 
   expect_error(test_dir(path), "test files")

tests/testthat/test-verify-output.R

@@ -83,3 +83,11 @@ test_that("verify_output() handles carriage return", {
     cat("\r\n")
   })
 })
+
+test_that("verify_exec() doesn't leave tempfiles around", {
+  before <- dir(tempdir())
+  verify_exec(quote(1 + 1))
+  after <- dir(tempdir())
+
+  expect_equal(before, after)
+})