1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20 package com.puppycrawl.tools.checkstyle.checks.javadoc;
21
22 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_EMPTY;
23 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_INCOMPLETE_TAG;
24 import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocStyleCheck.MSG_NO_PERIOD;
25
26 import org.junit.jupiter.api.Test;
27
28 import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
29
30 public class JavadocStyleCheckExamplesTest extends AbstractExamplesModuleTestSupport {
31 @Override
32 public String getPackageLocation() {
33 return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocstyle";
34 }
35
36 @Test
37 public void testExample1() throws Exception {
38 final String[] expected = {
39 "10: " + getCheckMessage(MSG_NO_PERIOD),
40 "29: " + getCheckMessage(MSG_NO_PERIOD),
41 "35: " + getCheckMessage(MSG_NO_PERIOD),
42 "41: " + getCheckMessage(MSG_NO_PERIOD),
43 "48: " + getCheckMessage(MSG_NO_PERIOD),
44 "50: " + getCheckMessage(MSG_INCOMPLETE_TAG, " * <p"),
45 };
46 verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47 }
48
49 @Test
50 public void testExample2() throws Exception {
51 final String[] expected = {
52 "12: " + getCheckMessage(MSG_NO_PERIOD),
53 "36: " + getCheckMessage(MSG_NO_PERIOD),
54 };
55 verifyWithInlineConfigParser(getPath("Example2.java"), expected);
56 }
57
58 @Test
59 public void testExample3() throws Exception {
60 final String[] expected = {
61 "30: " + getCheckMessage(MSG_NO_PERIOD),
62 "41: " + getCheckMessage(MSG_NO_PERIOD),
63 "48: " + getCheckMessage(MSG_NO_PERIOD),
64 "50: " + getCheckMessage(MSG_INCOMPLETE_TAG, " * <p"),
65 };
66 verifyWithInlineConfigParser(getPath("Example3.java"), expected);
67 }
68
69 @Test
70 public void testExample4() throws Exception {
71 final String[] expected = {
72 "48: " + getCheckMessage(MSG_INCOMPLETE_TAG, " * <p"),
73 };
74 verifyWithInlineConfigParser(getPath("Example4.java"), expected);
75 }
76
77 @Test
78 public void testExample5() throws Exception {
79 final String[] expected = {
80 "12: " + getCheckMessage(MSG_NO_PERIOD),
81 "29: " + getCheckMessage(MSG_NO_PERIOD),
82 "35: " + getCheckMessage(MSG_NO_PERIOD),
83 "41: " + getCheckMessage(MSG_NO_PERIOD),
84 "48: " + getCheckMessage(MSG_NO_PERIOD),
85 };
86 verifyWithInlineConfigParser(getPath("Example5.java"), expected);
87 }
88
89 @Test
90 public void testExample6() throws Exception {
91 final String[] expected = {
92 "12: " + getCheckMessage(MSG_NO_PERIOD),
93 };
94 verifyWithInlineConfigParser(getPath("Example6.java"), expected);
95 }
96
97 @Test
98 public void testExample7() throws Exception {
99 final String[] expected = {
100 "12: " + getCheckMessage(MSG_NO_PERIOD),
101 "30: " + getCheckMessage(MSG_NO_PERIOD),
102 "36: " + getCheckMessage(MSG_NO_PERIOD),
103 "42: " + getCheckMessage(MSG_NO_PERIOD),
104 "49: " + getCheckMessage(MSG_NO_PERIOD),
105 "51: " + getCheckMessage(MSG_INCOMPLETE_TAG, " * <p"),
106 "56: " + getCheckMessage(MSG_EMPTY),
107 };
108 verifyWithInlineConfigParser(getPath("Example7.java"), expected);
109 }
110 }