-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
/
NonEmptyAtclauseDescriptionCheckTest.java
132 lines (117 loc) · 5.79 KB
/
NonEmptyAtclauseDescriptionCheckTest.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
///////////////////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
// Copyright (C) 2001-2024 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.javadoc;
import static com.google.common.truth.Truth.assertWithMessage;
import static com.puppycrawl.tools.checkstyle.checks.javadoc.NonEmptyAtclauseDescriptionCheck.MSG_KEY;
import java.nio.charset.CodingErrorAction;
import org.junit.jupiter.api.Test;
import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.TreeWalker;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
import de.thetaphi.forbiddenapis.SuppressForbidden;
public class NonEmptyAtclauseDescriptionCheckTest
extends AbstractModuleTestSupport {
@Override
protected String getPackageLocation() {
return "com/puppycrawl/tools/checkstyle/checks/javadoc/nonemptyatclausedescription";
}
@Test
public void testGetAcceptableTokens() {
final NonEmptyAtclauseDescriptionCheck checkObj =
new NonEmptyAtclauseDescriptionCheck();
final int[] expected = {TokenTypes.BLOCK_COMMENT_BEGIN};
assertWithMessage("Default acceptable tokens are invalid")
.that(checkObj.getAcceptableTokens())
.isEqualTo(expected);
}
@Test
public void testGetRequiredTokens() {
final NonEmptyAtclauseDescriptionCheck checkObj =
new NonEmptyAtclauseDescriptionCheck();
final int[] expected = {TokenTypes.BLOCK_COMMENT_BEGIN};
assertWithMessage("Default required tokens are invalid")
.that(checkObj.getRequiredTokens())
.isEqualTo(expected);
}
@Test
public void testCheckOne() throws Exception {
final String[] expected = {
// this is a case with description that is sequences of spaces
"37: " + getCheckMessage(MSG_KEY),
// this is a case with description that is sequences of spaces
"38: " + getCheckMessage(MSG_KEY),
// this is a case with description that is sequences of spaces
"39: " + getCheckMessage(MSG_KEY),
// this is a case with description that is sequences of spaces
"50: " + getCheckMessage(MSG_KEY),
// this is a case with description that is sequences of spaces
"51: " + getCheckMessage(MSG_KEY),
// this is a case with description that is sequences of spaces
"52: " + getCheckMessage(MSG_KEY),
"92: " + getCheckMessage(MSG_KEY),
"93: " + getCheckMessage(MSG_KEY),
"94: " + getCheckMessage(MSG_KEY),
"95: " + getCheckMessage(MSG_KEY),
"96: " + getCheckMessage(MSG_KEY),
"97: " + getCheckMessage(MSG_KEY),
};
verifyWithInlineConfigParser(getPath("InputNonEmptyAtclauseDescriptionOne.java"), expected);
}
@Test
public void testCheckTwo() throws Exception {
final String[] expected = {
"16: " + getCheckMessage(MSG_KEY),
"17: " + getCheckMessage(MSG_KEY),
"18: " + getCheckMessage(MSG_KEY),
"19: " + getCheckMessage(MSG_KEY),
"20: " + getCheckMessage(MSG_KEY),
"51: " + getCheckMessage(MSG_KEY),
"60: " + getCheckMessage(MSG_KEY),
"75: " + getCheckMessage(MSG_KEY),
"77: " + getCheckMessage(MSG_KEY),
"88: " + getCheckMessage(MSG_KEY),
"98: " + getCheckMessage(MSG_KEY),
};
verifyWithInlineConfigParser(getPath("InputNonEmptyAtclauseDescriptionTwo.java"), expected);
}
/**
* This tests that the check does not fail when the input file contains malformed characters
* for a particular charset. The test file contains the character {@code ü} which is not
* mappable to US-ASCII. It makes sure that malformed characters than cannot be mapped are
* replaced with the default replacement character using {@link CodingErrorAction#REPLACE}.
*
* @throws Exception exception
*/
@SuppressForbidden
@Test
public void testDecoderOnMalformedInput() throws Exception {
final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
final DefaultConfiguration checkConfig =
createModuleConfig(NonEmptyAtclauseDescriptionCheck.class);
final DefaultConfiguration treeWalkerConfig = createModuleConfig(TreeWalker.class);
treeWalkerConfig.addChild(checkConfig);
final DefaultConfiguration checkerConfig = createRootConfig(treeWalkerConfig);
checkerConfig.addChild(treeWalkerConfig);
checkerConfig.addProperty("charset", "US-ASCII");
verify(checkerConfig,
getPath("InputNonEmptyAtclauseDescriptionDifferentCharset.java"), expected);
}
}