Start using testthat 3e

DESCRIPTION

@@ -34,12 +34,13 @@ Suggests:
     mockery,
     rmarkdown,
     rstudioapi (>= 0.2),
-    testthat (>= 2.2.1),
+    testthat (>= 3.0.0),
     withr
 License: MIT + file LICENSE
 Encoding: UTF-8
 VignetteBuilder: knitr
 RoxygenNote: 7.1.2
+Config/testthat/edition: 3
 Collate:
     'T_and_F_symbol_linter.R'
     'utils.R'

NEWS.md

@@ -85,6 +85,7 @@ function calls. (#850, #851, @renkun-ken)
   * Each linter can have multiple tags
   * New function `available_linters()` to list available linters and their tags 
     This feature is extensible by package authors providing add-on linters for {lintr}.
+* `lintr` now uses the 3rd edition of `testthat` (@MichaelChirico, #910)
 
 # lintr 2.0.1
 

tests/testthat/test-cache.R

@@ -53,116 +53,96 @@ test_that("clear_cache deletes the directory if no file is given", {
 # `load_cache`
 
 test_that("load_cache loads the saved file in a new empty environment", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    assign("x", "foobar", envir = e1),
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
-    save_cache(cache = e1, file = f1, path = d1),
-    e2 <- load_cache(file = f1, path = d1),
-
-    expect_equal(ls(e2), "x"),
-    expect_equal(e2[["x"]], "foobar")
-  )
+  e1 <- new.env(parent = emptyenv())
+  e1[["x"]] <- "foobar"
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
+  save_cache(cache = e1, file = f1, path = d1)
+  e2 <- load_cache(file = f1, path = d1)
+
+  # TODO(michaelchirico): use plain expect_equal after waldo#133 makes it into a CRAN release
+  expect_equal(as.list(e2, all.names = TRUE), as.list(e1, all.names = TRUE))
 })
 
 test_that("load_cache returns an empty environment if no cache file exists", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
-    f2 <- "test.R",
+  e1 <- new.env(parent = emptyenv())
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
+  f2 <- "test.R"
 
-    save_cache(cache = e1, file = f1, path = d1),
-    e2 <- load_cache(file = f2, path = d1),
+  save_cache(cache = e1, file = f1, path = d1)
+  e2 <- load_cache(file = f2, path = d1)
 
-    expect_equal(ls(e2), character(0))
-  )
+  # TODO(michaelchirico): use plain expect_equal after waldo#133 makes it into a CRAN release
+  expect_equal(as.list(e2, all.names = TRUE), as.list(e1, all.names = TRUE))
 })
 
 test_that("load_cache returns an empty environment if reading cache file fails", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    assign("x", "foobar", envir = e1),
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
-    save_cache(cache = e1, file = f1, path = d1),
-    cache_f1 <- file.path(d1, fhash(f1)),
-    writeLines(character(), cache_f1),
-    expect_warning(e2 <- load_cache(file = f1, path = d1)),
-    saveRDS(e1, cache_f1),
-    expect_warning(e3 <- load_cache(file = f1, path = d1)),
-    expect_equal(ls(e2), character(0)),
-    expect_equal(ls(e3), character(0))
-  )
+  e1 <- new.env(parent = emptyenv())
+  e1[["x"]] <- "foobar"
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
+  save_cache(cache = e1, file = f1, path = d1)
+  cache_f1 <- file.path(d1, fhash(f1))
+  writeLines(character(), cache_f1)
+
+  expect_warning(e2 <- load_cache(file = f1, path = d1))
+  saveRDS(e1, cache_f1)
+  expect_warning(e3 <- load_cache(file = f1, path = d1))
+
+  expect_equal(ls(e2), character(0))
+  expect_equal(ls(e3), character(0))
 })
 
 # `save_cache`
 
 test_that("save_cache creates a directory if needed", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
+  e1 <- new.env(parent = emptyenv())
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
 
-    expect_false(file.exists(d1)),
-    expect_false(file.exists(file.path(d1, fhash(f1)))),
+  expect_false(file.exists(d1))
+  expect_false(file.exists(file.path(d1, fhash(f1))))
 
-    save_cache(cache = e1, file = f1, path = d1),
+  save_cache(cache = e1, file = f1, path = d1)
 
-    expect_true(file.exists(d1)),
-    expect_true(file.info(d1)$isdir),
-    expect_true(file.exists(file.path(d1, fhash(f1))))
-  )
+  expect_true(file.exists(d1))
+  expect_true(file.info(d1)$isdir)
+  expect_true(file.exists(file.path(d1, fhash(f1))))
 })
 
 test_that("save_cache uses unambiguous cache file names", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
-    f2 <- "test.R",
+  e1 <- new.env(parent = emptyenv())
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
+  f2 <- "test.R"
 
-    expect_false(file.exists(file.path(d1, fhash(f1)))),
-    expect_false(file.exists(file.path(d1, fhash(f2)))),
+  expect_false(file.exists(file.path(d1, fhash(f1))))
+  expect_false(file.exists(file.path(d1, fhash(f2))))
 
-    save_cache(cache = e1, file = f1, path = d1),
-    save_cache(cache = e1, file = f2, path = d1),
+  save_cache(cache = e1, file = f1, path = d1)
+  save_cache(cache = e1, file = f2, path = d1)
 
-    expect_true(fhash(f1) != fhash(f2)),
-    expect_true(file.exists(file.path(d1, fhash(f1)))),
-    expect_true(file.exists(file.path(d1, fhash(f2))))
-  )
+  expect_true(fhash(f1) != fhash(f2))
+  expect_true(file.exists(file.path(d1, fhash(f1))))
+  expect_true(file.exists(file.path(d1, fhash(f2))))
 })
 
 test_that("save_cache saves all non-hidden objects from the environment", {
-  with_mock(
-    `lintr::read_settings` = function(...) invisible(...),
-
-    e1 <- new.env(parent = emptyenv()),
-    e1$t1 <- 1,
-    e1$t2 <- 2,
+  e1 <- new.env(parent = emptyenv())
+  e1$t1 <- 1
+  e1$t2 <- 2
 
-    d1 <- tempfile(pattern = "lintr_cache_"),
-    f1 <- "R/test.R",
+  d1 <- tempfile(pattern = "lintr_cache_")
+  f1 <- "R/test.R"
 
-    save_cache(cache = e1, file = f1, path = d1),
+  save_cache(cache = e1, file = f1, path = d1)
 
-    e2 <- new.env(parent = emptyenv()),
-    load(file = file.path(d1, fhash(f1)), envir = e2),
+  e2 <- new.env(parent = emptyenv())
+  load(file = file.path(d1, fhash(f1)), envir = e2)
 
-    expect_equal(e1, e2)
-  )
+  # TODO(michaelchirico): use plain expect_equal after waldo#133 makes it into a CRAN release
+  expect_equal(as.list(e1, all.names = TRUE), as.list(e2, all.names = TRUE))
 })
 
 # `cache_file`
