From 3882350fd8a77980301e8ce4dc676017713c601f Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Wed, 5 Mar 2025 23:44:08 +0000 Subject: [PATCH 01/57] use maybe_write_content for easier 'mocking' --- R/expect_lint.R | 21 +++++++++++--------- tests/testthat/test-get_source_expressions.R | 1 + 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/R/expect_lint.R b/R/expect_lint.R index c8e81cafa..30e377d7c 100644 --- a/R/expect_lint.R +++ b/R/expect_lint.R @@ -47,15 +47,7 @@ expect_lint <- function(content, checks, ..., file = NULL, language = "en") { old_lang <- set_lang(language) on.exit(reset_lang(old_lang)) - if (is.null(file)) { - file <- tempfile() - on.exit(unlink(file), add = TRUE) - local({ - con <- base::file(file, encoding = "UTF-8") - on.exit(close(con)) - writeLines(content, con = con, sep = "\n") - }) - } + file <- maybe_write_content(file, content) lints <- lint(file, ...) n_lints <- length(lints) @@ -121,6 +113,17 @@ expect_no_lint <- function(content, ..., file = NULL, language = "en") { expect_lint(content, NULL, ..., file = file, language = language) } +maybe_write_content <- function(file, lines) { + if (!is.null(file)) { + return(file) + } + tmp <- tempfile() + con <- file(tmp, encoding = "UTF-8") + on.exit(close(con)) + writeLines(lines, con = con, sep = "\n") + tmp +} + #' Test that the package is lint free #' #' This function is a thin wrapper around lint_package that simply tests there are no diff --git a/tests/testthat/test-get_source_expressions.R b/tests/testthat/test-get_source_expressions.R index eeaff905b..64dbd548d 100644 --- a/tests/testthat/test-get_source_expressions.R +++ b/tests/testthat/test-get_source_expressions.R @@ -105,6 +105,7 @@ test_that("Multi-byte character truncated by parser is ignored", { }) test_that("Can read non UTF-8 file", { + withr::local_options(list(lintr.linter_file = tempfile())) proj_dir <- test_path("dummy_projects", "project") withr::local_dir(proj_dir) expect_no_lint(file = "cp1252.R", linters = list()) From c392c535066ea661051956aaccd9e09e44596f7f Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 01:00:16 +0000 Subject: [PATCH 02/57] initial progress --- .dev/ast_fuzz_test.R | 43 +++++++++++++++++++++++++++++++++ .dev/maybe_fuzz_content.R | 50 +++++++++++++++++++++++++++++++++++++++ R/expect_lint.R | 48 ++++++++++++++++++++++++++++++++++++- 3 files changed, 140 insertions(+), 1 deletion(-) create mode 100644 .dev/ast_fuzz_test.R create mode 100644 .dev/maybe_fuzz_content.R diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R new file mode 100644 index 000000000..cd330d210 --- /dev/null +++ b/.dev/ast_fuzz_test.R @@ -0,0 +1,43 @@ +# Fuzz testing for lint consistency +# +# We have often encountered issues where we handle +# equivalent R constructs inconsistently, e.g., +# function(...) should almost always match the same +# rules as \(...), and '<-' assignment should almost +# always be equivalent to '='. +# +# Here, we seek to enforce that (under eventual consistency) +# by randomly altering the contents of files encountered +# under expect_lint() to swap known equivalencies. + +expect_lint_file <- "R/expect_lint.R" + +original <- readLines(expect_lint_file) +expected_line <- "file <- maybe_write_content(file, content)" +expected_line_idx <- grep(expected_line, original, fixed = TRUE) +if (length(expected_line_idx) != 1L) { + stop(sprintf( + "Please update this workflow -- need exactly one hit for line '%s' in file '%s'.", + expected_line, expect_lint_file + )) +} +writeLines( + c( + head(original, expected_line_idx-1L), + # overwrite original exit hook to always delete the fuzzed file + "on.exit({reset_lang(old_lang); unlink(file)})", + "file <- maybe_fuzz_content(file, content)", + tail(original, -expected_line_idx), + readLines(".dev/maybe_fuzz_content.R") + ), + expect_lint_file +) +# Not useful in CI but good when running locally. +withr::defer({ + writeLines(original, expect_lint_file) + pkgload::load_all() +}) + +pkgload::load_all() + +testthat::test_dir("tests") diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R new file mode 100644 index 000000000..fffce7d1f --- /dev/null +++ b/.dev/maybe_fuzz_content.R @@ -0,0 +1,50 @@ +maybe_fuzz_content <- function(file, lines) { + new_file <- tempfile() + if (is.null(file)) { + con <- file(new_file, encoding = "UTF-8") + writeLines(lines, con = con, sep = "\n") + close(con) + } else { + file.copy(file, new_file, copy.mode = FALSE) + } + + fuzz_contents(new_file) + + new_file +} + +fuzz_contents <- function(f) { + pd <- getParseData(parse(f, keep.source = TRUE)) + + fun_tokens <- c("'\\\\'", "FUNCTION") + fun_idx <- which(pd$token %in% fun_tokens) + n_fun <- length(fun_idx) + + if (n_fun == 0L) { + return(invisible()) + } + + pd$new_token[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) + + l <- readLines(f) + + replacement_map <- c(FUNCTION = " \\", `'\\\\'` = "function") + for (ii in rev(fun_idx)) { + if (pd$token[ii] == pd$new_token[ii]) next + browser() + ptn = rex::rex( + start, + capture(n_times(anything, pd$col1[ii] - 1L), name = "prefix"), + pd$text[ii] + ) + l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, replacement_map[pd$token[ii]]) + } + + + start <- pd$col1[fun_idx] + substr(l[pd$line1[fun_idx]], start, start + nchar("function") - 1L) <- replacement_map[pd$token[fun_idx]] + + writeLines(l, f) + + invisible() +} diff --git a/R/expect_lint.R b/R/expect_lint.R index 30e377d7c..5d321354a 100644 --- a/R/expect_lint.R +++ b/R/expect_lint.R @@ -47,7 +47,9 @@ expect_lint <- function(content, checks, ..., file = NULL, language = "en") { old_lang <- set_lang(language) on.exit(reset_lang(old_lang)) - file <- maybe_write_content(file, content) + if (is.null(file)) on.exit(unlink(file), add = TRUE) +on.exit({reset_lang(old_lang); unlink(file)}) +file <- maybe_fuzz_content(file, content) lints <- lint(file, ...) n_lints <- length(lints) @@ -165,3 +167,47 @@ require_testthat <- function() { ) } } +maybe_fuzz_content <- function(file, lines) { + new_file <- tempfile() + if (is.null(file)) { + con <- file(new_file, encoding = "UTF-8") + writeLines(lines, con = con, sep = "\n") + close(con) + } else { + file.copy(file, new_file, copy.mode = FALSE) + } + + fuzz_contents(new_file) + + new_file +} + +fuzz_contents <- function(f) { + pd <- getParseData(parse(f, keep.source = TRUE)) + + fun_tokens <- c("'\\\\'", "FUNCTION") + fun_idx <- which(pd$token %in% fun_tokens) + n_fun <- length(fun_idx) + + if (n_fun == 0L) { + return(invisible()) + } + + pd$new_token[fun_idx] <- sample(fun_tokens, length(fun_idx), replace = TRUE) + + l <- readLines(f) + + for (ii in rev(fun_idx)) { + if (pd$token[ii] == pd$new_token[ii]) next + browser() + ptn = paste0("^(.{", pd$col1 - 1L, "})") + } + + replacement_map <- c(FUNCTION = " \\", `'\\\\'` = "function") + start <- pd$col1[fun_idx] + substr(l[pd$line1[fun_idx]], start, start + nchar("function") - 1L) <- replacement_map[pd$token[fun_idx]] + + writeLines(l, f) + + invisible() +} From 5cef281b62b7a6ba61466b10a9ec9cf3bf58e430 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 17:35:37 +0000 Subject: [PATCH 03/57] getting very close i think... --- .dev/ast_fuzz_test.R | 4 ++-- .dev/maybe_fuzz_content.R | 10 +++------- R/expect_lint.R | 3 +-- 3 files changed, 6 insertions(+), 11 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index cd330d210..46be6a27c 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -25,8 +25,8 @@ writeLines( c( head(original, expected_line_idx-1L), # overwrite original exit hook to always delete the fuzzed file - "on.exit({reset_lang(old_lang); unlink(file)})", - "file <- maybe_fuzz_content(file, content)", + " on.exit({reset_lang(old_lang); unlink(file)})", + " file <- maybe_fuzz_content(file, content)", tail(original, -expected_line_idx), readLines(".dev/maybe_fuzz_content.R") ), diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index fffce7d1f..b5af3cb09 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -24,26 +24,22 @@ fuzz_contents <- function(f) { return(invisible()) } + pd$new_token <- NA_character_ pd$new_token[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) l <- readLines(f) - replacement_map <- c(FUNCTION = " \\", `'\\\\'` = "function") + replacement_map <- c(FUNCTION = "\\", `'\\\\'` = "function") for (ii in rev(fun_idx)) { if (pd$token[ii] == pd$new_token[ii]) next - browser() ptn = rex::rex( start, capture(n_times(anything, pd$col1[ii] - 1L), name = "prefix"), pd$text[ii] ) - l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, replacement_map[pd$token[ii]]) + l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, paste0("\\1", rex::rex(replacement_map[pd$token[ii]]))) } - - start <- pd$col1[fun_idx] - substr(l[pd$line1[fun_idx]], start, start + nchar("function") - 1L) <- replacement_map[pd$token[fun_idx]] - writeLines(l, f) invisible() diff --git a/R/expect_lint.R b/R/expect_lint.R index 5d321354a..811dda0ea 100644 --- a/R/expect_lint.R +++ b/R/expect_lint.R @@ -48,8 +48,7 @@ expect_lint <- function(content, checks, ..., file = NULL, language = "en") { on.exit(reset_lang(old_lang)) if (is.null(file)) on.exit(unlink(file), add = TRUE) -on.exit({reset_lang(old_lang); unlink(file)}) -file <- maybe_fuzz_content(file, content) + file <- maybe_write_content(file, content) lints <- lint(file, ...) n_lints <- length(lints) From a4e4a66f36a7bbe4d8db6fab56d90f58ef9449b2 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 17:41:43 +0000 Subject: [PATCH 04/57] skip Rmd files --- .dev/maybe_fuzz_content.R | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index b5af3cb09..3f2969f66 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -14,7 +14,11 @@ maybe_fuzz_content <- function(file, lines) { } fuzz_contents <- function(f) { - pd <- getParseData(parse(f, keep.source = TRUE)) + pd <- tryCatch(getParseData(parse(f, keep.source = TRUE)), error = identity) + # e.g. Rmd files. We could use get_source_expressions(), but with little benefit & much slower. + if (inherits(pd, "error")) { + return(invisible()) + } fun_tokens <- c("'\\\\'", "FUNCTION") fun_idx <- which(pd$token %in% fun_tokens) From 0b1eaf5e5984928ded4fc4ac44357c9d12b14b4e Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 17:43:06 +0000 Subject: [PATCH 05/57] caught a live one! --- R/terminal_close_linter.R | 2 +- tests/testthat/test-terminal_close_linter.R | 36 +++++++++++++++++++-- 2 files changed, 34 insertions(+), 4 deletions(-) diff --git a/R/terminal_close_linter.R b/R/terminal_close_linter.R index 20b86ac64..7c4a44285 100644 --- a/R/terminal_close_linter.R +++ b/R/terminal_close_linter.R @@ -39,7 +39,7 @@ #' @export terminal_close_linter <- make_linter_from_xpath( xpath = " - //FUNCTION + (//FUNCTION | //OP-LAMBDA) /following-sibling::expr /expr[last()][ expr/SYMBOL_FUNCTION_CALL[text() = 'close'] diff --git a/tests/testthat/test-terminal_close_linter.R b/tests/testthat/test-terminal_close_linter.R index 697804f68..b20149005 100644 --- a/tests/testthat/test-terminal_close_linter.R +++ b/tests/testthat/test-terminal_close_linter.R @@ -9,7 +9,7 @@ test_that("terminal_close_linter skips allowed cases", { return(invisible()) } ") - expect_lint(lines, NULL, linter) + expect_no_lint(lines, linter) lines <- trim_some(" foo <- function(bar) { @@ -17,7 +17,15 @@ test_that("terminal_close_linter skips allowed cases", { return(close) } ") - expect_lint(lines, NULL, linter) + expect_no_lint(lines, linter) + + lines <- trim_some(" + foo <- \\(bar) { + close <- bar + 1 + return(close) + } + ") + expect_no_lint(lines, linter) lines <- trim_some(" foo <- function(bar) { @@ -25,7 +33,7 @@ test_that("terminal_close_linter skips allowed cases", { close } ") - expect_lint(lines, NULL, linter) + expect_no_lint(lines, linter) }) test_that("terminal_close_linter blocks simple cases", { @@ -72,3 +80,25 @@ test_that("terminal_close_linter blocks simple cases", { linter ) }) + +test_that("lints vectorize", { + expect_lint( + trim_some("{ + foo <- function() { + tmp <- file(tempfile()) + writeLines(letters, tmp) + close(tmp) + } + bar <- \\() { + tmp <- file(tempfile()) + writeLines(letters, tmp) + close(tmp) + } + }"), + list( + list("close connections", line_number = 5L), + list("close connections", line_number = 10L) + ), + terminal_close_linter() + ) +}) From 868ad3079a4b287b3e88701d99b8410fc3403d12 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 17:55:25 +0000 Subject: [PATCH 06/57] need to match original file extension? --- .dev/maybe_fuzz_content.R | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 3f2969f66..60bb6588c 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -1,10 +1,11 @@ maybe_fuzz_content <- function(file, lines) { - new_file <- tempfile() if (is.null(file)) { + new_file <- tempfile() con <- file(new_file, encoding = "UTF-8") writeLines(lines, con = con, sep = "\n") close(con) } else { + new_file <- tempfile(fileext = tools::file_ext(file)) file.copy(file, new_file, copy.mode = FALSE) } From 0ed5cc042506832b19587161899e9d80aea9c988 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 17:58:44 +0000 Subject: [PATCH 07/57] caught another one! --- R/library_call_linter.R | 4 ++-- tests/testthat/test-library_call_linter.R | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/R/library_call_linter.R b/R/library_call_linter.R index fb5c20e80..b87297d8e 100644 --- a/R/library_call_linter.R +++ b/R/library_call_linter.R @@ -111,7 +111,7 @@ library_call_linter <- function(allow_preamble = TRUE) { expr[2][STR_CONST] or ( SYMBOL_SUB[text() = 'character.only'] - and not(ancestor::expr[FUNCTION]) + and not(ancestor::expr[FUNCTION or OP-LAMBDA]) ) ] ") @@ -122,7 +122,7 @@ library_call_linter <- function(allow_preamble = TRUE) { //SYMBOL_FUNCTION_CALL[{ xp_text_in_table(bad_indirect_funs) }] /parent::expr /parent::expr[ - not(ancestor::expr[FUNCTION]) + not(ancestor::expr[FUNCTION or OP-LAMBDA]) and expr[{ call_symbol_cond }] ] ") diff --git a/tests/testthat/test-library_call_linter.R b/tests/testthat/test-library_call_linter.R index fc5b53367..f43790b36 100644 --- a/tests/testthat/test-library_call_linter.R +++ b/tests/testthat/test-library_call_linter.R @@ -220,7 +220,9 @@ test_that("skips allowed usages of library()/character.only=TRUE", { expect_no_lint("library(data.table)", linter) expect_no_lint("function(pkg) library(pkg, character.only = TRUE)", linter) + expect_no_lint("\\(pkg) library(pkg, character.only = TRUE)", linter) expect_no_lint("function(pkgs) sapply(pkgs, require, character.only = TRUE)", linter) + expect_no_lint("\\(pkgs) sapply(pkgs, require, character.only = TRUE)", linter) }) test_that("blocks disallowed usages of strings in library()/require()", { From 99d00a36548bcd27572e97261ed6d6ee5fe697bf Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 18:29:58 +0000 Subject: [PATCH 08/57] simpler approach, avoid rex() due to bug --- .dev/maybe_fuzz_content.R | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 60bb6588c..16c5e566c 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -21,28 +21,24 @@ fuzz_contents <- function(f) { return(invisible()) } - fun_tokens <- c("'\\\\'", "FUNCTION") - fun_idx <- which(pd$token %in% fun_tokens) + fun_tokens <- c(`'\\\\'` = "\\", `FUNCTION` = "function") + fun_idx <- which(pd$token %in% names(fun_tokens)) n_fun <- length(fun_idx) if (n_fun == 0L) { return(invisible()) } - pd$new_token <- NA_character_ - pd$new_token[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) + pd$new_text <- NA_character_ + pd$new_text[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) l <- readLines(f) - replacement_map <- c(FUNCTION = "\\", `'\\\\'` = "function") for (ii in rev(fun_idx)) { - if (pd$token[ii] == pd$new_token[ii]) next - ptn = rex::rex( - start, - capture(n_times(anything, pd$col1[ii] - 1L), name = "prefix"), - pd$text[ii] - ) - l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, paste0("\\1", rex::rex(replacement_map[pd$token[ii]]))) + if (pd$text[ii] == pd$new_text[ii]) next + # Tried, with all rex(), hit a bug: https://github.com/r-lib/rex/issues/96 + ptn = paste0("^(.{", pd$col1[ii] - 1L, "})", rex::rex(pd$text[ii])) + l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, paste0("\\1", rex::rex(pd$new_text[ii]))) } writeLines(l, f) From d3cca7ad7a5af660f0544e7bc329586ff8db53f7 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 19:35:29 +0000 Subject: [PATCH 09/57] also ignore warnings --- .dev/maybe_fuzz_content.R | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 16c5e566c..b14a90aeb 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -15,8 +15,9 @@ maybe_fuzz_content <- function(file, lines) { } fuzz_contents <- function(f) { - pd <- tryCatch(getParseData(parse(f, keep.source = TRUE)), error = identity) - # e.g. Rmd files. We could use get_source_expressions(), but with little benefit & much slower. + # skip errors for e.g. Rmd files, and ignore warnings. + # We could use get_source_expressions(), but with little benefit & much slower. + pd <- tryCatch(getParseData(suppressWarnings(parse(f, keep.source = TRUE))), error = identity) if (inherits(pd, "error")) { return(invisible()) } From 59dc1b02ead3249c3f914f85dd78dfffcbcd8bb5 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 19:59:09 +0000 Subject: [PATCH 10/57] finally getting somewhere... --- .dev/ast_fuzz_test.R | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 46be6a27c..993be3b6b 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -40,4 +40,20 @@ withr::defer({ pkgload::load_all() -testthat::test_dir("tests") +reporter <- testthat::SummaryReporter$new() +testthat::test_local(reporter = reporter) + +failures <- reporter$failures$as_list() +valid_failure <- vapply( + failures, + function(failure) { + if (grepl("column_number [0-9]+L? did not match", failure$message)) { + return(TRUE) + } + FALSE + }, + logical(1L) +) +for (failure in failures) { + +} From a25065f7244f3d889b4335dea4401a092577ea3c Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 20:48:40 +0000 Subject: [PATCH 11/57] progressively more complicated :( --- .dev/ast_fuzz_test.R | 46 +++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 43 insertions(+), 3 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 993be3b6b..802c19eeb 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -40,6 +40,46 @@ withr::defer({ pkgload::load_all() +test_restorations <- list() +for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = TRUE)) { + xml <- xml2::read_xml(xmlparsedata::xml_parse_data(parse(test_file, keep.source = TRUE))) + # parent::* to catch top-level comments (exprlist) + nofuzz_lines <- xml_find_all(xml, "//COMMENT[contains(text(), 'nofuzz')]/parent::*") + if (length(nofuzz_lines) == 0L) next + + original <- test_lines <- readLines(test_file) + + for (nofuzz_line in nofuzz_lines) { + comments <- xml2::xml_find_all(nofuzz_line, "COMMENT[contains(text(), 'nofuzz')]") + comment_text <- xml2::xml_text(comments) + start_idx <- grep("nofuzz start", comment_text, fixed = TRUE) + end_idx <- grep("nofuzz end", comment_text, fixed = TRUE) + if (length(start_idx) != length(end_idx) || any(end_idx < start_idx)) { + stop(sprintf( + "Mismatched '# nofuzz start' (%s), '# nofuzz end' (%s) in %s", + toString(start_idx), toString(end_idx), test_file + )) + } + + comment_range <- Map(`:`, + as.integer(xml2::xml_attr(comments[start_idx], "line1")), + as.integer(xml2::xml_attr(comments[end_idx], "line1")) + ) + for (comment_range in comment_ranges) { + test_lines[comment_range] <- paste("#", test_lines[comment_range]) + } + + if (!any(!start_idx & !end_idx)) next + + comment_range <- as.integer(xml2::xml_attr(nofuzz_line, "line1")):as.integer(xml2::xml_attr(nofuzz_line, "line2")) + test_lines[comment_range] <- paste("#", test_lines[comment_range]) + } + + writeLines(test_lines, test_file) + test_restorations <- c(test_restorations, list(list(file = test_file, lines = original))) +} +withr::defer(for (restoration in test_restorations) writeLines(restoration$original, restoration$file)) + reporter <- testthat::SummaryReporter$new() testthat::test_local(reporter = reporter) @@ -50,10 +90,10 @@ valid_failure <- vapply( if (grepl("column_number [0-9]+L? did not match", failure$message)) { return(TRUE) } + if (grepl("ranges list[(].* did not match", failure$message)) { + return(TRUE) + } FALSE }, logical(1L) ) -for (failure in failures) { - -} From 491a3405ae88761410a5ee2b9c5444228617ec1d Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 20:58:02 +0000 Subject: [PATCH 12/57] round of fixes & first working nofuzz --- .dev/ast_fuzz_test.R | 7 +++++-- tests/testthat/test-exclusions.R | 2 +- tests/testthat/test-get_source_expressions.R | 21 +++++++++++--------- tests/testthat/test-indentation_linter.R | 2 ++ 4 files changed, 20 insertions(+), 12 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 802c19eeb..9cc411084 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -61,7 +61,7 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = )) } - comment_range <- Map(`:`, + comment_ranges <- Map(`:`, as.integer(xml2::xml_attr(comments[start_idx], "line1")), as.integer(xml2::xml_attr(comments[end_idx], "line1")) ) @@ -69,8 +69,11 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = test_lines[comment_range] <- paste("#", test_lines[comment_range]) } - if (!any(!start_idx & !end_idx)) next + if (length(start_idx) > 0L && !any(!start_idx & !end_idx)) next + # NB: one-line tests line expect_lint(...) # nofuzz are not supported, + # since the comment will attach to the parent test_that() & thus comment + # out the whole unit. Easiest solution is just to spread out those few tests for now. comment_range <- as.integer(xml2::xml_attr(nofuzz_line, "line1")):as.integer(xml2::xml_attr(nofuzz_line, "line2")) test_lines[comment_range] <- paste("#", test_lines[comment_range]) } diff --git a/tests/testthat/test-exclusions.R b/tests/testthat/test-exclusions.R index 9fce8adf5..9bfddc81e 100644 --- a/tests/testthat/test-exclusions.R +++ b/tests/testthat/test-exclusions.R @@ -142,7 +142,7 @@ test_that("#1442: is_excluded_files works if no global exclusions are specified" ) # 3 lints: assignment_linter(), quotes_linter() and line_length_linter() - expect_lint( + expect_lint( # nofuzz file = file.path(tmp, "bad.R"), checks = list( list(linter = "assignment_linter", line_number = 1L), diff --git a/tests/testthat/test-get_source_expressions.R b/tests/testthat/test-get_source_expressions.R index 64dbd548d..d99016d78 100644 --- a/tests/testthat/test-get_source_expressions.R +++ b/tests/testthat/test-get_source_expressions.R @@ -108,7 +108,10 @@ test_that("Can read non UTF-8 file", { withr::local_options(list(lintr.linter_file = tempfile())) proj_dir <- test_path("dummy_projects", "project") withr::local_dir(proj_dir) - expect_no_lint(file = "cp1252.R", linters = list()) + expect_no_lint( # nofuzz + file = "cp1252.R", + linters = list() + ) }) test_that("Warns if encoding is misspecified, Pt. 1", { @@ -142,14 +145,14 @@ test_that("Warns if encoding is misspecified, Pt. 1", { test_that("Can extract line number from parser errors", { with_content_to_parse( - trim_some(' - "ok" - R"---a---" - '), - { - expect_identical(error$message, "Malformed raw string literal.") - expect_identical(error$line_number, 2L) - } +# # trim_some(' +# # "ok" +# # R"---a---" +# # '), +# # { +# # expect_identical(error$message, "Malformed raw string literal.") +# # expect_identical(error$line_number, 2L) +# # } ) with_content_to_parse( diff --git a/tests/testthat/test-indentation_linter.R b/tests/testthat/test-indentation_linter.R index 4dd640389..10550eaff 100644 --- a/tests/testthat/test-indentation_linter.R +++ b/tests/testthat/test-indentation_linter.R @@ -152,6 +152,7 @@ test_that("indentation linter flags improper closing curly braces", { ) }) +# nofuzz start test_that("function argument indentation works in tidyverse-style", { linter <- indentation_linter() expect_no_lint( @@ -260,6 +261,7 @@ test_that("function argument indentation works in tidyverse-style", { linter ) }) +# nofuzz end test_that("function argument indentation works in always-hanging-style", { linter <- indentation_linter(hanging_indent_style = "always") From 92f0628ff64cd109e87120392ffe7add7992d232 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 21:03:19 +0000 Subject: [PATCH 13/57] looks like we got another live one... break time --- tests/testthat/test-indentation_linter.R | 2 +- tests/testthat/test-object_usage_linter.R | 14 ++++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/tests/testthat/test-indentation_linter.R b/tests/testthat/test-indentation_linter.R index 10550eaff..229f78cbe 100644 --- a/tests/testthat/test-indentation_linter.R +++ b/tests/testthat/test-indentation_linter.R @@ -261,7 +261,6 @@ test_that("function argument indentation works in tidyverse-style", { linter ) }) -# nofuzz end test_that("function argument indentation works in always-hanging-style", { linter <- indentation_linter(hanging_indent_style = "always") @@ -357,6 +356,7 @@ test_that("function argument indentation works in always-hanging-style", { linter ) }) +# nofuzz end test_that("indentation with operators works", { linter <- indentation_linter() diff --git a/tests/testthat/test-object_usage_linter.R b/tests/testthat/test-object_usage_linter.R index a12620008..3472fec3a 100644 --- a/tests/testthat/test-object_usage_linter.R +++ b/tests/testthat/test-object_usage_linter.R @@ -177,10 +177,10 @@ test_that("calls with top level function definitions are ignored", { test_that("object-usage line-numbers are relative to start-of-file", { expect_lint( trim_some(" - a <- function(y) { + a <- \\(y) { y ** 2 } - b <- function() { + b <- \\() { x } "), @@ -672,6 +672,8 @@ test_that("messages without a quoted name are caught", { # See #1914 test_that("symbols in formulas aren't treated as 'undefined global'", { + linter <- object_usage_linter() + expect_lint( trim_some(" foo <- function(x) { @@ -686,7 +688,7 @@ test_that("symbols in formulas aren't treated as 'undefined global'", { line_number = 4L, column_number = 21L ), - object_usage_linter() + linter ) # neither on the RHS @@ -704,7 +706,7 @@ test_that("symbols in formulas aren't treated as 'undefined global'", { line_number = 4L, column_number = 21L ), - object_usage_linter() + linter ) # nor in nested expressions @@ -722,7 +724,7 @@ test_that("symbols in formulas aren't treated as 'undefined global'", { line_number = 4L, column_number = 21L ), - object_usage_linter() + linter ) # nor as a call @@ -743,7 +745,7 @@ test_that("symbols in formulas aren't treated as 'undefined global'", { line_number = 4L, column_number = 21L ), - object_usage_linter() + linter ) }) From d387a715ee5ce35669d2f9c6beef0129b93e0024 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 21:40:23 +0000 Subject: [PATCH 14/57] another true positive --- R/unnecessary_lambda_linter.R | 2 +- tests/testthat/test-object_usage_linter.R | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/R/unnecessary_lambda_linter.R b/R/unnecessary_lambda_linter.R index 007b3c831..f2f62232d 100644 --- a/R/unnecessary_lambda_linter.R +++ b/R/unnecessary_lambda_linter.R @@ -93,7 +93,7 @@ unnecessary_lambda_linter <- function(allow_comparison = FALSE) { # NB: this includes 0+3 and TRUE+FALSE, which are also fine. inner_comparison_xpath <- glue(" parent::expr - /expr[FUNCTION] + /expr[FUNCTION or OP-LAMBDA] /expr[ ({ xp_or(infix_metadata$xml_tag[infix_metadata$comparator]) }) and expr[ diff --git a/tests/testthat/test-object_usage_linter.R b/tests/testthat/test-object_usage_linter.R index 3472fec3a..d2c58371e 100644 --- a/tests/testthat/test-object_usage_linter.R +++ b/tests/testthat/test-object_usage_linter.R @@ -177,10 +177,10 @@ test_that("calls with top level function definitions are ignored", { test_that("object-usage line-numbers are relative to start-of-file", { expect_lint( trim_some(" - a <- \\(y) { + a <- function(y) { y ** 2 } - b <- \\() { + b <- function() { x } "), From e150ffe73791da5d70b863c3c5ce5d87eb8c46c9 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:01:14 +0000 Subject: [PATCH 15/57] more ignores, need '.' in file extension, restore test --- .dev/ast_fuzz_test.R | 11 ++++------- .dev/maybe_fuzz_content.R | 2 +- tests/testthat/test-get_source_expressions.R | 16 ++++++++-------- 3 files changed, 13 insertions(+), 16 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 9cc411084..84f263d7d 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -47,7 +47,7 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = nofuzz_lines <- xml_find_all(xml, "//COMMENT[contains(text(), 'nofuzz')]/parent::*") if (length(nofuzz_lines) == 0L) next - original <- test_lines <- readLines(test_file) + test_original <- test_lines <- readLines(test_file) for (nofuzz_line in nofuzz_lines) { comments <- xml2::xml_find_all(nofuzz_line, "COMMENT[contains(text(), 'nofuzz')]") @@ -79,9 +79,9 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = } writeLines(test_lines, test_file) - test_restorations <- c(test_restorations, list(list(file = test_file, lines = original))) + test_restorations <- c(test_restorations, list(list(file = test_file, lines = test_original))) } -withr::defer(for (restoration in test_restorations) writeLines(restoration$original, restoration$file)) +withr::defer(for (restoration in test_restorations) writeLines(restoration$lines, restoration$file)) reporter <- testthat::SummaryReporter$new() testthat::test_local(reporter = reporter) @@ -90,10 +90,7 @@ failures <- reporter$failures$as_list() valid_failure <- vapply( failures, function(failure) { - if (grepl("column_number [0-9]+L? did not match", failure$message)) { - return(TRUE) - } - if (grepl("ranges list[(].* did not match", failure$message)) { + if (grepl('(column_number|ranges|line) .* did not match', failure$message)) { return(TRUE) } FALSE diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index b14a90aeb..b805b865d 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -5,7 +5,7 @@ maybe_fuzz_content <- function(file, lines) { writeLines(lines, con = con, sep = "\n") close(con) } else { - new_file <- tempfile(fileext = tools::file_ext(file)) + new_file <- tempfile(fileext = paste0(".", tools::file_ext(file))) file.copy(file, new_file, copy.mode = FALSE) } diff --git a/tests/testthat/test-get_source_expressions.R b/tests/testthat/test-get_source_expressions.R index d99016d78..bbda9d362 100644 --- a/tests/testthat/test-get_source_expressions.R +++ b/tests/testthat/test-get_source_expressions.R @@ -145,14 +145,14 @@ test_that("Warns if encoding is misspecified, Pt. 1", { test_that("Can extract line number from parser errors", { with_content_to_parse( -# # trim_some(' -# # "ok" -# # R"---a---" -# # '), -# # { -# # expect_identical(error$message, "Malformed raw string literal.") -# # expect_identical(error$line_number, 2L) -# # } + trim_some(' + "ok" + R"---a---" + '), + { + expect_identical(error$message, "Malformed raw string literal.") + expect_identical(error$line_number, 2L) + } ) with_content_to_parse( From 3d1fc0ea7f8b32ac7cecd2ad3a3e8343dd09a1ca Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:07:41 +0000 Subject: [PATCH 16/57] wrapping up --- .dev/ast_fuzz_test.R | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 84f263d7d..6ae518e31 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -97,3 +97,10 @@ valid_failure <- vapply( }, logical(1L) ) +if (!all(valid_failure)) { + failures <- failures[!valid_failure] + names(failures) <- vapply(failures, `[[`, "test", FUN.VALUE = character(1L)) + cat("Some fuzzed tests failed unexpectedly!\n") + print(failures) + stop("Use # nofuzz [start|end] to mark false positives or fix any bugs.") +} From b69b7cd0a8d8632a022c96a135c8212c04b80b63 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:11:53 +0000 Subject: [PATCH 17/57] Write up the GHA config --- .dev/ast_fuzz_test.R | 14 ++++++++------ .github/workflows/ast-fuzz.yaml | 30 ++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 6 deletions(-) create mode 100644 .github/workflows/ast-fuzz.yaml diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 6ae518e31..d8a14ade7 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -10,6 +10,8 @@ # by randomly altering the contents of files encountered # under expect_lint() to swap known equivalencies. +library(xml2) + expect_lint_file <- "R/expect_lint.R" original <- readLines(expect_lint_file) @@ -42,7 +44,7 @@ pkgload::load_all() test_restorations <- list() for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = TRUE)) { - xml <- xml2::read_xml(xmlparsedata::xml_parse_data(parse(test_file, keep.source = TRUE))) + xml <- read_xml(xmlparsedata::xml_parse_data(parse(test_file, keep.source = TRUE))) # parent::* to catch top-level comments (exprlist) nofuzz_lines <- xml_find_all(xml, "//COMMENT[contains(text(), 'nofuzz')]/parent::*") if (length(nofuzz_lines) == 0L) next @@ -50,8 +52,8 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = test_original <- test_lines <- readLines(test_file) for (nofuzz_line in nofuzz_lines) { - comments <- xml2::xml_find_all(nofuzz_line, "COMMENT[contains(text(), 'nofuzz')]") - comment_text <- xml2::xml_text(comments) + comments <- xml_find_all(nofuzz_line, "COMMENT[contains(text(), 'nofuzz')]") + comment_text <- xml_text(comments) start_idx <- grep("nofuzz start", comment_text, fixed = TRUE) end_idx <- grep("nofuzz end", comment_text, fixed = TRUE) if (length(start_idx) != length(end_idx) || any(end_idx < start_idx)) { @@ -62,8 +64,8 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = } comment_ranges <- Map(`:`, - as.integer(xml2::xml_attr(comments[start_idx], "line1")), - as.integer(xml2::xml_attr(comments[end_idx], "line1")) + as.integer(xml_attr(comments[start_idx], "line1")), + as.integer(xml_attr(comments[end_idx], "line1")) ) for (comment_range in comment_ranges) { test_lines[comment_range] <- paste("#", test_lines[comment_range]) @@ -74,7 +76,7 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = # NB: one-line tests line expect_lint(...) # nofuzz are not supported, # since the comment will attach to the parent test_that() & thus comment # out the whole unit. Easiest solution is just to spread out those few tests for now. - comment_range <- as.integer(xml2::xml_attr(nofuzz_line, "line1")):as.integer(xml2::xml_attr(nofuzz_line, "line2")) + comment_range <- as.integer(xml_attr(nofuzz_line, "line1")):as.integer(xml_attr(nofuzz_line, "line2")) test_lines[comment_range] <- paste("#", test_lines[comment_range]) } diff --git a/.github/workflows/ast-fuzz.yaml b/.github/workflows/ast-fuzz.yaml new file mode 100644 index 000000000..6242360cf --- /dev/null +++ b/.github/workflows/ast-fuzz.yaml @@ -0,0 +1,30 @@ +# Randomly change some code & ensure lint equivalency is maintained +on: + push: + branches: [main] + # TODO before merging: remove this. Only kept to demonstrate during review. + pull_request: + branches: [main] + +name: ast-fuzz + +jobs: + repo-meta-tests: + runs-on: ubuntu-latest + env: + GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }} + + steps: + - uses: actions/checkout@v4 + + - uses: r-lib/actions/setup-r@v2 + with: + r-version: "release" + use-public-rspm: true + + - uses: r-lib/actions/setup-r-dependencies@v2 + + - name: Ensure equivalent code generates equivalent lints + run: | + callr::rscript(".dev/ast_fuzz_test.R") + shell: Rscript {0} From b8a06e39b3a9d6cbc8924fccc9143b2d945cdfe5 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:23:16 +0000 Subject: [PATCH 18/57] annotation --- .dev/ast_fuzz_test.R | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index d8a14ade7..e67dc0ecc 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -42,10 +42,23 @@ withr::defer({ pkgload::load_all() +# beware lazy eval: originally tried adding a withr::defer() in each iteration, but +# this effectively only runs the last 'defer' expression as the names are only +# evaluated at run-time. So instead keep track of all edits in this object. +# this approach to implementing 'nofuzz' feels painfully manual, but I couldn't +# figure out how else to get 'testthat' to give us what we need -- the failures +# object in the reporter is frustratingly inconsistent in whether the trace +# exists, and even if it does, we'd have to text-mangle to get the corresponding +# file names out. Also, the trace 'srcref' happens under keep.source=FALSE, +# so we lose any associated comments anyway. even that would not solve the issue +# of getting top-level exclusions done for 'nofuzz start|end' ranges, except +# maybe if it enabled us to reuse lintr's own exclude() system. +# therefore we take this approach: pass over the test suite first and comment out +# any tests/units that have been marked 'nofuzz'. restore later. test_restorations <- list() for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = TRUE)) { xml <- read_xml(xmlparsedata::xml_parse_data(parse(test_file, keep.source = TRUE))) - # parent::* to catch top-level comments (exprlist) + # parent::* to catch top-level comments (exprlist). matches one-line nofuzz and start/end ranges. nofuzz_lines <- xml_find_all(xml, "//COMMENT[contains(text(), 'nofuzz')]/parent::*") if (length(nofuzz_lines) == 0L) next @@ -54,6 +67,7 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = for (nofuzz_line in nofuzz_lines) { comments <- xml_find_all(nofuzz_line, "COMMENT[contains(text(), 'nofuzz')]") comment_text <- xml_text(comments) + # handle start/end ranges first. start_idx <- grep("nofuzz start", comment_text, fixed = TRUE) end_idx <- grep("nofuzz end", comment_text, fixed = TRUE) if (length(start_idx) != length(end_idx) || any(end_idx < start_idx)) { @@ -85,10 +99,18 @@ for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = } withr::defer(for (restoration in test_restorations) writeLines(restoration$lines, restoration$file)) +# for some reason, 'report <- test_dir(...)' did not work -- the resulting object is ~empty. +# even 'report <- test_local(...)', which does return an object, lacks any information about +# which tests failed (all reports are about successful or skipped tests). probably this is not +# the best approach but documentation was not very helpful. reporter <- testthat::SummaryReporter$new() testthat::test_local(reporter = reporter) failures <- reporter$failures$as_list() +# ignore any test that failed for expected reasons, e.g. some known lint metadata changes +# about line numbers or the contents of the line. this saves us having to pepper tons of +# 'nofuzz' comments throughout the suite, as well as getting around the difficulty of injecting +# 'expect_lint()' with new code to ignore these attributes (this latter we might explore later). valid_failure <- vapply( failures, function(failure) { From a3dbf278766af57ac7c007f98000a4fe45fd0ae8 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:26:05 +0000 Subject: [PATCH 19/57] comment for future work --- .dev/maybe_fuzz_content.R | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index b805b865d..6a7849c39 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -14,6 +14,8 @@ maybe_fuzz_content <- function(file, lines) { new_file } +# we could also consider just passing any test where no fuzzing takes place, +# i.e. letting the other GHA handle whether unfuzzed tests pass as expected. fuzz_contents <- function(f) { # skip errors for e.g. Rmd files, and ignore warnings. # We could use get_source_expressions(), but with little benefit & much slower. From 5a22050b2ac38cb6346206f0860e4a6b2b88fcdf Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 22:30:33 +0000 Subject: [PATCH 20/57] vestigial --- R/expect_lint.R | 44 -------------------------------------------- 1 file changed, 44 deletions(-) diff --git a/R/expect_lint.R b/R/expect_lint.R index 811dda0ea..6e1c9e630 100644 --- a/R/expect_lint.R +++ b/R/expect_lint.R @@ -166,47 +166,3 @@ require_testthat <- function() { ) } } -maybe_fuzz_content <- function(file, lines) { - new_file <- tempfile() - if (is.null(file)) { - con <- file(new_file, encoding = "UTF-8") - writeLines(lines, con = con, sep = "\n") - close(con) - } else { - file.copy(file, new_file, copy.mode = FALSE) - } - - fuzz_contents(new_file) - - new_file -} - -fuzz_contents <- function(f) { - pd <- getParseData(parse(f, keep.source = TRUE)) - - fun_tokens <- c("'\\\\'", "FUNCTION") - fun_idx <- which(pd$token %in% fun_tokens) - n_fun <- length(fun_idx) - - if (n_fun == 0L) { - return(invisible()) - } - - pd$new_token[fun_idx] <- sample(fun_tokens, length(fun_idx), replace = TRUE) - - l <- readLines(f) - - for (ii in rev(fun_idx)) { - if (pd$token[ii] == pd$new_token[ii]) next - browser() - ptn = paste0("^(.{", pd$col1 - 1L, "})") - } - - replacement_map <- c(FUNCTION = " \\", `'\\\\'` = "function") - start <- pd$col1[fun_idx] - substr(l[pd$line1[fun_idx]], start, start + nchar("function") - 1L) <- replacement_map[pd$token[fun_idx]] - - writeLines(l, f) - - invisible() -} From 76b869f8a5cbefbfbaebb7f4c8e20cc9e3ccd09d Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:07:04 +0000 Subject: [PATCH 21/57] skips on old R --- tests/testthat/test-library_call_linter.R | 4 +++- tests/testthat/test-terminal_close_linter.R | 2 ++ 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/tests/testthat/test-library_call_linter.R b/tests/testthat/test-library_call_linter.R index f43790b36..aca3427c0 100644 --- a/tests/testthat/test-library_call_linter.R +++ b/tests/testthat/test-library_call_linter.R @@ -220,8 +220,10 @@ test_that("skips allowed usages of library()/character.only=TRUE", { expect_no_lint("library(data.table)", linter) expect_no_lint("function(pkg) library(pkg, character.only = TRUE)", linter) - expect_no_lint("\\(pkg) library(pkg, character.only = TRUE)", linter) expect_no_lint("function(pkgs) sapply(pkgs, require, character.only = TRUE)", linter) + + skip_if_not_r_version("4.1.0") + expect_no_lint("\\(pkg) library(pkg, character.only = TRUE)", linter) expect_no_lint("\\(pkgs) sapply(pkgs, require, character.only = TRUE)", linter) }) diff --git a/tests/testthat/test-terminal_close_linter.R b/tests/testthat/test-terminal_close_linter.R index b20149005..2a3d23d1c 100644 --- a/tests/testthat/test-terminal_close_linter.R +++ b/tests/testthat/test-terminal_close_linter.R @@ -82,6 +82,8 @@ test_that("terminal_close_linter blocks simple cases", { }) test_that("lints vectorize", { + skip_if_not_r_version("4.1.0") + expect_lint( trim_some("{ foo <- function() { From afec7431fb0d922da21489c71bba10fbcfa09ecf Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:10:11 +0000 Subject: [PATCH 22/57] expect_no_lint --- .../testthat/test-unnecessary_lambda_linter.R | 96 +++++++++---------- 1 file changed, 47 insertions(+), 49 deletions(-) diff --git a/tests/testthat/test-unnecessary_lambda_linter.R b/tests/testthat/test-unnecessary_lambda_linter.R index 9a9839bb9..d223fad89 100644 --- a/tests/testthat/test-unnecessary_lambda_linter.R +++ b/tests/testthat/test-unnecessary_lambda_linter.R @@ -1,80 +1,77 @@ test_that("unnecessary_lambda_linter skips allowed usages", { linter <- unnecessary_lambda_linter() - expect_lint("lapply(DF, sum)", NULL, linter) - expect_lint("apply(M, 1, sum, na.rm = TRUE)", NULL, linter) + expect_no_lint("lapply(DF, sum)", linter) + expect_no_lint("apply(M, 1, sum, na.rm = TRUE)", linter) # the first argument may be ... or have a cumbersome name, so an anonymous # function may be preferable (e.g. this is often the case for grep() calls) - expect_lint("sapply(x, function(xi) foo(1, xi))", NULL, linter) - expect_lint("sapply(x, function(xi) return(foo(1, xi)))", NULL, linter) + expect_no_lint("sapply(x, function(xi) foo(1, xi))", linter) + expect_no_lint("sapply(x, function(xi) return(foo(1, xi)))", linter) # if the argument is re-used, that's also a no-go - expect_lint("dendrapply(x, function(xi) foo(xi, xi))", NULL, linter) + expect_no_lint("dendrapply(x, function(xi) foo(xi, xi))", linter) # at any nesting level - expect_lint("parLapply(cl, x, function(xi) foo(xi, 2, bar(baz(xi))))", NULL, linter) + expect_no_lint("parLapply(cl, x, function(xi) foo(xi, 2, bar(baz(xi))))", linter) # multi-expression case - expect_lint("lapply(x, function(xi) { print(xi); xi^2 })", NULL, linter) + expect_no_lint("lapply(x, function(xi) { print(xi); xi^2 })", linter) # multi-expression, multi-line cases - expect_lint( + expect_no_lint( trim_some(" lapply(x, function(xi) { print(xi); xi^2 }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" lapply(x, function(xi) { print(xi) xi^2 }) "), - NULL, linter ) # This _could_ be lapply(x, `%in%`, tbl), but don't force infix into lambda - expect_lint("lapply(x, function(xi) xi %in% tbl)", NULL, linter) + expect_no_lint("lapply(x, function(xi) xi %in% tbl)", linter) # This one could not - expect_lint("lapply(x, function(xi) tbl %in% xi)", NULL, linter) + expect_no_lint("lapply(x, function(xi) tbl %in% xi)", linter) # would require multiple lapply() loops - expect_lint("lapply(x, function(xi) foo(bar(xi)))", NULL, linter) - expect_lint("lapply(x, function(xi) return(foo(bar(xi))))", NULL, linter) + expect_no_lint("lapply(x, function(xi) foo(bar(xi)))", linter) + expect_no_lint("lapply(x, function(xi) return(foo(bar(xi))))", linter) # extractions, #2231 - expect_lint("lapply(l, function(x) rle(x)$values)", NULL, linter) - expect_lint('lapply(l, function(x) rle(x)["values"])', NULL, linter) - expect_lint('lapply(l, function(x) rle(x)[["values"]])', NULL, linter) - expect_lint("lapply(l, function(x) rle(x)@values)", NULL, linter) + expect_no_lint("lapply(l, function(x) rle(x)$values)", linter) + expect_no_lint('lapply(l, function(x) rle(x)["values"])', linter) + expect_no_lint('lapply(l, function(x) rle(x)[["values"]])', linter) + expect_no_lint("lapply(l, function(x) rle(x)@values)", linter) # return() extractions, #2258 - expect_lint("lapply(l, function(x) return(foo(x)$bar))", NULL, linter) - expect_lint('lapply(l, function(x) return(rle(x)["values"]))', NULL, linter) - expect_lint('lapply(l, function(x) return(rle(x)[["values"]]))', NULL, linter) - expect_lint("lapply(l, function(x) return(rle(x)@values))", NULL, linter) + expect_no_lint("lapply(l, function(x) return(foo(x)$bar))", linter) + expect_no_lint('lapply(l, function(x) return(rle(x)["values"]))', linter) + expect_no_lint('lapply(l, function(x) return(rle(x)[["values"]]))', linter) + expect_no_lint("lapply(l, function(x) return(rle(x)@values))", linter) # Other operators, #2247 - expect_lint("lapply(l, function(x) foo(x) - 1)", NULL, linter) - expect_lint("lapply(l, function(x) foo(x) * 2)", NULL, linter) - expect_lint("lapply(l, function(x) foo(x) ^ 3)", NULL, linter) - expect_lint("lapply(l, function(x) foo(x) %% 4)", NULL, linter) + expect_no_lint("lapply(l, function(x) foo(x) - 1)", linter) + expect_no_lint("lapply(l, function(x) foo(x) * 2)", linter) + expect_no_lint("lapply(l, function(x) foo(x) ^ 3)", linter) + expect_no_lint("lapply(l, function(x) foo(x) %% 4)", linter) # Don't include other lambdas, #2249 - expect_lint( + expect_no_lint( trim_some('{ lapply(x, function(e) sprintf("%o", e)) lapply(y, function(e) paste(strlpad(e, "0", width))) }'), - NULL, linter ) # only call is on RHS of operator, #2310 - expect_lint("lapply(l, function(x) 'a' %in% names(x))", NULL, linter) - expect_lint("lapply(l, function(x = 1) 'a' %in% names(x))", NULL, linter) + expect_no_lint("lapply(l, function(x) 'a' %in% names(x))", linter) + expect_no_lint("lapply(l, function(x = 1) 'a' %in% names(x))", linter) }) test_that("unnecessary_lambda_linter skips allowed inner comparisons", { @@ -82,13 +79,13 @@ test_that("unnecessary_lambda_linter skips allowed inner comparisons", { # lapply returns a list, so not the same, though as.list is probably # a better choice - expect_lint("lapply(x, function(xi) foo(xi) == 2)", NULL, linter) + expect_no_lint("lapply(x, function(xi) foo(xi) == 2)", linter) # this _may_ return a matrix, though outer is probably a better choice if so - expect_lint("sapply(x, function(xi) foo(xi) == y)", NULL, linter) + expect_no_lint("sapply(x, function(xi) foo(xi) == y)", linter) # only lint "plain" calls that can be replaced by eliminating the lambda - expect_lint("sapply(x, function(xi) sum(abs(xi)) == 0)", NULL, linter) + expect_no_lint("sapply(x, function(xi) sum(abs(xi)) == 0)", linter) }) test_that("unnecessary_lambda_linter blocks simple disallowed usage", { @@ -132,9 +129,9 @@ test_that("unnecessary_lambda_linter blocks simple disallowed usages", { expect_lint("sapply(x, function(xi) foo(xi) == 'a')", lint_msg, linter) expect_lint("sapply(x, function(xi) foo(xi) == 1 + 2i)", lint_msg, linter) - expect_lint("sapply(x, function(xi) foo(xi) == 2)", NULL, linter_allow) - expect_lint("sapply(x, function(xi) foo(xi) == 'a')", NULL, linter_allow) - expect_lint("sapply(x, function(xi) foo(xi) == 1 + 2i)", NULL, linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) == 2)", linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) == 'a')", linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) == 1 + 2i)", linter_allow) # vapply counts as well # NB: we ignore the FUN.VALUE argument, for now @@ -154,22 +151,24 @@ test_that("unnecessary_lambda_linter blocks other comparators as well", { expect_lint("sapply(x, function(xi) foo(xi) != 'a')", lint_msg, linter) expect_lint("sapply(x, function(xi) foo(xi) < 1 + 2i)", lint_msg, linter) - expect_lint("sapply(x, function(xi) foo(xi) >= 2)", NULL, linter_allow) - expect_lint("sapply(x, function(xi) foo(xi) != 'a')", NULL, linter_allow) - expect_lint("sapply(x, function(xi) foo(xi) < 1 + 2i)", NULL, linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) >= 2)", linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) != 'a')", linter_allow) + expect_no_lint("sapply(x, function(xi) foo(xi) < 1 + 2i)", linter_allow) }) test_that("unnecessary_lambda_linter doesn't apply to keyword args", { - expect_lint("lapply(x, function(xi) data.frame(nm = xi))", NULL, unnecessary_lambda_linter()) - expect_lint("lapply(x, function(xi) return(data.frame(nm = xi)))", NULL, unnecessary_lambda_linter()) + linter <- unnecessary_lambda_linter() + + expect_no_lint("lapply(x, function(xi) data.frame(nm = xi))", linter) + expect_no_lint("lapply(x, function(xi) return(data.frame(nm = xi)))", linter) }) test_that("purrr-style anonymous functions are also caught", { linter <- unnecessary_lambda_linter() - expect_lint("purrr::map(x, ~.x)", NULL, linter) - expect_lint("purrr::map_df(x, ~lm(y, .x))", NULL, linter) - expect_lint("map_dbl(x, ~foo(bar = .x))", NULL, linter) + expect_no_lint("purrr::map(x, ~.x)", linter) + expect_no_lint("purrr::map_df(x, ~lm(y, .x))", linter) + expect_no_lint("map_dbl(x, ~foo(bar = .x))", linter) expect_lint( "purrr::map(x, ~foo(.x))", @@ -234,20 +233,19 @@ test_that("cases with braces are caught", { linter ) - expect_lint( + expect_no_lint( trim_some(" lapply(x, function(xi) { print(xi) xi }) "), - NULL, linter ) # false positives like #2231, #2247 are avoided with braces too - expect_lint("lapply(x, function(xi) { foo(xi)$bar })", NULL, linter) - expect_lint("lapply(x, function(xi) { foo(xi) - 1 })", NULL, linter) + expect_no_lint("lapply(x, function(xi) { foo(xi)$bar })", linter) + expect_no_lint("lapply(x, function(xi) { foo(xi) - 1 })", linter) }) test_that("function shorthand is handled", { From 51593e408237a1c9f74368bdd215c0e0cacdd4a9 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:10:58 +0000 Subject: [PATCH 23/57] new tests --- tests/testthat/test-unnecessary_lambda_linter.R | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/tests/testthat/test-unnecessary_lambda_linter.R b/tests/testthat/test-unnecessary_lambda_linter.R index d223fad89..00f70d284 100644 --- a/tests/testthat/test-unnecessary_lambda_linter.R +++ b/tests/testthat/test-unnecessary_lambda_linter.R @@ -256,6 +256,14 @@ test_that("function shorthand is handled", { rex::rex("Pass sum directly as a symbol to lapply()"), unnecessary_lambda_linter() ) + + expect_lint("sapply(x, \\(xi) foo(xi) == 2)", lint_msg, linter) + expect_lint("sapply(x, \\(xi) foo(xi) == 'a')", lint_msg, linter) + expect_lint("sapply(x, \\(xi) foo(xi) == 1 + 2i)", lint_msg, linter) + + expect_no_lint("sapply(x, \\(xi) foo(xi) == 2)", linter_allow) + expect_no_lint("sapply(x, \\(xi) foo(xi) == 'a')", linter_allow) + expect_no_lint("sapply(x, \\(xi) foo(xi) == 1 + 2i)", linter_allow) }) test_that("lints vectorize", { From f4b9481f3ac160f67dfbc4849ddb8d79f69d0a47 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:13:14 +0000 Subject: [PATCH 24/57] NEWS --- NEWS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/NEWS.md b/NEWS.md index 661038ad7..8ea061062 100644 --- a/NEWS.md +++ b/NEWS.md @@ -53,6 +53,10 @@ ### Lint accuracy fixes: removing false negatives * `todo_comment_linter()` finds comments inside {roxygen2} markup comments (#2447, @MichaelChirico). +* Linters with logic around function declarations consistently include the R 4.0.0 shorthand `\()` (#2818, continuation of earlier #2190, @MichaelChirico). + + `library_call_linter()` + + `terminal_close_linter()` + + `unnecessary_lambda_linter()` ## Notes From 6389d5539ce55be4e3292b8c051f28b314568c5b Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 15:20:39 -0800 Subject: [PATCH 25/57] bad copy-paste --- tests/testthat/test-unnecessary_lambda_linter.R | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/tests/testthat/test-unnecessary_lambda_linter.R b/tests/testthat/test-unnecessary_lambda_linter.R index 00f70d284..608421429 100644 --- a/tests/testthat/test-unnecessary_lambda_linter.R +++ b/tests/testthat/test-unnecessary_lambda_linter.R @@ -250,13 +250,16 @@ test_that("cases with braces are caught", { test_that("function shorthand is handled", { skip_if_not_r_version("4.1.0") - + linter <- unnecessary_lambda_linter() + linter_allow <- unnecessary_lambda_linter(allow_comparison = TRUE) + expect_lint( "lapply(DF, \\(x) sum(x))", rex::rex("Pass sum directly as a symbol to lapply()"), - unnecessary_lambda_linter() + linter ) + lint_msg <- rex::rex("Compare to a constant after calling sapply() to get", anything, "sapply(x, foo)") expect_lint("sapply(x, \\(xi) foo(xi) == 2)", lint_msg, linter) expect_lint("sapply(x, \\(xi) foo(xi) == 'a')", lint_msg, linter) expect_lint("sapply(x, \\(xi) foo(xi) == 1 + 2i)", lint_msg, linter) From 1550eadca280f3c25241d73a7ee6accddb2a817f Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:36:51 +0000 Subject: [PATCH 26/57] need stop_on_failure for batch? --- .dev/ast_fuzz_test.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index e67dc0ecc..501a5b2cc 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -104,7 +104,7 @@ withr::defer(for (restoration in test_restorations) writeLines(restoration$lines # which tests failed (all reports are about successful or skipped tests). probably this is not # the best approach but documentation was not very helpful. reporter <- testthat::SummaryReporter$new() -testthat::test_local(reporter = reporter) +testthat::test_local(reporter = reporter, stop_on_failure = FALSE) failures <- reporter$failures$as_list() # ignore any test that failed for expected reasons, e.g. some known lint metadata changes From bbdac439e2818c5c32d151f27406f426de088abc Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:50:21 +0000 Subject: [PATCH 27/57] delint, fix last skip for R<4.1.0 --- tests/testthat/test-terminal_close_linter.R | 9 +++++---- tests/testthat/test-unnecessary_lambda_linter.R | 2 +- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/tests/testthat/test-terminal_close_linter.R b/tests/testthat/test-terminal_close_linter.R index 2a3d23d1c..2423745c5 100644 --- a/tests/testthat/test-terminal_close_linter.R +++ b/tests/testthat/test-terminal_close_linter.R @@ -20,17 +20,18 @@ test_that("terminal_close_linter skips allowed cases", { expect_no_lint(lines, linter) lines <- trim_some(" - foo <- \\(bar) { + foo <- function(bar) { close <- bar + 1 - return(close) + close } ") expect_no_lint(lines, linter) + skip_if_not_r_version("4.1.0") lines <- trim_some(" - foo <- function(bar) { + foo <- \\(bar) { close <- bar + 1 - close + return(close) } ") expect_no_lint(lines, linter) diff --git a/tests/testthat/test-unnecessary_lambda_linter.R b/tests/testthat/test-unnecessary_lambda_linter.R index 608421429..44655b44b 100644 --- a/tests/testthat/test-unnecessary_lambda_linter.R +++ b/tests/testthat/test-unnecessary_lambda_linter.R @@ -252,7 +252,7 @@ test_that("function shorthand is handled", { skip_if_not_r_version("4.1.0") linter <- unnecessary_lambda_linter() linter_allow <- unnecessary_lambda_linter(allow_comparison = TRUE) - + expect_lint( "lapply(DF, \\(x) sum(x))", rex::rex("Pass sum directly as a symbol to lapply()"), From 523c21867fdd8afb6706bb00938943bb41e840f3 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 00:14:49 +0000 Subject: [PATCH 28/57] more extensible structure --- .dev/maybe_fuzz_content.R | 42 +++++++++++++++++++++++++-------------- 1 file changed, 27 insertions(+), 15 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 6a7849c39..3db32d7c1 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -9,21 +9,12 @@ maybe_fuzz_content <- function(file, lines) { file.copy(file, new_file, copy.mode = FALSE) } - fuzz_contents(new_file) + apply_fuzzers(new_file) new_file } -# we could also consider just passing any test where no fuzzing takes place, -# i.e. letting the other GHA handle whether unfuzzed tests pass as expected. -fuzz_contents <- function(f) { - # skip errors for e.g. Rmd files, and ignore warnings. - # We could use get_source_expressions(), but with little benefit & much slower. - pd <- tryCatch(getParseData(suppressWarnings(parse(f, keep.source = TRUE))), error = identity) - if (inherits(pd, "error")) { - return(invisible()) - } - +function_lambda_fuzzer <- function(pd, lines) { fun_tokens <- c(`'\\\\'` = "\\", `FUNCTION` = "function") fun_idx <- which(pd$token %in% names(fun_tokens)) n_fun <- length(fun_idx) @@ -35,16 +26,37 @@ fuzz_contents <- function(f) { pd$new_text <- NA_character_ pd$new_text[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) - l <- readLines(f) - for (ii in rev(fun_idx)) { if (pd$text[ii] == pd$new_text[ii]) next # Tried, with all rex(), hit a bug: https://github.com/r-lib/rex/issues/96 ptn = paste0("^(.{", pd$col1[ii] - 1L, "})", rex::rex(pd$text[ii])) - l[pd$line1[ii]] <- rex::re_substitutes(l[pd$line1[ii]], ptn, paste0("\\1", rex::rex(pd$new_text[ii]))) + lines[pd$line1[ii]] <- rex::re_substitutes(lines[pd$line1[ii]], ptn, paste0("\\1", rex::rex(pd$new_text[ii]))) } + lines +} - writeLines(l, f) +# we could also consider just passing any test where no fuzzing takes place, +# i.e. letting the other GHA handle whether unfuzzed tests pass as expected. +apply_fuzzers <- function(f) { + # skip errors for e.g. Rmd files, and ignore warnings. + # We could use get_source_expressions(), but with little benefit & much slower. + pd <- tryCatch(getParseData(suppressWarnings(parse(f, keep.source = TRUE))), error = identity) + if (inherits(pd, "error")) { + return(invisible()) + } + + reparse <- FALSE + lines <- readLines(f) + for (fuzzer in list(function_lambda_fuzzer)) { + if (reparse) { + pd <- getParseData(parse(f, keep.source = TRUE)) + lines <- readLines(f) + } + updated_lines <- fuzzer(pd, lines) + reparse <- !is.null(updated_lines) + if (!reparse) next # skip some I/O if we can + writeLines(updated_lines, f) + } invisible() } From 852d0eafe2fdb9c1febb66dac52932467a457a9e Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 00:33:52 +0000 Subject: [PATCH 29/57] expect_no_lint --- tests/testthat/test-brace_linter.R | 97 +++++++++++++----------------- 1 file changed, 43 insertions(+), 54 deletions(-) diff --git a/tests/testthat/test-brace_linter.R b/tests/testthat/test-brace_linter.R index 5bc8eb3dd..ec10d6f32 100644 --- a/tests/testthat/test-brace_linter.R +++ b/tests/testthat/test-brace_linter.R @@ -8,13 +8,13 @@ test_that("brace_linter lints braces correctly", { ) linter <- brace_linter() - expect_lint("blah", NULL, linter) - expect_lint("a <- function() {\n}", NULL, linter) - expect_lint("a <- function() { \n}", NULL, linter) + expect_no_lint("blah", linter) + expect_no_lint("a <- function() {\n}", linter) + expect_no_lint("a <- function() { \n}", linter) expect_lint("a <- function() { 1 }", list(open_curly_msg, closed_curly_msg), linter) # allowed by allow_single_line - expect_lint("a <- function() { 1 }", NULL, brace_linter(allow_single_line = TRUE)) + expect_no_lint("a <- function() { 1 }", brace_linter(allow_single_line = TRUE)) expect_lint( trim_some(" @@ -51,30 +51,28 @@ test_that("brace_linter lints braces correctly", { ) # }) is allowed - expect_lint("eval(bquote({\n...\n}))", NULL, linter) + expect_no_lint("eval(bquote({\n...\n}))", linter) # }] is too - expect_lint("df[, {\n...\n}]", NULL, linter) + expect_no_lint("df[, {\n...\n}]", linter) # }, is allowed - expect_lint( + expect_no_lint( trim_some(" fun({ statements }, param)"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" fun(function(a) { statements }, param)"), - NULL, linter ) # ,<\n>{ is allowed - expect_lint( + expect_no_lint( trim_some(" switch( x, @@ -86,12 +84,11 @@ test_that("brace_linter lints braces correctly", { } ) "), - NULL, linter ) # a comment before ,<\n>{ is allowed - expect_lint( + expect_no_lint( trim_some(" switch( x, @@ -103,12 +100,11 @@ test_that("brace_linter lints braces correctly", { } ) "), - NULL, linter ) # a comment before <\n>{ is allowed - expect_lint( + expect_no_lint( trim_some(" switch(stat, o = { @@ -120,11 +116,10 @@ test_that("brace_linter lints braces correctly", { } ) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" fun( 'This is very very very long text.', @@ -134,12 +129,11 @@ test_that("brace_linter lints braces correctly", { } ) "), - NULL, linter ) # (\n{ is allowed optionally - expect_lint( + expect_no_lint( trim_some(" tryCatch( { @@ -149,14 +143,13 @@ test_that("brace_linter lints braces correctly", { } ) "), - NULL, linter ) # {{ }} is allowed - expect_lint("{{ x }}", NULL, linter) + expect_no_lint("{{ x }}", linter) - expect_lint( + expect_no_lint( trim_some(" pkg_name <- function(path = find_package()) { if (is.null(path)) { @@ -166,7 +159,6 @@ test_that("brace_linter lints braces correctly", { } } "), - NULL, linter ) @@ -185,13 +177,12 @@ test_that("brace_linter lints braces correctly", { expect_lint("a <- function()\n\t{\n 1 \n}", open_curly_msg, linter) # trailing comments are allowed - expect_lint( + expect_no_lint( trim_some(' if ("P" != "NP") { # what most people expect print("Cryptomania is possible") } '), - NULL, linter ) }) @@ -236,10 +227,9 @@ test_that("brace_linter lints spaces before open braces", { ) # should ignore strings and comments, as in regexes: - expect_lint("grepl('(iss){2}', 'Mississippi')", NULL, linter) - expect_lint( + expect_no_lint("grepl('(iss){2}', 'Mississippi')", linter) + expect_no_lint( "x <- 123 # don't flag (paren){brace} if inside a comment", - NULL, linter ) # should not be thrown when the brace lies on subsequent line @@ -258,8 +248,8 @@ test_that("brace_linter lints spaces before open braces", { test_that("brace_linter lints else correctly", { linter <- brace_linter() - expect_lint("if (TRUE) 1 else 2", NULL, linter) - expect_lint("if (TRUE) 1", NULL, linter) + expect_no_lint("if (TRUE) 1 else 2", linter) + expect_no_lint("if (TRUE) 1", linter) lines_brace <- trim_some(" if (TRUE) { @@ -268,7 +258,7 @@ test_that("brace_linter lints else correctly", { 2 } ") - expect_lint(lines_brace, NULL, linter) + expect_no_lint(lines_brace, linter) # such usage is also not allowed by the style guide, but test anyway lines_unbrace <- trim_some(" @@ -279,7 +269,7 @@ test_that("brace_linter lints else correctly", { 2 } ") - expect_lint(lines_unbrace, NULL, linter) + expect_no_lint(lines_unbrace, linter) lines <- trim_some(" foo <- function(x) { @@ -380,8 +370,8 @@ test_that("brace_linter lints function expressions correctly", { test_that("brace_linter lints if/else matching braces correctly", { linter <- brace_linter() - expect_lint("if (TRUE) 1 else 2", NULL, linter) - expect_lint("if (TRUE) 1", NULL, linter) + expect_no_lint("if (TRUE) 1 else 2", linter) + expect_no_lint("if (TRUE) 1", linter) lines_brace <- trim_some(" if (TRUE) { @@ -390,7 +380,7 @@ test_that("brace_linter lints if/else matching braces correctly", { 2 } ") - expect_lint(lines_brace, NULL, linter) + expect_no_lint(lines_brace, linter) # such usage is also not allowed by the style guide, but test anyway lines_unbrace <- trim_some(" @@ -401,7 +391,7 @@ test_that("brace_linter lints if/else matching braces correctly", { 2 } ") - expect_lint(lines_unbrace, NULL, linter) + expect_no_lint(lines_unbrace, linter) # else if is OK lines_else_if <- trim_some(" @@ -413,7 +403,7 @@ test_that("brace_linter lints if/else matching braces correctly", { 3 } ") - expect_lint(lines_else_if, NULL, linter) + expect_no_lint(lines_else_if, linter) lines_if <- trim_some(" foo <- function(x) { @@ -444,13 +434,17 @@ test_that("brace_linter lints if/else matching braces correctly", { # Keep up to date with https://github.com/tidyverse/style/issues/191 test_that("empty brace expressions are always allowed inline", { - expect_lint("while (FALSE) {}", NULL, brace_linter()) - expect_lint("while (FALSE) { }", NULL, brace_linter()) + linter <- brace_linter() + linter_allow <- brace_linter(allow_single_line = TRUE) + lint_msg <- rex::rex("Opening curly braces") + + expect_no_lint("while (FALSE) {}", linter) + expect_no_lint("while (FALSE) { }", linter) # only applies when `{` is "attached" to the preceding token on the same line - expect_lint("while (FALSE)\n{}", rex::rex("Opening curly braces"), brace_linter()) - expect_lint("while (FALSE)\n{ }", rex::rex("Opening curly braces"), brace_linter()) - expect_lint("while (FALSE) {}", NULL, brace_linter(allow_single_line = TRUE)) - expect_lint("while (FALSE) { }", NULL, brace_linter(allow_single_line = TRUE)) + expect_lint("while (FALSE)\n{}", lint_msg, linter) + expect_lint("while (FALSE)\n{ }", lint_msg, linter) + expect_no_lint("while (FALSE) {}", linter_allow) + expect_no_lint("while (FALSE) { }", linter_allow) }) test_that("formula syntax is linted properly", { @@ -458,7 +452,7 @@ test_that("formula syntax is linted properly", { lint_msg_open <- rex::rex("Opening curly braces should never go on their own line") lint_msg_closed <- rex::rex("Closing curly-braces should always be on their own line") - expect_lint( + expect_no_lint( trim_some(" map( .x = 1:4, @@ -466,7 +460,6 @@ test_that("formula syntax is linted properly", { .x + 1 } )"), - NULL, linter ) @@ -515,35 +508,32 @@ test_that("code with pipes is handled correctly", { lint_msg_open <- rex::rex("Opening curly braces should never go on their own line") lint_msg_closed <- rex::rex("Closing curly-braces should always be on their own line") - expect_lint( + expect_no_lint( trim_some(" out <- lapply(stuff, function(i) { do_something(i) }) %>% unlist "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" 1:4 %!>% { sum(.) } "), - NULL, linter ) # %>%\n{ is allowed - expect_lint( + expect_no_lint( trim_some(" 1:4 %T>% { sum(.) } "), - NULL, linter ) @@ -592,13 +582,12 @@ test_that("code with pipes is handled correctly", { skip_if_not_r_version("4.1.0") - expect_lint( + expect_no_lint( trim_some(" out <- lapply(stuff, function(i) { do_something(i) }) |> unlist() "), - NULL, linter ) @@ -615,7 +604,7 @@ test_that("function shorthand is treated like 'full' function", { skip_if_not_r_version("4.1.0") linter <- brace_linter() - expect_lint("a <- \\() { \n}", NULL, linter) + expect_no_lint("a <- \\() { \n}", linter) expect_lint( trim_some(" x <- \\() From 3eb21ca307d7e059073b823d57e8fb24b09590b7 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 01:07:17 +0000 Subject: [PATCH 30/57] progress, incl. many 'nofuzz' & 'no_lint' --- .dev/ast_fuzz_test.R | 4 +- .dev/maybe_fuzz_content.R | 43 ++++--- tests/testthat/test-brace_linter.R | 2 +- .../test-implicit_assignment_linter.R | 121 ++++++++---------- tests/testthat/test-infix_spaces_linter.R | 81 ++++++------ tests/testthat/test-one_call_pipe_linter.R | 32 ++--- tests/testthat/test-pipe_call_linter.R | 20 +-- tests/testthat/test-pipe_consistency_linter.R | 22 ++-- .../testthat/test-pipe_continuation_linter.R | 31 +++-- tests/testthat/test-pipe_return_linter.R | 8 +- tests/testthat/test-return_linter.R | 2 + .../test-unnecessary_placeholder_linter.R | 12 +- tests/testthat/test-unused_import_linter.R | 30 +++-- 13 files changed, 205 insertions(+), 203 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 501a5b2cc..d72b4279c 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -54,7 +54,9 @@ pkgload::load_all() # of getting top-level exclusions done for 'nofuzz start|end' ranges, except # maybe if it enabled us to reuse lintr's own exclude() system. # therefore we take this approach: pass over the test suite first and comment out -# any tests/units that have been marked 'nofuzz'. restore later. +# any tests/units that have been marked 'nofuzz'. restore later. one consequence +# is there's no support for fuzzer-specific exclusion, e.g. we fully disable +# the unnecessary_placeholder_linter() tests because |> and _ placeholders differ. test_restorations <- list() for (test_file in list.files("tests/testthat", pattern = "^test-", full.names = TRUE)) { xml <- read_xml(xmlparsedata::xml_parse_data(parse(test_file, keep.source = TRUE))) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 3db32d7c1..e60ab4655 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -14,27 +14,38 @@ maybe_fuzz_content <- function(file, lines) { new_file } -function_lambda_fuzzer <- function(pd, lines) { - fun_tokens <- c(`'\\\\'` = "\\", `FUNCTION` = "function") - fun_idx <- which(pd$token %in% names(fun_tokens)) - n_fun <- length(fun_idx) +simple_swap_fuzzer <- function(pd_filter, replacements) { + function(pd, lines) { + idx <- which(pd_filter(pd)) + n <- length(idx) - if (n_fun == 0L) { - return(invisible()) - } + if (n == 0L) { + return(invisible()) + } - pd$new_text <- NA_character_ - pd$new_text[fun_idx] <- sample(fun_tokens, n_fun, replace = TRUE) + pd$new_text <- NA_character_ + pd$new_text[idx] <- sample(replacements, n, replace = TRUE) - for (ii in rev(fun_idx)) { - if (pd$text[ii] == pd$new_text[ii]) next - # Tried, with all rex(), hit a bug: https://github.com/r-lib/rex/issues/96 - ptn = paste0("^(.{", pd$col1[ii] - 1L, "})", rex::rex(pd$text[ii])) - lines[pd$line1[ii]] <- rex::re_substitutes(lines[pd$line1[ii]], ptn, paste0("\\1", rex::rex(pd$new_text[ii]))) + for (ii in rev(idx)) { + if (pd$text[ii] == pd$new_text[ii]) next + # Tried, with all rex(), hit a bug: https://github.com/r-lib/rex/issues/96 + ptn = paste0("^(.{", pd$col1[ii] - 1L, "})", rex::rex(pd$text[ii])) + lines[pd$line1[ii]] <- rex::re_substitutes(lines[pd$line1[ii]], ptn, paste0("\\1", rex::rex(pd$new_text[ii]))) + } + lines } - lines } +function_lambda_fuzzer <- simple_swap_fuzzer( + \(pd) pd$token %in% c("'\\\\'", "FUNCTION"), + replacements = c("\\", "function") +) + +pipe_fuzzer <- simple_swap_fuzzer( + \(pd) (pd$token == "SPECIAL" & pd$text == "%>%") | pd$token == "PIPE", + replacements = c("%>%", "|>") +) + # we could also consider just passing any test where no fuzzing takes place, # i.e. letting the other GHA handle whether unfuzzed tests pass as expected. apply_fuzzers <- function(f) { @@ -47,7 +58,7 @@ apply_fuzzers <- function(f) { reparse <- FALSE lines <- readLines(f) - for (fuzzer in list(function_lambda_fuzzer)) { + for (fuzzer in list(function_lambda_fuzzer, pipe_fuzzer)) { if (reparse) { pd <- getParseData(parse(f, keep.source = TRUE)) lines <- readLines(f) diff --git a/tests/testthat/test-brace_linter.R b/tests/testthat/test-brace_linter.R index ec10d6f32..0d0532f8e 100644 --- a/tests/testthat/test-brace_linter.R +++ b/tests/testthat/test-brace_linter.R @@ -512,7 +512,7 @@ test_that("code with pipes is handled correctly", { trim_some(" out <- lapply(stuff, function(i) { do_something(i) - }) %>% unlist + }) %>% unlist() "), linter ) diff --git a/tests/testthat/test-implicit_assignment_linter.R b/tests/testthat/test-implicit_assignment_linter.R index 5457cb441..91ab4de64 100644 --- a/tests/testthat/test-implicit_assignment_linter.R +++ b/tests/testthat/test-implicit_assignment_linter.R @@ -1,83 +1,76 @@ test_that("implicit_assignment_linter skips allowed usages", { linter <- implicit_assignment_linter() - expect_lint("x <- 1L", NULL, linter) - expect_lint("1L -> x", NULL, linter) - expect_lint("x <<- 1L", NULL, linter) - expect_lint("1L ->> x", NULL, linter) - expect_lint("y <- if (is.null(x)) z else x", NULL, linter) - expect_lint("for (x in 1:10) x <- x + 1", NULL, linter) + expect_no_lint("x <- 1L", linter) + expect_no_lint("1L -> x", linter) + expect_no_lint("x <<- 1L", linter) + expect_no_lint("1L ->> x", linter) + expect_no_lint("y <- if (is.null(x)) z else x", linter) + expect_no_lint("for (x in 1:10) x <- x + 1", linter) - expect_lint("abc <- mean(1:4)", NULL, linter) - expect_lint("mean(1:4) -> abc", NULL, linter) + expect_no_lint("abc <- mean(1:4)", linter) + expect_no_lint("mean(1:4) -> abc", linter) - expect_lint( + expect_no_lint( trim_some(" x <- 1:4 mean(x)"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" x <- 1L if (x) TRUE"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" 0L -> abc while (abc) { FALSE }"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" if (x > 20L) { x <- x / 2.0 }"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" i <- 1 while (i < 6L) { print(i) i <- i + 1 }"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" foo <- function(x) { x <- x + 1 return(x) }"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" f <- function() { p <- g() p <- if (is.null(p)) x else p }"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" map( .x = 1:4, @@ -86,42 +79,37 @@ test_that("implicit_assignment_linter skips allowed usages", { x } )"), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" lapply(1:4, function(x) { x <- x + 1 x })"), - NULL, linter ) skip_if_not_r_version("4.1.0") - expect_lint( + expect_no_lint( trim_some(" map(1:4, \\(x) { x <- x + 1 x })"), - NULL, linter ) }) test_that("implicit_assignment_linter respects except argument", { - expect_lint( + expect_no_lint( "local({ a <- 1L })", - NULL, implicit_assignment_linter(except = NULL) ) - expect_lint( + expect_no_lint( "local({ a <- 1L })", - NULL, implicit_assignment_linter(except = character(0L)) ) @@ -137,9 +125,8 @@ test_that("implicit_assignment_linter respects except argument", { implicit_assignment_linter(except = NULL) ) - expect_lint( + expect_no_lint( "local(a <- 1L)", - NULL, implicit_assignment_linter(except = "local") ) }) @@ -147,58 +134,52 @@ test_that("implicit_assignment_linter respects except argument", { test_that("implicit_assignment_linter skips allowed usages with braces", { linter <- implicit_assignment_linter(except = character(0L)) - expect_lint( + expect_no_lint( trim_some(" foo({ a <- 1L }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" output <- capture.output({ x <- f() }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" quote({ a <- 1L }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" bquote({ a <- 1L }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" expression({ a <- 1L }) "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" local({ a <- 1L }) "), - NULL, linter ) }) @@ -206,20 +187,19 @@ test_that("implicit_assignment_linter skips allowed usages with braces", { test_that("implicit_assignment_linter makes exceptions for functions that capture side-effects", { linter <- implicit_assignment_linter() - expect_lint( + expect_no_lint( trim_some(" test_that('my test', { a <- 1L expect_equal(a, 1L) })"), - NULL, linter ) # rlang - expect_lint("expr(a <- 1L)", NULL, linter) - expect_lint("quo(a <- 1L)", NULL, linter) - expect_lint("quos(a <- 1L)", NULL, linter) + expect_no_lint("expr(a <- 1L)", linter) + expect_no_lint("quo(a <- 1L)", linter) + expect_no_lint("quos(a <- 1L)", linter) }) test_that("implicit_assignment_linter blocks disallowed usages in simple conditional statements", { @@ -335,15 +315,18 @@ test_that("implicit_assignment_linter blocks disallowed usages in function calls test_that("implicit_assignment_linter works as expected with pipes and walrus operator", { linter <- implicit_assignment_linter() - expect_lint("data %>% mutate(a := b)", NULL, linter) - expect_lint("dt %>% .[, z := x + y]", NULL, linter) - expect_lint("data %<>% mutate(a := b)", NULL, linter) + expect_no_lint("data %>% mutate(a := b)", linter) + expect_no_lint( # nofuzz + "dt %>% .[, z := x + y]", + linter + ) + expect_no_lint("data %<>% mutate(a := b)", linter) - expect_lint("DT[i, x := i]", NULL, linter) + expect_no_lint("DT[i, x := i]", linter) skip_if_not_r_version("4.1.0") - expect_lint("data |> mutate(a := b)", NULL, linter) + expect_no_lint("data |> mutate(a := b)", linter) }) test_that("parenthetical assignments are caught", { @@ -358,21 +341,21 @@ test_that("allow_lazy lets lazy assignments through", { linter <- implicit_assignment_linter(allow_lazy = TRUE) lint_message <- rex::rex("Avoid implicit assignments in function calls.") - expect_lint("A && (B <- foo(A))", NULL, linter) + expect_no_lint("A && (B <- foo(A))", linter) # || also admits laziness - expect_lint("A || (B <- foo(A))", NULL, linter) + expect_no_lint("A || (B <- foo(A))", linter) # & and |, however, do not expect_lint("A & (B <- foo(A))", lint_message, linter) expect_lint("A | (B <- foo(A))", lint_message, linter) - expect_lint("A && foo(bar(idx <- baz()))", NULL, linter) + expect_no_lint("A && foo(bar(idx <- baz()))", linter) # LHS _is_ linted expect_lint("(A <- foo()) && B", lint_message, linter) # however we skip on _any_ RHS (even if it's later an LHS) # test on all &&/|| combinations to stress test operator precedence - expect_lint("A && (B <- foo(A)) && C", NULL, linter) - expect_lint("A && (B <- foo(A)) || C", NULL, linter) - expect_lint("A || (B <- foo(A)) && C", NULL, linter) - expect_lint("A || (B <- foo(A)) || C", NULL, linter) + expect_no_lint("A && (B <- foo(A)) && C", linter) + expect_no_lint("A && (B <- foo(A)) || C", linter) + expect_no_lint("A || (B <- foo(A)) && C", linter) + expect_no_lint("A || (B <- foo(A)) || C", linter) # &&/|| elsewhere in the tree don't matter expect_lint( trim_some(" @@ -388,13 +371,12 @@ test_that("allow_scoped skips scoped assignments", { linter <- implicit_assignment_linter(allow_scoped = TRUE) lint_message <- rex::rex("Avoid implicit assignments in function calls.") - expect_lint( + expect_no_lint( trim_some(" if (any(idx <- x < 0)) { stop('negative elements: ', toString(which(idx))) } "), - NULL, linter ) expect_lint( @@ -418,12 +400,11 @@ test_that("allow_scoped skips scoped assignments", { linter ) - expect_lint( + expect_no_lint( trim_some(" obj <- letters while ((n <- length(obj)) > 0) obj <- obj[-n] "), - NULL, linter ) expect_lint( @@ -446,13 +427,12 @@ test_that("allow_scoped skips scoped assignments", { test_that("interaction of allow_lazy and allow_scoped", { linter <- implicit_assignment_linter(allow_scoped = TRUE, allow_lazy = TRUE) - expect_lint( + expect_nl_lint( trim_some(" if (any(idx <- foo()) && BB) { stop('Invalid foo() output: ', toString(idx)) } "), - NULL, linter ) expect_lint( @@ -465,14 +445,13 @@ test_that("interaction of allow_lazy and allow_scoped", { rex::rex("Avoid implicit assignments in function calls."), linter ) - expect_lint( + expect_no_lint( trim_some(" if (AA && any(idx <- foo())) { stop('Invalid foo() output: ', toString(idx)) } print(format(idx)) # NB: bad code! idx may not exist. "), - NULL, linter ) }) diff --git a/tests/testthat/test-infix_spaces_linter.R b/tests/testthat/test-infix_spaces_linter.R index ade7969c0..7b73411e7 100644 --- a/tests/testthat/test-infix_spaces_linter.R +++ b/tests/testthat/test-infix_spaces_linter.R @@ -31,28 +31,32 @@ test_that("returns the correct linting", { linter <- infix_spaces_linter() lint_msg <- rex::rex("Put spaces around all infix operators.") - expect_lint("blah", NULL, linter) + expect_no_lint("blah", linter) for (op in ops) { - expect_lint(paste0("1 ", op, " 2"), NULL, linter) - expect_lint(paste0("1 ", op, "\n2"), NULL, linter) - expect_lint(paste0("1 ", op, "\n 2"), NULL, linter) + expect_no_lint(paste0("1 ", op, " 2"), linter) + expect_no_lint(paste0("1 ", op, "\n2"), linter) + expect_no_lint(paste0("1 ", op, "\n 2"), linter) - expect_lint(paste0("1", op, "2"), lint_msg, linter) + expect_lint( # nofuzz + paste0("1", op, "2"), + lint_msg, + linter + ) # unary plus and minus can have no space before them if (!op %in% ops[1L:2L]) { - expect_lint(paste0("1 ", op, "2"), lint_msg, linter) + expect_lint(paste0("1 ", op, "2"), lint_msg, linter) # nofuzz } expect_lint(paste0("1", op, " 2"), lint_msg, linter) } - expect_lint("b <- 2E+4", NULL, linter) - expect_lint("a <- 1e-3", NULL, linter) - expect_lint("a[-1]", NULL, linter) - expect_lint("a[-1 + 1]", NULL, linter) - expect_lint("a[1 + -1]", NULL, linter) + expect_no_lint("b <- 2E+4", linter) + expect_no_lint("a <- 1e-3", linter) + expect_no_lint("a[-1]", linter) + expect_no_lint("a[-1 + 1]", linter) + expect_no_lint("a[1 + -1]", linter) expect_lint("fun(a=1)", lint_msg, linter) }) @@ -72,26 +76,25 @@ test_that("The three `=` are all linted", { test_that("exclude_operators works", { lint_msg <- rex::rex("Put spaces around all infix operators.") - expect_lint("a+b", NULL, infix_spaces_linter(exclude_operators = "+")) - expect_lint( + expect_no_lint("a+b", infix_spaces_linter(exclude_operators = "+")) + expect_no_lint( trim_some(" a+b a-b "), - NULL, infix_spaces_linter(exclude_operators = c("+", "-")) ) # operators match on text, not hidden node expect_lint("a<<-1", lint_msg, infix_spaces_linter(exclude_operators = "<-")) - expect_lint("a<<-1", NULL, infix_spaces_linter(exclude_operators = "<<-")) + expect_no_lint("a<<-1", infix_spaces_linter(exclude_operators = "<<-")) expect_lint("a:=1", lint_msg, infix_spaces_linter(exclude_operators = "<-")) - expect_lint("a:=1", NULL, infix_spaces_linter(exclude_operators = ":=")) + expect_no_lint("a:=1", infix_spaces_linter(exclude_operators = ":=")) expect_lint("a->>1", lint_msg, infix_spaces_linter(exclude_operators = "->")) - expect_lint("a->>1", NULL, infix_spaces_linter(exclude_operators = "->>")) - expect_lint("a%any%1", NULL, infix_spaces_linter(exclude_operators = "%%")) - expect_lint("function(a=1) { }", NULL, infix_spaces_linter(exclude_operators = "=")) - expect_lint("foo(a=1)", NULL, infix_spaces_linter(exclude_operators = "=")) + expect_no_lint("a->>1", infix_spaces_linter(exclude_operators = "->>")) + expect_no_lint("a%any%1", infix_spaces_linter(exclude_operators = "%%")) + expect_no_lint("function(a=1) { }", infix_spaces_linter(exclude_operators = "=")) + expect_no_lint("foo(a=1)", infix_spaces_linter(exclude_operators = "=")) }) # more tests specifically for assignment @@ -99,23 +102,22 @@ test_that("assignment cases return the correct linting", { linter <- infix_spaces_linter() lint_msg <- rex::rex("Put spaces around all infix operators.") - expect_lint("fun(blah = 1)", NULL, linter) + expect_no_lint("fun(blah = 1)", linter) - expect_lint("blah <- 1", NULL, linter) - expect_lint("blah = 1", NULL, linter) + expect_no_lint("blah <- 1", linter) + expect_no_lint("blah = 1", linter) - expect_lint("\"my = variable\" <- 42.0", NULL, linter) + expect_no_lint("\"my = variable\" <- 42.0", linter) - expect_lint("if (0 < 1) x <- 42L", NULL, linter) - expect_lint( + expect_no_lint("if (0 < 1) x <- 42L", linter) + expect_no_lint( trim_some(" if (0 < 1) { x <- 42L }"), - NULL, linter ) - expect_lint("my = bad = variable = name <- 2.0", NULL, linter) + expect_no_lint("my = bad = variable = name <- 2.0", linter) expect_lint("blah<- 1", lint_msg, linter) expect_lint("blah <-1", lint_msg, linter) @@ -135,9 +137,9 @@ test_that("infix_spaces_linter can allow >1 spaces optionally", { test_that("exception for box::use()", { linter <- infix_spaces_linter() - expect_lint("box::use(a/b)", NULL, linter) - expect_lint("box::use(./a/b)", NULL, linter) - expect_lint( + expect_no_lint("box::use(a/b)", linter) + expect_no_lint("box::use(./a/b)", linter) + expect_no_lint( trim_some(" box::use( a, @@ -146,7 +148,6 @@ test_that("exception for box::use()", { alias = a/b/c[xyz = abc, ...], ) "), - NULL, linter ) }) @@ -167,8 +168,8 @@ test_that("Rules around missing arguments are respected", { linter <- infix_spaces_linter() lint_msg <- rex::rex("Put spaces around all infix operators.") - expect_lint("switch(a = , b = 2)", NULL, linter) - expect_lint("alist(missing_arg = )", NULL, linter) + expect_no_lint("switch(a = , b = 2)", linter) + expect_no_lint("alist(missing_arg = )", linter) expect_lint("switch(a =, b = 2)", lint_msg, linter) expect_lint("alist(missing_arg =)", lint_msg, linter) @@ -178,7 +179,7 @@ test_that("native pipe is supported", { skip_if_not_r_version("4.1.0") linter <- infix_spaces_linter() - expect_lint("a |> foo()", NULL, linter) + expect_no_lint("a |> foo()", linter) expect_lint("a|>foo()", rex::rex("Put spaces around all infix operators."), linter) }) @@ -194,19 +195,19 @@ test_that("mixed unary & binary operators aren't mis-lint", { }) test_that("parse tags are accepted by exclude_operators", { - expect_lint("sum(x, na.rm=TRUE)", NULL, infix_spaces_linter(exclude_operators = "EQ_SUB")) - expect_lint("function(x, na.rm=TRUE) { }", NULL, infix_spaces_linter(exclude_operators = "EQ_FORMALS")) - expect_lint("x=1", NULL, infix_spaces_linter(exclude_operators = "EQ_ASSIGN")) + expect_no_lint("sum(x, na.rm=TRUE)", infix_spaces_linter(exclude_operators = "EQ_SUB")) + expect_no_lint("function(x, na.rm=TRUE) { }", infix_spaces_linter(exclude_operators = "EQ_FORMALS")) + expect_no_lint("x=1", infix_spaces_linter(exclude_operators = "EQ_ASSIGN")) # uses parse_tag - expect_lint("1+1", NULL, infix_spaces_linter(exclude_operators = "'+'")) + expect_no_lint("1+1", infix_spaces_linter(exclude_operators = "'+'")) # mixing text <- "x=function(a=foo(bar=1)) { }" col_assign <- list(column_number = 2L) col_formals <- list(column_number = 13L) col_sub <- list(column_number = 21L) - expect_lint(text, NULL, infix_spaces_linter(exclude_operators = c("EQ_SUB", "EQ_FORMALS", "EQ_ASSIGN"))) + expect_no_lint(text, infix_spaces_linter(exclude_operators = c("EQ_SUB", "EQ_FORMALS", "EQ_ASSIGN"))) expect_lint(text, col_assign, infix_spaces_linter(exclude_operators = c("EQ_SUB", "EQ_FORMALS"))) expect_lint(text, col_formals, infix_spaces_linter(exclude_operators = c("EQ_SUB", "EQ_ASSIGN"))) expect_lint(text, col_sub, infix_spaces_linter(exclude_operators = c("EQ_FORMALS", "EQ_ASSIGN"))) diff --git a/tests/testthat/test-one_call_pipe_linter.R b/tests/testthat/test-one_call_pipe_linter.R index 9a1a84975..654202237 100644 --- a/tests/testthat/test-one_call_pipe_linter.R +++ b/tests/testthat/test-one_call_pipe_linter.R @@ -2,14 +2,14 @@ test_that("one_call_pipe_linter skips allowed usages", { linter <- one_call_pipe_linter() # two pipe steps is OK - expect_lint("x %>% foo() %>% bar()", NULL, linter) + expect_no_lint("x %>% foo() %>% bar()", linter) # call in first step --> OK - expect_lint("foo(x) %>% bar()", NULL, linter) + expect_no_lint("foo(x) %>% bar()", linter) # both calls in second step --> OK - expect_lint("x %>% foo(bar(.))", NULL, linter) + expect_no_lint("x %>% foo(bar(.))", linter) # assignment pipe is exempted - expect_lint("x %<>% as.character()", NULL, linter) + expect_no_lint("x %<>% as.character()", linter) }) test_that("one_call_pipe_linter blocks simple disallowed usages", { @@ -25,33 +25,31 @@ test_that("one_call_pipe_linter blocks simple disallowed usages", { expect_lint("x %>% inner_join(y %>% filter(is_treatment))", lint_msg, linter) }) +# nofuzz start test_that("one_call_pipe_linter skips data.table chains", { linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe %>% for expressions with only a single call.") - expect_lint("DT[x > 5, sum(y), by = keys] %>% .[, .SD[1], by = key1]", NULL, linter) + expect_no_lint("DT[x > 5, sum(y), by = keys] %>% .[, .SD[1], by = key1]", linter) # lint here: instead of a pipe, use DT[x > 5, sum(y), by = keys] expect_lint("DT %>% .[x > 5, sum(y), by = keys]", lint_msg, linter) # ditto for [[ - expect_lint("DT %>% rowSums() %>% .[[idx]]", NULL, linter) + expect_no_lint("DT %>% rowSums() %>% .[[idx]]", linter) expect_lint("DT %>% .[[idx]]", lint_msg, linter) }) +# nofuzz end test_that("one_call_pipe_linter treats all pipes equally", { linter <- one_call_pipe_linter() lint_msg_part <- " for expressions with only a single call." - expect_lint("foo %>% bar() %$% col", NULL, linter) + expect_no_lint("foo %>% bar() %$% col", linter) expect_lint("x %T>% foo()", rex::rex("%T>%", lint_msg_part), linter) expect_lint("x %$%\n foo", rex::rex("%$%", lint_msg_part), linter) - expect_lint( - 'data %>% filter(type == "console") %$% obscured_id %>% unique()', - NULL, - linter - ) + expect_no_lint('data %>% filter(type == "console") %$% obscured_id %>% unique()', linter) }) test_that("multiple lints are generated correctly", { @@ -83,8 +81,8 @@ test_that("Native pipes are handled as well", { ) # mixed pipes - expect_lint("x |> foo() %>% bar()", NULL, linter) - expect_lint("x %>% foo() |> bar()", NULL, linter) + expect_no_lint("x |> foo() %>% bar()", linter) + expect_no_lint("x %>% foo() |> bar()", linter) expect_lint( trim_some("{ @@ -99,19 +97,21 @@ test_that("Native pipes are handled as well", { ) }) +# nofuzz start test_that("one_call_pipe_linter skips data.table chains with native pipe", { skip_if_not_r_version("4.3.0") linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe |> for expressions with only a single call.") - expect_lint("DT[x > 5, sum(y), by = keys] |> _[, .SD[1], by = key1]", NULL, linter) + expect_no_lint("DT[x > 5, sum(y), by = keys] |> _[, .SD[1], by = key1]", linter) # lint here: instead of a pipe, use DT[x > 5, sum(y), by = keys] expect_lint("DT |> _[x > 5, sum(y), by = keys]", lint_msg, linter) # ditto for [[ - expect_lint("DT |> rowSums() |> _[[idx]]", NULL, linter) + expect_no_lint("DT |> rowSums() |> _[[idx]]", linter) expect_lint("DT |> _[[idx]]", lint_msg, linter) }) +# nofuzz end diff --git a/tests/testthat/test-pipe_call_linter.R b/tests/testthat/test-pipe_call_linter.R index 96cf2036e..7e389878e 100644 --- a/tests/testthat/test-pipe_call_linter.R +++ b/tests/testthat/test-pipe_call_linter.R @@ -1,10 +1,11 @@ +# nofuzz start test_that("pipe_call_linter skips allowed usages", { linter <- pipe_call_linter() - expect_lint("a %>% foo()", NULL, linter) - expect_lint("a %>% foo(x)", NULL, linter) - expect_lint("b %>% { foo(., ., .) }", NULL, linter) - expect_lint("a %>% foo() %>% bar()", NULL, linter) + expect_no_lint("a %>% foo()", linter) + expect_no_lint("a %>% foo(x)", linter) + expect_no_lint("b %>% { foo(., ., .) }", linter) + expect_no_lint("a %>% foo() %>% bar()", linter) # ensure it works across lines too lines <- trim_some(" @@ -12,10 +13,10 @@ test_that("pipe_call_linter skips allowed usages", { foo() %>% bar() ") - expect_lint(lines, NULL, linter) + expect_no_lint(lines, linter) # symbol extraction is OK (don't force extract2(), e.g.) - expect_lint("a %>% .$y %>% mean()", NULL, linter) + expect_no_lint("a %>% .$y %>% mean()", linter) # more complicated expressions don't pick up on nested symbols lines <- trim_some(" @@ -25,10 +26,10 @@ test_that("pipe_call_linter skips allowed usages", { my_combination_fun(tmp, bla) } ") - expect_lint(lines, NULL, linter) + expect_no_lint(lines, linter) # extraction pipe uses RHS symbols - expect_lint("a %$% b", NULL, linter) + expect_no_lint("a %$% b", linter) }) test_that("pipe_call_linter blocks simple disallowed usages", { @@ -68,7 +69,7 @@ local({ patrick::with_parameters_test_that( "All pipe operators are caught", { - expect_lint(sprintf("a %s foo()", pipe), NULL, linter) + expect_no_lint(sprintf("a %s foo()", pipe), linter) expect_lint(sprintf("a %s foo", pipe), sprintf("`a %s foo`", pipe), linter) }, pipe = pipes, @@ -89,3 +90,4 @@ test_that("Multiple lints give custom messages", { pipe_call_linter() ) }) +# nofuzz end diff --git a/tests/testthat/test-pipe_consistency_linter.R b/tests/testthat/test-pipe_consistency_linter.R index 4a236b156..57c6df83b 100644 --- a/tests/testthat/test-pipe_consistency_linter.R +++ b/tests/testthat/test-pipe_consistency_linter.R @@ -1,19 +1,19 @@ +# nofuzz start test_that("pipe_consistency skips allowed usage", { skip_if_not_r_version("4.1.0") linter <- pipe_consistency_linter() - expect_lint("1:3 %>% mean() %>% as.character()", NULL, linter) - expect_lint("1:3 |> mean() |> as.character()", NULL, linter) + expect_no_lint("1:3 %>% mean() %>% as.character()", linter) + expect_no_lint("1:3 |> mean() |> as.character()", linter) # With no pipes - expect_lint("x <- 1:5", NULL, linter) + expect_no_lint("x <- 1:5", linter) # Across multiple lines - expect_lint( + expect_no_lint( trim_some(" 1:3 %>% mean() %>% as.character() "), - NULL, linter ) }) @@ -96,9 +96,8 @@ test_that("pipe_consistency_linter works with |> argument", { linter ) - expect_lint( + expect_no_lint( "1:3 |> mean() |> as.character()", - NULL, linter ) @@ -134,11 +133,7 @@ test_that("pipe_consistency_linter works with %>% argument", { linter ) - expect_lint( - "1:3 %>% mean() %>% as.character()", - NULL, - linter - ) + expect_no_lint("1:3 %>% mean() %>% as.character()", linter) expect_lint( trim_some(" @@ -156,7 +151,7 @@ test_that("pipe_consistency_linter works with other magrittr pipes", { linter <- pipe_consistency_linter() expected_message <- rex::rex("Stick to one pipe operator; found 1 instances of %>% and 1 instances of |>.") - expect_lint("1:3 %>% mean() %T% print()", NULL, linter) + expect_no_lint("1:3 %>% mean() %T% print()", linter) expect_lint( "1:3 |> mean() %T>% print()", list( @@ -166,3 +161,4 @@ test_that("pipe_consistency_linter works with other magrittr pipes", { linter ) }) +# nofuzz end diff --git a/tests/testthat/test-pipe_continuation_linter.R b/tests/testthat/test-pipe_continuation_linter.R index 0d3350bca..7775007d1 100644 --- a/tests/testthat/test-pipe_continuation_linter.R +++ b/tests/testthat/test-pipe_continuation_linter.R @@ -3,19 +3,18 @@ test_that("pipe-continuation correctly handles stand-alone expressions", { lint_msg <- rex::rex("Put a space before `%>%` and a new line after it,") # Expressions without pipes are ignored - expect_lint("blah", NULL, linter) + expect_no_lint("blah", linter) # Pipe expressions on a single line are ignored - expect_lint("foo %>% bar() %>% baz()", NULL, linter) + expect_no_lint("foo %>% bar() %>% baz()", linter) # Pipe expressions spanning multiple lines with each expression on a line are ignored - expect_lint( + expect_no_lint( trim_some(" foo %>% bar() %>% baz() "), - NULL, linter ) @@ -66,13 +65,12 @@ test_that("pipe-continuation linter correctly handles nesting", { ) # but no lints here - expect_lint( + expect_no_lint( # nofuzz. Not valid with '|>' trim_some(" 1:4 %>% { (.) %>% sum() } "), - NULL, linter ) }) @@ -84,14 +82,13 @@ test_that("pipe-continuation linter handles native pipe", { lint_msg_native <- rex::rex("Put a space before `|>` and a new line after it,") lint_msg_magrittr <- rex::rex("Put a space before `%>%` and a new line after it,") - expect_lint("foo |> bar() |> baz()", NULL, linter) - expect_lint( + expect_no_lint("foo |> bar() |> baz()", linter) + expect_no_lint( trim_some(" foo |> bar() |> baz() "), - NULL, linter ) expect_lint( @@ -161,12 +158,14 @@ local({ test_data <- diamonds %>% head(10) %>% tail(5) }) "), "three inside test_that()", - trim_some(" - { - x <- a %>% b %>% c - y <- c %>% b %>% a - } - "), "two different single-line pipelines", + trim_some( # nofuzz. Native pipe requires calls, not symbols. + " + { + x <- a %>% b %>% c + y <- c %>% b %>% a + } + " + ), "two different single-line pipelines", trim_some(" my_fun <- function() { a %>% @@ -179,7 +178,7 @@ local({ "valid nesting is handled", # nolint next: unnecessary_nesting_linter. TODO(#2334): Remove this nolint. { - expect_lint(code_string, NULL, linter) + expect_no_lint(code_string, linter) }, .cases = .cases ) diff --git a/tests/testthat/test-pipe_return_linter.R b/tests/testthat/test-pipe_return_linter.R index 1d7af5f6c..22ea6a9a2 100644 --- a/tests/testthat/test-pipe_return_linter.R +++ b/tests/testthat/test-pipe_return_linter.R @@ -6,7 +6,7 @@ test_that("pipe_return_linter skips allowed usages", { filter(str > 5) %>% summarize(str = sum(str)) ") - expect_lint(normal_pipe_lines, NULL, linter) + expect_no_lint(normal_pipe_lines, linter) normal_function_lines <- trim_some(" pipeline <- function(x) { @@ -16,7 +16,7 @@ test_that("pipe_return_linter skips allowed usages", { return(out) } ") - expect_lint(normal_function_lines, NULL, linter) + expect_no_lint(normal_function_lines, linter) nested_return_lines <- trim_some(" pipeline <- function(x) { @@ -27,9 +27,10 @@ test_that("pipe_return_linter skips allowed usages", { return(x_squared) } ") - expect_lint(nested_return_lines, NULL, linter) + expect_no_lint(nested_return_lines, linter) }) +# nofuzz start test_that("pipe_return_linter blocks simple disallowed usages", { lines <- trim_some(" pipeline <- function(x) { @@ -65,3 +66,4 @@ test_that("lints vectorize", { pipe_return_linter() ) }) +# nofuzz end diff --git a/tests/testthat/test-return_linter.R b/tests/testthat/test-return_linter.R index 1a228e912..e4ad3caaa 100644 --- a/tests/testthat/test-return_linter.R +++ b/tests/testthat/test-return_linter.R @@ -495,6 +495,7 @@ test_that("return_linter allows return()-less namespace hook calls", { ) }) +# nofuzz start test_that("return_linter correctly handles pipes", { linter <- return_linter(return_style = "explicit") @@ -532,6 +533,7 @@ test_that("return_linter correctly handles pipes", { linter ) }) +# nofuzz end test_that("return_linter handles pipes in control flow", { linter <- return_linter(return_style = "explicit") diff --git a/tests/testthat/test-unnecessary_placeholder_linter.R b/tests/testthat/test-unnecessary_placeholder_linter.R index d8a1e677a..ba89c8237 100644 --- a/tests/testthat/test-unnecessary_placeholder_linter.R +++ b/tests/testthat/test-unnecessary_placeholder_linter.R @@ -1,3 +1,4 @@ +# nofuzz start linter <- unnecessary_placeholder_linter() pipes <- pipes(exclude = "|>") @@ -5,15 +6,15 @@ patrick::with_parameters_test_that( "unnecessary_placeholder_linter skips allowed usages", { # . used in position other than first --> ok - expect_lint(sprintf("x %s foo(y, .)", pipe), NULL, linter) + expect_no_lint(sprintf("x %s foo(y, .)", pipe), linter) # ditto for nested usage - expect_lint(sprintf("x %s foo(y, bar(.))", pipe), NULL, linter) + expect_no_lint(sprintf("x %s foo(y, bar(.))", pipe), linter) # . used twice --> ok - expect_lint(sprintf("x %s foo(., .)", pipe), NULL, linter) + expect_no_lint(sprintf("x %s foo(., .)", pipe), linter) # . used as a keyword argument --> ok - expect_lint(sprintf("x %s foo(arg = .)", pipe), NULL, linter) + expect_no_lint(sprintf("x %s foo(arg = .)", pipe), linter) # . used inside a scope --> ok - expect_lint(sprintf("x %s { foo(arg = .) }", pipe), NULL, linter) + expect_no_lint(sprintf("x %s { foo(arg = .) }", pipe), linter) }, .test_name = names(pipes), pipe = pipes @@ -53,3 +54,4 @@ test_that("lints vectorize", { unnecessary_placeholder_linter() ) }) +# nofuzz end diff --git a/tests/testthat/test-unused_import_linter.R b/tests/testthat/test-unused_import_linter.R index cb6f89872..4c2bac2ff 100644 --- a/tests/testthat/test-unused_import_linter.R +++ b/tests/testthat/test-unused_import_linter.R @@ -1,21 +1,27 @@ test_that("unused_import_linter lints as expected", { linter <- unused_import_linter() - expect_lint("library(dplyr)\ntibble(a = 1)", NULL, linter) + expect_no_lint("library(dplyr)\ntibble(a = 1)", linter) # SYMBOL_FUNCTION_CALL usage is detected - expect_lint("library(tidyverse)\ntibble(a = 1)", NULL, linter) + expect_no_lint("library(tidyverse)\ntibble(a = 1)", linter) # SYMBOL usage is detected - expect_lint("library(dplyr)\ndo.call(tibble, args = list(a = 1))", NULL, linter) + expect_no_lint("library(dplyr)\ndo.call(tibble, args = list(a = 1))", linter) # SPECIAL usage is detected - expect_lint("library(magrittr)\n1:3 %>% mean()", NULL, linter) + expect_no_lint( # nofuzz + trim_some(" + library(magrittr) + 1:3 %>% mean() + "), + linter + ) # dataset is detected - expect_lint("library(dplyr)\nstarwars", NULL, linter) - expect_lint("library(datasets)\nstate.center", NULL, linter) + expect_no_lint("library(dplyr)\nstarwars", linter) + expect_no_lint("library(datasets)\nstate.center", linter) # Missing packages are ignored - expect_lint("library(not.a.package)\ntibble(a = 1)", NULL, linter) + expect_no_lint("library(not.a.package)\ntibble(a = 1)", linter) # SYMBOL calls with character.only = TRUE are ignored, even if the argument is a package name - expect_lint("library(dplyr, character.only = TRUE)\n1 + 1", NULL, linter) + expect_no_lint("library(dplyr, character.only = TRUE)\n1 + 1", linter) lint_msg <- rex::rex("Package 'dplyr' is attached but never used") msg_ns <- rex::rex("Don't attach package 'dplyr', which is only used by namespace.") @@ -26,11 +32,11 @@ test_that("unused_import_linter lints as expected", { expect_lint("library('dplyr', character.only = TRUE)\n1 + 1", lint_msg, linter) # ignore namespaced usages by default, but provide custom lint message expect_lint("library(dplyr)\ndplyr::tibble(a = 1)", msg_ns, linter) - expect_lint("library(dplyr)\ndplyr::tibble(a = 1)", NULL, unused_import_linter(allow_ns_usage = TRUE)) + expect_no_lint("library(dplyr)\ndplyr::tibble(a = 1)", unused_import_linter(allow_ns_usage = TRUE)) # ignore packages in except_packages - expect_lint("library(data.table)\n1 + 1", NULL, linter) - expect_lint("library(dplyr)\n1 + 1", NULL, unused_import_linter(except_packages = "dplyr")) + expect_no_lint("library(data.table)\n1 + 1", linter) + expect_no_lint("library(dplyr)\n1 + 1", unused_import_linter(except_packages = "dplyr")) }) test_that("unused_import_linter handles message vectorization", { @@ -70,6 +76,6 @@ test_that("glue usages are seen", { glue('{ xml_parse_data() }') ") - expect_lint(lines, NULL, unused_import_linter()) + expect_no_lint(lines, unused_import_linter()) expect_lint(lines, lint_msg, unused_import_linter(interpret_glue = FALSE)) }) From 8059091e7a5942ba51002e6761a6c7c3d42efc2c Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:00:26 -0800 Subject: [PATCH 31/57] another round of nofuzz --- tests/testthat/test-brace_linter.R | 2 ++ tests/testthat/test-implicit_assignment_linter.R | 2 +- tests/testthat/test-infix_spaces_linter.R | 10 ++++------ tests/testthat/test-one_call_pipe_linter.R | 2 +- tests/testthat/test-return_linter.R | 2 +- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/tests/testthat/test-brace_linter.R b/tests/testthat/test-brace_linter.R index 0d0532f8e..76c475e0c 100644 --- a/tests/testthat/test-brace_linter.R +++ b/tests/testthat/test-brace_linter.R @@ -548,6 +548,7 @@ test_that("code with pipes is handled correctly", { linter ) + # nofuzz start expect_lint( trim_some(" x %>% @@ -579,6 +580,7 @@ test_that("code with pipes is handled correctly", { ), linter ) + # nofuzz end skip_if_not_r_version("4.1.0") diff --git a/tests/testthat/test-implicit_assignment_linter.R b/tests/testthat/test-implicit_assignment_linter.R index 91ab4de64..da0d9c6f7 100644 --- a/tests/testthat/test-implicit_assignment_linter.R +++ b/tests/testthat/test-implicit_assignment_linter.R @@ -427,7 +427,7 @@ test_that("allow_scoped skips scoped assignments", { test_that("interaction of allow_lazy and allow_scoped", { linter <- implicit_assignment_linter(allow_scoped = TRUE, allow_lazy = TRUE) - expect_nl_lint( + expect_no_lint( trim_some(" if (any(idx <- foo()) && BB) { stop('Invalid foo() output: ', toString(idx)) diff --git a/tests/testthat/test-infix_spaces_linter.R b/tests/testthat/test-infix_spaces_linter.R index 7b73411e7..9180f912b 100644 --- a/tests/testthat/test-infix_spaces_linter.R +++ b/tests/testthat/test-infix_spaces_linter.R @@ -33,24 +33,22 @@ test_that("returns the correct linting", { expect_no_lint("blah", linter) + # nofuzz start for (op in ops) { expect_no_lint(paste0("1 ", op, " 2"), linter) expect_no_lint(paste0("1 ", op, "\n2"), linter) expect_no_lint(paste0("1 ", op, "\n 2"), linter) - expect_lint( # nofuzz - paste0("1", op, "2"), - lint_msg, - linter - ) + expect_lint(paste0("1", op, "2"), lint_msg, linter) # unary plus and minus can have no space before them if (!op %in% ops[1L:2L]) { - expect_lint(paste0("1 ", op, "2"), lint_msg, linter) # nofuzz + expect_lint(paste0("1 ", op, "2"), lint_msg, linter) } expect_lint(paste0("1", op, " 2"), lint_msg, linter) } + # nofuzz end expect_no_lint("b <- 2E+4", linter) expect_no_lint("a <- 1e-3", linter) diff --git a/tests/testthat/test-one_call_pipe_linter.R b/tests/testthat/test-one_call_pipe_linter.R index 654202237..5822cec6e 100644 --- a/tests/testthat/test-one_call_pipe_linter.R +++ b/tests/testthat/test-one_call_pipe_linter.R @@ -69,6 +69,7 @@ test_that("multiple lints are generated correctly", { ) }) +# nofuzz start test_that("Native pipes are handled as well", { skip_if_not_r_version("4.1.0") @@ -97,7 +98,6 @@ test_that("Native pipes are handled as well", { ) }) -# nofuzz start test_that("one_call_pipe_linter skips data.table chains with native pipe", { skip_if_not_r_version("4.3.0") diff --git a/tests/testthat/test-return_linter.R b/tests/testthat/test-return_linter.R index e4ad3caaa..6a17faca5 100644 --- a/tests/testthat/test-return_linter.R +++ b/tests/testthat/test-return_linter.R @@ -539,7 +539,7 @@ test_that("return_linter handles pipes in control flow", { linter <- return_linter(return_style = "explicit") lint_msg <- rex::rex("All functions must have an explicit return().") - expect_no_lint( + expect_no_lint( # nofuzz trim_some(" foo <- function(x) { if (TRUE) { From df8cccc3b078d08a73ec2db42cdee4dfd4f59478 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:08:25 -0800 Subject: [PATCH 32/57] another batch --- .dev/ast_fuzz_test.R | 2 +- tests/testthat/test-one_call_pipe_linter.R | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index d72b4279c..1f57bbffa 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -116,7 +116,7 @@ failures <- reporter$failures$as_list() valid_failure <- vapply( failures, function(failure) { - if (grepl('(column_number|ranges|line) .* did not match', failure$message)) { + if (grepl("(column_number|ranges|line) .* did not match", failure$message)) { return(TRUE) } FALSE diff --git a/tests/testthat/test-one_call_pipe_linter.R b/tests/testthat/test-one_call_pipe_linter.R index 5822cec6e..9580af783 100644 --- a/tests/testthat/test-one_call_pipe_linter.R +++ b/tests/testthat/test-one_call_pipe_linter.R @@ -12,6 +12,7 @@ test_that("one_call_pipe_linter skips allowed usages", { expect_no_lint("x %<>% as.character()", linter) }) +# nofuzz start test_that("one_call_pipe_linter blocks simple disallowed usages", { linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe %>% for expressions with only a single call.") @@ -25,7 +26,6 @@ test_that("one_call_pipe_linter blocks simple disallowed usages", { expect_lint("x %>% inner_join(y %>% filter(is_treatment))", lint_msg, linter) }) -# nofuzz start test_that("one_call_pipe_linter skips data.table chains", { linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe %>% for expressions with only a single call.") @@ -53,7 +53,7 @@ test_that("one_call_pipe_linter treats all pipes equally", { }) test_that("multiple lints are generated correctly", { - expect_lint( + expect_lint( # nofuzz trim_some("{ a %>% b() c %$% d From 138e9cc2f87e7b84e8f8cbdf48736d1cefbe45b4 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:12:35 -0800 Subject: [PATCH 33/57] tweak --- .dev/ast_fuzz_test.R | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.dev/ast_fuzz_test.R b/.dev/ast_fuzz_test.R index 1f57bbffa..c08976976 100644 --- a/.dev/ast_fuzz_test.R +++ b/.dev/ast_fuzz_test.R @@ -123,8 +123,8 @@ valid_failure <- vapply( }, logical(1L) ) -if (!all(valid_failure)) { - failures <- failures[!valid_failure] +failures <- failures[!valid_failure] +if (length(failures) > 0L) { names(failures) <- vapply(failures, `[[`, "test", FUN.VALUE = character(1L)) cat("Some fuzzed tests failed unexpectedly!\n") print(failures) From 683c461857795f3aa9d2b12da17529a1c0f95173 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:22:14 -0800 Subject: [PATCH 34/57] another nofuzz case, attempting to reduce nofuzz requirements --- .dev/maybe_fuzz_content.R | 21 +++++++++--- tests/testthat/test-commented_code_linter.R | 36 ++++++++++----------- 2 files changed, 34 insertions(+), 23 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index e60ab4655..65ed88dfd 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -14,6 +14,14 @@ maybe_fuzz_content <- function(file, lines) { new_file } +# skip errors for e.g. Rmd files, and ignore warnings. +# We could use get_source_expressions(), but with little benefit & much slower. +# also avoid over-use of 'nofuzz' induced by some incompatible swaps, e.g. not all '%>%' can be +# swapped to '|>' (if '.' is used, or if RHS is not an allowed simple call) +error_or_parse_data <- function(f) { + tryCatch(getParseData(suppressWarnings(parse(f, keep.source = TRUE))), error = identity) +} + simple_swap_fuzzer <- function(pd_filter, replacements) { function(pd, lines) { idx <- which(pd_filter(pd)) @@ -49,18 +57,21 @@ pipe_fuzzer <- simple_swap_fuzzer( # we could also consider just passing any test where no fuzzing takes place, # i.e. letting the other GHA handle whether unfuzzed tests pass as expected. apply_fuzzers <- function(f) { - # skip errors for e.g. Rmd files, and ignore warnings. - # We could use get_source_expressions(), but with little benefit & much slower. - pd <- tryCatch(getParseData(suppressWarnings(parse(f, keep.source = TRUE))), error = identity) + pd <- error_or_parse_data(f) if (inherits(pd, "error")) { return(invisible()) } reparse <- FALSE - lines <- readLines(f) + unedited <- lines <- readLines(f) for (fuzzer in list(function_lambda_fuzzer, pipe_fuzzer)) { if (reparse) { - pd <- getParseData(parse(f, keep.source = TRUE)) + pd <- error_or_parse_data(f) + if (inherits(pd, "error")) { + # our attempted edit failed; restore & abort + writeLines(unedited, f) + return(invisible()) + } lines <- readLines(f) } updated_lines <- fuzzer(pd, lines) diff --git a/tests/testthat/test-commented_code_linter.R b/tests/testthat/test-commented_code_linter.R index 5154a5a94..a1ff0e157 100644 --- a/tests/testthat/test-commented_code_linter.R +++ b/tests/testthat/test-commented_code_linter.R @@ -1,21 +1,21 @@ test_that("commented_code_linter skips allowed usages", { linter <- commented_code_linter() - expect_lint("blah", NULL, linter) - expect_lint("#' blah <- 1", NULL, linter) - expect_lint("a <- 1\n# comment without code", NULL, linter) - expect_lint("a <- 1\n## whatever", NULL, linter) - - expect_lint("TRUE", NULL, linter) - expect_lint("#' @examples", NULL, linter) - expect_lint("#' foo(1) # list(1)", NULL, linter) # comment in roxygen block ignored - expect_lint("1+1 # gives 2", NULL, linter) - expect_lint("# Non-existent:", NULL, linter) - expect_lint("# 1-a", NULL, linter) # "-" removed from code operators - expect_lint('1+1 # for example cat("123")', NULL, linter) + expect_no_lint("blah", linter) + expect_no_lint("#' blah <- 1", linter) + expect_no_lint("a <- 1\n# comment without code", linter) + expect_no_lint("a <- 1\n## whatever", linter) + + expect_no_lint("TRUE", linter) + expect_no_lint("#' @examples", linter) + expect_no_lint("#' foo(1) # list(1)", linter) # comment in roxygen block ignored + expect_no_lint("1+1 # gives 2", linter) + expect_no_lint("# Non-existent:", linter) + expect_no_lint("# 1-a", linter) # "-" removed from code operators + expect_no_lint('1+1 # for example cat("123")', linter) # regression test for #451 - expect_lint("c('#a#' = 1)", NULL, linter) + expect_no_lint("c('#a#' = 1)", linter) }) test_that("commented_code_linter blocks disallowed usages", { @@ -87,20 +87,20 @@ test_that("commented_code_linter can detect operators in comments and lint corre "%anything%" ) + # nofuzz start for (op in test_ops) { - expect_lint(paste("i", op, "1", collapse = ""), NULL, linter) - expect_lint(paste("# something like i", op, "1", collapse = ""), NULL, linter) + expect_no_lint(paste("i", op, "1", collapse = ""), linter) + expect_no_lint(paste("# something like i", op, "1", collapse = ""), linter) expect_lint(paste("# i", op, "1", collapse = ""), lint_msg, linter) } -}) + # nofuzz end -test_that("commented_code_linter can detect operators in comments and lint correctly", { skip_if_not_r_version("4.1.0") expect_lint( "# 1:3 |> sum()", rex::rex("Remove commented code."), - commented_code_linter() + linter ) }) From 98086d48e1528f1dd0ee7610b8df10eb9518bf01 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 6 Mar 2025 23:45:00 -0800 Subject: [PATCH 35/57] fix; scale back nofuzz for an attempt --- .dev/maybe_fuzz_content.R | 20 ++++++++----------- tests/testthat/test-brace_linter.R | 2 -- tests/testthat/test-commented_code_linter.R | 2 -- .../test-implicit_assignment_linter.R | 2 +- tests/testthat/test-infix_spaces_linter.R | 2 -- tests/testthat/test-one_call_pipe_linter.R | 6 +----- tests/testthat/test-pipe_call_linter.R | 2 -- tests/testthat/test-pipe_consistency_linter.R | 2 -- .../testthat/test-pipe_continuation_linter.R | 4 ++-- tests/testthat/test-pipe_return_linter.R | 2 -- tests/testthat/test-return_linter.R | 4 +--- .../test-unnecessary_placeholder_linter.R | 2 -- tests/testthat/test-unused_import_linter.R | 2 +- 13 files changed, 14 insertions(+), 38 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index 65ed88dfd..b76edca00 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -62,22 +62,18 @@ apply_fuzzers <- function(f) { return(invisible()) } - reparse <- FALSE unedited <- lines <- readLines(f) for (fuzzer in list(function_lambda_fuzzer, pipe_fuzzer)) { - if (reparse) { - pd <- error_or_parse_data(f) - if (inherits(pd, "error")) { - # our attempted edit failed; restore & abort - writeLines(unedited, f) - return(invisible()) - } - lines <- readLines(f) - } updated_lines <- fuzzer(pd, lines) - reparse <- !is.null(updated_lines) - if (!reparse) next # skip some I/O if we can + if (is.null(updated_lines)) next # skip some I/O if we can writeLines(updated_lines, f) + # check if our attempted edit introduced some error + pd <- error_or_parse_data(f) + if (inherits(pd, "error")) { + writeLines(unedited, f) + return(invisible()) + } + lines <- readLines(f) } invisible() diff --git a/tests/testthat/test-brace_linter.R b/tests/testthat/test-brace_linter.R index 76c475e0c..0d0532f8e 100644 --- a/tests/testthat/test-brace_linter.R +++ b/tests/testthat/test-brace_linter.R @@ -548,7 +548,6 @@ test_that("code with pipes is handled correctly", { linter ) - # nofuzz start expect_lint( trim_some(" x %>% @@ -580,7 +579,6 @@ test_that("code with pipes is handled correctly", { ), linter ) - # nofuzz end skip_if_not_r_version("4.1.0") diff --git a/tests/testthat/test-commented_code_linter.R b/tests/testthat/test-commented_code_linter.R index a1ff0e157..8809335de 100644 --- a/tests/testthat/test-commented_code_linter.R +++ b/tests/testthat/test-commented_code_linter.R @@ -87,13 +87,11 @@ test_that("commented_code_linter can detect operators in comments and lint corre "%anything%" ) - # nofuzz start for (op in test_ops) { expect_no_lint(paste("i", op, "1", collapse = ""), linter) expect_no_lint(paste("# something like i", op, "1", collapse = ""), linter) expect_lint(paste("# i", op, "1", collapse = ""), lint_msg, linter) } - # nofuzz end skip_if_not_r_version("4.1.0") diff --git a/tests/testthat/test-implicit_assignment_linter.R b/tests/testthat/test-implicit_assignment_linter.R index da0d9c6f7..0681b2ecd 100644 --- a/tests/testthat/test-implicit_assignment_linter.R +++ b/tests/testthat/test-implicit_assignment_linter.R @@ -316,7 +316,7 @@ test_that("implicit_assignment_linter works as expected with pipes and walrus op linter <- implicit_assignment_linter() expect_no_lint("data %>% mutate(a := b)", linter) - expect_no_lint( # nofuzz + expect_no_lint( "dt %>% .[, z := x + y]", linter ) diff --git a/tests/testthat/test-infix_spaces_linter.R b/tests/testthat/test-infix_spaces_linter.R index 9180f912b..245ac8a4e 100644 --- a/tests/testthat/test-infix_spaces_linter.R +++ b/tests/testthat/test-infix_spaces_linter.R @@ -33,7 +33,6 @@ test_that("returns the correct linting", { expect_no_lint("blah", linter) - # nofuzz start for (op in ops) { expect_no_lint(paste0("1 ", op, " 2"), linter) expect_no_lint(paste0("1 ", op, "\n2"), linter) @@ -48,7 +47,6 @@ test_that("returns the correct linting", { expect_lint(paste0("1", op, " 2"), lint_msg, linter) } - # nofuzz end expect_no_lint("b <- 2E+4", linter) expect_no_lint("a <- 1e-3", linter) diff --git a/tests/testthat/test-one_call_pipe_linter.R b/tests/testthat/test-one_call_pipe_linter.R index 9580af783..f8c1d664e 100644 --- a/tests/testthat/test-one_call_pipe_linter.R +++ b/tests/testthat/test-one_call_pipe_linter.R @@ -12,7 +12,6 @@ test_that("one_call_pipe_linter skips allowed usages", { expect_no_lint("x %<>% as.character()", linter) }) -# nofuzz start test_that("one_call_pipe_linter blocks simple disallowed usages", { linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe %>% for expressions with only a single call.") @@ -40,7 +39,6 @@ test_that("one_call_pipe_linter skips data.table chains", { expect_lint("DT %>% .[[idx]]", lint_msg, linter) }) -# nofuzz end test_that("one_call_pipe_linter treats all pipes equally", { linter <- one_call_pipe_linter() @@ -53,7 +51,7 @@ test_that("one_call_pipe_linter treats all pipes equally", { }) test_that("multiple lints are generated correctly", { - expect_lint( # nofuzz + expect_lint( trim_some("{ a %>% b() c %$% d @@ -69,7 +67,6 @@ test_that("multiple lints are generated correctly", { ) }) -# nofuzz start test_that("Native pipes are handled as well", { skip_if_not_r_version("4.1.0") @@ -114,4 +111,3 @@ test_that("one_call_pipe_linter skips data.table chains with native pipe", { expect_lint("DT |> _[[idx]]", lint_msg, linter) }) -# nofuzz end diff --git a/tests/testthat/test-pipe_call_linter.R b/tests/testthat/test-pipe_call_linter.R index 7e389878e..e15226de3 100644 --- a/tests/testthat/test-pipe_call_linter.R +++ b/tests/testthat/test-pipe_call_linter.R @@ -1,4 +1,3 @@ -# nofuzz start test_that("pipe_call_linter skips allowed usages", { linter <- pipe_call_linter() @@ -90,4 +89,3 @@ test_that("Multiple lints give custom messages", { pipe_call_linter() ) }) -# nofuzz end diff --git a/tests/testthat/test-pipe_consistency_linter.R b/tests/testthat/test-pipe_consistency_linter.R index 57c6df83b..687838405 100644 --- a/tests/testthat/test-pipe_consistency_linter.R +++ b/tests/testthat/test-pipe_consistency_linter.R @@ -1,4 +1,3 @@ -# nofuzz start test_that("pipe_consistency skips allowed usage", { skip_if_not_r_version("4.1.0") linter <- pipe_consistency_linter() @@ -161,4 +160,3 @@ test_that("pipe_consistency_linter works with other magrittr pipes", { linter ) }) -# nofuzz end diff --git a/tests/testthat/test-pipe_continuation_linter.R b/tests/testthat/test-pipe_continuation_linter.R index 7775007d1..566848505 100644 --- a/tests/testthat/test-pipe_continuation_linter.R +++ b/tests/testthat/test-pipe_continuation_linter.R @@ -65,7 +65,7 @@ test_that("pipe-continuation linter correctly handles nesting", { ) # but no lints here - expect_no_lint( # nofuzz. Not valid with '|>' + expect_no_lint( trim_some(" 1:4 %>% { (.) %>% sum() @@ -158,7 +158,7 @@ local({ test_data <- diamonds %>% head(10) %>% tail(5) }) "), "three inside test_that()", - trim_some( # nofuzz. Native pipe requires calls, not symbols. + trim_some( " { x <- a %>% b %>% c diff --git a/tests/testthat/test-pipe_return_linter.R b/tests/testthat/test-pipe_return_linter.R index 22ea6a9a2..f235edbd1 100644 --- a/tests/testthat/test-pipe_return_linter.R +++ b/tests/testthat/test-pipe_return_linter.R @@ -30,7 +30,6 @@ test_that("pipe_return_linter skips allowed usages", { expect_no_lint(nested_return_lines, linter) }) -# nofuzz start test_that("pipe_return_linter blocks simple disallowed usages", { lines <- trim_some(" pipeline <- function(x) { @@ -66,4 +65,3 @@ test_that("lints vectorize", { pipe_return_linter() ) }) -# nofuzz end diff --git a/tests/testthat/test-return_linter.R b/tests/testthat/test-return_linter.R index 6a17faca5..1a228e912 100644 --- a/tests/testthat/test-return_linter.R +++ b/tests/testthat/test-return_linter.R @@ -495,7 +495,6 @@ test_that("return_linter allows return()-less namespace hook calls", { ) }) -# nofuzz start test_that("return_linter correctly handles pipes", { linter <- return_linter(return_style = "explicit") @@ -533,13 +532,12 @@ test_that("return_linter correctly handles pipes", { linter ) }) -# nofuzz end test_that("return_linter handles pipes in control flow", { linter <- return_linter(return_style = "explicit") lint_msg <- rex::rex("All functions must have an explicit return().") - expect_no_lint( # nofuzz + expect_no_lint( trim_some(" foo <- function(x) { if (TRUE) { diff --git a/tests/testthat/test-unnecessary_placeholder_linter.R b/tests/testthat/test-unnecessary_placeholder_linter.R index ba89c8237..88b921e52 100644 --- a/tests/testthat/test-unnecessary_placeholder_linter.R +++ b/tests/testthat/test-unnecessary_placeholder_linter.R @@ -1,4 +1,3 @@ -# nofuzz start linter <- unnecessary_placeholder_linter() pipes <- pipes(exclude = "|>") @@ -54,4 +53,3 @@ test_that("lints vectorize", { unnecessary_placeholder_linter() ) }) -# nofuzz end diff --git a/tests/testthat/test-unused_import_linter.R b/tests/testthat/test-unused_import_linter.R index 4c2bac2ff..b9c52a240 100644 --- a/tests/testthat/test-unused_import_linter.R +++ b/tests/testthat/test-unused_import_linter.R @@ -7,7 +7,7 @@ test_that("unused_import_linter lints as expected", { # SYMBOL usage is detected expect_no_lint("library(dplyr)\ndo.call(tibble, args = list(a = 1))", linter) # SPECIAL usage is detected - expect_no_lint( # nofuzz + expect_no_lint( trim_some(" library(magrittr) 1:3 %>% mean() From fe88c59362fb6e2b7f6167998858a81c7f84c54a Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 00:09:42 -0800 Subject: [PATCH 36/57] reinstate more legit nofuzz --- tests/testthat/test-one_call_pipe_linter.R | 8 +++++--- tests/testthat/test-pipe_consistency_linter.R | 2 ++ tests/testthat/test-unnecessary_placeholder_linter.R | 4 ++-- tests/testthat/test-unused_import_linter.R | 2 +- 4 files changed, 10 insertions(+), 6 deletions(-) diff --git a/tests/testthat/test-one_call_pipe_linter.R b/tests/testthat/test-one_call_pipe_linter.R index f8c1d664e..9cf7a60e9 100644 --- a/tests/testthat/test-one_call_pipe_linter.R +++ b/tests/testthat/test-one_call_pipe_linter.R @@ -12,6 +12,7 @@ test_that("one_call_pipe_linter skips allowed usages", { expect_no_lint("x %<>% as.character()", linter) }) +# nofuzz start test_that("one_call_pipe_linter blocks simple disallowed usages", { linter <- one_call_pipe_linter() lint_msg <- rex::rex("Avoid pipe %>% for expressions with only a single call.") @@ -24,6 +25,7 @@ test_that("one_call_pipe_linter blocks simple disallowed usages", { # nested case expect_lint("x %>% inner_join(y %>% filter(is_treatment))", lint_msg, linter) }) +# nofuzz end test_that("one_call_pipe_linter skips data.table chains", { linter <- one_call_pipe_linter() @@ -50,7 +52,7 @@ test_that("one_call_pipe_linter treats all pipes equally", { expect_no_lint('data %>% filter(type == "console") %$% obscured_id %>% unique()', linter) }) -test_that("multiple lints are generated correctly", { +test_that("multiple lints are generated correctly", { # nofuzz expect_lint( trim_some("{ a %>% b() @@ -72,7 +74,7 @@ test_that("Native pipes are handled as well", { linter <- one_call_pipe_linter() - expect_lint( + expect_lint( # nofuzz "x |> foo()", rex::rex("Avoid pipe |> for expressions with only a single call."), linter @@ -82,7 +84,7 @@ test_that("Native pipes are handled as well", { expect_no_lint("x |> foo() %>% bar()", linter) expect_no_lint("x %>% foo() |> bar()", linter) - expect_lint( + expect_lint( # nofuzz trim_some("{ a %>% b() c |> d() diff --git a/tests/testthat/test-pipe_consistency_linter.R b/tests/testthat/test-pipe_consistency_linter.R index 687838405..57c6df83b 100644 --- a/tests/testthat/test-pipe_consistency_linter.R +++ b/tests/testthat/test-pipe_consistency_linter.R @@ -1,3 +1,4 @@ +# nofuzz start test_that("pipe_consistency skips allowed usage", { skip_if_not_r_version("4.1.0") linter <- pipe_consistency_linter() @@ -160,3 +161,4 @@ test_that("pipe_consistency_linter works with other magrittr pipes", { linter ) }) +# nofuzz end diff --git a/tests/testthat/test-unnecessary_placeholder_linter.R b/tests/testthat/test-unnecessary_placeholder_linter.R index 88b921e52..8ee413a4b 100644 --- a/tests/testthat/test-unnecessary_placeholder_linter.R +++ b/tests/testthat/test-unnecessary_placeholder_linter.R @@ -19,7 +19,7 @@ patrick::with_parameters_test_that( pipe = pipes ) -patrick::with_parameters_test_that( +patrick::with_parameters_test_that( # nofuzz "unnecessary_placeholder_linter blocks simple disallowed usages", { expect_lint( @@ -38,7 +38,7 @@ patrick::with_parameters_test_that( pipe = pipes ) -test_that("lints vectorize", { +test_that("lints vectorize", { # nofuzz lint_msg <- rex::rex("Don't use the placeholder (`.`) when it's not needed") expect_lint( diff --git a/tests/testthat/test-unused_import_linter.R b/tests/testthat/test-unused_import_linter.R index b9c52a240..4c2bac2ff 100644 --- a/tests/testthat/test-unused_import_linter.R +++ b/tests/testthat/test-unused_import_linter.R @@ -7,7 +7,7 @@ test_that("unused_import_linter lints as expected", { # SYMBOL usage is detected expect_no_lint("library(dplyr)\ndo.call(tibble, args = list(a = 1))", linter) # SPECIAL usage is detected - expect_no_lint( + expect_no_lint( # nofuzz trim_some(" library(magrittr) 1:3 %>% mean() From 19288315511c376b929407793ac0e87725ed1629 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 18:03:42 +0000 Subject: [PATCH 37/57] general fix for issue of S4 method calls under @ --- NEWS.md | 2 ++ R/missing_argument_linter.R | 2 +- R/source_utils.R | 12 +++++++++++- tests/testthat/test-missing_argument_linter.R | 1 + 4 files changed, 15 insertions(+), 2 deletions(-) diff --git a/NEWS.md b/NEWS.md index 8ea061062..393a1e394 100644 --- a/NEWS.md +++ b/NEWS.md @@ -30,6 +30,7 @@ * `object_name_linter()` and `object_length_linter()` apply to objects assigned with `assign()` or generics created with `setGeneric()` (#1665, @MichaelChirico). * `object_usage_linter()` gains argument `interpret_extensions` to govern which false positive-prone common syntaxes should be checked for used objects (#1472, @MichaelChirico). Currently `"glue"` (renamed from earlier argument `interpret_glue`) and `"rlang"` are supported. The latter newly covers usage of the `.env` pronoun like `.env$key`, where `key` was previously missed as being a used variable. * `boolean_arithmetic_linter()` finds many more cases like `sum(x | y) == 0` where the total of a known-logical vector is compared to 0 (#1580, @MichaelChirico). +* New argument `include_s4_slots` for the `xml_find_function_calls()` entry in the `get_source_expressions()` to govern whether calls of the form `s4Obj@fun()` are included in the result (#2820, @MichaelChirico). ### New linters @@ -57,6 +58,7 @@ + `library_call_linter()` + `terminal_close_linter()` + `unnecessary_lambda_linter()` +* `missing_argument_linter()` finds S4 usage like `s4Obj@method(arg = )` (#2820, @MichaelChirico). ## Notes diff --git a/R/missing_argument_linter.R b/R/missing_argument_linter.R index 284cfa75a..749980d52 100644 --- a/R/missing_argument_linter.R +++ b/R/missing_argument_linter.R @@ -50,7 +50,7 @@ missing_argument_linter <- function(except = c("alist", "quote", "switch"), allo ") Linter(linter_level = "file", function(source_expression) { - xml_targets <- source_expression$xml_find_function_calls(NULL, keep_names = TRUE) + xml_targets <- source_expression$xml_find_function_calls(NULL, keep_names = TRUE, include_s4_slots = TRUE) xml_targets <- xml_targets[!names(xml_targets) %in% except] missing_args <- xml_find_all(xml_targets, xpath) diff --git a/R/source_utils.R b/R/source_utils.R index 427bab0fa..b558eac61 100644 --- a/R/source_utils.R +++ b/R/source_utils.R @@ -13,12 +13,22 @@ build_xml_find_function_calls <- function(xml) { function_call_cache <- xml_find_all(xml, "//SYMBOL_FUNCTION_CALL/parent::expr") names(function_call_cache) <- get_r_string(function_call_cache, "SYMBOL_FUNCTION_CALL") - function(function_names, keep_names = FALSE) { + s4_slot_cache <- xml_find_all(xml, "//SLOT/parent::expr[following-sibling::OP-LEFT-PAREN]") + names(s4_slot_cache) <- get_r_string(s4_slot_cache, "SLOT") + + function(function_names, keep_names = FALSE, include_s4_slots = FALSE) { if (is.null(function_names)) { res <- function_call_cache } else { res <- function_call_cache[names(function_call_cache) %in% function_names] } + if (include_s4_slots) { + if (is.null(function_names)) { + res <- combine_nodesets(function_call_cache, s4_slot_cache) + } else { + res <- combine_nodesets(function_call_cache, s4_slot_cache[names(s4_slot_cache) %in% function_names]) + } + } if (keep_names) res else unname(res) } } diff --git a/tests/testthat/test-missing_argument_linter.R b/tests/testthat/test-missing_argument_linter.R index 62266e628..cea51f404 100644 --- a/tests/testthat/test-missing_argument_linter.R +++ b/tests/testthat/test-missing_argument_linter.R @@ -51,6 +51,7 @@ test_that("missing_argument_linter blocks disallowed usages", { expect_lint("stats::median(1:10, a =)", lint_msga, linter) expect_lint("env$get(1:10, a =)", lint_msga, linter) + expect_lint("env@get(1:10, a =)", lint_msga, linter) # Fixes https://github.com/r-lib/lintr/issues/906 # Comments should be ignored so that missing arguments could be From 168ee65f12bad5e382b8abbef5b7f12145c06b75 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 18:09:06 +0000 Subject: [PATCH 38/57] fix missed S4 extractions looking for preamble --- R/library_call_linter.R | 5 ++++- tests/testthat/test-library_call_linter.R | 11 +++++++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/R/library_call_linter.R b/R/library_call_linter.R index b87297d8e..4b67851ab 100644 --- a/R/library_call_linter.R +++ b/R/library_call_linter.R @@ -97,7 +97,10 @@ library_call_linter <- function(allow_preamble = TRUE) { upfront_call_xpath <- glue(" //SYMBOL_FUNCTION_CALL[{ attach_call_cond }][last()] /preceding::expr - /SYMBOL_FUNCTION_CALL[{ unsuppressed_call_cond }][last()] + /*[ + (self::SYMBOL_FUNCTION_CALL or self::SLOT[parent::expr/following-sibling::OP-LEFT-PAREN]) + and ({ unsuppressed_call_cond }) + ][last()] /following::expr[SYMBOL_FUNCTION_CALL[{ attach_call_cond }]] /parent::expr ") diff --git a/tests/testthat/test-library_call_linter.R b/tests/testthat/test-library_call_linter.R index aca3427c0..0a6521734 100644 --- a/tests/testthat/test-library_call_linter.R +++ b/tests/testthat/test-library_call_linter.R @@ -206,6 +206,17 @@ test_that("allow_preamble applies as intended", { expect_no_lint(lines, linter_preamble) expect_lint(lines, list(list(line_number = 2L), list(line_number = 3L)), linter_no_preamble) + # allow S4 operation to precede library() as well, equivalently to other function calls + lines <- trim_some(" + opts_chunk@set(eval = FALSE) + library(dplyr) + suppressPackageStartupMessages(library(knitr)) + + print(letters) + ") + expect_no_lint(lines, linter_preamble) + expect_lint(lines, list(list(line_number = 2L), list(line_number = 3L)), linter_no_preamble) + lines <- trim_some(" fun() library(moreFun) From 413e029972608e85dc8096675e0158ad7d985caf Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 18:12:59 +0000 Subject: [PATCH 39/57] expect_no_lint --- .../test-function_left_parentheses_linter.R | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/tests/testthat/test-function_left_parentheses_linter.R b/tests/testthat/test-function_left_parentheses_linter.R index 9c53df662..ff119ff85 100644 --- a/tests/testthat/test-function_left_parentheses_linter.R +++ b/tests/testthat/test-function_left_parentheses_linter.R @@ -1,27 +1,27 @@ test_that("function_left_parentheses_linter skips allowed usages", { linter <- function_left_parentheses_linter() - expect_lint("blah", NULL, linter) - expect_lint("print(blah)", NULL, linter) - expect_lint('"print"(blah)', NULL, linter) - expect_lint("base::print(blah)", NULL, linter) - expect_lint('base::"print"(blah)', NULL, linter) - expect_lint("base::print(blah, fun(1))", NULL, linter) - expect_lint("blah <- function(blah) { }", NULL, linter) - expect_lint("(1 + 1)", NULL, linter) - expect_lint("( (1 + 1) )", NULL, linter) - expect_lint("if (blah) { }", NULL, linter) - expect_lint("for (i in j) { }", NULL, linter) - expect_lint("1 * (1 + 1)", NULL, linter) - expect_lint("!(1 == 1)", NULL, linter) - expect_lint("(2 - 1):(3 - 1)", NULL, linter) - expect_lint("c(1, 2, 3)[(2 - 1)]", NULL, linter) - expect_lint("list(1, 2, 3)[[(2 - 1)]]", NULL, linter) - expect_lint("range(10)[(2 - 1):(10 - 1)]", NULL, linter) - expect_lint("function(){function(){}}()()", NULL, linter) - expect_lint("c(function(){})[1]()", NULL, linter) - expect_lint("function(x) (mean(x) + 3)", NULL, linter) - expect_lint("\"blah (1)\"", NULL, linter) + expect_no_lint("blah", linter) + expect_no_lint("print(blah)", linter) + expect_no_lint('"print"(blah)', linter) + expect_no_lint("base::print(blah)", linter) + expect_no_lint('base::"print"(blah)', linter) + expect_no_lint("base::print(blah, fun(1))", linter) + expect_no_lint("blah <- function(blah) { }", linter) + expect_no_lint("(1 + 1)", linter) + expect_no_lint("( (1 + 1) )", linter) + expect_no_lint("if (blah) { }", linter) + expect_no_lint("for (i in j) { }", linter) + expect_no_lint("1 * (1 + 1)", linter) + expect_no_lint("!(1 == 1)", linter) + expect_no_lint("(2 - 1):(3 - 1)", linter) + expect_no_lint("c(1, 2, 3)[(2 - 1)]", linter) + expect_no_lint("list(1, 2, 3)[[(2 - 1)]]", linter) + expect_no_lint("range(10)[(2 - 1):(10 - 1)]", linter) + expect_no_lint("function(){function(){}}()()", linter) + expect_no_lint("c(function(){})[1]()", linter) + expect_no_lint("function(x) (mean(x) + 3)", linter) + expect_no_lint('"blah (1)"', linter) }) test_that("function_left_parentheses_linter blocks disallowed usages", { @@ -168,7 +168,7 @@ test_that("it doesn't produce invalid lints", { test_that("newline in character string doesn't trigger false positive (#1963)", { linter <- function_left_parentheses_linter() - expect_lint('foo("\n")$bar()', NULL, linter) + expect_no_lint('foo("\n")$bar()', linter) # also corrected the lint metadata for similar cases expect_lint( trim_some(' @@ -189,7 +189,7 @@ test_that("shorthand functions are handled", { linter <- function_left_parentheses_linter() fun_lint_msg <- rex::rex("Remove spaces before the left parenthesis in a function definition.") - expect_lint("blah <- \\(blah) { }", NULL, linter) - expect_lint("\\(){\\(){}}()()", NULL, linter) + expect_no_lint("blah <- \\(blah) { }", linter) + expect_no_lint("\\(){\\(){}}()()", linter) expect_lint("test <- \\ (x) { }", fun_lint_msg, linter) }) From c7cc8ac254e09337cb0e705f98117f91d4796b59 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 18:16:48 +0000 Subject: [PATCH 40/57] handle @ equivalency --- R/function_left_parentheses_linter.R | 2 +- .../test-function_left_parentheses_linter.R | 13 +++++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/R/function_left_parentheses_linter.R b/R/function_left_parentheses_linter.R index 07e4ee438..de0d9a41d 100644 --- a/R/function_left_parentheses_linter.R +++ b/R/function_left_parentheses_linter.R @@ -47,7 +47,7 @@ function_left_parentheses_linter <- function() { # nolint: object_length. # because it allows the xpath to be the same for both FUNCTION and SYMBOL_FUNCTION_CALL. # Further, write 4 separate XPaths because the 'range_end_xpath' differs for these two nodes. bad_line_fun_xpath <- "(//FUNCTION | //OP-LAMBDA)[@line1 != following-sibling::OP-LEFT-PAREN/@line1]" - bad_line_call_xpath <- "//SYMBOL_FUNCTION_CALL[@line1 != parent::expr/following-sibling::OP-LEFT-PAREN/@line1]" + bad_line_call_xpath <- "(//SYMBOL_FUNCTION_CALL | //SLOT)[@line1 != parent::expr/following-sibling::OP-LEFT-PAREN/@line1]" bad_col_fun_xpath <- "(//FUNCTION | //OP-LAMBDA)[ @line1 = following-sibling::OP-LEFT-PAREN/@line1 and @col2 != following-sibling::OP-LEFT-PAREN/@col1 - 1 diff --git a/tests/testthat/test-function_left_parentheses_linter.R b/tests/testthat/test-function_left_parentheses_linter.R index ff119ff85..e45b1b7b0 100644 --- a/tests/testthat/test-function_left_parentheses_linter.R +++ b/tests/testthat/test-function_left_parentheses_linter.R @@ -182,6 +182,19 @@ test_that("newline in character string doesn't trigger false positive (#1963)", list(line_number = 3L, column_number = 6L), linter ) + + expect_lint( + trim_some(' + ( + foo(" + ")@bar + () + ) + '), + # attach to 'b' in '@bar' + list(line_number = 3L, column_number = 6L), + linter + ) }) test_that("shorthand functions are handled", { From 4d3ff4fca896c5cc246ca471322de538cab07039 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 18:42:34 +0000 Subject: [PATCH 41/57] fix an equivalency issue in indentation_linter --- R/indentation_linter.R | 4 ++-- tests/testthat/test-indentation_linter.R | 19 +++++++++++++++++++ 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/R/indentation_linter.R b/R/indentation_linter.R index 9c57b5c74..e09b01fae 100644 --- a/R/indentation_linter.R +++ b/R/indentation_linter.R @@ -161,7 +161,7 @@ indentation_linter <- function(indent = 2L, hanging_indent_style = c("tidy", "al glue("self::{paren_tokens_left}/following-sibling::{paren_tokens_right}/preceding-sibling::*[1]/@line2"), glue(" self::*[{xp_and(paste0('not(self::', paren_tokens_left, ')'))}] - /following-sibling::SYMBOL_FUNCTION_CALL + /following-sibling::*[self::SYMBOL_FUNCTION_CALL or self::SLOT] /parent::expr /following-sibling::expr[1] /@line2 @@ -169,7 +169,7 @@ indentation_linter <- function(indent = 2L, hanging_indent_style = c("tidy", "al glue(" self::*[ {xp_and(paste0('not(self::', paren_tokens_left, ')'))} - and not(following-sibling::SYMBOL_FUNCTION_CALL) + and not(following-sibling::*[self::SYMBOL_FUNCTION_CALL or self::SLOT]) ] /following-sibling::*[not(self::COMMENT)][1] /@line2 diff --git a/tests/testthat/test-indentation_linter.R b/tests/testthat/test-indentation_linter.R index 229f78cbe..fdb8e5477 100644 --- a/tests/testthat/test-indentation_linter.R +++ b/tests/testthat/test-indentation_linter.R @@ -579,6 +579,25 @@ test_that("combined hanging and block indent works", { "), linter ) + + # S4 equivalence + expect_no_lint( + trim_some(" + http_head(url, ...)@ + then(function(res) { + if (res$status_code < 300) { + cli_alert_success() + } else { + cli_alert_danger() + } + })@ + catch(error = function(err) { + e <- if (grepl('timed out', err$message)) 'timed out' else 'error' + cli_alert_danger() + }) + "), + linter + ) }) test_that("hanging_indent_stlye works", { From 1d8869f232cfda75868d8fadd2d1f5e8e9cfbebb Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:01:41 +0000 Subject: [PATCH 42/57] new simple swap fuzzer, some nofuzz --- .dev/maybe_fuzz_content.R | 11 ++++++++--- tests/testthat/test-any_duplicated_linter.R | 2 ++ tests/testthat/test-object_usage_linter.R | 2 +- 3 files changed, 11 insertions(+), 4 deletions(-) diff --git a/.dev/maybe_fuzz_content.R b/.dev/maybe_fuzz_content.R index b76edca00..8daf63fe2 100644 --- a/.dev/maybe_fuzz_content.R +++ b/.dev/maybe_fuzz_content.R @@ -9,7 +9,7 @@ maybe_fuzz_content <- function(file, lines) { file.copy(file, new_file, copy.mode = FALSE) } - apply_fuzzers(new_file) + apply_fuzzers(new_file, list(function_lambda_fuzzer, pipe_fuzzer, dollar_at_fuzzer)) new_file } @@ -54,16 +54,21 @@ pipe_fuzzer <- simple_swap_fuzzer( replacements = c("%>%", "|>") ) +dollar_at_fuzzer <- simple_swap_fuzzer( + \(pd) pd$token %in% c("'$'", "'@'"), + replacements = c("$", "@") +) + # we could also consider just passing any test where no fuzzing takes place, # i.e. letting the other GHA handle whether unfuzzed tests pass as expected. -apply_fuzzers <- function(f) { +apply_fuzzers <- function(f, fuzzers) { pd <- error_or_parse_data(f) if (inherits(pd, "error")) { return(invisible()) } unedited <- lines <- readLines(f) - for (fuzzer in list(function_lambda_fuzzer, pipe_fuzzer)) { + for (fuzzer in fuzzers) { updated_lines <- fuzzer(pd, lines) if (is.null(updated_lines)) next # skip some I/O if we can writeLines(updated_lines, f) diff --git a/tests/testthat/test-any_duplicated_linter.R b/tests/testthat/test-any_duplicated_linter.R index 22100b1cf..15038b0b5 100644 --- a/tests/testthat/test-any_duplicated_linter.R +++ b/tests/testthat/test-any_duplicated_linter.R @@ -1,3 +1,4 @@ +# nofuzz start test_that("any_duplicated_linter skips allowed usages", { linter <- any_duplicated_linter() @@ -80,3 +81,4 @@ test_that("any_duplicated_linter catches expression with two types of lint", { linter ) }) +# nofuzz end diff --git a/tests/testthat/test-object_usage_linter.R b/tests/testthat/test-object_usage_linter.R index d2c58371e..88bb4a1ac 100644 --- a/tests/testthat/test-object_usage_linter.R +++ b/tests/testthat/test-object_usage_linter.R @@ -866,7 +866,7 @@ test_that("dplyr's .env-specified objects are marked as 'used'", { skip_if_not_installed("rlang") linter <- object_usage_linter() - expect_lint( + expect_lint( # nofuzz trim_some(" foo <- function(df) { source <- 1 From 3d106d73511b506878a45649438bd0eb2f23ce40 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:14:25 +0000 Subject: [PATCH 43/57] add some vectorization to make debugging easier --- R/indentation_linter.R | 27 +++++++++++++-------------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/R/indentation_linter.R b/R/indentation_linter.R index e09b01fae..f59e0145e 100644 --- a/R/indentation_linter.R +++ b/R/indentation_linter.R @@ -237,20 +237,19 @@ indentation_linter <- function(indent = 2L, hanging_indent_style = c("tidy", "al is_hanging <- logical(length(indent_levels)) indent_changes <- xml_find_all(xml, xp_indent_changes) - for (change in indent_changes) { - change_type <- find_indent_type(change) - change_begin <- as.integer(xml_attr(change, "line1")) + 1L - change_end <- xml_find_num(change, xp_block_ends) - if (isTRUE(change_begin <= change_end)) { - to_indent <- seq(from = change_begin, to = change_end) - expected_indent_levels[to_indent] <- find_new_indent( - current_indent = expected_indent_levels[to_indent], - change_type = change_type, - indent = indent, - hanging_indent = as.integer(xml_attr(change, "col2")) - ) - is_hanging[to_indent] <- change_type == "hanging" - } + change_types <- vapply(indent_changes, find_indent_type, character(1L)) + change_begins <- as.integer(xml_attr(indent_changes, "line1")) + 1L + change_ends <- xml_find_num(indent_changes, xp_block_ends) + col2s <- as.integer(xml_attr(indent_changes, "col2")) + for (ii in which(change_begins <= change_ends)) { + to_indent <- seq(from = change_begins[ii], to = change_ends[ii]) + expected_indent_levels[to_indent] <- find_new_indent( + current_indent = expected_indent_levels[to_indent], + change_type = change_types[ii], + indent = indent, + hanging_indent = col2s[ii] + ) + is_hanging[to_indent] <- change_types[ii] == "hanging" } in_str_const <- logical(length(indent_levels)) From 1d196875a6ddca3c9dfa9b7f7d72cc3e8dc252da Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:25:38 +0000 Subject: [PATCH 44/57] another indentation inconsistency --- R/indentation_linter.R | 10 ++++++++-- tests/testthat/test-indentation_linter.R | 9 +++++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/R/indentation_linter.R b/R/indentation_linter.R index f59e0145e..3533eac39 100644 --- a/R/indentation_linter.R +++ b/R/indentation_linter.R @@ -161,7 +161,10 @@ indentation_linter <- function(indent = 2L, hanging_indent_style = c("tidy", "al glue("self::{paren_tokens_left}/following-sibling::{paren_tokens_right}/preceding-sibling::*[1]/@line2"), glue(" self::*[{xp_and(paste0('not(self::', paren_tokens_left, ')'))}] - /following-sibling::*[self::SYMBOL_FUNCTION_CALL or self::SLOT] + /following-sibling::*[ + self::SYMBOL_FUNCTION_CALL + or self::SLOT[parent::expr/following-sibling::OP-LEFT-PAREN] + ] /parent::expr /following-sibling::expr[1] /@line2 @@ -169,7 +172,10 @@ indentation_linter <- function(indent = 2L, hanging_indent_style = c("tidy", "al glue(" self::*[ {xp_and(paste0('not(self::', paren_tokens_left, ')'))} - and not(following-sibling::*[self::SYMBOL_FUNCTION_CALL or self::SLOT]) + and not(following-sibling::*[ + self::SYMBOL_FUNCTION_CALL + or self::SLOT[parent::expr/following-sibling::OP-LEFT-PAREN] + ]) ] /following-sibling::*[not(self::COMMENT)][1] /@line2 diff --git a/tests/testthat/test-indentation_linter.R b/tests/testthat/test-indentation_linter.R index fdb8e5477..a4e1f6a55 100644 --- a/tests/testthat/test-indentation_linter.R +++ b/tests/testthat/test-indentation_linter.R @@ -403,6 +403,15 @@ test_that("indentation with operators works", { "), linter ) + + expect_no_lint( + trim_some(" + abc@ + def@ + ghi + "), + linter + ) }) test_that("indentation with bracket works", { From dbfaf5ccda42e6a646213ba12f0740c638baf719 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:40:24 +0000 Subject: [PATCH 45/57] nofuzz'ing --- tests/testthat/test-is_numeric_linter.R | 6 +++++- tests/testthat/test-keyword_quote_linter.R | 4 ++-- tests/testthat/test-undesirable_operator_linter.R | 2 +- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/tests/testthat/test-is_numeric_linter.R b/tests/testthat/test-is_numeric_linter.R index af61203c7..d0026e1f7 100644 --- a/tests/testthat/test-is_numeric_linter.R +++ b/tests/testthat/test-is_numeric_linter.R @@ -28,7 +28,11 @@ test_that("is_numeric_linter blocks disallowed usages involving ||", { expect_lint("is.integer(x) || is.numeric(x)", lint_msg, linter) # identical expressions match too - expect_lint("is.integer(DT$x) || is.numeric(DT$x)", lint_msg, linter) + expect_lint( # nofuzz + "is.integer(DT$x) || is.numeric(DT$x)", + lint_msg, + linter + ) # line breaks don't matter lines <- trim_some(" diff --git a/tests/testthat/test-keyword_quote_linter.R b/tests/testthat/test-keyword_quote_linter.R index a8610439b..12b53b696 100644 --- a/tests/testthat/test-keyword_quote_linter.R +++ b/tests/testthat/test-keyword_quote_linter.R @@ -113,7 +113,7 @@ test_that("keyword_quote_linter blocks quoted assignment targets", { expect_lint('1 -> "a b"', backtick_msg, linter) }) -test_that("keyword_quote_linter blocks quoted $, @ extractions", { +test_that("keyword_quote_linter blocks quoted $, @ extractions", { # nofuzz linter <- keyword_quote_linter() backtick_msg <- rex::rex("Use backticks to create non-syntactic names, not quotes.") dollar_msg <- rex::rex("Only quote targets of extraction with $ if necessary") @@ -135,7 +135,7 @@ test_that("keyword_quote_linter blocks quoted $, @ extractions", { expect_lint("x@`foo` = 1", at_msg, linter) }) -test_that("multiple lints are generated correctly", { +test_that("multiple lints are generated correctly", { # nofuzz linter <- keyword_quote_linter() expect_lint( diff --git a/tests/testthat/test-undesirable_operator_linter.R b/tests/testthat/test-undesirable_operator_linter.R index 2cd9ca483..67a3e9ac5 100644 --- a/tests/testthat/test-undesirable_operator_linter.R +++ b/tests/testthat/test-undesirable_operator_linter.R @@ -10,7 +10,7 @@ test_that("linter returns correct linting", { list(message = msg_assign, line_number = 1L, column_number = 3L), linter ) - expect_lint( + expect_lint( # nofuzz "data$parsed == c(1, 2)", list(message = msg_dollar, line_number = 1L, column_number = 5L), linter From 88117cbccef74f515f7c8f3d7e4d57834cccb435 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:48:33 +0000 Subject: [PATCH 46/57] complete NEWS --- NEWS.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index 393a1e394..af6d69e88 100644 --- a/NEWS.md +++ b/NEWS.md @@ -58,7 +58,11 @@ + `library_call_linter()` + `terminal_close_linter()` + `unnecessary_lambda_linter()` -* `missing_argument_linter()` finds S4 usage like `s4Obj@method(arg = )` (#2820, @MichaelChirico). +* More consistency on handling `@` extractions (#2820, @MichaelChirico). + + `function_left_parentheses_linter()` + + `indentation_linter()` + + `library_call_linter()` + + `missing_argument_linter()` ## Notes From ee611cbe2b280dfa0a9f564b8db1b2546c8eccd5 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:50:18 +0000 Subject: [PATCH 47/57] more expect_no_lint --- tests/testthat/test-keyword_quote_linter.R | 50 ++++++++++------------ 1 file changed, 23 insertions(+), 27 deletions(-) diff --git a/tests/testthat/test-keyword_quote_linter.R b/tests/testthat/test-keyword_quote_linter.R index 12b53b696..b562a9ac5 100644 --- a/tests/testthat/test-keyword_quote_linter.R +++ b/tests/testthat/test-keyword_quote_linter.R @@ -2,30 +2,26 @@ test_that("keyword_quote_linter skips allowed usages", { linter <- keyword_quote_linter() # main use case: c() - expect_lint("x <- c(1, 2, 4, 5)", NULL, linter) - expect_lint("x <- c(a = 1, 2)", NULL, linter) - expect_lint("x <- c(a = 1, b = 2)", NULL, linter) - expect_lint("y <- c(`a b` = 1, `c d` = 2)", NULL, linter) - expect_lint('y <- c("a b" = 1, "c d" = 2)', NULL, linter) - expect_lint("z <- c('a b' = 1, c = 2)", NULL, linter) + expect_no_lint("x <- c(1, 2, 4, 5)", linter) + expect_no_lint("x <- c(a = 1, 2)", linter) + expect_no_lint("x <- c(a = 1, b = 2)", linter) + expect_no_lint("y <- c(`a b` = 1, `c d` = 2)", linter) + expect_no_lint('y <- c("a b" = 1, "c d" = 2)', linter) + expect_no_lint("z <- c('a b' = 1, c = 2)", linter) # don't catch strings as arguments - expect_lint('c(A = "a")', NULL, linter) + expect_no_lint('c(A = "a")', linter) # don't catch unnamed arguments - expect_lint('c(1, 2, "a")', NULL, linter) + expect_no_lint('c(1, 2, "a")', linter) # don't get thrown off by missing arguments - expect_lint("alist(`a b` =)", NULL, linter) + expect_no_lint("alist(`a b` =)", linter) # other use cases: switch() and list() - expect_lint("list(a = 1, b = list(c = 2))", NULL, linter) - expect_lint("list(`a b` = 1, c = 2:6)", NULL, linter) + expect_no_lint("list(a = 1, b = list(c = 2))", linter) + expect_no_lint("list(`a b` = 1, c = 2:6)", linter) - expect_lint("switch(x, a = 1, b = 2)", NULL, linter) - expect_lint( - "switch(x, `a b` = 1, c = 2:6)", - NULL, - linter - ) + expect_no_lint("switch(x, a = 1, b = 2)", linter) + expect_no_lint("switch(x, `a b` = 1, c = 2:6)", linter) }) test_that("keyword_quote_linter blocks simple disallowed usages", { @@ -59,9 +55,9 @@ test_that("keyword_quote_linter blocks simple disallowed usages", { test_that("keyword_quote_linter skips quoting on reserved words", { linter <- keyword_quote_linter() - expect_lint("c(`next` = 1, `while` = 2)", NULL, linter) - expect_lint("switch(x, `for` = 3, `TRUE` = 4)", NULL, linter) - expect_lint("list('NA' = 5, 'Inf' = 6)", NULL, linter) + expect_no_lint("c(`next` = 1, `while` = 2)", linter) + expect_no_lint("switch(x, `for` = 3, `TRUE` = 4)", linter) + expect_no_lint("list('NA' = 5, 'Inf' = 6)", linter) }) test_that("keyword_quote_linter works on more common functions", { @@ -91,16 +87,16 @@ test_that("keyword_quote_linter blocks quoted assignment targets", { expect_lint('"foo bar" <- 1', backtick_msg, linter) expect_lint("'foo bar' = 1", backtick_msg, linter) # valid choice: use backticks - expect_lint("`foo bar` = 1", NULL, linter) + expect_no_lint("`foo bar` = 1", linter) expect_lint('"foo" <- 1', assign_msg, linter) expect_lint("'foo' = 1", assign_msg, linter) expect_lint("`foo` = 1", assign_msg, linter) # don't include data.table assignments - expect_lint('DT[, "a" := 1]', NULL, linter) - expect_lint("DT[, 'a' := 1]", NULL, linter) - expect_lint("DT[, `a` := 1]", NULL, linter) + expect_no_lint('DT[, "a" := 1]', linter) + expect_no_lint("DT[, 'a' := 1]", linter) + expect_no_lint("DT[, `a` := 1]", linter) # include common use cases: [<-/$ methods and infixes expect_lint('"$.my_class" <- function(x, key) { }', backtick_msg, linter) @@ -109,7 +105,7 @@ test_that("keyword_quote_linter blocks quoted assignment targets", { # right assignment expect_lint('1 -> "foo"', assign_msg, linter) - expect_lint("1 -> foo", NULL, linter) + expect_no_lint("1 -> foo", linter) expect_lint('1 -> "a b"', backtick_msg, linter) }) @@ -124,8 +120,8 @@ test_that("keyword_quote_linter blocks quoted $, @ extractions", { # nofuzz expect_lint('x@"foo bar" <- 1', backtick_msg, linter) expect_lint("x@'foo bar' = 1", backtick_msg, linter) # valid choice: non-syntactic name with backticks - expect_lint("x@`foo bar` <- 1", NULL, linter) - expect_lint("x@`foo bar` = 1", NULL, linter) + expect_no_lint("x@`foo bar` <- 1", linter) + expect_no_lint("x@`foo bar` = 1", linter) expect_lint('x$"foo" <- 1', dollar_msg, linter) expect_lint("x$'foo' = 1", dollar_msg, linter) From aa756e6c70ae3cff2a02e148f4ada6e366fa129f Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 19:53:34 +0000 Subject: [PATCH 48/57] more expect_no_lint --- tests/testthat/test-object_usage_linter.R | 150 +++++++++++----------- 1 file changed, 76 insertions(+), 74 deletions(-) diff --git a/tests/testthat/test-object_usage_linter.R b/tests/testthat/test-object_usage_linter.R index 88bb4a1ac..cd9172619 100644 --- a/tests/testthat/test-object_usage_linter.R +++ b/tests/testthat/test-object_usage_linter.R @@ -2,20 +2,19 @@ test_that("returns the correct linting", { linter <- object_usage_linter() local_var_msg <- rex::rex("local variable", anything, "assigned but may not be used") - expect_lint("blah", NULL, linter) + expect_no_lint("blah", linter) - expect_lint( + expect_no_lint( trim_some(" function() { a <- 1 a } "), - NULL, linter ) - expect_lint( + expect_no_lint( trim_some(" fun <- function(x) { fun(1) @@ -24,7 +23,6 @@ test_that("returns the correct linting", { fun2(2) } "), - NULL, linter ) @@ -154,22 +152,20 @@ test_that("replace_functions_stripped", { }) test_that("eval errors are ignored", { - expect_lint( + expect_no_lint( trim_some(' setMethod("[[<-", c("stampedEnv", "character", "missing"), function(x) { x }) '), - NULL, object_usage_linter() ) }) test_that("calls with top level function definitions are ignored", { - expect_lint( + expect_no_lint( 'tryCatch("foo", error = function(e) e)', - NULL, object_usage_linter() ) }) @@ -191,7 +187,7 @@ test_that("object-usage line-numbers are relative to start-of-file", { test_that("used symbols are detected correctly", { # From #666 - expect_lint( + expect_no_lint( trim_some(' foo <- data.frame(0) foo$bar <- 1 @@ -200,7 +196,6 @@ test_that("used symbols are detected correctly", { } message(zero()) '), - NULL, object_usage_linter() ) @@ -217,7 +212,7 @@ test_that("used symbols are detected correctly", { ) # Also test deeper nesting - expect_lint( + expect_no_lint( trim_some(' foo <- list(0) foo$bar$baz$goo <- 1 @@ -229,12 +224,11 @@ test_that("used symbols are detected correctly", { } message(zero()) '), - NULL, object_usage_linter() ) # Test alternative assignment and access methods - expect_lint( + expect_no_lint( trim_some(' foo <- list(0) foo[["bar"]][["baz"]][["goo"]] <- 1 @@ -249,14 +243,13 @@ test_that("used symbols are detected correctly", { } message(zero()) '), - NULL, object_usage_linter() ) # regression #1322 - expect_silent(expect_lint("assign('x', 42)", NULL, object_usage_linter())) + expect_silent(expect_no_lint("assign('x', 42)", object_usage_linter())) }) test_that("object_usage_linter finds lints spanning multiple lines", { @@ -312,7 +305,7 @@ test_that("global variable detection works", { utils::globalVariables("global_function", package = globalenv()) on.exit(utils::globalVariables(old_globals, package = globalenv(), add = FALSE)) - expect_lint( + expect_no_lint( trim_some(" foo <- function() { if (global_function()) NULL @@ -322,7 +315,6 @@ test_that("global variable detection works", { } } "), - NULL, object_usage_linter() ) }) @@ -335,9 +327,8 @@ test_that("package detection works", { }) test_that("robust against errors", { - expect_lint( + expect_no_lint( 'assign("x", unknown_function)', - NULL, object_usage_linter() ) }) @@ -345,47 +336,62 @@ test_that("robust against errors", { test_that("interprets glue expressions", { linter <- object_usage_linter() - expect_lint(trim_some(" - fun <- function() { - local_var <- 42 - glue::glue('The answer is {local_var}.') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + fun <- function() { + local_var <- 42 + glue::glue('The answer is {local_var}.') + } + "), + linter + ) # no need for namespace-qualification - expect_lint(trim_some(" - glue <- glue::glue # imitate this being an @import - fun <- function() { - local_var <- 42 - glue('The answer is {local_var}.') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + glue <- glue::glue # imitate this being an @import + fun <- function() { + local_var <- 42 + glue('The answer is {local_var}.') + } + "), + linter + ) # multiple variables in different interpolations - expect_lint(trim_some(" - fun <- function() { - local_key <- 'a' - local_value <- 123 - glue::glue('Key-value pair: {local_key}={local_value}.') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + fun <- function() { + local_key <- 'a' + local_value <- 123 + glue::glue('Key-value pair: {local_key}={local_value}.') + } + "), + linter + ) # multiple variables in single interpolation - expect_lint(trim_some(" - fun <- function() { - local_str1 <- 'a' - local_str2 <- 'b' - glue::glue('With our powers combined: {paste(local_str1, local_str2)}.') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + fun <- function() { + local_str1 <- 'a' + local_str2 <- 'b' + glue::glue('With our powers combined: {paste(local_str1, local_str2)}.') + } + "), + linter + ) # Check non-standard .open and .close - expect_lint(trim_some(" - fun <- function() { - local_var <- 42 - glue::glue('The answer is $[local_var].', .open = '$[', .close = ']') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + fun <- function() { + local_var <- 42 + glue::glue('The answer is $[local_var].', .open = '$[', .close = ']') + } + "), + linter + ) # Steer clear of custom .transformer and .envir constructs expect_lint(trim_some(" @@ -434,13 +440,16 @@ test_that("interprets glue expressions", { ) # ditto infix operator - expect_lint(trim_some(" - glue <- glue::glue # imitate this being an @import - foo <- function() { - `%++%` <- `+` - glue('{x %++% y}') - } - "), NULL, linter) + expect_no_lint( + trim_some(" + glue <- glue::glue # imitate this being an @import + foo <- function() { + `%++%` <- `+` + glue('{x %++% y}') + } + "), + linter + ) }) test_that("errors/edge cases in glue syntax don't fail lint()", { @@ -448,7 +457,7 @@ test_that("errors/edge cases in glue syntax don't fail lint()", { # no lint & no error, despite glue error expect_warning( - expect_lint( + expect_no_lint( trim_some(" fun <- function() { a <- 2 @@ -456,7 +465,6 @@ test_that("errors/edge cases in glue syntax don't fail lint()", { glue::glue('The answer is {a') } "), - NULL, linter ), "Evaluating glue expression.*failed: Expecting '\\}'.*Please ensure correct glue syntax" @@ -490,19 +498,18 @@ test_that("errors/edge cases in glue syntax don't fail lint()", { ) # empty glue expression {} - expect_lint( + expect_no_lint( trim_some(" fun <- function() { a <- 2 glue::glue('The answer is {}: {a}') } "), - NULL, linter ) # comment inside glue range (#1919) - expect_lint( + expect_no_lint( trim_some(" fun <- function() { a <- 2 @@ -511,7 +518,6 @@ test_that("errors/edge cases in glue syntax don't fail lint()", { ) } "), - NULL, linter ) }) @@ -539,7 +545,7 @@ test_that("backtick'd names in glue are handled", { # reported as #1088 test_that("definitions below top level are ignored (for now)", { - expect_lint( + expect_no_lint( trim_some(" local({ x <- 1 @@ -548,7 +554,6 @@ test_that("definitions below top level are ignored (for now)", { } }) "), - NULL, object_usage_linter() ) }) @@ -567,7 +572,7 @@ test_that("package imports are detected if present in file", { object_usage_linter() ) - expect_lint( + expect_no_lint( trim_some(" library(xml2) @@ -576,7 +581,6 @@ test_that("package imports are detected if present in file", { a } "), - NULL, object_usage_linter() ) }) @@ -640,7 +644,7 @@ test_that("respects `skip_with` argument for `with()` expressions", { }) test_that("missing libraries don't cause issue", { - expect_lint( + expect_no_lint( trim_some(" library(a.a.a.z.z.z) foo <- function() { @@ -648,7 +652,6 @@ test_that("missing libraries don't cause issue", { a } "), - NULL, object_usage_linter() ) }) @@ -842,7 +845,7 @@ test_that("messages without location info are repaired", { test_that("globals in scripts are found regardless of assignment operator", { linter <- object_usage_linter() - expect_lint( + expect_no_lint( trim_some(" library(dplyr) @@ -856,7 +859,6 @@ test_that("globals in scripts are found regardless of assignment operator", { mutate(power = global_const_eq + global_const_ra + global_const_la) } "), - NULL, linter ) }) From c3a99ce41c419a5f9f4141efac4c83d8aed36a27 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 7 Mar 2025 21:05:29 +0000 Subject: [PATCH 49/57] add tests of include_s4_slots --- tests/testthat/test-get_source_expressions.R | 41 ++++++++++++++------ 1 file changed, 29 insertions(+), 12 deletions(-) diff --git a/tests/testthat/test-get_source_expressions.R b/tests/testthat/test-get_source_expressions.R index bbda9d362..975a152a2 100644 --- a/tests/testthat/test-get_source_expressions.R +++ b/tests/testthat/test-get_source_expressions.R @@ -255,7 +255,14 @@ test_that("returned data structure is complete", { }) test_that("xml_find_function_calls works as intended", { - lines <- c("foo()", "bar()", "foo()", "{ foo(); foo(); bar() }") + lines <- c( + "foo()", + "bar()", + "foo()", + "s4Obj@baz()", + "{ foo(); foo(); bar(); s4Obj@baz() }", + NULL + ) temp_file <- withr::local_tempfile(lines = lines) exprs <- get_source_expressions(temp_file) @@ -270,30 +277,40 @@ test_that("xml_find_function_calls works as intended", { expect_length(exprs$expressions[[2L]]$xml_find_function_calls("foo"), 0L) expect_length(exprs$expressions[[2L]]$xml_find_function_calls("bar"), 1L) - expect_length(exprs$expressions[[4L]]$xml_find_function_calls("foo"), 2L) - expect_length(exprs$expressions[[4L]]$xml_find_function_calls("bar"), 1L) - expect_length(exprs$expressions[[4L]]$xml_find_function_calls(c("foo", "bar")), 3L) + expect_length(exprs$expressions[[5L]]$xml_find_function_calls("foo"), 2L) + expect_length(exprs$expressions[[5L]]$xml_find_function_calls("bar"), 1L) + expect_length(exprs$expressions[[5L]]$xml_find_function_calls(c("foo", "bar")), 3L) # file-level source expression contains all function calls - expect_length(exprs$expressions[[5L]]$xml_find_function_calls("foo"), 4L) - expect_length(exprs$expressions[[5L]]$xml_find_function_calls("bar"), 2L) - expect_length(exprs$expressions[[5L]]$xml_find_function_calls(c("foo", "bar")), 6L) + expect_length(exprs$expressions[[6L]]$xml_find_function_calls("foo"), 4L) + expect_length(exprs$expressions[[6L]]$xml_find_function_calls("bar"), 2L) + expect_length(exprs$expressions[[6L]]$xml_find_function_calls(c("foo", "bar")), 6L) # Also check order is retained: expect_identical( - exprs$expressions[[5L]]$xml_find_function_calls(c("foo", "bar")), - xml_find_all(exprs$expressions[[5L]]$full_xml_parsed_content, "//SYMBOL_FUNCTION_CALL/parent::expr") + exprs$expressions[[6L]]$xml_find_function_calls(c("foo", "bar")), + xml_find_all(exprs$expressions[[6L]]$full_xml_parsed_content, "//SYMBOL_FUNCTION_CALL/parent::expr") ) # Check naming and full cache expect_identical( - exprs$expressions[[5L]]$xml_find_function_calls(NULL), - exprs$expressions[[5L]]$xml_find_function_calls(c("foo", "bar")) + exprs$expressions[[6L]]$xml_find_function_calls(NULL), + exprs$expressions[[6L]]$xml_find_function_calls(c("foo", "bar")) ) expect_named( - exprs$expressions[[4L]]$xml_find_function_calls(c("foo", "bar"), keep_names = TRUE), + exprs$expressions[[5L]]$xml_find_function_calls(c("foo", "bar"), keep_names = TRUE), c("foo", "foo", "bar") ) + + # include_s4_slots + expect_identical( + exprs$expressions[[6L]]$xml_find_function_calls(NULL, include_s4_slots = TRUE), + exprs$expressions[[6L]]$xml_find_function_calls(c("foo", "bar", "baz"), include_s4_slots = TRUE) + ) + expect_named( + exprs$expressions[[5L]]$xml_find_function_calls(NULL, keep_names = TRUE, include_s4_slots = TRUE), + c("foo", "foo", "bar", "baz") + ) }) test_that("#1262: xml_parsed_content gets returned as missing even if there's no parsed_content", { From ee9b446e0686837c98c856d405fa81d81713d768 Mon Sep 17 00:00:00 2001 From: AshesITR Date: Thu, 24 Jul 2025 22:20:27 +0200 Subject: [PATCH 50/57] remove empty line --- NEWS.md | 1 - 1 file changed, 1 deletion(-) diff --git a/NEWS.md b/NEWS.md index d3df2e442..e49dc2916 100644 --- a/NEWS.md +++ b/NEWS.md @@ -47,7 +47,6 @@ * `object_usage_linter()` lints missing packages that may cause false positives (#2872, @AshesITR) * New argument `include_s4_slots` for the `xml_find_function_calls()` entry in the `get_source_expressions()` to govern whether calls of the form `s4Obj@fun()` are included in the result (#2820, @MichaelChirico). - ### New linters * `download_file_linter()` encourages the use of `mode = "wb"` (or `mode = "ab"`) when using `download.file()`, rather than `mode = "w"` or `mode = "a"`, as the latter can produce broken From 50b88328282960f1d6a399668bf60fd8cb102bbc Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:23:06 -0700 Subject: [PATCH 51/57] revert --- tests/testthat/test-pipe_continuation_linter.R | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/tests/testthat/test-pipe_continuation_linter.R b/tests/testthat/test-pipe_continuation_linter.R index 566848505..89633f6b2 100644 --- a/tests/testthat/test-pipe_continuation_linter.R +++ b/tests/testthat/test-pipe_continuation_linter.R @@ -158,14 +158,12 @@ local({ test_data <- diamonds %>% head(10) %>% tail(5) }) "), "three inside test_that()", - trim_some( - " - { - x <- a %>% b %>% c - y <- c %>% b %>% a - } - " - ), "two different single-line pipelines", + trim_some(" + { + x <- a %>% b %>% c + y <- c %>% b %>% a + } + "), "two different single-line pipelines", trim_some(" my_fun <- function() { a %>% From 4f95e406525ec1f96e35af795f2ec7e157b7e260 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:25:36 -0700 Subject: [PATCH 52/57] revert --- tests/testthat/test-commented_code_linter.R | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tests/testthat/test-commented_code_linter.R b/tests/testthat/test-commented_code_linter.R index 8809335de..80143631f 100644 --- a/tests/testthat/test-commented_code_linter.R +++ b/tests/testthat/test-commented_code_linter.R @@ -92,13 +92,15 @@ test_that("commented_code_linter can detect operators in comments and lint corre expect_no_lint(paste("# something like i", op, "1", collapse = ""), linter) expect_lint(paste("# i", op, "1", collapse = ""), lint_msg, linter) } +}) +test_that("commented_code_linter can detect operators in comments and lint correctly", { skip_if_not_r_version("4.1.0") expect_lint( "# 1:3 |> sum()", rex::rex("Remove commented code."), - linter + commented_code_linter() ) }) From ebab6048e64da55b728164206a2b531ef4d71270 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:26:49 -0700 Subject: [PATCH 53/57] revert --- tests/testthat/test-pipe_consistency_linter.R | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/tests/testthat/test-pipe_consistency_linter.R b/tests/testthat/test-pipe_consistency_linter.R index 97243fae4..2197fa329 100644 --- a/tests/testthat/test-pipe_consistency_linter.R +++ b/tests/testthat/test-pipe_consistency_linter.R @@ -3,7 +3,6 @@ test_that("pipe_consistency skips allowed usage", { skip_if_not_r_version("4.1.0") linter <- pipe_consistency_linter() - expect_no_lint("1:3 %>% mean() %>% as.character()", linter) expect_no_lint("1:3 |> mean() |> as.character()", linter) # With no pipes expect_no_lint("x <- 1:5", linter) @@ -135,7 +134,10 @@ test_that("pipe_consistency_linter works with %>% argument", { linter ) - expect_no_lint("1:3 %>% mean() %>% as.character()", linter) + expect_no_lint( + "1:3 %>% mean() %>% as.character()", + linter + ) expect_lint( trim_some(" From 2a1ebe27b2686dcf87cd1c8c596a9135a42364fc Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:33:06 -0700 Subject: [PATCH 54/57] failed merge? --- tests/testthat/test-object_usage_linter.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/testthat/test-object_usage_linter.R b/tests/testthat/test-object_usage_linter.R index 66d786c70..7efc4025b 100644 --- a/tests/testthat/test-object_usage_linter.R +++ b/tests/testthat/test-object_usage_linter.R @@ -643,7 +643,7 @@ test_that("respects `skip_with` argument for `with()` expressions", { }) test_that("missing libraries don't cause issue", { - expect_no_lint( + expect_lint( trim_some(" library(a.a.a.z.z.z) foo <- function() { From 4870ecb675a97aab80e61fd8b58f86d1446ecb70 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:42:55 -0700 Subject: [PATCH 55/57] narrow line --- R/function_left_parentheses_linter.R | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/R/function_left_parentheses_linter.R b/R/function_left_parentheses_linter.R index de0d9a41d..f3e4af5bf 100644 --- a/R/function_left_parentheses_linter.R +++ b/R/function_left_parentheses_linter.R @@ -47,7 +47,8 @@ function_left_parentheses_linter <- function() { # nolint: object_length. # because it allows the xpath to be the same for both FUNCTION and SYMBOL_FUNCTION_CALL. # Further, write 4 separate XPaths because the 'range_end_xpath' differs for these two nodes. bad_line_fun_xpath <- "(//FUNCTION | //OP-LAMBDA)[@line1 != following-sibling::OP-LEFT-PAREN/@line1]" - bad_line_call_xpath <- "(//SYMBOL_FUNCTION_CALL | //SLOT)[@line1 != parent::expr/following-sibling::OP-LEFT-PAREN/@line1]" + bad_line_call_xpath <- + "(//SYMBOL_FUNCTION_CALL | //SLOT)[@line1 != parent::expr/following-sibling::OP-LEFT-PAREN/@line1]" bad_col_fun_xpath <- "(//FUNCTION | //OP-LAMBDA)[ @line1 = following-sibling::OP-LEFT-PAREN/@line1 and @col2 != following-sibling::OP-LEFT-PAREN/@col1 - 1 From 83aa12eaf58d03a5341184a2ce86e8d7da8cb8f6 Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Thu, 24 Jul 2025 13:43:22 -0700 Subject: [PATCH 56/57] trailing ws --- tests/testthat/test-is_numeric_linter.R | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tests/testthat/test-is_numeric_linter.R b/tests/testthat/test-is_numeric_linter.R index d0026e1f7..aa3093775 100644 --- a/tests/testthat/test-is_numeric_linter.R +++ b/tests/testthat/test-is_numeric_linter.R @@ -30,7 +30,7 @@ test_that("is_numeric_linter blocks disallowed usages involving ||", { # identical expressions match too expect_lint( # nofuzz "is.integer(DT$x) || is.numeric(DT$x)", - lint_msg, + lint_msg, linter ) From c11dc399ab65077ff0600182c5ac87aff1e7fe6c Mon Sep 17 00:00:00 2001 From: Michael Chirico Date: Fri, 25 Jul 2025 14:41:56 -0700 Subject: [PATCH 57/57] use parallel branching --- R/source_utils.R | 19 ++++++++++++------- 1 file changed, 12 insertions(+), 7 deletions(-) diff --git a/R/source_utils.R b/R/source_utils.R index b558eac61..a9014fb63 100644 --- a/R/source_utils.R +++ b/R/source_utils.R @@ -18,15 +18,20 @@ build_xml_find_function_calls <- function(xml) { function(function_names, keep_names = FALSE, include_s4_slots = FALSE) { if (is.null(function_names)) { - res <- function_call_cache - } else { - res <- function_call_cache[names(function_call_cache) %in% function_names] - } - if (include_s4_slots) { - if (is.null(function_names)) { + if (include_s4_slots) { res <- combine_nodesets(function_call_cache, s4_slot_cache) } else { - res <- combine_nodesets(function_call_cache, s4_slot_cache[names(s4_slot_cache) %in% function_names]) + res <- function_call_cache + } + } else { + include_function_idx <- names(function_call_cache) %in% function_names + if (include_s4_slots) { + res <- combine_nodesets( + function_call_cache[include_function_idx], + s4_slot_cache[names(s4_slot_cache) %in% function_names] + ) + } else { + res <- function_call_cache[include_function_idx] } } if (keep_names) res else unname(res)