1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package org.checkstyle.suppressionxpathfilter.javadoc;
21
22 import java.io.File;
23 import java.util.Collections;
24 import java.util.List;
25
26 import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
27 import org.junit.jupiter.api.Test;
28
29 import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30 import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocContentLocationCheck;
31
32 public class XpathRegressionJavadocContentLocationTest extends AbstractXpathTestSupport {
33
34 private final String checkName = JavadocContentLocationCheck.class.getSimpleName();
35
36 @Override
37 protected String getCheckName() {
38 return checkName;
39 }
40
41 @Override
42 protected String getPackageLocation() {
43 return "org/checkstyle/suppressionxpathfilter/javadoc/javadoccontentlocation";
44 }
45
46 @Test
47 public void testOne() throws Exception {
48 final File fileToProcess =
49 new File(getPath("InputXpathJavadocContentLocationOne.java"));
50
51 final DefaultConfiguration moduleConfig =
52 createModuleConfig(JavadocContentLocationCheck.class);
53
54 final String[] expectedViolation = {
55 "5:5: " + getCheckMessage(JavadocContentLocationCheck.class,
56 JavadocContentLocationCheck.MSG_JAVADOC_CONTENT_SECOND_LINE),
57 };
58
59 final List<String> expectedXpathQueries = Collections.singletonList(
60 "/COMPILATION_UNIT/INTERFACE_DEF"
61 + "[./IDENT[@text='InputXpathJavadocContentLocationOne']]"
62 + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/BLOCK_COMMENT_BEGIN"
63 + "[./COMMENT_CONTENT[@text='* Text. // warn\\n ']]"
64 );
65
66 runVerifications(moduleConfig, fileToProcess, expectedViolation,
67 expectedXpathQueries);
68 }
69
70 @Test
71 public void testTwo() throws Exception {
72 final File fileToProcess =
73 new File(getPath("InputXpathJavadocContentLocationTwo.java"));
74
75 final DefaultConfiguration moduleConfig =
76 createModuleConfig(JavadocContentLocationCheck.class);
77
78 moduleConfig.addProperty("location", "first_line");
79
80 final String[] expectedViolation = {
81 "5:16: " + getCheckMessage(JavadocContentLocationCheck.class,
82 JavadocContentLocationCheck.MSG_JAVADOC_CONTENT_FIRST_LINE),
83 };
84
85 final List<String> expectedXpathQueries = Collections.singletonList(
86 "/COMPILATION_UNIT/INTERFACE_DEF[./IDENT"
87 + "[@text='InputXpathJavadocContentLocationTwo']]"
88 + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/BLOCK_COMMENT_BEGIN"
89 + "[./COMMENT_CONTENT[@text='*\\n * Text.\\n ']]"
90 );
91
92 runVerifications(moduleConfig, fileToProcess, expectedViolation,
93 expectedXpathQueries);
94 }
95
96 }