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.sun.checkstyle.test.chapter5comments.rule52documentationcomments;
21  
22  import org.junit.jupiter.api.Test;
23  
24  import com.puppycrawl.tools.checkstyle.api.Configuration;
25  import com.puppycrawl.tools.checkstyle.checks.javadoc.InvalidJavadocPositionCheck;
26  import com.sun.checkstyle.test.base.AbstractSunModuleTestSupport;
27  
28  public class InvalidJavadocPositionTest extends AbstractSunModuleTestSupport {
29  
30      @Override
31      protected String getPackageLocation() {
32          return "com/sun/checkstyle/test/chapter5comments/rule52documentationcomments";
33      }
34  
35      @Test
36      public void testDefault() throws Exception {
37          final String message = getCheckMessage(InvalidJavadocPositionCheck.class,
38              "invalid.position");
39  
40          final String[] expected = {
41              "1:9: " + message,
42              "3:1: " + message,
43              "6:1: " + message,
44              "9:5: " + message,
45              "14:5: " + message,
46              "17:5: " + message,
47              "27:9: " + message,
48              "28:17: " + message,
49              "29:17: " + message,
50              "39:10: " + message,
51              "40:19: " + message,
52              "41:19: " + message,
53              "42:21: " + message,
54              "43:23: " + message,
55              "44:23: " + message,
56              "47:1: " + message,
57              "52:7: " + message,
58              "53:36: " + message,
59              "54:1: " + message,
60          };
61  
62          final Configuration checkConfig = getModuleConfig("InvalidJavadocPosition");
63          final String filePath = getPath("InputInvalidJavadocPosition.java");
64  
65          final Integer[] warnList = getLinesWithWarn(filePath);
66          verify(checkConfig, filePath, expected, warnList);
67      }
68  
69  }