aboutsummaryrefslogtreecommitdiff
path: root/integration-tests
diff options
context:
space:
mode:
authorsebastian.sellmair <sebastian.sellmair@jetbrains.com>2020-07-02 14:18:51 +0200
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-07-06 15:34:57 +0200
commita573641a70a626983c1d63965e377ea0be274f41 (patch)
treefa242cb03627437c6a40a38900d894c97a6436c0 /integration-tests
parentb594564969ec4d93d59e4850a63f0fbf8f68cf7a (diff)
downloaddokka-a573641a70a626983c1d63965e377ea0be274f41.tar.gz
dokka-a573641a70a626983c1d63965e377ea0be274f41.tar.bz2
dokka-a573641a70a626983c1d63965e377ea0be274f41.zip
Implement AndroidGradleIntegrationTest
Diffstat (limited to 'integration-tests')
-rw-r--r--integration-tests/build.gradle.kts30
-rw-r--r--integration-tests/gradle/build.gradle.kts19
-rw-r--r--integration-tests/gradle/projects/it-android-0/build.gradle.kts19
-rw-r--r--integration-tests/gradle/projects/it-android-0/gradle.properties2
-rw-r--r--integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jarbin0 -> 58695 bytes
-rw-r--r--integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.properties5
-rwxr-xr-xintegration-tests/gradle/projects/it-android-0/gradlew183
-rw-r--r--integration-tests/gradle/projects/it-android-0/gradlew.bat100
-rw-r--r--integration-tests/gradle/projects/it-android-0/settings.gradle.kts5
-rw-r--r--integration-tests/gradle/projects/it-android-0/src/main/AndroidManifest.xml1
-rw-r--r--integration-tests/gradle/projects/it-android-0/src/main/java/it/android/AndroidSpecificClass.kt16
-rw-r--r--integration-tests/gradle/projects/template.root.gradle.kts4
-rw-r--r--integration-tests/gradle/projects/template.settings.gradle.kts11
-rw-r--r--integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Android0GradleIntegrationTest.kt69
-rw-r--r--integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt (renamed from integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt)21
-rw-r--r--integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt (renamed from integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt)28
-rw-r--r--integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractDefaultVersionsGradleIntegrationTest.kt84
-rw-r--r--integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/AbstractGradleIntegrationTest.kt30
-rw-r--r--integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/BuildVersions.kt38
-rw-r--r--integration-tests/gradle/src/main/kotlin/org/jetbrains/dokka/it/gradle/utils.kt29
20 files changed, 543 insertions, 151 deletions
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<Test>("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
--- /dev/null
+++ b/integration-tests/gradle/projects/it-android-0/gradle/wrapper/gradle-wrapper.jar
Binary files 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 @@
+<manifest package="org.jetbrains.dokka.it.android"/>
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/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt
index b4d9e82c..c3adce4f 100644
--- a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt
+++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/BasicGradleIntegrationTest.kt
@@ -1,10 +1,21 @@
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 : AbstractDefaultVersionsGradleIntegrationTest() {
+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() {
@@ -17,11 +28,9 @@ class BasicGradleIntegrationTest : AbstractDefaultVersionsGradleIntegrationTest(
File(templateProjectDir, "src").copyRecursively(File(projectDir, "src"))
}
- override fun execute(versions: BuildVersions) {
- val result = createGradleRunner(
- buildVersions = versions,
- arguments = arrayOf("dokka", "--stacktrace")
- ).build()
+ @Test
+ fun execute() {
+ val result = createGradleRunner("dokka", "--stacktrace").build()
assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome)
val dokkaOutputDir = File(projectDir, "build/dokka")
diff --git a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt
index a0f6be24..b54eecb1 100644
--- a/integration-tests/gradle/src/test/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt
+++ b/integration-tests/gradle/src/integrationTest/kotlin/org/jetbrains/dokka/it/gradle/Multiplatform0GradleIntegrationTest.kt
@@ -2,15 +2,20 @@ 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.BeforeTest
-import kotlin.test.assertEquals
-import kotlin.test.assertNotNull
-import kotlin.test.assertTrue
+import kotlin.test.*
-class Multiplatform0GradleIntegrationTest : AbstractDefaultVersionsGradleIntegrationTest(
- minGradleVersion = GradleVersion.version("6.0.0")
-) {
+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() {
@@ -21,11 +26,9 @@ class Multiplatform0GradleIntegrationTest : AbstractDefaultVersionsGradleIntegra
File(templateProjectDir, "src").copyRecursively(File(projectDir, "src"))
}
- override fun execute(versions: BuildVersions) {
- val result = createGradleRunner(
- buildVersions = versions,
- arguments = arrayOf("dokka", "--stacktrace")
- ).build()
+ @Test
+ fun execute() {
+ val result = createGradleRunner("dokka", "--stacktrace").build()
assertEquals(TaskOutcome.SUCCESS, assertNotNull(result.task(":dokka")).outcome)
@@ -37,5 +40,4 @@ class Multiplatform0GradleIntegrationTest : AbstractDefaultVersionsGradleIntegra
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<String>
+ 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<File> {
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<String>,
+ kotlinVersions: List<String>,
+ androidGradlePluginVersions: List<String?> = listOf(null)
+ ): List<BuildVersions> {
+ 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<Path>() {
- @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
- }
-}