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 MagicNumberCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28      @Override
29      protected String getPackageLocation() {
30          return "com/puppycrawl/tools/checkstyle/checks/coding/magicnumber";
31      }
32  
33      @Test
34      public void testExample1() throws Exception {
35          final String[] expected = {
36              "12:22: " + getCheckMessage(
37                      MagicNumberCheck.MSG_KEY, 6),
38              "14:23: " + getCheckMessage(
39                      MagicNumberCheck.MSG_KEY, 7),
40              "18:13: " + getCheckMessage(
41                      MagicNumberCheck.MSG_KEY, 8),
42              "37:12: " + getCheckMessage(
43                      MagicNumberCheck.MSG_KEY, 10),
44          };
45  
46          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
47      }
48  
49      @Test
50      public void testExample2() throws Exception {
51          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
52  
53          verifyWithInlineConfigParser(getPath("Example2.java"), expected);
54      }
55  
56      @Test
57      public void testExample3() throws Exception {
58          final String[] expected = {
59              "14:22: " + getCheckMessage(
60                      MagicNumberCheck.MSG_KEY, 6),
61              "20:13: " + getCheckMessage(
62                      MagicNumberCheck.MSG_KEY, 8),
63              "39:12: " + getCheckMessage(
64                      MagicNumberCheck.MSG_KEY, 10),
65          };
66  
67          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
68      }
69  
70      @Test
71      public void testExample4() throws Exception {
72          final String[] expected = {
73              "14:22: " + getCheckMessage(
74                      MagicNumberCheck.MSG_KEY, 6),
75              "16:23: " + getCheckMessage(
76                      MagicNumberCheck.MSG_KEY, 7),
77              "20:13: " + getCheckMessage(
78                      MagicNumberCheck.MSG_KEY, 8),
79              "39:12: " + getCheckMessage(
80                      MagicNumberCheck.MSG_KEY, 10),
81              "42:25: " + getCheckMessage(
82                      MagicNumberCheck.MSG_KEY, 10),
83              "43:29: " + getCheckMessage(
84                      MagicNumberCheck.MSG_KEY, 10),
85          };
86  
87          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
88      }
89  
90      @Test
91      public void testExample5() throws Exception {
92          final String[] expected = {
93              "15:22: " + getCheckMessage(
94                      MagicNumberCheck.MSG_KEY, 6),
95              "17:23: " + getCheckMessage(
96                      MagicNumberCheck.MSG_KEY, 7),
97              "21:13: " + getCheckMessage(
98                      MagicNumberCheck.MSG_KEY, 8),
99              "24:48: " + getCheckMessage(
100                     MagicNumberCheck.MSG_KEY, 62),
101             "30:27: " + getCheckMessage(
102                     MagicNumberCheck.MSG_KEY, 10),
103             "30:31: " + getCheckMessage(
104                     MagicNumberCheck.MSG_KEY, 20),
105             "34:19: " + getCheckMessage(
106                     MagicNumberCheck.MSG_KEY, 3),
107             "34:23: " + getCheckMessage(
108                     MagicNumberCheck.MSG_KEY, 4),
109             "40:19: " + getCheckMessage(
110                     MagicNumberCheck.MSG_KEY, 3),
111             "40:23: " + getCheckMessage(
112                     MagicNumberCheck.MSG_KEY, 4),
113             "50:12: " + getCheckMessage(
114                     MagicNumberCheck.MSG_KEY, 10),
115         };
116 
117         verifyWithInlineConfigParser(getPath("Example5.java"), expected);
118     }
119 
120     @Test
121     public void testExample6() throws Exception {
122         final String[] expected = {
123             "14:22: " + getCheckMessage(
124                     MagicNumberCheck.MSG_KEY, 6),
125             "16:23: " + getCheckMessage(
126                     MagicNumberCheck.MSG_KEY, 7),
127             "20:13: " + getCheckMessage(
128                     MagicNumberCheck.MSG_KEY, 8),
129         };
130 
131         verifyWithInlineConfigParser(getPath("Example6.java"), expected);
132     }
133 }