View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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      @Override
31      protected String getPackageLocation() {
32          return "com/puppycrawl/tools/checkstyle/checks/header/header";
33      }
34  
35      @Test
36      public void testExample1() throws Exception {
37          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
38          verifyWithInlineConfigParser(getPath("Example1.java"), expected);
39      }
40  
41      @Test
42      public void testExample2() throws Exception {
43          final String[] expected = {
44              "1: " + getCheckMessage(HeaderCheck.MSG_MISMATCH,
45                  "////////////////////////////////////////////////////////////////"
46                      + "///////////////////////////////"),
47          };
48          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
49          verifyWithInlineConfigParser(
50                  getPath("Example2.java"), expected);
51  
52      }
53  
54      @Test
55      public void testExample3() throws Exception {
56          final String[] expected = {
57              "1: " + getCheckMessage(HeaderCheck.MSG_MISMATCH, "// Copyright (C) 2004 MyCompany"),
58          };
59  
60          verifyWithInlineConfigParser(getPath("Example3.java"), expected);
61      }
62  
63      @Test
64      public void testExample4() throws Exception {
65          final String[] expected = {
66              "1: " + getCheckMessage(MSG_MISSING),
67          };
68          System.setProperty("config.folder", "src/xdocs-examples/resources/" + getPackageLocation());
69          verifyWithInlineConfigParser(getPath("Example4.java"), expected);
70      }
71  }