View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.coding;
21  
22  import java.io.File;
23  import java.util.Arrays;
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.coding.NoCloneCheck;
31  
32  public class XpathRegressionNoCloneTest extends AbstractXpathTestSupport {
33  
34      private final String checkName = NoCloneCheck.class.getSimpleName();
35  
36      @Override
37      protected String getCheckName() {
38          return checkName;
39      }
40  
41      @Override
42      protected String getPackageLocation() {
43          return "org/checkstyle/suppressionxpathfilter/coding/noclone";
44      }
45  
46      @Test
47      public void testMethod() throws Exception {
48          final File fileToProcess =
49                  new File(getPath("InputXpathNoCloneMethod.java"));
50  
51          final DefaultConfiguration moduleConfig =
52                  createModuleConfig(NoCloneCheck.class);
53  
54          final String[] expectedViolation = {
55              "5:5: " + getCheckMessage(NoCloneCheck.class, NoCloneCheck.MSG_KEY),
56          };
57  
58          final List<String> expectedXpathQueries = Arrays.asList(
59                  "/COMPILATION_UNIT/CLASS_DEF"
60                      + "[./IDENT[@text='InputXpathNoCloneMethod']]/OBJBLOCK"
61                      + "/METHOD_DEF[./IDENT[@text='clone']]",
62                  "/COMPILATION_UNIT/CLASS_DEF"
63                      + "[./IDENT[@text='InputXpathNoCloneMethod']]/OBJBLOCK"
64                      + "/METHOD_DEF[./IDENT[@text='clone']]/MODIFIERS",
65                  "/COMPILATION_UNIT/CLASS_DEF"
66                      + "[./IDENT[@text='InputXpathNoCloneMethod']]/OBJBLOCK"
67                      + "/METHOD_DEF[./IDENT[@text='clone']]/MODIFIERS/LITERAL_PUBLIC"
68          );
69  
70          runVerifications(moduleConfig, fileToProcess, expectedViolation,
71                  expectedXpathQueries);
72      }
73  
74      @Test
75      public void testTwo() throws Exception {
76          final File fileToProcess =
77                  new File(getPath("InputXpathNoCloneInnerClass.java"));
78  
79          final DefaultConfiguration moduleConfig =
80                  createModuleConfig(NoCloneCheck.class);
81  
82          final String[] expectedViolation = {
83              "6:5: " + getCheckMessage(NoCloneCheck.class, NoCloneCheck.MSG_KEY),
84          };
85  
86          final List<String> expectedXpathQueries = Arrays.asList(
87                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathNoCloneInnerClass']]"
88                          + "/OBJBLOCK"
89                          + "/CLASS_DEF[./IDENT[@text='InnerClass']]/OBJBLOCK"
90                          + "/METHOD_DEF[./IDENT[@text='clone']]",
91                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathNoCloneInnerClass']]"
92                          + "/OBJBLOCK"
93                          + "/CLASS_DEF[./IDENT[@text='InnerClass']]/OBJBLOCK/"
94                          + "METHOD_DEF[./IDENT[@text='clone']]/MODIFIERS",
95                  "/COMPILATION_UNIT/CLASS_DEF[./IDENT[@text='InputXpathNoCloneInnerClass']]"
96                          + "/OBJBLOCK"
97                          + "/CLASS_DEF[./IDENT[@text='InnerClass']]/OBJBLOCK"
98                          + "/METHOD_DEF[./IDENT[@text='clone']]/MODIFIERS/LITERAL_PUBLIC"
99          );
100 
101         runVerifications(moduleConfig, fileToProcess, expectedViolation,
102                 expectedXpathQueries);
103     }
104 }