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 com.puppycrawl.tools.checkstyle.checks.naming;
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  
28  public class PatternVariableNameCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29      @Override
30      protected String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/naming/patternvariablename";
32      }
33  
34      @Test
35      public void testExample1() throws Exception {
36  
37          final String pattern = "^([a-z][a-zA-Z0-9]*|_)$";
38  
39          final String[] expected = {
40              "15:30: " + getCheckMessage(MSG_INVALID_PATTERN, "STRING", pattern),
41              "17:31: " + getCheckMessage(MSG_INVALID_PATTERN, "num_1", pattern),
42          };
43  
44          verifyWithInlineConfigParser(getNonCompilablePath("Example1.java"), expected);
45      }
46  
47      @Test
48      public void testExample2() throws Exception {
49  
50          final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
51  
52          final String[] expected = {
53              "17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "STRING", pattern),
54          };
55  
56          verifyWithInlineConfigParser(getNonCompilablePath("Example2.java"), expected);
57      }
58  
59      @Test
60      public void testExample3() throws Exception {
61  
62          final String pattern = "^[a-z][_a-zA-Z0-9]{2,}$";
63  
64          final String[] expected = {
65              "17:30: " + getCheckMessage(MSG_INVALID_PATTERN, "STRING", pattern),
66              "20:31: " + getCheckMessage(MSG_INVALID_PATTERN, "n", pattern),
67          };
68  
69          verifyWithInlineConfigParser(getNonCompilablePath("Example3.java"), expected);
70      }
71  
72      @Test
73      public void testExample4() throws Exception {
74  
75          final String[] expected = {
76              "37:30: " + getCheckMessage(MSG_INVALID_PATTERN, "BAD", "^([a-z][a-zA-Z0-9]*|_)$"),
77              "40:36: " + getCheckMessage(MSG_INVALID_PATTERN, "bad", "^[A-Z][A-Z0-9]*$"),
78          };
79  
80          verifyWithInlineConfigParser(getNonCompilablePath("Example4.java"), expected);
81      }
82  }