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.Arrays;
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.JavadocVariableCheck;
31
32 public class XpathRegressionJavadocVariableTest extends AbstractXpathTestSupport {
33
34 private final String checkName = JavadocVariableCheck.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/javadocvariable";
44 }
45
46 @Test
47 public void testPrivateClassFields() throws Exception {
48 final File fileToProcess =
49 new File(getPath("InputXpathJavadocVariablePrivateClassFields.java"));
50
51 final DefaultConfiguration moduleConfig =
52 createModuleConfig(JavadocVariableCheck.class);
53
54 final String[] expectedViolation = {
55 "5:5: " + getCheckMessage(JavadocVariableCheck.class,
56 JavadocVariableCheck.MSG_JAVADOC_MISSING),
57 };
58
59 final List<String> expectedXpathQueries = Arrays.asList(
60 "/COMPILATION_UNIT/CLASS_DEF"
61 + "[./IDENT[@text='InputXpathJavadocVariablePrivateClassFields']]/OBJBLOCK"
62 + "/VARIABLE_DEF[./IDENT[@text='age']]",
63 "/COMPILATION_UNIT/CLASS_DEF"
64 + "[./IDENT[@text='InputXpathJavadocVariablePrivateClassFields']]/OBJBLOCK"
65 + "/VARIABLE_DEF[./IDENT[@text='age']]/MODIFIERS",
66 "/COMPILATION_UNIT/CLASS_DEF"
67 + "[./IDENT[@text='InputXpathJavadocVariablePrivateClassFields']]/OBJBLOCK"
68 + "/VARIABLE_DEF[./IDENT[@text='age']]/MODIFIERS/LITERAL_PRIVATE"
69 );
70
71 runVerifications(moduleConfig, fileToProcess, expectedViolation,
72 expectedXpathQueries);
73 }
74
75 @Test
76 public void testInnerClassFields() throws Exception {
77 final File fileToProcess =
78 new File(getPath("InputXpathJavadocVariableInnerClassFields.java"));
79
80 final DefaultConfiguration moduleConfig =
81 createModuleConfig(JavadocVariableCheck.class);
82
83 final String[] expectedViolation = {
84 "6:9: " + getCheckMessage(JavadocVariableCheck.class,
85 JavadocVariableCheck.MSG_JAVADOC_MISSING),
86 };
87
88 final List<String> expectedXpathQueries = Arrays.asList(
89 "/COMPILATION_UNIT/CLASS_DEF"
90 + "[./IDENT[@text='InputXpathJavadocVariableInnerClassFields']]/OBJBLOCK"
91 + "/CLASS_DEF[./IDENT[@text='InnerInner2']]/OBJBLOCK"
92 + "/VARIABLE_DEF[./IDENT[@text='fData']]",
93 "/COMPILATION_UNIT/CLASS_DEF"
94 + "[./IDENT[@text='InputXpathJavadocVariableInnerClassFields']]/OBJBLOCK"
95 + "/CLASS_DEF[./IDENT[@text='InnerInner2']]/OBJBLOCK"
96 + "/VARIABLE_DEF[./IDENT[@text='fData']]/MODIFIERS",
97 "/COMPILATION_UNIT/CLASS_DEF"
98 + "[./IDENT[@text='InputXpathJavadocVariableInnerClassFields']]/OBJBLOCK"
99 + "/CLASS_DEF[./IDENT[@text='InnerInner2']]/OBJBLOCK"
100 + "/VARIABLE_DEF[./IDENT[@text='fData']]/MODIFIERS"
101 + "/LITERAL_PUBLIC"
102 );
103
104 runVerifications(moduleConfig, fileToProcess, expectedViolation,
105 expectedXpathQueries);
106 }
107 }