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.Arrays;
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.EmptyForIteratorPadCheck;
30  import com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption;
31  
32  public class XpathRegressionEmptyForIteratorPadTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = EmptyForIteratorPadCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Test
42      public void testFollowed() throws Exception {
43          final File fileToProcess =
44                  new File(getPath("InputXpathEmptyForIteratorPadFollowed.java"));
45  
46          final DefaultConfiguration moduleConfig =
47                  createModuleConfig(EmptyForIteratorPadCheck.class);
48  
49          final String[] expectedViolation = {
50              "5:34: " + getCheckMessage(EmptyForIteratorPadCheck.class,
51                      EmptyForIteratorPadCheck.MSG_WS_FOLLOWED, ";"),
52          };
53  
54          final List<String> expectedXpathQueries = Arrays.asList(
55              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
56                  + "@text='InputXpathEmptyForIteratorPadFollowed']]/OBJBLOCK"
57                  + "/METHOD_DEF[./IDENT[@text='method']]/SLIST/LITERAL_FOR/FOR_ITERATOR",
58              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
59                  + "@text='InputXpathEmptyForIteratorPadFollowed']]/OBJBLOCK"
60                  + "/METHOD_DEF[./IDENT[@text='method']]/SLIST/LITERAL_FOR/RPAREN"
61          );
62  
63          runVerifications(moduleConfig, fileToProcess, expectedViolation,
64                  expectedXpathQueries);
65      }
66  
67      @Test
68      public void testNotFollowed() throws Exception {
69          final File fileToProcess =
70                  new File(getPath("InputXpathEmptyForIteratorPadNotFollowed.java"));
71  
72          final DefaultConfiguration moduleConfig =
73                  createModuleConfig(EmptyForIteratorPadCheck.class);
74          moduleConfig.addProperty("option", PadOption.SPACE.toString());
75  
76          final String[] expectedViolation = {
77              "5:33: " + getCheckMessage(EmptyForIteratorPadCheck.class,
78                      EmptyForIteratorPadCheck.MSG_WS_NOT_FOLLOWED, ";"),
79          };
80  
81          final List<String> expectedXpathQueries = Arrays.asList(
82              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
83                  + "@text='InputXpathEmptyForIteratorPadNotFollowed']]/OBJBLOCK"
84                  + "/METHOD_DEF[./IDENT[@text='method']]/SLIST/LITERAL_FOR/FOR_ITERATOR",
85              "/COMPILATION_UNIT/CLASS_DEF[./IDENT["
86                  + "@text='InputXpathEmptyForIteratorPadNotFollowed']]/OBJBLOCK"
87                  + "/METHOD_DEF[./IDENT[@text='method']]/SLIST/LITERAL_FOR/RPAREN"
88          );
89  
90          runVerifications(moduleConfig, fileToProcess, expectedViolation,
91                  expectedXpathQueries);
92      }
93  
94  }