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.imports;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.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  
30  public class AvoidStarImportCheckTest
31      extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/imports/avoidstarimport";
36      }
37  
38      @Test
39      public void testDefaultOperation()
40              throws Exception {
41          final String[] expected = {
42              "12:15: " + getCheckMessage(MSG_KEY, "java.io.*"),
43              "13:17: " + getCheckMessage(MSG_KEY, "java.lang.*"),
44              "28:42: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
45              "29:42: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
46              "31:27: " + getCheckMessage(MSG_KEY, "java.io.File.*"),
47          };
48  
49          verifyWithInlineConfigParser(
50                  getPath("InputAvoidStarImportDefault.java"),
51                  expected);
52      }
53  
54      @Test
55      public void testExcludes()
56              throws Exception {
57          // allow the java.io/java.lang,javax.swing.WindowConstants star imports
58          final String[] expected2 = {
59              "31:27: " + getCheckMessage(MSG_KEY, "java.io.File.*"),
60          };
61          verifyWithInlineConfigParser(
62                  getPath("InputAvoidStarImportExcludes.java"),
63                  expected2);
64      }
65  
66      @Test
67      public void testAllowClassImports() throws Exception {
68          // allow all class star imports
69          final String[] expected2 = {
70              "28:42: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
71              "29:42: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
72              "31:27: " + getCheckMessage(MSG_KEY, "java.io.File.*"), };
73          verifyWithInlineConfigParser(
74                  getPath("InputAvoidStarImportAllowClass.java"), expected2);
75      }
76  
77      @Test
78      public void testAllowStaticMemberImports() throws Exception {
79          // allow all static star imports
80          final String[] expected2 = {
81              "12:15: " + getCheckMessage(MSG_KEY, "java.io.*"),
82              "13:17: " + getCheckMessage(MSG_KEY, "java.lang.*"),
83          };
84          verifyWithInlineConfigParser(
85                  getPath("InputAvoidStarImportAllowStaticMember.java"), expected2);
86      }
87  
88      @Test
89      public void testGetAcceptableTokens() {
90          final AvoidStarImportCheck testCheckObject =
91                  new AvoidStarImportCheck();
92          final int[] actual = testCheckObject.getAcceptableTokens();
93          final int[] expected = {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
94          assertWithMessage("Default acceptable tokens are invalid")
95              .that(actual)
96              .isEqualTo(expected);
97      }
98  
99      @Test
100     public void testGetRequiredTokens() {
101         final AvoidStarImportCheck testCheckObject =
102                 new AvoidStarImportCheck();
103         final int[] actual = testCheckObject.getRequiredTokens();
104         final int[] expected = {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
105 
106         assertWithMessage("Default required tokens are invalid")
107             .that(actual)
108             .isEqualTo(expected);
109     }
110 
111 }