8000 Inject classpath for Gradle plugin functional tests by 3flex · Pull Request #5149 · detekt/detekt · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Inject classpath for Gradle plugin functional tests #5149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions build-logic/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
`kotlin-dsl`
`java-gradle-plugin`
}

repositories {
Expand All @@ -13,3 +14,12 @@ dependencies {
implementation(libs.semver4j.gradle)
implementation(libs.nexusStaging.gradle)
}

gradlePlugin {
plugins {
create("injectedPlugin") {
id = "io.github.com.detekt.injected"
implementationClass = "InjectedDependenciesPlugin"
}
}
}
46 changes: 46 additions & 0 deletions build-logic/src/main/kotlin/InjectedDependenciesPlugin.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import org.gradle.api.DefaultTask
import org.gradle.api.Plugin
import org.gradle.api.Project
import org.gradle.api.file.ConfigurableFileCollection
import org.gradle.api.file.DirectoryProperty
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Nested
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction
import org.gradle.kotlin.dsl.domainObjectContainer

class InjectedDependenciesPlugin : Plugin<Project> {
override fun apply(project: Project) {
project.tasks.register("generateClasspaths", GenerateClasspathsTask::class.java).configure {
targetDir.convention(project.layout.buildDirectory.dir("detektClasspathMetadata"))
}
}
}

interface InjectedDependencySet {
@get:Input
val name: String

@get:Classpath
val injectedClasspath: ConfigurableFileCollection
}

abstract class GenerateClasspathsTask : DefaultTask() {
@get:Nested
val injectedDependencies = project.objects.domainObjectContainer(InjectedDependencySet::class)

@get:OutputDirectory
abstract val targetDir: DirectoryProperty

@TaskAction
fun doStuff() {
val writeString = injectedDependencies.asMap.map {
val classpathString =
it.value.injectedClasspath.files.joinToString(java.io.File.pathSeparator) { it.invariantSeparatorsPath }
"${it.key}-classpath=$classpathString"
}
targetDir.get().asFile.mkdirs()
targetDir.file("detekt-classpath.properties").get().asFile.writeText(writeString.joinToString("\n"))
}
}
27 changes: 27 additions & 0 deletions detekt-gradle-plugin/build.gradle.kts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
plugins {
id("module")
id("io.github.com.detekt.injected")
`java-gradle-plugin`
`java-test-fixtures`
idea
Expand Down Expand Up @@ -56,6 +57,16 10000 @@ testing {

val pluginCompileOnly: Configuration by configurations.creating
val functionalTestImplementation: Configuration by configurations.getting
val functionalTestRuntimeOnly: Configuration by configurations.getting
val smokeTest: Configuration by configurations.creating

configurations.detekt {
resolutionStrategy.useGlobalDependencySubstitutionRules.set(false)
}

configurations.detektPlugins {
resolutionStrategy.useGlobalDependencySubstitutionRules.set(false)
}

configurations.compileOnly { extendsFrom(pluginCompileOnly) }

Expand All @@ -71,6 +82,10 @@ dependencies {
// https://github.com/gradle/gradle/pull/19472
functionalTestImplementation(testFixtures(project))

functionalTestRuntimeOnly(layout.files(tasks.generateClasspaths))

smokeTest("io.gitlab.arturbosch.detekt:detekt-cli")

pluginCompileOnly(libs.android.gradle)
pluginCompileOnly(libs.kotlin.gradle)

Expand Down Expand Up @@ -142,6 +157,18 @@ tasks {
publishPlugins {
notCompatibleWithConfigurationCache("https://github.com/gradle/gradle/issues/21283")
}

generateClasspaths {
injectedDependencies {
create("implementation") {
injectedClasspath.from(smokeTest)
}
}
}

withType<Test>().configureEach {
inputs.files(generateClasspaths.get().targetDir)
}
}

// Skip publishing of test fixture API & runtime variants
Expand Down
2 changes: 2 additions & 0 deletions detekt-gradle-plugin/settings.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ pluginManagement {
includeBuild("../build-logic")
}

includeBuild("..")

dependencyResolutionManagement {
versionCatalogs {
create("libs") {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,27 +5,37 @@ import io.gitlab.arturbosch.detekt.testkit.DslTestBuilder
import io.gitlab.arturbosch.detekt.testkit.ProjectLayout
import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test
import java.io.File
import java.util.Properties

class DetektReportMergeSpec {
@Test
@Suppress("LongMethod")
fun `Sarif merge is configured correctly for multi module project`() {
val propertiesUrl = Thread.currentThread().contextClassLoader.getResource("detekt-classpath.properties")
checkNotNull(propertiesUrl) { "Injected classpath file detekt-classpath.properties cannot be read" }
val properties = Properties()
propertiesUrl.openStream().use(properties::load)

val injectedDependencies = properties
.getProperty("implementation-classpath")
.split(File.pathSeparatorChar)
.joinToString(separator = "\", \"", prefix = "\"", postfix = "\"")

val builder = DslTestBuilder.kotlin()
val buildFileContent =
"""
|${builder.gradlePlugins}
|
|allprojects {
| ${builder.gradleRepositories}
|}
|
|val sarifReportMerge by tasks.registering(io.gitlab.arturbosch.detekt.report.ReportMergeTask::class) {
| output.set(project.layout.buildDirectory.file("reports/detekt/merge.sarif"))
|}
|
|subprojects {
| ${builder.gradleSubprojectsApplyPlugins}
|
| dependencies {
| detekt(files($injectedDependencies))
| }
| detekt {
| reports.sarif.enabled = true
| }
Expand Down
0