View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 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.TrailingCommentCheck;
30  
31  public class XpathRegressionTrailingCommentTest extends AbstractXpathTestSupport {
32  
33      private final String checkName = TrailingCommentCheck.class.getSimpleName();
34  
35      @Override
36      protected String getCheckName() {
37          return checkName;
38      }
39  
40      @Test
41      public void testSingleLine() throws Exception {
42          final File fileToProcess = new File(getPath(
43                  "InputXpathTrailingCommentSingleLine.java"));
44  
45          final DefaultConfiguration moduleConfig =
46                  createModuleConfig(TrailingCommentCheck.class);
47  
48          final String[] expectedViolation = {
49              "4:12: " + getCheckMessage(TrailingCommentCheck.class,
50                          TrailingCommentCheck.MSG_KEY),
51          };
52  
53          final List<String> expectedXpathQueries = Collections.singletonList(
54                  "/COMPILATION_UNIT/CLASS_DEF"
55                          + "[./IDENT[@text='InputXpathTrailingCommentSingleLine']]/"
56                          + "OBJBLOCK/SINGLE_LINE_COMMENT[./COMMENT_CONTENT[@text=' don&apos;"
57                          + "&apos;t use trailing comments :) // warn\\n']]"
58          );
59  
60          runVerifications(moduleConfig, fileToProcess, expectedViolation,
61                  expectedXpathQueries);
62      }
63  
64      @Test
65      public void testBlock() throws Exception {
66          final File fileToProcess = new File(getPath(
67                  "InputXpathTrailingCommentBlock.java"));
68  
69          final DefaultConfiguration moduleConfig =
70                  createModuleConfig(TrailingCommentCheck.class);
71  
72          final String[] expectedViolation = {
73              "4:40: " + getCheckMessage(TrailingCommentCheck.class,
74                          TrailingCommentCheck.MSG_KEY),
75          };
76  
77          final List<String> expectedXpathQueries = Collections.singletonList(
78                  "/COMPILATION_UNIT/CLASS_DEF"
79                          + "[./IDENT[@text='InputXpathTrailingCommentBlock']]"
80                          + "/OBJBLOCK/SINGLE_LINE_COMMENT[./COMMENT_CONTENT[@text=' warn\\n']]"
81          );
82  
83          runVerifications(moduleConfig, fileToProcess, expectedViolation,
84                  expectedXpathQueries);
85      }
86  
87      @Test
88      public void testInsideMethod() throws Exception {
89          final File fileToProcess = new File(getPath(
90                  "InputXpathTrailingCommentInsideMethod.java"));
91  
92          final DefaultConfiguration moduleConfig =
93                  createModuleConfig(TrailingCommentCheck.class);
94  
95          final String[] expectedViolation = {
96              "5:20: " + getCheckMessage(TrailingCommentCheck.class,
97                          TrailingCommentCheck.MSG_KEY),
98          };
99  
100         final List<String> expectedXpathQueries = Collections.singletonList(
101                 "/COMPILATION_UNIT/CLASS_DEF"
102                         + "[./IDENT[@text='InputXpathTrailingCommentInsideMethod']]"
103                         + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='method']]"
104                         + "/SLIST/SINGLE_LINE_COMMENT[./COMMENT_CONTENT[@text=' warn\\n']]"
105         );
106 
107         runVerifications(moduleConfig, fileToProcess, expectedViolation,
108                 expectedXpathQueries);
109     }
110 
111 }