From c0ce35627413103d64845ca3c56b9ceab0606b6b Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Wed, 1 Jul 2020 14:30:49 +0200 Subject: Re-implement first basic gradle integration test --- .../it/gradle/AbstractGradleIntegrationTest.kt | 49 ++++++++++++++++++++++ .../org/jetbrains/dokka/it/gradle/BuildVersions.kt | 6 +++ .../kotlin/org/jetbrains/dokka/it/gradle/utils.kt | 29 +++++++++++++ 3 files changed, 84 insertions(+) create mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt create mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt create mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt new file mode 100644 index 00000000..271720fe --- /dev/null +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -0,0 +1,49 @@ +package org.jetbrains.dokka.it.gradle + +import org.gradle.testkit.runner.GradleRunner +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import java.io.File +import kotlin.test.assertFalse +import kotlin.test.assertTrue + +abstract class AbstractGradleIntegrationTest { + + @get:Rule + val projectTemporaryFolder = TemporaryFolder() + + val projectPath get() = projectTemporaryFolder.root.toPath() + + val projectDir get() = projectTemporaryFolder.root + + + fun createGradleRunner( + buildVersions: BuildVersions, arguments: Array + ): GradleRunner { + return GradleRunner.create() + .withProjectDir(projectDir) + .withGradleVersion(buildVersions.gradleVersion) + .forwardOutput() + .withArguments("-Pkotlin_version=${buildVersions.kotlinVersion}", *arguments) + .withDebug(true) + + } + + protected fun assertContainsNoErrorClass(file: File) { + val fileText = file.readText() + assertFalse( + fileText.contains("ERROR CLASS", ignoreCase = true), + "Unexpected `ERROR CLASS` in ${file.path}\n" + fileText + ) + } + + protected fun assertNoUnresolvedLInks(file: File) { + val regex = Regex("[\"']#[\"']") + val fileText = file.readText() + assertFalse( + fileText.contains(regex), + "Unexpected unresolved link in ${file.path}\n" + fileText + ) + } +} + diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt new file mode 100644 index 00000000..6aa41e7a --- /dev/null +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt @@ -0,0 +1,6 @@ +package org.jetbrains.dokka.it.gradle + +data class BuildVersions( + val gradleVersion: String, + val kotlinVersion: String +) diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt new file mode 100644 index 00000000..2516b151 --- /dev/null +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt @@ -0,0 +1,29 @@ +package org.jetbrains.dokka.it.gradle + +import java.io.IOException +import java.nio.file.* +import java.nio.file.attribute.BasicFileAttributes + +fun Path.copy(to: Path) { + Files.walkFileTree(this, CopyFileVisitor(this, to)) +} + +class CopyFileVisitor(private var sourcePath: Path, private val targetPath: Path) : SimpleFileVisitor() { + @Throws(IOException::class) + override fun preVisitDirectory( + dir: Path, + attrs: BasicFileAttributes + ): FileVisitResult { + Files.createDirectories(targetPath.resolve(sourcePath.relativize(dir))) + return FileVisitResult.CONTINUE + } + + @Throws(IOException::class) + override fun visitFile( + file: Path, + attrs: BasicFileAttributes + ): FileVisitResult { + Files.copy(file, targetPath.resolve(sourcePath.relativize(file)), StandardCopyOption.REPLACE_EXISTING) + return FileVisitResult.CONTINUE + } +} -- cgit From badd2d7e4bfad519f31b69ae9c1bea5659f3c59b Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Wed, 1 Jul 2020 14:44:18 +0200 Subject: Implement AbstractDefaultVersionsGradleIntegrationTest.kt --- .../gradle/projects/it-basic/build.gradle.kts | 2 +- ...AbstractDefaultVersionsGradleIntegrationTest.kt | 68 ++++++++++++++++++++++ .../it/gradle/AbstractGradleIntegrationTest.kt | 1 - .../org/jetbrains/dokka/it/gradle/BasicTest.kt | 64 +------------------- 4 files changed, 71 insertions(+), 64 deletions(-) create mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 69e469bc..bdb59279 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -17,6 +17,6 @@ dependencies { } afterEvaluate { - logger.quiet("Kotlin version: ${KotlinVersion.CURRENT}") logger.quiet("Gradle version: ${gradle.gradleVersion}") + logger.quiet("Kotlin version: ${property("kotlin_version")}") } diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt new file mode 100644 index 00000000..b7f44a4c --- /dev/null +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt @@ -0,0 +1,68 @@ +package org.jetbrains.dokka.it.gradle + +import org.junit.Test + +abstract class AbstractDefaultVersionsGradleIntegrationTest : AbstractGradleIntegrationTest() { + + protected abstract fun execute(versions: BuildVersions) + + @Test + fun `gradle 5_6_4 kotlin 1_3_72`() { + execute( + BuildVersions( + gradleVersion = "5.6.4", + kotlinVersion = "1.3.72" + ) + ) + } + + @Test + fun `gradle 5_6_4 kotlin 1_3_30`() { + execute( + BuildVersions( + gradleVersion = "5.6.4", + kotlinVersion = "1.3.30" + ) + ) + } + + @Test + fun `gradle 5_6_4 kotlin 1_4_M2_eap_70`() { + execute( + BuildVersions( + gradleVersion = "5.6.4", + kotlinVersion = "1.4-M2-eap-70" + ) + ) + } + + @Test + fun `gradle 6_1_1 kotlin 1_3_72`() { + execute( + BuildVersions( + gradleVersion = "6.1.1", + kotlinVersion = "1.3.72" + ) + ) + } + + @Test + fun `gradle 6_5_1 kotlin 1_4_M2_eap_70`() { + execute( + BuildVersions( + gradleVersion = "6.5.1", + kotlinVersion = "1.4-M2-eap-70" + ) + ) + } + + @Test + fun `gradle 6_5_1 kotlin 1_3_72`() { + execute( + BuildVersions( + gradleVersion = "6.5.1", + kotlinVersion = "1.3.72" + ) + ) + } +} diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index 271720fe..34114c74 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -5,7 +5,6 @@ import org.junit.Rule import org.junit.rules.TemporaryFolder import java.io.File import kotlin.test.assertFalse -import kotlin.test.assertTrue abstract class AbstractGradleIntegrationTest { diff --git a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicTest.kt b/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicTest.kt index deba4a16..ba6da4f9 100644 --- a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicTest.kt +++ b/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicTest.kt @@ -4,57 +4,7 @@ import org.gradle.testkit.runner.TaskOutcome import java.io.File import kotlin.test.* -class BasicTest : AbstractGradleIntegrationTest() { - - @Test - fun `gradle 5_6_4 kotlin 1_3_72`() { - execute( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.3.72" - ) - ) - } - - @Test - fun `gradle 5_6_4 kotlin 1_3_30`() { - execute( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.3.30" - ) - ) - } - - @Test - fun `gradle 5_6_4 kotlin 1_4_M2_eap_70`() { - execute( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.4-M2-eap-70" - ) - ) - } - - @Test - fun `gradle 6_1_1 kotlin 1_3_72`() { - execute( - BuildVersions( - gradleVersion = "6.1.1", - kotlinVersion = "1.3.72" - ) - ) - } - - @Test - fun `gradle 6_5_1 kotlin 1_4_M2_eap_70`() { - execute( - BuildVersions( - gradleVersion = "6.5.1", - kotlinVersion = "1.4-M2-eap-70" - ) - ) - } +class BasicTest : AbstractDefaultVersionsGradleIntegrationTest() { @BeforeTest fun prepareProjectFiles() { @@ -67,17 +17,7 @@ class BasicTest : AbstractGradleIntegrationTest() { File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) } - @Test - fun `gradle 6_5_1 kotlin 1_3_72`() { - execute( - BuildVersions( - gradleVersion = "6.5.1", - kotlinVersion = "1.3.72" - ) - ) - } - - private fun execute(versions: BuildVersions) { + override fun execute(versions: BuildVersions) { val result = createGradleRunner( buildVersions = versions, arguments = arrayOf("dokka", "--stacktrace") -- cgit From 012190fbfd049f56637b1039f4ae1f69becea881 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Wed, 1 Jul 2020 17:38:49 +0200 Subject: Gradle integration tests: Use dokka_it_kotlin_version over kotlin_version --- .../src/main/kotlin/org/jetbrains/DokkaVersion.kt | 20 ++++++++++++-------- .../testData/androidApp/app/build.gradle | 2 +- .../gradle/projects/it-basic/build.gradle.kts | 4 +--- .../gradle/projects/it-basic/gradle.properties | 1 + .../gradle/projects/it-basic/settings.gradle.kts | 4 ++-- .../dokka/it/gradle/AbstractGradleIntegrationTest.kt | 6 +++++- 6 files changed, 22 insertions(+), 15 deletions(-) create mode 100644 integration-tests/gradle/projects/it-basic/gradle.properties (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/buildSrc/src/main/kotlin/org/jetbrains/DokkaVersion.kt b/buildSrc/src/main/kotlin/org/jetbrains/DokkaVersion.kt index 5bd35415..d5fd3e78 100644 --- a/buildSrc/src/main/kotlin/org/jetbrains/DokkaVersion.kt +++ b/buildSrc/src/main/kotlin/org/jetbrains/DokkaVersion.kt @@ -7,13 +7,17 @@ import org.gradle.kotlin.dsl.provideDelegate fun Project.configureDokkaVersion(): String { var dokka_version: String? by this.extra if (dokka_version == null) { - val buildNumber = System.getenv("BUILD_NUMBER") val dokka_version_base: String by this - dokka_version = dokka_version_base + if (buildNumber == null || System.getenv("FORCE_SNAPSHOT") != null) { - "-SNAPSHOT" - } else { - "-$buildNumber" - } + dokka_version = dokkaVersionFromBase(dokka_version_base) } - return dokka_version!! -} \ No newline at end of file + return checkNotNull(dokka_version) +} + +private fun dokkaVersionFromBase(baseVersion: String): String { + val buildNumber = System.getenv("BUILD_NUMBER") + val forceSnapshot = System.getenv("FORCE_SNAPSHOT") != null + if (forceSnapshot || buildNumber == null) { + return "$baseVersion-SNAPSHOT" + } + return "$baseVersion-$buildNumber" +} diff --git a/integration-tests/gradle-integration-tests/testData/androidApp/app/build.gradle b/integration-tests/gradle-integration-tests/testData/androidApp/app/build.gradle index 2420107c..0092b76c 100644 --- a/integration-tests/gradle-integration-tests/testData/androidApp/app/build.gradle +++ b/integration-tests/gradle-integration-tests/testData/androidApp/app/build.gradle @@ -42,4 +42,4 @@ android { dependencies { compile "org.jetbrains.kotlin:kotlin-stdlib:$test_kotlin_version" dokkaRuntime files(dokka_fatjar) -} \ No newline at end of file +} diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 3e451fd3..80c2bbea 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -1,5 +1,3 @@ -import org.jetbrains.dokka.gradle.dokka - plugins { kotlin("jvm") id("org.jetbrains.dokka") @@ -18,5 +16,5 @@ dependencies { afterEvaluate { logger.quiet("Gradle version: ${gradle.gradleVersion}") - logger.quiet("Kotlin version: ${findProperty("kotlin_version")}") + logger.quiet("Kotlin version: ${properties["dokka_it_kotlin_version"]}") } diff --git a/integration-tests/gradle/projects/it-basic/gradle.properties b/integration-tests/gradle/projects/it-basic/gradle.properties new file mode 100644 index 00000000..7ebac3ad --- /dev/null +++ b/integration-tests/gradle/projects/it-basic/gradle.properties @@ -0,0 +1 @@ +dokka_it_kotlin_version=1.3.72 diff --git a/integration-tests/gradle/projects/it-basic/settings.gradle.kts b/integration-tests/gradle/projects/it-basic/settings.gradle.kts index 9bfd026f..10447365 100644 --- a/integration-tests/gradle/projects/it-basic/settings.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/settings.gradle.kts @@ -1,11 +1,11 @@ @file:Suppress("LocalVariableName", "UnstableApiUsage") pluginManagement { - val kotlin_version = "1.3.72" + val dokka_it_kotlin_version: String by settings val dokka_version = "0.11.0-SNAPSHOT" plugins { - id("org.jetbrains.kotlin.jvm") version kotlin_version + id("org.jetbrains.kotlin.jvm") version dokka_it_kotlin_version id("org.jetbrains.dokka") version dokka_version } diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index 34114c74..d8a9a60f 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -23,7 +23,11 @@ abstract class AbstractGradleIntegrationTest { .withProjectDir(projectDir) .withGradleVersion(buildVersions.gradleVersion) .forwardOutput() - .withArguments("-Pkotlin_version=${buildVersions.kotlinVersion}", *arguments) + .withArguments( + "-Pkotlin_version=${buildVersions.kotlinVersion}", + "-Pdokka_it_kotlin_version=${buildVersions.kotlinVersion}", + * arguments + ) .withDebug(true) } -- cgit From 3a5de4fada9dae8eb75816abe740152480409165 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Thu, 2 Jul 2020 09:44:50 +0200 Subject: Implement template mechanism for Gradle integration tests --- .../gradle/projects/it-basic/build.gradle.kts | 11 +--------- .../gradle/projects/it-basic/settings.gradle.kts | 24 +--------------------- .../gradle/projects/template.root.gradle.kts | 11 ++++++++++ .../gradle/projects/template.settings.gradle.kts | 24 ++++++++++++++++++++++ .../it/gradle/AbstractGradleIntegrationTest.kt | 14 ++++++++++--- .../src/main/kotlin/renderers/DefaultRenderer.kt | 2 +- 6 files changed, 49 insertions(+), 37 deletions(-) create mode 100644 integration-tests/gradle/projects/template.root.gradle.kts create mode 100644 integration-tests/gradle/projects/template.settings.gradle.kts (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index 80c2bbea..e5a44555 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -3,18 +3,9 @@ plugins { id("org.jetbrains.dokka") } -repositories { - maven("https://dl.bintray.com/kotlin/kotlin-dev/") - jcenter() - mavenLocal() - mavenCentral() -} +apply(from = "../template.root.gradle.kts") dependencies { implementation(kotlin("stdlib")) } -afterEvaluate { - logger.quiet("Gradle version: ${gradle.gradleVersion}") - logger.quiet("Kotlin version: ${properties["dokka_it_kotlin_version"]}") -} diff --git a/integration-tests/gradle/projects/it-basic/settings.gradle.kts b/integration-tests/gradle/projects/it-basic/settings.gradle.kts index ca697588..833995e5 100644 --- a/integration-tests/gradle/projects/it-basic/settings.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/settings.gradle.kts @@ -1,27 +1,5 @@ @file:Suppress("LocalVariableName", "UnstableApiUsage") -pluginManagement { - val dokka_it_kotlin_version: String by settings - - plugins { - id("org.jetbrains.kotlin.jvm") version dokka_it_kotlin_version - } - - resolutionStrategy { - eachPlugin { - if (requested.id.id == "org.jetbrains.dokka") { - useModule("org.jetbrains.dokka:dokka-gradle-plugin:for-integration-tests-SNAPSHOT") - } - } - } - repositories { - maven("https://dl.bintray.com/kotlin/kotlin-dev/") - mavenLocal() - mavenCentral() - jcenter() - gradlePluginPortal() - } -} - +apply(from = "../template.settings.gradle.kts") rootProject.name = "it-basic" diff --git a/integration-tests/gradle/projects/template.root.gradle.kts b/integration-tests/gradle/projects/template.root.gradle.kts new file mode 100644 index 00000000..02e6c715 --- /dev/null +++ b/integration-tests/gradle/projects/template.root.gradle.kts @@ -0,0 +1,11 @@ +repositories { + maven("https://dl.bintray.com/kotlin/kotlin-dev/") + jcenter() + mavenLocal() + mavenCentral() +} + +afterEvaluate { + logger.quiet("Gradle version: ${gradle.gradleVersion}") + logger.quiet("Kotlin version: ${properties["dokka_it_kotlin_version"]}") +} diff --git a/integration-tests/gradle/projects/template.settings.gradle.kts b/integration-tests/gradle/projects/template.settings.gradle.kts new file mode 100644 index 00000000..faee1f18 --- /dev/null +++ b/integration-tests/gradle/projects/template.settings.gradle.kts @@ -0,0 +1,24 @@ +@file:Suppress("LocalVariableName", "UnstableApiUsage") + +pluginManagement { + val dokka_it_kotlin_version: String by settings + + plugins { + id("org.jetbrains.kotlin.jvm") version dokka_it_kotlin_version + } + + resolutionStrategy { + eachPlugin { + if (requested.id.id == "org.jetbrains.dokka") { + useModule("org.jetbrains.dokka:dokka-gradle-plugin:for-integration-tests-SNAPSHOT") + } + } + } + repositories { + maven("https://dl.bintray.com/kotlin/kotlin-dev/") + mavenLocal() + mavenCentral() + jcenter() + gradlePluginPortal() + } +} diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index d8a9a60f..2efb9c55 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -4,17 +4,25 @@ import org.gradle.testkit.runner.GradleRunner import org.junit.Rule import org.junit.rules.TemporaryFolder import java.io.File +import kotlin.test.BeforeTest import kotlin.test.assertFalse abstract class AbstractGradleIntegrationTest { @get:Rule - val projectTemporaryFolder = TemporaryFolder() + val temporaryTestFolder = TemporaryFolder() - val projectPath get() = projectTemporaryFolder.root.toPath() + val projectDir get() = File(temporaryTestFolder.root, "project") - val projectDir get() = projectTemporaryFolder.root + val projectPath get() = projectDir.toPath() + @BeforeTest + fun copyTemplates() { + File("projects").listFiles().orEmpty() + .filter { it.isFile } + .filter { it.name.startsWith("template.") } + .forEach { file -> file.copyTo(File(temporaryTestFolder.root, file.name)) } + } fun createGradleRunner( buildVersions: BuildVersions, arguments: Array diff --git a/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt b/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt index 4313f1e3..f2fce191 100644 --- a/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt +++ b/plugins/base/src/main/kotlin/renderers/DefaultRenderer.kt @@ -172,4 +172,4 @@ abstract class DefaultRenderer( } } -fun ContentPage.sourceSets() = this.content.sourceSets \ No newline at end of file +fun ContentPage.sourceSets() = this.content.sourceSets -- cgit From 11a80c62d09d89803016c0feb3f41678bff41cfd Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Thu, 2 Jul 2020 11:12:49 +0200 Subject: Add basic multiplatform gradle integration test --- .run/it-basic_dokka.run.xml | 2 +- .run/it-multiplatform-0_dokka.run.xml | 24 +++ .../projects/it-multiplatform-0/build.gradle.kts | 25 +++ .../projects/it-multiplatform-0/gradle.properties | 1 + .../gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 58695 bytes .../gradle/wrapper/gradle-wrapper.properties | 5 + .../gradle/projects/it-multiplatform-0/gradlew | 183 +++++++++++++++++++++ .../gradle/projects/it-multiplatform-0/gradlew.bat | 100 +++++++++++ .../it-multiplatform-0/settings.gradle.kts | 2 + .../commonMain/kotlin/it/mpp0/CommonMainClass.kt | 8 + .../src/commonMain/kotlin/it/mpp0/ExpectedClass.kt | 5 + .../src/jsMain/kotlin/it/mpp0/ExpectedClass.kt | 5 + .../src/jvmMain/kotlin/it/mpp0/ExpectedClass.kt | 5 + .../src/linuxMain/kotlin/it/mpp0/ExpectedClass.kt | 5 + .../src/macosMain/kotlin/it/mpp0/ExpectedClass.kt | 5 + .../gradle/projects/template.root.gradle.kts | 12 +- .../gradle/projects/template.settings.gradle.kts | 1 + ...AbstractDefaultVersionsGradleIntegrationTest.kt | 42 +++-- .../it/gradle/AbstractGradleIntegrationTest.kt | 10 +- .../org/jetbrains/dokka/it/gradle/BuildVersions.kt | 14 +- .../dokka/it/gradle/BasicGradleIntegrationTest.kt | 10 +- .../gradle/Multiplatform0GradleIntegrationTest.kt | 41 +++++ 22 files changed, 477 insertions(+), 28 deletions(-) create mode 100644 .run/it-multiplatform-0_dokka.run.xml create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/build.gradle.kts create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/gradle.properties create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/gradle/wrapper/gradle-wrapper.jar create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/gradle/wrapper/gradle-wrapper.properties create mode 100755 integration-tests/gradle/projects/it-multiplatform-0/gradlew create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/gradlew.bat create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/settings.gradle.kts create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/commonMain/kotlin/it/mpp0/CommonMainClass.kt create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/commonMain/kotlin/it/mpp0/ExpectedClass.kt create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/jsMain/kotlin/it/mpp0/ExpectedClass.kt create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/jvmMain/kotlin/it/mpp0/ExpectedClass.kt create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/linuxMain/kotlin/it/mpp0/ExpectedClass.kt create mode 100644 integration-tests/gradle/projects/it-multiplatform-0/src/macosMain/kotlin/it/mpp0/ExpectedClass.kt create mode 100644 integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/.run/it-basic_dokka.run.xml b/.run/it-basic_dokka.run.xml index c5374b94..42d6ca63 100644 --- a/.run/it-basic_dokka.run.xml +++ b/.run/it-basic_dokka.run.xml @@ -1,5 +1,5 @@ - + \ No newline at end of file diff --git a/.run/it-android-0_dokka.run.xml b/.run/it-android-0_dokka.run.xml new file mode 100644 index 00000000..dcb61e2e --- /dev/null +++ b/.run/it-android-0_dokka.run.xml @@ -0,0 +1,24 @@ + + + + + + + true + + + + \ No newline at end of file diff --git a/buildSrc/src/main/kotlin/org/jetbrains/projectUtils.kt b/buildSrc/src/main/kotlin/org/jetbrains/projectUtils.kt new file mode 100644 index 00000000..46d803a5 --- /dev/null +++ b/buildSrc/src/main/kotlin/org/jetbrains/projectUtils.kt @@ -0,0 +1,16 @@ +package org.jetbrains + +import org.gradle.api.Project + +fun Project.whenEvaluated(action: Project.() -> Unit) { + if (state.executed) { + action() + } else { + afterEvaluate { action() } + } +} + +fun Project.invokeWhenEvaluated(action: (project: Project) -> Unit) { + whenEvaluated { action(this) } +} + diff --git a/integration-tests/build.gradle.kts b/integration-tests/build.gradle.kts index e69de29b..ec9b4004 100644 --- a/integration-tests/build.gradle.kts +++ b/integration-tests/build.gradle.kts @@ -0,0 +1,30 @@ +subprojects { + sourceSets { + create("integrationTest") { + compileClasspath += sourceSets.main.get().output + runtimeClasspath += sourceSets.main.get().output + } + } + configurations.getByName("integrationTestImplementation") { + extendsFrom(configurations.implementation.get()) + } + + configurations.getByName("integrationTestRuntimeOnly") { + extendsFrom(configurations.runtimeOnly.get()) + } + + val integrationTest = task("integrationTest") { + maxHeapSize = "2G" + description = "Runs integration tests." + group = "verification" + + testClassesDirs = sourceSets["integrationTest"].output.classesDirs + classpath = sourceSets["integrationTest"].runtimeClasspath + + useJUnit() + } + + tasks.check { + dependsOn(integrationTest) + } +} diff --git a/integration-tests/gradle/build.gradle.kts b/integration-tests/gradle/build.gradle.kts index fb5e5739..2c526af7 100644 --- a/integration-tests/gradle/build.gradle.kts +++ b/integration-tests/gradle/build.gradle.kts @@ -1,15 +1,22 @@ +import org.jetbrains.invokeWhenEvaluated + dependencies { implementation(kotlin("stdlib")) implementation(kotlin("test-junit")) implementation(gradleTestKit()) } -tasks { - test { - inputs.dir(file("projects")) +val integrationTest by tasks.integrationTest +integrationTest.inputs.dir(file("projects")) - rootProject.allprojects - .mapNotNull { project -> project.tasks.findByName("publishToMavenLocal") } - .forEach { publishTask -> this.dependsOn(publishTask) } +rootProject.allprojects.forEach { otherProject -> + otherProject.invokeWhenEvaluated { evaluatedProject -> + evaluatedProject.tasks.findByName("publishToMavenLocal")?.let { publishingTask -> + integrationTest.dependsOn(publishingTask) + } } } + +tasks.clean { + delete(File(buildDir, "gradle-test-kit")) +} diff --git a/integration-tests/gradle/projects/it-android-0/build.gradle.kts b/integration-tests/gradle/projects/it-android-0/build.gradle.kts new file mode 100644 index 00000000..32c5c56c --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/build.gradle.kts @@ -0,0 +1,19 @@ +plugins { + id("com.android.library") + id("org.jetbrains.dokka") + kotlin("android") +} + +apply(from = "../template.root.gradle.kts") + +android { + defaultConfig { + minSdkVersion(21) + setCompileSdkVersion(29) + } +} + +dependencies { + implementation(kotlin("stdlib")) +} + diff --git a/integration-tests/gradle/projects/it-android-0/gradle.properties b/integration-tests/gradle/projects/it-android-0/gradle.properties new file mode 100644 index 00000000..1332de19 --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/gradle.properties @@ -0,0 +1,2 @@ +dokka_it_kotlin_version=1.3.72 +dokka_it_android_gradle_plugin_version=4.0.0 diff --git a/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jar b/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 00000000..f3d88b1c Binary files /dev/null and b/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jar differ diff --git a/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.properties b/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 00000000..1b16c34a --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.1.1-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/integration-tests/gradle/projects/it-android-0/gradlew b/integration-tests/gradle/projects/it-android-0/gradlew new file mode 100755 index 00000000..2fe81a7d --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/gradlew @@ -0,0 +1,183 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/integration-tests/gradle/projects/it-android-0/gradlew.bat b/integration-tests/gradle/projects/it-android-0/gradlew.bat new file mode 100644 index 00000000..24467a14 --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/gradlew.bat @@ -0,0 +1,100 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/integration-tests/gradle/projects/it-android-0/settings.gradle.kts b/integration-tests/gradle/projects/it-android-0/settings.gradle.kts new file mode 100644 index 00000000..664d2cb7 --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/settings.gradle.kts @@ -0,0 +1,5 @@ +@file:Suppress("LocalVariableName", "UnstableApiUsage") + +apply(from = "../template.settings.gradle.kts") +rootProject.name = "it-android-0" + diff --git a/integration-tests/gradle/projects/it-android-0/src/main/AndroidManifest.xml b/integration-tests/gradle/projects/it-android-0/src/main/AndroidManifest.xml new file mode 100644 index 00000000..a35f86be --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/src/main/AndroidManifest.xml @@ -0,0 +1 @@ + diff --git a/integration-tests/gradle/projects/it-android-0/src/main/java/it/android/AndroidSpecificClass.kt b/integration-tests/gradle/projects/it-android-0/src/main/java/it/android/AndroidSpecificClass.kt new file mode 100644 index 00000000..cb9046b1 --- /dev/null +++ b/integration-tests/gradle/projects/it-android-0/src/main/java/it/android/AndroidSpecificClass.kt @@ -0,0 +1,16 @@ +@file:Suppress("unused") + +package it.android + +import android.content.Context +import android.util.SparseIntArray +import android.view.View + +/** + * This class is specific to android and uses android classes like: + * [Context], [SparseIntArray] or [View] + */ +class AndroidSpecificClass { + fun sparseIntArray() = SparseIntArray() + fun createView(context: Context): View = View(context) +} diff --git a/integration-tests/gradle/projects/template.root.gradle.kts b/integration-tests/gradle/projects/template.root.gradle.kts index 1285375d..de516cb0 100644 --- a/integration-tests/gradle/projects/template.root.gradle.kts +++ b/integration-tests/gradle/projects/template.root.gradle.kts @@ -4,10 +4,14 @@ allprojects { jcenter() mavenLocal() mavenCentral() + google() } } afterEvaluate { logger.quiet("Gradle version: ${gradle.gradleVersion}") logger.quiet("Kotlin version: ${properties["dokka_it_kotlin_version"]}") + properties["dokka_it_android_gradle_plugin_version"]?.let { androidVersion -> + logger.quiet("Android version: $androidVersion") + } } diff --git a/integration-tests/gradle/projects/template.settings.gradle.kts b/integration-tests/gradle/projects/template.settings.gradle.kts index f28de32a..253c4e1b 100644 --- a/integration-tests/gradle/projects/template.settings.gradle.kts +++ b/integration-tests/gradle/projects/template.settings.gradle.kts @@ -2,9 +2,11 @@ pluginManagement { val dokka_it_kotlin_version: String by settings + val dokka_it_android_gradle_plugin_version: String? by settings plugins { id("org.jetbrains.kotlin.jvm") version dokka_it_kotlin_version + id("org.jetbrains.kotlin.android") version dokka_it_kotlin_version id("org.jetbrains.kotlin.multiplatform") version dokka_it_kotlin_version } @@ -13,6 +15,14 @@ pluginManagement { if (requested.id.id == "org.jetbrains.dokka") { useModule("org.jetbrains.dokka:dokka-gradle-plugin:for-integration-tests-SNAPSHOT") } + + if (requested.id.id == "com.android.library") { + useModule("com.android.tools.build:gradle:$dokka_it_android_gradle_plugin_version") + } + + if (requested.id.id == "com.android.application") { + useModule("com.android.tools.build:gradle:$dokka_it_android_gradle_plugin_version") + } } } repositories { @@ -21,5 +31,6 @@ pluginManagement { mavenCentral() jcenter() gradlePluginPortal() + google() } } diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt new file mode 100644 index 00000000..93d84e1f --- /dev/null +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt @@ -0,0 +1,69 @@ +package org.jetbrains.dokka.it.gradle + +import org.gradle.testkit.runner.TaskOutcome +import org.junit.Assume +import org.junit.runners.Parameterized.Parameters +import java.io.File +import kotlin.test.BeforeTest +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertNotNull + +class Android0GradleIntegrationTest(override val versions: BuildVersions) : AbstractGradleIntegrationTest() { + + companion object { + @get:JvmStatic + @get:Parameters(name = "{0}") + val versions = BuildVersions.permutations( + gradleVersions = listOf("6.5.1", "5.6.4"), + kotlinVersions = listOf("1.3.72", "1.4-M2-eap-70"), + androidGradlePluginVersions = listOf("3.5.3", "3.6.3") + ) + BuildVersions.permutations( + gradleVersions = listOf("6.5.1","6.1.1"), + kotlinVersions = listOf("1.3.72", "1.4-M2-eap-70"), + androidGradlePluginVersions = listOf("4.0.0") + ) + BuildVersions.permutations( + gradleVersions = listOf("6.5.1"), + kotlinVersions = listOf("1.3.72", "1.4-M2-eap-70"), + androidGradlePluginVersions = listOf("4.1.0-beta02") + ) + } + + @BeforeTest + fun assumeAndroidInstallation() { + val isCI = System.getenv("CI") != null + if (isCI) { + return + } + + val androidSdkRoot = System.getenv("ANDROID_SDK_ROOT") + val androidHome = System.getenv("ANDROID_HOME") + + val isAndroidSdkInstalled = androidSdkRoot != null || androidHome != null + + Assume.assumeTrue( + "Missing ANDROID_SDK_ROOT", + isAndroidSdkInstalled + ) + } + + @BeforeTest + fun prepareProjectFiles() { + val templateProjectDir = File("projects", "it-android-0") + + templateProjectDir.listFiles().orEmpty() + .filter { it.isFile } + .filterNot { it.name == "local.properties" } + .filterNot { it.name.startsWith("gradlew") } + .forEach { topLevelFile -> topLevelFile.copyTo(File(projectDir, topLevelFile.name)) } + + File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) + } + + @Test + fun execute() { + val result = createGradleRunner("dokka", "--stacktrace").build() + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome) + } + +} diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt new file mode 100644 index 00000000..c3adce4f --- /dev/null +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt @@ -0,0 +1,71 @@ +package org.jetbrains.dokka.it.gradle + +import org.gradle.testkit.runner.TaskOutcome +import org.junit.runners.Parameterized +import org.junit.runners.Parameterized.Parameters +import java.io.File +import kotlin.test.* + +class BasicGradleIntegrationTest(override val versions: BuildVersions) : AbstractGradleIntegrationTest() { + + companion object { + @get:JvmStatic + @get:Parameters(name = "{0}") + val versions = BuildVersions.permutations( + gradleVersions = listOf("6.5.1", "6.4.1", "6.3", "6.2.2", "6.1.1", "6.0", "5.6.4"), + kotlinVersions = listOf("1.3.30", "1.3.72", "1.4-M2-eap-70") + ) + } + + @BeforeTest + fun prepareProjectFiles() { + val templateProjectDir = File("projects", "it-basic") + + templateProjectDir.listFiles().orEmpty() + .filter { it.isFile } + .forEach { topLevelFile -> topLevelFile.copyTo(File(projectDir, topLevelFile.name)) } + + File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) + } + + @Test + fun execute() { + val result = createGradleRunner("dokka", "--stacktrace").build() + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome) + + val dokkaOutputDir = File(projectDir, "build/dokka") + assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") + + val imagesDir = File(dokkaOutputDir, "images") + assertTrue(imagesDir.isDirectory, "Missing images directory") + + val scriptsDir = File(dokkaOutputDir, "scripts") + assertTrue(scriptsDir.isDirectory, "Missing scripts directory") + + val stylesDir = File(dokkaOutputDir, "styles") + assertTrue(stylesDir.isDirectory, "Missing styles directory") + + val navigationHtml = File(dokkaOutputDir, "navigation.html") + assertTrue(navigationHtml.isFile, "Missing navigation.html") + + val moduleOutputDir = File(dokkaOutputDir, "it-basic") + assertTrue(moduleOutputDir.isDirectory, "Missing module directory") + + val moduleIndexHtml = File(moduleOutputDir, "index.html") + assertTrue(moduleIndexHtml.isFile, "Missing module index.html") + + val modulePackageDir = File(moduleOutputDir, "it.basic") + assertTrue(modulePackageDir.isDirectory, "Missing it.basic package directory") + + val modulePackageIndexHtml = File(modulePackageDir, "index.html") + assertTrue(modulePackageIndexHtml.isFile, "Missing module package index.html") + + val moduleJavaPackageDir = File(moduleOutputDir, "it.basic.java") + assertTrue(moduleJavaPackageDir.isDirectory, "Missing it.basic.java package directory") + + dokkaOutputDir.allHtmlFiles().forEach { file -> + assertContainsNoErrorClass(file) + assertNoUnresolvedLInks(file) + } + } +} diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt new file mode 100644 index 00000000..b54eecb1 --- /dev/null +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt @@ -0,0 +1,43 @@ +package org.jetbrains.dokka.it.gradle + +import org.gradle.testkit.runner.TaskOutcome +import org.gradle.util.GradleVersion +import org.junit.runners.Parameterized +import java.io.File +import kotlin.test.* + +class Multiplatform0GradleIntegrationTest(override val versions: BuildVersions) : AbstractGradleIntegrationTest() { + + companion object { + @get:JvmStatic + @get:Parameterized.Parameters(name = "{0}") + val versions = BuildVersions.permutations( + gradleVersions = listOf("6.5.1", "6.1.1"), + kotlinVersions = listOf("1.3.30", "1.3.72", "1.4-M2-eap-70") + ) + } + + @BeforeTest + fun prepareProjectFiles() { + val templateProjectDir = File("projects", "it-multiplatform-0") + templateProjectDir.listFiles().orEmpty() + .filter { it.isFile } + .forEach { topLevelFile -> topLevelFile.copyTo(File(projectDir, topLevelFile.name)) } + File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) + } + + @Test + fun execute() { + val result = createGradleRunner("dokka", "--stacktrace").build() + + assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome) + + val dokkaOutputDir = File(projectDir, "build/dokka") + assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") + + dokkaOutputDir.allHtmlFiles().forEach { file -> + assertContainsNoErrorClass(file) + assertNoUnresolvedLInks(file) + } + } +} diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt deleted file mode 100644 index 80737129..00000000 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt +++ /dev/null @@ -1,84 +0,0 @@ -package org.jetbrains.dokka.it.gradle - -import org.gradle.util.GradleVersion -import org.junit.Assume -import org.junit.Test - -abstract class AbstractDefaultVersionsGradleIntegrationTest( - private val minGradleVersion: GradleVersion? = null, - private val maxGradleVersion: GradleVersion? = null -) : AbstractGradleIntegrationTest() { - - protected abstract fun execute(versions: BuildVersions) - - private fun executeIfRequirementsAreMet(versions: BuildVersions) { - if (minGradleVersion != null) { - Assume.assumeTrue(versions.gradleVersion >= minGradleVersion) - } - if (maxGradleVersion != null) { - Assume.assumeTrue(versions.gradleVersion <= maxGradleVersion) - } - - execute(versions ) - } - - @Test - open fun `gradle 5_6_4 kotlin 1_3_72`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.3.72" - ) - ) - } - - @Test - open fun `gradle 5_6_4 kotlin 1_3_30`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.3.30" - ) - ) - } - - @Test - open fun `gradle 5_6_4 kotlin 1_4_M2_eap_70`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "5.6.4", - kotlinVersion = "1.4-M2-eap-70" - ) - ) - } - - @Test - open fun `gradle 6_1_1 kotlin 1_3_72`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "6.1.1", - kotlinVersion = "1.3.72" - ) - ) - } - - @Test - open fun `gradle 6_5_1 kotlin 1_4_M2_eap_70`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "6.5.1", - kotlinVersion = "1.4-M2-eap-70" - ) - ) - } - - @Test - open fun `gradle 6_5_1 kotlin 1_3_72`() { - executeIfRequirementsAreMet( - BuildVersions( - gradleVersion = "6.5.1", - kotlinVersion = "1.3.72" - ) - ) - } -} diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index e6b6b0eb..bb2d0cc6 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -1,21 +1,26 @@ package org.jetbrains.dokka.it.gradle import org.gradle.testkit.runner.GradleRunner +import org.gradle.testkit.runner.internal.DefaultGradleRunner import org.junit.Rule import org.junit.rules.TemporaryFolder +import org.junit.runner.RunWith +import org.junit.runners.Parameterized import java.io.File import kotlin.test.BeforeTest +import kotlin.test.Test import kotlin.test.assertFalse +@RunWith(Parameterized::class) abstract class AbstractGradleIntegrationTest { + abstract val versions: BuildVersions + @get:Rule val temporaryTestFolder = TemporaryFolder() val projectDir get() = File(temporaryTestFolder.root, "project") - val projectPath get() = projectDir.toPath() - @BeforeTest fun copyTemplates() { File("projects").listFiles().orEmpty() @@ -25,19 +30,24 @@ abstract class AbstractGradleIntegrationTest { } fun createGradleRunner( - buildVersions: BuildVersions, arguments: Array + vararg arguments: String ): GradleRunner { return GradleRunner.create() .withProjectDir(projectDir) - .withGradleVersion(buildVersions.gradleVersion.version) + .withGradleVersion(versions.gradleVersion.version) .forwardOutput() + .withTestKitDir(File("build", "gradle-test-kit").absoluteFile) .withArguments( - "-Pkotlin_version=${buildVersions.kotlinVersion}", - "-Pdokka_it_kotlin_version=${buildVersions.kotlinVersion}", - * arguments - ) - .withDebug(true) - + listOfNotNull( + "-Pkotlin_version=${versions.kotlinVersion}", + "-Pdokka_it_kotlin_version=${versions.kotlinVersion}", + versions.androidGradlePluginVersion?.let { androidVersion -> + "-Pdokka_it_android_gradle_plugin_version=$androidVersion" + }, + * arguments + ) + ).run { this as DefaultGradleRunner } + .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=512M") } fun File.allDescendentsWithExtension(extension: String): Sequence { diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt index 2fdd0368..84a7f1e8 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt @@ -4,13 +4,45 @@ import org.gradle.util.GradleVersion data class BuildVersions( val gradleVersion: GradleVersion, - val kotlinVersion: String + val kotlinVersion: String, + val androidGradlePluginVersion: String? = null, ) { constructor( gradleVersion: String, - kotlinVersion: String + kotlinVersion: String, + androidGradlePluginVersion: String? = null ) : this( gradleVersion = GradleVersion.version(gradleVersion), - kotlinVersion = kotlinVersion + kotlinVersion = kotlinVersion, + androidGradlePluginVersion = androidGradlePluginVersion ) + + override fun toString(): String { + return buildString { + append("Gradle ${gradleVersion.version}, Kotlin $kotlinVersion") + if (androidGradlePluginVersion != null) { + append(", Android $androidGradlePluginVersion") + } + } + } + + companion object { + fun permutations( + gradleVersions: List, + kotlinVersions: List, + androidGradlePluginVersions: List = listOf(null) + ): List { + return gradleVersions.distinct().flatMap { gradleVersion -> + kotlinVersions.distinct().flatMap { kotlinVersion -> + androidGradlePluginVersions.distinct().map { androidVersion -> + BuildVersions( + gradleVersion = gradleVersion, + kotlinVersion = kotlinVersion, + androidGradlePluginVersion = androidVersion + ) + } + } + } + } + } } diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt deleted file mode 100644 index 2516b151..00000000 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt +++ /dev/null @@ -1,29 +0,0 @@ -package org.jetbrains.dokka.it.gradle - -import java.io.IOException -import java.nio.file.* -import java.nio.file.attribute.BasicFileAttributes - -fun Path.copy(to: Path) { - Files.walkFileTree(this, CopyFileVisitor(this, to)) -} - -class CopyFileVisitor(private var sourcePath: Path, private val targetPath: Path) : SimpleFileVisitor() { - @Throws(IOException::class) - override fun preVisitDirectory( - dir: Path, - attrs: BasicFileAttributes - ): FileVisitResult { - Files.createDirectories(targetPath.resolve(sourcePath.relativize(dir))) - return FileVisitResult.CONTINUE - } - - @Throws(IOException::class) - override fun visitFile( - file: Path, - attrs: BasicFileAttributes - ): FileVisitResult { - Files.copy(file, targetPath.resolve(sourcePath.relativize(file)), StandardCopyOption.REPLACE_EXISTING) - return FileVisitResult.CONTINUE - } -} diff --git a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt deleted file mode 100644 index b4d9e82c..00000000 --- a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt +++ /dev/null @@ -1,62 +0,0 @@ -package org.jetbrains.dokka.it.gradle - -import org.gradle.testkit.runner.TaskOutcome -import java.io.File -import kotlin.test.* - -class BasicGradleIntegrationTest : AbstractDefaultVersionsGradleIntegrationTest() { - - @BeforeTest - fun prepareProjectFiles() { - val templateProjectDir = File("projects", "it-basic") - - templateProjectDir.listFiles().orEmpty() - .filter { it.isFile } - .forEach { topLevelFile -> topLevelFile.copyTo(File(projectDir, topLevelFile.name)) } - - File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) - } - - override fun execute(versions: BuildVersions) { - val result = createGradleRunner( - buildVersions = versions, - arguments = arrayOf("dokka", "--stacktrace") - ).build() - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome) - - val dokkaOutputDir = File(projectDir, "build/dokka") - assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") - - val imagesDir = File(dokkaOutputDir, "images") - assertTrue(imagesDir.isDirectory, "Missing images directory") - - val scriptsDir = File(dokkaOutputDir, "scripts") - assertTrue(scriptsDir.isDirectory, "Missing scripts directory") - - val stylesDir = File(dokkaOutputDir, "styles") - assertTrue(stylesDir.isDirectory, "Missing styles directory") - - val navigationHtml = File(dokkaOutputDir, "navigation.html") - assertTrue(navigationHtml.isFile, "Missing navigation.html") - - val moduleOutputDir = File(dokkaOutputDir, "it-basic") - assertTrue(moduleOutputDir.isDirectory, "Missing module directory") - - val moduleIndexHtml = File(moduleOutputDir, "index.html") - assertTrue(moduleIndexHtml.isFile, "Missing module index.html") - - val modulePackageDir = File(moduleOutputDir, "it.basic") - assertTrue(modulePackageDir.isDirectory, "Missing it.basic package directory") - - val modulePackageIndexHtml = File(modulePackageDir, "index.html") - assertTrue(modulePackageIndexHtml.isFile, "Missing module package index.html") - - val moduleJavaPackageDir = File(moduleOutputDir, "it.basic.java") - assertTrue(moduleJavaPackageDir.isDirectory, "Missing it.basic.java package directory") - - dokkaOutputDir.allHtmlFiles().forEach { file -> - assertContainsNoErrorClass(file) - assertNoUnresolvedLInks(file) - } - } -} diff --git a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt b/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt deleted file mode 100644 index a0f6be24..00000000 --- a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt +++ /dev/null @@ -1,41 +0,0 @@ -package org.jetbrains.dokka.it.gradle - -import org.gradle.testkit.runner.TaskOutcome -import org.gradle.util.GradleVersion -import java.io.File -import kotlin.test.BeforeTest -import kotlin.test.assertEquals -import kotlin.test.assertNotNull -import kotlin.test.assertTrue - -class Multiplatform0GradleIntegrationTest : AbstractDefaultVersionsGradleIntegrationTest( - minGradleVersion = GradleVersion.version("6.0.0") -) { - - @BeforeTest - fun prepareProjectFiles() { - val templateProjectDir = File("projects", "it-multiplatform-0") - templateProjectDir.listFiles().orEmpty() - .filter { it.isFile } - .forEach { topLevelFile -> topLevelFile.copyTo(File(projectDir, topLevelFile.name)) } - File(templateProjectDir, "src").copyRecursively(File(projectDir, "src")) - } - - override fun execute(versions: BuildVersions) { - val result = createGradleRunner( - buildVersions = versions, - arguments = arrayOf("dokka", "--stacktrace") - ).build() - - assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome) - - val dokkaOutputDir = File(projectDir, "build/dokka") - assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") - - dokkaOutputDir.allHtmlFiles().forEach { file -> - assertContainsNoErrorClass(file) - assertNoUnresolvedLInks(file) - } - } - -} diff --git a/settings.gradle.kts b/settings.gradle.kts index a9d8d852..e634c7d2 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -17,6 +17,7 @@ include("plugins:gfm") include("plugins:jekyll") include("plugins:kotlin-as-java") include("plugins:javadoc") +include("integration-tests") include("integration-tests:gradle-integration-tests") include("integration-tests:gradle") -- cgit From cb20227d354b1b74ca6784d55ea75cc8b5281abd Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 7 Jul 2020 11:08:34 +0200 Subject: Implement simple cli integration test --- .idea/codeStyles/Project.xml | 16 +++++ integration-tests/build.gradle.kts | 10 +++ integration-tests/cli/build.gradle.kts | 39 ++++++++++ .../main/java/it/basic/java/SampleJavaClass.java | 17 +++++ .../it-cli/src/main/kotlin/it/basic/PublicClass.kt | 48 +++++++++++++ .../jetbrains/dokka/it/cli/CliIntegrationTest.kt | 82 ++++++++++++++++++++++ .../dokka/it/cli/AbstractCliIntegrationTest.kt | 36 ++++++++++ .../org/jetbrains/dokka/it/cli/processUtils.kt | 51 ++++++++++++++ .../it/gradle/AbstractGradleIntegrationTest.kt | 37 +--------- .../jetbrains/dokka/it/AbstractIntegrationTest.kt | 39 ++++++++++ runners/cli/src/main/kotlin/cli/main.kt | 10 +-- settings.gradle.kts | 1 + 12 files changed, 346 insertions(+), 40 deletions(-) create mode 100644 integration-tests/cli/build.gradle.kts create mode 100644 integration-tests/cli/projects/it-cli/src/main/java/it/basic/java/SampleJavaClass.java create mode 100644 integration-tests/cli/projects/it-cli/src/main/kotlin/it/basic/PublicClass.kt create mode 100644 integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt create mode 100644 integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt create mode 100644 integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt create mode 100644 integration-tests/src/main/kotlin/org/jetbrains/dokka/it/AbstractIntegrationTest.kt (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml index 1bec35e5..31d977a0 100644 --- a/.idea/codeStyles/Project.xml +++ b/.idea/codeStyles/Project.xml @@ -1,6 +1,22 @@ + + diff --git a/integration-tests/build.gradle.kts b/integration-tests/build.gradle.kts index ec9b4004..44da74cf 100644 --- a/integration-tests/build.gradle.kts +++ b/integration-tests/build.gradle.kts @@ -5,6 +5,7 @@ subprojects { runtimeClasspath += sourceSets.main.get().output } } + configurations.getByName("integrationTestImplementation") { extendsFrom(configurations.implementation.get()) } @@ -13,6 +14,10 @@ subprojects { extendsFrom(configurations.runtimeOnly.get()) } + dependencies { + implementation(project(":integration-tests")) + } + val integrationTest = task("integrationTest") { maxHeapSize = "2G" description = "Runs integration tests." @@ -28,3 +33,8 @@ subprojects { dependsOn(integrationTest) } } + +dependencies { + implementation(kotlin("stdlib")) + implementation(kotlin("test-junit")) +} diff --git a/integration-tests/cli/build.gradle.kts b/integration-tests/cli/build.gradle.kts new file mode 100644 index 00000000..c3e98d0a --- /dev/null +++ b/integration-tests/cli/build.gradle.kts @@ -0,0 +1,39 @@ +import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar + + +plugins { + id("com.github.johnrengelman.shadow") +} + +val dokka_version: String by project +evaluationDependsOn(":runners:cli") +evaluationDependsOn(":plugins:base") + +dependencies { + implementation(kotlin("stdlib")) + implementation(kotlin("test-junit")) + + val coroutines_version: String by project + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version") + +} + +/* Create a fat base plugin jar for cli tests */ +val basePluginShadow: Configuration by configurations.creating +dependencies { + basePluginShadow(project(":plugins:base")) +} +val basePluginShadowJar = tasks.create("basePluginShadowJar", ShadowJar::class) { + configurations = listOf(basePluginShadow) + archiveFileName.set("fat-base-plugin-$dokka_version.jar") + archiveClassifier.set("") +} + +tasks.integrationTest { + val cliJar = tasks.getByPath(":runners:cli:shadowJar") as ShadowJar + environment("CLI_JAR_PATH", cliJar.archiveFile.get()) + environment("BASE_PLUGIN_JAR_PATH", basePluginShadowJar.archiveFile.get()) + dependsOn(cliJar) + dependsOn(basePluginShadowJar) +} + diff --git a/integration-tests/cli/projects/it-cli/src/main/java/it/basic/java/SampleJavaClass.java b/integration-tests/cli/projects/it-cli/src/main/java/it/basic/java/SampleJavaClass.java new file mode 100644 index 00000000..23b0202c --- /dev/null +++ b/integration-tests/cli/projects/it-cli/src/main/java/it/basic/java/SampleJavaClass.java @@ -0,0 +1,17 @@ +package it.basic.java; + +import it.basic.PublicClass; + +/** + * This class is, unlike {@link PublicClass}, written in Java + */ +@SuppressWarnings("unused") +public class SampleJavaClass { + + /** + * @return Empty instance of {@link PublicClass} + */ + public PublicClass publicDocumentedFunction() { + return new PublicClass(); + } +} diff --git a/integration-tests/cli/projects/it-cli/src/main/kotlin/it/basic/PublicClass.kt b/integration-tests/cli/projects/it-cli/src/main/kotlin/it/basic/PublicClass.kt new file mode 100644 index 00000000..71bc7e63 --- /dev/null +++ b/integration-tests/cli/projects/it-cli/src/main/kotlin/it/basic/PublicClass.kt @@ -0,0 +1,48 @@ +@file:Suppress("unused") + +package it.basic + +class PublicClass { + /** + * This function is public and documented + */ + fun publicDocumentedFunction(): String = "" + + fun publicUndocumentedFunction(): String = "" + + /** + * This function is internal and documented + */ + internal fun internalDocumentedFunction(): String = "" + + internal fun internalUndocumentedFunction(): String = "" + + /** + * This function is private and documented + */ + private fun privateDocumentedFunction(): String = "" + + private fun privateUndocumentedFunction(): String = "" + + + /** + * This property is public and documented + */ + val publicDocumentedProperty: Int = 0 + + val publicUndocumentedProperty: Int = 0 + + /** + * This property internal and documented + */ + val internalDocumentedProperty: Int = 0 + + val internalUndocumentedProperty: Int = 0 + + /** + * This property private and documented + */ + private val privateDocumentedProperty: Int = 0 + + private val privateUndocumentedProperty: Int = 0 +} diff --git a/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt b/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt new file mode 100644 index 00000000..5e24c1cd --- /dev/null +++ b/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt @@ -0,0 +1,82 @@ +package org.jetbrains.dokka.it.cli + +import java.io.File +import kotlin.test.BeforeTest +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue + +class CliIntegrationTest : AbstractCliIntegrationTest() { + + @BeforeTest + fun copyProject() { + val templateProjectDir = File("projects", "it-cli") + templateProjectDir.copyRecursively(projectDir) + } + + @Test + fun runHelp() { + val process = ProcessBuilder("java", "-jar", cliJarFile.path, "-h") + .redirectErrorStream(true) + .start() + + val result = process.awaitProcessResult() + assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)") + assertTrue("Usage: " in result.output) + } + + @Test + fun runCli() { + val dokkaOutputDir = File(projectDir, "output") + assertTrue(dokkaOutputDir.mkdirs()) + val process = ProcessBuilder( + "java", "-jar", cliJarFile.path, + "-outputDir", dokkaOutputDir.path, + "-format", "html", + "-pluginsClasspath", basePluginJarFile.path, + "-sourceSet", + buildString { + append(" -moduleName it-cli") + append(" -moduleDisplayName CLI-Example") + append(" -sourceSetName cliMain") + append(" -src ${File(projectDir, "src").path}") + append(" -jdkVersion 8") + append(" -analysisPlatform jvm") + append(" -reportUndocumented") + append(" -skipDeprecated") + } + ) + .redirectErrorStream(true) + .start() + + val result = process.awaitProcessResult() + assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)") + + val extensionLoadedRegex = Regex("""Extension: org\.jetbrains\.dokka\.base\.DokkaBase""") + val amountOfExtensionsLoaded = extensionLoadedRegex.findAll(result.output).count() + + assertTrue( + amountOfExtensionsLoaded > 10, + "Expected more than 10 extensions being present (found $amountOfExtensionsLoaded)" + ) + + assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory") + + val imagesDir = File(dokkaOutputDir, "images") + assertTrue(imagesDir.isDirectory, "Missing images directory") + + val scriptsDir = File(dokkaOutputDir, "scripts") + assertTrue(scriptsDir.isDirectory, "Missing scripts directory") + + val stylesDir = File(dokkaOutputDir, "styles") + assertTrue(stylesDir.isDirectory, "Missing styles directory") + + val navigationHtml = File(dokkaOutputDir, "navigation.html") + assertTrue(navigationHtml.isFile, "Missing navigation.html") + + projectDir.allHtmlFiles().forEach { file -> + assertContainsNoErrorClass(file) + assertNoUnresolvedLInks(file) + } + } +} diff --git a/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt b/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt new file mode 100644 index 00000000..7f6f9433 --- /dev/null +++ b/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt @@ -0,0 +1,36 @@ +package org.jetbrains.dokka.it.cli + +import org.jetbrains.dokka.it.AbstractIntegrationTest +import java.io.File +import kotlin.test.BeforeTest +import kotlin.test.assertTrue + +abstract class AbstractCliIntegrationTest : AbstractIntegrationTest() { + + protected val cliJarFile: File by lazy { + File(temporaryTestFolder.root, "dokka.jar") + } + + protected val basePluginJarFile: File by lazy { + File(temporaryTestFolder.root, "base-plugin.jar") + } + + @BeforeTest + fun copyJarFiles() { + val cliJarPathEnvironmentKey = "CLI_JAR_PATH" + val cliJarFile = File(System.getenv(cliJarPathEnvironmentKey)) + assertTrue( + cliJarFile.exists() && cliJarFile.isFile, + "Missing path to CLI jar System.getenv($cliJarPathEnvironmentKey)" + ) + cliJarFile.copyTo(this.cliJarFile) + + val basePluginPathEnvironmentKey = "BASE_PLUGIN_JAR_PATH" + val basePluginJarFile = File(System.getenv(basePluginPathEnvironmentKey)) + assertTrue( + basePluginJarFile.exists() && basePluginJarFile.isFile, + "Missing path to base plugin jar System.getenv($basePluginPathEnvironmentKey)" + ) + basePluginJarFile.copyTo(this.basePluginJarFile) + } +} diff --git a/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt b/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt new file mode 100644 index 00000000..d2fa3b31 --- /dev/null +++ b/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt @@ -0,0 +1,51 @@ +package org.jetbrains.dokka.it.cli + +import kotlinx.coroutines.CompletableDeferred +import kotlinx.coroutines.async +import kotlinx.coroutines.runBlocking +import kotlin.concurrent.thread + +class ProcessResult( + val exitCode: Int, + val output: String +) + +fun Process.awaitProcessResult() = runBlocking { + val exitCode = async { awaitExitCode() } + val output = async { awaitOutput() } + ProcessResult( + exitCode.await(), + output.await() + ) +} + +private suspend fun Process.awaitExitCode(): Int { + val deferred = CompletableDeferred() + thread { + try { + deferred.complete(this.waitFor()) + } catch (e: Throwable) { + deferred.completeExceptionally(e) + } + } + + return deferred.await() +} + +private suspend fun Process.awaitOutput(): String { + val deferred = CompletableDeferred() + thread { + try { + var string = "" + this.inputStream.bufferedReader().forEachLine { line -> + println(line) + string += line + System.lineSeparator() + } + deferred.complete(string) + } catch (e: Throwable) { + deferred.completeExceptionally(e) + } + } + + return deferred.await() +} diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index bb2d0cc6..c8c8c844 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -2,25 +2,17 @@ package org.jetbrains.dokka.it.gradle import org.gradle.testkit.runner.GradleRunner import org.gradle.testkit.runner.internal.DefaultGradleRunner -import org.junit.Rule -import org.junit.rules.TemporaryFolder +import org.jetbrains.dokka.it.AbstractIntegrationTest import org.junit.runner.RunWith import org.junit.runners.Parameterized import java.io.File import kotlin.test.BeforeTest -import kotlin.test.Test -import kotlin.test.assertFalse @RunWith(Parameterized::class) -abstract class AbstractGradleIntegrationTest { +abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() { abstract val versions: BuildVersions - @get:Rule - val temporaryTestFolder = TemporaryFolder() - - val projectDir get() = File(temporaryTestFolder.root, "project") - @BeforeTest fun copyTemplates() { File("projects").listFiles().orEmpty() @@ -49,30 +41,5 @@ abstract class AbstractGradleIntegrationTest { ).run { this as DefaultGradleRunner } .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=512M") } - - fun File.allDescendentsWithExtension(extension: String): Sequence { - return this.walkTopDown().filter { it.isFile && it.extension == extension } - } - - fun File.allHtmlFiles(): Sequence { - return allDescendentsWithExtension("html") - } - - protected fun assertContainsNoErrorClass(file: File) { - val fileText = file.readText() - assertFalse( - fileText.contains("ERROR CLASS", ignoreCase = true), - "Unexpected `ERROR CLASS` in ${file.path}\n" + fileText - ) - } - - protected fun assertNoUnresolvedLInks(file: File) { - val regex = Regex("[\"']#[\"']") - val fileText = file.readText() - assertFalse( - fileText.contains(regex), - "Unexpected unresolved link in ${file.path}\n" + fileText - ) - } } diff --git a/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/AbstractIntegrationTest.kt b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/AbstractIntegrationTest.kt new file mode 100644 index 00000000..4af523a2 --- /dev/null +++ b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/AbstractIntegrationTest.kt @@ -0,0 +1,39 @@ +package org.jetbrains.dokka.it + +import org.junit.Rule +import org.junit.rules.TemporaryFolder +import java.io.File +import kotlin.test.assertFalse + +abstract class AbstractIntegrationTest { + + @get:Rule + val temporaryTestFolder = TemporaryFolder() + + val projectDir get() = File(temporaryTestFolder.root, "project") + + fun File.allDescendentsWithExtension(extension: String): Sequence { + return this.walkTopDown().filter { it.isFile && it.extension == extension } + } + + fun File.allHtmlFiles(): Sequence { + return allDescendentsWithExtension("html") + } + + protected fun assertContainsNoErrorClass(file: File) { + val fileText = file.readText() + assertFalse( + fileText.contains("ERROR CLASS", ignoreCase = true), + "Unexpected `ERROR CLASS` in ${file.path}\n" + fileText + ) + } + + protected fun assertNoUnresolvedLInks(file: File) { + val regex = Regex("[\"']#[\"']") + val fileText = file.readText() + assertFalse( + fileText.contains(regex), + "Unexpected unresolved link in ${file.path}\n" + fileText + ) + } +} diff --git a/runners/cli/src/main/kotlin/cli/main.kt b/runners/cli/src/main/kotlin/cli/main.kt index 5e5cd6b2..d284e653 100644 --- a/runners/cli/src/main/kotlin/cli/main.kt +++ b/runners/cli/src/main/kotlin/cli/main.kt @@ -118,7 +118,7 @@ private fun parseSourceSet(args: Array): DokkaConfiguration.DokkaSourceS val moduleName by parser.option( ArgType.String, description = "Name of the documentation module", - fullName = "module" + fullName = "moduleName" ).required() val moduleDisplayName by parser.option( @@ -126,12 +126,12 @@ private fun parseSourceSet(args: Array): DokkaConfiguration.DokkaSourceS description = "Name of the documentation module" ) - val name by parser.option( + val sourceSetName by parser.option( ArgType.String, description = "Name of the source set" ).default("main") - val displayName by parser.option( + val sourceSetDisplayName by parser.option( ArgType.String, description = "Displayed name of the source set" ).default("JVM") @@ -235,8 +235,8 @@ private fun parseSourceSet(args: Array): DokkaConfiguration.DokkaSourceS return object : DokkaConfiguration.DokkaSourceSet { override val moduleDisplayName = moduleDisplayName ?: moduleName - override val displayName = displayName - override val sourceSetID = DokkaSourceSetID(moduleName, name) + override val displayName = sourceSetDisplayName + override val sourceSetID = DokkaSourceSetID(moduleName, sourceSetName) override val classpath = classpath override val sourceRoots = sourceRoots.map { SourceRootImpl(it.toAbsolutePath()) } override val dependentSourceSets: Set = dependentSourceSets diff --git a/settings.gradle.kts b/settings.gradle.kts index 969bb53f..54245a96 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -19,6 +19,7 @@ include("plugins:kotlin-as-java") include("plugins:javadoc") include("integration-tests") include("integration-tests:gradle") +include("integration-tests:cli") pluginManagement { val kotlin_version: String by settings -- cgit From 03c629b415fd98dea279ce86e11ed1823b504183 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 7 Jul 2020 11:27:12 +0200 Subject: Increase test memory --- .../org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt | 2 +- plugins/base/build.gradle.kts | 4 ++++ 2 files changed, 5 insertions(+), 1 deletion(-) (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index c8c8c844..f2dece62 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -39,7 +39,7 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() { * arguments ) ).run { this as DefaultGradleRunner } - .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=512M") + .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=1G") } } diff --git a/plugins/base/build.gradle.kts b/plugins/base/build.gradle.kts index d90385b5..cc34fce9 100644 --- a/plugins/base/build.gradle.kts +++ b/plugins/base/build.gradle.kts @@ -23,6 +23,10 @@ tasks { processResources { dependsOn("copy_frontend") } + + test { + maxHeapSize = "4G" + } } publishing { -- cgit From 90459de7b6fce28a8ba57aca5eb213575204bc3d Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Mon, 15 Jun 2020 18:13:35 +0200 Subject: Update to Kotlin 1.4 M3 --- gradle.properties | 6 +++--- integration-tests/cli/build.gradle.kts | 7 ++++++- .../org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt | 1 - .../kotlin/org/jetbrains/dokka/analysis/AnalysisEnvironment.kt | 4 ++++ .../kotlin/org/jetbrains/dokka/analysis/EnvironmentAndFacade.kt | 7 ++----- plugins/base/build.gradle.kts | 2 +- plugins/javadoc/build.gradle.kts | 3 +++ 7 files changed, 19 insertions(+), 11 deletions(-) (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/gradle.properties b/gradle.properties index edd78940..f0c75c72 100644 --- a/gradle.properties +++ b/gradle.properties @@ -2,9 +2,9 @@ dokka_version_base=0.11.0 dokka_publication_channel=dokka # Kotlin compiler and plugin -kotlin_version=1.4-M2-eap-70 -kotlin_plugin_version=1.4-M2-eap-63 -coroutines_version=1.3.7-1.4-M2 +kotlin_version=1.4-M3-eap-197 +kotlin_plugin_version=1.4-M3-release-207 +coroutines_version=1.3.7-1.4-M3 idea_version=193.6494.35 language_version=1.4 diff --git a/integration-tests/cli/build.gradle.kts b/integration-tests/cli/build.gradle.kts index f825a148..5fdf0ff5 100644 --- a/integration-tests/cli/build.gradle.kts +++ b/integration-tests/cli/build.gradle.kts @@ -19,7 +19,12 @@ dependencies { } /* Create a fat base plugin jar for cli tests */ -val basePluginShadow: Configuration by configurations.creating +val basePluginShadow: Configuration by configurations.creating { + attributes { + attribute(Usage.USAGE_ATTRIBUTE, project.objects.named(Usage::class.java, "java-runtime")) + } +} + dependencies { basePluginShadow(project(":plugins:base")) } diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index f2dece62..2ba49a5a 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -42,4 +42,3 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() { .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=1G") } } - diff --git a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/AnalysisEnvironment.kt b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/AnalysisEnvironment.kt index 7836bde9..43bb9e48 100644 --- a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/AnalysisEnvironment.kt +++ b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/AnalysisEnvironment.kt @@ -633,4 +633,8 @@ class DokkaResolutionFacade( throw UnsupportedOperationException() } + override fun getResolverForProject(): ResolverForProject { + throw UnsupportedOperationException() + } + } diff --git a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/EnvironmentAndFacade.kt b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/EnvironmentAndFacade.kt index a12becee..d9a89194 100644 --- a/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/EnvironmentAndFacade.kt +++ b/kotlin-analysis/src/main/kotlin/org/jetbrains/dokka/analysis/EnvironmentAndFacade.kt @@ -3,10 +3,7 @@ package org.jetbrains.dokka.analysis import org.jetbrains.dokka.DokkaConfiguration import org.jetbrains.dokka.Platform import org.jetbrains.dokka.utilities.DokkaLogger -import org.jetbrains.kotlin.cli.common.messages.CompilerMessageLocation -import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity -import org.jetbrains.kotlin.cli.common.messages.MessageCollector -import org.jetbrains.kotlin.cli.common.messages.MessageRenderer +import org.jetbrains.kotlin.cli.common.messages.* import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment import org.jetbrains.kotlin.utils.PathUtil import java.io.File @@ -42,7 +39,7 @@ class DokkaMessageCollector(private val logger: DokkaLogger) : MessageCollector private var seenErrors = false - override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageLocation?) { + override fun report(severity: CompilerMessageSeverity, message: String, location: CompilerMessageSourceLocation?) { if (severity == CompilerMessageSeverity.ERROR) { seenErrors = true } diff --git a/plugins/base/build.gradle.kts b/plugins/base/build.gradle.kts index cc34fce9..02babd4d 100644 --- a/plugins/base/build.gradle.kts +++ b/plugins/base/build.gradle.kts @@ -6,7 +6,7 @@ plugins { dependencies { val coroutines_version: String by project - // implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version") // TODO: Enable this dependency after update to 1.4-M3 + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version") api(project(":kotlin-analysis")) implementation("org.jsoup:jsoup:1.12.1") diff --git a/plugins/javadoc/build.gradle.kts b/plugins/javadoc/build.gradle.kts index 1f39c3a1..4c5c22b0 100644 --- a/plugins/javadoc/build.gradle.kts +++ b/plugins/javadoc/build.gradle.kts @@ -15,6 +15,9 @@ dependencies { implementation("org.jetbrains.kotlinx:kotlinx-html-jvm:0.6.10") implementation(project(":plugins:base")) implementation(project(":plugins:kotlin-as-java")) + + val coroutines_version: String by project + implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version") } configureBintrayPublication("javadocPlugin") -- cgit From 5b99af982f3430910e9ee4eaf3499cc636884167 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Fri, 10 Jul 2020 14:52:06 +0200 Subject: Further increase memory for integration tests --- .../org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index 2ba49a5a..5b3e3250 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -39,6 +39,6 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() { * arguments ) ).run { this as DefaultGradleRunner } - .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=1G") + .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=2G") } } -- cgit From 2c9fe4c22e13f4d84f4085563715162fcdf2ec85 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 14 Jul 2020 14:55:46 +0200 Subject: Implement GradleRunner.buildRelaxed API --- .../it/gradle/Android0GradleIntegrationTest.kt | 2 +- .../dokka/it/gradle/BasicGradleIntegrationTest.kt | 3 ++- .../dokka/it/gradle/BasicGroovyIntegrationTest.kt | 4 ++- .../dokka/it/gradle/Multimodule0IntegrationTest.kt | 2 +- .../gradle/Multiplatform0GradleIntegrationTest.kt | 2 +- .../it/gradle/AbstractGradleIntegrationTest.kt | 30 ++++++++++++++++++++++ 6 files changed, 38 insertions(+), 5 deletions(-) (limited to 'integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka') diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt index 52dc6f0c..19235597 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt @@ -51,7 +51,7 @@ class Android0GradleIntegrationTest(override val versions: BuildVersions) : Abst @Test fun execute() { - val result = createGradleRunner("dokkaHtml", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "--stacktrace").buildRelaxed() assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) val htmlOutputDir = File(projectDir, "build/dokka/html") diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt index 5e23a753..c9c45d58 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt @@ -29,7 +29,8 @@ class BasicGradleIntegrationTest(override val versions: BuildVersions) : Abstrac @Test fun execute() { - val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace") + .buildRelaxed() assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJavadoc")).outcome) diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt index 7a620d9c..b20a7b2d 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGroovyIntegrationTest.kt @@ -19,6 +19,7 @@ class BasicGroovyIntegrationTest(override val versions: BuildVersions) : Abstrac kotlinVersions = listOf("1.4-M2-eap-70") ) } + @BeforeTest fun prepareProjectFiles() { val templateProjectDir = File("projects", "it-basic-groovy") @@ -32,7 +33,8 @@ class BasicGroovyIntegrationTest(override val versions: BuildVersions) : Abstrac @Test fun execute() { - val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "dokkaJavadoc", "dokkaGfm", "dokkaJekyll", "--stacktrace") + .buildRelaxed() assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaJavadoc")).outcome) diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt index 821ae08b..50ae22f9 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multimodule0IntegrationTest.kt @@ -26,7 +26,7 @@ class Multimodule0IntegrationTest(override val versions: BuildVersions) : Abstra @Test fun execute() { - val result = createGradleRunner(":moduleA:dokkaHtmlMultimodule", "--stacktrace").build() + val result = createGradleRunner(":moduleA:dokkaHtmlMultimodule", "--stacktrace").buildRelaxed() assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":moduleA:dokkaHtmlMultimodule")).outcome) diff --git a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt index 0a8c4fe0..3e254dd0 100644 --- a/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt +++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt @@ -27,7 +27,7 @@ class Multiplatform0GradleIntegrationTest(override val versions: BuildVersions) @Test fun execute() { - val result = createGradleRunner("dokkaHtml", "--stacktrace").build() + val result = createGradleRunner("dokkaHtml", "--stacktrace").buildRelaxed() assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokkaHtml")).outcome) diff --git a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt index 5b3e3250..f852dc8b 100644 --- a/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt +++ b/integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt @@ -1,8 +1,13 @@ package org.jetbrains.dokka.it.gradle +import org.gradle.testkit.runner.BuildResult import org.gradle.testkit.runner.GradleRunner import org.gradle.testkit.runner.internal.DefaultGradleRunner +import org.gradle.tooling.GradleConnectionException import org.jetbrains.dokka.it.AbstractIntegrationTest +import org.junit.Assume +import org.junit.Assume.assumeFalse +import org.junit.AssumptionViolatedException import org.junit.runner.RunWith import org.junit.runners.Parameterized import java.io.File @@ -41,4 +46,29 @@ abstract class AbstractGradleIntegrationTest : AbstractIntegrationTest() { ).run { this as DefaultGradleRunner } .withJvmArguments("-Xmx4G", "-XX:MaxMetaspaceSize=2G") } + + fun GradleRunner.buildRelaxed(): BuildResult { + return try { + build() + } catch (e: Throwable) { + val gradleConnectionException = e.withAllCauses().find { it is GradleConnectionException } + if (gradleConnectionException != null) { + gradleConnectionException.printStackTrace() + throw AssumptionViolatedException("Assumed Gradle connection", gradleConnectionException) + + } + throw e + } + } +} + +private fun Throwable.withAllCauses(): Sequence { + val root = this + return sequence { + yield(root) + val cause = root.cause + if (cause != null && cause != root) { + yieldAll(cause.withAllCauses()) + } + } } -- cgit