azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Migrate PluginsDslIT tests to new dsl

Browse Source 
^KT-45745 In Progress
This commit is contained in:
Yahor Berdnikau
2022-03-07 11:50:06 +01:00
parent c596ced62d
commit 9ce32e5a9e
8 changed files with 130 additions and 164 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/kotlin/org/jetbrains/kotlin/gradle/BaseGradleIT.kt
+71
View File
@@ -29,6 +29,7 @@ import org.junit.runner.RunWith
import java.io.File import java.io.File
import java.nio.file.Files import java.nio.file.Files
import java.util.regex.Pattern import java.util.regex.Pattern
import javax.xml.parsers.DocumentBuilderFactory
import kotlin.io.path.isDirectory import kotlin.io.path.isDirectory
import kotlin.test.* import kotlin.test.*
@@ -1008,3 +1009,73 @@ Finished executing task ':$taskName'|
fun BaseGradleIT.BuildOptions.withFreeCommandLineArgument(argument: String) = copy( fun BaseGradleIT.BuildOptions.withFreeCommandLineArgument(argument: String) = copy(
freeCommandLineArgs = freeCommandLineArgs + argument freeCommandLineArgs = freeCommandLineArgs + argument
) )
private const val MAVEN_LOCAL_URL_PLACEHOLDER = "<mavenLocalUrl>"
internal const val PLUGIN_MARKER_VERSION_PLACEHOLDER = "<pluginMarkerVersion>"
internal fun BaseGradleIT.transformProjectWithPluginsDsl(
projectName: String,
wrapperVersion: GradleVersionRequired = defaultGradleVersion,
directoryPrefix: String? = null,
minLogLevel: LogLevel = LogLevel.DEBUG
): BaseGradleIT.Project {
val result = Project(projectName, wrapperVersion, directoryPrefix, minLogLevel)
result.setupWorkingDir()
val settingsGradle = File(result.projectDir, "settings.gradle").takeIf(File::exists)
settingsGradle?.modify {
it.replace(MAVEN_LOCAL_URL_PLACEHOLDER, MavenLocalUrlProvider.mavenLocalUrl)
}
result.projectDir.walkTopDown()
.filter {
it.isFile && (it.name == "build.gradle" || it.name == "build.gradle.kts" ||
it.name == "settings.gradle" || it.name == "settings.gradle.kts")
}
.forEach { buildGradle ->
buildGradle.modify(::transformBuildScriptWithPluginsDsl)
}
return result
}
internal fun transformBuildScriptWithPluginsDsl(buildScriptContent: String): String =
buildScriptContent.replace(PLUGIN_MARKER_VERSION_PLACEHOLDER, KOTLIN_VERSION)
/** Copies the logic of Gradle [`mavenLocal()`](https://docs.gradle.org/3.4.1/dsl/org.gradle.api.artifacts.dsl.RepositoryHandler.html#org.gradle.api.artifacts.dsl.RepositoryHandler:mavenLocal())
*/
private object MavenLocalUrlProvider {
/** The URL that points to the Gradle's mavenLocal() repository. */
val mavenLocalUrl by lazy {
val path = propertyMavenLocalRepoPath ?: homeSettingsLocalRepoPath ?: m2HomeSettingsLocalRepoPath ?: defaultM2RepoPath
File(path).toURI().toString()
}
private val homeDir get() = File(System.getProperty("user.home"))
private fun getLocalRepositoryFromXml(file: File): String? {
if (!file.isFile)
return null
val xml = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(file)
val localRepoNodes = xml.getElementsByTagName("localRepository")
if (localRepoNodes.length == 0)
return null
val content = localRepoNodes.item(0).textContent
return content.replace("\\$\\{(.*?)\\}".toRegex()) { System.getProperty(it.groupValues[1]) ?: it.value }
}
private val propertyMavenLocalRepoPath get() = System.getProperty("maven.repo.local")
private val homeSettingsLocalRepoPath
get() = getLocalRepositoryFromXml(File(homeDir, ".m2/settings.xml"))
private val m2HomeSettingsLocalRepoPath
get() = System.getProperty("M2_HOME")?.let { getLocalRepositoryFromXml(File(it, "conf/settings.xml")) }
private val defaultM2RepoPath get() = File(homeDir, ".m2/repository").absolutePath
}
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/kotlin/org/jetbrains/kotlin/gradle/PluginsDslIT.kt
+46 -120
View File
@@ -1,132 +1,58 @@
package org.jetbrains.kotlin.gradle package org.jetbrains.kotlin.gradle
import org.gradle.api.logging.LogLevel import org.gradle.util.GradleVersion
import org.jetbrains.kotlin.gradle.util.modify import org.jetbrains.kotlin.gradle.testbase.*
import org.junit.Assert import org.jetbrains.kotlin.test.util.JUnit4Assertions.assertTrue
import org.junit.Test import org.junit.jupiter.api.DisplayName
import java.io.File
import javax.xml.parsers.DocumentBuilderFactory
class PluginsDslIT : BaseGradleIT() { @DisplayName("Plugins DSL is working correctly")
@OtherGradlePluginTests
class PluginsDslIT : KGPBaseTest() {
@Test @DisplayName("Allopen plugin")
fun testAllopenWithPluginsDsl() { @GradleTest
val project = projectWithMavenLocalPlugins("allopenPluginsDsl") fun testAllopenWithPluginsDsl(gradleVersion: GradleVersion) {
project.build("build") { project("allopenPluginsDsl".withPrefix, gradleVersion) {
assertSuccessful() build("build") {
assertTasksExecuted(":compileKotlin") assertTasksExecuted(":compileKotlin")
}
}
@Test
fun testApplyToSubprojects() {
val project = projectWithMavenLocalPlugins("applyToSubprojects")
project.build("build") {
assertSuccessful()
assertTasksExecuted(":subproject:compileKotlin")
}
}
@Test
fun testApplyAllPlugins() {
val project = projectWithMavenLocalPlugins("applyAllPlugins")
val kotlinPluginClasses = setOf(
"org.jetbrains.kotlin.gradle.plugin.KotlinPluginWrapper",
"org.jetbrains.kotlin.gradle.internal.Kapt3GradleSubplugin",
"org.jetbrains.kotlin.allopen.gradle.AllOpenGradleSubplugin",
"org.jetbrains.kotlin.allopen.gradle.SpringGradleSubplugin",
"org.jetbrains.kotlin.noarg.gradle.NoArgGradleSubplugin",
"org.jetbrains.kotlin.noarg.gradle.KotlinJpaSubplugin"
)
project.build("build") {
assertSuccessful()
val appliedPlugins = "applied plugin class\\:(.*)".toRegex().findAll(output).map { it.groupValues[1] }.toSet()
kotlinPluginClasses.forEach {
Assert.assertTrue("Plugin class $it should be in applied plugins", it in appliedPlugins)
} }
} }
} }
companion object { @DisplayName("Apply plugin to subproject from root project")
private const val DIRECTORY_PREFIX = "pluginsDsl" @GradleTest
fun testApplyToSubprojects(gradleVersion: GradleVersion) {
private fun BaseGradleIT.projectWithMavenLocalPlugins( project("applyToSubprojects".withPrefix, gradleVersion) {
projectName: String, build("build") {
wrapperVersion: GradleVersionRequired = GradleVersionRequired.None, assertTasksExecuted(":subproject:compileKotlin")
directoryPrefix: String? = DIRECTORY_PREFIX, }
minLogLevel: LogLevel = LogLevel.DEBUG
): Project = transformProjectWithPluginsDsl(projectName, wrapperVersion, directoryPrefix, minLogLevel)
}
}
private const val MAVEN_LOCAL_URL_PLACEHOLDER = "<mavenLocalUrl>"
internal const val PLUGIN_MARKER_VERSION_PLACEHOLDER = "<pluginMarkerVersion>"
internal fun BaseGradleIT.transformProjectWithPluginsDsl(
projectName: String,
wrapperVersion: GradleVersionRequired = defaultGradleVersion,
directoryPrefix: String? = null,
minLogLevel: LogLevel = LogLevel.DEBUG
): BaseGradleIT.Project {
val result = Project(projectName, wrapperVersion, directoryPrefix, minLogLevel)
result.setupWorkingDir()
val settingsGradle = File(result.projectDir, "settings.gradle").takeIf(File::exists)
settingsGradle?.modify {
it.replace(MAVEN_LOCAL_URL_PLACEHOLDER, MavenLocalUrlProvider.mavenLocalUrl)
}
result.projectDir.walkTopDown()
.filter {
it.isFile && (it.name == "build.gradle" || it.name == "build.gradle.kts" ||
it.name == "settings.gradle" || it.name == "settings.gradle.kts")
} }
.forEach { buildGradle -> }
buildGradle.modify(::transformBuildScriptWithPluginsDsl)
@DisplayName("All Kotlin plugins are applied to project")
@GradleTest
fun testApplyAllPlugins(gradleVersion: GradleVersion) {
project("applyAllPlugins".withPrefix, gradleVersion) {
val kotlinPluginClasses = setOf(
"org.jetbrains.kotlin.gradle.plugin.KotlinPluginWrapper",
"org.jetbrains.kotlin.gradle.internal.Kapt3GradleSubplugin",
"org.jetbrains.kotlin.allopen.gradle.AllOpenGradleSubplugin",
"org.jetbrains.kotlin.allopen.gradle.SpringGradleSubplugin",
"org.jetbrains.kotlin.noarg.gradle.NoArgGradleSubplugin",
"org.jetbrains.kotlin.noarg.gradle.KotlinJpaSubplugin"
)
build("build") {
val appliedPlugins = "applied plugin class:(.*)".toRegex().findAll(output).map { it.groupValues[1] }.toSet()
kotlinPluginClasses.forEach {
assertTrue(it in appliedPlugins) {
"Plugin class $it should be in applied plugins"
}
}
}
} }
}
return result private val String.withPrefix get() = "pluginsDsl/$this"
} }
internal fun transformBuildScriptWithPluginsDsl(buildScriptContent: String): String =
buildScriptContent.replace(PLUGIN_MARKER_VERSION_PLACEHOLDER, KOTLIN_VERSION)
/** Copies the logic of Gradle [`mavenLocal()`](https://docs.gradle.org/3.4.1/dsl/org.gradle.api.artifacts.dsl.RepositoryHandler.html#org.gradle.api.artifacts.dsl.RepositoryHandler:mavenLocal())
*/
private object MavenLocalUrlProvider {
/** The URL that points to the Gradle's mavenLocal() repository. */
val mavenLocalUrl by lazy {
val path = propertyMavenLocalRepoPath ?: homeSettingsLocalRepoPath ?: m2HomeSettingsLocalRepoPath ?: defaultM2RepoPath
File(path).toURI().toString()
}
private val homeDir get() = File(System.getProperty("user.home"))
private fun getLocalRepositoryFromXml(file: File): String? {
if (!file.isFile)
return null
val xml = DocumentBuilderFactory.newInstance().newDocumentBuilder().parse(file)
val localRepoNodes = xml.getElementsByTagName("localRepository")
if (localRepoNodes.length == 0)
return null
val content = localRepoNodes.item(0).textContent
return content.replace("\\$\\{(.*?)\\}".toRegex()) { System.getProperty(it.groupValues[1]) ?: it.value }
}
private val propertyMavenLocalRepoPath get() = System.getProperty("maven.repo.local")
private val homeSettingsLocalRepoPath
get() = getLocalRepositoryFromXml(File(homeDir, ".m2/settings.xml"))
private val m2HomeSettingsLocalRepoPath
get() = System.getProperty("M2_HOME")?.let { getLocalRepositoryFromXml(File(it, "conf/settings.xml")) }
private val defaultM2RepoPath get() = File(homeDir, ".m2/repository").absolutePath
}
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/allopenPluginsDsl/build.gradle
+3 -3
View File
@@ -1,11 +1,11 @@
plugins { plugins {
id 'org.jetbrains.kotlin.jvm' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.jvm'
id 'org.jetbrains.kotlin.plugin.allopen' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.plugin.allopen'
} }
repositories { repositories {
mavenCentral()
mavenLocal() mavenLocal()
mavenCentral()
} }
allOpen { allOpen {
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/allopenPluginsDsl/settings.gradle
-10
View File
@@ -1,10 +0,0 @@
pluginManagement {
repositories {
maven { url '<mavenLocalUrl>' }
gradlePluginPortal()
}
plugins {
id "org.jetbrains.kotlin.test.fixes.android" version "$test_fixes_version"
}
}
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/applyAllPlugins/build.gradle
+8 -8
View File
@@ -1,15 +1,15 @@
plugins { plugins {
id 'org.jetbrains.kotlin.jvm' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.jvm'
id 'org.jetbrains.kotlin.kapt' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.kapt'
id 'org.jetbrains.kotlin.plugin.allopen' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.plugin.allopen'
id 'org.jetbrains.kotlin.plugin.spring' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.plugin.spring'
id 'org.jetbrains.kotlin.plugin.noarg' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.plugin.noarg'
id 'org.jetbrains.kotlin.plugin.jpa' version '<pluginMarkerVersion>' id 'org.jetbrains.kotlin.plugin.jpa'
} }
repositories { repositories {
mavenCentral()
mavenLocal() mavenLocal()
mavenCentral()
} }
dependencies { dependencies {
@@ -18,5 +18,5 @@ dependencies {
} }
afterEvaluate { afterEvaluate {
plugins.forEach { println("applied plugin class:" + it.class.canonicalName) } plugins.forEach { logger.info("applied plugin class:" + it.class.canonicalName) }
} }
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/applyAllPlugins/settings.gradle
-10
View File
@@ -1,10 +0,0 @@
pluginManagement {
repositories {
maven { url '<mavenLocalUrl>' }
gradlePluginPortal()
}
plugins {
id "org.jetbrains.kotlin.test.fixes.android" version "$test_fixes_version"
}
}
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/applyToSubprojects/build.gradle
+1 -1
View File
@@ -1,5 +1,5 @@
plugins { plugins {
id 'org.jetbrains.kotlin.jvm' version '<pluginMarkerVersion>' apply false id 'org.jetbrains.kotlin.jvm' apply false
} }
allprojects { allprojects {
libraries/tools/kotlin-gradle-plugin-integration-tests/src/test/resources/testProject/pluginsDsl/applyToSubprojects/settings.gradle
+1 -12
View File
@@ -1,12 +1 @@
pluginManagement { include 'subproject'
repositories {
maven { url '<mavenLocalUrl>' }
gradlePluginPortal()
}
plugins {
id "org.jetbrains.kotlin.test.fixes.android" version "$test_fixes_version"
}
}
include 'subproject'