Skip to content

Commit

Permalink
Issue checkstyle#6207: Add xpath regression test for AbstractClassName
Browse files Browse the repository at this point in the history
  • Loading branch information
mincong-h committed Aug 14, 2019
1 parent b447602 commit 63d0a11
Show file tree
Hide file tree
Showing 4 changed files with 136 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2019 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.List;

import org.junit.Test;

import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
import com.puppycrawl.tools.checkstyle.checks.naming.AbstractClassNameCheck;

public class XpathRegressionAbstractClassNameTest extends AbstractXpathTestSupport {

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

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

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

final DefaultConfiguration moduleConfig =
createModuleConfig(AbstractClassNameCheck.class);

final String[] expectedViolation = {
"3:1: " + getCheckMessage(AbstractClassNameCheck.class,
AbstractClassNameCheck.MSG_ILLEGAL_ABSTRACT_CLASS_NAME,
"SuppressionXpathRegressionAbstractClassNameOne", "^Abstract.+$"),
};

final List<String> expectedXpathQueries = Arrays.asList(
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameOne']]",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameOne']]"
+ "/MODIFIERS",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameOne']]"
+ "/MODIFIERS/LITERAL_PUBLIC"
);

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

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

final DefaultConfiguration moduleConfig =
createModuleConfig(AbstractClassNameCheck.class);

final String[] expectedViolation = {
"4:5: " + getCheckMessage(AbstractClassNameCheck.class,
AbstractClassNameCheck.MSG_ILLEGAL_ABSTRACT_CLASS_NAME,
"MyClass", "^Abstract.+$"),
};

final List<String> expectedXpathQueries = Arrays.asList(
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameTwo']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='MyClass']]",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameTwo']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='MyClass']]/MODIFIERS",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassNameTwo']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='MyClass']]/MODIFIERS/ABSTRACT"
);

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

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

final DefaultConfiguration moduleConfig =
createModuleConfig(AbstractClassNameCheck.class);

final String[] expectedViolation = {
"4:5: " + getCheckMessage(AbstractClassNameCheck.class,
AbstractClassNameCheck.MSG_NO_ABSTRACT_CLASS_MODIFIER,
"AbstractMyClass"),
};

final List<String> expectedXpathQueries = Arrays.asList(
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassModifierOne']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='AbstractMyClass']]",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassModifierOne']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='AbstractMyClass']]/MODIFIERS",
"/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionAbstractClassModifierOne']]"
+ "/OBJBLOCK/CLASS_DEF[./IDENT[@text='AbstractMyClass']]/LITERAL_CLASS"
);

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

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

public class SuppressionXpathRegressionAbstractClassModifierOne {
class AbstractMyClass { // warn
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
package org.checkstyle.suppressionxpathfilter.abstractclassname;

public abstract class SuppressionXpathRegressionAbstractClassNameOne { // warn
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
package org.checkstyle.suppressionxpathfilter.abstractclassname;

public class SuppressionXpathRegressionAbstractClassNameTwo {
abstract class MyClass { // warn
}
}

0 comments on commit 63d0a11

Please sign in to comment.