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
|
////////////////////////////////////////////////////////////////////////////////
// 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 org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;
import java.io.File;
import java.util.Arrays;
import java.util.List;
import java.util.function.Function;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.AbstractPathTestSupport;
import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.internal.utils.TestUtil;
public class BlockCommentPositionTest extends AbstractPathTestSupport {
@Test
public void testPrivateConstr() throws Exception {
assertTrue("Constructor is not private",
TestUtil.isUtilsClassHasPrivateConstructor(BlockCommentPosition.class, true));
}
@Test
public void testJavaDocsRecognition() throws Exception {
final List<BlockCommentPositionTestMetadata> metadataList = Arrays.asList(
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnClass.java",
BlockCommentPosition::isOnClass, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnMethod.java",
BlockCommentPosition::isOnMethod, 4),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnField.java",
BlockCommentPosition::isOnField, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnEnum.java",
BlockCommentPosition::isOnEnum, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnConstructor.java",
BlockCommentPosition::isOnConstructor, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnInterface.java",
BlockCommentPosition::isOnInterface, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnAnnotation.java",
BlockCommentPosition::isOnAnnotationDef, 3),
new BlockCommentPositionTestMetadata("InputBlockCommentPositionOnEnumMember.java",
BlockCommentPosition::isOnEnumConstant, 2),
new BlockCommentPositionTestMetadata(
"InputBlockCommentPositionOnAnnotationField.java",
BlockCommentPosition::isOnAnnotationField, 4)
);
for (BlockCommentPositionTestMetadata metadata : metadataList) {
final DetailAST ast = TestUtil.parseFile(
new File(getPath(metadata.getFileName()))
);
final int matches = getJavadocsCount(ast, metadata.getAssertion());
assertEquals("Invalid javadoc count", metadata.getMatchesNum(), matches);
}
}
private static int getJavadocsCount(DetailAST detailAST,
Function<DetailAST, Boolean> assertion) {
int matchFound = 0;
DetailAST node = detailAST;
while (node != null) {
if (node.getType() == TokenTypes.BLOCK_COMMENT_BEGIN
&& JavadocUtils.isJavadocComment(node)) {
if (!assertion.apply(node)) {
throw new IllegalStateException("Position of comment is defined correctly");
}
matchFound++;
}
matchFound += getJavadocsCount(node.getFirstChild(), assertion);
node = node.getNextSibling();
}
return matchFound;
}
@Override
protected String getPackageLocation() {
return "com/puppycrawl/tools/checkstyle/utils/blockcommentposition";
}
private static final class BlockCommentPositionTestMetadata {
private final String fileName;
private final Function<DetailAST, Boolean> assertion;
private final int matchesNum;
BlockCommentPositionTestMetadata(String fileName, Function<DetailAST,
Boolean> assertion, int matchesNum) {
this.fileName = fileName;
this.assertion = assertion;
this.matchesNum = matchesNum;
}
public String getFileName() {
return fileName;
}
public Function<DetailAST, Boolean> getAssertion() {
return assertion;
}
public int getMatchesNum() {
return matchesNum;
}
}
}
|
