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;
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.design.DesignForExtensionCheck;
30  
31  public class XpathRegressionDesignForExtensionTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = DesignForExtensionCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void test() throws Exception {
42          final File fileToProcess =
43                  new File(getPath("InputXpathDesignForExtensionClass.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(DesignForExtensionCheck.class);
47          moduleConfig.addProperty("ignoredAnnotations", "Override");
48  
49          final String[] expected = {
50              "7:5: " + getCheckMessage(DesignForExtensionCheck.class,
51                      DesignForExtensionCheck.MSG_KEY,
52                      "InputXpathDesignForExtensionClass",
53                      "calculateValue"),
54          };
55  
56          final List<String> expectedXpathQueries = Arrays.asList(
57              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
58                 + "[@text='InputXpathDesignForExtensionClass']]/OBJBLOCK"
59                 + "/METHOD_DEF[./IDENT[@text='calculateValue']]",
60              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
61                 + "[@text='InputXpathDesignForExtensionClass']]/OBJBLOCK"
62                 + "/METHOD_DEF[./IDENT[@text='calculateValue']]/MODIFIERS",
63              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
64                 + "[@text='InputXpathDesignForExtensionClass']]/OBJBLOCK"
65                 + "/METHOD_DEF[./IDENT[@text='calculateValue']]/MODIFIERS/LITERAL_PUBLIC"
66          );
67  
68          // Run the verifications
69          runVerifications(moduleConfig, fileToProcess, expected, expectedXpathQueries);
70  
71      }
72  
73      @Test
74      public void test2() throws Exception {
75          final File fileToProcess =
76                  new File(getPath("InputXpathDesignForExtensionWithEnum.java"));
77  
78          final DefaultConfiguration moduleConfig =
79                  createModuleConfig(DesignForExtensionCheck.class);
80          moduleConfig.addProperty("ignoredAnnotations", "Override");
81          moduleConfig.addProperty("requiredJavadocPhrase", "This[\\s\\S]*implementation");
82  
83          final String[] expected = {
84              "23:5: " + getCheckMessage(DesignForExtensionCheck.class,
85                      DesignForExtensionCheck.MSG_KEY,
86                      "InputXpathDesignForExtensionWithEnum",
87                      "processData"),
88          };
89  
90          final List<String> expectedXpathQueries = Arrays.asList(
91              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
92                 + "[@text='InputXpathDesignForExtensionWithEnum']]/OBJBLOCK"
93                 + "/METHOD_DEF[./IDENT[@text='processData']]",
94              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
95                 + "[@text='InputXpathDesignForExtensionWithEnum']]/OBJBLOCK"
96                 + "/METHOD_DEF[./IDENT[@text='processData']]/MODIFIERS",
97              "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
98                 + "[@text='InputXpathDesignForExtensionWithEnum']]/OBJBLOCK"
99                 + "/METHOD_DEF[./IDENT[@text='processData']]/MODIFIERS/LITERAL_PUBLIC"
100         );
101 
102         // Run the verifications
103         runVerifications(moduleConfig, fileToProcess, expected, expectedXpathQueries);
104 
105     }
106 }