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