r-lib · lorenzwalthert · May 31, 2022 · May 26, 2022 · May 26, 2022 · May 28, 2022
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -97,6 +97,7 @@ repos:
           tests/testthat/exception_handling/empty_file\.R|
           tests/testthat/parse_comments/eol_eof_spaces-.*|
           tests/testthat/reference-objects/.*|
+          tests/testthat/_snaps/.*|
           )$
 -   repo: https://github.com/lorenzwalthert/gitignore-tidy
     rev: 9dd648a2cbce0c0ce09255695b63ea4823699bec

diff --git a/DESCRIPTION b/DESCRIPTION
@@ -39,13 +39,14 @@ Suggests:
     rmarkdown,
     roxygen2,
     rstudioapi (>= 0.7),
-    testthat (>= 2.1.0)
+    testthat (>= 3.0.0)
 VignetteBuilder: 
     knitr
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE, roclets = c("rd", "namespace", "collate",
     "pkgapi::api_roclet"))
 RoxygenNote: 7.1.2
+Config/testthat/edition: 3
 Collate: 
     'addins.R'
     'communicate.R'

diff --git a/NEWS.md b/NEWS.md
@@ -30,8 +30,10 @@ editor_options:
 
 **Other**
 
--   All (R)md files in this project's source code are now formatted with default pandoc markdown formatter.
-    This conversion is required when using the visual mode in RStudio (#941).
+-   Upgrade testing infra to testthat 3e (\@IndrajeetPatil, #949).
+-   All (R)md files in this project's source code are now formatted with
+    default pandoc markdown formatter. This conversion is required when using
+    the visual mode in RStudio (#941).
 -   Update {pkgdown} action to always build, but only deploy on default branch
     (#946).
 

diff --git a/tests/testthat/_snaps/cache-with-r-cache.md b/tests/testthat/_snaps/cache-with-r-cache.md
@@ -0,0 +1,30 @@
+# cached expressions are displayed propperly
+
+    Code
+      cache_info[, c("n", "size", "last_modified", "activated")]
+    Output
+      # A tibble: 1 x 4
+            n  size last_modified activated
+        <int> <dbl> <dttm>        <lgl>    
+      1     0     0 -Inf -Inf     FALSE    
+
+---
+
+    Code
+      cache_info[, c("n", "size", "activated")]
+    Output
+      # A tibble: 1 x 3
+            n  size activated
+        <int> <dbl> <lgl>    
+      1     1     0 TRUE     
+
+---
+
+    Code
+      cache_info[, c("n", "size", "activated")]
+    Output
+      # A tibble: 1 x 3
+            n  size activated
+        <int> <dbl> <lgl>    
+      1     2     0 TRUE     
+
diff --git a/tests/testthat/_snaps/helpers.md b/tests/testthat/_snaps/helpers.md
@@ -0,0 +1,15 @@
+# can construct and print vertical
+
+    Code
+      construct_vertical(c("1 + 1", "nw"))
+    Output
+      1 + 1
+      nw
+
+# can lookup tokens
+
+    Code
+      lookup_new_special()
+    Output
+      [1] "SPECIAL-PIPE"  "SPECIAL-IN"    "SPECIAL-OTHER"
+
diff --git a/tests/testthat/_snaps/public_api.md b/tests/testthat/_snaps/public_api.md
@@ -0,0 +1,54 @@
+# messages (via cat()) of style_file are correct
+
+    Code
+      cat(catch_style_file_output(file.path("public-api", "xyzdir-dirty",
+        "dirty-sample-with-scope-tokens.R")), sep = "\n")
+    Output
+      Styling  1  files:
+       dirty-sample-with-scope-tokens.R i 
+      ----------------------------------------
+      Status	Count	Legend 
+      v 	0	File unchanged.
+      i 	1	File changed.
+      x 	0	Styling threw an error.
+      ----------------------------------------
+      Please review the changes carefully!
+
+---
+
+    Code
+      cat(catch_style_file_output(file.path("public-api", "xyzdir-dirty",
+        "clean-sample-with-scope-tokens.R")), sep = "\n")
+    Output
+      Styling  1  files:
+       clean-sample-with-scope-tokens.R v 
+      ----------------------------------------
+      Status	Count	Legend 
+      v 	1	File unchanged.
+      i 	0	File changed.
+      x 	0	Styling threw an error.
+      ----------------------------------------
+
+---
+
+    Code
+      cat(catch_style_file_output(file.path("public-api", "xyzdir-dirty",
+        "dirty-sample-with-scope-spaces.R")), sep = "\n")
+    Output
+      Styling  1  files:
+       dirty-sample-with-scope-spaces.R i 
+      ----------------------------------------
+      Status	Count	Legend 
+      v 	0	File unchanged.
+      i 	1	File changed.
+      x 	0	Styling threw an error.
+      ----------------------------------------
+      Please review the changes carefully!
+
+# No sensitive to decimal option
+
+    Code
+      style_text("1")
+    Output
+      1
+
diff --git a/tests/testthat/_snaps/roundtrip.md b/tests/testthat/_snaps/roundtrip.md
@@ -0,0 +1,9 @@
+# correct styling does not give an error
+
+    Code
+      verify_roundtrip("1+1", "1 + 1")
+
+# corrupt styling does give an error
+
+    The expression evaluated before the styling is not the same as the expression after styling. This should not happen. Please file a bug report on GitHub (https://github.com/r-lib/styler/issues) using a reprex.
+
diff --git a/tests/testthat/_snaps/utils.md b/tests/testthat/_snaps/utils.md
@@ -0,0 +1,24 @@
+# files with and without blank EOF line are read correctly
+
+    Code
+      read_utf8(test_path("reference-objects/missing-blank-at-EOF.R"))
+    Output
+      $text
+      [1] "x"
+
+      $missing_EOF_line_break
+      [1] TRUE
+
+
+---
+
+    Code
+      read_utf8(test_path("reference-objects/non-missing-blank-at-EOF.R"))
+    Output
+      $text
+      [1] "x"
+
+      $missing_EOF_line_break
+      [1] FALSE
+
+
diff --git a/tests/testthat/public-api/renvpkg/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/renvpkg/tests/testthat/test-package-xyz.R
@@ -1,4 +1,4 @@
-context("testing styler on package")
+
 
 test_that("hi there", {
   I(am(a(package(x))))

diff --git a/tests/testthat/public-api/xyzdir-dirty/clean-reference-with-scope-tokens-non-utf8 b/tests/testthat/public-api/xyzdir-dirty/clean-reference-with-scope-tokens-non-utf8
diff --git a/tests/testthat/public-api/xyzdir-dirty/clean-reference-with-scope-tokens-utf8 b/tests/testthat/public-api/xyzdir-dirty/clean-reference-with-scope-tokens-utf8
diff --git a/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-non-utf8 b/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-non-utf8
diff --git a/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-utf8 b/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-spaces-utf8
diff --git a/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-non-utf8 b/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-non-utf8
diff --git a/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-utf8 b/tests/testthat/public-api/xyzdir-dirty/dirty-reference-with-scope-tokens-utf8
diff --git a/tests/testthat/public-api/xyzpackage-qmd/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-qmd/tests/testthat/test-package-xyz.R
@@ -1,4 +1,4 @@
-context("testing styler on package")
+
 
 test_that("hi there", {
   I(am(a(package(x))))

diff --git a/tests/testthat/public-api/xyzpackage-rmd/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-rmd/tests/testthat/test-package-xyz.R
@@ -1,4 +1,4 @@
-context("testing styler on package")
+
 
 test_that("hi there", {
   I(am(a(package(x))))

diff --git a/tests/testthat/public-api/xyzpackage-rnw/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage-rnw/tests/testthat/test-package-xyz.R
@@ -1,4 +1,4 @@
-context("testing styler on package")
+
 
 test_that("hi there", {
   I(am(a(package(x))))

diff --git a/tests/testthat/public-api/xyzpackage/tests/testthat/test-package-xyz.R b/tests/testthat/public-api/xyzpackage/tests/testthat/test-package-xyz.R
@@ -1,4 +1,4 @@
-context("testing styler on package")
+
 
 test_that("hi there", {
   I(am(a(package(x))))

diff --git a/tests/testthat/test-cache-with-r-cache.R b/tests/testthat/test-cache-with-r-cache.R
@@ -57,30 +57,26 @@ test_that("top-level test: Caches top-level expressions efficiently on style_tex
 
 
 test_that("cached expressions are displayed propperly", {
+  skip_if(getRversion() < "4.2")
+
   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"),
-    update = getOption("styler.test_dir_writable", TRUE)
-  )
+  expect_snapshot({
+    cache_info[, c("n", "size", "last_modified", "activated")]
+  })
 
   local_test_setup(cache = TRUE)
   style_text("1+1")
   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-2"),
-    update = getOption("styler.test_dir_writable", TRUE)
-  )
+  expect_snapshot({
+    cache_info[, c("n", "size", "activated")]
+  })
   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"),
-    update = getOption("styler.test_dir_writable", TRUE)
-  )
+  expect_snapshot({
+    cache_info[, c("n", "size", "activated")]
+  })
 })
 
 

diff --git a/tests/testthat/test-create_token.R b/tests/testthat/test-create_token.R
@@ -1,4 +1,4 @@
-context("token insertion")
+
 
 test_that("can create a token that has relevant columns", {
   pd_names <- c(

diff --git a/tests/testthat/test-create_tree.R b/tests/testthat/test-create_tree.R
@@ -1,4 +1,4 @@
-context("test tree creation")
+
 
 test_that("create_trees outputs identical structure if trees have same structure", {
   skip_if_not_installed("DiagrammeR")

diff --git a/tests/testthat/test-curly-curly.R b/tests/testthat/test-curly-curly.R
@@ -1,4 +1,4 @@
-context("curly-curly")
+
 
 test_that("curly-culry", {
   expect_warning(test_collection("curly-curly",

diff --git a/tests/testthat/test-encoding.R b/tests/testthat/test-encoding.R
@@ -1,4 +1,4 @@
-context("non-ASCII characters are handled properly")
+
 
 test_that("non-ASCII characters are handled properly for text styling", {
   expect_equal(

diff --git a/tests/testthat/test-exception_handling.R b/tests/testthat/test-exception_handling.R
@@ -1,4 +1,4 @@
-context("Exception handling")
+
 
 test_that("style_text returns custom error", {
   expect_error(style_text("a <- 3 4"), "unexpected numeric constant")

diff --git a/tests/testthat/test-helpers.R b/tests/testthat/test-helpers.R
@@ -1,10 +1,9 @@
-context("various helpers")
+
 
 test_that("can construct and print vertical", {
-  expect_error(construct_vertical(c("1 + 1", "nw")), NA)
-  capture.output(
-    expect_error(construct_vertical(c("1 + 1", "nw")) %>% print(), NA)
-  )
+  expect_snapshot({
+    construct_vertical(c("1 + 1", "nw"))
+  })
 })
 
 
@@ -13,7 +12,9 @@ test_that("file types can be asserted", {
 })
 
 test_that("can lookup tokens", {
-  expect_error(lookup_new_special(), NA)
+  expect_snapshot({
+    lookup_new_special()
+  })
 })
 
 test_that("can extend non-comment", {

diff --git a/tests/testthat/test-identify-roxygen-examples.R b/tests/testthat/test-identify-roxygen-examples.R
@@ -1,4 +1,4 @@
-context("test-roxygen-examples-identify.R")
+
 
 #' Things to consider:
 #' * one function declaration or many

diff --git a/tests/testthat/test-indention_curly.R b/tests/testthat/test-indention_curly.R
@@ -1,4 +1,4 @@
-context("indent curly brackets")
+
 
 test_that("indention on one-liner curley only is not changed", {
   expect_warning(test_collection("indention_curly_brackets",

diff --git a/tests/testthat/test-indention_fun_calls.R b/tests/testthat/test-indention_fun_calls.R
@@ -1,4 +1,4 @@
-context("test-indention_fun_calls.R")
+
 
 test_that("edge cases work", {
   expect_warning(test_collection("indention_fun_calls",

diff --git a/tests/testthat/test-indention_multiple.R b/tests/testthat/test-indention_multiple.R
@@ -1,4 +1,4 @@
-context("test indent multiple")
+
 
 test_that("multiple round brackets don't cause extraindention", {
   expect_warning(test_collection("indention_multiple",

diff --git a/tests/testthat/test-indention_operators.R b/tests/testthat/test-indention_operators.R
@@ -1,4 +1,4 @@
-context("indention operators")
+
 
 test_that("pipe is indended correctly", {
   expect_warning(test_collection("indention_operators",

diff --git a/tests/testthat/test-indention_round_brackets.R b/tests/testthat/test-indention_round_brackets.R
@@ -1,4 +1,4 @@
-context("Function calls with round brackets")
+
 
 test_that("one-line function call yields correct indention", {
   expect_warning(test_collection("indention_round_brackets",
@@ -19,7 +19,7 @@ test_that(paste("multi-line function call yields correct indention"), {
 ##  ............................................................................
 
 
-context("grouping arithmetic expressions with round brackets. ")
+
 
 # Does NOT cover indention by operators such as +"
 

diff --git a/tests/testthat/test-insertion_comment_interaction.R b/tests/testthat/test-insertion_comment_interaction.R
@@ -1,4 +1,4 @@
-context("test comment token insertion interaction")
+
 
 ##  ............................................................................
 ##  strict = TRUE                                                           ####

diff --git a/tests/testthat/test-line_breaks_and_other.R b/tests/testthat/test-line_breaks_and_other.R
@@ -1,4 +1,4 @@
-context("linebreaking added / removed correctly")
+
 
 test_that("line breaks involing curly brackets", {
   expect_warning(test_collection("line_breaks_and_other", "curly",

diff --git a/tests/testthat/test-line_breaks_fun_call.R b/tests/testthat/test-line_breaks_fun_call.R
@@ -1,4 +1,4 @@
-context("line breaks for function calls")
+
 test_that("line breaks work in general", {
   expect_warning(test_collection("line_breaks_fun_call",
     "token_dependent_mixed",

diff --git a/tests/testthat/test-math_token_spacing.R b/tests/testthat/test-math_token_spacing.R
@@ -1,4 +1,4 @@
-context("math token spacing")
+
 
 test_that("invalid tokens return error", {
   expect_error(test_collection(

diff --git a/tests/testthat/test-multiple_expressions.R b/tests/testthat/test-multiple_expressions.R
@@ -1,5 +1,5 @@
 library("testthat")
-context("multiple expressions")
+
 
 test_that("simple multiple expressions are styled correctly", {
   expect_warning(test_collection("multiple_expressions",

diff --git a/tests/testthat/test-parse_comments.R b/tests/testthat/test-parse_comments.R
@@ -1,5 +1,5 @@
 library("testthat")
-context("correctly treats comments")
+
 
 test_that("spacing within comments is done correctly", {
   expect_warning(test_collection("parse_comments",

diff --git a/tests/testthat/test-parsing.R b/tests/testthat/test-parsing.R
@@ -1,4 +1,4 @@
-context("circumvent parsing bugs")
+
 
 test_that("repreated parsing solves wrong parent assignment", {
   expect_warning(