Repository navigation
Expand file tree
/
Copy pathCycleRulesTest.java
More file actions
311 lines (279 loc) · 14.9 KB
/
Copy pathCycleRulesTest.java
File metadata and controls
311 lines (279 loc) · 14.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
package dev.archunitjava.rules;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import dev.archunitjava.graph.DependencyEvidence;
import dev.archunitjava.graph.DependencyGraph;
import dev.archunitjava.graph.DependencyKind;
import dev.archunitjava.graph.LocationId;
import dev.archunitjava.graph.MemberId;
import dev.archunitjava.graph.TypeId;
import dev.archunitjava.importer.ClassFileInput;
import dev.archunitjava.importer.ClassFileInputEnumerator;
import dev.archunitjava.importer.ClassFileReader;
import dev.archunitjava.model.TypeModelBuilder;
import dev.archunitjava.model.TypeModelResult;
import dev.archunitjava.pattern.JavaPattern;
import dev.archunitjava.pattern.PatternDomain;
import dev.archunitjava.result.RuleStatus;
import dev.archunitjava.selector.PackageSelector;
import dev.archunitjava.selector.TypeSelector;
import java.io.IOException;
import java.lang.classfile.ClassFile;
import java.lang.constant.ClassDesc;
import java.lang.constant.MethodTypeDesc;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
class CycleRulesTest {
private static final TypeId A = TypeId.ofBinaryName("app.A");
private static final TypeId B = TypeId.ofBinaryName("app.B");
private static final TypeId C = TypeId.ofBinaryName("app.C");
private static final TypeId D = TypeId.ofBinaryName("other.D");
private static final TypeId GENERATED = TypeId.ofBinaryName("app.Generated");
private static final MemberId A_WORK = MemberId.of(A, "work", "()V");
private static final MemberId A_BRIDGE = MemberId.of(A, "bridge", "()V");
private static final MemberId A_SYNTHETIC = MemberId.of(A, "generated", "()V");
private static final MemberId B_WORK = MemberId.of(B, "work", "()V");
private static final MemberId D_WORK = MemberId.of(D, "work", "()V");
private static final MemberId GENERATED_WORK = MemberId.of(GENERATED, "work", "()V");
@TempDir Path temporaryDirectory;
private TypeModelResult model;
@BeforeEach
void importTypes() throws IOException {
write("app/A.class", type("app.A", true));
write("app/B.class", type("app.B", false));
write("app/C.class", type("app.C", false));
write("other/D.class", type("other.D", false));
write("app/Generated.class", syntheticType("app.Generated"));
var resources = new ClassFileInputEnumerator()
.enumerate(List.of(ClassFileInput.directory(temporaryDirectory)))
.resources();
model = new TypeModelBuilder().build(new ClassFileReader().readAll(resources));
}
@Test
void oneStableRepresentativeIsReportedPerComponentWithBoundedEvidence() {
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B).addNode(C).addNode(D)
.addDependency(A, B, DependencyKind.METHOD_CALL, evidence(A_BRIDGE, 10))
.addDependency(B, A, DependencyKind.METHOD_CALL, evidence(B_WORK, 20))
.addDependency(A, C, DependencyKind.METHOD_CALL, evidence(A_BRIDGE, 30))
.addDependency(C, A, DependencyKind.METHOD_CALL, evidence(null, 40))
.build();
CycleRuleOptions options = CycleRuleOptions.defaults()
.withSyntheticEdges(SyntheticEdgePolicy.INCLUDE)
.withBounds(8, 100, 1);
ArchitectureRule rule = CycleRules.typesAreAcyclic(
model, graph, packages("app"), options);
var first = rule.check();
var second = rule.check();
assertEquals(first, second);
assertEquals(1, first.violations().size());
assertEquals("[type:app.A, type:app.B, type:app.A]",
first.violations().getFirst().attributes().get("representativeCycle"));
assertEquals("3", first.violations().getFirst().attributes().get("componentSize"));
assertEquals("true", first.violations().getFirst().attributes().get("evidenceTruncated"));
assertEquals(1, first.violations().getFirst().evidence().size());
assertTrue(first.diagnostics().stream()
.anyMatch(value -> value.code().equals("cycle.representative.truncated")));
}
@Test
void selectorExclusionsRemoveNodesAndEveryIncidentEdge() {
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B).addNode(C).addNode(D)
.addDependency(A, B, DependencyKind.METHOD_CALL, evidence(null, 10))
.addDependency(B, C, DependencyKind.METHOD_CALL, evidence(null, 20))
.addDependency(C, A, DependencyKind.METHOD_CALL, evidence(null, 30))
.build();
TypeSelector withoutC = packages("app").excluding(binary("app.C"));
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(model, graph, packages("app")).check().status());
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, graph, withoutC).check().status());
}
@Test
void typeUseAndSyntheticEdgesAreIndependentExplicitPolicies() {
DependencyGraph typeUses = DependencyGraph.builder()
.addNode(A).addNode(B)
.addDependency(A, B, DependencyKind.FIELD_TYPE, evidence(null, 10))
.addDependency(B, A, DependencyKind.FIELD_TYPE, evidence(null, 20))
.build();
CycleRuleOptions noTypeUses = CycleRuleOptions.defaults()
.withTypeUseDependencies(TypeUseDependencyPolicy.IGNORE);
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(model, typeUses, packages("app")).check().status());
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, typeUses, packages("app"), noTypeUses)
.check().status());
DependencyGraph synthetic = DependencyGraph.builder()
.addNode(A).addNode(B)
.addDependency(A, B, DependencyKind.METHOD_CALL, evidence(A_BRIDGE, 30))
.addDependency(B, A, DependencyKind.METHOD_CALL, evidence(B_WORK, 40))
.build();
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, synthetic, packages("app")).check().status());
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(
model,
synthetic,
packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(SyntheticEdgePolicy.INCLUDE))
.check().status());
}
@Test
void ordinaryMemberEvidenceIsRetainedUnderEverySyntheticPolicy() {
DependencyEvidence outward = evidence(A_WORK, 10);
DependencyEvidence inward = evidence(B_WORK, 20);
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B)
.addDependency(A, B, DependencyKind.METHOD_CALL, outward)
.addDependency(B, A, DependencyKind.METHOD_CALL, inward)
.build();
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(model, graph, packages("app")).check().status());
for (SyntheticEdgePolicy policy : SyntheticEdgePolicy.values()) {
var result = CycleRules.typesAreAcyclic(model, graph, packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(policy)).check();
assertEquals(RuleStatus.FAILED, result.status(), policy.name());
assertEquals(1, result.violations().size());
assertEquals(List.of(outward, inward), result.violations().getFirst().evidence());
}
}
@Test
void syntheticMemberEvidenceCannotCreateAnOrdinaryTypeCycle() {
for (MemberId owner : List.of(A_BRIDGE, A_SYNTHETIC)) {
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B)
.addDependency(A, B, DependencyKind.METHOD_CALL, evidence(owner, 10))
.addDependency(B, A, DependencyKind.METHOD_CALL, evidence(null, 20))
.build();
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, graph, packages("app")).check().status(),
owner.stableKey());
var included = CycleRules.typesAreAcyclic(model, graph, packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(SyntheticEdgePolicy.INCLUDE))
.check();
assertEquals(RuleStatus.FAILED, included.status());
assertEquals(1, included.violations().size());
}
}
@Test
void mixedEvidenceKeepsTheOrdinaryCycleAndDropsOnlySyntheticOwners() {
DependencyEvidence ordinary = evidence(A_WORK, 10);
DependencyEvidence synthetic = evidence(A_BRIDGE, 20);
DependencyEvidence reverse = evidence(B_WORK, 30);
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B)
.addDependency(A, B, DependencyKind.METHOD_CALL, ordinary)
.addDependency(A, B, DependencyKind.METHOD_CALL, synthetic)
.addDependency(B, A, DependencyKind.METHOD_CALL, reverse)
.build();
var ignored = CycleRules.typesAreAcyclic(model, graph, packages("app")).check();
assertEquals(RuleStatus.FAILED, ignored.status());
assertEquals(List.of(ordinary, reverse), ignored.violations().getFirst().evidence());
var included = CycleRules.typesAreAcyclic(model, graph, packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(SyntheticEdgePolicy.INCLUDE)).check();
assertEquals(RuleStatus.FAILED, included.status());
assertEquals(List.of(ordinary, synthetic, reverse).stream().sorted().toList(),
included.violations().getFirst().evidence());
}
@Test
void syntheticOriginsAreIgnoredEvenWithoutEvidenceOwners() {
for (var origin : List.of(GENERATED, A_BRIDGE)) {
DependencyGraph graph = DependencyGraph.builder()
.addNode(origin).addNode(B)
.addDependency(origin, B, DependencyKind.METHOD_CALL, evidence(null, 10))
.addDependency(B, origin, DependencyKind.METHOD_CALL, evidence(null, 20))
.build();
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, graph, packages("app")).check().status());
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(model, graph, packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(SyntheticEdgePolicy.INCLUDE))
.check().status());
}
}
@Test
void packageProjectionIgnoresIntraPackageEdgesAndRetainsUnderlyingEvidence() {
DependencyEvidence outward = evidence(A_WORK, 50);
DependencyEvidence inward = evidence(D_WORK, 60);
DependencyGraph graph = DependencyGraph.builder()
.addNode(A).addNode(B).addNode(D)
.addDependency(A, B, DependencyKind.METHOD_CALL, evidence(null, 40))
.addDependency(A, D, DependencyKind.METHOD_CALL, outward)
.addDependency(D, B, DependencyKind.METHOD_CALL, inward)
.build();
var result = CycleRules.packagesAreAcyclic(
model, graph, PackageSelector.all()).check();
assertEquals(RuleStatus.FAILED, result.status());
assertEquals("[package:app, package:other, package:app]",
result.violations().getFirst().attributes().get("representativeCycle"));
assertEquals(List.of(outward, inward), result.violations().getFirst().evidence());
}
@Test
void ordinaryMemberOnSyntheticTypeStillProducesSyntheticEvidence() {
DependencyGraph graph = DependencyGraph.builder()
.addNode(GENERATED).addNode(B)
.addDependency(
GENERATED, B, DependencyKind.METHOD_CALL, evidence(GENERATED_WORK, 70))
.addDependency(B, GENERATED, DependencyKind.METHOD_CALL, evidence(B_WORK, 80))
.build();
assertEquals(RuleStatus.PASSED,
CycleRules.typesAreAcyclic(model, graph, packages("app")).check().status());
assertEquals(RuleStatus.FAILED,
CycleRules.typesAreAcyclic(
model,
graph,
packages("app"),
CycleRuleOptions.defaults().withSyntheticEdges(SyntheticEdgePolicy.INCLUDE))
.check().status());
}
private static byte[] type(String binaryName, boolean syntheticBridge) {
return ClassFile.of().build(ClassDesc.of(binaryName), builder -> {
builder.withMethodBody(
"work", MethodTypeDesc.of(ClassDesc.ofDescriptor("V")),
ClassFile.ACC_PUBLIC, code -> code.return_());
if (syntheticBridge) {
builder.withMethodBody(
"bridge", MethodTypeDesc.of(ClassDesc.ofDescriptor("V")),
ClassFile.ACC_PUBLIC | ClassFile.ACC_SYNTHETIC | ClassFile.ACC_BRIDGE,
code -> code.return_());
builder.withMethodBody(
"generated", MethodTypeDesc.of(ClassDesc.ofDescriptor("V")),
ClassFile.ACC_PRIVATE | ClassFile.ACC_SYNTHETIC,
code -> code.return_());
}
});
}
private static byte[] syntheticType(String binaryName) {
return ClassFile.of().build(ClassDesc.of(binaryName), builder -> builder
.withFlags(ClassFile.ACC_SYNTHETIC)
.withMethodBody(
"work", MethodTypeDesc.of(ClassDesc.ofDescriptor("V")),
ClassFile.ACC_PUBLIC, code -> code.return_()));
}
private static TypeSelector binary(String value) {
return TypeSelector.binaryName(exact(value));
}
private static TypeSelector packages(String value) {
return TypeSelector.packageName(exact(value));
}
private static JavaPattern exact(String value) {
return JavaPattern.exact(PatternDomain.QUALIFIED_NAME, value);
}
private static DependencyEvidence evidence(MemberId owner, int line) {
return new DependencyEvidence(
LocationId.ofResourcePath("classes/Fixture.class"),
java.util.Optional.ofNullable(owner),
java.util.OptionalInt.empty(),
java.util.Optional.of("Fixture.java"),
java.util.OptionalInt.of(line));
}
private void write(String resourceName, byte[] bytes) throws IOException {
Path target = temporaryDirectory.resolve(resourceName);
Files.createDirectories(target.getParent());
Files.write(target, bytes);
}
}