-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
GradleRunnerRule.kt
290 lines (258 loc) · 8.89 KB
/
GradleRunnerRule.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
package net.twisterrob.gradle.test
import org.gradle.api.internal.tasks.testing.worker.TestWorker
import org.gradle.testkit.runner.GradleRunner
import org.gradle.testkit.runner.internal.DefaultGradleRunner
import org.gradle.util.GradleVersion
import org.intellij.lang.annotations.Language
import org.junit.rules.TemporaryFolder
import org.junit.rules.TestRule
import org.junit.runner.Description
import org.junit.runners.model.Statement
import java.io.File
import java.net.URI
/**
* Simplified {@link org.junit.Rule} around {@link GradleRunner} to reduce code repetition.
*/
@Suppress("BooleanPropertyNaming") // These are clear names.
open class GradleRunnerRule : TestRule {
private val temp = TemporaryFolder()
/**
* Defines if a tests Gradle folder should be removed after a failed execution.
* Precedence:
* * this property (`null` → next)
* * `net.twisterrob.gradle.runner.clearAfterFailure` system property (not set → next)
* * automatically clear (when none of the above are specified)
*
* @param value `null` = automatic, `true` clean, `false` keep
* @see GradleRunner.getProjectDir `runner.projectDir`
*/
@Suppress("KDocUnresolvedReference")
var clearAfterFailure: Boolean? = null
private val needClearAfterFailure: Boolean
get() = listOfNotNull(
clearAfterFailure,
System.getProperty("net.twisterrob.gradle.runner.clearAfterFailure")?.toBoolean(),
true
).first()
/**
* Defines if a tests Gradle folder should be removed after a failed execution.
* Precedence:
* * this property (`null` → next)
* * `net.twisterrob.gradle.runner.clearAfterFailure` system property (not set → next)
* * automatically clear (when none of the above are specified)
*
* @param value `null` = automatic, `true` clean, `false` keep
* @see GradleRunner.getProjectDir `runner.projectDir`
*/
@Suppress("KDocUnresolvedReference")
var clearAfterSuccess: Boolean? = null
private val needClearAfterSuccess: Boolean
get() = listOfNotNull(
clearAfterSuccess,
System.getProperty("net.twisterrob.gradle.runner.clearAfterSuccess")?.toBoolean(),
true
).first()
lateinit var runner: GradleRunner private set
//@Test:given/@Before
var gradleVersion: GradleVersion = GradleVersion.current()
set(value) {
val distributionUrl =
URI.create("https://services.gradle.org/distributions/gradle-${value.version}-all.zip")
runner
.withGradleVersion(value.version)
.withGradleDistribution(distributionUrl)
field = value
}
@Suppress("MemberVisibilityCanBePrivate") // API
lateinit var buildFile: File
private set
val settingsFile: File
get() = File(runner.projectDir, "settings.gradle")
val propertiesFile: File
get() = File(runner.projectDir, "gradle.properties")
open val extraArgs: Array<String> = arrayOf("--stacktrace")
//region TestRule
override fun apply(base: Statement, description: Description): Statement {
return object : Statement() {
override fun evaluate() {
var success = false
try {
before()
base.evaluate()
success = true
} finally {
after(success)
}
}
}
}
internal fun before() {
temp.create()
setUp()
}
internal fun after(success: Boolean) {
tearDown()
@Suppress("ComplexCondition")
if ((success && needClearAfterSuccess) || (!success && needClearAfterFailure)) {
temp.delete()
}
}
//endregion
//region GradleRunner wrapper
//@Before(automatic with @Rule)
protected open fun setUp() {
buildFile = temp.newFile("build.gradle")
runner = GradleRunner
.create()
//.forwardOutput() // need to customize forwarding because of test output
.forwardStdOutput(WriteOnlyWhenLineCompleteWriter(System.out.writer()))
.forwardStdError(WriteOnlyWhenLineCompleteWriter(System.err.writer()))
.withProjectDir(temp.root)
.withPluginClasspath()
check(buildFile == File(runner.projectDir, "build.gradle")) {
"${buildFile} is not within ${runner.projectDir}."
}
fixClassPath(runner)
System.getProperty("net.twisterrob.gradle.runner.gradleVersion", null)?.let {
gradleVersion = GradleVersion.version(it)
}
}
protected open fun tearDown() {
// not used yet, but useful for debugging
}
//@Test:when
fun run(@Language("gradle") script: String?, vararg tasks: String): GradleRunner {
if (script != null) {
buildFile.appendText(script)
}
val args = arrayOf(*tasks, *extraArgs)
val gradleTestWorkerId: String? by systemProperty(TestWorker.WORKER_ID_SYS_PROPERTY)
val testKitDir = (runner as? DefaultGradleRunner)?.testKitDirProvider?.dir
val javaVendor: String? by systemProperty("java.vendor")
val javaVersion: String? by systemProperty("java.version")
val javaVersionDate: String? by systemProperty("java.version.date")
val javaRuntimeName: String? by systemProperty("java.runtime.name")
val javaRuntimeVersion: String? by systemProperty("java.runtime.version")
val javaHome: String? by systemProperty("java.home")
@Suppress("NullableToStringCall") // Debug info, null is OK.
val java = "${javaVendor} ${javaRuntimeName} ${javaVersion} (${javaRuntimeVersion} ${javaVersionDate})"
@Suppress("ForbiddenMethodCall") // TODO abstract logging.
println(
@Suppress("MultilineRawStringIndentation") """
${gradleVersion} worker #${gradleTestWorkerId} at ${testKitDir?.absolutePath}.
Java: ${java} from ${javaHome}.
Gradle properties:
```properties
${propertiesContentForLogging().prependIndent("\t\t\t\t")}
```
Running `gradle ${args.joinToString(" ")}` on ${buildFile.absolutePath}:
```gradle
${buildContentForLogging().prependIndent("\t\t\t\t")}
```
Execution output:
""".trimIndent()
)
return runner.withArguments(*args)
}
private fun buildContentForLogging(): String =
buildFile.readText()
private fun propertiesContentForLogging(): String =
if (propertiesFile.exists()) {
propertiesFile.readText()
} else {
"${propertiesFile.name} does not exist."
}
/**
* This is a workaround because runner.withPluginClasspath() doesn't seem to work.
*/
private fun fixClassPath(runner: GradleRunner) {
val classPaths = runner
.pluginClasspath
.joinToString(System.lineSeparator()) {
"classpath files('${it.absolutePath.replace("\\", "\\\\")}')"
}
@Language("gradle")
val buildscript = @Suppress("MultilineRawStringIndentation") """
buildscript {
dependencies {
${classPaths.prependIndent("\t\t\t\t\t")}
}
}
""".trimIndent() + System.lineSeparator()
buildFile.appendText(buildscript)
}
//endregion
//region Helper methods
//@Test:given/@Before
@Deprecated(
message = "Use gradleVersion property instead.",
replaceWith = ReplaceWith("gradleVersion = GradleVersion.version(version)")
)
fun setGradleVersion(version: String) {
gradleVersion = GradleVersion.version(version)
}
//@Test:given/@Before
fun file(contents: String, path: String) {
file(contents, path.split("""[/\\]""".toRegex()))
}
//@Test:given/@Before
fun file(contents: String, path: Collection<String>) {
file(contents, *path.toTypedArray())
}
fun file(contents: String, vararg path: String) {
getFile(*path).appendText(contents)
}
@Suppress("ReturnCount")
private fun getFile(vararg path: String): File {
if (path.size == 1 && path[0] == "build.gradle") {
return buildFile
}
if (path.size == 1 && path[0] == "gradle.properties") {
return propertiesFile
}
if (1 < path.size) {
val folders = path.sliceArray(0..path.size - 2)
if (!File(temp.root, folders.joinToString(File.separator)).exists()) {
temp.newFolder(*folders)
}
}
val existing = temp.root.resolve(path.joinToString(File.separator))
if (existing.exists()) {
return existing
}
return temp.newFile(path.joinToString(File.separator))
}
//@Test:given/@Before
@JvmOverloads
fun basedOn(folder: String, relativeTo: Any? = null): GradleRunnerRule =
@Suppress("DEPRECATION")
basedOn(templateFile(folder, relativeTo))
@JvmOverloads
@Deprecated("This method does not belong on the Gradle rule, use some other utility to load from resources.")
fun templateFile(path: String, relativeTo: Any? = null): File {
val container = when (relativeTo) {
is String -> relativeTo
null -> ""
else -> "/${relativeTo.javaClass.`package`.name}"
}
val resource = this.javaClass.getResource("${container}/${path}")
?: throw IllegalArgumentException("Cannot find ${path} relative to {${relativeTo ?: "nothing (i.e. absolute)"}}")
return File(resource.file)
}
//@Test:given/@Before
fun basedOn(folder: File): GradleRunnerRule {
@Suppress("ForbiddenMethodCall") // TODO abstract logging.
println("Deploying ${folder} into ${temp.root}")
folder.copyRecursively(temp.root, overwrite = false) onError@{ file, ex ->
if (file == buildFile && ex is FileAlreadyExistsException) {
val originalBuildFile = buildFile.readText()
val newBuildFile = folder.resolve(buildFile.name).readText()
buildFile.writeText(originalBuildFile + newBuildFile)
return@onError OnErrorAction.SKIP
}
throw ex
}
return this
}
//endregion
}