@@ -177,7 +157,7 @@ test_that("cache_file generates the same cache with different lints", {
   cache_file(e1, f1, list(), list())
   cache_file(e1, f1, list(), list(1))
 
-  expect_equal(length(ls(e1)), 1)
+  expect_length(ls(e1), 1L)
 })
 
 test_that("cache_file generates different caches for different linters", {
@@ -190,7 +170,7 @@ test_that("cache_file generates different caches for different linters", {
   cache_file(e1, f1, list(), list())
   cache_file(e1, f1, list(1), list())
 
-  expect_equal(length(ls(e1)), 2)
+  expect_length(ls(e1), 2L)
 })
 
 # `retrieve_file`
@@ -225,7 +205,7 @@ test_that("cache_lint generates the same cache with different lints", {
   cache_lint(e1, t1, list(), list())
   cache_lint(e1, t1, list(), list(1))
 
-  expect_equal(length(ls(e1)), 1)
+  expect_length(ls(e1), 1L)
 })
 
 test_that("cache_lint generates different caches for different linters", {
@@ -236,7 +216,7 @@ test_that("cache_lint generates different caches for different linters", {
   cache_lint(e1, t1, list(), list())
   cache_lint(e1, t1, list(1), list())
 
-  expect_equal(length(ls(e1)), 2)
+  expect_length(ls(e1), 2L)
 })
 
 # `retrieve_lint`
@@ -435,18 +415,14 @@ test_that("lint with cache uses the provided relative cache directory", {
 test_that("it works outside of a package", {
   linter <- assignment_linter()
 
-  with_mock(
-    `lintr::find_package` = function(...) NULL,
-    `lintr::pkg_name` = function(...) NULL,
-
-    path <- tempfile(pattern = "my_cache_dir_"),
-    expect_false(dir.exists(path)),
-    expect_lint("a <- 1", NULL, linter, cache = path),
-    expect_true(dir.exists(path)),
-    expect_length(list.files(path), 1),
-    expect_lint("a <- 1", NULL, linter, cache = path),
-    expect_true(dir.exists(path))
-  )
+  mockery::stub(lintr:::find_default_encoding, "find_package", function(...) NULL)
+  path <- tempfile(pattern = "my_cache_dir_")
+  expect_false(dir.exists(path))
+  expect_lint("a <- 1", NULL, linter, cache = path)
+  expect_true(dir.exists(path))
+  expect_length(list.files(path), 1L)
+  expect_lint("a <- 1", NULL, linter, cache = path)
+  expect_true(dir.exists(path))
 })
 
 test_that("cache = TRUE workflow works", {

tests/testthat/test-ci.R

@@ -1,67 +1,55 @@
 test_that("GitHub Actions functionality works", {
   # imitate being on GHA whether or not we are
-  withr::with_envvar(c(GITHUB_ACTIONS = "true"), {
-    old <- options(lintr.rstudio_source_markers = FALSE)
-    on.exit(options(old), add = TRUE)
+  withr::local_envvar(list(GITHUB_ACTIONS = "true"))
+  withr::local_options(lintr.rstudio_source_markers = FALSE)
+  tmp <- withr::local_tempfile()
 
-    writeLines("x <- 1:nrow(y)", tmp <- tempfile())
-    on.exit(unlink(tmp))
+  writeLines("x <- 1:nrow(y)", tmp)
 
-    l <- lint(tmp)
-    expect_output(print(l), "::warning file", fixed = TRUE)
-  })
+  l <- lint(tmp)
+  expect_output(print(l), "::warning file", fixed = TRUE)
 })
 
 test_that("GitHub Actions functionality works in a subdirectory", {
   # imitate being on GHA whether or not we are
   pkg_path <- file.path("dummy_packages", "assignmentLinter")
-  withr::with_envvar(c(GITHUB_ACTIONS = "true"), {
-    old <- options(
-      lintr.rstudio_source_markers = FALSE,
-      lintr.github_annotation_project_dir = pkg_path
-    )
-    on.exit(options(old), add = TRUE)
-
-    read_settings(NULL)
-    l <- lint_package(
-      pkg_path, linters = list(assignment_linter()),
-      parse_settings = FALSE
-    )
-    expect_output(
-      print(l),
-      paste0("::warning file=", file.path(pkg_path, "R(/|\\\\)abc\\.R"))
-    )
-  })
+  withr::local_envvar(list(GITHUB_ACTIONS = "true"))
+  withr::local_options(lintr.rstudio_source_markers = FALSE, lintr.github_annotation_project_dir = pkg_path)
+
+  read_settings(NULL)
+  l <- lint_package(
+    pkg_path,
+    linters = list(assignment_linter()),
+    parse_settings = FALSE
+  )
+  expect_output(
+    print(l),
+    paste0("::warning file=", file.path(pkg_path, "R(/|\\\\)abc\\.R"))
+  )
 })
 
 test_that("Printing works for Travis", {
-  withr::with_envvar(c(GITHUB_ACTIONS = "false", TRAVIS_REPO_SLUG = "test/repo", LINTR_COMMENT_BOT = "true"), {
-    old <- options(lintr.rstudio_source_markers = FALSE)
-    on.exit(options(old), add = TRUE)
+  withr::local_envvar(list(GITHUB_ACTIONS = "false", TRAVIS_REPO_SLUG = "test/repo", LINTR_COMMENT_BOT = "true"))
+  withr::local_options(lintr.rstudio_source_markers = FALSE)
+  tmp <- withr::local_tempfile()
+  writeLines("x <- 1:nrow(y)", tmp)
 
-    writeLines("x <- 1:nrow(y)", tmp <- tempfile())
-    on.exit(unlink(tmp))
+  l <- lint(tmp)
 
-    l <- lint(tmp)
-
-    with_mock(github_comment = function(x, ...) cat(x, "\n"), .env = asNamespace("lintr"), {
-      expect_output(print(l), "*warning:*", fixed = TRUE)
-    })
+  with_mock(github_comment = function(x, ...) cat(x, "\n"), .env = asNamespace("lintr"), {
+    expect_output(print(l), "*warning:*", fixed = TRUE)
   })
 })
 
 test_that("Printing works for Wercker", {
-  withr::with_envvar(c(GITHUB_ACTIONS = "false", WERCKER_GIT_BRANCH = "test/repo", LINTR_COMMENT_BOT = "true"), {
-    old <- options(lintr.rstudio_source_markers = FALSE)
-    on.exit(options(old), add = TRUE)
-
-    writeLines("x <- 1:nrow(y)", tmp <- tempfile())
-    on.exit(unlink(tmp))
+  withr::local_envvar(list(GITHUB_ACTIONS = "false", WERCKER_GIT_BRANCH = "test/repo", LINTR_COMMENT_BOT = "true"))
+  withr::local_options(lintr.rstudio_source_markers = FALSE)
+  tmp <- withr::local_tempfile()
+  writeLines("x <- 1:nrow(y)", tmp)
 
-    l <- lint(tmp)
+  l <- lint(tmp)
 
-    with_mock(github_comment = function(x, ...) cat(x, "\n"), .env = asNamespace("lintr"), {
-      expect_output(print(l), "*warning:*", fixed = TRUE)
-    })
+  with_mock(github_comment = function(x, ...) cat(x, "\n"), .env = asNamespace("lintr"), {
+    expect_output(print(l), "*warning:*", fixed = TRUE)
   })
 })

tests/testthat/test-commented_code_linter.R

@@ -1,7 +1,7 @@
 test_that("returns the correct linting", {
   msg <- rex("Commented code should be removed.")
   linter <- commented_code_linter()
-  expect_is(linter, "linter")
+  expect_s3_class(linter, "linter")
 
   expect_lint("blah", NULL, linter)