HBASE-25333 Add maven enforcer rule to ban VisibleForTesting imports (#…

…2854) Signed-off-by: Peter Somogyi <[email protected]>
apache · Jan 9, 2021 · 4925a64 · 4925a64
1 parent 54eae0f
commit 4925a64
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/pom.xml b/pom.xml
@@ -1341,6 +1341,19 @@
                     <bannedImport>org.glassfish.jersey.**</bannedImport>
                   </bannedImports>
                 </restrictImports>
+                <restrictImports implementation="de.skuzzle.enforcer.restrictimports.rule.RestrictImports">
+                  <includeTestCode>true</includeTestCode>
+                  <commentLineBufferSize>512</commentLineBufferSize>
+                  <reason>
+                    You should never use this style of annotations(i.e, 'this is for test only')
+                    in IA.Public or IA.LimitedPrivate classes. Use IA.Private to tell users this is
+                    not for public use.
+                    For IA.Private classes, use RestrictedApi annotation in error prone instead.
+                  </reason>
+                  <bannedImports>
+                    <bannedImport>org.apache.hbase.thirdparty.com.google.common.annotations.VisibleForTesting</bannedImport>
+                  </bannedImports>
+                </restrictImports>
               </rules>
             </configuration>
           </execution>