SONARJAVA-5318 modify S7180 to not raise in interface annotated with spring data repository (#5027)

Author: erwan-serandour

java-checks-test-sources/default/src/main/java/checks/spring/CacheAnnotationsShouldOnlyBeAppliedToConcreteClassesCheckSample.java

@@ -5,6 +5,8 @@
 import org.springframework.cache.annotation.CachePut;
 import org.springframework.cache.annotation.Cacheable;
 import org.springframework.cache.annotation.Caching;
+import org.springframework.data.repository.CrudRepository;
+import org.springframework.data.repository.Repository;
 
 public class CacheAnnotationsShouldOnlyBeAppliedToConcreteClassesCheckSample {
 
@@ -86,4 +88,30 @@ class ClassCaching {
     @Caching
     String getData(String id){return "";}
   }
+
+  interface MyRepository extends Repository<Integer, Integer> {
+    @Cacheable("aCache") // compliant, it is the only way to do it in repositories. I guess depending on proxy mode
+    // repositories don't work at all
+    Integer findById(Integer id);
+
+    @CachePut("aCache") // compliant
+    Integer findByIdCachePut(Integer id);
+
+    @CacheEvict("aCache") // compliant
+    Integer findByIdCacheEvict(Integer id);
+
+    @org.springframework.cache.annotation.Cacheable("aCache")
+    Integer fullyQualifiedCache(Integer i);
+  }
+
+  public interface MyCrudRepository extends CrudRepository<Integer, Integer> {
+    @CachePut("aCache") // compliant
+    Integer findByIdCachePut(Integer id);
+
+    @CacheEvict("aCache") // compliant
+    Integer findByIdCacheEvict(Integer id);
+
+    @org.springframework.cache.annotation.Cacheable("aCache")
+    Integer fullyQualifiedCache(Integer i);
+  }
 }

java-checks/src/main/java/org/sonar/java/checks/spring/CacheAnnotationsShouldOnlyBeAppliedToConcreteClassesCheck.java

@@ -31,6 +31,7 @@
 public class CacheAnnotationsShouldOnlyBeAppliedToConcreteClassesCheck extends IssuableSubscriptionVisitor {
 
   private static final String ISSUE_MESSAGE = "\"@%s\" annotation should only be applied to concrete classes.";
+  private static final String REPOSITORY_INTERFACE = "org.springframework.data.repository.Repository";
   private static final Set<String> CACHING_ANNOTATIONS = Set.of(
     "org.springframework.cache.annotation.CacheConfig",
     "org.springframework.cache.annotation.CacheEvict",
@@ -47,6 +48,10 @@ public List<Tree.Kind> nodesToVisit() {
   public void visitNode(Tree tree) {
     ClassTree anInterface = (ClassTree) tree;
 
+    if (anInterface.symbol().type().isSubtypeOf(REPOSITORY_INTERFACE)) {
+      return;
+    }
+
     // report caching annotations on the whole interface
     selectCachingAnnotations(anInterface.modifiers())
       .forEach(ann -> {