Merge pull request #548 from michaelquinn32/patch-1

- Don't write to the test directory during testing (#548).

Author: lorenzwalthert

NEWS.md

@@ -4,6 +4,8 @@
 
 - blank lines in function calls and headers are now removed, for the former only 
   when there are no comments before or after the blank line (#629, #630, #635).
+- added an option (`styler.test_dir_writeable`) that changes test behavior
+  to not directly modify test files in the current directory (#548).
 - `style_file()` and friends gain argument `dry` to control if changes should 
   be applied to files or not (#634).
 
@@ -13,7 +15,6 @@
 - always strip trailing spaces and make cache insensitive to it (#626).
 - typos in documentation (#618, #614).
 
-
 # styler 1.3.2
 
 Release upon request by the CRAN team.

R/testing.R

@@ -41,10 +41,17 @@ test_collection <- function(test, sub_test = NULL,
 
   out_names <- construct_out(in_names)
 
-  out_items <- file.path(path, out_names)
-  in_items <- file.path(path, in_names)
-
-  out_trees <- construct_tree(in_items)
+  if (getOption("styler.test_dir_writable", TRUE)) {
+    out_items <- file.path(path, out_names)
+    in_items <- file.path(path, in_names)
+    out_trees <- construct_tree(in_items)
+  } else {
+    in_items <- file.path(path, in_names)
+    out_items <- file.path(tempdir(), out_names)
+    ref_items <- file.path(path, out_names)
+    file.copy(ref_items, out_items, overwrite = TRUE, copy.mode = FALSE)
+    out_trees <- file.path(tempdir(), construct_tree(in_names))
+  }
 
   pwalk(list(in_items, out_items, in_names, out_names, out_trees),
     transform_and_check,
@@ -106,7 +113,9 @@ transform_and_check <- function(in_item, out_item,
   read_in <- xfun::read_utf8(in_item)
   if (write_tree) {
     create_tree(read_in) %>%
-      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE, fileEncoding = "UTF-8")
+      write.table(out_tree, col.names = FALSE, row.names = FALSE, quote = FALSE,
+        fileEncoding = "UTF-8"
+      )
   }
   transformed_text <- read_in %>%
     transformer(...) %>%

R/zzz.R

@@ -6,7 +6,8 @@
     styler.cache_name = styler_version,
     styler.addins_style_transformer = "styler::tidyverse_style()",
     styler.ignore_start = "# styler: off",
-    styler.ignore_stop = "# styler: on"
+    styler.ignore_stop = "# styler: on",
+    styler.test_dir_writable = TRUE
   )
   toset <- !(names(op.styler) %in% names(op))
   if (any(toset)) options(op.styler[toset])

tests/testthat/test-cache-with-r-cache.R

@@ -64,7 +64,8 @@ capture.output(test_that("cached expressions are displayed propperly", {
   cache_info <- cache_info("testthat", format = "tabular")
   expect_known_value(
     cache_info[, c("n", "size", "last_modified", "activated")],
-    file = test_path("reference-objects/cache-info-1")
+    file = test_path("reference-objects/cache-info-1"),
+    update = getOption("styler.test_dir_writable", TRUE)
   )
 
   activate_testthat_cache()
@@ -73,14 +74,18 @@ capture.output(test_that("cached expressions are displayed propperly", {
   cache_info$size <- round(cache_info$size, -2)
   expect_known_value(
     cache_info[, c("n", "size", "activated")],
-    file = test_path("reference-objects/cache-info-2")
+    file = test_path("reference-objects/cache-info-2"),
+    update = getOption("styler.test_dir_writable", TRUE)
+
   )
   style_text("a <-function() NULL")
   cache_info <- cache_info(format = "tabular")
   cache_info$size <- round(cache_info$size, -2)
   expect_known_value(
     cache_info[, c("n", "size", "activated")],
-    file = test_path("reference-objects/cache-info-3")
+    file = test_path("reference-objects/cache-info-3"),
+    update = getOption("styler.test_dir_writable", TRUE)
+
   )
 }))
 

tests/testthat/test-public_api.R

@@ -163,7 +163,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
 
         # No message if scope > line_breaks and code does not change
@@ -175,7 +176,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/clean-reference-with-scope-tokens-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
 
         # No message if scope <= line_breaks even if code is changed.
@@ -187,7 +189,8 @@ test_that("messages (via cat()) of style_file are correct", {
           testthat_file(paste0(
             "public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-",
             encoding
-          ))
+          )),
+          update = getOption("styler.test_dir_writable", TRUE)
         )
       }
     )

tests/testthat/test-utils.R

@@ -10,11 +10,13 @@ test_that("non-comment-helpers", {
 test_that("files with and without blank EOF line are read correctly", {
   expect_known_value(
     read_utf8(test_path("reference-objects/missing-blank-at-EOF.R")),
-    test_path("reference-objects/return-read-utf8-missing-EOF")
+    test_path("reference-objects/return-read-utf8-missing-EOF"),
+    update = getOption("styler.test_dir_writable", TRUE)
   )
 
   expect_known_value(
     read_utf8(test_path("reference-objects/non-missing-blank-at-EOF.R")),
-    test_path("reference-objects/return-read-utf8-non-missing-EOF")
+    test_path("reference-objects/return-read-utf8-non-missing-EOF"),
+    update = getOption("styler.test_dir_writable", TRUE)
   )
 })