View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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.puppycrawl.tools.checkstyle.checks.imports.AvoidStarImportCheck.MSG_KEY;
23  import static org.junit.Assert.assertArrayEquals;
24  
25  import org.junit.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
30  
31  public class AvoidStarImportCheckTest
32      extends AbstractModuleTestSupport {
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 DefaultConfiguration checkConfig =
42              createModuleConfig(AvoidStarImportCheck.class);
43          final String[] expected = {
44              "7: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.checks.imports.*"),
45              "9: " + getCheckMessage(MSG_KEY, "java.io.*"),
46              "10: " + getCheckMessage(MSG_KEY, "java.lang.*"),
47              "25: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
48              "26: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
49              "28: " + getCheckMessage(MSG_KEY, "java.io.File.*"),
50          };
51  
52          verify(checkConfig, getPath("InputAvoidStarImportDefault.java"),
53                  expected);
54      }
55  
56      @Test
57      public void testExcludes()
58              throws Exception {
59          final DefaultConfiguration checkConfig =
60              createModuleConfig(AvoidStarImportCheck.class);
61          checkConfig.addAttribute("excludes",
62              "java.io,java.lang,javax.swing.WindowConstants.*, javax.swing.WindowConstants");
63          // allow the java.io/java.lang,javax.swing.WindowConstants star imports
64          final String[] expected2 = {
65              "7: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.checks.imports.*"),
66              "28: " + getCheckMessage(MSG_KEY, "java.io.File.*"),
67          };
68          verify(checkConfig, getPath("InputAvoidStarImportDefault.java"),
69                  expected2);
70      }
71  
72      @Test
73      public void testAllowClassImports() throws Exception {
74          final DefaultConfiguration checkConfig = createModuleConfig(AvoidStarImportCheck.class);
75          checkConfig.addAttribute("allowClassImports", "true");
76          // allow all class star imports
77          final String[] expected2 = {
78              "25: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
79              "26: " + getCheckMessage(MSG_KEY, "javax.swing.WindowConstants.*"),
80              "28: " + getCheckMessage(MSG_KEY, "java.io.File.*"), };
81          verify(checkConfig, getPath("InputAvoidStarImportDefault.java"), expected2);
82      }
83  
84      @Test
85      public void testAllowStaticMemberImports() throws Exception {
86          final DefaultConfiguration checkConfig = createModuleConfig(AvoidStarImportCheck.class);
87          checkConfig.addAttribute("allowStaticMemberImports", "true");
88          // allow all static star imports
89          final String[] expected2 = {
90              "7: " + getCheckMessage(MSG_KEY, "com.puppycrawl.tools.checkstyle.checks.imports.*"),
91              "9: " + getCheckMessage(MSG_KEY, "java.io.*"),
92              "10: " + getCheckMessage(MSG_KEY, "java.lang.*"),
93          };
94          verify(checkConfig, getPath("InputAvoidStarImportDefault.java"), expected2);
95      }
96  
97      @Test
98      public void testGetAcceptableTokens() {
99          final AvoidStarImportCheck testCheckObject =
100                 new AvoidStarImportCheck();
101         final int[] actual = testCheckObject.getAcceptableTokens();
102         final int[] expected = {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
103         assertArrayEquals("Default acceptable tokens are invalid", expected, actual);
104     }
105 
106     @Test
107     public void testGetRequiredTokens() {
108         final AvoidStarImportCheck testCheckObject =
109                 new AvoidStarImportCheck();
110         final int[] actual = testCheckObject.getRequiredTokens();
111         final int[] expected = {TokenTypes.IMPORT, TokenTypes.STATIC_IMPORT};
112 
113         assertArrayEquals("Default required tokens are invalid", expected, actual);
114     }
115 }