View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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.javadoc;
21  
22  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTagContinuationIndentationCheck.MSG_KEY;
23  import static org.junit.Assert.assertArrayEquals;
24  
25  import org.junit.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
29  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
30  import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
31  
32  public class JavadocTagContinuationIndentationCheckTest
33          extends AbstractModuleTestSupport {
34      @Override
35      protected String getPackageLocation() {
36          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadoctagcontinuationindentation";
37      }
38  
39      @Test
40      public void testGetRequiredTokens() {
41          final JavadocTagContinuationIndentationCheck checkObj =
42              new JavadocTagContinuationIndentationCheck();
43          final int[] expected = {TokenTypes.BLOCK_COMMENT_BEGIN };
44          assertArrayEquals("Default required tokens are invalid",
45              expected, checkObj.getRequiredTokens());
46      }
47  
48      @Test
49      public void testFp() throws Exception {
50          final DefaultConfiguration checkConfig =
51                  createModuleConfig(JavadocTagContinuationIndentationCheck.class);
52          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
53          verify(checkConfig,
54                 getPath("InputJavadocTagContinuationIndentationGuavaFalsePositive.java"),
55                 expected);
56      }
57  
58      @Test
59      public void testCheck() throws Exception {
60          final DefaultConfiguration checkConfig =
61                  createModuleConfig(JavadocTagContinuationIndentationCheck.class);
62          final String[] expected = {
63              "47: " + getCheckMessage(MSG_KEY, 4),
64              "109: " + getCheckMessage(MSG_KEY, 4),
65              "112: " + getCheckMessage(MSG_KEY, 4),
66              "203: " + getCheckMessage(MSG_KEY, 4),
67              "206: " + getCheckMessage(MSG_KEY, 4),
68              "221: " + getCheckMessage(MSG_KEY, 4),
69              "223: " + getCheckMessage(MSG_KEY, 4),
70              "285: " + getCheckMessage(MSG_KEY, 4),
71              "288: " + getCheckMessage(MSG_KEY, 4),
72              "290: " + getCheckMessage(MSG_KEY, 4),
73              "310: " + getCheckMessage(MSG_KEY, 4),
74              "322: " + getCheckMessage(MSG_KEY, 4),
75              "324: " + getCheckMessage(MSG_KEY, 4),
76          };
77          verify(checkConfig, getPath("InputJavadocTagContinuationIndentation.java"),
78                  expected);
79      }
80  
81      @Test
82      public void testCheckWithOffset3() throws Exception {
83          final DefaultConfiguration checkConfig =
84                  createModuleConfig(JavadocTagContinuationIndentationCheck.class);
85          checkConfig.addAttribute("offset", "3");
86          final String[] expected = {
87              "7: " + getCheckMessage(MSG_KEY, 3),
88              "19: " + getCheckMessage(MSG_KEY, 3),
89          };
90          verify(checkConfig, getPath("InputJavadocTagContinuationIndentationOffset3.java"),
91                  expected);
92      }
93  }