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.JavadocEndCommentDelimiterCheck;
31
32 public class XpathRegressionJavadocEndCommentDelimiterTest extends AbstractXpathTestSupport {
33
34 private final String checkName = JavadocEndCommentDelimiterCheck.class.getSimpleName();
35
36 @Override
37 protected String getCheckName() {
38 return checkName;
39 }
40
41 @Override
42 public String getPackageLocation() {
43 return "org/checkstyle/suppressionxpathfilter/javadoc/javadocendcommentdelimiter";
44 }
45
46 @Test
47 public void testClassJavadocEndCommentDelimiter() throws Exception {
48 final File fileToProcess =
49 new File(getPath("InputXpathJavadocEndCommentDelimiterClass.java"));
50
51 final DefaultConfiguration moduleConfig =
52 createModuleConfig(JavadocEndCommentDelimiterCheck.class);
53
54 final String[] expectedViolation = {
55 "5:3: " + getCheckMessage(JavadocEndCommentDelimiterCheck.class,
56 JavadocEndCommentDelimiterCheck.MSG_KEY),
57 };
58
59 final List<String> expectedXpathQueries = Collections.singletonList(
60 "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
61 + "[@text='InputXpathJavadocEndCommentDelimiterClass']]"
62 + "/MODIFIERS/BLOCK_COMMENT_BEGIN[./COMMENT_CONTENT"
63 + "[@text='*\\n * Text.\\n *']]/BLOCK_COMMENT_END"
64 );
65
66 runVerifications(moduleConfig, fileToProcess, expectedViolation,
67 expectedXpathQueries);
68 }
69
70 @Test
71 public void testMethodJavadocEndCommentDelimiter() throws Exception {
72 final File fileToProcess =
73 new File(getPath("InputXpathJavadocEndCommentDelimiterMultiline.java"));
74
75 final DefaultConfiguration moduleConfig =
76 createModuleConfig(JavadocEndCommentDelimiterCheck.class);
77
78 final String[] expectedViolation = {
79 "7:7: " + getCheckMessage(JavadocEndCommentDelimiterCheck.class,
80 JavadocEndCommentDelimiterCheck.MSG_KEY),
81 };
82
83 final List<String> expectedXpathQueries = Collections.singletonList(
84 "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
85 + "[@text='InputXpathJavadocEndCommentDelimiterMultiline']]"
86 + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS"
87 + "/BLOCK_COMMENT_BEGIN[./COMMENT_CONTENT"
88 + "[@text='*\\n * Text.\\n *']]/BLOCK_COMMENT_END"
89 );
90
91 runVerifications(moduleConfig, fileToProcess, expectedViolation,
92 expectedXpathQueries);
93 }
94
95 @Test
96 public void testFieldJavadocEndCommentDelimiter() throws Exception {
97 final File fileToProcess =
98 new File(getPath("InputXpathJavadocEndCommentDelimiterField.java"));
99
100 final DefaultConfiguration moduleConfig =
101 createModuleConfig(JavadocEndCommentDelimiterCheck.class);
102
103 final String[] expectedViolation = {
104 "5:15: " + getCheckMessage(JavadocEndCommentDelimiterCheck.class,
105 JavadocEndCommentDelimiterCheck.MSG_KEY),
106 };
107
108 final List<String> expectedXpathQueries = Collections.singletonList(
109 "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
110 + "[@text='InputXpathJavadocEndCommentDelimiterField']]"
111 + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='value']]/MODIFIERS"
112 + "/BLOCK_COMMENT_BEGIN[./COMMENT_CONTENT[@text='* Text. *']]"
113 + "/BLOCK_COMMENT_END"
114 );
115
116 runVerifications(moduleConfig, fileToProcess, expectedViolation,
117 expectedXpathQueries);
118 }
119
120 }