////////////////////////////////////////////////////////////////////////////////
// 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.modifier;
import static com.puppycrawl.tools.checkstyle.checks.modifier.RedundantModifierCheck.MSG_KEY;
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.TokenTypes;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
public class RedundantModifierCheckTest
extends BaseCheckTestSupport {
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("checks" + File.separator
+ "modifier" + File.separator + filename);
}
@Override
protected String getNonCompilablePath(String filename) throws IOException {
return super.getNonCompilablePath("checks" + File.separator
+ "modifier" + File.separator + filename);
}
@Test
public void testClassesInsideOfInterfaces() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"11:5: " + getCheckMessage(MSG_KEY, "static"),
"17:5: " + getCheckMessage(MSG_KEY, "public"),
"20:5: " + getCheckMessage(MSG_KEY, "public"),
"26:5: " + getCheckMessage(MSG_KEY, "static"),
};
verify(checkConfig, getPath("InputModifierClassesInsideOfInterfaces.java"), expected);
}
@Test
public void testIt() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"54:12: " + getCheckMessage(MSG_KEY, "static"),
"57:9: " + getCheckMessage(MSG_KEY, "public"),
"63:9: " + getCheckMessage(MSG_KEY, "abstract"),
"66:9: " + getCheckMessage(MSG_KEY, "public"),
//"69:9: Redundant 'abstract' modifier.",
"72:9: " + getCheckMessage(MSG_KEY, "final"),
"79:13: " + getCheckMessage(MSG_KEY, "final"),
"88:12: " + getCheckMessage(MSG_KEY, "final"),
"99:1: " + getCheckMessage(MSG_KEY, "abstract"),
"116:5: " + getCheckMessage(MSG_KEY, "public"),
"117:5: " + getCheckMessage(MSG_KEY, "final"),
"118:5: " + getCheckMessage(MSG_KEY, "static"),
"120:5: " + getCheckMessage(MSG_KEY, "public"),
"121:5: " + getCheckMessage(MSG_KEY, "abstract"),
};
verify(checkConfig, getPath("InputModifier.java"), expected);
}
@Test
public void testStaticMethodInInterface()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = CommonUtils.EMPTY_STRING_ARRAY;
verify(checkConfig, getPath("InputStaticModifierInInterface.java"), expected);
}
@Test
public void testFinalInInterface()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"5:9: " + getCheckMessage(MSG_KEY, "final"),
};
verify(checkConfig, getPath("InputFinalInDefaultMethods.java"), expected);
}
@Test
public void testEnumConstructorIsImplicitlyPrivate() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"10:5: " + getCheckMessage(MSG_KEY, "private"),
};
verify(checkConfig, getPath("InputRedundantConstructorModifier.java"), expected);
}
@Test
public void testInnerTypeInInterfaceIsImplicitlyStatic() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"8:5: " + getCheckMessage(MSG_KEY, "static"),
"12:5: " + getCheckMessage(MSG_KEY, "static"),
};
verify(checkConfig, getPath("InputRedundantStaticModifierInInnerTypeOfInterface.java"),
expected);
}
@Test
public void testNotPublicClassConstructorHasNotPublicModifier() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"18:5: " + getCheckMessage(MSG_KEY, "public"),
};
verify(checkConfig, getPath("InputRedundantPublicModifierInNotPublicClass.java"), expected);
}
@Test
public void testNestedClassConsInPublicInterfaceHasValidPublicModifier() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"18:33: " + getCheckMessage(MSG_KEY, "public"),
"22:41: " + getCheckMessage(MSG_KEY, "public"),
"33:33: " + getCheckMessage(MSG_KEY, "public"),
"41:33: " + getCheckMessage(MSG_KEY, "public"),
};
verify(checkConfig,
getPath("InputNestedClassInPublicInterfaceRedundantModifiers.java"),
expected);
}
@Test
public void testGetAcceptableTokens() {
final RedundantModifierCheck redundantModifierCheckObj = new RedundantModifierCheck();
final int[] actual = redundantModifierCheckObj.getAcceptableTokens();
final int[] expected = {
TokenTypes.METHOD_DEF,
TokenTypes.VARIABLE_DEF,
TokenTypes.ANNOTATION_FIELD_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.CTOR_DEF,
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.RESOURCE,
};
Assert.assertArrayEquals(expected, actual);
}
@Test
public void testGetRequiredTokens() {
final RedundantModifierCheck redundantModifierCheckObj = new RedundantModifierCheck();
final int[] actual = redundantModifierCheckObj.getRequiredTokens();
final int[] expected = CommonUtils.EMPTY_INT_ARRAY;
Assert.assertArrayEquals(expected, actual);
}
@Test
public void testNestedStaticEnum() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"4:5: " + getCheckMessage(MSG_KEY, "static"),
"8:9: " + getCheckMessage(MSG_KEY, "static"),
"12:9: " + getCheckMessage(MSG_KEY, "static"),
};
verify(checkConfig, getPath("InputRedundantStaticModifierInNestedEnum.java"), expected);
}
@Test
public void testFinalInAnonymousClass()
throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"14:20: " + getCheckMessage(MSG_KEY, "final"),
};
verify(checkConfig, getPath("InputFinalInAnonymousClass.java"), expected);
}
@Test
public void testFinalInTryWithResource() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"22:14: " + getCheckMessage(MSG_KEY, "final"),
"27:14: " + getCheckMessage(MSG_KEY, "final"),
"28:17: " + getCheckMessage(MSG_KEY, "final"),
};
verify(checkConfig, getPath("InputFinalInTryWithResource.java"), expected);
}
@Test
public void testFinalInAbstractMethods() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"4:33: " + getCheckMessage(MSG_KEY, "final"),
"8:49: " + getCheckMessage(MSG_KEY, "final"),
"11:17: " + getCheckMessage(MSG_KEY, "final"),
"16:24: " + getCheckMessage(MSG_KEY, "final"),
"25:33: " + getCheckMessage(MSG_KEY, "final"),
};
verify(checkConfig, getPath("InputFinalInAbstractMethods.java"), expected);
}
@Test
public void testEnumMethods() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(RedundantModifierCheck.class);
final String[] expected = {
"7:16: " + getCheckMessage(MSG_KEY, "final"),
"22:16: " + getCheckMessage(MSG_KEY, "final"),
};
verify(checkConfig, getPath("InputFinalInEnumMethods.java"), expected);
}
}