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
|
////////////////////////////////////////////////////////////////////////////////
// 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.utils;
import static com.puppycrawl.tools.checkstyle.internal.utils.TestUtil.isUtilsClassHasPrivateConstructor;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertTrue;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.Scope;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
public class ScopeUtilsTest {
@Test
public void testIsProperUtilsClass() throws ReflectiveOperationException {
assertTrue("Constructor is not private",
isUtilsClassHasPrivateConstructor(ScopeUtils.class, true));
}
@Test
public void testInEnumOnRoot() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(new DetailAST()));
}
@Test
public void testInEnumBlockInNew() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.LITERAL_NEW,
TokenTypes.MODIFIERS)));
}
@Test
public void testInEnumBlockWithEnum() {
assertTrue("Should return true when passed is enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.OBJBLOCK, TokenTypes.ENUM_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testInEnumBlockInInterface() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.INTERFACE_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testInEnumBlockInAnnotation() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.ANNOTATION_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testInEnumBlockInClass() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.CLASS_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testInEnumBlockInLiteralNew() {
assertFalse("Should return false when passed is not enum",
ScopeUtils.isInEnumBlock(getNode(TokenTypes.LITERAL_NEW,
TokenTypes.IDENT)));
}
@Test
public void testIsOuterMostTypeInterface() {
assertFalse("Should return false when passed is not outer most type",
ScopeUtils.isOuterMostType(getNode(TokenTypes.INTERFACE_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testIsOuterMostTypeAnnotation() {
assertFalse("Should return false when passed is not outer most type",
ScopeUtils.isOuterMostType(getNode(TokenTypes.ANNOTATION_DEF,
TokenTypes.MODIFIERS)));
}
@Test
public void testIsOuterMostTypeEnum() {
assertFalse("Should return false when passed is not outer most type",
ScopeUtils.isOuterMostType(getNode(TokenTypes.ENUM_DEF, TokenTypes.MODIFIERS)));
}
@Test
public void testIsOuterMostTypeClass() {
assertFalse("Should return false when passed is not outer most type",
ScopeUtils.isOuterMostType(getNode(TokenTypes.CLASS_DEF, TokenTypes.MODIFIERS)));
}
@Test
public void testIsLocalVariableDefCatch() {
assertTrue("Should return true when passed is variable def",
ScopeUtils.isLocalVariableDef(getNode(TokenTypes.LITERAL_CATCH,
TokenTypes.PARAMETER_DEF)));
}
@Test
public void testIsLocalVariableDefUnexpected() {
assertFalse("Should return false when passed is not variable def",
ScopeUtils.isLocalVariableDef(getNode(TokenTypes.LITERAL_CATCH)));
}
@Test
public void testIsClassFieldDef() {
assertTrue("Should return true when passed is class field def",
ScopeUtils.isClassFieldDef(getNode(TokenTypes.CLASS_DEF,
TokenTypes.OBJBLOCK, TokenTypes.VARIABLE_DEF)));
}
@Test
public void testSurroundingScope() {
assertEquals("Invalid surrounding scope",
Scope.PUBLIC, ScopeUtils.getSurroundingScope(getNodeWithParentScope(
TokenTypes.LITERAL_PUBLIC, "public", TokenTypes.ANNOTATION_DEF)));
assertEquals("Invalid surrounding scope",
Scope.PROTECTED, ScopeUtils.getSurroundingScope(
getNodeWithParentScope(TokenTypes.LITERAL_PROTECTED, "protected",
TokenTypes.INTERFACE_DEF)));
assertEquals("Invalid surrounding scope",
Scope.PRIVATE, ScopeUtils.getSurroundingScope(
getNodeWithParentScope(TokenTypes.LITERAL_PRIVATE, "private", TokenTypes.ENUM_DEF)));
assertEquals("Invalid surrounding scope",
Scope.PACKAGE, ScopeUtils.getSurroundingScope(
getNodeWithParentScope(TokenTypes.LITERAL_STATIC, "static", TokenTypes.CLASS_DEF)));
}
@Test
public void testIsInScope() {
assertTrue("Should return true when node is in valid scope",
ScopeUtils.isInScope(getNodeWithParentScope(TokenTypes.LITERAL_PUBLIC,
"public", TokenTypes.ANNOTATION_DEF), Scope.PUBLIC));
assertFalse("Should return false when node is in invalid scope",
ScopeUtils.isInScope(getNodeWithParentScope(TokenTypes.LITERAL_PROTECTED,
"protected", TokenTypes.INTERFACE_DEF), Scope.PRIVATE));
}
@Test
public void testSurroundingScopeOfNodeChildOfLiteralNewIsAnoninner() {
assertEquals("Invalid surrounding scope",
Scope.ANONINNER, ScopeUtils.getSurroundingScope(
getNode(TokenTypes.LITERAL_NEW, TokenTypes.IDENT)));
}
@Test
public void testIsInInterfaceBlock() {
final DetailAST ast = getNode(TokenTypes.INTERFACE_DEF, TokenTypes.OBJBLOCK,
TokenTypes.CLASS_DEF, TokenTypes.MODIFIERS);
assertTrue("Should return true when node is interface block",
ScopeUtils.isInInterfaceBlock(ast.getParent()));
assertFalse("Should return false when node is not interface block",
ScopeUtils.isInInterfaceBlock(ast));
}
@Test
public void testIsInAnnotationBlock() {
final DetailAST ast = getNode(TokenTypes.ANNOTATION_DEF, TokenTypes.OBJBLOCK,
TokenTypes.INTERFACE_DEF, TokenTypes.MODIFIERS);
assertTrue("Should return true when node is annotation block",
ScopeUtils.isInAnnotationBlock(ast.getParent()));
assertFalse("Should return false when node is not annotation block",
ScopeUtils.isInAnnotationBlock(ast));
}
@Test
public void testisInInterfaceOrAnnotationBlock() {
assertTrue("Should return true when node is in interface or annotation block",
ScopeUtils.isInInterfaceOrAnnotationBlock(
getNode(TokenTypes.ANNOTATION_DEF, TokenTypes.OBJBLOCK)));
assertTrue("Should return true when node is in interface or annotation block",
ScopeUtils.isInInterfaceOrAnnotationBlock(
getNode(TokenTypes.INTERFACE_DEF, TokenTypes.OBJBLOCK)));
assertFalse("Should return false when node is not in interface or annotation block",
ScopeUtils.isInInterfaceOrAnnotationBlock(
getNode(TokenTypes.CLASS_DEF, TokenTypes.OBJBLOCK)));
assertFalse("Should return false when node is not in interface or annotation block",
ScopeUtils.isInInterfaceOrAnnotationBlock(
getNode(TokenTypes.LITERAL_NEW, TokenTypes.IDENT)));
assertFalse("Should return false when node is not in interface or annotation block",
ScopeUtils.isInInterfaceOrAnnotationBlock(
getNode(TokenTypes.ENUM_DEF, TokenTypes.OBJBLOCK)));
}
private static DetailAST getNode(int... nodeTypes) {
DetailAST ast = new DetailAST();
ast.setType(nodeTypes[0]);
for (int i = 1; i < nodeTypes.length; i++) {
final DetailAST astChild = new DetailAST();
astChild.setType(nodeTypes[i]);
ast.addChild(astChild);
ast = astChild;
}
return ast;
}
private static DetailAST getNodeWithParentScope(int literal, String scope,
int parentTokenType) {
final DetailAST ast = getNode(parentTokenType, TokenTypes.MODIFIERS, literal);
ast.setText(scope);
final DetailAST ast2 = getNode(TokenTypes.OBJBLOCK);
ast.getParent().getParent().addChild(ast2);
return ast;
}
}
|
