|
| 1 | +package dev.archunitjava.rules; |
| 2 | + |
| 3 | +import static org.junit.jupiter.api.Assertions.assertEquals; |
| 4 | +import static org.junit.jupiter.api.Assertions.assertFalse; |
| 5 | +import static org.junit.jupiter.api.Assertions.assertNotNull; |
| 6 | +import static org.junit.jupiter.api.Assertions.assertTrue; |
| 7 | + |
| 8 | +import dev.archunitjava.cli.CliAnalysisResult; |
| 9 | +import dev.archunitjava.cli.CliAnalyzer; |
| 10 | +import dev.archunitjava.cli.CliConfigurationLoader; |
| 11 | +import dev.archunitjava.graph.DependencyEvidence; |
| 12 | +import dev.archunitjava.graph.DependencyKind; |
| 13 | +import dev.archunitjava.graph.MemberId; |
| 14 | +import dev.archunitjava.graph.TypeId; |
| 15 | +import dev.archunitjava.model.JavaMemberModifier; |
| 16 | +import dev.archunitjava.pattern.JavaPattern; |
| 17 | +import dev.archunitjava.pattern.PatternDomain; |
| 18 | +import dev.archunitjava.result.RuleStatus; |
| 19 | +import dev.archunitjava.selector.PackageSelector; |
| 20 | +import dev.archunitjava.selector.TypeSelector; |
| 21 | +import java.io.IOException; |
| 22 | +import java.nio.file.Files; |
| 23 | +import java.nio.file.Path; |
| 24 | +import java.util.List; |
| 25 | +import java.util.Set; |
| 26 | +import java.util.stream.Collectors; |
| 27 | +import org.junit.jupiter.api.BeforeEach; |
| 28 | +import org.junit.jupiter.api.Test; |
| 29 | +import org.junit.jupiter.api.io.TempDir; |
| 30 | + |
| 31 | +class CycleRulesBytecodeTest { |
| 32 | + private static final String PREFIX = "dev.archunitjava.rules.fixtures.cycles."; |
| 33 | + private static final TypeId LEFT = TypeId.ofBinaryName(PREFIX + "left.CycleLeft"); |
| 34 | + private static final TypeId RIGHT = TypeId.ofBinaryName(PREFIX + "right.CycleRight"); |
| 35 | + |
| 36 | + @TempDir Path temporaryDirectory; |
| 37 | + private CliAnalysisResult analysis; |
| 38 | + |
| 39 | + @BeforeEach |
| 40 | + void importJavacFixturesWithoutLoadingTargetClasses() throws IOException { |
| 41 | + for (String name : List.of(LEFT.binaryName(), RIGHT.binaryName(), |
| 42 | + LEFT.binaryName() + "$OneWay", RIGHT.binaryName() + "$Leaf")) { |
| 43 | + String resource = name.replace('.', '/') + ".class"; |
| 44 | + Path target = temporaryDirectory.resolve("classes").resolve(resource); |
| 45 | + Files.createDirectories(target.getParent()); |
| 46 | + try (var input = CycleRulesBytecodeTest.class.getResourceAsStream("/" + resource)) { |
| 47 | + assertNotNull(input, resource); |
| 48 | + Files.copy(input, target); |
| 49 | + } |
| 50 | + } |
| 51 | + Path configuration = temporaryDirectory.resolve("archunitjava.properties"); |
| 52 | + Files.writeString(configuration, """ |
| 53 | + schema=archunitjava.cli.v1 |
| 54 | + inputs=classes |
| 55 | + rules=fixture |
| 56 | + rule.fixture.domain=types |
| 57 | + rule.fixture.mode=only |
| 58 | + rule.fixture.origins=glob:dev.archunitjava.rules.fixtures.cycles.** |
| 59 | + rule.fixture.targets=glob:dev.archunitjava.rules.fixtures.cycles.** |
| 60 | + rule.fixture.external=ignore |
| 61 | + """); |
| 62 | + analysis = new CliAnalyzer().analyze( |
| 63 | + CliConfigurationLoader.load(configuration, temporaryDirectory)); |
| 64 | + assertTrue(analysis.imports().model().classFileDiagnostics().isEmpty()); |
| 65 | + assertEquals(4, analysis.imports().model().types().size()); |
| 66 | + } |
| 67 | + |
| 68 | + @Test |
| 69 | + void defaultRulesDetectJavacTypeAndPackageCycles() { |
| 70 | + TypeSelector selected = types(LEFT.binaryName(), RIGHT.binaryName()); |
| 71 | + assertEquals(RuleStatus.FAILED, CycleRules.typesAreAcyclic( |
| 72 | + analysis.imports().model(), analysis.graph(), selected).check().status()); |
| 73 | + assertEquals(RuleStatus.FAILED, CycleRules.packagesAreAcyclic( |
| 74 | + analysis.imports().model(), analysis.graph(), PackageSelector.all()).check().status()); |
| 75 | + } |
| 76 | + |
| 77 | + @Test |
| 78 | + void javacMethodCyclesAreDetectedUnderEverySyntheticPolicy() { |
| 79 | + assertCyclesUnderEverySyntheticPolicy(DependencyKind.METHOD_CALL); |
| 80 | + } |
| 81 | + |
| 82 | + @Test |
| 83 | + void javacFieldCyclesRespectTheIndependentTypeUsePolicy() { |
| 84 | + assertCyclesUnderEverySyntheticPolicy(DependencyKind.FIELD_TYPE); |
| 85 | + var noTypeUses = CycleRuleOptions.defaults().includingOnly(Set.of(DependencyKind.FIELD_TYPE)) |
| 86 | + .withTypeUseDependencies(TypeUseDependencyPolicy.IGNORE); |
| 87 | + assertEquals(RuleStatus.PASSED, CycleRules.typesAreAcyclic( |
| 88 | + analysis.imports().model(), analysis.graph(), types(LEFT.binaryName(), RIGHT.binaryName()), |
| 89 | + noTypeUses).check().status()); |
| 90 | + } |
| 91 | + |
| 92 | + @Test |
| 93 | + void javacLambdaEvidenceIsFilteredWithoutRemovingOrdinaryCallsOnTheSameEdge() { |
| 94 | + Set<MemberId> syntheticMembers = analysis.imports().model().types().stream() |
| 95 | + .flatMap(type -> type.declaredMembers().stream() |
| 96 | + .filter(member -> member.modifiers().contains(JavaMemberModifier.SYNTHETIC)) |
| 97 | + .map(member -> MemberId.of(TypeId.ofBinaryName(type.binaryName()), |
| 98 | + member.name(), member.descriptor()))) |
| 99 | + .collect(Collectors.toSet()); |
| 100 | + assertFalse(syntheticMembers.isEmpty(), "javac must generate a lambda implementation member"); |
| 101 | + var calls = analysis.graph().edges().stream() |
| 102 | + .filter(edge -> edge.origin().equals(LEFT) && edge.target().equals(RIGHT) |
| 103 | + && edge.kind() == DependencyKind.METHOD_CALL) |
| 104 | + .flatMap(edge -> edge.evidence().stream()).toList(); |
| 105 | + assertTrue(calls.stream().anyMatch(evidence -> syntheticMembers.contains( |
| 106 | + evidence.ownerMember().orElseThrow()))); |
| 107 | + assertTrue(calls.stream().anyMatch(evidence -> !syntheticMembers.contains( |
| 108 | + evidence.ownerMember().orElseThrow()))); |
| 109 | + |
| 110 | + for (SyntheticEdgePolicy policy : SyntheticEdgePolicy.values()) { |
| 111 | + var result = CycleRules.typesAreAcyclic(analysis.imports().model(), analysis.graph(), |
| 112 | + types(LEFT.binaryName(), RIGHT.binaryName()), CycleRuleOptions.defaults() |
| 113 | + .includingOnly(Set.of(DependencyKind.METHOD_CALL)) |
| 114 | + .withSyntheticEdges(policy)).check(); |
| 115 | + assertEquals(RuleStatus.FAILED, result.status()); |
| 116 | + Set<MemberId> owners = result.violations().getFirst().evidence().stream() |
| 117 | + .map(DependencyEvidence::ownerMember).map(owner -> owner.orElseThrow()) |
| 118 | + .collect(Collectors.toSet()); |
| 119 | + assertTrue(owners.contains(MemberId.of(LEFT, "work", "()V"))); |
| 120 | + assertTrue(owners.contains(MemberId.of(RIGHT, "work", "()V"))); |
| 121 | + assertEquals(policy == SyntheticEdgePolicy.INCLUDE, |
| 122 | + owners.stream().anyMatch(syntheticMembers::contains)); |
| 123 | + } |
| 124 | + } |
| 125 | + |
| 126 | + @Test |
| 127 | + void javacOneWayDependenciesRemainAcyclicUnderEverySyntheticPolicy() { |
| 128 | + TypeSelector selected = types(LEFT.binaryName() + "$OneWay", RIGHT.binaryName() + "$Leaf"); |
| 129 | + assertEquals(2, selected.selectFrom(analysis.imports().model()).selected().size()); |
| 130 | + Set<DependencyKind> importedKinds = analysis.graph().edges().stream() |
| 131 | + .filter(edge -> edge.origin().equals(TypeId.ofBinaryName(LEFT.binaryName() + "$OneWay")) |
| 132 | + && edge.target().equals(TypeId.ofBinaryName(RIGHT.binaryName() + "$Leaf"))) |
| 133 | + .map(edge -> edge.kind()).collect(Collectors.toSet()); |
| 134 | + assertTrue(importedKinds.containsAll(Set.of(DependencyKind.METHOD_CALL, DependencyKind.FIELD_TYPE))); |
| 135 | + assertEquals(RuleStatus.PASSED, CycleRules.typesAreAcyclic( |
| 136 | + analysis.imports().model(), analysis.graph(), selected).check().status()); |
| 137 | + for (SyntheticEdgePolicy policy : SyntheticEdgePolicy.values()) { |
| 138 | + var result = CycleRules.typesAreAcyclic(analysis.imports().model(), analysis.graph(), |
| 139 | + selected, CycleRuleOptions.defaults().withSyntheticEdges(policy)).check(); |
| 140 | + assertEquals(RuleStatus.PASSED, result.status(), policy.name()); |
| 141 | + assertTrue(result.violations().isEmpty()); |
| 142 | + } |
| 143 | + } |
| 144 | + |
| 145 | + private void assertCyclesUnderEverySyntheticPolicy(DependencyKind kind) { |
| 146 | + var edges = analysis.graph().edges().stream() |
| 147 | + .filter(edge -> edge.kind() == kind) |
| 148 | + .filter(edge -> Set.of(LEFT, RIGHT).contains(edge.origin()) |
| 149 | + && Set.of(LEFT, RIGHT).contains(edge.target())) |
| 150 | + .toList(); |
| 151 | + assertEquals(2, edges.size(), kind.name()); |
| 152 | + assertTrue(edges.stream().flatMap(edge -> edge.evidence().stream()) |
| 153 | + .allMatch(evidence -> evidence.ownerMember().isPresent())); |
| 154 | + for (SyntheticEdgePolicy policy : SyntheticEdgePolicy.values()) { |
| 155 | + var options = CycleRuleOptions.defaults().includingOnly(Set.of(kind)).withSyntheticEdges(policy); |
| 156 | + var result = CycleRules.typesAreAcyclic(analysis.imports().model(), analysis.graph(), |
| 157 | + types(LEFT.binaryName(), RIGHT.binaryName()), options).check(); |
| 158 | + assertEquals(RuleStatus.FAILED, result.status(), kind + "/" + policy); |
| 159 | + assertEquals(1, result.violations().size()); |
| 160 | + assertFalse(result.violations().getFirst().evidence().isEmpty()); |
| 161 | + var packages = CycleRules.packagesAreAcyclic(analysis.imports().model(), |
| 162 | + analysis.graph(), PackageSelector.all(), options).check(); |
| 163 | + assertEquals(RuleStatus.FAILED, packages.status(), kind + "/" + policy); |
| 164 | + assertEquals(1, packages.violations().size()); |
| 165 | + } |
| 166 | + } |
| 167 | + |
| 168 | + private static TypeSelector types(String first, String second) { |
| 169 | + return TypeSelector.anyOf( |
| 170 | + TypeSelector.binaryName(JavaPattern.exact(PatternDomain.QUALIFIED_NAME, first)), |
| 171 | + TypeSelector.binaryName(JavaPattern.exact(PatternDomain.QUALIFIED_NAME, second))); |
| 172 | + } |
| 173 | +} |
0 commit comments