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
|
package org.jetbrains.dokka.dokkatoo.tests.integration
import org.jetbrains.dokka.dokkatoo.utils.*
import io.kotest.core.spec.style.FunSpec
import io.kotest.matchers.file.shouldBeAFile
import io.kotest.matchers.file.shouldHaveSameStructureAndContentAs
import io.kotest.matchers.file.shouldHaveSameStructureAs
import io.kotest.matchers.shouldBe
import io.kotest.matchers.string.shouldContain
import io.kotest.matchers.string.shouldNotContain
import java.io.File
import kotlin.io.path.deleteIfExists
/**
* Integration test for the `it-android-0` project in Dokka
*
* Runs Dokka & Dokkatoo, and compares the resulting HTML site.
*/
class AndroidProjectIntegrationTest : FunSpec({
val tempDir = GradleProjectTest.projectTestTempDir.resolve("it/it-android-0").toFile()
val dokkatooProject = initDokkatooProject(tempDir.resolve("dokkatoo"))
val dokkaProject = initDokkaProject(tempDir.resolve("dokka"))
context("when generating HTML") {
context("with Dokka") {
dokkaProject.runner
.addArguments(
"clean",
"dokkaHtml",
"--stacktrace",
)
.forwardOutput()
.build {
test("expect project builds successfully") {
output shouldContain "BUILD SUCCESSFUL"
}
}
}
context("with Dokkatoo") {
dokkatooProject.runner
.addArguments(
"clean",
"dokkatooGeneratePublicationHtml",
"--stacktrace",
)
.forwardOutput()
.build {
test("expect project builds successfully") {
output shouldContain "BUILD SUCCESSFUL"
}
test("expect all dokka workers are successful") {
dokkatooProject
.findFiles { it.name == "dokka-worker.log" }
.shouldBeSingleton { dokkaWorkerLog ->
dokkaWorkerLog.shouldBeAFile()
dokkaWorkerLog.readText().shouldNotContainAnyOf(
"[ERROR]",
"[WARN]",
)
}
}
}
}
test("expect the same HTML is generated") {
val dokkaHtmlDir = dokkaProject.projectDir.resolve("build/dokka/html")
val dokkatooHtmlDir = dokkatooProject.projectDir.resolve("build/dokka/html")
val expectedFileTree = dokkaHtmlDir.toTreeString()
val actualFileTree = dokkatooHtmlDir.toTreeString()
println((actualFileTree to expectedFileTree).sideBySide())
expectedFileTree shouldBe actualFileTree
dokkatooHtmlDir.toFile().shouldHaveSameStructureAs(dokkaHtmlDir.toFile())
dokkatooHtmlDir.toFile().shouldHaveSameStructureAndContentAs(dokkaHtmlDir.toFile())
}
test("Dokkatoo tasks should be cacheable") {
dokkatooProject.runner
.addArguments(
"dokkatooGeneratePublicationHtml",
"--stacktrace",
"--build-cache",
)
.forwardOutput()
.build {
output shouldContainAll listOf(
"Task :dokkatooGeneratePublicationHtml UP-TO-DATE",
)
}
}
context("expect Dokkatoo is compatible with Gradle Configuration Cache") {
dokkatooProject.file(".gradle/configuration-cache").toFile().deleteRecursively()
dokkatooProject.file("build/reports/configuration-cache").toFile().deleteRecursively()
val configCacheRunner =
dokkatooProject.runner
.addArguments(
"clean",
"dokkatooGeneratePublicationHtml",
"--stacktrace",
"--no-build-cache",
"--configuration-cache",
)
.forwardOutput()
test("first build should store the configuration cache") {
configCacheRunner.build {
output shouldContain "BUILD SUCCESSFUL"
output shouldContain "Configuration cache entry stored"
output shouldNotContain "problems were found storing the configuration cache"
}
}
test("second build should reuse the configuration cache") {
configCacheRunner.build {
output shouldContain "BUILD SUCCESSFUL"
output shouldContain "Configuration cache entry reused"
}
}
}
}
})
private fun initDokkaProject(
destinationDir: File,
): GradleProjectTest {
return GradleProjectTest(destinationDir.toPath()).apply {
copyIntegrationTestProject("it-android-0/dokka")
gradleProperties = gradleProperties
.replace(
"dokka_it_android_gradle_plugin_version=4.2.2",
"dokka_it_android_gradle_plugin_version=8.0.2",
)
file("src/main/AndroidManifest.xml").deleteIfExists()
buildGradleKts += """
android {
namespace = "org.jetbrains.dokka.it.android"
}
java {
toolchain {
languageVersion.set(JavaLanguageVersion.of(17))
}
}
""".trimIndent()
}
}
private fun initDokkatooProject(
destinationDir: File,
): GradleProjectTest {
return GradleProjectTest(destinationDir.toPath()).apply {
copyIntegrationTestProject("it-android-0/dokkatoo")
}
}
|
