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 org.checkstyle.suppressionxpathfilter;
21  
22  import java.io.File;
23  import java.util.Collections;
24  import java.util.List;
25  
26  import org.junit.jupiter.api.Test;
27  
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.checks.whitespace.NoWhitespaceBeforeCheck;
30  
31  public class XpathRegressionNoWhitespaceBeforeTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = NoWhitespaceBeforeCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void testNoWhitespaceBefore() throws Exception {
42          final File fileToProcess =
43                  new File(getPath("InputXpathNoWhitespaceBefore.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(NoWhitespaceBeforeCheck.class);
47  
48          final String[] expectedViolation = {
49              "4:13: " + getCheckMessage(NoWhitespaceBeforeCheck.class,
50                      NoWhitespaceBeforeCheck.MSG_KEY, ";"),
51          };
52  
53          final List<String> expectedXpathQueries = Collections.singletonList(
54              "/COMPILATION_UNIT/CLASS_DEF"
55                  + "[./IDENT[@text='InputXpathNoWhitespaceBefore']]/OBJBLOCK"
56                  + "/VARIABLE_DEF[./IDENT[@text='bad']]/SEMI"
57          );
58  
59          runVerifications(moduleConfig, fileToProcess, expectedViolation,
60                  expectedXpathQueries);
61      }
62  
63      @Test
64      public void testTokens() throws Exception {
65          final File fileToProcess =
66              new File(getPath("InputXpathNoWhitespaceBeforeTokens.java"));
67  
68          final DefaultConfiguration moduleConfig =
69              createModuleConfig(NoWhitespaceBeforeCheck.class);
70          moduleConfig.addProperty("tokens", "DOT");
71  
72          final String[] expectedViolation = {
73              "4:17: " + getCheckMessage(NoWhitespaceBeforeCheck.class,
74                  NoWhitespaceBeforeCheck.MSG_KEY, "."),
75          };
76  
77          final List<String> expectedXpathQueries = Collections.singletonList(
78              "/COMPILATION_UNIT/CLASS_DEF"
79                  + "[./IDENT[@text='InputXpathNoWhitespaceBeforeTokens']]"
80                  + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]"
81                  + "/TYPE/DOT[./IDENT[@text='String']]"
82                  + "/DOT[./IDENT[@text='java']]"
83          );
84  
85          runVerifications(moduleConfig, fileToProcess, expectedViolation,
86              expectedXpathQueries);
87      }
88  
89      @Test
90      public void testAllowLineBreaks() throws Exception {
91          final File fileToProcess =
92              new File(getPath("InputXpathNoWhitespaceBeforeLineBreaks.java"));
93  
94          final DefaultConfiguration moduleConfig =
95              createModuleConfig(NoWhitespaceBeforeCheck.class);
96          moduleConfig.addProperty("allowLineBreaks", "false");
97  
98          final String[] expectedViolation = {
99              "6:13: " + getCheckMessage(NoWhitespaceBeforeCheck.class,
100                 NoWhitespaceBeforeCheck.MSG_KEY, ","),
101         };
102 
103         final List<String> expectedXpathQueries = Collections.singletonList(
104             "/COMPILATION_UNIT/CLASS_DEF"
105                 + "[./IDENT[@text='InputXpathNoWhitespaceBeforeLineBreaks']]"
106                 + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]"
107                 + "/SLIST/VARIABLE_DEF[./IDENT[@text='array']]"
108                 + "/ASSIGN/ARRAY_INIT/COMMA"
109         );
110 
111         runVerifications(moduleConfig, fileToProcess, expectedViolation,
112             expectedXpathQueries);
113     }
114 }