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 com.puppycrawl.tools.checkstyle.filters;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  import com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck;
28  
29  public class SuppressWarningsFilterExamplesTest extends AbstractExamplesModuleTestSupport {
30  
31      @Override
32      public String getPackageLocation() {
33          return "com/puppycrawl/tools/checkstyle/filters/suppresswarningsfilter";
34      }
35  
36      @Test
37      public void testExample1() throws Exception {
38          final String pattern = "^[a-z][a-zA-Z0-9]*$";
39  
40          final String[] expectedWithoutFilter = {
41              "17:7: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "J", pattern),
42              "18:7: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "JJ", pattern),
43              "21:7: 'int' is followed by whitespace.",
44              "21:10: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "ARRAY",
45                      pattern),
46              "23:7: 'int' is followed by whitespace.",
47              "23:10: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "ARRAY2",
48                      pattern),
49          };
50  
51          final String[] expectedWithFilter = {
52              "18:7: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "JJ", pattern),
53              "23:7: 'int' is followed by whitespace.",
54              "23:10: " + getCheckMessage(MemberNameCheck.class, MSG_INVALID_PATTERN, "ARRAY2",
55                      pattern),
56          };
57  
58          verifyFilterWithInlineConfigParser(getPath("Example1.java"),
59                  expectedWithoutFilter, expectedWithFilter);
60      }
61  
62      @Test
63      public void testExample2() throws Exception {
64          final String[] expectedWithoutFilter = {
65              "9: Dont use System.out/err, use SLF4J instead.",
66              "32: Dont use System.out/err, use SLF4J instead.",
67              "36: Dont use System.out/err, use SLF4J instead.",
68          };
69  
70          final String[] expectedWithFilter = {
71              "9: Dont use System.out/err, use SLF4J instead.",
72              "36: Dont use System.out/err, use SLF4J instead.",
73          };
74  
75          verifyFilterWithInlineConfigParser(getPath("Example2.java"),
76                  expectedWithoutFilter, expectedWithFilter);
77      }
78  
79  }