-
Notifications
You must be signed in to change notification settings - Fork 391
/
GradleDokkaSourceSetBuilderTest.kt
494 lines (412 loc) · 19.3 KB
/
GradleDokkaSourceSetBuilderTest.kt
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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package org.jetbrains.dokka.gradle
import com.android.build.gradle.internal.api.DefaultAndroidSourceSet
import org.gradle.api.Project
import org.gradle.kotlin.dsl.closureOf
import org.gradle.testfixtures.ProjectBuilder
import org.jetbrains.dokka.*
import org.jetbrains.kotlin.gradle.plugin.sources.DefaultKotlinSourceSet
import java.net.URI
import kotlin.test.*
class GradleDokkaSourceSetBuilderTest {
private val project = ProjectBuilder.builder().withName("root").build()
@Test
fun sourceSetId() {
val sourceSet = GradleDokkaSourceSetBuilder("myName", project, "scopeId")
assertEquals(
DokkaSourceSetID("scopeId", "myName"), sourceSet.sourceSetID,
"Expected sourceSet.sourceSetID to match output of DokkaSourceSetID factory function"
)
assertEquals(
"scopeId/myName", sourceSet.sourceSetID.toString(),
"Expected SourceSetId's string representation"
)
}
@Test
fun classpath() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
sourceSet.classpath.from(project.file("path/to/file.jar"))
sourceSet.classpath.from(project.file("path/to/other.jar"))
assertEquals(
listOf(project.file("path/to/file.jar"), project.file("path/to/other.jar")), sourceSet.classpath.toList(),
"Expected both file paths being present in classpath"
)
assertEquals(
listOf(project.file("path/to/file.jar"), project.file("path/to/other.jar")),
sourceSet.build().classpath.toList(),
"Expected both file paths being present in built classpath"
)
}
@Test
fun displayName() {
val sourceSet = GradleDokkaSourceSetBuilder("myName", project)
assertNull(
sourceSet.displayName.orNull,
"Expected no ${GradleDokkaSourceSetBuilder::displayName.name} being set by default"
)
assertEquals(
"myName", sourceSet.build().displayName,
"Expected source set name being used for ${DokkaConfiguration.DokkaSourceSet::displayName.name} " +
"after building source set with no ${GradleDokkaSourceSetBuilder::displayName.name} being set"
)
sourceSet.displayName.set("displayName")
assertEquals(
"displayName", sourceSet.build().displayName,
"Expected previously set ${GradleDokkaSourceSetBuilder::displayName.name} to be present after build"
)
}
@Test
fun `displayName default for sourceSet ending with Main`() {
val sourceSet = GradleDokkaSourceSetBuilder("jvmMain", project)
assertEquals(
"jvm", sourceSet.build().displayName,
"Expected 'Main' being stripped for source set display name after build"
)
}
@Test
fun sourceRoots() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
sourceSet.sourceRoots.from(project.file("root1"))
sourceSet.sourceRoot(project.file("root2"))
sourceSet.sourceRoot(project.file("root3").absolutePath)
sourceSet.sourceRoot("root4")
assertEquals(
listOf("root1", "root2", "root3", "root4").map(project::file).toSet(),
sourceSet.build().sourceRoots,
"Expected all files being present"
)
sourceSet.build().sourceRoots.forEach { root ->
assertTrue(
root.startsWith(project.projectDir),
"Expected all roots to be inside the projectDir\n" +
"projectDir: ${project.projectDir}\n" +
"root: ${root.absolutePath})"
)
}
}
@Test
fun dependentSourceSets() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(emptySet(), sourceSet.build().dependentSourceSets, "Expected no dependent sourceSets by default")
sourceSet.dependentSourceSets.add(sourceSet.DokkaSourceSetID("s1"))
sourceSet.dependsOn("s2")
sourceSet.dependsOn(sourceSet.DokkaSourceSetID("s3"))
sourceSet.dependsOn(GradleDokkaSourceSetBuilder("s4", project))
sourceSet.dependsOn(GradleDokkaSourceSetBuilder("s5", project).build())
sourceSet.dependsOn(createDefaultKotlinSourceSet("s6"))
sourceSet.dependsOn(DefaultAndroidSourceSet("s7", project, false))
assertEquals(
listOf(":/s1", ":/s2", ":/s3", ":/s4", ":/s5", ":/s6", ":/s7"),
sourceSet.build().dependentSourceSets.map { it.toString() },
"Expected all source sets being registered"
)
}
private fun createDefaultKotlinSourceSet(displayName: String): DefaultKotlinSourceSet {
return project.objects.newInstance(DefaultKotlinSourceSet::class.java, project, displayName)
}
@Test
fun samples() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(emptySet(), sourceSet.build().samples, "Expected no default samples")
sourceSet.samples.from(project.file("s1"))
sourceSet.samples.from(project.file("s2"))
assertEquals(
setOf(project.file("s1"), project.file("s2")), sourceSet.build().samples,
"Expected all samples being present after build"
)
}
@Test
fun includes() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(emptySet(), sourceSet.build().includes, "Expected no default includees")
sourceSet.includes.from(project.file("i1"))
sourceSet.includes.from(project.file("i2"))
assertEquals(
setOf(project.file("i1"), project.file("i2")), sourceSet.build().includes,
"Expected all includes being present after build"
)
}
@Test
@Suppress("DEPRECATION")
fun includeNonPublic() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(
DokkaDefaults.includeNonPublic, sourceSet.build().includeNonPublic,
"Expected default value for ${GradleDokkaSourceSetBuilder::includeNonPublic.name}"
)
sourceSet.includeNonPublic.set(!DokkaDefaults.includeNonPublic)
assertEquals(
!DokkaDefaults.includeNonPublic, sourceSet.build().includeNonPublic,
"Expected flipped value for ${GradleDokkaSourceSetBuilder::includeNonPublic.name}"
)
}
@Test
fun documentedVisibilities() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(
DokkaDefaults.documentedVisibilities, sourceSet.build().documentedVisibilities,
"Expected default value for ${GradleDokkaSourceSetBuilder::documentedVisibilities.name}"
)
val visibilities = setOf(DokkaConfiguration.Visibility.PRIVATE, DokkaConfiguration.Visibility.INTERNAL)
sourceSet.documentedVisibilities.set(visibilities)
assertEquals(
visibilities, sourceSet.build().documentedVisibilities,
"Expected to see previously set value for ${GradleDokkaSourceSetBuilder::includeNonPublic.name}"
)
}
@Test
fun reportUndocumented() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(
DokkaDefaults.reportUndocumented, sourceSet.build().reportUndocumented,
"Expected default value for ${GradleDokkaSourceSetBuilder::reportUndocumented.name}"
)
sourceSet.reportUndocumented.set(!DokkaDefaults.reportUndocumented)
assertEquals(
!DokkaDefaults.reportUndocumented, sourceSet.build().reportUndocumented,
"Expected flipped value for ${GradleDokkaSourceSetBuilder::reportUndocumented.name}"
)
}
@Test
fun jdkVersion() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(
DokkaDefaults.jdkVersion, sourceSet.build().jdkVersion,
"Expected default value for ${GradleDokkaSourceSetBuilder::jdkVersion.name}"
)
sourceSet.jdkVersion.set(DokkaDefaults.jdkVersion + 1)
assertEquals(
DokkaDefaults.jdkVersion + 1, sourceSet.build().jdkVersion,
"Expected increased value for ${GradleDokkaSourceSetBuilder::jdkVersion.name}"
)
}
@Test
fun sourceLinks() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(emptySet(), sourceSet.build().sourceLinks, "Expected no default source links")
sourceSet.sourceLinks.add(
GradleSourceLinkBuilder(project).apply {
this.remoteLineSuffix.set("ls1")
this.localDirectory.set(project.file("p1"))
this.remoteUrl.set(URI("https://u1").toURL())
})
sourceSet.sourceLink {
remoteLineSuffix.set("ls2")
localDirectory.set(project.file("p2"))
remoteUrl.set(URI("https://u2").toURL())
}
sourceSet.sourceLink(project.closureOf<GradleSourceLinkBuilder> {
this.remoteLineSuffix.set("ls3")
this.localDirectory.set(project.file("p3"))
this.remoteUrl.set(URI("https://u3").toURL())
})
assertEquals(
setOf(
SourceLinkDefinitionImpl(
remoteLineSuffix = "ls1",
localDirectory = project.file("p1").absolutePath,
remoteUrl = URI("https://u1").toURL()
),
SourceLinkDefinitionImpl(
remoteLineSuffix = "ls2",
localDirectory = project.file("p2").absolutePath,
remoteUrl = URI("https://u2").toURL()
),
SourceLinkDefinitionImpl(
remoteLineSuffix = "ls3",
localDirectory = project.file("p3").absolutePath,
remoteUrl = URI("https://u3").toURL()
)
),
sourceSet.build().sourceLinks,
"Expected all source links being present after build"
)
}
@Test
fun perPackageOptions() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(emptyList(), sourceSet.build().perPackageOptions, "Expected no default per package options")
sourceSet.perPackageOptions.add(GradlePackageOptionsBuilder(project).apply {
this.matchingRegex.set("p1.*")
})
sourceSet.perPackageOption {
matchingRegex.set("p2.*")
}
sourceSet.perPackageOption(project.closureOf<GradlePackageOptionsBuilder> {
this.matchingRegex.set("p3.*")
})
assertEquals(
listOf("p1.*", "p2.*", "p3.*").map { matchingRegex ->
PackageOptionsImpl(
matchingRegex = matchingRegex,
includeNonPublic = DokkaDefaults.includeNonPublic,
documentedVisibilities = DokkaDefaults.documentedVisibilities,
reportUndocumented = DokkaDefaults.reportUndocumented,
skipDeprecated = DokkaDefaults.skipDeprecated,
suppress = DokkaDefaults.suppress
)
},
sourceSet.build().perPackageOptions,
"Expected all package options being present after build"
)
}
@Test
fun externalDocumentationLink() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
sourceSet.noAndroidSdkLink.set(true)
sourceSet.noJdkLink.set(true)
sourceSet.noStdlibLink.set(true)
assertEquals(
emptySet(), sourceSet.build().externalDocumentationLinks,
"Expected no default external documentation links"
)
sourceSet.externalDocumentationLinks.add(
GradleExternalDocumentationLinkBuilder(project).apply {
this.url.set(URI("https://u1").toURL())
this.packageListUrl.set(URI("https://pl1").toURL())
}
)
sourceSet.externalDocumentationLink {
url.set(URI("https://u2").toURL())
}
sourceSet.externalDocumentationLink(project.closureOf<GradleExternalDocumentationLinkBuilder> {
url.set(URI("https://u3").toURL())
})
sourceSet.externalDocumentationLink(url = "https://u4", packageListUrl = "https://pl4")
sourceSet.externalDocumentationLink(url = URI("https://u5").toURL())
assertEquals(
setOf(
ExternalDocumentationLinkImpl(URI("https://u1").toURL(), URI("https://pl1").toURL()),
ExternalDocumentationLinkImpl(URI("https://u2").toURL(), URI("https://u2/package-list").toURL()),
ExternalDocumentationLinkImpl(URI("https://u3").toURL(), URI("https://u3/package-list").toURL()),
ExternalDocumentationLinkImpl(URI("https://u4").toURL(), URI("https://pl4").toURL()),
ExternalDocumentationLinkImpl(URI("https://u5").toURL(), URI("https://u5/package-list").toURL())
),
sourceSet.build().externalDocumentationLinks,
"Expected all external documentation links being present after build"
)
}
@Test
fun languageVersion() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertNull(sourceSet.build().languageVersion, "Expected no language version being set by default")
sourceSet.languageVersion.set("JAVA_20")
assertEquals(
"JAVA_20", sourceSet.build().languageVersion,
"Expected previously set language version to be present after build"
)
}
@Test
fun apiVersion() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertNull(sourceSet.build().apiVersion, "Expected no api version being set by default")
sourceSet.apiVersion.set("20")
assertEquals(
"20", sourceSet.build().apiVersion,
"Expected previously set api version to be present after build"
)
}
@Test
fun noStdlibLink() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertFalse(sourceSet.noStdlibLink.get(), "Expected 'noStdlibLink' to be set to false by default")
assertEquals(1, sourceSet.build().externalDocumentationLinks.count {
"https://kotlinlang.org/api" in it.url.toURI().toString()
}, "Expected kotlin stdlib in external documentation links")
sourceSet.noStdlibLink.set(true)
assertEquals(
0, sourceSet.build().externalDocumentationLinks.count {
"https://kotlinlang.org/api" in it.url.toURI().toString()
}, "Expected no stdlib in external documentation link"
)
}
@Test
fun noJdkLink() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertFalse(sourceSet.noJdkLink.get(), "Expected 'noJdkLink' to be set to false by default")
assertEquals(1, sourceSet.build().externalDocumentationLinks.count {
"https://docs.oracle.com/" in it.url.toURI().toString()
}, "Expected java jdk in external documentation links")
sourceSet.noJdkLink.set(true)
assertEquals(
0, sourceSet.build().externalDocumentationLinks.count {
"https://docs.oracle.com/" in it.url.toURI().toString()
}, "Expected no java jdk in external documentation link"
)
}
@Test
fun noAndroidSdkLink() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertFalse(sourceSet.noAndroidSdkLink.get(), "Expected 'noAndroidSdkLink' to be set to false by default")
assertEquals(0, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference" in it.url.toURI().toString()
}, "Expected no android sdk in external documentation links (without android plugin)")
assertEquals(0, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference/androidx" in it.packageListUrl.toURI().toString()
}, "Expected no androidx in external documentation links (without android plugin)")
project.plugins.apply("com.android.library")
assertEquals(1, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference/kotlin/package-list" in it.packageListUrl.toURI().toString()
}, "Expected android sdk in external documentation links")
assertEquals(1, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference/kotlin/androidx/package-list" in it.packageListUrl.toURI()
.toString()
}, "Expected androidx in external documentation links")
sourceSet.noAndroidSdkLink.set(true)
assertEquals(0, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference" in it.url.toURI().toString()
}, "Expected no android sdk in external documentation links")
assertEquals(0, sourceSet.build().externalDocumentationLinks.count {
"https://developer.android.com/reference/kotlin/androidx/package-list" in it.packageListUrl.toURI()
.toString()
}, "Expected no androidx in external documentation links")
}
@Test
fun suppressedFiles() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertTrue(sourceSet.build().suppressedFiles.isEmpty(), "Expected no suppressed files by default")
sourceSet.suppressedFiles.from(project.file("f1"))
sourceSet.suppressedFiles.from("f2")
assertEquals(
setOf(project.file("f1"), project.file("f2")), sourceSet.build().suppressedFiles,
"Expected all suppressed files to be present after build"
)
}
@Test
fun suppressedFilesByDefault() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertTrue(sourceSet.build().suppressedFiles.isEmpty(), "Expected no suppressed files by default")
val file = project.buildDir.resolve("generated").also { it.mkdirs() }
file.resolve("suppressed.kt").writeText("class A")
sourceSet.sourceRoots.from(project.buildDir.resolve("generated"))
val suppressedConfiguration = sourceSet.build()
sourceSet.suppressGeneratedFiles.set(false)
val unsuppressedConfiguration = sourceSet.build()
assertEquals(
setOf(
project.buildDir.resolve("generated"),
project.buildDir.resolve("generated").resolve("suppressed.kt")
), suppressedConfiguration.suppressedFiles,
"Expected all suppressed files to be present after build"
)
assertTrue(
unsuppressedConfiguration.suppressedFiles.isEmpty(),
"Expected no files to be suppressed by default"
)
}
@Test
fun platform() {
val sourceSet = GradleDokkaSourceSetBuilder("", project)
assertEquals(Platform.DEFAULT, sourceSet.build().analysisPlatform, "Expected default platform if not specified")
sourceSet.platform.set(Platform.common)
assertEquals(
Platform.common, sourceSet.build().analysisPlatform,
"Expected previously set analysis platform being present after build"
)
}
}
@Suppress("TestFunctionName")
private fun GradleDokkaSourceSetBuilder(name: String, project: Project) =
GradleDokkaSourceSetBuilder(name, project, project.path)