View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.blocks;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.blocks.NeedBracesCheck.MSG_KEY_NEED_BRACES;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
28  
29  public class NeedBracesCheckExamplesTest extends AbstractExamplesModuleTestSupport {
30      @Override
31      protected String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/blocks/needbraces";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = {
38              "20:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "if"),
39              "24:7: " + getCheckMessage(MSG_KEY_NEED_BRACES, "else"),
40              "29:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "do"),
41              "32:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "for"),
42              "34:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "for"),
43              "36:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
44              "39:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
45          };
46  
47          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
48      }
49  
50      @Test
51      public void testExample2() throws Exception {
52          final String[] expected = {
53              "22:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "if"),
54              "26:7: " + getCheckMessage(MSG_KEY_NEED_BRACES, "else"),
55          };
56  
57          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
58      }
59  
60      @Test
61      public void testExample3() throws Exception {
62          final String[] expected = {
63              "33:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "do"),
64              "40:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
65  
66          };
67  
68          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
69      }
70  
71      @Test
72      public void testExample4() throws Exception {
73          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
74  
75          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
76      }
77  
78      @Test
79      public void testExample5() throws Exception {
80          final String[] expected = {
81              "39:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
82          };
83  
84          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
85      }
86  
87      @Test
88      public void testExample6() throws Exception {
89          final String[] expected = {
90              "25:38: " + getCheckMessage(MSG_KEY_NEED_BRACES, "->"),
91          };
92  
93          verifyWithInlineConfigParser(getPath("Example6.java"), expected);
94      }
95  }