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.rule72thesummaryfragment;
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.SummaryJavadocCheck;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
28  
29  public class SummaryJavadocTest extends AbstractModuleTestSupport {
30  
31      @Override
32      protected String getPackageLocation() {
33          return "com/google/checkstyle/test/chapter7javadoc/rule72thesummaryfragment";
34      }
35  
36      @Test
37      public void testCorrect() throws Exception {
38  
39          final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
40  
41          final Configuration checkConfig = getModuleConfig("SummaryJavadoc");
42          final String filePath = getPath("InputCorrectSummaryJavaDocCheck.java");
43  
44          final Integer[] warnList = getLinesWithWarn(filePath);
45          verify(checkConfig, filePath, expected, warnList);
46      }
47  
48      @Test
49      public void testIncorrect() throws Exception {
50  
51          final String msgFirstSentence = getCheckMessage(SummaryJavadocCheck.class,
52              "summary.first.sentence");
53          final String msgForbiddenFragment = getCheckMessage(SummaryJavadocCheck.class,
54              "summary.javaDoc");
55          final String msgMissingDoc = getCheckMessage(SummaryJavadocCheck.class,
56              "summary.javaDoc.missing");
57  
58          final String[] expected = {
59              "14: " + msgMissingDoc,
60              "32: " + msgMissingDoc,
61              "37: " + msgFirstSentence,
62              "47: " + msgForbiddenFragment,
63              "53: " + msgMissingDoc,
64              "58: " + msgMissingDoc,
65              "69: " + msgMissingDoc,
66              "83: " + msgForbiddenFragment,
67              "103: " + msgMissingDoc,
68          };
69  
70          final Configuration checkConfig = getModuleConfig("SummaryJavadoc");
71          final String filePath = getPath("InputIncorrectSummaryJavaDocCheck.java");
72  
73          final Integer[] warnList = getLinesWithWarn(filePath);
74          verify(checkConfig, filePath, expected, warnList);
75      }
76  }