View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.javadoc;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocVariableCheck.MSG_JAVADOC_MISSING;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  
28  public class JavadocVariableCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29  
30      @Override
31      public String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocvariable";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = {
38              "12:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "a"),
39              "18:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "c"),
40              "19:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "d"),
41              "20:15: " + getCheckMessage(MSG_JAVADOC_MISSING, "e"),
42              "23:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
43              "27:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
44          };
45          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
46      }
47  
48      @Test
49      public void testExample2() throws Exception {
50          final String[] expected = {
51              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "d"),
52              "25:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
53          };
54  
55          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
56      }
57  
58      @Test
59      public void testExample3() throws Exception {
60          final String[] expected = {
61              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "a"),
62              "20:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "c"),
63              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "d"),
64              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING, "e"),
65          };
66  
67          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
68      }
69  
70      @Test
71      public void testExample4() throws Exception {
72          final String[] expected = {
73              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "a"),
74              "20:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "c"),
75              "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "d"),
76              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING, "e"),
77              "25:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
78              "29:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
79          };
80  
81          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
82      }
83  
84      @Test
85      public void testUseCase1() throws Exception {
86          final String[] expected = {
87              "14:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "a"),
88              "22:15: " + getCheckMessage(MSG_JAVADOC_MISSING, "e"),
89              "29:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
90          };
91  
92          verifyWithInlineConfigParser(getPath("UseCase1.java"), expected);
93      }
94  
95      @Test
96      public void testUseCase2() throws Exception {
97          final String[] expected = {
98              "15:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "variablePublic"),
99              "17:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "variableProtected"),
100             "19:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "variablePackage"),
101             "21:3: " + getCheckMessage(MSG_JAVADOC_MISSING, "variablePrivate"),
102             "24:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
103             "28:5: " + getCheckMessage(MSG_JAVADOC_MISSING, "CONSTANT"),
104         };
105 
106         verifyWithInlineConfigParser(getPath("UseCase2.java"), expected);
107     }
108 
109 }