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