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 MultiFileRegexpHeaderCheckExamplesTest extends AbstractExamplesModuleTestSupport {
28  
29      @Override
30      public String getPackageLocation() {
31          return "com/puppycrawl/tools/checkstyle/checks/header/multifileregexpheader";
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 path =
45                       "src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/header/"
46                        + "multifileregexpheader/java.header, "
47                      + "src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/header/"
48                         + "multifileregexpheader/apache.header";
49          final String[] expected = {
50              "1: " + getCheckMessage(MultiFileRegexpHeaderCheck.MSG_HEADER_MISMATCH,
51                      "// Checkstyle - Java code style checker."
52                     + " Copyright (C) 20XX-20XX the authors.", path),
53          };
54          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
55          verifyWithExternalXmlConfig(getPath("Example2.xml"),
56                                      getPath("Example2.java"),
57                                       expected);
58      }
59  
60      @Test
61      public void testExample3() throws Exception {
62          final String path =
63                       "src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/header/"
64                        + "multifileregexpheader/java.header, "
65                      + "src/xdocs-examples/resources/com/puppycrawl/tools/checkstyle/checks/header/"
66                         + "multifileregexpheader/apache.header";
67          final String[] expected = {
68              "1: " + getCheckMessage(MultiFileRegexpHeaderCheck.MSG_HEADER_MISMATCH,
69                         "// Checkstyle - Java code style checker."
70                     + " Copyright (C) 20XX-20XX the authors.", path),
71          };
72          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
73          verifyWithExternalXmlConfig(getPath("Example3.xml"),
74                                      getPath("Example3.java"),
75                                       expected);
76      }
77  
78      @Test
79      public void testExample4() throws Exception {
80          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
81          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
82          verifyWithExternalXmlConfig(getPath("Example4.xml"),
83                                      getPath("Example4.java"),
84                                       expected);
85      }
86  
87  }
88