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.JavadocPackageCheck.MSG_LEGACY_PACKAGE_HTML;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocPackageCheck.MSG_PACKAGE_INFO;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
29  
30  public class JavadocPackageCheckExamplesTest extends AbstractExamplesModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocpackage";
35      }
36  
37      @Test
38      public void testExample1() throws Exception {
39          final String[] expected = {
40              "1: " + getCheckMessage(MSG_PACKAGE_INFO),
41          };
42  
43          verifyWithInlineConfigParser(getPath("nonlegacy/Example1.java"), expected);
44      }
45  
46      @Test
47      public void testExample2() throws Exception {
48          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
49          verifyWithInlineConfigParser(getPath("legacy/Example2.java"), expected);
50      }
51  
52      @Test
53      public void testExample3() throws Exception {
54          final String[] expected = {
55              "1: " + getCheckMessage(MSG_LEGACY_PACKAGE_HTML),
56  
57          };
58  
59          verifyWithInlineConfigParser(getPath("legacywithboth/Example3.java"), expected);
60      }
61  
62      @Test
63      public void testExample4() throws Exception {
64          final String[] expected = {};
65  
66          verifyWithInlineConfigParser(getPath("extensions/Example4.java"), expected);
67      }
68  
69  }