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.Collections;
25  import java.util.List;
26  
27  import org.junit.jupiter.api.Test;
28  
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.checks.coding.ArrayTrailingCommaCheck;
31  
32  public class XpathRegressionArrayTrailingCommaTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = ArrayTrailingCommaCheck.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 =
44                  new File(getPath("InputXpathArrayTrailingCommaLinear.java"));
45  
46          final DefaultConfiguration moduleConfig =
47                  createModuleConfig(ArrayTrailingCommaCheck.class);
48  
49          final String[] expectedViolation = {
50              "16:9: " + getCheckMessage(ArrayTrailingCommaCheck.class,
51                  ArrayTrailingCommaCheck.MSG_KEY),
52          };
53  
54          final List<String> expectedXpathQueries = Arrays.asList(
55              "/COMPILATION_UNIT/CLASS_DEF"
56                  + "[./IDENT[@text='InputXpathArrayTrailingCommaLinear']]"
57                  + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='a2']]/ASSIGN/EXPR/LITERAL_NEW"
58                  + "/ARRAY_INIT/EXPR[./NUM_INT[@text='3']]",
59              "/COMPILATION_UNIT/CLASS_DEF"
60                  + "[./IDENT[@text='InputXpathArrayTrailingCommaLinear']]"
61                  + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='a2']]/ASSIGN/EXPR/LITERAL_NEW"
62                  + "/ARRAY_INIT/EXPR/NUM_INT[@text='3']"
63          );
64  
65          runVerifications(moduleConfig, fileToProcess, expectedViolation,
66                  expectedXpathQueries);
67      }
68  
69      @Test
70      public void testTwo() throws Exception {
71          final File fileToProcess =
72                  new File(getPath("InputXpathArrayTrailingCommaMatrix.java"));
73  
74          final DefaultConfiguration moduleConfig =
75                  createModuleConfig(ArrayTrailingCommaCheck.class);
76  
77          final String[] expectedViolation = {
78              "17:9: " + getCheckMessage(ArrayTrailingCommaCheck.class,
79                  ArrayTrailingCommaCheck.MSG_KEY),
80          };
81  
82          final List<String> expectedXpathQueries = Collections.singletonList(
83              "/COMPILATION_UNIT/CLASS_DEF"
84                  + "[./IDENT[@text='InputXpathArrayTrailingCommaMatrix']]"
85                  + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='d2']]/ASSIGN/EXPR/LITERAL_NEW"
86                  + "/ARRAY_INIT/ARRAY_INIT[./EXPR/NUM_INT[@text='5']]"
87          );
88  
89          runVerifications(moduleConfig, fileToProcess, expectedViolation,
90                  expectedXpathQueries);
91      }
92  
93  }