Issue #6207: Enable XpathRegressiontest for EqualsHashCode

src/it/java/org/checkstyle/suppressionxpathfilter/XpathRegressionEqualsHashCodeTest.java

@@ -0,0 +1,121 @@
+///////////////////////////////////////////////////////////////////////////////////////////////
+// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
+// Copyright (C) 2001-2024 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.jupiter.api.Test;
+
+import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
+import com.puppycrawl.tools.checkstyle.checks.coding.EqualsHashCodeCheck;
+
+public class XpathRegressionEqualsHashCodeTest extends AbstractXpathTestSupport {
+    @Override
+    protected String getCheckName() {
+        return EqualsHashCodeCheck.class.getSimpleName();
+    }
+
+    @Test
+    public void testEqualsOnly() throws Exception {
+        final File fileToProcess = new File(
+            getPath("SuppressionXpathRegressionEqualsHashCode1.java"));
+
+        final DefaultConfiguration moduleConfig = createModuleConfig(EqualsHashCodeCheck.class);
+
+        final String[] expectedViolation = {
+            "4:5: " + getCheckMessage(EqualsHashCodeCheck.class,
+                    EqualsHashCodeCheck.MSG_KEY_HASHCODE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode1']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode1']]/OBJBLOCK/"
+                        + "METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode1']]/OBJBLOCK/"
+                        + "METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS/LITERAL_PUBLIC"
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
+    }
+
+    @Test
+    public void testHashCodeOnly() throws Exception {
+        final File fileToProcess = new File(
+            getPath("SuppressionXpathRegressionEqualsHashCode2.java"));
+
+        final DefaultConfiguration moduleConfig = createModuleConfig(EqualsHashCodeCheck.class);
+
+        final String[] expectedViolation = {
+            "4:5: " + getCheckMessage(EqualsHashCodeCheck.class,
+                    EqualsHashCodeCheck.MSG_KEY_EQUALS),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='hashCode']]",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='hashCode']]/MODIFIERS",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCode2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='hashCode']]/MODIFIERS/LITERAL_PUBLIC"
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
+    }
+
+    @Test
+    public void testNestedCase() throws Exception {
+        final File fileToProcess = new File(
+            getPath("SuppressionXpathRegressionEqualsHashCodeNestedCase.java"));
+
+        final DefaultConfiguration moduleConfig = createModuleConfig(EqualsHashCodeCheck.class);
+
+        final String[] expectedViolation = {
+            "5:9: " + getCheckMessage(EqualsHashCodeCheck.class,
+                    EqualsHashCodeCheck.MSG_KEY_HASHCODE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCodeNestedCase']]"
+                        + "/OBJBLOCK/CLASS_DEF[./IDENT[@text='innerClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCodeNestedCase']]"
+                        + "/OBJBLOCK/CLASS_DEF[./IDENT[@text='innerClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS",
+                "/COMPILATION_UNIT/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionEqualsHashCodeNestedCase']]"
+                        + "/OBJBLOCK/CLASS_DEF[./IDENT[@text='innerClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]"
+                        + "/MODIFIERS/LITERAL_PUBLIC"
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation, expectedXpathQueries);
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/equalshashcode/SuppressionXpathRegressionEqualsHashCode1.java

@@ -0,0 +1,7 @@
+package org.checkstyle.suppressionxpathfilter.equalshashcode;
+
+public class SuppressionXpathRegressionEqualsHashCode1 {
+    public boolean equals(Object obj) { // warn
+        return false;
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/equalshashcode/SuppressionXpathRegressionEqualsHashCode2.java

@@ -0,0 +1,7 @@
+package org.checkstyle.suppressionxpathfilter.equalshashcode;
+
+public class SuppressionXpathRegressionEqualsHashCode2 {
+    public int hashCode() { // warn
+        return 0;
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/equalshashcode/SuppressionXpathRegressionEqualsHashCodeNestedCase.java

@@ -0,0 +1,10 @@
+package org.checkstyle.suppressionxpathfilter.equalshashcode;
+
+public class SuppressionXpathRegressionEqualsHashCodeNestedCase {
+    public static class innerClass {
+        public boolean equals(Object obj) { // warn
+            return false;
+        }
+    }
+}
+

src/test/java/com/puppycrawl/tools/checkstyle/internal/XpathRegressionTest.java

@@ -95,7 +95,6 @@ public class XpathRegressionTest extends AbstractModuleTestSupport {
             "ClassTypeParameterName",
             "DescendantToken",
             "DesignForExtension",
-            "EqualsHashCode",
             "ExecutableStatementCount",
             "HideUtilityClassConstructor",
             "IllegalInstantiation",