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.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  
31      @Override
32      public String getPackageLocation() {
33          return "com/puppycrawl/tools/checkstyle/checks/blocks/needbraces";
34      }
35  
36      @Test
37      public void testExample1() throws Exception {
38          final String[] expected = {
39              "20:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "if"),
40              "24:7: " + getCheckMessage(MSG_KEY_NEED_BRACES, "else"),
41              "29:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "do"),
42              "32:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "for"),
43              "34:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "for"),
44              "36:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
45              "39:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
46          };
47  
48          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
49      }
50  
51      @Test
52      public void testExample2() throws Exception {
53          final String[] expected = {
54              "22:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "if"),
55              "26:7: " + getCheckMessage(MSG_KEY_NEED_BRACES, "else"),
56          };
57  
58          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
59      }
60  
61      @Test
62      public void testExample3() throws Exception {
63          final String[] expected = {
64              "33:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "do"),
65              "40:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
66  
67          };
68  
69          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
70      }
71  
72      @Test
73      public void testUseCase1() throws Exception {
74          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
75  
76          verifyWithInlineConfigParser(getPath("UseCase1.java"), expected);
77      }
78  
79      @Test
80      public void testExample4() throws Exception {
81          final String[] expected = {
82              "39:5: " + getCheckMessage(MSG_KEY_NEED_BRACES, "while"),
83          };
84  
85          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
86      }
87  
88      @Test
89      public void testUseCase2() throws Exception {
90          final String[] expected = {
91              "25:38: " + getCheckMessage(MSG_KEY_NEED_BRACES, "->"),
92          };
93  
94          verifyWithInlineConfigParser(getPath("UseCase2.java"), expected);
95      }
96  
97  }