Skip to content

Commit

Permalink
Issue #6207: Add Xpath Regression Test for MethodName
Browse files Browse the repository at this point in the history
  • Loading branch information
Kevin222004 authored and romani committed Mar 27, 2022
1 parent 21125a7 commit a8cc4dd
Show file tree
Hide file tree
Showing 5 changed files with 158 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2022 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 org.checkstyle.suppressionxpathfilter;

import java.io.File;
import java.util.Collections;
import java.util.List;

import org.junit.jupiter.api.Test;

import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck;
import com.puppycrawl.tools.checkstyle.checks.naming.MethodNameCheck;

public class XpathRegressionMethodNameTest extends AbstractXpathTestSupport {

private final String checkName = MethodNameCheck.class.getSimpleName();

@Override
protected String getCheckName() {
return checkName;
}

@Test
public void test1() throws Exception {
final File fileToProcess =
new File(getPath("SuppressionXpathRegressionMethodName1.java"));

final String pattern = "^[a-z][a-zA-Z0-9]*$";
final DefaultConfiguration moduleConfig =
createModuleConfig(MethodNameCheck.class);

final String[] expectedViolation = {
"6:16: " + getCheckMessage(MethodNameCheck.class,
AbstractNameCheck.MSG_INVALID_PATTERN, "SecondMethod", pattern),
};

final List<String> expectedXpathQueries = Collections.singletonList(
"/COMPILATION_UNIT"
+ "/CLASS_DEF[./IDENT[@text"
+ "='SuppressionXpathRegressionMethodName1']]"
+ "/OBJBLOCK/METHOD_DEF/IDENT[@text='SecondMethod']"
);
runVerifications(moduleConfig, fileToProcess, expectedViolation,
expectedXpathQueries);
}

@Test
public void test2() throws Exception {
final File fileToProcess =
new File(getPath("SuppressionXpathRegressionMethodName2.java"));

final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
final DefaultConfiguration moduleConfig =
createModuleConfig(MethodNameCheck.class);
moduleConfig.addProperty("format", "^[a-z](_?[a-zA-Z0-9]+)*$");

final String[] expectedViolation = {
"7:21: " + getCheckMessage(MethodNameCheck.class,
AbstractNameCheck.MSG_INVALID_PATTERN, "MyMethod2", pattern),
};

final List<String> expectedXpathQueries = Collections.singletonList(
"/COMPILATION_UNIT"
+ "/CLASS_DEF[./IDENT[@text"
+ "='SuppressionXpathRegressionMethodName2']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='Inner']]"
+ "/OBJBLOCK/METHOD_DEF/IDENT[@text='MyMethod2']"
);
runVerifications(moduleConfig, fileToProcess, expectedViolation,
expectedXpathQueries);
}

@Test
public void test3() throws Exception {
final File fileToProcess =
new File(getPath("SuppressionXpathRegressionMethodName3.java"));

final String pattern = "^[a-z](_?[a-zA-Z0-9]+)*$";
final DefaultConfiguration moduleConfig =
createModuleConfig(MethodNameCheck.class);
moduleConfig.addProperty("format", "^[a-z](_?[a-zA-Z0-9]+)*$");
moduleConfig.addProperty("applyToPublic", "false");
moduleConfig.addProperty("applyToProtected", "false");

final String[] expectedViolation = {
"7:19: " + getCheckMessage(MethodNameCheck.class,
AbstractNameCheck.MSG_INVALID_PATTERN,
"ThirdMethod", pattern),
};

final List<String> expectedXpathQueries = Collections.singletonList(
"/COMPILATION_UNIT"
+ "/INTERFACE_DEF[./IDENT[@text='Check']]"
+ "/OBJBLOCK/METHOD_DEF/IDENT[@text='ThirdMethod']"
);
runVerifications(moduleConfig, fileToProcess, expectedViolation,
expectedXpathQueries);
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
package org.checkstyle.suppressionxpathfilter.methodname;

public class SuppressionXpathRegressionMethodName1 {

protected void firstMethod() {} // OK
private void SecondMethod() {} // warn

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package org.checkstyle.suppressionxpathfilter.methodname;

public class SuppressionXpathRegressionMethodName2 {
public void myMethod1() { // OK
}
class Inner {
public void MyMethod2() { // warn
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package org.checkstyle.suppressionxpathfilter.methodname;

interface Check {
int i = 10;
default void FirstMethod() {} // OK
default void SecondMethod() {} // OK
private void ThirdMethod() {} // warn

}

public class SuppressionXpathRegressionMethodName3 implements Check {

@Override
public void FirstMethod() {

}

@Override
public void SecondMethod() {

}
}
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,6 @@ public class XpathRegressionTest extends AbstractModuleTestSupport {
"MagicNumber",
"MemberName",
"MethodLength",
"MethodName",
"MethodTypeParameterName",
"ModifiedControlVariable",
"ModifierOrder",
Expand Down

0 comments on commit a8cc4dd

Please sign in to comment.