////////////////////////////////////////////////////////////////////////////////
// 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.filters;
import java.io.File;
import java.io.IOException;
import java.util.Arrays;
import java.util.Collection;
import java.util.Locale;
import java.util.stream.Collectors;
import org.junit.Test;
import com.puppycrawl.tools.checkstyle.BaseCheckTestSupport;
import com.puppycrawl.tools.checkstyle.BriefUtLogger;
import com.puppycrawl.tools.checkstyle.Checker;
import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.TreeWalker;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.checks.SuppressWarningsHolder;
import com.puppycrawl.tools.checkstyle.checks.UncommentedMainCheck;
import com.puppycrawl.tools.checkstyle.checks.coding.IllegalCatchCheck;
import com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTypeCheck;
import com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck;
import com.puppycrawl.tools.checkstyle.checks.naming.MemberNameCheck;
import com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck;
import com.puppycrawl.tools.checkstyle.utils.CommonUtils;
public class SuppressWarningsFilterTest
extends BaseCheckTestSupport {
private static final String[] ALL_MESSAGES = {
"16: Missing a Javadoc comment.",
"17: Missing a Javadoc comment.",
"19: Missing a Javadoc comment.",
"22:45: Name 'I' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"24:17: Name 'J' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"25:17: Name 'K' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"29:17: Name 'L' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"29:32: Name 'X' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"33:30: Name 'm' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.",
"34:30: Name 'n' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.",
"39:17: More than 7 parameters (found 8).",
"45:9: Catching 'Exception' is not allowed.",
"56:9: Catching 'Exception' is not allowed.",
"61: Missing a Javadoc comment.",
"71: Uncommented main method found.",
"76: Missing a Javadoc comment.",
"77: Uncommented main method found.",
"83: Missing a Javadoc comment.",
"84: Uncommented main method found.",
"90: Missing a Javadoc comment.",
"91: Uncommented main method found.",
"97: Missing a Javadoc comment.",
};
@Override
protected String getPath(String filename) throws IOException {
return super.getPath("filters" + File.separator + filename);
}
@Test
public void testNone() throws Exception {
final DefaultConfiguration filterConfig = null;
final String[] suppressed = CommonUtils.EMPTY_STRING_ARRAY;
verifySuppressed(filterConfig, suppressed);
}
@Test
public void testDefault() throws Exception {
final DefaultConfiguration filterConfig =
createFilterConfig(SuppressWarningsFilter.class);
final String[] suppressed = {
"24:17: Name 'J' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"29:17: Name 'L' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"33:30: Name 'm' must match pattern '^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$'.",
"39:17: More than 7 parameters (found 8).",
"56:9: Catching 'Exception' is not allowed.",
"71: Uncommented main method found.",
"77: Uncommented main method found.",
"84: Uncommented main method found.",
"91: Uncommented main method found.",
"97: Missing a Javadoc comment.",
};
verifySuppressed(filterConfig, suppressed);
}
private static DefaultConfiguration createFilterConfig(Class<?> classObj) {
return new DefaultConfiguration(classObj.getName());
}
private void verifySuppressed(Configuration aFilterConfig,
String... aSuppressed) throws Exception {
verify(createChecker(aFilterConfig),
getPath("InputSuppressWarningsFilter.java"),
removeSuppressed(ALL_MESSAGES, aSuppressed));
}
@Override
public Checker createChecker(Configuration checkConfig)
throws Exception {
final DefaultConfiguration checkerConfig =
new DefaultConfiguration("configuration");
final DefaultConfiguration checksConfig =
createCheckConfig(TreeWalker.class);
final DefaultConfiguration holderConfig =
createCheckConfig(SuppressWarningsHolder.class);
holderConfig.addAttribute("aliasList",
"com.puppycrawl.tools.checkstyle.checks.sizes."
+ "ParameterNumberCheck=paramnum");
checksConfig.addChild(holderConfig);
final DefaultConfiguration memberNameCheckConfig = createCheckConfig(MemberNameCheck.class);
memberNameCheckConfig.addAttribute("id", "ignore");
checksConfig.addChild(memberNameCheckConfig);
final DefaultConfiguration constantNameCheckConfig =
createCheckConfig(ConstantNameCheck.class);
constantNameCheckConfig.addAttribute("id", "");
checksConfig.addChild(constantNameCheckConfig);
checksConfig.addChild(createCheckConfig(ParameterNumberCheck.class));
checksConfig.addChild(createCheckConfig(IllegalCatchCheck.class));
final DefaultConfiguration uncommentedMainCheckConfig =
createCheckConfig(UncommentedMainCheck.class);
uncommentedMainCheckConfig.addAttribute("id", "ignore");
checksConfig.addChild(uncommentedMainCheckConfig);
checksConfig.addChild(createCheckConfig(JavadocTypeCheck.class));
checkerConfig.addChild(checksConfig);
if (checkConfig != null) {
checkerConfig.addChild(checkConfig);
}
final Checker checker = new Checker();
final Locale locale = Locale.ROOT;
checker.setLocaleCountry(locale.getCountry());
checker.setLocaleLanguage(locale.getLanguage());
checker.setModuleClassLoader(Thread.currentThread()
.getContextClassLoader());
checker.configure(checkerConfig);
checker.addListener(new BriefUtLogger(stream));
return checker;
}
private static String[] removeSuppressed(String[] from, String... remove) {
final Collection<String> coll = Arrays.stream(from).collect(Collectors.toList());
coll.removeAll(Arrays.asList(remove));
return coll.toArray(new String[coll.size()]);
}
@Test
public void testSuppressById() throws Exception {
final DefaultConfiguration filterConfig =
createFilterConfig(SuppressWarningsFilter.class);
final String[] suppressedViolationMessages = {
"6:17: Name 'A1' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"8: Uncommented main method found.",
};
final String[] expectedViolationMessages = {
"3: Missing a Javadoc comment.",
"6:17: Name 'A1' must match pattern '^[a-z][a-zA-Z0-9]*$'.",
"8: Uncommented main method found.",
};
verify(createChecker(filterConfig),
getPath("InputSuppressByIdWithWarningsFilter.java"),
removeSuppressed(expectedViolationMessages, suppressedViolationMessages));
}
}