support type cast detection #710

Detect checkcast asm instructions as TypeCast (similar to InstanceofCheck)
Implicit checkcast instructions generated by compiler due to method invocations are ignored

Resolves #710

Signed-off-by: Allan Jones <[email protected]>

Author: ratoaq2

archunit-example/example-junit4/src/test/resources/frozen/e77ec262-4d5c-4a7b-b41f-362a71e5a1d8

@@ -6,4 +6,5 @@ Method <com.tngtech.archunit.example.layers.persistence.first.dao.jpa.SomeJpa.fi
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.OtherDao.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherDao.java:0)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.findById(long)> calls method <javax.persistence.EntityManager.find(java.lang.Class, java.lang.Object)> in (OtherJpa.java:19)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherJpa.java:0)
-Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> casts <com.tngtech.archunit.example.layers.service.ProxiedConnection> in (OtherJpa.java:27)

archunit-example/example-junit5/src/test/resources/frozen/e77ec262-4d5c-4a7b-b41f-362a71e5a1d8

@@ -6,4 +6,5 @@ Method <com.tngtech.archunit.example.layers.persistence.first.dao.jpa.SomeJpa.fi
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.OtherDao.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherDao.java:0)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.findById(long)> calls method <javax.persistence.EntityManager.find(java.lang.Class, java.lang.Object)> in (OtherJpa.java:19)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherJpa.java:0)
-Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> casts <com.tngtech.archunit.example.layers.service.ProxiedConnection> in (OtherJpa.java:27)

archunit-example/example-plain/src/test/resources/frozen/e77ec262-4d5c-4a7b-b41f-362a71e5a1d8

@@ -6,4 +6,5 @@ Method <com.tngtech.archunit.example.layers.persistence.first.dao.jpa.SomeJpa.fi
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.OtherDao.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherDao.java:0)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.findById(long)> calls method <javax.persistence.EntityManager.find(java.lang.Class, java.lang.Object)> in (OtherJpa.java:19)
 Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.getEntityManager()> has return type <javax.persistence.EntityManager> in (OtherJpa.java:0)
-Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> calls method <javax.persistence.EntityManager.unwrap(java.lang.Class)> in (OtherJpa.java:24)
+Method <com.tngtech.archunit.example.layers.persistence.second.dao.jpa.OtherJpa.testConnection()> casts <com.tngtech.archunit.example.layers.service.ProxiedConnection> in (OtherJpa.java:27)

archunit-integration-test/src/test/java/com/tngtech/archunit/integration/ExamplesIntegrationTest.java

