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
|
test_that("vector_logic_linter skips allowed usages", {
linter <- vector_logic_linter()
expect_lint("if (TRUE) 5 else if (TRUE) 2", NULL, linter)
expect_lint("if (TRUE || FALSE) 1; while (TRUE && FALSE) 2", NULL, linter)
# function calls and extractions may aggregate to scalars -- only catch
# usages at the highest logical level
expect_lint("if (agg_function(x & y)) 1", NULL, linter)
expect_lint("if (DT[x | y, cond]) 1", NULL, linter)
# don't match potentially OK usages nested within calls
expect_lint("if (TRUE && any(TRUE | FALSE)) 4", NULL, linter)
# even if the usage is nested in those calls (b/181915948)
expect_lint("if (TRUE && any(TRUE | FALSE | TRUE)) 4", NULL, linter)
# don't match potentially OK usages in the branch itself
lines <- trim_some("
if (TRUE) {
x | y
}
")
expect_lint(lines, NULL, linter)
# valid nested usage within aggregator
expect_lint("testthat::expect_false(any(TRUE | TRUE))", NULL, linter)
})
test_that("vector_logic_linter blocks simple disallowed usages", {
linter <- vector_logic_linter()
expect_lint("if (TRUE & FALSE) 1", rex::rex("Use `&&` in conditional expressions."), linter)
expect_lint("while (TRUE | TRUE) 2", rex::rex("Use `||` in conditional expressions."), linter)
})
test_that("vector_logic_linter detects nested conditions", {
linter <- vector_logic_linter()
expect_lint(
"if (TRUE & TRUE || FALSE) 4",
list(rex::rex("Use `&&` in conditional expressions."), column_number = 10L),
linter
)
expect_lint(
"if (TRUE && (TRUE | FALSE)) 4",
list(rex::rex("Use `||` in conditional expressions."), column_number = 19L),
linter
)
})
test_that("vector_logic_linter catches usages in expect_true()/expect_false()", {
linter <- vector_logic_linter()
and_msg <- rex::rex("Use `&&` in conditional expressions.")
or_msg <- rex::rex("Use `||` in conditional expressions.")
expect_lint("expect_true(TRUE & FALSE)", and_msg, linter)
expect_lint("expect_false(TRUE | TRUE)", or_msg, linter)
# ditto with namespace qualification
expect_lint("testthat::expect_true(TRUE & FALSE)", and_msg, linter)
expect_lint("testthat::expect_false(TRUE | TRUE)", or_msg, linter)
})
test_that("vector_logic_linter doesn't get mixed up from complex usage", {
expect_lint(
trim_some("
if (a) {
expect_true(ok)
x <- 2
a | b
}
"),
NULL,
vector_logic_linter()
)
})
test_that("vector_logic_linter recognizes some false positves around bitwise &/|", {
linter <- vector_logic_linter()
expect_lint("if (info & as.raw(12)) { }", NULL, linter)
expect_lint("if (as.raw(12) & info) { }", NULL, linter)
expect_lint("if (info | as.raw(12)) { }", NULL, linter)
expect_lint("if (info & as.octmode('100')) { }", NULL, linter)
expect_lint("if (info | as.octmode('011')) { }", NULL, linter)
expect_lint("if (info & as.hexmode('100')) { }", NULL, linter)
expect_lint("if (info | as.hexmode('011')) { }", NULL, linter)
# implicit as.octmode() coercion
expect_lint("if (info & '100') { }", NULL, linter)
expect_lint("if (info | '011') { }", NULL, linter)
expect_lint("if ('011' | info) { }", NULL, linter)
# further nesting
expect_lint("if ((info & as.raw(12)) == as.raw(12)) { }", NULL, linter)
expect_lint("if ((info | as.raw(12)) == as.raw(12)) { }", NULL, linter)
expect_lint('if ((mode & "111") != as.octmode("111")) { }', NULL, linter)
expect_lint('if ((mode | "111") != as.octmode("111")) { }', NULL, linter)
expect_lint('if ((mode & "111") != as.hexmode("111")) { }', NULL, linter)
expect_lint('if ((mode | "111") != as.hexmode("111")) { }', NULL, linter)
})
test_that("incorrect subset/filter usage is caught", {
linter <- vector_logic_linter()
and_msg <- rex::rex("Use `&` in subsetting expressions")
or_msg <- rex::rex("Use `|` in subsetting expressions")
expect_lint("filter(x, y && z)", and_msg, linter)
expect_lint("filter(x, y || z)", or_msg, linter)
expect_lint("subset(x, y && z)", and_msg, linter)
expect_lint("subset(x, y || z)", or_msg, linter)
expect_lint("x %>% filter(y && z)", and_msg, linter)
expect_lint("filter(x, a & b, c | d, e && f)", list(and_msg, column_number = 27L), linter)
})
test_that("native pipe usage is caught in subset/filter logic", {
skip_if_not_r_version("4.1.0")
expect_lint("x |> filter(y && z)", rex::rex("Use `&` in subsetting"), vector_logic_linter())
})
test_that("subsetting logic handles nesting", {
linter <- vector_logic_linter()
and_msg <- rex::rex("Use `&` in subsetting expressions")
or_msg <- rex::rex("Use `|` in subsetting expressions")
expect_lint("filter(x, a & b || c)", or_msg, linter)
expect_lint("filter(x, a && b | c)", and_msg, linter)
# but not valid usage
expect_lint("filter(x, y < mean(y, na.rm = AA && BB))", NULL, linter)
expect_lint("subset(x, y < mean(y, na.rm = AA && BB) & y > 0)", NULL, linter)
expect_lint("subset(x, y < x[y > 0, drop = AA && BB, y])", NULL, linter)
})
test_that("filter() handling is conservative about stats::filter()", {
linter <- vector_logic_linter()
and_msg <- rex::rex("Use `&` in subsetting expressions")
# NB: this should be invalid, filter= is a vector argument
expect_lint("stats::filter(x, y && z)", NULL, linter)
# The only logical argument to stats::filter(), exclude by keyword
expect_lint("filter(x, circular = y && z)", NULL, linter)
# But presence of circular= doesn't invalidate lint
expect_lint("filter(x, circular = TRUE, y && z)", and_msg, linter)
expect_lint("filter(x, y && z, circular = TRUE)", and_msg, linter)
expect_lint(
trim_some("
filter(x, circular # comment
= y && z)
"),
NULL,
linter
)
expect_lint(
trim_some("
filter(x, circular = # comment
y && z)
"),
NULL,
linter
)
expect_lint(
trim_some("
filter(x, circular # comment
= # comment
y && z)
"),
NULL,
linter
)
})
test_that("lints vectorize", {
expect_lint(
trim_some("{
if (AA & BB) {}
if (CC | DD) {}
filter(x, EE && FF)
subset(y, GG || HH)
}"),
list(
list(rex::rex("`&&`"), line_number = 2L),
list(rex::rex("`||`"), line_number = 3L),
list(rex::rex("`&`"), line_number = 4L),
list(rex::rex("`|`"), line_number = 5L)
),
vector_logic_linter()
)
})
|
