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
|
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 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.puppycrawl.tools.checkstyle.checks.coding.IllegalTokenTextCheck.MSG_KEY;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;
import org.junit.Assert;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil;
import com.puppycrawl.tools.checkstyle.utils.TokenUtils;
public class IllegalTokenTextCheckTest
extends AbstractModuleTestSupport {
@Override
protected String getPackageLocation() {
return "com/puppycrawl/tools/checkstyle/checks/coding/illegaltokentext";
}
@Test
public void testCaseSensitive()
throws Exception {
final DefaultConfiguration checkConfig =
createModuleConfig(IllegalTokenTextCheck.class);
checkConfig.addAttribute("tokens", "STRING_LITERAL");
checkConfig.addAttribute("format", "a href");
checkConfig.addAttribute("ignoreCase", "false");
final String[] expected = {
"24:28: " + getCheckMessage(MSG_KEY, "a href"),
};
verify(checkConfig, getPath("InputIllegalTokenTextTokens.java"), expected);
}
@Test
public void testCaseInSensitive()
throws Exception {
final DefaultConfiguration checkConfig =
createModuleConfig(IllegalTokenTextCheck.class);
checkConfig.addAttribute("tokens", "STRING_LITERAL");
checkConfig.addAttribute("format", "a href");
checkConfig.addAttribute("ignoreCase", "true");
final String[] expected = {
"24:28: " + getCheckMessage(MSG_KEY, "a href"),
"25:32: " + getCheckMessage(MSG_KEY, "a href"),
};
verify(checkConfig, getPath("InputIllegalTokenTextTokens.java"), expected);
}
@Test
public void testCustomMessage()
throws Exception {
final DefaultConfiguration checkConfig =
createModuleConfig(IllegalTokenTextCheck.class);
checkConfig.addAttribute("tokens", "STRING_LITERAL");
checkConfig.addAttribute("format", "a href");
checkConfig.addAttribute("message", "My custom message");
final String[] expected = {
"24:28: " + "My custom message",
};
verify(checkConfig, getPath("InputIllegalTokenTextTokens.java"), expected);
}
@Test
public void testNullCustomMessage()
throws Exception {
final DefaultConfiguration checkConfig =
createModuleConfig(IllegalTokenTextCheck.class);
checkConfig.addAttribute("tokens", "STRING_LITERAL");
checkConfig.addAttribute("format", "a href");
checkConfig.addAttribute("message", null);
final String[] expected = {
"24:28: " + getCheckMessage(MSG_KEY, "a href"),
};
verify(checkConfig, getPath("InputIllegalTokenTextTokens.java"), expected);
}
@Test
public void testTokensNotNull() {
final IllegalTokenTextCheck check = new IllegalTokenTextCheck();
Assert.assertNotNull("Acceptable tokens should not be null", check.getAcceptableTokens());
Assert.assertNotNull("Default tokens should not be null", check.getDefaultTokens());
Assert.assertNotNull("Required tokens should not be null", check.getRequiredTokens());
Assert.assertTrue("Comments are also TokenType token", check.isCommentNodesRequired());
}
@Test
public void testCommentToken()
throws Exception {
final DefaultConfiguration checkConfig =
createModuleConfig(IllegalTokenTextCheck.class);
checkConfig.addAttribute("tokens", "COMMENT_CONTENT");
checkConfig.addAttribute("format", "a href");
checkConfig.addAttribute("message", null);
final String[] expected = {
"35:28: " + getCheckMessage(MSG_KEY, "a href"),
};
verify(checkConfig, getPath("InputIllegalTokenTextTokens.java"), expected);
}
@Test
public void testOrderOfProperties() throws Exception {
// pure class must be used as configuration doesn't guarantee order of
// attributes
final IllegalTokenTextCheck check = new IllegalTokenTextCheck();
check.setFormat("test");
check.setIgnoreCase(true);
final Pattern actual = (Pattern) TestUtil.getClassDeclaredField(
IllegalTokenTextCheck.class, "regexp").get(check);
Assert.assertEquals("should match", Pattern.CASE_INSENSITIVE, actual.flags());
Assert.assertEquals("should match", "test", actual.pattern());
}
@Test
public void testAcceptableTokensMakeSense() {
final int expectedTokenTypesTotalNumber = 169;
Assert.assertEquals("Total number of TokenTypes has changed, acceptable tokens in"
+ " IllegalTokenTextCheck need to be reconsidered.",
expectedTokenTypesTotalNumber, TokenUtils.getTokenTypesTotalNumber());
final IllegalTokenTextCheck check = new IllegalTokenTextCheck();
final int[] allowedTokens = check.getAcceptableTokens();
final List<Integer> tokenTypesWithMutableText = Arrays.asList(
TokenTypes.NUM_DOUBLE,
TokenTypes.NUM_FLOAT,
TokenTypes.NUM_INT,
TokenTypes.NUM_LONG,
TokenTypes.IDENT,
TokenTypes.COMMENT_CONTENT,
TokenTypes.STRING_LITERAL,
TokenTypes.CHAR_LITERAL
);
for (int tokenType : allowedTokens) {
Assert.assertTrue(TokenUtils.getTokenName(tokenType) + " should not be allowed"
+ " in this check as its text is a constant (IllegalTokenCheck should be used for"
+ " such cases).", tokenTypesWithMutableText.contains(tokenType));
}
}
}
|
