View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 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.google.checkstyle.test.chapter7javadoc.rule712paragraphs;
21  
22  import org.junit.Test;
23  
24  import com.google.checkstyle.test.base.AbstractModuleTestSupport;
25  import com.puppycrawl.tools.checkstyle.api.Configuration;
26  import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocParagraphCheck;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
28  
29  public class JavadocParagraphTest extends AbstractModuleTestSupport {
30  
31      @Override
32      protected String getPackageLocation() {
33          return "com/google/checkstyle/test/chapter7javadoc/rule712paragraphs";
34      }
35  
36      @Test
37      public void testJavadocParagraphCorrect() throws Exception {
38  
39          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
40  
41          final Configuration checkConfig = getModuleConfig("JavadocParagraph");
42          final String filePath = getPath("InputCorrectJavadocParagraphCheck.java");
43  
44          final Integer[] warnList = getLinesWithWarn(filePath);
45          verify(checkConfig, filePath, expected, warnList);
46      }
47  
48      @Test
49      public void testJavadocParagraphIncorrect() throws Exception {
50  
51          final String msgBefore = getCheckMessage(JavadocParagraphCheck.class,
52                  "javadoc.paragraph.line.before");
53          final String msgRed = getCheckMessage(JavadocParagraphCheck.class,
54                  "javadoc.paragraph.redundant.paragraph");
55          final String msgMisplaced = getCheckMessage(JavadocParagraphCheck.class,
56                  "javadoc.paragraph.misplaced.tag");
57  
58          final String[] expected = {
59              "5: " + msgMisplaced,
60              "5: " + msgBefore,
61              "6: " + msgMisplaced,
62              "6: " + msgBefore,
63              "12: " + msgMisplaced,
64              "12: " + msgBefore,
65              "14: " + msgMisplaced,
66              "21: " + msgBefore,
67              "30: " + msgRed,
68              "31: " + msgMisplaced,
69              "31: " + msgBefore,
70              "32: " + msgMisplaced,
71              "32: " + msgBefore,
72              "33: " + msgMisplaced,
73              "33: " + msgBefore,
74              "37: " + msgMisplaced,
75              "37: " + msgBefore,
76              "43: " + msgMisplaced,
77              "43: " + msgRed,
78              "46: " + msgMisplaced,
79              "48: " + msgMisplaced,
80              "48: " + msgBefore,
81              "49: " + msgMisplaced,
82              "49: " + msgBefore,
83              "59: " + msgRed,
84              "68: " + msgMisplaced,
85              "68: " + msgBefore,
86              "70: " + msgMisplaced,
87              "73: " + msgMisplaced,
88              "73: " + msgBefore,
89          };
90  
91          final Configuration checkConfig = getModuleConfig("JavadocParagraph");
92          final String filePath = getPath("InputIncorrectJavadocParagraphCheck.java");
93  
94          final Integer[] warnList = getLinesWithWarn(filePath);
95          verify(checkConfig, filePath, expected, warnList);
96      }
97  }