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.header;
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 RegexpHeaderCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28      @Override
29      public String getPackageLocation() {
30          return "com/puppycrawl/tools/checkstyle/checks/header/regexpheader";
31      }
32  
33      @Test
34      public void testExample1() throws Exception {
35          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
36          verifyWithExternalXmlConfig(getPath("Example1.xml"),
37                                      getPath("Example1.java"),
38                                       expected);
39      }
40  
41      @Test
42      public void testExample2() throws Exception {
43          final String[] expected = {
44              "1: " + getCheckMessage(RegexpHeaderCheck.MSG_HEADER_MISSING),
45          };
46  
47          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
48          verifyWithExternalXmlConfig(getPath("Example2.xml"),
49                                      getPath("Example2.java"),
50                                       expected);
51      }
52  
53      @Test
54      public void testExample3() throws Exception {
55          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
56  
57          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
58          verifyWithExternalXmlConfig(getPath("Example3.xml"),
59                                      getPath("Example3.java"),
60                                       expected);
61      }
62  
63      @Test
64      public void testExample4() throws Exception {
65          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
66          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
67          verifyWithExternalXmlConfig(getPath("Example4.xml"),
68                                      getPath("Example4.java"),
69                                       expected);
70      }
71  }