////////////////////////////////////////////////////////////////////////////////
// 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.coding;
import static com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.MSG_ACCESS;
import static com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.MSG_CONSTRUCTOR;
import static com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.MSG_INSTANCE;
import static com.puppycrawl.tools.checkstyle.checks.coding.DeclarationOrderCheck.MSG_STATIC;
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.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;
public class DeclarationOrderCheckTest
extends BaseCheckTestSupport {
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("checks" + File.separator
+ "coding" + File.separator + "declarationorder" + File.separator + filename);
}
@Test
public void testDefault() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(DeclarationOrderCheck.class);
final String[] expected = {
"8:5: " + getCheckMessage(MSG_ACCESS),
"13:5: " + getCheckMessage(MSG_ACCESS),
"18:5: " + getCheckMessage(MSG_ACCESS),
"21:5: " + getCheckMessage(MSG_ACCESS),
"27:5: " + getCheckMessage(MSG_STATIC),
"34:9: " + getCheckMessage(MSG_ACCESS),
"45:9: " + getCheckMessage(MSG_STATIC),
"54:5: " + getCheckMessage(MSG_CONSTRUCTOR),
"80:5: " + getCheckMessage(MSG_INSTANCE),
"92:9: " + getCheckMessage(MSG_ACCESS),
"100:9: " + getCheckMessage(MSG_STATIC),
"106:5: " + getCheckMessage(MSG_ACCESS),
"111:5: " + getCheckMessage(MSG_ACCESS),
"116:5: " + getCheckMessage(MSG_ACCESS),
"119:5: " + getCheckMessage(MSG_ACCESS),
"125:5: " + getCheckMessage(MSG_STATIC),
"132:9: " + getCheckMessage(MSG_ACCESS),
"143:9: " + getCheckMessage(MSG_STATIC),
"152:5: " + getCheckMessage(MSG_CONSTRUCTOR),
"178:5: " + getCheckMessage(MSG_INSTANCE),
"182:9: " + getCheckMessage(MSG_ACCESS),
};
verify(checkConfig, getPath("InputDeclarationOrder.java"), expected);
}
@Test
public void testOnlyConstructors() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(DeclarationOrderCheck.class);
checkConfig.addAttribute("ignoreConstructors", "false");
checkConfig.addAttribute("ignoreModifiers", "true");
final String[] expected = {
"45:9: " + getCheckMessage(MSG_STATIC),
"54:5: " + getCheckMessage(MSG_CONSTRUCTOR),
"80:5: " + getCheckMessage(MSG_INSTANCE),
"100:9: " + getCheckMessage(MSG_STATIC),
"143:9: " + getCheckMessage(MSG_STATIC),
"152:5: " + getCheckMessage(MSG_CONSTRUCTOR),
"178:5: " + getCheckMessage(MSG_INSTANCE),
};
verify(checkConfig, getPath("InputDeclarationOrder.java"), expected);
}
@Test
public void testOnlyModifiers() throws Exception {
final DefaultConfiguration checkConfig =
createCheckConfig(DeclarationOrderCheck.class);
checkConfig.addAttribute("ignoreConstructors", "true");
checkConfig.addAttribute("ignoreModifiers", "false");
final String[] expected = {
"8:5: " + getCheckMessage(MSG_ACCESS),
"13:5: " + getCheckMessage(MSG_ACCESS),
"18:5: " + getCheckMessage(MSG_ACCESS),
"21:5: " + getCheckMessage(MSG_ACCESS),
"27:5: " + getCheckMessage(MSG_STATIC),
"34:9: " + getCheckMessage(MSG_ACCESS),
"45:9: " + getCheckMessage(MSG_STATIC),
"80:5: " + getCheckMessage(MSG_INSTANCE),
"92:9: " + getCheckMessage(MSG_ACCESS),
"100:9: " + getCheckMessage(MSG_STATIC),
"106:5: " + getCheckMessage(MSG_ACCESS),
"111:5: " + getCheckMessage(MSG_ACCESS),
"116:5: " + getCheckMessage(MSG_ACCESS),
"119:5: " + getCheckMessage(MSG_ACCESS),
"125:5: " + getCheckMessage(MSG_STATIC),
"132:9: " + getCheckMessage(MSG_ACCESS),
"143:9: " + getCheckMessage(MSG_STATIC),
"178:5: " + getCheckMessage(MSG_INSTANCE),
"182:9: " + getCheckMessage(MSG_ACCESS),
};
verify(checkConfig, getPath("InputDeclarationOrder.java"), expected);
}
@Test
public void testTokensNotNull() {
final DeclarationOrderCheck check = new DeclarationOrderCheck();
Assert.assertNotNull(check.getAcceptableTokens());
Assert.assertNotNull(check.getDefaultTokens());
Assert.assertNotNull(check.getRequiredTokens());
}
@Test
public void testParents() {
final DetailAST parent = new DetailAST();
parent.setType(TokenTypes.STATIC_INIT);
final DetailAST method = new DetailAST();
method.setType(TokenTypes.METHOD_DEF);
parent.setFirstChild(method);
final DetailAST ctor = new DetailAST();
ctor.setType(TokenTypes.CTOR_DEF);
method.setNextSibling(ctor);
final DeclarationOrderCheck check = new DeclarationOrderCheck();
check.visitToken(method);
check.visitToken(ctor);
}
@Test
public void testImproperToken() {
final DetailAST parent = new DetailAST();
parent.setType(TokenTypes.STATIC_INIT);
final DetailAST array = new DetailAST();
array.setType(TokenTypes.ARRAY_INIT);
parent.setFirstChild(array);
final DeclarationOrderCheck check = new DeclarationOrderCheck();
check.visitToken(array);
}
@Test
public void testForwardReference() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(DeclarationOrderCheck.class);
final String[] expected = {
"12:5: " + getCheckMessage(MSG_ACCESS),
"13:5: " + getCheckMessage(MSG_ACCESS),
"14:5: " + getCheckMessage(MSG_ACCESS),
"15:5: " + getCheckMessage(MSG_ACCESS),
"16:5: " + getCheckMessage(MSG_ACCESS),
"17:5: " + getCheckMessage(MSG_ACCESS),
"23:5: " + getCheckMessage(MSG_ACCESS),
"41:5: " + getCheckMessage(MSG_STATIC),
};
verify(checkConfig, getPath("InputDeclarationOrderForwardReference.java"), expected);
}
@Test
public void testAvoidDuplicatesForStaticFinalFields() throws Exception {
final DefaultConfiguration checkConfig = createCheckConfig(DeclarationOrderCheck.class);
final String[] expected = {
"6:5: " + getCheckMessage(MSG_STATIC),
};
verify(checkConfig,
getPath("InputDeclarationOrderAvoidDuplicatesInStaticFinalFields.java"),
expected);
}
}