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;
21  
22  import static com.google.common.truth.Truth.assertWithMessage;
23  import static com.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.MSG_KEY;
24  
25  import org.junit.jupiter.api.Test;
26  
27  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
28  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
29  
30  public class TodoCommentCheckTest
31      extends AbstractModuleTestSupport {
32  
33      @Override
34      protected String getPackageLocation() {
35          return "com/puppycrawl/tools/checkstyle/checks/todocomment";
36      }
37  
38      @Test
39      public void testGetRequiredTokens() {
40          final TodoCommentCheck checkObj = new TodoCommentCheck();
41          final int[] expected = {TokenTypes.COMMENT_CONTENT};
42          assertWithMessage("Required tokens differs from expected")
43              .that(checkObj.getRequiredTokens())
44              .isEqualTo(expected);
45      }
46  
47      @Test
48      public void testItOne() throws Exception {
49          final String[] expected = {
50              "1:3: " + getCheckMessage(MSG_KEY, "FIXME:"),
51          };
52          verifyWithInlineConfigParser(
53                  getPath("InputTodoCommentSimpleOne.java"), expected);
54      }
55  
56      @Test
57      public void testItTwo() throws Exception {
58          final String[] expected = {
59              "1:3: " + getCheckMessage(MSG_KEY, "FIXME:"),
60              "68:7: " + getCheckMessage(MSG_KEY, "FIXME:"),
61              "69:7: " + getCheckMessage(MSG_KEY, "FIXME:"),
62              "74:17: " + getCheckMessage(MSG_KEY, "FIXME:"),
63          };
64          verifyWithInlineConfigParser(
65                  getPath("InputTodoCommentSimpleTwo.java"), expected);
66      }
67  
68      @Test
69      public void testGetAcceptableTokens() {
70          final int[] expected = {TokenTypes.COMMENT_CONTENT };
71          final TodoCommentCheck check = new TodoCommentCheck();
72          final int[] actual = check.getAcceptableTokens();
73          assertWithMessage("Amount of acceptable tokens differs from expected")
74              .that(actual.length)
75              .isEqualTo(1);
76          assertWithMessage("Acceptable tokens differs from expected")
77              .that(actual)
78              .isEqualTo(expected);
79      }
80  
81      @Test
82      public void test() throws Exception {
83          final String[] expected = {
84              "11:16: " + getCheckMessage(MSG_KEY, "TODO:"),
85          };
86          verifyWithInlineConfigParser(
87                  getPath("InputTodoCommentDefault.java"), expected);
88      }
89  }