View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2018 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.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.MSG_KEY;
23  import static org.junit.Assert.assertArrayEquals;
24  import static org.junit.Assert.assertEquals;
25  
26  import org.junit.Test;
27  
28  import com.puppycrawl.tools.checkstyle.AbstractModuleTestSupport;
29  import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
30  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
31  
32  public class TodoCommentCheckTest
33      extends AbstractModuleTestSupport {
34  
35      @Override
36      protected String getPackageLocation() {
37          return "com/puppycrawl/tools/checkstyle/checks/todocomment";
38      }
39  
40      @Test
41      public void testGetRequiredTokens() {
42          final TodoCommentCheck checkObj = new TodoCommentCheck();
43          final int[] expected = {TokenTypes.COMMENT_CONTENT};
44          assertArrayEquals("Required tokens differs from expected",
45                  expected, checkObj.getRequiredTokens());
46      }
47  
48      @Test
49      public void testIt() throws Exception {
50          final DefaultConfiguration checkConfig =
51              createModuleConfig(TodoCommentCheck.class);
52          checkConfig.addAttribute("format", "FIXME:");
53          final String[] expected = {
54              "161: " + getCheckMessage(MSG_KEY, "FIXME:"),
55              "162: " + getCheckMessage(MSG_KEY, "FIXME:"),
56              "163: " + getCheckMessage(MSG_KEY, "FIXME:"),
57              "167: " + getCheckMessage(MSG_KEY, "FIXME:"),
58          };
59          verify(checkConfig, getPath("InputTodoCommentSimple.java"), expected);
60      }
61  
62      @Test
63      public void testGetAcceptableTokens() {
64          final int[] expected = {TokenTypes.COMMENT_CONTENT };
65          final TodoCommentCheck check = new TodoCommentCheck();
66          final int[] actual = check.getAcceptableTokens();
67          assertEquals("Amount of acceptable tokens differs from expected",
68                  1, actual.length);
69          assertArrayEquals("Acceptable tokens differs from expected",
70                  expected, actual);
71      }
72  
73  }