////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2017 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
////////////////////////////////////////////////////////////////////////////////
package com.puppycrawl.tools.checkstyle.checks.naming;
import static com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck.MSG_INVALID_PATTERN;
import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.fail;
import java.io.File;
import java.io.IOException;
import org.junit.Assert;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.api.CheckstyleException;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
public class ConstantNameCheckTest
extends BaseCheckTestSupport {
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("checks" + File.separator
+ "naming" + File.separator
+ "constantname" + File.separator
+ filename);
}
@Override
protected String getNonCompilablePath(String filename) throws IOException {
return super.getNonCompilablePath("checks" + File.separator
+ "naming" + File.separator + filename);
}
@Test
public void testGetRequiredTokens() {
final ConstantNameCheck checkObj = new ConstantNameCheck();
final int[] expected = {TokenTypes.VARIABLE_DEF};
assertArrayEquals(expected, checkObj.getRequiredTokens());
}
@Test
public void testIllegalRegexp()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
checkConfig.addAttribute("format", "\\");
try {
createChecker(checkConfig);
fail("CheckstyleException is expected");
}
catch (CheckstyleException ex) {
assertEquals("cannot initialize module"
+ " com.puppycrawl.tools.checkstyle.TreeWalker - illegal value"
+ " '\\' for property 'format' of module"
+ " com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck",
ex.getMessage());
}
}
@Test
public void testDefault()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
final String pattern = "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$";
final String[] expected = {
"25:29: " + getCheckMessage(MSG_INVALID_PATTERN, "badConstant", pattern),
"142:30: " + getCheckMessage(MSG_INVALID_PATTERN, "BAD__NAME", pattern),
};
verify(checkConfig, getPath("InputConstantNameSimple.java"), expected);
}
@Test
public void testAccessControlTuning()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
checkConfig.addAttribute("applyToPublic", "false");
checkConfig.addAttribute("applyToProtected", "false");
checkConfig.addAttribute("applyToPackage", "false");
final String pattern = "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$";
final String[] expected = {
"142:30: " + getCheckMessage(MSG_INVALID_PATTERN, "BAD__NAME", pattern),
};
verify(checkConfig, getPath("InputConstantNameSimple.java"), expected);
}
@Test
public void testInterfaceAndAnnotation()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
final String pattern = "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$";
final String[] expected = {
"24:16: " + getCheckMessage(MSG_INVALID_PATTERN, "data", pattern),
"64:16: " + getCheckMessage(MSG_INVALID_PATTERN, "data", pattern),
};
verify(checkConfig, getPath("InputConstantNameInner.java"), expected);
}
@Test
public void testDefault1()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputConstantName.java"), expected);
}
@Test
public void testIntoInterface() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
final String pattern = "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$";
final String[] expected = {
"45:16: " + getCheckMessage(MSG_INVALID_PATTERN, "mPublic", pattern),
"46:9: " + getCheckMessage(MSG_INVALID_PATTERN, "mProtected", pattern),
"47:9: " + getCheckMessage(MSG_INVALID_PATTERN, "mPackage", pattern),
"48:9: " + getCheckMessage(MSG_INVALID_PATTERN, "mPrivate", pattern),
"50:16: " + getCheckMessage(MSG_INVALID_PATTERN, "_public", pattern),
"51:9: " + getCheckMessage(MSG_INVALID_PATTERN, "_protected", pattern),
"52:9: " + getCheckMessage(MSG_INVALID_PATTERN, "_package", pattern),
"53:9: " + getCheckMessage(MSG_INVALID_PATTERN, "_private", pattern),
};
verify(checkConfig, getPath("InputConstantNameMemberExtended.java"), expected);
}
@Test
public void testStaticMethodInInterface()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(ConstantNameCheck.class);
final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputConstantNameStaticModifierInInterface.java"), expected);
}
@Test
public void testGetAcceptableTokens() {
final ConstantNameCheck constantNameCheckObj = new ConstantNameCheck();
final int[] actual = constantNameCheckObj.getAcceptableTokens();
final int[] expected = {
TokenTypes.VARIABLE_DEF,
};
Assert.assertNotNull(actual);
assertArrayEquals(expected, actual);
}
}