Ignore deny listed words in implementation packages (Azure#43369)

Author: alzimmermsft

eng/code-quality-reports/src/main/java/com/azure/tools/checkstyle/checks/DenyListedWordsCheck.java

@@ -5,6 +5,7 @@
 
 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
 import com.puppycrawl.tools.checkstyle.api.DetailAST;
+import com.puppycrawl.tools.checkstyle.api.FullIdent;
 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
 import com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption;
 import com.puppycrawl.tools.checkstyle.utils.CheckUtil;
@@ -21,6 +22,8 @@
 public class DenyListedWordsCheck extends AbstractCheck {
     private String[] denyListedWords = new String[0];
 
+    private boolean implementationPackage = false;
+
     static final String ERROR_MESSAGE = "%s, All Public API Classes, Fields and Methods should follow "
         + "Camelcase standards for the following words: %s.";
 
@@ -47,14 +50,35 @@ public int[] getAcceptableTokens() {
 
     @Override
     public int[] getRequiredTokens() {
-        return new int[]{TokenTypes.CLASS_DEF,
-            TokenTypes.METHOD_DEF,
-            TokenTypes.VARIABLE_DEF};
+        return new int[] {
+            TokenTypes.PACKAGE_DEF, TokenTypes.CLASS_DEF, TokenTypes.METHOD_DEF, TokenTypes.VARIABLE_DEF };
+    }
+
+    @Override
+    public void beginTree(DetailAST rootAST) {
+        implementationPackage = false;
+    }
+
+    @Override
+    public void finishTree(DetailAST rootAST) {
+        implementationPackage = false;
     }
 
     @Override
     public void visitToken(DetailAST token) {
+        // If we're in an implementation package ignore this check.
+        // If a PACKAGE_DEF is not found, then assume it's not an implementation package.
+        if (implementationPackage) {
+            return;
+        }
+
         switch (token.getType()) {
+            case TokenTypes.PACKAGE_DEF:
+                // Check if we're in an implementation package.
+                final String packageName = FullIdent.createFullIdent(token.findFirstToken(TokenTypes.DOT)).getText();
+                implementationPackage = packageName.contains("implementation");
+                break;
+
             case TokenTypes.CLASS_DEF:
             case TokenTypes.METHOD_DEF:
             case TokenTypes.VARIABLE_DEF:
@@ -67,7 +91,7 @@ public void visitToken(DetailAST token) {
                     break;
                 }
 
-                // In an interface all the fields (variables) are by default public, static and final.
+                // In an interface all the fields (variables) are by default public, static, and final.
                 if (token.getType() == TokenTypes.VARIABLE_DEF && ScopeUtil.isInInterfaceBlock(token)) {
                     break;
                 }
@@ -91,7 +115,8 @@ private boolean isPublicApi(DetailAST token) {
         final DetailAST modifiersAST = token.findFirstToken(TokenTypes.MODIFIERS);
         final AccessModifierOption accessModifier = CheckUtil.getAccessModifierFromModifiersToken(token);
         final boolean isStatic = modifiersAST.findFirstToken(TokenTypes.LITERAL_STATIC) != null;
-        return (accessModifier.equals(AccessModifierOption.PUBLIC) || accessModifier.equals(AccessModifierOption.PROTECTED)) && !isStatic;
+        return (accessModifier.equals(AccessModifierOption.PUBLIC) || accessModifier.equals(
+            AccessModifierOption.PROTECTED)) && !isStatic;
     }
 
     /**

eng/code-quality-reports/src/test/java/com/azure/tools/checkstyle/checks/DenyListedWordsCheckTest.java

@@ -11,6 +11,9 @@
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 
+import java.io.File;
+import java.util.Arrays;
+
 public class DenyListedWordsCheckTest extends AbstractModuleTestSupport {
     private Checker checker;
 
@@ -44,6 +47,23 @@ public void denyListedWordsInterface() throws Exception {
         verify(checker, getPath("DenyListedWordsInterface.java"));
     }
 
+    @Test
+    public void implementationPackageIgnored() throws Exception {
+        File file = TestUtils.createCheckFile("implementationPackageIgnored", Arrays.asList(
+            "package com.test.implementation;",
+            "@JacksonXmlRootElement(localName = \"File-SetHTTPHeaders-Headers\")",
+            "public class CamelCaseTestData {",
+            "    public void errorHTTPMethod() { throw new RuntimeException(\"Error Messages.\"); }",
+            "    public void validHttpMethod() { throw new RuntimeException(\"Error Messages.\"); }",
+            "    public static void itIsAURLError() { throw new RuntimeException(\"Error Messages.\"); }",
+            "    protected void invalidXMLMethod() { throw new RuntimeException(\"Error Messages.\"); }",
+            "    private void shouldNotSearch() { throw new RuntimeException(\"Error Messages.\"); }",
+            "}"
+        ));
+
+        verify(checker, new File[]{file}, file.getAbsolutePath());
+    }
+
     private String expectedErrorMessage(int line, int column, String errorMessage) {
         return String.format("%d:%d: %s", line, column, errorMessage);
     }