foundry.gradle.lint.DetektTasks.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2023 Slack Technologies, LLC
 *
 * 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.
 */
package foundry.gradle.lint

import foundry.gradle.FoundryProperties
import foundry.gradle.artifacts.FoundryArtifact
import foundry.gradle.artifacts.Publisher
import foundry.gradle.artifacts.Resolver
import foundry.gradle.avoidance.SkippyArtifacts
import foundry.gradle.configure
import foundry.gradle.configureEach
import foundry.gradle.isRootProject
import foundry.gradle.properties.setDisallowChanges
import foundry.gradle.properties.sneakyNull
import foundry.gradle.register
import foundry.gradle.tasks.DetektDownloadTask
import foundry.gradle.tasks.SimpleFileProducerTask
import foundry.gradle.tasks.SimpleFilesConsumerTask
import foundry.gradle.tasks.publish
import io.gitlab.arturbosch.detekt.Detekt
import io.gitlab.arturbosch.detekt.DetektCreateBaselineTask
import io.gitlab.arturbosch.detekt.DetektPlugin
import io.gitlab.arturbosch.detekt.extensions.DetektExtension
import org.gradle.api.Project
import org.gradle.api.file.Directory
import org.gradle.api.specs.Spec
import org.gradle.language.base.plugins.LifecycleBasePlugin

internal object DetektTasks {
  private const val GLOBAL_CI_DETEKT_TASK_NAME = "globalCiDetekt"
  private const val CI_DETEKT_TASK_NAME = "ciDetekt"
  private const val LOG = "FoundryDetekt:"

  fun configureRootProject(project: Project, foundryProperties: FoundryProperties) {
    // Add detekt download task
    foundryProperties.versions.detekt?.let { detektVersion ->
      project.tasks.register("updateDetekt") {
        version.setDisallowChanges(detektVersion)
        outputFile.setDisallowChanges(project.layout.projectDirectory.file("config/bin/detekt"))
      }

      val resolver = Resolver.interProjectResolver(project, FoundryArtifact.SKIPPY_DETEKT)
      SimpleFilesConsumerTask.registerOrConfigure(
        project,
        GLOBAL_CI_DETEKT_TASK_NAME,
        description = "Global lifecycle task to run all dependent detekt tasks.",
        inputFiles = resolver.artifactView(),
      )
    }
  }

  fun configureSubProject(
    project: Project,
    foundryProperties: FoundryProperties,
    affectedProjects: Set?,
  ) {
    check(!project.isRootProject) {
      "This method should only be called for subprojects, not the root project."
    }
    if (foundryProperties.versions.detekt == null) return

    project.pluginManager.withPlugin("io.gitlab.arturbosch.detekt") {
      project.logger.debug("$LOG Configuring Detekt tasks for project ${project.path}...")

      // Configuration examples https://arturbosch.github.io/detekt/kotlindsl.html
      project.configure {
        buildUponDefaultConfig = true
        toolVersion =
          foundryProperties.versions.detekt ?: error("missing 'detekt' version in version catalog")
        project.rootProject.file("config/detekt/detekt.yml")
        foundryProperties.detektConfigs?.let { configs ->
          for (configFile in configs) {
            config.from(project.rootProject.file(configFile))
          }
        }

        // Note we need to _explicitly_ null this out if it's not present, as otherwise detekt will
        // default to using the project's "detekt-baseline.xml" file if available, which we don't
        // want.
        baseline =
          foundryProperties.detektBaselineFileName?.let { baselineFile ->
            project.layout.projectDirectory.file(baselineFile).asFile
          }
      }

      val publisher =
        if (affectedProjects == null || project.path in affectedProjects) {
          Publisher.interProjectPublisher(project, FoundryArtifact.SKIPPY_DETEKT)
        } else {
          val log = "$LOG Skipping ${project.path}:detekt because it is not affected."
          if (foundryProperties.debug) {
            project.logger.lifecycle(log)
          } else {
            project.logger.debug(log)
          }
          SkippyArtifacts.publishSkippedTask(project, "detekt")
          null
        }

      // Duplicate configs due to https://github.com/detekt/detekt/issues/5940
      val buildDir = project.layout.buildDirectory.asFile.get().canonicalPath
      project.tasks.configureEach {
        this.jvmTarget = foundryProperties.versions.jvmTarget.get().toString()
        exclude { it.file.canonicalPath.startsWith(buildDir) }
        // Cannot use setDisallowChanges because this property is set without a convention in Detekt
        jdkHome.set(sneakyNull())
      }
      project.tasks.configureEach {
        this.jvmTarget = foundryProperties.versions.jvmTarget.get().toString()
        exclude { it.file.canonicalPath.startsWith(buildDir) }
        // Cannot use setDisallowChanges because this property is set without a convention in Detekt
        jdkHome.set(sneakyNull())
      }

      // Wire up to the global task
      // We use a filter on Detekt tasks because not every project actually makes one!
      val taskSpec =
        if (foundryProperties.enableFullDetekt) {
          // Depend on all Detekt tasks with type resolution
          // The "detekt" task is excluded because it is a plain, non-type-resolution version
          Spec { it != DetektPlugin.DETEKT_TASK_NAME }
        } else {
          // Depend _only_ on the "detekt plain" task, which runs without type resolution
          Spec { it == DetektPlugin.DETEKT_TASK_NAME }
        }
      val matchingTasks = project.tasks.withType(Detekt::class.java).named(taskSpec)
      val ciDetekt =
        SimpleFileProducerTask.registerOrConfigure(
          project,
          CI_DETEKT_TASK_NAME,
          description = "Lifecycle task to run detekt for ${project.path}.",
          group = LifecycleBasePlugin.VERIFICATION_GROUP,
        ) {
          dependsOn(matchingTasks)
        }
      publisher?.publish(ciDetekt)
    }
  }
}