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;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.NoCodeInFileCheck.MSG_KEY_NO_CODE;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30  
31  public class NoCodeInFileCheckTest extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/nocodeinfile";
36      }
37  
38      @Test
39      public void testGetRequiredTokens() {
40          final NoCodeInFileCheck checkObj = new NoCodeInFileCheck();
41          assertWithMessage("Required tokens array is not empty")
42                  .that(checkObj.getRequiredTokens())
43                  .isEmpty();
44      }
45  
46      @Test
47      public void testGetAcceptableTokens() {
48          final NoCodeInFileCheck checkObj = new NoCodeInFileCheck();
49          assertWithMessage("Acceptable tokens array is not empty")
50                  .that(checkObj.getAcceptableTokens())
51                  .isEmpty();
52      }
53  
54      @Test
55      public void testBlank() throws Exception {
56          final DefaultConfiguration checkConfig = createModuleConfig(NoCodeInFileCheck.class);
57          final String[] expected = {
58              "1: " + getCheckMessage(MSG_KEY_NO_CODE),
59          };
60          verify(checkConfig, getPath("InputNoCodeInFile1.java"), expected);
61      }
62  
63      @Test
64      public void testSingleLineComment() throws Exception {
65          final DefaultConfiguration checkConfig = createModuleConfig(NoCodeInFileCheck.class);
66          final String[] expected = {
67              "1: " + getCheckMessage(MSG_KEY_NO_CODE),
68          };
69          verify(checkConfig, getPath("InputNoCodeInFile2.java"), expected);
70      }
71  
72      @Test
73      public void testMultiLineComment() throws Exception {
74          final String[] expected = {
75              "1: " + getCheckMessage(MSG_KEY_NO_CODE),
76          };
77          verifyWithInlineConfigParser(
78                  getPath("InputNoCodeInFile3.java"), expected);
79      }
80  
81      @Test
82      public void testFileContainingCode() throws Exception {
83          verifyWithInlineConfigParser(
84                  getPath("InputNoCodeInFile4.java"),
85                  CommonUtil.EMPTY_STRING_ARRAY);
86      }
87  
88      @Test
89      public void testBothSingleLineAndMultiLineComment() throws Exception {
90          final String[] expected = {
91              "1: " + getCheckMessage(MSG_KEY_NO_CODE),
92          };
93          verifyWithInlineConfigParser(
94                  getPath("InputNoCodeInFile5.java"), expected);
95      }
96  }