@@ -672,6 +672,9 @@ Stream<DynamicTest> FrozenRulesTest() {
                 .by(method(OtherJpa.class, "testConnection")
                         .checkingInstanceOf(ProxiedConnection.class)
                         .inLine(26))
+                .by(method(OtherJpa.class, "testConnection")
+                        .casting(ProxiedConnection.class)
+                        .inLine(27))
 
                 .ofRule("no classes should depend on classes that are assignable to javax.persistence.EntityManager")
                 .by(callFromMethod(ServiceViolatingDaoRules.class, "illegallyUseEntityManager").
@@ -847,6 +850,9 @@ Stream<DynamicTest> LayerDependencyRulesTest() {
                 .by(method(OtherJpa.class, "testConnection")
                         .checkingInstanceOf(ProxiedConnection.class)
                         .inLine(26))
+                .by(method(OtherJpa.class, "testConnection")
+                        .casting(ProxiedConnection.class)
+                        .inLine(27))
 
                 .ofRule("classes that reside in a package '..service..' should " +
                         "only have dependent classes that reside in any package ['..controller..', '..service..']")
@@ -866,6 +872,9 @@ Stream<DynamicTest> LayerDependencyRulesTest() {
                 .by(method(OtherJpa.class, "testConnection")
                         .checkingInstanceOf(ProxiedConnection.class)
                         .inLine(26))
+                .by(method(OtherJpa.class, "testConnection")
+                        .casting(ProxiedConnection.class)
+                        .inLine(27))
 
                 .ofRule("classes that reside in a package '..service..' should "
                         + "only depend on classes that reside in any package ['..service..', '..persistence..', 'java..', 'javax..']")
@@ -972,6 +981,9 @@ Stream<DynamicTest> LayeredArchitectureTest() {
                                         .toMethod(ProxiedConnection.class, "refresh")
                                         .inLine(27)
                                         .asDependency())
+                                .by(method(OtherJpa.class, "testConnection")
+                                        .casting(ProxiedConnection.class)
+                                        .inLine(27))
 
                                 .by(typeParameter(ServiceHelper.class, "TYPE_PARAMETER_VIOLATING_LAYER_RULE").dependingOn(SomeUtility.class))
                                 .by(typeParameter(ServiceHelper.class, "ANOTHER_TYPE_PARAMETER_VIOLATING_LAYER_RULE").dependingOn(SomeEnum.class))

archunit-integration-test/src/test/java/com/tngtech/archunit/testutils/ExpectedDependency.java

@@ -295,6 +295,10 @@ public AddsLineNumber checkingInstanceOf(Class<?> target) {
             return new AddsLineNumber(owner, getOriginName(), "checks instanceof", target);
         }
 
+        public AddsLineNumber casting(Class<?> target) {
+            return new AddsLineNumber(owner, getOriginName(), "casts", target);
+        }
+
         public AddsLineNumber referencingClassObject(Class<?> target) {
             return new AddsLineNumber(owner, getOriginName(), "references class object", target);
         }

archunit/src/main/java/com/tngtech/archunit/core/domain/Dependency.java

@@ -128,6 +128,12 @@ static Set<Dependency> tryCreateFromInstanceofCheck(InstanceofCheck instanceofCh
                 instanceofCheck.getRawType(), instanceofCheck.getSourceCodeLocation());
     }
 
+    static Set<Dependency> tryCreateFromTypeCast(TypeCast typeCast) {
+        return tryCreateDependency(
+                typeCast.getOwner(), "casts",
+                typeCast.getRawType(), typeCast.getSourceCodeLocation());
+    }
+
     static Set<Dependency> tryCreateFromReferencedClassObject(ReferencedClassObject referencedClassObject) {
         return tryCreateDependency(
                 referencedClassObject.getOwner(), "references class object",

archunit/src/main/java/com/tngtech/archunit/core/domain/DomainObjectCreationContext.java

@@ -184,6 +184,10 @@ public static InstanceofCheck createInstanceofCheck(JavaCodeUnit codeUnit, JavaC
         return InstanceofCheck.from(codeUnit, type, lineNumber, declaredInLambda);
     }
 
+    public static TypeCast createTypeCast(JavaCodeUnit codeUnit, JavaClass type, int lineNumber, boolean declaredInLambda) {
+        return TypeCast.from(codeUnit, type, lineNumber, declaredInLambda);
+    }
+
     public static <OWNER extends HasDescription> JavaTypeVariable<OWNER> createTypeVariable(String name, OWNER owner, JavaClass erasure) {
         return new JavaTypeVariable<>(name, owner, erasure);
     }

archunit/src/main/java/com/tngtech/archunit/core/domain/ImportContext.java

@@ -67,5 +67,7 @@ public interface ImportContext {
 
     Set<InstanceofCheck> createInstanceofChecksFor(JavaCodeUnit codeUnit);
 
+    Set<TypeCast> createTypeCastsFor(JavaCodeUnit codeUnit);
+
     JavaClass resolveClass(String fullyQualifiedClassName);
 }

archunit/src/main/java/com/tngtech/archunit/core/domain/JavaClass.java

@@ -645,6 +645,11 @@ public Set<InstanceofCheck> getInstanceofChecks() {
         return members.getInstanceofChecks();
     }
 
+    @PublicAPI(usage = ACCESS)
+    public Set<TypeCast> getTypeCasts() {
+        return members.getTypeCasts();
+    }
+
     @PublicAPI(usage = ACCESS)
     public Set<ReferencedClassObject> getReferencedClassObjects() {
         return members.getReferencedClassObjects();

archunit/src/main/java/com/tngtech/archunit/core/domain/JavaClassDependencies.java

@@ -49,6 +49,7 @@ private Supplier<Set<Dependency>> createDirectDependenciesFromClassSupplier() {
                         throwsDeclarationDependenciesFromSelf(),
                         annotationDependenciesFromSelf(),
                         instanceofCheckDependenciesFromSelf(),
+                        typeCastDependenciesFromSelf(),
                         referencedClassObjectDependenciesFromSelf(),
                         typeParameterDependenciesFromSelf()
                 ).collect(toImmutableSet())
@@ -182,6 +183,11 @@ private Stream<Dependency> instanceofCheckDependenciesFromSelf() {
                 .flatMap(instanceofCheck -> Dependency.tryCreateFromInstanceofCheck(instanceofCheck).stream());
     }
 
+    private Stream<Dependency> typeCastDependenciesFromSelf() {
+        return javaClass.getTypeCasts().stream()
+                .flatMap(typeCast -> Dependency.tryCreateFromTypeCast(typeCast).stream());
+    }
+
     private Stream<Dependency> referencedClassObjectDependenciesFromSelf() {
         return javaClass.getReferencedClassObjects().stream()
                 .flatMap(referencedClassObject -> Dependency.tryCreateFromReferencedClassObject(referencedClassObject).stream());