-
Notifications
You must be signed in to change notification settings - Fork 110
/
MavenPublishPluginIntegrationTest.kt
418 lines (320 loc) · 16.4 KB
/
MavenPublishPluginIntegrationTest.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
package com.vanniktech.maven.publish
import java.io.File
import java.util.zip.ZipFile
import org.assertj.core.api.Assertions.assertThat
import org.gradle.testkit.runner.BuildResult
import org.gradle.testkit.runner.GradleRunner
import org.gradle.testkit.runner.TaskOutcome.SUCCESS
import org.junit.Rule
import org.junit.Test
import org.junit.rules.TemporaryFolder
class MavenPublishPluginIntegrationTest {
@get:Rule val testProjectDir: TemporaryFolder = TemporaryFolder()
private lateinit var repoFolder: File
private lateinit var projectFolder: File
private lateinit var expectedFolder: File
@Test fun generatesArtifactsAndDocumentationOnJavaProject() {
setupFixture("passing_java_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.java", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnJavaWithKotlinProject() {
setupFixture("passing_java_with_kotlin_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.kt", "src/main/java")
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/JavaTestClass.java", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnJavaLibraryProject() {
setupFixture("passing_java_library_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.java", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnJavaLibraryWithToolchainProject() {
setupFixture("passing_java_library_with_toolchain_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.java", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnJavaLibraryWithKotlinProject() {
setupFixture("passing_java_library_with_kotlin_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.kt", "src/main/java")
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/JavaTestClass.java", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnKotlinJvmProject() {
setupFixture("passing_kotlin_jvm_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.kt", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnKotlinJvmWithDokkaProject() {
setupFixture("passing_kotlin_jvm_with_dokka_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result, hasDokka = true)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
assertSourceJarContainsFile("com/vanniktech/maven/publish/test/TestClass.kt", "src/main/java")
}
@Test fun generatesArtifactsAndDocumentationOnAndroidProject() {
setupFixture("passing_android_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated("aar")
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnAndroidSingleVariantProject() {
setupFixture("passing_android_single_variant_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated(artifactExtension = "aar")
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnAndroidMultiVariantProject() {
setupFixture("passing_android_multi_variant_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated("aar", qualifier = "debug")
assertExpectedCommonArtifactsGenerated("aar", qualifier = "release")
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnAndroidWithKotlinProject() {
setupFixture("passing_android_with_kotlin_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated("aar")
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnKotlinMppProject() {
setupFixture("passing_kotlin_mpp_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
val jvmArtifactId = "$TEST_POM_ARTIFACT_ID-jvm"
assertExpectedCommonArtifactsGenerated(artifactId = jvmArtifactId)
// TODO dependency sorting is unstable - the main variant only has 1 and is enough to see that the pom is correct
// assertPomContentMatches(jvmArtifactId)
val nodejsArtifactId = "$TEST_POM_ARTIFACT_ID-nodejs"
assertExpectedCommonArtifactsGenerated(artifactId = nodejsArtifactId)
// TODO dependency sorting is unstable - the main variant only has 1 and is enough to see that the pom is correct
// assertPomContentMatches(nodejsArtifactId)
val linuxArtifactId = "$TEST_POM_ARTIFACT_ID-linux"
assertExpectedCommonArtifactsGenerated(artifactExtension = "klib", artifactId = linuxArtifactId)
assertPomContentMatches(linuxArtifactId)
}
@Test fun kotlinMppArtifactIdReplacementWorksCorrectly1() {
setupFixture("passing_kotlin_mpp_project", "foo")
val result = executeGradleCommands(TEST_TASK, "--stacktrace", "-PPOM_ARTIFACT_ID=foo-bar")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated(artifactId = "foo-bar")
assertExpectedCommonArtifactsGenerated(artifactId = "foo-bar-jvm")
assertExpectedCommonArtifactsGenerated(artifactId = "foo-bar-nodejs")
assertExpectedCommonArtifactsGenerated(artifactExtension = "klib", artifactId = "foo-bar-linux")
}
@Test fun kotlinMppArtifactIdReplacementWorksCorrectly2() {
setupFixture("passing_kotlin_mpp_project", "foo")
val result = executeGradleCommands(TEST_TASK, "--stacktrace", "-PPOM_ARTIFACT_ID=bar-foo")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated(artifactId = "bar-foo")
assertExpectedCommonArtifactsGenerated(artifactId = "bar-foo-jvm")
assertExpectedCommonArtifactsGenerated(artifactId = "bar-foo-nodejs")
assertExpectedCommonArtifactsGenerated(artifactExtension = "klib", artifactId = "bar-foo-linux")
}
@Test fun generatesArtifactsAndDocumentationOnKotlinMppWithDokkaProject() {
setupFixture("passing_kotlin_mpp_with_dokka_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result, hasDokka = true)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
val jvmArtifactId = "$TEST_POM_ARTIFACT_ID-jvm"
assertExpectedCommonArtifactsGenerated(artifactId = jvmArtifactId)
// TODO dependency sorting is unstable - the other variants only have 1 and are enough to see that the pom is correct
// assertPomContentMatches(jvmArtifactId)
val nodejsArtifactId = "$TEST_POM_ARTIFACT_ID-nodejs"
assertExpectedCommonArtifactsGenerated(artifactId = nodejsArtifactId)
// TODO dependency sorting is unstable - the main variant only has 1 and is enough to see that the pom is correct
// assertPomContentMatches(nodejsArtifactId)
val linuxArtifactId = "$TEST_POM_ARTIFACT_ID-linux"
assertExpectedCommonArtifactsGenerated(artifactExtension = "klib", artifactId = linuxArtifactId)
assertPomContentMatches(linuxArtifactId)
}
@Test fun generatesArtifactsAndDocumentationOnKotlinMppWithAndroidDokkaProject() {
setupFixture("passing_kotlin_mpp_with_android_dokka_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result, hasDokka = true)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
val androidArtifactId = "$TEST_POM_ARTIFACT_ID-android"
assertExpectedCommonArtifactsGenerated(artifactId = androidArtifactId, artifactExtension = "aar")
// TODO dependency sorting is unstable - the other variants only have 1 and are enough to see that the pom is correct
// assertPomContentMatches(androidArtifactId)
val androidDebugArtifactId = "$TEST_POM_ARTIFACT_ID-android-debug"
assertExpectedCommonArtifactsGenerated(artifactId = androidDebugArtifactId, artifactExtension = "aar")
// TODO dependency sorting is unstable - the other variants only have 1 and are enough to see that the pom is correct
// assertPomContentMatches(androidDebugArtifactId)
val jvmArtifactId = "$TEST_POM_ARTIFACT_ID-jvm"
assertExpectedCommonArtifactsGenerated(artifactId = jvmArtifactId)
// TODO dependency sorting is unstable - the other variants only have 1 and are enough to see that the pom is correct
// assertPomContentMatches(jvmArtifactId)
val nodejsArtifactId = "$TEST_POM_ARTIFACT_ID-nodejs"
assertExpectedCommonArtifactsGenerated(artifactId = nodejsArtifactId)
// TODO dependency sorting is unstable - the main variant only has 1 and is enough to see that the pom is correct
// assertPomContentMatches(nodejsArtifactId)
val linuxArtifactId = "$TEST_POM_ARTIFACT_ID-linux"
assertExpectedCommonArtifactsGenerated(artifactExtension = "klib", artifactId = linuxArtifactId)
assertPomContentMatches(linuxArtifactId)
}
@Test
fun generatesArtifactsAndDocumentationOnKotlinJsProject() {
setupFixture("passing_kotlin_js_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnGradlePluginProject() {
setupFixture("passing_java_gradle_plugin_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertThat(result.task(":$TEST_TASK")?.outcome).isEqualTo(SUCCESS)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
val pluginId = "com.example.test-plugin"
val artifactId = "$pluginId.gradle.plugin"
assertPomContentMatches(artifactId, pluginId)
}
@Test fun generatesArtifactsAndDocumentationOnMinimalPomProject() {
setupFixture("minimal_pom_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnFullPomProject() {
setupFixture("full_pom_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated()
assertPomContentMatches()
}
@Test fun generatesArtifactsAndDocumentationOnOverrideVersionGroupProject() {
setupFixture("override_version_group_project")
val result = executeGradleCommands(TEST_TASK, "--stacktrace")
assertExpectedTasksRanSuccessfully(result)
assertExpectedCommonArtifactsGenerated(groupId = "com.example2", version = "2.0.0")
assertPomContentMatches(groupId = "com.example2", version = "2.0.0")
}
/**
* Copies test fixture into temp directory under test.
*/
private fun setupFixture(fixtureName: String, projectName: String = fixtureName) {
repoFolder = testProjectDir.newFolder("repo")
projectFolder = testProjectDir.newFolder(projectName)
expectedFolder = projectFolder.resolve(EXPECTED_DIR)
File("$FIXTURES/common").copyRecursively(projectFolder)
File("$FIXTURES/$fixtureName").copyRecursively(projectFolder, overwrite = true)
}
private fun assertExpectedTasksRanSuccessfully(result: BuildResult, hasDokka: Boolean = false) {
assertThat(result.task(":$TEST_TASK")?.outcome).isEqualTo(SUCCESS)
if (hasDokka) {
assertThat(result.task(":dokkaHtml")?.outcome).isEqualTo(SUCCESS)
} else {
assertThat(result.task(":dokkaHtml")).isNull()
}
}
/**
* Makes sure common artifacts are generated (POM, javadoc, sources, etc.),
* no matter what project type is and which plugins are applied.
*/
private fun assertExpectedCommonArtifactsGenerated(
artifactExtension: String = "jar",
artifactId: String = TEST_POM_ARTIFACT_ID,
groupId: String = TEST_GROUP,
version: String = TEST_VERSION_NAME,
qualifier: String? = null,
) {
val qualifierSuffix = qualifier?.let { "-$it" } ?: ""
val artifactJar = "$artifactId-$version$qualifierSuffix.$artifactExtension"
val pomFile = "$artifactId-$version.pom"
val moduleFile = "$artifactId-$version.module"
val javadocJar = "$artifactId-$version$qualifierSuffix-javadoc.jar"
val sourcesJar = "$artifactId-$version$qualifierSuffix-sources.jar"
assertArtifactGenerated(artifactJar, artifactId, groupId, version)
assertArtifactGenerated(pomFile, artifactId, groupId, version)
assertArtifactGenerated(moduleFile, artifactId, groupId, version)
assertArtifactGenerated(javadocJar, artifactId, groupId, version)
assertArtifactGenerated(sourcesJar, artifactId, groupId, version)
}
private fun assertArtifactGenerated(
artifactFileNameWithExtension: String,
artifactId: String = TEST_POM_ARTIFACT_ID,
groupId: String = TEST_GROUP,
version: String = TEST_VERSION_NAME
) {
val artifactFolder = artifactFolder(artifactId, groupId, version)
assertThat(artifactFolder.resolve(artifactFileNameWithExtension)).exists()
assertThat(artifactFolder.resolve("$artifactFileNameWithExtension.asc")).exists()
}
private fun assertPomContentMatches(
artifactId: String = TEST_POM_ARTIFACT_ID,
groupId: String = TEST_GROUP,
version: String = TEST_VERSION_NAME
) {
val artifactFolder = artifactFolder(artifactId, groupId, version)
val pomFileName = "$artifactId-$version.pom"
val resolvedPomFile = artifactFolder.resolve(pomFileName)
val content = resolvedPomFile.readText()
val expectedContent = expectedFolder.resolve(pomFileName).readText()
assertThat(content).isEqualToNormalizingWhitespace(expectedContent)
}
private fun assertSourceJarContainsFile(
file: String,
srcRoot: String,
artifactId: String = TEST_POM_ARTIFACT_ID,
groupId: String = TEST_GROUP,
version: String = TEST_VERSION_NAME
) {
val artifactFolder = artifactFolder(artifactId, groupId, version)
val sourcesJar = ZipFile(artifactFolder.resolve("$artifactId-$version-sources.jar"))
val entry = sourcesJar.getEntry(file)
assertThat(entry).describedAs(file).isNotNull()
val content = sourcesJar.getInputStream(entry)?.reader()?.buffered()?.readText()
val expected = projectFolder.resolve(srcRoot).resolve(file)
val expectedContent = expected.readText()
assertThat(content).describedAs(file).isNotBlank()
assertThat(content).describedAs(file).isEqualTo(expectedContent)
}
private fun artifactFolder(artifactId: String, groupId: String, version: String): File {
val group = groupId.replace(".", "/")
return repoFolder.resolve(group).resolve(artifactId).resolve(version)
}
private fun executeGradleCommands(vararg commands: String) = GradleRunner.create()
.withProjectDir(projectFolder)
.withArguments(*commands, "-Ptest.releaseRepository=$repoFolder")
.withDebug(true)
.forwardOutput()
.build()
companion object {
const val FIXTURES = "src/integrationTest/fixtures"
const val EXPECTED_DIR = "expected"
const val TEST_GROUP = "com.example"
const val TEST_VERSION_NAME = "1.0.0"
const val TEST_POM_ARTIFACT_ID = "test-artifact"
const val TEST_TASK = "publishAllPublicationsToTestFolderRepository"
}
}