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.puppycrawl.tools.checkstyle.checks.TodoCommentCheck.MSG_KEY;
23
24 import org.junit.jupiter.api.Test;
25
26 import com.puppycrawl.tools.checkstyle.AbstractExamplesModuleTestSupport;
27
28 public class TodoCommentCheckExamplesTest extends AbstractExamplesModuleTestSupport {
29 @Override
30 protected String getPackageLocation() {
31 return "com/puppycrawl/tools/checkstyle/checks/todocomment";
32 }
33
34 @Test
35 public void testExample1() throws Exception {
36 final String[] expected = {
37 "15:14: " + getCheckMessage(MSG_KEY, "TODO:"),
38 };
39
40 verifyWithInlineConfigParser(getPath("Example1.java"), expected);
41 }
42
43 @Test
44 public void testExample2() throws Exception {
45 final String[] expected = {
46 "1:3: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
47 "18:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
48 "19:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
49 "20:14: " + getCheckMessage(MSG_KEY, "(?i)(TODO)|(FIXME)"),
50 };
51
52 verifyWithInlineConfigParser(getPath("Example2.java"), expected);
53 }
54 }