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.AtclauseOrderCheck;
27  import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
28  
29  public class AtclauseOrderTest extends AbstractModuleTestSupport {
30  
31      @Override
32      protected String getPackageLocation() {
33          return "com/google/checkstyle/test/chapter7javadoc/rule713atclauses";
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("AtclauseOrder");
42          final String filePath = getPath("InputCorrectAtClauseOrderCheck.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          final String tagOrder = "[@param, @return, @throws, @deprecated]";
51          final String msg = getCheckMessage(AtclauseOrderCheck.class, "at.clause.order", tagOrder);
52  
53          final String[] expected = {
54              "40: " + msg,
55              "51: " + msg,
56              "62: " + msg,
57              "69: " + msg,
58              "86: " + msg,
59              "87: " + msg,
60              "99: " + msg,
61              "101: " + msg,
62              "123: " + msg,
63              "124: " + msg,
64              "134: " + msg,
65              "135: " + msg,
66              "153: " + msg,
67              "161: " + msg,
68              "172: " + msg,
69              "183: " + msg,
70              "185: " + msg,
71              "199: " + msg,
72              "202: " + msg,
73              "213: " + msg,
74              "223: " + msg,
75              "230: " + msg,
76              "237: " + msg,
77              "247: " + msg,
78              "248: " + msg,
79              "259: " + msg,
80              "261: " + msg,
81          };
82  
83          final Configuration checkConfig = getModuleConfig("AtclauseOrder");
84          final String filePath = getPath("InputIncorrectAtClauseOrderCheck.java");
85  
86          final Integer[] warnList = getLinesWithWarn(filePath);
87          verify(checkConfig, filePath, expected, warnList);
88      }
89  }