View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 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.annotation;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.annotation.PackageAnnotationCheck.MSG_KEY;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
29  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30  
31  public class PackageAnnotationCheckTest extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/annotation/packageannotation";
36      }
37  
38      /**
39       * This tests a package annotation that is in the package-info.java file.
40       */
41      @Test
42      public void testGoodPackageAnnotation() throws Exception {
43  
44          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
45  
46          verifyWithInlineConfigParser(
47                  getPath("package-info.java"), expected);
48      }
49  
50      @Test
51      public void testGetAcceptableTokens() {
52          final PackageAnnotationCheck constantNameCheckObj = new PackageAnnotationCheck();
53          final int[] actual = constantNameCheckObj.getAcceptableTokens();
54          final int[] expected = {TokenTypes.PACKAGE_DEF};
55          assertWithMessage("Invalid acceptable tokens")
56                  .that(actual)
57                  .isEqualTo(expected);
58      }
59  
60      @Test
61      public void testNoPackageAnnotation() throws Exception {
62  
63          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
64  
65          verifyWithInlineConfigParser(
66                  getPath("InputPackageAnnotation.java"), expected);
67      }
68  
69      @Test
70      public void testBadPackageAnnotation() throws Exception {
71  
72          final String[] expected = {
73              "10:1: " + getCheckMessage(MSG_KEY),
74          };
75  
76          verifyWithInlineConfigParser(
77                  getNonCompilablePath("InputPackageAnnotation2.java"), expected);
78      }
79  
80  }