Skip to content

Commit 3eebcab

Browse files
mezpahlanmezpahlan
committed
Update explanatory diagram and project vs directory identifiers
We use p for Gradle projects and d for File directories on disk. We could have used any identifier but choosing the same letter is a bit of a mind bender for newbies that are not familiar. We also change the diagram to better match how the code sets up the projects.
1 parent b31f730 commit 3eebcab

File tree

1 file changed

+51
-48
lines changed

1 file changed

+51
-48
lines changed

‎affectedmoduledetector/src/test/kotlin/com/dropbox/affectedmoduledetector/AffectedModuleDetectorImplTest.kt‎

Lines changed: 51 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -62,22 +62,25 @@ class AffectedModuleDetectorImplTest {
6262
}
6363

6464
/*
65+
d: File directories
66+
p: Gradle projects
6567
6668
Dummy project file tree:
67-
"library modules" "UI modules"
68-
root ----------------- root2
69-
/ | \ | | | | / | \
70-
p1 p7 p2 p8 p9 p10 p11 p12 p13 p14
69+
"library modules" "UI modules"
70+
tmpDir -------------- tmpDir2
71+
/ | \ | | | / \
72+
d1 d7 d2 d8 d9 d10 d12 d13 (d10)
7173
/ \
72-
p3 p5
74+
d3 d5
7375
/ \
74-
p4 p6
76+
d4 d6
7577
7678
Dependency forest:
77-
78-
p1 p2 p7 p8 p9 p10 p11 p12 p14
79-
/ \ / \ \
80-
p3 p5 p6 p13
79+
root ------------------- root2
80+
/ \ | | | | / \
81+
p1 p2 p7 p8 p9 p10 p12 p13
82+
/ / \
83+
p3 --- p5 p6
8184
/
8285
p4
8386
@@ -99,61 +102,61 @@ class AffectedModuleDetectorImplTest {
99102

100103
// Library modules
101104
p1 = ProjectBuilder.builder()
102-
.withProjectDir(tmpDir.resolve("p1"))
105+
.withProjectDir(tmpDir.resolve("d1"))
103106
.withName("p1")
104107
.withParent(root)
105108
.build()
106109
p2 = ProjectBuilder.builder()
107-
.withProjectDir(tmpDir.resolve("p2"))
110+
.withProjectDir(tmpDir.resolve("d2"))
108111
.withName("p2")
109112
.withParent(root)
110113
.build()
111114
p3 = ProjectBuilder.builder()
112-
.withProjectDir(tmpDir.resolve("p1/p3"))
115+
.withProjectDir(tmpDir.resolve("d1/d3"))
113116
.withName("p3")
114117
.withParent(p1)
115118
.build()
116119
val p3config = p3.configurations.create("p3config")
117120
p3config.dependencies.add(p3.dependencies.project(mutableMapOf("path" to ":p1")))
118121
p4 = ProjectBuilder.builder()
119-
.withProjectDir(tmpDir.resolve("p1/p3/p4"))
122+
.withProjectDir(tmpDir.resolve("d1/d3/d4"))
120123
.withName("p4")
121124
.withParent(p3)
122125
.build()
123126
val p4config = p4.configurations.create("p4config")
124127
p4config.dependencies.add(p4.dependencies.project(mutableMapOf("path" to ":p1:p3")))
125128
p5 = ProjectBuilder.builder()
126-
.withProjectDir(tmpDir.resolve("p2/p5"))
129+
.withProjectDir(tmpDir.resolve("d2/d5"))
127130
.withName("p5")
128131
.withParent(p2)
129132
.build()
130133
val p5config = p5.configurations.create("p5config")
131134
p5config.dependencies.add(p5.dependencies.project(mutableMapOf("path" to ":p2")))
132135
p5config.dependencies.add(p5.dependencies.project(mutableMapOf("path" to ":p1:p3")))
133136
p6 = ProjectBuilder.builder()
134-
.withProjectDir(tmpDir.resolve("p1/p3/p6"))
137+
.withProjectDir(tmpDir.resolve("d1/d3/d6"))
135138
.withName("p6")
136139
.withParent(p3)
137140
.build()
138141
val p6config = p6.configurations.create("p6config")
139142
p6config.dependencies.add(p6.dependencies.project(mutableMapOf("path" to ":p2")))
140143
p7 = ProjectBuilder.builder()
141-
.withProjectDir(tmpDir.resolve("p7"))
144+
.withProjectDir(tmpDir.resolve("d7"))
142145
.withName("p7")
143146
.withParent(root)
144147
.build()
145148
p8 = ProjectBuilder.builder()
146-
.withProjectDir(tmpDir.resolve("p8"))
149+
.withProjectDir(tmpDir.resolve("d8"))
147150
.withName("cobuilt1")
148151
.withParent(root)
149152
.build()
150153
p9 = ProjectBuilder.builder()
151-
.withProjectDir(tmpDir.resolve("p9"))
154+
.withProjectDir(tmpDir.resolve("d9"))
152155
.withName("cobuilt2")
153156
.withParent(root)
154157
.build()
155158
p10 = ProjectBuilder.builder()
156-
.withProjectDir(tmpDir.resolve("p10"))
159+
.withProjectDir(tmpDir.resolve("d10"))
157160
.withName("benchmark")
158161
.withParent(root)
159162
.build()
@@ -166,7 +169,7 @@ class AffectedModuleDetectorImplTest {
166169
.build()
167170
// The existence of this project is a test for the benchmark use case. It is picked up by
168171
p13 = ProjectBuilder.builder() // allProjects in ui, even though it is in the root1 dir
169-
.withProjectDir(tmpDir.resolve("p10")) // and is symlinked as p10
172+
.withProjectDir(tmpDir.resolve("d10")) // and is symlinked as p10
170173
.withName("benchmark")
171174
.withParent(root2)
172175
.build()
@@ -248,7 +251,7 @@ class AffectedModuleDetectorImplTest {
248251
ignoreUnknownProjects = false,
249252
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
250253
injectedGitClient = MockGitClient(
251-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
254+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
252255
tmpFolder = tmpFolder.root
253256
),
254257
config = affectedModuleConfiguration
@@ -269,7 +272,7 @@ class AffectedModuleDetectorImplTest {
269272
ignoreUnknownProjects = false,
270273
projectSubset = ProjectSubset.DEPENDENT_PROJECTS,
271274
injectedGitClient = MockGitClient(
272-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
275+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
273276
tmpFolder = tmpFolder.root
274277
),
275278
config = affectedModuleConfiguration
@@ -290,7 +293,7 @@ class AffectedModuleDetectorImplTest {
290293
ignoreUnknownProjects = false,
291294
projectSubset = ProjectSubset.CHANGED_PROJECTS,
292295
injectedGitClient = MockGitClient(
293-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
296+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
294297
tmpFolder = tmpFolder.root
295298
),
296299
config = affectedModuleConfiguration
@@ -312,8 +315,8 @@ class AffectedModuleDetectorImplTest {
312315
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
313316
injectedGitClient = MockGitClient(
314317
changedFiles = listOf(
315-
convertToFilePath("p1", "foo.java"),
316-
convertToFilePath("p2", "bar.java")
318+
convertToFilePath("d1", "foo.java"),
319+
convertToFilePath("d2", "bar.java")
317320
),
318321
tmpFolder = tmpFolder.root
319322
),
@@ -336,8 +339,8 @@ class AffectedModuleDetectorImplTest {
336339
projectSubset = ProjectSubset.DEPENDENT_PROJECTS,
337340
injectedGitClient = MockGitClient(
338341
changedFiles = listOf(
339-
convertToFilePath("p1", "foo.java"),
340-
convertToFilePath("p2", "bar.java")
342+
convertToFilePath("d1", "foo.java"),
343+
convertToFilePath("d2", "bar.java")
341344
),
342345
tmpFolder = tmpFolder.root
343346
),
@@ -360,8 +363,8 @@ class AffectedModuleDetectorImplTest {
360363
projectSubset = ProjectSubset.CHANGED_PROJECTS,
361364
injectedGitClient = MockGitClient(
362365
changedFiles = listOf(
363-
convertToFilePath("p1", "foo.java"),
364-
convertToFilePath("p2", "bar.java")
366+
convertToFilePath("d1", "foo.java"),
367+
convertToFilePath("d2", "bar.java")
365368
),
366369
tmpFolder = tmpFolder.root
367370
),
@@ -425,7 +428,7 @@ class AffectedModuleDetectorImplTest {
425428
ignoreUnknownProjects = false,
426429
projectSubset = ProjectSubset.CHANGED_PROJECTS,
427430
injectedGitClient = MockGitClient(
428-
changedFiles = listOf("foo.java", convertToFilePath("p7", "bar.java")),
431+
changedFiles = listOf("foo.java", convertToFilePath("d7", "bar.java")),
429432
tmpFolder = tmpFolder.root
430433
),
431434
config = affectedModuleConfiguration
@@ -598,7 +601,7 @@ class AffectedModuleDetectorImplTest {
598601
injectedGitClient = MockGitClient(
599602
changedFiles = listOf(
600603
convertToFilePath(
601-
"p8", "foo.java"
604+
"d8", "foo.java"
602605
)
603606
),
604607
tmpFolder = tmpFolder.root
@@ -623,7 +626,7 @@ class AffectedModuleDetectorImplTest {
623626
injectedGitClient = MockGitClient(
624627
changedFiles = listOf(
625628
convertToFilePath(
626-
"p8", "foo.java"
629+
"d8", "foo.java"
627630
)
628631
),
629632
tmpFolder = tmpFolder.root
@@ -648,7 +651,7 @@ class AffectedModuleDetectorImplTest {
648651
injectedGitClient = MockGitClient(
649652
changedFiles = listOf(
650653
convertToFilePath(
651-
"p8", "foo.java"
654+
"d8", "foo.java"
652655
)
653656
),
654657
tmpFolder = tmpFolder.root
@@ -673,7 +676,7 @@ class AffectedModuleDetectorImplTest {
673676
injectedGitClient = MockGitClient(
674677
changedFiles = listOf(
675678
convertToFilePath(
676-
"p8", "foo.java"
679+
"d8", "foo.java"
677680
)
678681
),
679682
tmpFolder = tmpFolder.root
@@ -697,7 +700,7 @@ class AffectedModuleDetectorImplTest {
697700
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
698701
injectedGitClient = MockGitClient(
699702
changedFiles = listOf(
700-
convertToFilePath("p7", "foo.java"),
703+
convertToFilePath("d7", "foo.java"),
701704
convertToFilePath("compose", "foo.java")
702705
),
703706
tmpFolder = tmpFolder.root
@@ -721,7 +724,7 @@ class AffectedModuleDetectorImplTest {
721724
projectSubset = ProjectSubset.CHANGED_PROJECTS,
722725
injectedGitClient = MockGitClient(
723726
changedFiles = listOf(
724-
convertToFilePath("p7", "foo.java"),
727+
convertToFilePath("d7", "foo.java"),
725728
convertToFilePath("compose", "foo.java")
726729
),
727730
tmpFolder = tmpFolder.root
@@ -745,7 +748,7 @@ class AffectedModuleDetectorImplTest {
745748
projectSubset = ProjectSubset.DEPENDENT_PROJECTS,
746749
injectedGitClient = MockGitClient(
747750
changedFiles = listOf(
748-
convertToFilePath("p7", "foo.java"),
751+
convertToFilePath("d7", "foo.java"),
749752
convertToFilePath("compose", "foo.java")
750753
),
751754
tmpFolder = tmpFolder.root
@@ -769,7 +772,7 @@ class AffectedModuleDetectorImplTest {
769772
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
770773
injectedGitClient = MockGitClient(
771774
changedFiles = listOf(
772-
convertToFilePath("p7", "foo.java"),
775+
convertToFilePath("d7", "foo.java"),
773776
convertToFilePath("compose", "foo.java")
774777
),
775778
tmpFolder = tmpFolder.root
@@ -793,7 +796,7 @@ class AffectedModuleDetectorImplTest {
793796
projectSubset = ProjectSubset.CHANGED_PROJECTS,
794797
injectedGitClient = MockGitClient(
795798
changedFiles = listOf(
796-
convertToFilePath("p7", "foo.java"),
799+
convertToFilePath("d7", "foo.java"),
797800
convertToFilePath("compose", "foo.java")
798801
),
799802
tmpFolder = tmpFolder.root
@@ -817,7 +820,7 @@ class AffectedModuleDetectorImplTest {
817820
projectSubset = ProjectSubset.DEPENDENT_PROJECTS,
818821
injectedGitClient = MockGitClient(
819822
changedFiles = listOf(
820-
convertToFilePath("p7", "foo.java"),
823+
convertToFilePath("d7", "foo.java"),
821824
convertToFilePath("compose", "foo.java")
822825
),
823826
tmpFolder = tmpFolder.root
@@ -1023,7 +1026,7 @@ class AffectedModuleDetectorImplTest {
10231026
ignoreUnknownProjects = false,
10241027
projectSubset = ProjectSubset.CHANGED_PROJECTS,
10251028
injectedGitClient = MockGitClient(
1026-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1029+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
10271030
tmpFolder = tmpFolder.root
10281031
),
10291032
config = affectedModuleConfiguration
@@ -1066,7 +1069,7 @@ class AffectedModuleDetectorImplTest {
10661069
ignoreUnknownProjects = false,
10671070
projectSubset = ProjectSubset.DEPENDENT_PROJECTS,
10681071
injectedGitClient = MockGitClient(
1069-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1072+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
10701073
tmpFolder = tmpFolder.root
10711074
),
10721075
config = affectedModuleConfiguration
@@ -1109,7 +1112,7 @@ class AffectedModuleDetectorImplTest {
11091112
ignoreUnknownProjects = false,
11101113
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
11111114
injectedGitClient = MockGitClient(
1112-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1115+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
11131116
tmpFolder = tmpFolder.root
11141117
),
11151118
config = affectedModuleConfiguration
@@ -1188,7 +1191,7 @@ class AffectedModuleDetectorImplTest {
11881191
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
11891192
modules = setOf(":p1"),
11901193
injectedGitClient = MockGitClient(
1191-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1194+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
11921195
tmpFolder = tmpFolder.root
11931196
),
11941197
config = affectedModuleConfiguration
@@ -1207,7 +1210,7 @@ class AffectedModuleDetectorImplTest {
12071210
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
12081211
modules = emptySet(),
12091212
injectedGitClient = MockGitClient(
1210-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1213+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
12111214
tmpFolder = tmpFolder.root
12121215
),
12131216
config = affectedModuleConfiguration
@@ -1227,7 +1230,7 @@ class AffectedModuleDetectorImplTest {
12271230
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
12281231
modules = null,
12291232
injectedGitClient = MockGitClient(
1230-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1233+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
12311234
tmpFolder = tmpFolder.root
12321235
),
12331236
config = affectedModuleConfiguration
@@ -1250,7 +1253,7 @@ class AffectedModuleDetectorImplTest {
12501253
projectSubset = ProjectSubset.ALL_AFFECTED_PROJECTS,
12511254
modules = null,
12521255
injectedGitClient = MockGitClient(
1253-
changedFiles = listOf(convertToFilePath("p1", "foo.java")),
1256+
changedFiles = listOf(convertToFilePath("d1", "foo.java")),
12541257
tmpFolder = tmpFolder.root
12551258
),
12561259
config = affectedModuleConfiguration

0 commit comments

Comments
 (0)