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
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2015 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.naming;
import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
import static org.junit.Assert.assertArrayEquals;
import java.io.File;
import java.io.IOException;
import org.apache.commons.lang3.ArrayUtils;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
public class ParameterNameCheckTest
extends BaseCheckTestSupport {
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("checks" + File.separator
+ "naming" + File.separator + filename);
}
@Test
public void testGetRequiredTokens() {
final ParameterNameCheck checkObj = new ParameterNameCheck();
final int[] expected = {TokenTypes.PARAMETER_DEF};
assertArrayEquals(expected, checkObj.getRequiredTokens());
}
@Test
public void testCatch()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^NO_WAY_MATEY$");
final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputCatchOnly.java"), expected);
}
@Test
public void testSpecified()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^a[A-Z][a-zA-Z0-9]*$");
final String pattern = "^a[A-Z][a-zA-Z0-9]*$";
final String[] expected = {
"71:19: " + getCheckMessage(MSG_INVALID_PATTERN, "badFormat1", pattern),
"71:34: " + getCheckMessage(MSG_INVALID_PATTERN, "badFormat2", pattern),
"72:25: " + getCheckMessage(MSG_INVALID_PATTERN, "badFormat3", pattern),
};
verify(checkConfig, getPath("InputSimple.java"), expected);
}
@Test
public void testDefault()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputSimple.java"), expected);
}
@Test
public void testGetAcceptableTokens() {
final ParameterNameCheck parameterNameCheckObj = new ParameterNameCheck();
final int[] actual = parameterNameCheckObj.getAcceptableTokens();
final int[] expected = {
TokenTypes.PARAMETER_DEF,
};
assertArrayEquals(expected, actual);
}
@Test
public void testSkipMethodsWithOverrideAnnotationTrue()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("ignoreOverridden", "true");
final String pattern = "^h$";
final String[] expected = {
"11:28: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"15:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"19:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"19:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"21:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"28:33: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"28:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
};
verify(checkConfig, getPath("InputOverrideAnnotation.java"), expected);
}
@Test
public void testSkipMethodsWithOverrideAnnotationFalse()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("ignoreOverridden", "false");
final String pattern = "^h$";
final String[] expected = {
"6:34: " + getCheckMessage(MSG_INVALID_PATTERN, "o", pattern),
"11:28: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"15:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"19:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"19:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"21:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"28:33: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"28:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
};
verify(checkConfig, getPath("InputOverrideAnnotation.java"), expected);
}
@Test
public void testSkipCatchParameterTrue()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "true");
final String[] expected = ArrayUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputCatchParameter.java"), expected);
}
@Test
public void testSkipCatchParameterFalse()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "false");
final String pattern = "^h$";
final String[] expected = {
"13:26: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
"22:64: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
};
verify(checkConfig, getPath("InputCatchParameter.java"), expected);
}
@Test
public void testSkipCatchParameterTrueAndIgnoreOverriddenTrue()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "true");
checkConfig.addAttribute("ignoreOverridden", "true");
final String pattern = "^h$";
final String[] expected = {
"13:29: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"21:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"21:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"23:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"30:43: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"30:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
};
verify(checkConfig, getPath("InputParameterNameMultipleOptions.java"), expected);
}
@Test
public void testSkipCatchParameterFalseAndIgnoreOverriddenFalse()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "false");
checkConfig.addAttribute("ignoreOverridden", "false");
final String pattern = "^h$";
final String[] expected = {
"8:34: " + getCheckMessage(MSG_INVALID_PATTERN, "o", pattern),
"13:29: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"21:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"21:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"23:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"30:43: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"30:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
"36:26: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
"45:64: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
};
verify(checkConfig, getPath("InputParameterNameMultipleOptions.java"), expected);
}
@Test
public void testSkipCatchParameterTrueAndIgnoreOverriddenFalse()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "true");
checkConfig.addAttribute("ignoreOverridden", "false");
final String pattern = "^h$";
final String[] expected = {
"8:34: " + getCheckMessage(MSG_INVALID_PATTERN, "o", pattern),
"13:29: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"21:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"21:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"23:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"30:43: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"30:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
};
verify(checkConfig, getPath("InputParameterNameMultipleOptions.java"), expected);
}
@Test
public void testSkipCatchParameterFalseAndIgnoreOverriddenTrue()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ParameterNameCheck.class);
checkConfig.addAttribute("format", "^h$");
checkConfig.addAttribute("skipCatchParameter", "false");
checkConfig.addAttribute("ignoreOverridden", "true");
final String pattern = "^h$";
final String[] expected = {
"13:29: " + getCheckMessage(MSG_INVALID_PATTERN, "object", pattern),
"17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "aaaa", pattern),
"21:19: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"21:28: " + getCheckMessage(MSG_INVALID_PATTERN, "bd", pattern),
"23:18: " + getCheckMessage(MSG_INVALID_PATTERN, "abc", pattern),
"30:43: " + getCheckMessage(MSG_INVALID_PATTERN, "field", pattern),
"30:62: " + getCheckMessage(MSG_INVALID_PATTERN, "packageNames", pattern),
"36:26: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
"45:64: " + getCheckMessage(MSG_INVALID_PATTERN, "ex", pattern),
};
verify(checkConfig, getPath("InputParameterNameMultipleOptions.java"), expected);
}
}
|
