forked from checkstyle/checkstyle
/
VariableDeclarationUsageDistanceCheckTest.java
299 lines (274 loc) · 14.8 KB
/
VariableDeclarationUsageDistanceCheckTest.java
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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
///////////////////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.coding;
import static com.google.common.truth.Truth.assertWithMessage;
import static com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck.MSG_KEY;
import static com.puppycrawl.tools.checkstyle.checks.coding.VariableDeclarationUsageDistanceCheck.MSG_KEY_EXT;
import org.junit.jupiter.api.Test;
import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
public class VariableDeclarationUsageDistanceCheckTest extends
AbstractModuleTestSupport {
@Override
protected String getPackageLocation() {
return "com/puppycrawl/tools/checkstyle/checks/coding/variabledeclarationusagedistance";
}
@Test
public void testGeneralLogic() throws Exception {
final String[] expected = {
"42:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"50:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"56:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"69:9: " + getCheckMessage(MSG_KEY, "count", 2, 1),
"83:9: " + getCheckMessage(MSG_KEY, "count", 4, 1),
"108:9: " + getCheckMessage(MSG_KEY, "arg", 2, 1),
"156:9: " + getCheckMessage(MSG_KEY, "m", 3, 1),
"157:9: " + getCheckMessage(MSG_KEY, "n", 2, 1),
"196:9: " + getCheckMessage(MSG_KEY, "result", 2, 1),
"231:9: " + getCheckMessage(MSG_KEY, "t", 5, 1),
"234:9: " + getCheckMessage(MSG_KEY, "c", 3, 1),
"235:9: " + getCheckMessage(MSG_KEY, "d2", 3, 1),
"272:9: " + getCheckMessage(MSG_KEY, "sel", 2, 1),
"273:9: " + getCheckMessage(MSG_KEY, "model", 2, 1),
"299:9: " + getCheckMessage(MSG_KEY, "sw", 2, 1),
"312:9: " + getCheckMessage(MSG_KEY, "wh", 2, 1),
"355:9: " + getCheckMessage(MSG_KEY, "green", 2, 1),
"356:9: " + getCheckMessage(MSG_KEY, "blue", 3, 1),
"379:9: " + getCheckMessage(MSG_KEY, "intervalMs", 2, 1),
"466:9: " + getCheckMessage(MSG_KEY, "aOpt", 3, 1),
"467:9: " + getCheckMessage(MSG_KEY, "bOpt", 2, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l1", 3, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l2", 2, 1),
"491:9: " + getCheckMessage(MSG_KEY, "myOption", 7, 1),
"503:9: " + getCheckMessage(MSG_KEY, "myOption", 6, 1),
"516:9: " + getCheckMessage(MSG_KEY, "count", 4, 1),
"517:9: " + getCheckMessage(MSG_KEY, "files", 2, 1),
"552:13: " + getCheckMessage(MSG_KEY, "id", 2, 1),
"554:13: " + getCheckMessage(MSG_KEY, "parentId", 3, 1),
"903:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
"913:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
"979:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
"990:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"1001:9: " + getCheckMessage(MSG_KEY, "a", 3, 1),
"1036:9: " + getCheckMessage(MSG_KEY, "c", 3, 1),
"1066:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceGeneral.java"), expected);
}
@Test
public void testGeneralLogic2() throws Exception {
final String[] expected = {
"17:9: " + getCheckMessage(MSG_KEY, "first", 5, 1),
"29:9: " + getCheckMessage(MSG_KEY, "allInvariants", 2, 1),
"59:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"68:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
"78:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"83:9: " + getCheckMessage(MSG_KEY, "b", 2, 1),
"90:9: " + getCheckMessage(MSG_KEY, "c", 3, 1),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceGeneral2.java"), expected);
}
@Test
public void testDistance() throws Exception {
final String[] expected = {
"83:9: " + getCheckMessage(MSG_KEY, "count", 4, 3),
"231:9: " + getCheckMessage(MSG_KEY, "t", 5, 3),
"491:9: " + getCheckMessage(MSG_KEY, "myOption", 7, 3),
"503:9: " + getCheckMessage(MSG_KEY, "myOption", 6, 3),
"516:9: " + getCheckMessage(MSG_KEY, "count", 4, 3),
"903:9: " + getCheckMessage(MSG_KEY, "a", 4, 3),
"913:9: " + getCheckMessage(MSG_KEY, "a", 4, 3),
"979:9: " + getCheckMessage(MSG_KEY, "a", 4, 3),
"1066:9: " + getCheckMessage(MSG_KEY, "a", 4, 3),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistance.java"), expected);
}
@Test
public void testVariableRegExp() throws Exception {
final String[] expected = {
"50:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"56:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"69:9: " + getCheckMessage(MSG_KEY, "count", 2, 1),
"83:9: " + getCheckMessage(MSG_KEY, "count", 4, 1),
"108:9: " + getCheckMessage(MSG_KEY, "arg", 2, 1),
"157:9: " + getCheckMessage(MSG_KEY, "n", 2, 1),
"196:9: " + getCheckMessage(MSG_KEY, "result", 2, 1),
"235:9: " + getCheckMessage(MSG_KEY, "d2", 3, 1),
"272:9: " + getCheckMessage(MSG_KEY, "sel", 2, 1),
"273:9: " + getCheckMessage(MSG_KEY, "model", 2, 1),
"299:9: " + getCheckMessage(MSG_KEY, "sw", 2, 1),
"312:9: " + getCheckMessage(MSG_KEY, "wh", 2, 1),
"355:9: " + getCheckMessage(MSG_KEY, "green", 2, 1),
"356:9: " + getCheckMessage(MSG_KEY, "blue", 3, 1),
"379:9: " + getCheckMessage(MSG_KEY, "intervalMs", 2, 1),
"466:9: " + getCheckMessage(MSG_KEY, "aOpt", 3, 1),
"467:9: " + getCheckMessage(MSG_KEY, "bOpt", 2, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l1", 3, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l2", 2, 1),
"491:9: " + getCheckMessage(MSG_KEY, "myOption", 7, 1),
"503:9: " + getCheckMessage(MSG_KEY, "myOption", 6, 1),
"516:9: " + getCheckMessage(MSG_KEY, "count", 4, 1),
"517:9: " + getCheckMessage(MSG_KEY, "files", 2, 1),
"552:13: " + getCheckMessage(MSG_KEY, "id", 2, 1),
"554:13: " + getCheckMessage(MSG_KEY, "parentId", 3, 1),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceRegExp.java"), expected);
}
@Test
public void testValidateBetweenScopesOption() throws Exception {
final String[] expected = {
"42:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"50:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"56:9: " + getCheckMessage(MSG_KEY, "temp", 2, 1),
"83:9: " + getCheckMessage(MSG_KEY, "count", 4, 1),
"108:9: " + getCheckMessage(MSG_KEY, "arg", 2, 1),
"231:9: " + getCheckMessage(MSG_KEY, "t", 5, 1),
"234:9: " + getCheckMessage(MSG_KEY, "c", 3, 1),
"235:9: " + getCheckMessage(MSG_KEY, "d2", 3, 1),
"312:9: " + getCheckMessage(MSG_KEY, "wh", 2, 1),
"355:9: " + getCheckMessage(MSG_KEY, "green", 2, 1),
"356:9: " + getCheckMessage(MSG_KEY, "blue", 3, 1),
"379:9: " + getCheckMessage(MSG_KEY, "intervalMs", 2, 1),
"466:9: " + getCheckMessage(MSG_KEY, "aOpt", 3, 1),
"467:9: " + getCheckMessage(MSG_KEY, "bOpt", 2, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l1", 3, 1),
"483:9: " + getCheckMessage(MSG_KEY, "l2", 2, 1),
"491:9: " + getCheckMessage(MSG_KEY, "myOption", 7, 1),
"503:9: " + getCheckMessage(MSG_KEY, "myOption", 6, 1),
"517:9: " + getCheckMessage(MSG_KEY, "files", 2, 1),
"552:13: " + getCheckMessage(MSG_KEY, "id", 2, 1),
"554:13: " + getCheckMessage(MSG_KEY, "parentId", 4, 1),
"990:9: " + getCheckMessage(MSG_KEY, "a", 2, 1),
"1036:9: " + getCheckMessage(MSG_KEY, "c", 4, 1),
"1066:9: " + getCheckMessage(MSG_KEY, "a", 4, 1),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceScopes.java"), expected);
}
@Test
public void testIgnoreFinalOption() throws Exception {
final String[] expected = {
"42:9: " + getCheckMessage(MSG_KEY_EXT, "a", 2, 1),
"50:9: " + getCheckMessage(MSG_KEY_EXT, "temp", 2, 1),
"56:9: " + getCheckMessage(MSG_KEY_EXT, "temp", 2, 1),
"69:9: " + getCheckMessage(MSG_KEY_EXT, "count", 2, 1),
"83:9: " + getCheckMessage(MSG_KEY_EXT, "count", 4, 1),
"108:9: " + getCheckMessage(MSG_KEY_EXT, "arg", 2, 1),
"156:9: " + getCheckMessage(MSG_KEY_EXT, "m", 3, 1),
"157:9: " + getCheckMessage(MSG_KEY_EXT, "n", 2, 1),
"196:9: " + getCheckMessage(MSG_KEY_EXT, "result", 2, 1),
"231:9: " + getCheckMessage(MSG_KEY_EXT, "t", 5, 1),
"234:9: " + getCheckMessage(MSG_KEY_EXT, "c", 3, 1),
"235:9: " + getCheckMessage(MSG_KEY_EXT, "d2", 3, 1),
"272:9: " + getCheckMessage(MSG_KEY_EXT, "sel", 2, 1),
"273:9: " + getCheckMessage(MSG_KEY_EXT, "model", 2, 1),
"299:9: " + getCheckMessage(MSG_KEY_EXT, "sw", 2, 1),
"312:9: " + getCheckMessage(MSG_KEY_EXT, "wh", 2, 1),
"355:9: " + getCheckMessage(MSG_KEY_EXT, "green", 2, 1),
"356:9: " + getCheckMessage(MSG_KEY_EXT, "blue", 3, 1),
"466:9: " + getCheckMessage(MSG_KEY_EXT, "aOpt", 3, 1),
"467:9: " + getCheckMessage(MSG_KEY_EXT, "bOpt", 2, 1),
"483:9: " + getCheckMessage(MSG_KEY_EXT, "l1", 3, 1),
"483:9: " + getCheckMessage(MSG_KEY_EXT, "l2", 2, 1),
"491:9: " + getCheckMessage(MSG_KEY_EXT, "myOption", 7, 1),
"503:9: " + getCheckMessage(MSG_KEY_EXT, "myOption", 6, 1),
"516:9: " + getCheckMessage(MSG_KEY_EXT, "count", 4, 1),
"517:9: " + getCheckMessage(MSG_KEY_EXT, "files", 2, 1),
"552:13: " + getCheckMessage(MSG_KEY_EXT, "id", 2, 1),
"554:13: " + getCheckMessage(MSG_KEY_EXT, "parentId", 3, 1),
"903:9: " + getCheckMessage(MSG_KEY_EXT, "a", 4, 1),
"913:9: " + getCheckMessage(MSG_KEY_EXT, "a", 4, 1),
"979:9: " + getCheckMessage(MSG_KEY_EXT, "a", 4, 1),
"1001:9: " + getCheckMessage(MSG_KEY_EXT, "a", 3, 1),
"1036:9: " + getCheckMessage(MSG_KEY_EXT, "c", 3, 1),
"1066:9: " + getCheckMessage(MSG_KEY_EXT, "a", 4, 1),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceFinal.java"), expected);
}
@Test
public void testTokensNotNull() {
final VariableDeclarationUsageDistanceCheck check =
new VariableDeclarationUsageDistanceCheck();
assertWithMessage("Acceptable tokens should not be null")
.that(check.getAcceptableTokens())
.isNotNull();
assertWithMessage("Default tokens should not be null")
.that(check.getDefaultTokens())
.isNotNull();
assertWithMessage("Required tokens should not be null")
.that(check.getRequiredTokens())
.isNotNull();
}
@Test
public void testDefaultConfiguration() throws Exception {
final String[] expected = {
"83:9: " + getCheckMessage(MSG_KEY_EXT, "count", 4, 3),
"231:9: " + getCheckMessage(MSG_KEY_EXT, "t", 5, 3),
"491:9: " + getCheckMessage(MSG_KEY_EXT, "myOption", 7, 3),
"503:9: " + getCheckMessage(MSG_KEY_EXT, "myOption", 6, 3),
"554:13: " + getCheckMessage(MSG_KEY_EXT, "parentId", 4, 3),
"1036:9: " + getCheckMessage(MSG_KEY_EXT, "c", 4, 3),
"1066:9: " + getCheckMessage(MSG_KEY_EXT, "a", 4, 3),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceDefault.java"), expected);
}
@Test
public void testDefaultConfiguration2() throws Exception {
final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceDefault2.java"), expected);
}
@Test
public void testAnonymousClass() throws Exception {
final String[] expected = {
"19:9: " + getCheckMessage(MSG_KEY_EXT, "prefs", 4, 3),
};
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceAnonymous.java"),
expected);
}
@Test
public void testLabels() throws Exception {
final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
verifyWithInlineConfigParser(
getPath("InputVariableDeclarationUsageDistanceLabels.java"), expected);
}
@Test
public void testVariableDeclarationUsageDistanceSwitchExpressions() throws Exception {
final int maxDistance = 1;
final String[] expected = {
"35:17: " + getCheckMessage(MSG_KEY, "arg", 2, maxDistance),
"80:17: " + getCheckMessage(MSG_KEY, "m", 3, maxDistance),
"81:17: " + getCheckMessage(MSG_KEY, "n", 2, maxDistance),
"113:17: " + getCheckMessage(MSG_KEY, "arg", 2, maxDistance),
"155:17: " + getCheckMessage(MSG_KEY, "m", 3, maxDistance),
"156:17: " + getCheckMessage(MSG_KEY, "n", 2, maxDistance),
"177:17: " + getCheckMessage(MSG_KEY, "count", 3, maxDistance),
"197:17: " + getCheckMessage(MSG_KEY, "count", 3, maxDistance),
};
final String filename = "InputVariableDeclarationUsageDistanceCheckSwitchExpressions.java";
verifyWithInlineConfigParser(getNonCompilablePath(filename), expected);
}
}