1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
|
test_that("fixed_regex_linter skips allowed usages", {
linter <- fixed_regex_linter()
expect_lint("gsub('^x', '', y)", NULL, linter)
expect_lint("grep('x$', '', y)", NULL, linter)
expect_lint("sub('[a-zA-Z]', '', y)", NULL, linter)
expect_lint("grepl(fmt, y)", NULL, linter)
expect_lint(R"{regexec('\\s', '', y)}", NULL, linter)
expect_lint("grep('a(?=b)', x, perl = TRUE)", NULL, linter)
expect_lint("grep('0+1', x, perl = TRUE)", NULL, linter)
expect_lint("grep('1*2', x)", NULL, linter)
expect_lint("grep('a|b', x)", NULL, linter)
expect_lint(R"{grep('\\[|\\]', x)}", NULL, linter)
# if fixed=TRUE is already set, regex patterns don't matter
expect_lint(R"{gsub('\\.', '', y, fixed = TRUE)}", NULL, linter)
# ignore.case=TRUE implies regex interpretation
expect_lint("gsub('abcdefg', '', y, ignore.case = TRUE)", NULL, linter)
# char classes starting with [] might contain other characters -> not fixed
expect_lint("sub('[][]', '', y)", NULL, linter)
expect_lint("sub('[][ ]', '', y)", NULL, linter)
expect_lint("sub('[],[]', '', y)", NULL, linter)
# wrapper functions don't throw
expect_lint("gregexpr(pattern = pattern, data, perl = TRUE, ...)", NULL, linter)
})
test_that("fixed_regex_linter blocks simple disallowed usages", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint(R"{gsub('\\.', '', x)}", lint_msg, linter)
expect_lint("grepl('abcdefg', x)", lint_msg, linter)
expect_lint("gregexpr('a-z', y)", lint_msg, linter)
expect_lint(R"{regexec('\\$', x)}", lint_msg, linter)
expect_lint("grep('\n', x)", lint_msg, linter)
# naming the argument doesn't matter (if it's still used positionally)
expect_lint("gregexpr(pattern = 'a-z', y)", lint_msg, linter)
})
patrick::with_parameters_test_that(
"fixed_regex_linter is robust to unrecognized escapes error for {char}",
{
expect_lint(
sprintf(R"{grep('\\%s', x)}", char),
rex::rex("This regular expression is static"),
fixed_regex_linter()
)
expect_lint(
sprintf(R"{strsplit('a%sb', '\\%s')}", char, char),
rex::rex("This regular expression is static"),
fixed_regex_linter()
)
},
char = c(
"^", "$", "{", "}", "(", ")", ".", "*", "+", "?",
"|", "[", "]", R"(\\)", "<", ">", "=", ":", ";", "/",
"_", "-", "!", "@", "#", "%", "&", "~"
)
)
test_that("fixed_regex_linter catches regex like [.] or [$]", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint("grep('[.]', x)", lint_msg, linter)
expect_lint("grepl('a[*]b', x)", lint_msg, linter)
# also catch char classes for [ and ]
expect_lint("gregexpr('[]]', x)", lint_msg, linter)
})
test_that("fixed_regex_linter catches null calls to strsplit as well", {
linter <- fixed_regex_linter()
expect_lint("strsplit(x, '^x')", NULL, linter)
expect_lint(R"{strsplit(x, '\\s')}", NULL, linter)
expect_lint("strsplit(x, 'a(?=b)', perl = TRUE)", NULL, linter)
expect_lint("strsplit(x, '0+1', perl = TRUE)", NULL, linter)
expect_lint("strsplit(x, 'a|b')", NULL, linter)
expect_lint("tstrsplit(x, '1*2')", NULL, linter)
expect_lint("tstrsplit(x, '[a-zA-Z]')", NULL, linter)
expect_lint("tstrsplit(x, fmt)", NULL, linter)
# if fixed=TRUE is already set, regex patterns don't matter
expect_lint(R"{strsplit(x, '\\.', fixed = TRUE)}", NULL, linter)
expect_lint(R"{strsplit(x, '\\.', fixed = T)}", NULL, linter)
})
test_that("fixed_regex_linter catches calls to strsplit as well", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint(R"{strsplit(x, '\\.')}", lint_msg, linter)
expect_lint("strsplit(x, '[.]')", lint_msg, linter)
expect_lint("tstrsplit(x, 'abcdefg')", lint_msg, linter)
})
test_that("fixed_regex_linter is more exact about distinguishing \\s from \\:", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint(R"{grep('\\s', '', x)}", NULL, linter)
expect_lint(R"{grep('\\:', '', x)}", lint_msg, linter)
})
## tests for stringr functions
test_that("fixed_regex_linter skips allowed stringr usages", {
linter <- fixed_regex_linter()
expect_lint("str_replace(y, '[a-zA-Z]', '')", NULL, linter)
expect_lint("str_replace_all(y, '^x', '')", NULL, linter)
expect_lint("str_detect(y, fmt)", NULL, linter)
expect_lint(R"{str_extract(y, '\\s')}", NULL, linter)
expect_lint(R"{str_extract_all(y, '\\s')}", NULL, linter)
expect_lint("str_which(x, '1*2')", NULL, linter)
# if fixed() is already set, regex patterns don't matter
expect_lint(R"{str_replace(y, fixed('\\.'), '')}", NULL, linter)
# namespace qualification doesn't matter
expect_lint("stringr::str_replace(y, stringr::fixed('abcdefg'), '')", NULL, linter)
})
test_that("fixed_regex_linter blocks simple disallowed usages of stringr functions", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint(R"{str_replace_all(x, '\\.', '')}", lint_msg, linter)
expect_lint("str_detect(x, 'abcdefg')", lint_msg, linter)
expect_lint("str_locate(y, 'a-z')", lint_msg, linter)
expect_lint(R"{str_subset(x, '\\$')}", lint_msg, linter)
expect_lint("str_which(x, '\n')", lint_msg, linter)
# named, positional arguments are still caught
expect_lint("str_locate(y, pattern = 'a-z')", lint_msg, linter)
# nor do other named arguments throw things off
expect_lint(R"{str_starts(x, '\\.', negate = TRUE)}", lint_msg, linter)
})
test_that("fixed_regex_linter catches calls to str_split as well", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint("str_split(x, '^x')", NULL, linter)
expect_lint("str_split(x, fmt)", NULL, linter)
# if fixed() is already set, regex patterns don't matter
expect_lint(R"{str_split(x, fixed('\\.'))}", NULL, linter)
expect_lint(R"{str_split(x, '\\.')}", lint_msg, linter)
expect_lint("str_split(x, '[.]')", lint_msg, linter)
})
test_that("str_replace_all's multi-replacement version is handled", {
linter <- fixed_regex_linter()
# While each of the replacements is fixed, and this _could_ in principle be replaced by
# a pipeline where each step does one of the replacements and fixed() is used, this is overkill.
# Instead, ensure that no lint is returned for this case
expect_lint('str_replace_all(x, c("one" = "1", "two" = "2", "three" = "3"))', NULL, linter)
expect_lint('grepl(c("a" = "b"), x)', NULL, linter)
})
test_that("1- or 2-width octal escape sequences are handled", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint('strsplit(x, "\\1")', lint_msg, linter)
})
test_that("one-character character classes with escaped characters are caught", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint(R"{gsub('[\n]', '', x)}", lint_msg, linter)
expect_lint(R"{gsub('[\"]', '', x)}", lint_msg, linter)
expect_lint(R'{gsub("\\<", "x", x, perl = TRUE)}', lint_msg, linter)
expect_lint(R"{str_split(x, '[\1]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\12]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\123]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\xa]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\x32]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\uF]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\u01]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\u012]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\u0123]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\U8]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\U1d4d7]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\u{1}]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\U{F7D5}]')}", lint_msg, linter)
expect_lint(R"{str_split(x, '[\U{1D4D7}]')}", lint_msg, linter)
})
test_that("bracketed unicode escapes are caught", {
linter <- fixed_regex_linter()
lint_msg <- rex::rex("This regular expression is static")
expect_lint('gsub("\\u{A0}", " ", out, useBytes = TRUE)', lint_msg, linter)
expect_lint('gsub("abc\\U{A0DEF}ghi", " ", out, useBytes = TRUE)', lint_msg, linter)
expect_lint('gsub("\\u{A0}\\U{0001d4d7}", " ", out, useBytes = TRUE)', lint_msg, linter)
})
test_that("escaped characters are handled correctly", {
linter <- fixed_regex_linter()
expect_lint(R"{gsub('\n+', '', sql)}", NULL, linter)
expect_lint('gsub("\\n{2,}", "\n", D)', NULL, linter)
expect_lint(R'{gsub("[\r\n]", "", x)}', NULL, linter)
expect_lint(R'{gsub("\n $", "", y)}', NULL, linter)
expect_lint(R'{gsub("```\n*```r*\n*", "", x)}', NULL, linter)
expect_lint('strsplit(x, "(;|\n)")', NULL, linter)
expect_lint(R'{strsplit(x, "(;|\n)")}', NULL, linter)
expect_lint(R'{grepl("[\\W]", x, perl = TRUE)}', NULL, linter)
expect_lint(R'{grepl("[\\W]", x)}', NULL, linter)
})
# make sure the logic is properly vectorized
test_that("single expression with multiple regexes is OK", {
expect_lint('c(grep("^a", x), grep("b$", x))', NULL, fixed_regex_linter())
})
test_that("fixed replacements vectorize and recognize str_detect", {
linter <- fixed_regex_linter()
# properly vectorized
expect_lint(
trim_some(R"({
grepl('abcdefg', x)
grepl('a[.]\\.b\n', x)
})"),
list(
list(rex::rex('Use "abcdefg" with fixed = TRUE'), line_number = 2L),
list(rex::rex('Use "a..b\\n" with fixed = TRUE'), line_number = 3L)
),
linter
)
# stringr hint works
expect_lint(
"str_detect(x, 'abc')",
rex::rex('Use stringr::fixed("abc") as the pattern'),
linter
)
})
test_that("fixed replacement is correct with UTF-8", {
skip_if(
.Platform$OS.type == "windows" && !hasName(R.Version(), "crt"),
message = "UTF-8 support is required"
)
expect_lint(
"grepl('[\\U{1D4D7}]', x)",
rex::rex('Use "\U1D4D7" with fixed = TRUE'),
fixed_regex_linter()
)
})
#' Generate a string with a non-printable Unicode entry robust to test environment
#'
#' Non-printable unicode behaves wildly different with `encodeString()`
#' across R versions and platforms. Nonetheless, all of these expressions
#' are valid replacements.
#' @noRd
robust_non_printable_unicode <- function() {
if (getRversion() < "4.1.0") {
"abc\\U000a0defghi"
} else if (.Platform$OS.type == "windows") {
"abc\U{0a0def}ghi"
} else {
"abc\\U{0a0def}ghi"
}
}
# styler: off
local({
.cases <- tibble::tribble(
~.test_name, ~regex_expr, ~fixed_expr,
"[.]", "[.]", ".",
'[\\\"]', R'([\"])', '\\"',
"[]]", "[]]", "]",
R"(\\.)", R"(\\.)", ".",
R"(\\:)", R"(\\:)", ":",
R"(\\<)", R"(\\<)", "<",
R"(\\$)", R"(\\$)", "$",
R"([\1])", R"([\1])", R"(\001)",
R"(\1)", R"(\1)", R"(\001)",
R"([\12])", R"([\12])", R"(\n)",
R"([\123])", R"([\123])", "S",
"a[*]b", "a[*]b", "a*b",
"abcdefg", "abcdefg", "abcdefg",
"abc\\U{A0DEF}ghi", "abc\\U{A0DEF}ghi", robust_non_printable_unicode(),
"a-z", "a-z", "a-z",
R"([\n])", R"([\n])", R"(\n)",
R"(\n)", "\n", R"(\n)",
R"([\u01])", R"([\u01])", R"(\001)",
R"([\u012])", R"([\u012])", R"(\022)",
R"([\u0123])", R"([\u0123])", "\u0123",
R"([\u{1}])", R"([\u{1}])", R"(\001)",
R"([\U1d4d7])", R"([\U1d4d7])", "\U1D4D7",
R"([\U{1D4D7}])", R"([\U{1D4D7}])", "\U1D4D7",
R"([\U8])", R"([\U8])", R"(\b)",
R"(\u{A0})", R"(\u{A0})", "\uA0",
R"(\u{A0}\U{0001d4d7})", R"(\u{A0}\U{0001d4d7})", "\uA0\U1D4D7",
R"([\uF])", R"([\uF])", R"(\017)",
R"([\U{F7D5}])", R"([\U{F7D5}])", "\UF7D5",
R"([\x32])", R"([\x32])", "2",
R"([\xa])", R"([\xa])", R"(\n)"
)
if (.Platform$OS.type == "windows" && !hasName(R.Version(), "crt")) {
skip_cases <- c(
# These require UTF-8 support
"abc\\U{A0DEF}ghi", "[\\U1d4d7]", "[\\U{1D4D7}]", "\\u{A0}\\U{0001d4d7}",
# R version-specific difference in output message on Windows (probably r80051)
if (getRversion() == "4.0.4") "[\\U{F7D5}]"
)
} else {
skip_cases <- character()
}
patrick::with_parameters_test_that(
"fixed replacements of {regex_expr} with {fixed_expr} is correct",
{
# TODO(google/patrick#19): handle this more cleanly by skipping up-front
skip_if(
regex_expr %in% skip_cases,
sprintf("regex '%s' is not supported on this system", regex_expr)
)
expect_lint(
sprintf("grepl('%s', x)", regex_expr),
rex::rex(sprintf('Use "%s" with fixed = TRUE', fixed_expr)),
fixed_regex_linter()
)
},
.cases = .cases
)
})
# styler: on
test_that("'unescaped' regex can optionally be skipped", {
linter <- fixed_regex_linter(allow_unescaped = TRUE)
expect_lint("grepl('a', x)", NULL, linter)
expect_lint("str_detect(x, 'a')", NULL, linter)
expect_lint("grepl('[$]', x)", rex::rex('Use "$" with fixed = TRUE'), linter)
})
local({
pipes <- pipes(exclude = c("%$%", "%T>%"))
patrick::with_parameters_test_that(
"linter is pipe-aware",
{
linter <- fixed_regex_linter()
lint_msg <- "This regular expression is static"
expect_lint(paste("x", pipe, "grepl(pattern = 'a')"), lint_msg, linter)
expect_lint(paste("x", pipe, "grepl(pattern = '^a')"), NULL, linter)
expect_lint(paste("x", pipe, "grepl(pattern = 'a', fixed = TRUE)"), NULL, linter)
expect_lint(paste("x", pipe, "str_detect('a')"), lint_msg, linter)
expect_lint(paste("x", pipe, "str_detect('^a')"), NULL, linter)
expect_lint(paste("x", pipe, "str_detect(fixed('a'))"), NULL, linter)
expect_lint(paste("x", pipe, "gsub(pattern = 'a', replacement = '')"), lint_msg, linter)
expect_lint(paste("x", pipe, "gsub(pattern = '^a', replacement = '')"), NULL, linter)
expect_lint(paste("x", pipe, "gsub(pattern = 'a', replacement = '', fixed = TRUE)"), NULL, linter)
expect_lint(paste("x", pipe, "str_replace('a', '')"), lint_msg, linter)
expect_lint(paste("x", pipe, "str_replace('^a', '')"), NULL, linter)
expect_lint(paste("x", pipe, "str_replace(fixed('a'), '')"), NULL, linter)
},
pipe = pipes,
.test_name = names(pipes)
)
})
|
