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.javadoc.JavadocContentLocationCheck;
30  
31  public class XpathRegressionJavadocContentLocationTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = JavadocContentLocationCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void testOne() throws Exception {
42          final File fileToProcess =
43                  new File(getPath("InputXpathJavadocContentLocationOne.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(JavadocContentLocationCheck.class);
47  
48          final String[] expectedViolation = {
49              "5:5: " + getCheckMessage(JavadocContentLocationCheck.class,
50                      JavadocContentLocationCheck.MSG_JAVADOC_CONTENT_SECOND_LINE),
51          };
52  
53          final List<String> expectedXpathQueries = Collections.singletonList(
54              "/COMPILATION_UNIT/INTERFACE_DEF"
55                  + "[./IDENT[@text='InputXpathJavadocContentLocationOne']]"
56                  + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/BLOCK_COMMENT_BEGIN"
57                  + "[./COMMENT_CONTENT[@text='* Text. // warn\\n     ']]"
58          );
59  
60          runVerifications(moduleConfig, fileToProcess, expectedViolation,
61                  expectedXpathQueries);
62      }
63  
64      @Test
65      public void testTwo() throws Exception {
66          final File fileToProcess =
67                  new File(getPath("InputXpathJavadocContentLocationTwo.java"));
68  
69          final DefaultConfiguration moduleConfig =
70                  createModuleConfig(JavadocContentLocationCheck.class);
71  
72          moduleConfig.addProperty("location", "first_line");
73  
74          final String[] expectedViolation = {
75              "5:16: " + getCheckMessage(JavadocContentLocationCheck.class,
76                      JavadocContentLocationCheck.MSG_JAVADOC_CONTENT_FIRST_LINE),
77          };
78  
79          final List<String> expectedXpathQueries = Collections.singletonList(
80              "/COMPILATION_UNIT/INTERFACE_DEF[./IDENT"
81                      + "[@text='InputXpathJavadocContentLocationTwo']]"
82                      + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/BLOCK_COMMENT_BEGIN"
83                      + "[./COMMENT_CONTENT[@text='*\\n     * Text.\\n     ']]"
84          );
85  
86          runVerifications(moduleConfig, fileToProcess, expectedViolation,
87                  expectedXpathQueries);
88      }
89  
90  }