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.whitespace;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.whitespace.NoLineWrapCheck.MSG_KEY;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
28  
29  public class NoLineWrapCheckTest
30      extends AbstractModuleTestSupport {
31  
32      @Override
33      public String getPackageLocation() {
34          return "com/puppycrawl/tools/checkstyle/checks/whitespace/nolinewrap";
35      }
36  
37      @Test
38      public void testCaseWithoutLineWrapping() throws Exception {
39          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
40          verifyWithInlineConfigParser(
41                  getPath("InputNoLineWrapGood.java"), expected);
42      }
43  
44      @Test
45      public void testDefaultTokensLineWrapping() throws Exception {
46          final String[] expected = {
47              "8:1: " + getCheckMessage(MSG_KEY, "package"),
48              "13:1: " + getCheckMessage(MSG_KEY, "import"),
49              "17:1: " + getCheckMessage(MSG_KEY, "import"),
50          };
51          verifyWithInlineConfigParser(
52                  getPath("InputNoLineWrapBad.java"), expected);
53      }
54  
55      @Test
56      public void testCustomTokensLineWrapping()
57              throws Exception {
58          final String[] expected = {
59              "14:1: " + getCheckMessage(MSG_KEY, "import"),
60              "18:1: " + getCheckMessage(MSG_KEY, "import"),
61              "21:1: " + getCheckMessage(MSG_KEY, "CLASS_DEF"),
62              "24:9: " + getCheckMessage(MSG_KEY, "METHOD_DEF"),
63              "31:1: " + getCheckMessage(MSG_KEY, "ENUM_DEF"),
64          };
65          verifyWithInlineConfigParser(
66                  getPath("InputNoLineWrapBad2.java"), expected);
67      }
68  
69      @Test
70      public void testNoLineWrapRecordsAndCompactCtors()
71              throws Exception {
72  
73          final String[] expected = {
74              "14:9: " + getCheckMessage(MSG_KEY, "CTOR_DEF"),
75              "20:5: " + getCheckMessage(MSG_KEY, "RECORD_DEF"),
76              "29:9: " + getCheckMessage(MSG_KEY, "CTOR_DEF"),
77              "35:5: " + getCheckMessage(MSG_KEY, "RECORD_DEF"),
78              "37:9: " + getCheckMessage(MSG_KEY, "COMPACT_CTOR_DEF"),
79              "42:5: " + getCheckMessage(MSG_KEY, "RECORD_DEF"),
80              "44:9: " + getCheckMessage(MSG_KEY, "COMPACT_CTOR_DEF"),
81              "49:9: " + getCheckMessage(MSG_KEY, "RECORD_DEF"),
82              "51:13: " + getCheckMessage(MSG_KEY, "COMPACT_CTOR_DEF"),
83          };
84          verifyWithInlineConfigParser(
85                  getPath("InputNoLineWrapRecordsAndCompactCtors.java"),
86                  expected);
87      }
88  
89      @Test
90      public void testNoLineWrapModuleImport() throws Exception {
91          final String[] expected = {
92              "15:1: " + getCheckMessage(MSG_KEY, "import"),
93              "22:1: " + getCheckMessage(MSG_KEY, "import"),
94          };
95          verifyWithInlineConfigParser(
96                  getNonCompilablePath("InputNoLineWrapModuleImport.java"), expected);
97      }
98  
99      @Test
100     public void testNoLineWrapModuleDef() throws Exception {
101         final String[] expected = {
102             "11:1: " + getCheckMessage(MSG_KEY, "MODULE_DEF"),
103         };
104         verifyWithInlineConfigParser(
105                 getNonCompilablePath("module-info/wrapped/module-info.java"), expected);
106     }
107 
108     @Test
109     public void testNoLineWrapModuleDefGood() throws Exception {
110         final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
111         verifyWithInlineConfigParser(
112                 getNonCompilablePath("module-info/unwrapped/module-info.java"), expected);
113     }
114 
115     @Test
116     public void testNoLineWrapModuleDefWithAnnotation() throws Exception {
117         final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
118         verifyWithInlineConfigParser(
119                 getNonCompilablePath("module-info/annotated/module-info.java"), expected);
120     }
121 
122     @Test
123     public void testNoLineWrapModuleDefWithAnnotationSkipFalse() throws Exception {
124         final String[] expected = {
125             "11:1: " + getCheckMessage(MSG_KEY, "MODULE_DEF"),
126         };
127         verifyWithInlineConfigParser(
128                 getNonCompilablePath("module-info/strict/module-info.java"), expected);
129     }
130 
131     @Test
132     public void testNoLineWrapWithSkipAnnotationsFalse() throws Exception {
133         final String[] expected = {
134             "10:1: " + getCheckMessage(MSG_KEY, "CLASS_DEF"),
135             "14:5: " + getCheckMessage(MSG_KEY, "CTOR_DEF"),
136             "19:5: " + getCheckMessage(MSG_KEY, "METHOD_DEF"),
137             "25:5: " + getCheckMessage(MSG_KEY, "ENUM_DEF"),
138             "31:5: " + getCheckMessage(MSG_KEY, "RECORD_DEF"),
139             "34:9: " + getCheckMessage(MSG_KEY, "COMPACT_CTOR_DEF"),
140         };
141         verifyWithInlineConfigParser(
142                 getPath("InputNoLineWrapSkipAnnotationsFalse.java"), expected);
143     }
144 
145     @Test
146     public void testNoLineWrapWithSkipAnnotationsTrue() throws Exception {
147         final String[] expected = {
148             "22:5: " + getCheckMessage(MSG_KEY, "METHOD_DEF"),
149         };
150         verifyWithInlineConfigParser(
151                 getPath("InputNoLineWrapSkipAnnotationsTrue.java"), expected);
152     }
153 
154 }