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.rule713atclauses;
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.NonEmptyAtclauseDescriptionCheck;
27  
28  public class NonEmptyAtclauseDescriptionTest extends AbstractModuleTestSupport {
29  
30      @Override
31      protected String getPackageLocation() {
32          return "com/google/checkstyle/test/chapter7javadoc/rule713atclauses";
33      }
34  
35      @Test
36      public void testDefaultConfiguration() throws Exception {
37          final String msg = getCheckMessage(NonEmptyAtclauseDescriptionCheck.class,
38              "non.empty.atclause");
39  
40          final String[] expected = {
41              "34: " + msg,
42              "35: " + msg,
43              "36: " + msg,
44              "37: " + msg,
45              "38: " + msg,
46              "39: " + msg,
47              "48: " + msg,
48              "49: " + msg,
49              "50: " + msg,
50              "51: " + msg,
51              "52: " + msg,
52          };
53  
54          final Configuration checkConfig = getModuleConfig("NonEmptyAtclauseDescription");
55          final String filePath = getPath("InputNonEmptyAtclauseDescriptionCheck.java");
56  
57          final Integer[] warnList = getLineNumbersFromExpected(expected);
58          verify(checkConfig, filePath, expected, warnList);
59      }
60  
61      @Test
62      public void testSpaceSequence() throws Exception {
63          final String msg = getCheckMessage(NonEmptyAtclauseDescriptionCheck.class,
64              "non.empty.atclause");
65  
66          final String[] expected = {
67              "27: " + msg,
68              "28: " + msg,
69              "29: " + msg,
70              "38: " + msg,
71              "39: " + msg,
72              "40: " + msg,
73          };
74  
75          final Configuration checkConfig = getModuleConfig("NonEmptyAtclauseDescription");
76          final String filePath = getPath("InputNonEmptyAtclauseDescriptionCheckSpaceSeq.java");
77  
78          final Integer[] warnList = getLineNumbersFromExpected(expected);
79          verify(checkConfig, filePath, expected, warnList);
80      }
81  
82      /**
83       * Gets line numbers with violations from an array with expected messages.
84       * This is used as using "warn" comments in input files would affects the work
85       * of the Check.
86       * @param expected an array with expected messages.
87       * @return Integer array with numbers of lines with violations.
88       */
89      private static Integer[] getLineNumbersFromExpected(String... expected) {
90          final Integer[] result = new Integer[expected.length];
91          for (int i = 0; i < expected.length; i++) {
92              result[i] = Integer.valueOf(expected[i].substring(0, expected[i].indexOf(':')));
93          }
94          return result;
95      }
96  }