forked from TNG/ArchUnit
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add
ArchCondition to check for transitive dependencies
The original implementation had the problem that it reported every single transitive dependency that matched the predicate. This would mean, even if a transitive dependency got reported as violation, all further transitive dependencies of that dependency would still be analyzed and potentially also reported as violation. For rules like
```
noClasses()
.that().resideInAPackage("..example..")
.should().transitivelyDependOnClassesThat().resideInAPackage("..some.framework..")
```
this would mean thousands of violations, even for classes that are only reached through other framework classes.
We now do a depth first search approach for all dependency paths that are outgoing from the analyzed classes until we find a matching target. Then we stop and report the path. This way all further dependencies will be omitted and the analysis will complete a lot faster.
Issue: TNG#780
Signed-off-by: e.solutions <[email protected]>
on-behalf-of: @e-esolutions-GmbH <[email protected]>- Loading branch information
1 parent
a3268fb
commit 499020a
Showing
4 changed files
with
194 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
...nit/src/main/java/com/tngtech/archunit/lang/conditions/TransitiveDependencyCondition.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /* | ||
| * Copyright 2014-2022 TNG Technology Consulting GmbH | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package com.tngtech.archunit.lang.conditions; | ||
|
|
||
| import java.util.Collection; | ||
| import java.util.HashSet; | ||
| import java.util.List; | ||
| import java.util.Set; | ||
|
|
||
| import com.google.common.collect.ImmutableList; | ||
| import com.tngtech.archunit.base.DescribedPredicate; | ||
| import com.tngtech.archunit.core.domain.JavaClass; | ||
| import com.tngtech.archunit.lang.ArchCondition; | ||
| import com.tngtech.archunit.lang.ConditionEvent; | ||
| import com.tngtech.archunit.lang.ConditionEvents; | ||
| import com.tngtech.archunit.lang.SimpleConditionEvent; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkNotNull; | ||
| import static com.google.common.collect.Iterables.getLast; | ||
| import static com.tngtech.archunit.lang.ConditionEvent.createMessage; | ||
| import static java.util.stream.Collectors.joining; | ||
| import static java.util.stream.Collectors.toSet; | ||
|
|
||
| public class TransitiveDependencyCondition extends ArchCondition<JavaClass> { | ||
|
|
||
| private final DescribedPredicate<? super JavaClass> conditionPredicate; | ||
| private final TransitiveDependencyPath transitiveDependencyPath = new TransitiveDependencyPath(); | ||
| private Collection<JavaClass> allClasses; | ||
|
|
||
| public TransitiveDependencyCondition(DescribedPredicate<? super JavaClass> conditionPredicate) { | ||
| super("transitively depend on classes that " + conditionPredicate.getDescription()); | ||
|
|
||
| this.conditionPredicate = checkNotNull(conditionPredicate); | ||
| } | ||
|
|
||
| @Override | ||
| public void init(Collection<JavaClass> allObjectsToTest) { | ||
| this.allClasses = allObjectsToTest; | ||
| } | ||
|
|
||
| @Override | ||
| public void check(JavaClass javaClass, ConditionEvents events) { | ||
| boolean hasTransitiveDependency = false; | ||
| for (JavaClass target : getDirectDependencyTargetsOutsideOfAnalyzedClasses(javaClass)) { | ||
| List<JavaClass> dependencyPath = transitiveDependencyPath.findPathTo(target); | ||
| if (!dependencyPath.isEmpty()) { | ||
| events.add(newTransitiveDependencyPathFoundEvent(javaClass, dependencyPath)); | ||
| hasTransitiveDependency = true; | ||
| } | ||
| } | ||
| if (!hasTransitiveDependency) { | ||
| events.add(newNoTransitiveDependencyPathFoundEvent(javaClass)); | ||
| } | ||
| } | ||
|
|
||
| private static ConditionEvent newTransitiveDependencyPathFoundEvent(JavaClass javaClass, List<JavaClass> transitiveDependencyPath) { | ||
| String message = String.format("%sdepends on <%s>", | ||
| transitiveDependencyPath.size() > 1 ? "transitively " : "", | ||
| getLast(transitiveDependencyPath).getFullName()); | ||
|
|
||
| if (transitiveDependencyPath.size() > 1) { | ||
| message += " by [" + transitiveDependencyPath.stream().map(JavaClass::getName).collect(joining("->")) + "]"; | ||
| } | ||
|
|
||
| return SimpleConditionEvent.satisfied(javaClass, createMessage(javaClass, message)); | ||
| } | ||
|
|
||
| private static ConditionEvent newNoTransitiveDependencyPathFoundEvent(JavaClass javaClass) { | ||
| return SimpleConditionEvent.violated(javaClass, createMessage(javaClass, "does not transitively depend on any matching class")); | ||
| } | ||
|
|
||
| private Set<JavaClass> getDirectDependencyTargetsOutsideOfAnalyzedClasses(JavaClass item) { | ||
| return item.getDirectDependenciesFromSelf().stream() | ||
| .map(dependency -> dependency.getTargetClass().getBaseComponentType()) | ||
| .filter(targetClass -> !allClasses.contains(targetClass)) | ||
| .collect(toSet()); | ||
| } | ||
|
|
||
| private class TransitiveDependencyPath { | ||
| /** | ||
| * @return some outgoing transitive dependency path to the supplied class or empty if there is none | ||
| */ | ||
| List<JavaClass> findPathTo(JavaClass clazz) { | ||
| ImmutableList.Builder<JavaClass> transitivePath = ImmutableList.builder(); | ||
| addDependenciesToPathFrom(clazz, transitivePath, new HashSet<>()); | ||
| return transitivePath.build().reverse(); | ||
| } | ||
|
|
||
| private boolean addDependenciesToPathFrom( | ||
| JavaClass clazz, | ||
| ImmutableList.Builder<JavaClass> dependencyPath, | ||
| Set<JavaClass> analyzedClasses | ||
| ) { | ||
| if (conditionPredicate.test(clazz)) { | ||
| dependencyPath.add(clazz); | ||
| return true; | ||
| } | ||
|
|
||
| analyzedClasses.add(clazz); | ||
|
|
||
| for (JavaClass directDependency : getDirectDependencyTargetsOutsideOfAnalyzedClasses(clazz)) { | ||
| if (!analyzedClasses.contains(directDependency) | ||
| && addDependenciesToPathFrom(directDependency, dependencyPath, analyzedClasses)) { | ||
| dependencyPath.add(clazz); | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters