Skip to content

Commit

Permalink
Issue checkstyle#7742: Update AbstractChecks to log DetailAST - Lambd…
Browse files Browse the repository at this point in the history
…aParameterName
  • Loading branch information
Abhishek-kumar09 authored and RayRCaringal committed Apr 7, 2020
1 parent 17ab4b2 commit 9dbab73
Show file tree
Hide file tree
Showing 6 changed files with 129 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2020 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.Arrays;
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.LambdaParameterNameCheck;

public class XpathRegressionLambdaParameterNameTest extends AbstractXpathTestSupport {

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

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

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

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

final String[] expectedViolation = {
"7:44: " + getCheckMessage(LambdaParameterNameCheck.class,
AbstractNameCheck.MSG_INVALID_PATTERN, "S", defaultPattern),
};

final List<String> expectedXpathQueries = Collections.singletonList(
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName1']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST/VARIABLE_DEF["
+ "./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/IDENT[@text='S']"
);

runVerifications(moduleConfig, fileToProcess, expectedViolation,
expectedXpathQueries);
}

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

final String nonDefaultPattern = "^_[a-zA-Z0-9]*$";

final DefaultConfiguration moduleConfig =
createModuleConfig(LambdaParameterNameCheck.class);
moduleConfig.addAttribute("format", nonDefaultPattern);

final String[] expectedViolation = {
"7:45: " + getCheckMessage(LambdaParameterNameCheck.class,
AbstractNameCheck.MSG_INVALID_PATTERN, "s", nonDefaultPattern),
};

final List<String> expectedXpathQueries = Arrays.asList(
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName2']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST/"
+ "VARIABLE_DEF[./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/PARAMETERS",

"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName2']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST/"
+ "VARIABLE_DEF[./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/PARAMETERS"
+ "/PARAMETER_DEF[./IDENT[@text='s']]",

"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName2']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST"
+ "/VARIABLE_DEF[./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/PARAMETERS"
+ "/PARAMETER_DEF[./IDENT[@text='s']]/MODIFIERS",

"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName2']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST/"
+ "VARIABLE_DEF[./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/PARAMETERS"
+ "/PARAMETER_DEF[./IDENT[@text='s']]/TYPE",

"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionLambdaParameterName2']]"
+ "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/SLIST/"
+ "VARIABLE_DEF[./IDENT[@text='trimmer']]/ASSIGN/LAMBDA/PARAMETERS"
+ "/PARAMETER_DEF/IDENT[@text='s']"
);

runVerifications(moduleConfig, fileToProcess, expectedViolation,
expectedXpathQueries);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package org.checkstyle.suppressionxpathfilter.lambdaparametername;

import java.util.function.Function;

public class SuppressionXpathRegressionLambdaParameterName1 {
void test() {
Function<String, String> trimmer = S -> S.trim(); // warn
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
package org.checkstyle.suppressionxpathfilter.lambdaparametername;

import java.util.function.Function;

public class SuppressionXpathRegressionLambdaParameterName2 {
void test() {
Function<String, String> trimmer = (s) -> s.trim(); // warn
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -80,9 +80,6 @@
* JavadocType
* </li>
* <li>
* LambdaParameterName
* </li>
* <li>
* MethodCount
* </li>
* <li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,6 @@ public class XpathRegressionTest extends AbstractModuleTestSupport {
"JavadocContentLocation",
"JavadocMethod",
"JavadocType",
"LambdaParameterName",
"MethodCount",
"MissingJavadocMethod",
"MissingJavadocType",
Expand Down
1 change: 0 additions & 1 deletion src/xdocs/config_filters.xml
Original file line number Diff line number Diff line change
Expand Up @@ -914,7 +914,6 @@ public class UserService {
<li>JavadocContentLocation</li>
<li>JavadocMethod</li>
<li>JavadocType</li>
<li>LambdaParameterName</li>
<li>MethodCount</li>
<li>MissingJavadocMethod</li>
<li>MissingJavadocType</li>
Expand Down

0 comments on commit 9dbab73

Please sign in to comment.