Detekt: add ability to specify input directory (#210)

vanniktech · Mar 11, 2021 · 3afbca2 · 3afbca2
1 parent 013fbb4
commit 3afbca2
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 6 deletions.
diff --git a/src/main/kotlin/com/vanniktech/code/quality/tools/CodeQualityToolsPlugin.kt b/src/main/kotlin/com/vanniktech/code/quality/tools/CodeQualityToolsPlugin.kt
@@ -80,7 +80,8 @@ fun hasLintPlugin(): Boolean {
   }
 }
 
-fun Project.kotlinFiles() = fileTree(mapOf("dir" to ".", "exclude" to "**/build/**", "includes" to listOf("**/*.kt", "**/*.kts")))
+fun Project.kotlinFiles(baseDir: String = ".") =
+  fileTree(mapOf("dir" to baseDir, "exclude" to "**/build/**", "includes" to listOf("**/*.kt", "**/*.kts")))
 
 fun Project.editorconfigFile() = fileTree(mapOf("dir" to ".", "include" to ".editorconfig"))
 
@@ -321,7 +322,8 @@ fun Project.addDetekt(rootProject: Project, extension: CodeQualityToolsPluginExt
       task.version = extension.detekt.toolVersion
       task.outputDirectory = File(buildDir, "reports/detekt/")
       task.configFile = rootProject.file(extension.detekt.config)
-      task.inputs.files(kotlinFiles())
+      task.input = extension.detekt.input
+      task.inputs.files(kotlinFiles(baseDir = extension.detekt.input))
 
       task.inputs.property("baseline-file-exists", false)
 

diff --git a/src/main/kotlin/com/vanniktech/code/quality/tools/DetektCheckTask.kt b/src/main/kotlin/com/vanniktech/code/quality/tools/DetektCheckTask.kt
@@ -15,6 +15,7 @@ import org.gradle.api.tasks.TaskExecutionException
 import java.io.File
 
 @CacheableTask open class DetektCheckTask : DefaultTask() {
+  @Input var input: String = "."
   @Input var failFast: Boolean = true
   @Input var buildUponDefaultConfig: Boolean = false
   @Input var parallel: Boolean = false
@@ -57,7 +58,7 @@ import java.io.File
       task.main = "io.gitlab.arturbosch.detekt.cli.Main"
       task.classpath = configuration
       task.args(
-          "--input", project.file("."),
+          "--input", project.file(input),
           reportKey, reportValue
       )
 

diff --git a/src/main/kotlin/com/vanniktech/code/quality/tools/DetektExtension.kt b/src/main/kotlin/com/vanniktech/code/quality/tools/DetektExtension.kt
@@ -40,4 +40,12 @@ open class DetektExtension {
    * @since 0.19.0
    */
   var parallel: Boolean = false
+
+  /**
+   * Directories to look for source files.
+   * Defaults to current directory.
+   *
+   * @since 0.21.0
+   */
+  var input: String = "."
 }
diff --git a/src/test/kotlin/com/vanniktech/code/quality/tools/CodeQualityToolsPluginDetektTest.kt b/src/test/kotlin/com/vanniktech/code/quality/tools/CodeQualityToolsPluginDetektTest.kt
@@ -113,14 +113,29 @@ class CodeQualityToolsPluginDetektTest {
         .fails(taskToRun = "check", taskToCheck = "detektCheck", containsMessage = "NewLineAtEndOfFile - [Foo.kt] at")
   }
 
+  @Test fun runningWithExplicitInputSucceeds() {
+    Roboter(testProjectDir, inputDirectoryName = testProjectDir.root.toString())
+      .withConfiguration("failFast: true")
+      .withKotlinFile(testPath, testCode)
+      .succeeds()
+  }
+
+  @Test fun failsWithUnexistentInput() {
+    Roboter(testProjectDir, inputDirectoryName = "unexistent")
+      .withConfiguration("failFast: true")
+      .withKotlinFile(testPath, testCode)
+      .fails(containsMessage = "does not exist", assertReportsExist = false)
+  }
+
   class Roboter(
     private val directory: TemporaryFolder,
     private val config: String = "code_quality_tools/detekt.yml",
     enabled: Boolean = true,
     version: String = "1.0.0",
     private val baselineFileName: String? = null,
     buildUponDefaultConfig: Boolean = false,
-    parallel: Boolean = false
+    parallel: Boolean = false,
+    inputDirectoryName: String = "."
   ) {
     init {
       directory.newFile("build.gradle").writeText("""
@@ -137,6 +152,7 @@ class CodeQualityToolsPluginDetektTest {
           |    config = "$config"
           |    toolVersion = "$version"
           |    baselineFileName = ${baselineFileName.wrap("\"")}
+          |    input = ${inputDirectoryName.wrap("\"")}
           |  }
           |  ktlint.enabled = false
           |  checkstyle.enabled = false
@@ -168,11 +184,18 @@ class CodeQualityToolsPluginDetektTest {
       assertReportsExist()
     }
 
-    fun fails(taskToRun: String = "detektCheck", taskToCheck: String = taskToRun, containsMessage: String) = apply {
+    fun fails(
+      taskToRun: String = "detektCheck",
+      taskToCheck: String = taskToRun,
+      assertReportsExist: Boolean = true,
+      containsMessage: String
+    ) = apply {
       val buildResult = run(taskToRun).buildAndFail()
       assertThat(buildResult.task(":$taskToCheck")?.outcome).isEqualTo(TaskOutcome.FAILED)
       assertThat(buildResult.output).contains(containsMessage)
-      assertReportsExist()
+      if (assertReportsExist) {
+        assertReportsExist()
+      }
     }
 
     private fun assertReportsExist() {