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 --- integration-tests/gradle/build.gradle.kts | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 integration-tests/gradle/build.gradle.kts (limited to 'integration-tests/gradle/build.gradle.kts') diff --git a/integration-tests/gradle/build.gradle.kts b/integration-tests/gradle/build.gradle.kts new file mode 100644 index 00000000..3f5baa7b --- /dev/null +++ b/integration-tests/gradle/build.gradle.kts @@ -0,0 +1,14 @@ +dependencies { + implementation(kotlin("stdlib")) + implementation(kotlin("test-junit")) + implementation(gradleTestKit()) +} + +tasks { + test { + inputs.dir(file("projects")) + rootProject.allprojects + .mapNotNull { project -> project.tasks.findByName("publishToMavenLocal") } + .forEach { publishTask -> this.dependsOn(publishTask) } + } +} -- cgit From 2e02e56818609c683f95ba4f17fa749eb9e1c705 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Wed, 1 Jul 2020 16:38:56 +0200 Subject: runner:gradle-plugin: Apply `java-gradle-plugin` --- core/build.gradle.kts | 13 ++++++++++ core/src/main/kotlin/DokkaVersion.kt | 10 ++++++++ .../META-INF/dokka/dokka-version.properties | 1 + integration-tests/gradle/build.gradle.kts | 1 + .../gradle/projects/it-basic/build.gradle.kts | 2 +- .../gradle/projects/it-basic/gradle.properties | 2 -- .../gradle/projects/it-basic/settings.gradle.kts | 14 ++++------- runners/gradle-plugin/build.gradle.kts | 28 ++++++++++------------ .../main/kotlin/org/jetbrains/dokka/gradle/main.kt | 18 ++------------ 9 files changed, 44 insertions(+), 45 deletions(-) create mode 100644 core/src/main/kotlin/DokkaVersion.kt create mode 100644 core/src/main/resources/META-INF/dokka/dokka-version.properties delete mode 100644 integration-tests/gradle/projects/it-basic/gradle.properties (limited to 'integration-tests/gradle/build.gradle.kts') diff --git a/core/build.gradle.kts b/core/build.gradle.kts index fc62b73d..45ddccf3 100644 --- a/core/build.gradle.kts +++ b/core/build.gradle.kts @@ -21,6 +21,19 @@ val sourceJar by tasks.registering(Jar::class) { from(sourceSets["main"].allSource) } +tasks { + processResources { + val dokka_version: String by project + eachFile { + if (name == "dokka-version.properties") { + filter { line -> + line.replace("", dokka_version) + } + } + } + } +} + publishing { publications { register("dokkaCore") { diff --git a/core/src/main/kotlin/DokkaVersion.kt b/core/src/main/kotlin/DokkaVersion.kt new file mode 100644 index 00000000..410058f3 --- /dev/null +++ b/core/src/main/kotlin/DokkaVersion.kt @@ -0,0 +1,10 @@ +package org.jetbrains.dokka + +import java.util.* + +object DokkaVersion { + val version: String by lazy { + val stream = javaClass.getResourceAsStream("/META-INF/dokka/dokka-version.properties") + Properties().apply { load(stream) }.getProperty("dokka-version") + } +} diff --git a/core/src/main/resources/META-INF/dokka/dokka-version.properties b/core/src/main/resources/META-INF/dokka/dokka-version.properties new file mode 100644 index 00000000..6b2e2bcd --- /dev/null +++ b/core/src/main/resources/META-INF/dokka/dokka-version.properties @@ -0,0 +1 @@ +dokka-version= diff --git a/integration-tests/gradle/build.gradle.kts b/integration-tests/gradle/build.gradle.kts index 3f5baa7b..fb5e5739 100644 --- a/integration-tests/gradle/build.gradle.kts +++ b/integration-tests/gradle/build.gradle.kts @@ -7,6 +7,7 @@ dependencies { tasks { test { inputs.dir(file("projects")) + rootProject.allprojects .mapNotNull { project -> project.tasks.findByName("publishToMavenLocal") } .forEach { publishTask -> this.dependsOn(publishTask) } diff --git a/integration-tests/gradle/projects/it-basic/build.gradle.kts b/integration-tests/gradle/projects/it-basic/build.gradle.kts index bdb59279..3e451fd3 100644 --- a/integration-tests/gradle/projects/it-basic/build.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/build.gradle.kts @@ -18,5 +18,5 @@ dependencies { afterEvaluate { logger.quiet("Gradle version: ${gradle.gradleVersion}") - logger.quiet("Kotlin version: ${property("kotlin_version")}") + logger.quiet("Kotlin version: ${findProperty("kotlin_version")}") } diff --git a/integration-tests/gradle/projects/it-basic/gradle.properties b/integration-tests/gradle/projects/it-basic/gradle.properties deleted file mode 100644 index 625ff49c..00000000 --- a/integration-tests/gradle/projects/it-basic/gradle.properties +++ /dev/null @@ -1,2 +0,0 @@ -kotlin_version=1.4-M2-eap-70 -dokka_version=0.11.0-SNAPSHOT diff --git a/integration-tests/gradle/projects/it-basic/settings.gradle.kts b/integration-tests/gradle/projects/it-basic/settings.gradle.kts index 4ee17dee..9bfd026f 100644 --- a/integration-tests/gradle/projects/it-basic/settings.gradle.kts +++ b/integration-tests/gradle/projects/it-basic/settings.gradle.kts @@ -1,19 +1,12 @@ @file:Suppress("LocalVariableName", "UnstableApiUsage") pluginManagement { - val kotlin_version: String by settings - val dokka_version: String by settings + val kotlin_version = "1.3.72" + val dokka_version = "0.11.0-SNAPSHOT" plugins { id("org.jetbrains.kotlin.jvm") version kotlin_version - } - - resolutionStrategy { - eachPlugin { - if (requested.id.id == "org.jetbrains.dokka") { - useModule("org.jetbrains.dokka:dokka-gradle-plugin:$dokka_version") - } - } + id("org.jetbrains.dokka") version dokka_version } repositories { @@ -26,3 +19,4 @@ pluginManagement { } rootProject.name = "it-basic" + diff --git a/runners/gradle-plugin/build.gradle.kts b/runners/gradle-plugin/build.gradle.kts index d2e9eccd..e0241f67 100644 --- a/runners/gradle-plugin/build.gradle.kts +++ b/runners/gradle-plugin/build.gradle.kts @@ -2,6 +2,7 @@ import org.jetbrains.configureBintrayPublication plugins { id("com.gradle.plugin-publish") + `java-gradle-plugin` } repositories { @@ -26,19 +27,6 @@ dependencies { } } -tasks { - processResources { - val dokka_version: String by project - eachFile { - if (name == "org.jetbrains.dokka.properties") { - filter { line -> - line.replace("", dokka_version) - } - } - } - } -} - val sourceJar by tasks.registering(Jar::class) { archiveClassifier.set("sources") from(sourceSets["main"].allSource) @@ -56,6 +44,15 @@ publishing { configureBintrayPublication("dokkaGradlePlugin") // TODO check if this publishes correctly +gradlePlugin { + plugins { + create("dokkaGradlePlugin") { + id = "org.jetbrains.dokka" + implementationClass = "org.jetbrains.dokka.gradle.DokkaPlugin" + } + } +} + pluginBundle { // TODO check if this publishes correctly website = "https://www.kotlinlang.org/" @@ -64,8 +61,7 @@ pluginBundle { tags = listOf("dokka", "kotlin", "kdoc", "android") plugins { - create("dokkaGradlePlugin") { - id = "org.jetbrains.dokka" + getByName("dokkaGradlePlugin") { displayName = "Dokka plugin" } } @@ -74,4 +70,4 @@ pluginBundle { groupId = "org.jetbrains.dokka" artifactId = "dokka-gradle-plugin" } -} \ No newline at end of file +} diff --git a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt index 2b076fd0..92d63a40 100644 --- a/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt +++ b/runners/gradle-plugin/src/main/kotlin/org/jetbrains/dokka/gradle/main.kt @@ -5,9 +5,8 @@ import org.gradle.api.Project import org.gradle.api.artifacts.Configuration import org.gradle.api.attributes.Usage import org.gradle.util.GradleVersion +import org.jetbrains.dokka.DokkaVersion import java.io.File -import java.io.InputStream -import java.util.* internal const val SOURCE_SETS_EXTENSION_NAME = "dokkaSourceSets" internal const val DOKKA_TASK_NAME = "dokka" @@ -16,7 +15,6 @@ internal const val DOKKA_MULTIMODULE_TASK_NAME = "dokkaMultimodule" open class DokkaPlugin : Plugin { override fun apply(project: Project) { - loadDokkaVersion() val dokkaRuntimeConfiguration = addConfiguration(project) val pluginsConfiguration = project.configurations.create("dokkaPlugins").apply { dependencies.add(project.dependencies.create("org.jetbrains.dokka:dokka-base:${DokkaVersion.version}")) @@ -35,8 +33,6 @@ open class DokkaPlugin : Plugin { ) } - private fun loadDokkaVersion() = - DokkaVersion.loadFrom(javaClass.getResourceAsStream("/META-INF/gradle-plugins/org.jetbrains.dokka.properties")) private fun addConfiguration(project: Project) = project.configurations.create("dokkaRuntime").apply { @@ -99,17 +95,7 @@ open class DokkaPlugin : Plugin { } } -object DokkaVersion { - var version: String? = null - - fun loadFrom(stream: InputStream) { - version = Properties().apply { - load(stream) - }.getProperty("dokka-version") - } -} - internal object ClassloaderContainer { @JvmField var coreClassLoader: ClassLoader? = null -} \ No newline at end of file +} -- cgit From a573641a70a626983c1d63965e377ea0be274f41 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Thu, 2 Jul 2020 14:18:51 +0200 Subject: Implement AndroidGradleIntegrationTest --- .github/workflows/gradle-build.pr.yml | 16 -- .github/workflows/gradle-integration-test.pr.yml | 13 ++ .github/workflows/gradle-test.pr.yml | 16 ++ .idea/jarRepositories.xml | 5 + .run/it-android-0_dokka.run.xml | 24 +++ .../src/main/kotlin/org/jetbrains/projectUtils.kt | 16 ++ integration-tests/build.gradle.kts | 30 ++++ integration-tests/gradle/build.gradle.kts | 19 ++- .../gradle/projects/it-android-0/build.gradle.kts | 19 +++ .../gradle/projects/it-android-0/gradle.properties | 2 + .../it-android-0/gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 58695 bytes .../gradle/wrapper/gradle-wrapper.properties | 5 + .../gradle/projects/it-android-0/gradlew | 183 +++++++++++++++++++++ .../gradle/projects/it-android-0/gradlew.bat | 100 +++++++++++ .../projects/it-android-0/settings.gradle.kts | 5 + .../it-android-0/src/main/AndroidManifest.xml | 1 + .../main/java/it/android/AndroidSpecificClass.kt | 16 ++ .../gradle/projects/template.root.gradle.kts | 4 + .../gradle/projects/template.settings.gradle.kts | 11 ++ .../it/gradle/Android0GradleIntegrationTest.kt | 69 ++++++++ .../dokka/it/gradle/BasicGradleIntegrationTest.kt | 71 ++++++++ .../gradle/Multiplatform0GradleIntegrationTest.kt | 43 +++++ ...AbstractDefaultVersionsGradleIntegrationTest.kt | 84 ---------- .../it/gradle/AbstractGradleIntegrationTest.kt | 30 ++-- .../org/jetbrains/dokka/it/gradle/BuildVersions.kt | 38 ++++- .../kotlin/org/jetbrains/dokka/it/gradle/utils.kt | 29 ---- .../dokka/it/gradle/BasicGradleIntegrationTest.kt | 62 ------- .../gradle/Multiplatform0GradleIntegrationTest.kt | 41 ----- settings.gradle.kts | 1 + 29 files changed, 702 insertions(+), 251 deletions(-) delete mode 100644 .github/workflows/gradle-build.pr.yml create mode 100644 .github/workflows/gradle-integration-test.pr.yml create mode 100644 .github/workflows/gradle-test.pr.yml create mode 100644 .run/it-android-0_dokka.run.xml create mode 100644 buildSrc/src/main/kotlin/org/jetbrains/projectUtils.kt create mode 100644 integration-tests/gradle/projects/it-android-0/build.gradle.kts create mode 100644 integration-tests/gradle/projects/it-android-0/gradle.properties create mode 100644 integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jar create mode 100644 integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.properties create mode 100755 integration-tests/gradle/projects/it-android-0/gradlew create mode 100644 integration-tests/gradle/projects/it-android-0/gradlew.bat create mode 100644 integration-tests/gradle/projects/it-android-0/settings.gradle.kts create mode 100644 integration-tests/gradle/projects/it-android-0/src/main/AndroidManifest.xml create mode 100644 integration-tests/gradle/projects/it-android-0/src/main/java/it/android/AndroidSpecificClass.kt create mode 100644 integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt create mode 100644 integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt create mode 100644 integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt delete mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt delete mode 100644 integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt delete mode 100644 integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt delete mode 100644 integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt (limited to 'integration-tests/gradle/build.gradle.kts') diff --git a/.github/workflows/gradle-build.pr.yml b/.github/workflows/gradle-build.pr.yml deleted file mode 100644 index 2723ecf4..00000000 --- a/.github/workflows/gradle-build.pr.yml +++ /dev/null @@ -1,16 +0,0 @@ -name: CI - -on: pull_request - -jobs: - build: - strategy: - matrix: - os: [ubuntu-latest, windows-latest] - runs-on: ${{ matrix.os }} - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-java@v1 - with: - java-version: 11 - - run: ./gradlew clean build --stacktrace \ No newline at end of file diff --git a/.github/workflows/gradle-integration-test.pr.yml b/.github/workflows/gradle-integration-test.pr.yml new file mode 100644 index 00000000..bfc1b9d3 --- /dev/null +++ b/.github/workflows/gradle-integration-test.pr.yml @@ -0,0 +1,13 @@ +name: CI (Integration Test) + +on: pull_request + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-java@v1 + with: + java-version: 11 + - run: ./gradlew clean integrationTest -s diff --git a/.github/workflows/gradle-test.pr.yml b/.github/workflows/gradle-test.pr.yml new file mode 100644 index 00000000..2838d975 --- /dev/null +++ b/.github/workflows/gradle-test.pr.yml @@ -0,0 +1,16 @@ +name: CI (Test) + +on: pull_request + +jobs: + build: + strategy: + matrix: + os: [ubuntu-latest, windows-latest] + runs-on: ${{ matrix.os }} + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-java@v1 + with: + java-version: 11 + - run: ./gradlew clean test --stacktrace diff --git a/.idea/jarRepositories.xml b/.idea/jarRepositories.xml index e0b545b3..0c589859 100644 --- a/.idea/jarRepositories.xml +++ b/.idea/jarRepositories.xml @@ -96,5 +96,10 @@ \ 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 14b9352b9b7a4084f72209ba686170e313f7863b Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 7 Jul 2020 13:12:05 +0200 Subject: Lazily configure integration test tasks --- integration-tests/build.gradle.kts | 2 +- integration-tests/cli/build.gradle.kts | 2 +- integration-tests/gradle/build.gradle.kts | 14 +++++++------- 3 files changed, 9 insertions(+), 9 deletions(-) (limited to 'integration-tests/gradle/build.gradle.kts') diff --git a/integration-tests/build.gradle.kts b/integration-tests/build.gradle.kts index 44da74cf..70b6db26 100644 --- a/integration-tests/build.gradle.kts +++ b/integration-tests/build.gradle.kts @@ -18,7 +18,7 @@ subprojects { implementation(project(":integration-tests")) } - val integrationTest = task("integrationTest") { + val integrationTest by tasks.register("integrationTest") { maxHeapSize = "2G" description = "Runs integration tests." group = "verification" diff --git a/integration-tests/cli/build.gradle.kts b/integration-tests/cli/build.gradle.kts index c3e98d0a..f825a148 100644 --- a/integration-tests/cli/build.gradle.kts +++ b/integration-tests/cli/build.gradle.kts @@ -23,7 +23,7 @@ val basePluginShadow: Configuration by configurations.creating dependencies { basePluginShadow(project(":plugins:base")) } -val basePluginShadowJar = tasks.create("basePluginShadowJar", ShadowJar::class) { +val basePluginShadowJar by tasks.register("basePluginShadowJar", ShadowJar::class) { configurations = listOf(basePluginShadow) archiveFileName.set("fat-base-plugin-$dokka_version.jar") archiveClassifier.set("") diff --git a/integration-tests/gradle/build.gradle.kts b/integration-tests/gradle/build.gradle.kts index 2c526af7..28e20cf9 100644 --- a/integration-tests/gradle/build.gradle.kts +++ b/integration-tests/gradle/build.gradle.kts @@ -6,13 +6,13 @@ dependencies { implementation(gradleTestKit()) } -val integrationTest by tasks.integrationTest -integrationTest.inputs.dir(file("projects")) - -rootProject.allprojects.forEach { otherProject -> - otherProject.invokeWhenEvaluated { evaluatedProject -> - evaluatedProject.tasks.findByName("publishToMavenLocal")?.let { publishingTask -> - integrationTest.dependsOn(publishingTask) +tasks.integrationTest { + inputs.dir(file("projects")) + rootProject.allprojects.forEach { otherProject -> + otherProject.invokeWhenEvaluated { evaluatedProject -> + evaluatedProject.tasks.findByName("publishToMavenLocal")?.let { publishingTask -> + this.dependsOn(publishingTask) + } } } } -- cgit From caf48e76f3bff5e9907cd094cf0719f623e528d5 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Wed, 8 Jul 2020 10:47:05 +0200 Subject: Implement simple MavenIntegrationTest.kt --- .../src/main/kotlin/org/jetbrains/taskUtils.kt | 13 ++ integration-tests/build.gradle.kts | 3 +- integration-tests/cli/build.gradle.kts | 5 +- .../jetbrains/dokka/it/cli/CliIntegrationTest.kt | 1 + .../org/jetbrains/dokka/it/cli/processUtils.kt | 51 ------- integration-tests/gradle/build.gradle.kts | 10 +- .../it/gradle/Android0GradleIntegrationTest.kt | 14 +- integration-tests/maven/build.gradle.kts | 17 +++ integration-tests/maven/projects/it-maven/pom.xml | 170 +++++++++++++++++++++ .../main/java/it/basic/java/SampleJavaClass.java | 22 +++ .../src/main/kotlin/it/basic/PublicClass.kt | 48 ++++++ .../dokka/it/maven/MavenIntegrationTest.kt | 78 ++++++++++ .../org/jetbrains/dokka/it/environmentUtils.kt | 16 ++ .../kotlin/org/jetbrains/dokka/it/processUtils.kt | 51 +++++++ runners/maven-plugin/build.gradle.kts | 3 + runners/maven-plugin/src/main/kotlin/DokkaMojo.kt | 3 - settings.gradle.kts | 1 + 17 files changed, 428 insertions(+), 78 deletions(-) create mode 100644 buildSrc/src/main/kotlin/org/jetbrains/taskUtils.kt delete mode 100644 integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt create mode 100644 integration-tests/maven/build.gradle.kts create mode 100644 integration-tests/maven/projects/it-maven/pom.xml create mode 100644 integration-tests/maven/projects/it-maven/src/main/java/it/basic/java/SampleJavaClass.java create mode 100644 integration-tests/maven/projects/it-maven/src/main/kotlin/it/basic/PublicClass.kt create mode 100644 integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt create mode 100644 integration-tests/src/main/kotlin/org/jetbrains/dokka/it/environmentUtils.kt create mode 100644 integration-tests/src/main/kotlin/org/jetbrains/dokka/it/processUtils.kt (limited to 'integration-tests/gradle/build.gradle.kts') diff --git a/buildSrc/src/main/kotlin/org/jetbrains/taskUtils.kt b/buildSrc/src/main/kotlin/org/jetbrains/taskUtils.kt new file mode 100644 index 00000000..b018ba13 --- /dev/null +++ b/buildSrc/src/main/kotlin/org/jetbrains/taskUtils.kt @@ -0,0 +1,13 @@ +package org.jetbrains + +import org.gradle.api.Task + +fun Task.dependsOnMavenLocalPublication() { + project.rootProject.allprojects.forEach { otherProject -> + otherProject.invokeWhenEvaluated { evaluatedProject -> + evaluatedProject.tasks.findByName("publishToMavenLocal")?.let { publishingTask -> + this.dependsOn(publishingTask) + } + } + } +} diff --git a/integration-tests/build.gradle.kts b/integration-tests/build.gradle.kts index 70b6db26..070091a0 100644 --- a/integration-tests/build.gradle.kts +++ b/integration-tests/build.gradle.kts @@ -37,4 +37,5 @@ subprojects { dependencies { implementation(kotlin("stdlib")) implementation(kotlin("test-junit")) -} + val coroutines_version: String by project + api("org.jetbrains.kotlinx:kotlinx-coroutines-core:$coroutines_version")} diff --git a/integration-tests/cli/build.gradle.kts b/integration-tests/cli/build.gradle.kts index 5fdf0ff5..60d3a298 100644 --- a/integration-tests/cli/build.gradle.kts +++ b/integration-tests/cli/build.gradle.kts @@ -12,10 +12,6 @@ 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 */ @@ -35,6 +31,7 @@ val basePluginShadowJar by tasks.register("basePluginShadowJar", ShadowJar::clas } tasks.integrationTest { + inputs.dir((file("projects"))) val cliJar = tasks.getByPath(":runners:cli:shadowJar") as ShadowJar environment("CLI_JAR_PATH", cliJar.archiveFile.get()) environment("BASE_PLUGIN_JAR_PATH", basePluginShadowJar.archiveFile.get()) 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 index 49030c73..9f83c869 100644 --- 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 @@ -1,5 +1,6 @@ package org.jetbrains.dokka.it.cli +import org.jetbrains.dokka.it.awaitProcessResult import java.io.File import kotlin.test.BeforeTest import kotlin.test.Test 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 deleted file mode 100644 index d2fa3b31..00000000 --- a/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/processUtils.kt +++ /dev/null @@ -1,51 +0,0 @@ -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/build.gradle.kts b/integration-tests/gradle/build.gradle.kts index 28e20cf9..3da416bb 100644 --- a/integration-tests/gradle/build.gradle.kts +++ b/integration-tests/gradle/build.gradle.kts @@ -1,4 +1,4 @@ -import org.jetbrains.invokeWhenEvaluated +import org.jetbrains.dependsOnMavenLocalPublication dependencies { implementation(kotlin("stdlib")) @@ -8,13 +8,7 @@ dependencies { tasks.integrationTest { inputs.dir(file("projects")) - rootProject.allprojects.forEach { otherProject -> - otherProject.invokeWhenEvaluated { evaluatedProject -> - evaluatedProject.tasks.findByName("publishToMavenLocal")?.let { publishingTask -> - this.dependsOn(publishingTask) - } - } - } + dependsOnMavenLocalPublication() } tasks.clean { 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 e08dbca5..0a29555f 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 @@ -1,6 +1,8 @@ package org.jetbrains.dokka.it.gradle import org.gradle.testkit.runner.TaskOutcome +import org.jetbrains.dokka.it.isAndroidSdkInstalled +import org.jetbrains.dokka.it.isCI import org.junit.Assume import org.junit.runners.Parameterized.Parameters import java.io.File @@ -28,20 +30,10 @@ class Android0GradleIntegrationTest(override val versions: BuildVersions) : Abst @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 - ) + Assume.assumeTrue("Missing ANDROID_SDK_ROOT", isAndroidSdkInstalled) } @BeforeTest diff --git a/integration-tests/maven/build.gradle.kts b/integration-tests/maven/build.gradle.kts new file mode 100644 index 00000000..b0187b13 --- /dev/null +++ b/integration-tests/maven/build.gradle.kts @@ -0,0 +1,17 @@ +import org.jetbrains.dependsOnMavenLocalPublication + +evaluationDependsOn(":runners:maven-plugin") + +dependencies { + implementation(kotlin("stdlib")) + implementation(kotlin("test-junit")) +} + +tasks.integrationTest { + dependsOnMavenLocalPublication() + dependsOn(":runners:maven-plugin:setupMaven") + + val dokka_version: String by project + environment("DOKKA_VERSION", dokka_version) + environment("MVN_BINARY_PATH", project(":runners:maven-plugin").extra["MVN_BINARY_PATH"].toString()) +} diff --git a/integration-tests/maven/projects/it-maven/pom.xml b/integration-tests/maven/projects/it-maven/pom.xml new file mode 100644 index 00000000..47bd633c --- /dev/null +++ b/integration-tests/maven/projects/it-maven/pom.xml @@ -0,0 +1,170 @@ + + 4.0.0 + + org.jetbrains.dokka + it-maven + 1.0-SNAPSHOT + + + 1.3.72 + + + + + org.jetbrains.kotlin + kotlin-maven-plugin + ${kotlin.version} + + + compile + + compile + + + + ${project.basedir}/src/main/kotlin + ${project.basedir}/src/main/java + + + + + test-compile + + test-compile + + + + ${project.basedir}/src/test/kotlin + ${project.basedir}/src/test/java + + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.5.1 + + + + default-compile + none + + + + default-testCompile + none + + + java-compile + compile + + compile + + + + java-test-compile + test-compile + + testCompile + + + + + + org.jetbrains.dokka + dokka-maven-plugin + $dokka_version + + + pre-site + + dokka + + + + + + + false + + + Maven Integration Test Module + + + html + + ${project.basedir}/output + + + + default + + + + 8 + + + false + + true + + true + + + + ${project.basedir}/src/main/kotlin + ${project.basedir}/src/main/java + + + + + false + + + false + + + + + + kotlin + + + false + + true + false + + + + + + ${project.basedir}/src/main/kotlin + ${project.basedir}/src/test/kotlin + + + + + kotlin-dev + https://dl.bintray.com/kotlin/kotlin-dev/ + + + jcenter + JCenter + https://jcenter.bintray.com/ + + + + + + org.jetbrains.kotlin + kotlin-stdlib + ${kotlin.version} + + + + + diff --git a/integration-tests/maven/projects/it-maven/src/main/java/it/basic/java/SampleJavaClass.java b/integration-tests/maven/projects/it-maven/src/main/java/it/basic/java/SampleJavaClass.java new file mode 100644 index 00000000..e08bb66a --- /dev/null +++ b/integration-tests/maven/projects/it-maven/src/main/java/it/basic/java/SampleJavaClass.java @@ -0,0 +1,22 @@ +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(); + } + + + public PublicClass publicUndocumentedFunction() { + return new PublicClass(); + } +} diff --git a/integration-tests/maven/projects/it-maven/src/main/kotlin/it/basic/PublicClass.kt b/integration-tests/maven/projects/it-maven/src/main/kotlin/it/basic/PublicClass.kt new file mode 100644 index 00000000..71bc7e63 --- /dev/null +++ b/integration-tests/maven/projects/it-maven/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/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt b/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt new file mode 100644 index 00000000..e52debf4 --- /dev/null +++ b/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt @@ -0,0 +1,78 @@ +package org.jetbrains.dokka.it.maven + +import org.jetbrains.dokka.it.AbstractIntegrationTest +import org.jetbrains.dokka.it.awaitProcessResult +import java.io.File +import kotlin.test.BeforeTest +import kotlin.test.Test +import kotlin.test.assertEquals +import kotlin.test.assertTrue + +class MavenIntegrationTest : AbstractIntegrationTest() { + + val currentDokkaVersion: String = checkNotNull(System.getenv("DOKKA_VERSION")) + + val mavenBinaryFile: File = File(checkNotNull(System.getenv("MVN_BINARY_PATH"))) + + @BeforeTest + fun prepareProjectFiles() { + val templateProjectDir = File("projects", "it-maven") + templateProjectDir.copyRecursively(projectDir) + val pomXml = File(projectDir, "pom.xml") + assertTrue(pomXml.isFile) + pomXml.apply { + writeText(readText().replace("\$dokka_version", currentDokkaVersion)) + } + } + + @Test + fun run() { + val result = ProcessBuilder().directory(projectDir) + .command(mavenBinaryFile.absolutePath, "dokka:dokka", "-U", "-e").start().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)" + ) + + val undocumentedReportRegex = Regex("""Undocumented:""") + val amountOfUndocumentedReports = undocumentedReportRegex.findAll(result.output).count() + assertTrue( + amountOfUndocumentedReports > 0, + "Expected at least one report of undocumented code (found $amountOfUndocumentedReports)" + ) + + val undocumentedJavaReportRegex = Regex("""Undocumented: it\.basic\.java""") + val amountOfUndocumentedJavaReports = undocumentedJavaReportRegex.findAll(result.output).count() + assertTrue( + amountOfUndocumentedJavaReports > 0, + "Expected at least one report of undocumented java code (found $amountOfUndocumentedJavaReports)" + ) + + val dokkaOutputDir = File(projectDir, "output") + 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/src/main/kotlin/org/jetbrains/dokka/it/environmentUtils.kt b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/environmentUtils.kt new file mode 100644 index 00000000..eadf5a8c --- /dev/null +++ b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/environmentUtils.kt @@ -0,0 +1,16 @@ +package org.jetbrains.dokka.it + +import java.io.File + +/** + * Indicating whether or not the current machine executing the test is a CI + */ +val isCI: Boolean get() = System.getenv("CI") == "true" + +val isAndroidSdkInstalled: Boolean = System.getenv("ANDROID_SDK_ROOT") != null || + System.getenv("ANDROID_HOME") != null + +val isMavenInstalled: Boolean = System.getenv("PATH").orEmpty() + .split(File.pathSeparator) + .flatMap { pathElement -> File(pathElement).listFiles().orEmpty().toList() } + .any { pathElement -> "mvn" == pathElement.name } diff --git a/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/processUtils.kt b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/processUtils.kt new file mode 100644 index 00000000..d2c048ac --- /dev/null +++ b/integration-tests/src/main/kotlin/org/jetbrains/dokka/it/processUtils.kt @@ -0,0 +1,51 @@ +package org.jetbrains.dokka.it + +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/runners/maven-plugin/build.gradle.kts b/runners/maven-plugin/build.gradle.kts index d9fc4f6f..8e412b43 100644 --- a/runners/maven-plugin/build.gradle.kts +++ b/runners/maven-plugin/build.gradle.kts @@ -1,5 +1,6 @@ import org.jetbrains.configureBintrayPublication import org.jetbrains.CrossPlatformExec + /** * [mavenBin] configuration is used to download Maven Plugin Plugin * for generating plugin-help.xml and plugin.xml files @@ -30,6 +31,7 @@ dependencies { val mavenBinDir = "$buildDir/maven-bin" val mavenBuildDir = "$buildDir/maven" val mvn = File(mavenBinDir, "apache-maven-$mavenVersion/bin/mvn") +extra.set("MVN_BINARY_PATH", mvn.absolutePath) tasks.named("clean") { delete(mavenBinDir) @@ -48,6 +50,7 @@ val setupMaven by tasks.registering(Sync::class) { */ val generatePom by tasks.registering(Copy::class) { val dokka_version: String by project + inputs.property("dokka_version", dokka_version) from("$projectDir/pom.tpl.xml") { rename("(.*).tpl.xml", "$1.xml") diff --git a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt index 8160ab87..aa92516f 100644 --- a/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt +++ b/runners/maven-plugin/src/main/kotlin/DokkaMojo.kt @@ -87,9 +87,6 @@ abstract class AbstractDokkaMojo : AbstractMojo() { @Parameter(required = true, defaultValue = "\${project.compileSourceRoots}") var sourceDirectories: List = emptyList() - @Parameter - var sourceRoots: List = emptyList() - @Parameter var samples: List = emptyList() diff --git a/settings.gradle.kts b/settings.gradle.kts index 409dca88..ecee8020 100644 --- a/settings.gradle.kts +++ b/settings.gradle.kts @@ -21,6 +21,7 @@ include("plugins:javadoc") include("integration-tests") include("integration-tests:gradle") include("integration-tests:cli") +include("integration-tests:maven") pluginManagement { val kotlin_version: String by settings -- cgit