View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2024 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.chapter5naming.rule53camelcase;
21  
22  import java.io.IOException;
23  
24  import org.junit.jupiter.api.Test;
25  
26  import com.google.checkstyle.test.base.AbstractGoogleModuleTestSupport;
27  import com.puppycrawl.tools.checkstyle.api.Configuration;
28  import com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck;
29  
30  public class AbbreviationAsWordInNameTest extends AbstractGoogleModuleTestSupport {
31  
32      private static final String MSG_KEY = "abbreviation.as.word";
33      private final Class<AbbreviationAsWordInNameCheck> clazz = AbbreviationAsWordInNameCheck.class;
34  
35      @Override
36      protected String getPackageLocation() {
37          return "com/google/checkstyle/test/chapter5naming/rule53camelcase";
38      }
39  
40      @Test
41      public void testAbbreviationAsWordInName() throws Exception {
42          final int maxCapitalCount = 1;
43  
44          final String[] expected = {
45              "51:9: " + getWarningMessage("newCustomerID", maxCapitalCount),
46              "53:13: " + getWarningMessage("supportsIPv6OnIOS", maxCapitalCount),
47              "55:10: " + getWarningMessage("XMLHTTPRequest", maxCapitalCount),
48              "59:13: " + getWarningMessage("newCustomerID", maxCapitalCount),
49              "61:17: " + getWarningMessage("supportsIPv6OnIOS", maxCapitalCount),
50              "63:14: " + getWarningMessage("XMLHTTPRequest", maxCapitalCount),
51              "69:17: " + getWarningMessage("newCustomerID", maxCapitalCount),
52              "71:21: " + getWarningMessage("supportsIPv6OnIOS", maxCapitalCount),
53              "73:18: " + getWarningMessage("XMLHTTPRequest", maxCapitalCount),
54          };
55  
56          final String filePath = getPath("InputAbbreviationAsWordInTypeNameCheck.java");
57  
58          final Configuration checkConfig = getModuleConfig("AbbreviationAsWordInName");
59          final Integer[] warnList = getLinesWithWarn(filePath);
60          verify(checkConfig, filePath, expected, warnList);
61      }
62  
63      private String getWarningMessage(String typeName, int expectedCapitalCount)
64              throws IOException {
65          return getCheckMessage(clazz, MSG_KEY, typeName, expectedCapitalCount);
66      }
67  
68  }