forked from Kotlin/dokka
/
DokkaMultiModuleTaskTest.kt
213 lines (176 loc) · 7.93 KB
/
DokkaMultiModuleTaskTest.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
@file:Suppress("UnstableApiUsage")
package org.jetbrains.dokka.gradle
import org.gradle.kotlin.dsl.*
import org.gradle.testfixtures.ProjectBuilder
import org.jetbrains.dokka.*
import java.io.File
import kotlin.test.*
class DokkaMultiModuleTaskTest {
private val rootProject = ProjectBuilder.builder()
.withName("root")
.build()
private val childProject = ProjectBuilder.builder()
.withName("child")
.withProjectDir(rootProject.projectDir.resolve("child"))
.withParent(rootProject).build()
private val childDokkaTask = childProject.tasks.create<DokkaTaskPartial>("childDokkaTask")
private val multiModuleTask = rootProject.tasks.create<DokkaMultiModuleTask>("multiModuleTask").apply {
addChildTask(childDokkaTask)
}
init {
rootProject.allprojects { project ->
project.tasks.withType<AbstractDokkaTask>().configureEach { task ->
task.plugins.withDependencies { dependencies -> dependencies.clear() }
}
}
}
@Test
fun `child project is withing root project`() {
assertEquals(
rootProject.projectDir, childProject.projectDir.parentFile,
"Expected child project being inside the root project"
)
assertEquals(
childProject.projectDir.name, "child",
"Expected folder of child project to be called 'child'"
)
}
@Test
fun buildDokkaConfiguration() {
val include1 = childDokkaTask.project.file("include1.md")
val include2 = childDokkaTask.project.file("include2.md")
val topLevelInclude = multiModuleTask.project.file("README.md")
childDokkaTask.apply {
dokkaSourceSets.create("main")
dokkaSourceSets.create("test")
dokkaSourceSets.configureEach {
it.includes.from(include1, include2)
}
}
multiModuleTask.apply {
moduleVersion by "1.5.0"
moduleName by "custom Module Name"
outputDirectory by project.buildDir.resolve("customOutputDirectory")
cacheRoot by File("customCacheRoot")
pluginsConfiguration.add(PluginConfigurationImpl("pluginA", DokkaConfiguration.SerializationFormat.JSON, """ { "key" : "value2" } """))
failOnWarning by true
offlineMode by true
includes.from(listOf(topLevelInclude))
}
val dokkaConfiguration = multiModuleTask.buildDokkaConfiguration()
assertEquals(
DokkaConfigurationImpl(
moduleName = "custom Module Name",
moduleVersion = "1.5.0",
outputDir = multiModuleTask.project.buildDir.resolve("customOutputDirectory"),
cacheRoot = File("customCacheRoot"),
pluginsConfiguration = mutableListOf(PluginConfigurationImpl("pluginA", DokkaConfiguration.SerializationFormat.JSON, """ { "key" : "value2" } """)),
pluginsClasspath = emptyList(),
failOnWarning = true,
offlineMode = true,
includes = setOf(topLevelInclude),
modules = listOf(
DokkaModuleDescriptionImpl(
name = "child",
relativePathToOutputDirectory = File("child"),
includes = setOf(include1, include2),
sourceOutputDirectory = childDokkaTask.outputDirectory.getSafe()
)
)
),
dokkaConfiguration
)
}
@Test
fun `multimodule task should not include unspecified version`(){
childDokkaTask.apply {
dokkaSourceSets.create("main")
dokkaSourceSets.create("test")
}
multiModuleTask.apply {
moduleVersion by "unspecified"
}
val dokkaConfiguration = multiModuleTask.buildDokkaConfiguration()
assertNull(dokkaConfiguration.moduleVersion)
}
@Test
fun `setting dokkaTaskNames declares proper task dependencies`() {
val dependenciesInitial = multiModuleTask.taskDependencies.getDependencies(multiModuleTask).toSet()
assertEquals(1, dependenciesInitial.size, "Expected one dependency")
val dependency = dependenciesInitial.single()
assertTrue(dependency is DokkaTaskPartial, "Expected dependency to be of Type ${DokkaTaskPartial::class.simpleName}")
assertEquals(childProject, dependency.project, "Expected dependency from child project")
val customDokkaTask = childProject.tasks.create<DokkaTask>("customDokkaTask")
multiModuleTask.addSubprojectChildTasks("customDokkaTask")
val dependenciesAfter = multiModuleTask.taskDependencies.getDependencies(multiModuleTask).toSet()
assertEquals(2, dependenciesAfter.size, "Expected two dependencies")
assertTrue(customDokkaTask in dependenciesAfter, "Expected 'customDokkaTask' in dependencies")
}
@Test
fun `multimodule task with no child tasks throws DokkaException`() {
val project = ProjectBuilder.builder().build()
val multimodule = project.tasks.create<DokkaMultiModuleTask>("multimodule")
project.configurations.configureEach { it.withDependencies { it.clear() } }
assertFailsWith<DokkaException> { multimodule.generateDocumentation() }
}
@Test
fun childDokkaTaskIncludes() {
val childDokkaTaskInclude1 = childProject.file("include1")
val childDokkaTaskInclude2 = childProject.file("include2")
val childDokkaTaskInclude3 = childProject.file("include3")
childDokkaTask.apply {
dokkaSourceSets.create("main") {
it.includes.from(childDokkaTaskInclude1, childDokkaTaskInclude2)
}
dokkaSourceSets.create("main2") {
it.includes.from(childDokkaTaskInclude3)
}
}
val secondChildDokkaTaskInclude = childProject.file("include4")
val secondChildDokkaTask = childProject.tasks.create<DokkaTaskPartial>("secondChildDokkaTask") {
dokkaSourceSets.create("main") {
it.includes.from(secondChildDokkaTaskInclude)
}
}
multiModuleTask.addChildTask(secondChildDokkaTask)
assertEquals(
mapOf(
":child:childDokkaTask" to setOf(
childDokkaTaskInclude1,
childDokkaTaskInclude2,
childDokkaTaskInclude3
),
":child:secondChildDokkaTask" to setOf(secondChildDokkaTaskInclude)
),
multiModuleTask.childDokkaTaskIncludes
)
}
@Test
fun sourceChildOutputDirectories() {
val parent = ProjectBuilder.builder().build()
val child = ProjectBuilder.builder().withName("child").withParent(parent).build()
val parentTask = parent.tasks.create<DokkaMultiModuleTask>("parent")
val childTask = child.tasks.create<DokkaTask>("child")
parentTask.addChildTask(childTask)
childTask.outputDirectory by child.file("custom/output")
assertEquals(
listOf(parent.file("child/custom/output")), parentTask.sourceChildOutputDirectories,
"Expected child output directory being present"
)
}
@Test
fun targetChildOutputDirectories() {
val parent = ProjectBuilder.builder().build()
val child = ProjectBuilder.builder().withName("child").withParent(parent).build()
val parentTask = parent.tasks.create<DokkaMultiModuleTask>("parent")
val childTask = child.tasks.create<DokkaTask>("child")
parentTask.addChildTask(childTask)
parentTask.fileLayout by DokkaMultiModuleFileLayout { parent, child ->
parent.project.buildDir.resolve(child.name)
}
assertEquals(
listOf(parent.project.buildDir.resolve("child")), parentTask.targetChildOutputDirectories,
"Expected child target output directory being present"
)
}
}