Issue checkstyle#7748: Update AbstractChecks to log DetailAST - Missi…

…ngOverride

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

@@ -0,0 +1,263 @@
+////////////////////////////////////////////////////////////////////////////////
+// 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.List;
+
+import org.junit.jupiter.api.Test;
+
+import com.puppycrawl.tools.checkstyle.DefaultConfiguration;
+import com.puppycrawl.tools.checkstyle.checks.annotation.MissingOverrideCheck;
+
+public class XpathRegressionMissingOverrideTest extends AbstractXpathTestSupport {
+
+    private final String checkName = MissingOverrideCheck.class.getSimpleName();
+
+    @Override
+    protected String getCheckName() {
+        return checkName;
+    }
+
+    @Test
+    public void testClass() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideClass.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                MissingOverrideCheck.MSG_KEY_ANNOTATION_MISSING_OVERRIDE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS/LITERAL_PUBLIC"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testInterface() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideInterface.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                MissingOverrideCheck.MSG_KEY_ANNOTATION_MISSING_OVERRIDE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/LITERAL_BOOLEAN"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testAnonymous() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideAnonymous.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+
+        final String[] expectedViolation = {
+            "8:9: " + getCheckMessage(MissingOverrideCheck.class,
+                MissingOverrideCheck.MSG_KEY_ANNOTATION_MISSING_OVERRIDE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideAnonymous']]"
+                        + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='r']]/ASSIGN/EXPR/"
+                        + "LITERAL_NEW[./IDENT[@text='Runnable']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='run']]",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideAnonymous']]"
+                        + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='r']]/ASSIGN/EXPR/"
+                        + "LITERAL_NEW[./IDENT[@text='Runnable']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='run']]/MODIFIERS",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideAnonymous']]"
+                        + "/OBJBLOCK/VARIABLE_DEF[./IDENT[@text='r']]/ASSIGN/EXPR/"
+                        + "LITERAL_NEW[./IDENT[@text='Runnable']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='run']]/MODIFIERS/LITERAL_PUBLIC"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testInheritDocInvalid1() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideInheritDocInvalid1.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                MissingOverrideCheck.MSG_KEY_TAG_NOT_VALID_ON, "{@inheritDoc}"),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid1']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]",
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid1']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS",
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid1']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS/LITERAL_PRIVATE"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testInheritDocInvalid2() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideInheritDocInvalid2.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                MissingOverrideCheck.MSG_KEY_TAG_NOT_VALID_ON, "{@inheritDoc}"),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]",
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS",
+                "/CLASS_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInheritDocInvalid2']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS/LITERAL_PUBLIC"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testJavaFiveCompatibility1() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideClass.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+        moduleConfig.addAttribute("javaFiveCompatibility", "true");
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                    MissingOverrideCheck.MSG_KEY_ANNOTATION_MISSING_OVERRIDE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS",
+                "/CLASS_DEF[./IDENT[@text='SuppressionXpathRegressionMissingOverrideClass']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='equals']]/MODIFIERS/LITERAL_PUBLIC"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+    @Test
+    public void testJavaFiveCompatibility2() throws Exception {
+        final File fileToProcess = new File(getPath(
+                "SuppressionXpathRegressionMissingOverrideInterface.java"));
+
+        final DefaultConfiguration moduleConfig =
+                createModuleConfig(MissingOverrideCheck.class);
+        moduleConfig.addAttribute("javaFiveCompatibility", "true");
+
+        final String[] expectedViolation = {
+            "7:5: " + getCheckMessage(MissingOverrideCheck.class,
+                    MissingOverrideCheck.MSG_KEY_ANNOTATION_MISSING_OVERRIDE),
+        };
+
+        final List<String> expectedXpathQueries = Arrays.asList(
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/MODIFIERS",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE",
+                "/INTERFACE_DEF[./IDENT"
+                        + "[@text='SuppressionXpathRegressionMissingOverrideInterface']]"
+                        + "/OBJBLOCK/METHOD_DEF[./IDENT[@text='test']]/TYPE/LITERAL_BOOLEAN"
+
+        );
+
+        runVerifications(moduleConfig, fileToProcess, expectedViolation,
+                expectedXpathQueries);
+
+    }
+
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/missingoverride/SuppressionXpathRegressionMissingOverrideAnonymous.java

@@ -0,0 +1,12 @@
+package org.checkstyle.suppressionxpathfilter.missingoverride;
+
+public class SuppressionXpathRegressionMissingOverrideAnonymous {
+    Runnable r = new Runnable() {
+        /**
+         * {@inheritDoc}
+         */
+        public void run() { // warn
+
+        }
+    };
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/missingoverride/SuppressionXpathRegressionMissingOverrideClass.java

@@ -0,0 +1,10 @@
+package org.checkstyle.suppressionxpathfilter.missingoverride;
+
+public class SuppressionXpathRegressionMissingOverrideClass {
+    /**
+     * {@inheritDoc}
+     */
+    public boolean equals(Object obj) { // warn
+        return false;
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/missingoverride/SuppressionXpathRegressionMissingOverrideInheritDocInvalid1.java

@@ -0,0 +1,10 @@
+package org.checkstyle.suppressionxpathfilter.missingoverride;
+
+public class SuppressionXpathRegressionMissingOverrideInheritDocInvalid1 {
+    /**
+     * {@inheritDoc}
+     */
+    private void test() { // warn
+
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/missingoverride/SuppressionXpathRegressionMissingOverrideInheritDocInvalid2.java

@@ -0,0 +1,10 @@
+package org.checkstyle.suppressionxpathfilter.missingoverride;
+
+public class SuppressionXpathRegressionMissingOverrideInheritDocInvalid2 {
+    /**
+     * {@inheritDoc}
+     */
+    public static void test() { // warn
+
+    }
+}

src/it/resources/org/checkstyle/suppressionxpathfilter/missingoverride/SuppressionXpathRegressionMissingOverrideInterface.java

@@ -0,0 +1,8 @@
+package org.checkstyle.suppressionxpathfilter.missingoverride;
+
+public interface SuppressionXpathRegressionMissingOverrideInterface {
+    /**
+     * {@inheritDoc}
+     */
+    boolean test(Object obj); // warn
+}

src/main/java/com/puppycrawl/tools/checkstyle/checks/annotation/MissingOverrideCheck.java

@@ -214,7 +214,7 @@ public void visitToken(final DetailAST ast) {
 
         final boolean containsTag = containsJavadocTag(javadoc);
         if (containsTag && !JavadocTagInfo.INHERIT_DOC.isValidOn(ast)) {
-            log(ast.getLineNo(), MSG_KEY_TAG_NOT_VALID_ON,
+            log(ast, MSG_KEY_TAG_NOT_VALID_ON,
                 JavadocTagInfo.INHERIT_DOC.getText());
         }
         else {
@@ -234,7 +234,7 @@ public void visitToken(final DetailAST ast) {
                 && containsTag
                 && !AnnotationUtil.containsAnnotation(ast, OVERRIDE)
                 && !AnnotationUtil.containsAnnotation(ast, FQ_OVERRIDE)) {
-                log(ast.getLineNo(), MSG_KEY_ANNOTATION_MISSING_OVERRIDE);
+                log(ast, MSG_KEY_ANNOTATION_MISSING_OVERRIDE);
             }
         }
     }

src/main/java/com/puppycrawl/tools/checkstyle/filters/SuppressionXpathFilter.java

@@ -122,9 +122,6 @@
  * MissingJavadocType
  * </li>
  * <li>
- * MissingOverride
- * </li>
- * <li>
  * MissingSwitchDefault
  * </li>
  * <li>