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.google.checkstyle.test.chapter7javadoc.rule711generalform;
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.SingleLineJavadocCheck;
27  
28  public class SingleLineJavadocTest extends AbstractModuleTestSupport {
29  
30      @Override
31      protected String getPackageLocation() {
32          return "com/google/checkstyle/test/chapter7javadoc/rule711generalform";
33      }
34  
35      @Test
36      public void testSingleLineJavadoc() throws Exception {
37          final String msg = getCheckMessage(SingleLineJavadocCheck.class, "singleline.javadoc");
38  
39          final String[] expected = {
40              "5: " + msg,
41              "13: " + msg,
42              "29: " + msg,
43              "32: " + msg,
44              "35: " + msg,
45              "38: " + msg,
46              "41: " + msg,
47          };
48  
49          final Configuration checkConfig = getModuleConfig("SingleLineJavadoc");
50          final String filePath = getPath("InputSingleLineJavadocCheck.java");
51  
52          final Integer[] warnList = getLinesWithWarn(filePath);
53          verify(checkConfig, filePath, expected, warnList);
54      }
55  
56  }