View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 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.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingLeadingAsteriskCheck.MSG_MISSING_ASTERISK;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.api.JavadocTokenTypes;
29  import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
30  
31  public class JavadocMissingLeadingAsteriskCheckTest extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/javadoc/javadocmissingleadingasterisk";
36      }
37  
38      @Test
39      public void testGetAcceptableTokens() {
40          final JavadocMissingLeadingAsteriskCheck checkObj =
41              new JavadocMissingLeadingAsteriskCheck();
42          final int[] expected = {
43              JavadocTokenTypes.NEWLINE,
44          };
45          assertWithMessage("Default acceptable tokens are invalid")
46              .that(checkObj.getAcceptableJavadocTokens())
47              .isEqualTo(expected);
48      }
49  
50      @Test
51      public void testCorrect() throws Exception {
52          final String[] expected = CommonUtil.EMPTY_STRING_ARRAY;
53          verifyWithInlineConfigParser(
54                  getPath("InputJavadocMissingLeadingAsteriskCorrect.java"), expected);
55      }
56  
57      @Test
58      public void testIncorrect() throws Exception {
59          final String[] expected = {
60              "13: " + getCheckMessage(MSG_MISSING_ASTERISK),
61              "18: " + getCheckMessage(MSG_MISSING_ASTERISK),
62              "25: " + getCheckMessage(MSG_MISSING_ASTERISK),
63              "31: " + getCheckMessage(MSG_MISSING_ASTERISK),
64              "35: " + getCheckMessage(MSG_MISSING_ASTERISK),
65              "36: " + getCheckMessage(MSG_MISSING_ASTERISK),
66              "41: " + getCheckMessage(MSG_MISSING_ASTERISK),
67              "46: " + getCheckMessage(MSG_MISSING_ASTERISK),
68              "53: " + getCheckMessage(MSG_MISSING_ASTERISK),
69              "62: " + getCheckMessage(MSG_MISSING_ASTERISK),
70              "63: " + getCheckMessage(MSG_MISSING_ASTERISK),
71              "64: " + getCheckMessage(MSG_MISSING_ASTERISK),
72          };
73          verifyWithInlineConfigParser(
74                  getPath("InputJavadocMissingLeadingAsteriskIncorrect.java"), expected);
75      }
76  
77  }