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