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 static com.puppycrawl.tools.checkstyle.checks.header.HeaderCheck.MSG_MISSING;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
28  
29  public class HeaderCheckExamplesTest extends AbstractExamplesModuleTestSupport {
30  
31      @Override
32      public String getPackageLocation() {
33          return "com/puppycrawl/tools/checkstyle/checks/header/header";
34      }
35  
36      @Test
37      public void testExample1() throws Exception {
38          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
39          verifyWithExternalXmlConfig(getPath("Example1.xml"),
40                                      getPath("Example1.java"),
41                                      expected);
42      }
43  
44      @Test
45      public void testExample2() throws Exception {
46          final String[] expected = {
47              "1: " + getCheckMessage(MSG_MISSING),
48          };
49          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
50          verifyWithExternalXmlConfig(getPath("Example2.xml"),
51                                      getPath("Example2.java"),
52                                      expected);
53  
54      }
55  
56      @Test
57      public void testExample3() throws Exception {
58          final String[] expected = {
59              "1: " + getCheckMessage(HeaderCheck.MSG_MISMATCH, "// Copyright (C) 2004 MyCompany"),
60          };
61  
62          verifyWithExternalXmlConfig(getPath("Example3.xml"),
63                                      getPath("Example3.java"),
64                                      expected);
65      }
66  
67      @Test
68      public void testExample4() throws Exception {
69          final String[] expected = {
70              "1: " + getCheckMessage(MSG_MISSING),
71          };
72          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
73          verifyWithExternalXmlConfig(getPath("Example4.xml"),
74                                      getPath("Example4.java"),
75                                      expected);
76      }
77  
78  }