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.naming.AbstractNameCheck;
30  import com.puppycrawl.tools.checkstyle.checks.naming.IllegalIdentifierNameCheck;
31  
32  public class XpathRegressionIllegalIdentifierNameTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = IllegalIdentifierNameCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Test
42      public void testOne() throws Exception {
43          final File fileToProcess = new File(getNonCompilablePath(
44              "InputXpathIllegalIdentifierNameOne.java"));
45  
46          final DefaultConfiguration moduleConfig =
47              createModuleConfig(IllegalIdentifierNameCheck.class);
48  
49          final String format = "(?i)^(?!(record|yield|var|permits|sealed)$).+$";
50  
51          final String[] expectedViolation = {
52              "10:20: " + getCheckMessage(IllegalIdentifierNameCheck.class,
53                  AbstractNameCheck.MSG_INVALID_PATTERN, "yield", format),
54              };
55  
56          final List<String> expectedXpathQueries = Collections.singletonList(
57              "/COMPILATION_UNIT/RECORD_DEF"
58                  + "[./IDENT[@text='InputXpathIllegalIdentifierNameOne'"
59                  + "]]/RECORD_COMPONENTS/RECORD_COMPONENT_DEF/IDENT[@text='yield']"
60          );
61  
62          runVerifications(moduleConfig, fileToProcess, expectedViolation,
63              expectedXpathQueries);
64      }
65  
66      @Test
67      public void testTwo() throws Exception {
68          final File fileToProcess = new File(getNonCompilablePath(
69              "InputXpathIllegalIdentifierNameTwo.java"));
70  
71          final DefaultConfiguration moduleConfig =
72              createModuleConfig(IllegalIdentifierNameCheck.class);
73  
74          final String format = "(?i)^(?!(record|yield|var|permits|sealed)$).+$";
75  
76          final String[] expectedViolation = {
77              "9:17: " + getCheckMessage(IllegalIdentifierNameCheck.class,
78                  AbstractNameCheck.MSG_INVALID_PATTERN, "yield", format),
79              };
80  
81          final List<String> expectedXpathQueries = Collections.singletonList(
82              "/COMPILATION_UNIT/CLASS_DEF"
83                  + "[./IDENT[@text='InputXpathIllegalIdentifierNameTwo']"
84                  + "]/OBJBLOCK/METHOD_DEF[./IDENT[@text='foo']]/PARAMETERS/PARAMETER_DEF"
85                  + "/IDENT[@text='yield']"
86          );
87  
88          runVerifications(moduleConfig, fileToProcess, expectedViolation,
89              expectedXpathQueries);
90      }
91  }