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 com.puppycrawl.tools.checkstyle.checks.coding;
21  
22  import org.junit.jupiter.api.Test;
23  
24  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
25  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
26  
27  public class RequireThisCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28      @Override
29      protected String getPackageLocation() {
30          return "com/puppycrawl/tools/checkstyle/checks/coding/requirethis";
31      }
32  
33      @Test
34      public void testExample1() throws Exception {
35          final String[] expected = {
36              "26:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field3", ""),
37          };
38  
39          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
40      }
41  
42      @Test
43      public void testExample2() throws Exception {
44          final String[] expected = {
45              "19:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field2", ""),
46              "29:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field3", ""),
47          };
48  
49          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
50      }
51  
52      @Test
53      public void testExample3() throws Exception {
54          final String[] expected = {
55              "20:5: " + getCheckMessage(RequireThisCheck.MSG_METHOD, "foo", ""),
56              "24:5: " + getCheckMessage(RequireThisCheck.MSG_METHOD, "foo", ""),
57          };
58  
59          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
60      }
61  
62      @Test
63      public void testExample4() throws Exception {
64          final String[] expected = {
65              "18:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field2", ""),
66              "19:5: " + getCheckMessage(RequireThisCheck.MSG_METHOD, "foo", ""),
67              "23:5: " + getCheckMessage(RequireThisCheck.MSG_METHOD, "foo", ""),
68              "28:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field3", ""),
69          };
70  
71          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
72      }
73  
74      @Test
75      public void testExample5() throws Exception {
76          final String[] expected = {
77              "23:5: " + getCheckMessage(RequireThisCheck.MSG_VARIABLE, "field2", ""),
78          };
79  
80          verifyWithInlineConfigParser(getPath("Example5.java"), expected);
81      }
82  
83      @Test
84      public void testExample6() throws Exception {
85          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
86          verifyWithInlineConfigParser(getPath("Example6.java"), expected);
87      }
88  }