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 org.checkstyle.suppressionxpathfilter.whitespace;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.checkstyle.suppressionxpathfilter.AbstractXpathTestSupport;
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.checks.whitespace.ArrayBracketNoWhitespaceCheck;
31  
32  public class XpathRegressionArrayBracketNoWhitespaceTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = ArrayBracketNoWhitespaceCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Override
42      public String getPackageLocation() {
43          return "org/checkstyle/suppressionxpathfilter/whitespace/arraybracketnowhitespace";
44      }
45  
46      @Test
47      public void testArrayBracketNoWhitespacePreceded() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathArrayBracketNoWhitespacePreceded.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(ArrayBracketNoWhitespaceCheck.class);
53  
54          final String[] expectedViolation = {
55              "4:9: " + getCheckMessage(ArrayBracketNoWhitespaceCheck.class,
56                      ArrayBracketNoWhitespaceCheck.MSG_WS_PRECEDED, "["),
57          };
58  
59          final List<String> expectedXpathQueries = Collections.singletonList(
60              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
61                  + "@text='InputXpathArrayBracketNoWhitespacePreceded']]/OBJBLOCK"
62                  + "/VARIABLE_DEF[./IDENT[@text='bad']]/TYPE/ARRAY_DECLARATOR"
63          );
64  
65          runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
66      }
67  
68      @Test
69      public void testArrayBracketNoWhitespaceFollowed() throws Exception {
70          final File fileToProcess =
71                  new File(getPath("InputXpathArrayBracketNoWhitespaceFollowed.java"));
72  
73          final DefaultConfiguration moduleConfig =
74                  createModuleConfig(ArrayBracketNoWhitespaceCheck.class);
75  
76          final String[] expectedViolation = {
77              "5:32: " + getCheckMessage(ArrayBracketNoWhitespaceCheck.class,
78                      ArrayBracketNoWhitespaceCheck.MSG_WS_FOLLOWED, "["),
79          };
80  
81          final List<String> expectedXpathQueries = Collections.singletonList(
82              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
83                  + "@text='InputXpathArrayBracketNoWhitespaceFollowed']]/OBJBLOCK"
84                  + "/METHOD_DEF[./IDENT[@text='bad']]/SLIST/VARIABLE_DEF[./IDENT[@text='offsets']]"
85                  + "/ASSIGN/EXPR/LITERAL_NEW/ARRAY_DECLARATOR"
86          );
87  
88          runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
89      }
90  
91      @Test
92      public void testArrayBracketNoWhitespaceNotFollowed() throws Exception {
93          final File fileToProcess =
94                  new File(getPath("InputXpathArrayBracketNoWhitespaceNotFollowed.java"));
95  
96          final DefaultConfiguration moduleConfig =
97                  createModuleConfig(ArrayBracketNoWhitespaceCheck.class);
98  
99          final String[] expectedViolation = {
100             "6:26: " + getCheckMessage(ArrayBracketNoWhitespaceCheck.class,
101                     ArrayBracketNoWhitespaceCheck.MSG_WS_NOT_FOLLOWED, "]"),
102         };
103 
104         final List<String> expectedXpathQueries = Collections.singletonList(
105             "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
106                 + "@text='InputXpathArrayBracketNoWhitespaceNotFollowed']]/OBJBLOCK"
107                 + "/METHOD_DEF[./IDENT[@text='bad']]/SLIST/VARIABLE_DEF[./IDENT[@text='total']]"
108                 + "/ASSIGN/EXPR/PLUS[./NUM_INT[@text='5']]/INDEX_OP[./IDENT[@text='arr']]/RBRACK"
109         );
110 
111         runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
112     }
113 
114 }