Migrate detekt-gradle-plugin tests to JUnit (detekt#4529)

* Migrate detekt-gradle-plugin functional tests to JUnit * Migrate detekt-gradle-plugin tests to JUnit * Remove unused dependencies * Removed unused function
Goooler · Feb 10, 2022 · ebf5d77 · ebf5d77
1 parent e00eafe
commit ebf5d77
Show file tree

Hide file tree

Showing 22 changed files with 904 additions and 736 deletions.
diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -105,6 +105,16 @@ formatting:
 naming:
   ClassNaming:
     excludes: ['**/*Spec.kt']
+  FunctionNaming:
+    active: true
+    excludes:
+      - '**/test/**'
+      - '**/androidTest/**'
+      - '**/commonTest/**'
+      - '**/functionalTest/**'
+      - '**/jvmTest/**'
+      - '**/jsTest/**'
+      - '**/iosTest/**'
   TopLevelPropertyNaming:
     constantPattern: '[a-z][_A-Za-z0-9]*|[A-Z][_A-Z0-9]*'
   InvalidPackageDeclaration:

diff --git a/detekt-gradle-plugin/build.gradle.kts b/detekt-gradle-plugin/build.gradle.kts
@@ -19,10 +19,8 @@ testing {
         getByName("test", JvmTestSuite::class) {
             dependencies {
                 implementation(libs.assertj)
-                implementation(libs.spek.dsl)
                 implementation(libs.kotlin.gradle)
                 implementation(gradleKotlinDsl())
-                runtimeOnly(libs.spek.runner)
 
                 // Workaround for gradle/gradle#16774, see
                 // https://github.com/gradle/gradle/issues/16774#issuecomment-853407822
@@ -51,8 +49,6 @@ testing {
 
             dependencies {
                 implementation(libs.assertj)
-                implementation(libs.spek.dsl)
-                runtimeOnly(libs.spek.runner)
             }
         }
     }

diff --git a/...plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/CreateBaselineTaskDslSpec.kt b/...plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/CreateBaselineTaskDslSpec.kt
@@ -4,83 +4,83 @@ import io.gitlab.arturbosch.detekt.testkit.DslTestBuilder
 import io.gitlab.arturbosch.detekt.testkit.ProjectLayout
 import org.assertj.core.api.Assertions.assertThat
 import org.gradle.testkit.runner.TaskOutcome
-import org.spekframework.spek2.Spek
-import org.spekframework.spek2.style.specification.describe
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.MethodSource
 
-internal class CreateBaselineTaskDslSpec : Spek({
-    describe("The detektBaseline task of the Detekt Gradle plugin") {
-        listOf(DslTestBuilder.groovy(), DslTestBuilder.kotlin()).forEach { builder ->
-            describe("using ${builder.gradleBuildName}") {
-                it("can be executed when baseline file is specified") {
-                    val baselineFilename = "baseline.xml"
+class CreateBaselineTaskDslSpec {
+    @ParameterizedTest(name = "Using {0}, detektBaseline task can be executed when baseline file is specified")
+    @MethodSource("io.gitlab.arturbosch.detekt.testkit.DslTestBuilder#builders")
+    fun baselineTaskExecutableWhenBaselineFileSpecified(builder: DslTestBuilder) {
+        val baselineFilename = "baseline.xml"
 
-                    val detektConfig = """
-                        |detekt {
-                        |   baseline = file("$baselineFilename")
-                        |}
-                        """
-                    val gradleRunner = builder
-                        .withProjectLayout(
-                            ProjectLayout(
-                                numberOfSourceFilesInRootPerSourceDir = 1,
-                                numberOfCodeSmellsInRootPerSourceDir = 1,
-                            )
-                        )
-                        .withDetektConfig(detektConfig)
-                        .build()
+        val detektConfig = """
+            |detekt {
+            |   baseline = file("$baselineFilename")
+            |}
+            """
+        val gradleRunner = builder
+            .withProjectLayout(
+                ProjectLayout(
+                    numberOfSourceFilesInRootPerSourceDir = 1,
+                    numberOfCodeSmellsInRootPerSourceDir = 1,
+                )
+            )
+            .withDetektConfig(detektConfig)
+            .build()
 
-                    gradleRunner.runTasksAndCheckResult("detektBaseline") { result ->
-                        assertThat(result.task(":detektBaseline")?.outcome).isEqualTo(TaskOutcome.SUCCESS)
-                        assertThat(projectFile(baselineFilename)).exists()
-                        assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).doesNotExist()
-                    }
-                }
+        gradleRunner.runTasksAndCheckResult("detektBaseline") { result ->
+            assertThat(result.task(":detektBaseline")?.outcome).isEqualTo(TaskOutcome.SUCCESS)
+            assertThat(projectFile(baselineFilename)).exists()
+            assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).doesNotExist()
+        }
+    }
 
-                it("can be executed when baseline file is not specified") {
-                    val detektConfig = """
-                        |detekt {
-                        |}
-                        """
-                    val gradleRunner = builder
-                        .withProjectLayout(
-                            ProjectLayout(
-                                numberOfSourceFilesInRootPerSourceDir = 1,
-                                numberOfCodeSmellsInRootPerSourceDir = 1,
-                            )
-                        )
-                        .withDetektConfig(detektConfig)
-                        .build()
+    @ParameterizedTest(name = "Using {0}, detektBaseline task can be executed when baseline file is not specified")
+    @MethodSource("io.gitlab.arturbosch.detekt.testkit.DslTestBuilder#builders")
+    fun baselineTaskExecutableWhenBaselineFileNotSpecified(builder: DslTestBuilder) {
+        val detektConfig = """
+            |detekt {
+            |}
+            """
+        val gradleRunner = builder
+            .withProjectLayout(
+                ProjectLayout(
+                    numberOfSourceFilesInRootPerSourceDir = 1,
+                    numberOfCodeSmellsInRootPerSourceDir = 1,
+                )
+            )
+            .withDetektConfig(detektConfig)
+            .build()
 
-                    gradleRunner.runTasksAndCheckResult("detektBaseline") { result ->
-                        assertThat(result.task(":detektBaseline")?.outcome).isEqualTo(TaskOutcome.SUCCESS)
-                        assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).exists()
-                    }
-                }
+        gradleRunner.runTasksAndCheckResult("detektBaseline") { result ->
+            assertThat(result.task(":detektBaseline")?.outcome).isEqualTo(TaskOutcome.SUCCESS)
+            assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).exists()
+        }
+    }
 
-                it("can not be executed when baseline file is specified null") {
-                    val detektConfig = """
-                        |detekt {
-                        |   baseline = null
-                        |}
-                        """
-                    val gradleRunner = builder
-                        .withProjectLayout(
-                            ProjectLayout(
-                                numberOfSourceFilesInRootPerSourceDir = 1,
-                                numberOfCodeSmellsInRootPerSourceDir = 1,
-                            )
-                        )
-                        .withDetektConfig(detektConfig)
-                        .build()
+    @ParameterizedTest(name = "Using {0}, detektBaseline task can not be executed when baseline file is specified null")
+    @MethodSource("io.gitlab.arturbosch.detekt.testkit.DslTestBuilder#builders")
+    fun baselineTaskNotExecutableWhenBaselineFileIsNull(builder: DslTestBuilder) {
+        val detektConfig = """
+            |detekt {
+            |   baseline = null
+            |}
+            """
+        val gradleRunner = builder
+            .withProjectLayout(
+                ProjectLayout(
+                    numberOfSourceFilesInRootPerSourceDir = 1,
+                    numberOfCodeSmellsInRootPerSourceDir = 1,
+                )
+            )
+            .withDetektConfig(detektConfig)
+            .build()
 
-                    gradleRunner.runTasksAndExpectFailure("detektBaseline") { result ->
-                        assertThat(result.output).contains("property 'baseline' doesn't have a configured value")
-                        assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).doesNotExist()
-                    }
-                }
-            }
+        gradleRunner.runTasksAndExpectFailure("detektBaseline") { result ->
+            assertThat(result.output).contains("property 'baseline' doesn't have a configured value")
+            assertThat(projectFile(DEFAULT_BASELINE_FILENAME)).doesNotExist()
         }
     }
-})
+}
 
 private const val DEFAULT_BASELINE_FILENAME = "detekt-baseline.xml"
diff --git a/...dle-plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/DetektReportMergeSpec.kt b/...dle-plugin/src/functionalTest/kotlin/io/gitlab/arturbosch/detekt/DetektReportMergeSpec.kt
@@ -4,15 +4,19 @@ import io.gitlab.arturbosch.detekt.testkit.DslGradleRunner
 import io.gitlab.arturbosch.detekt.testkit.DslTestBuilder
 import io.gitlab.arturbosch.detekt.testkit.ProjectLayout
 import org.assertj.core.api.Assertions.assertThat
-import org.spekframework.spek2.Spek
-import org.spekframework.spek2.style.specification.describe
+import org.junit.jupiter.api.Nested
+import org.junit.jupiter.params.ParameterizedTest
+import org.junit.jupiter.params.provider.Arguments
+import org.junit.jupiter.params.provider.Arguments.arguments
+import org.junit.jupiter.params.provider.MethodSource
 
-internal class DetektReportMergeSpec : Spek({
+class DetektReportMergeSpec {
 
-    describe("Sarif merge is configured correctly for multi module project") {
+    @Nested
+    inner class `Sarif merge is configured correctly for multi module project` {
 
-        val groovy by memoized { DslTestBuilder.groovy() }
-        val groovyBuildFileContent by memoized {
+        val groovy = DslTestBuilder.groovy()
+        val groovyBuildFileContent =
             """
             |${groovy.gradlePlugins}
             |
@@ -41,9 +45,8 @@ internal class DetektReportMergeSpec : Spek({
             |  }
             |}
             |""".trimMargin()
-        }
-        val kotlin by memoized { DslTestBuilder.kotlin() }
-        val kotlinBuildFileContent by memoized {
+        val kotlin = DslTestBuilder.kotlin()
+        val kotlinBuildFileContent =
             """
             |${kotlin.gradlePlugins}
             |
@@ -72,45 +75,47 @@ internal class DetektReportMergeSpec : Spek({
             |  }
             |}
             |""".trimMargin()
-        }
 
-        it("using Groovy and Kotlin") {
-            listOf(
-                groovy to groovyBuildFileContent,
-                kotlin to kotlinBuildFileContent
-            ).forEach { (builder, mainBuildFileContent) ->
-                val projectLayout = ProjectLayout(numberOfSourceFilesInRootPerSourceDir = 0).apply {
-                    addSubmodule(
-                        name = "child1",
-                        numberOfSourceFilesPerSourceDir = 2,
-                        numberOfCodeSmells = 2
-                    )
-                    addSubmodule(
-                        name = "child2",
-                        numberOfSourceFilesPerSourceDir = 4,
-                        numberOfCodeSmells = 4
-                    )
-                }
+        fun scenarios(): List<Arguments> = listOf(
+            arguments(groovy, groovyBuildFileContent),
+            arguments(kotlin, kotlinBuildFileContent)
+        )
+
+        @ParameterizedTest(name = "Using {0}")
+        @MethodSource("scenarios")
+        fun sarifMerge(builder: DslTestBuilder, mainBuildFileContent: String) {
+            val projectLayout = ProjectLayout(numberOfSourceFilesInRootPerSourceDir = 0).apply {
+                addSubmodule(
+                    name = "child1",
+                    numberOfSourceFilesPerSourceDir = 2,
+                    numberOfCodeSmells = 2
+                )
+                addSubmodule(
+                    name = "child2",
+                    numberOfSourceFilesPerSourceDir = 4,
+                    numberOfCodeSmells = 4
+                )
+            }
 
-                val gradleRunner = DslGradleRunner(projectLayout, builder.gradleBuildName, mainBuildFileContent)
-                gradleRunner.setupProject()
-                gradleRunner.runTasksAndExpectFailure("detekt", "sarifReportMerge", "--continue") { _ ->
-                    assertThat(projectFile("build/reports/detekt/detekt.sarif")).doesNotExist()
-                    assertThat(projectFile("build/reports/detekt/merge.sarif")).exists()
-                    assertThat(projectFile("build/reports/detekt/merge.sarif").readText())
-                        .contains("\"ruleId\": \"detekt.style.MagicNumber\"")
-                    projectLayout.submodules.forEach {
-                        assertThat(projectFile("${it.name}/build/reports/detekt/detekt.sarif")).exists()
-                    }
+            val gradleRunner = DslGradleRunner(projectLayout, builder.gradleBuildName, mainBuildFileContent)
+            gradleRunner.setupProject()
+            gradleRunner.runTasksAndExpectFailure("detekt", "sarifReportMerge", "--continue") { _ ->
+                assertThat(projectFile("build/reports/detekt/detekt.sarif")).doesNotExist()
+                assertThat(projectFile("build/reports/detekt/merge.sarif")).exists()
+                assertThat(projectFile("build/reports/detekt/merge.sarif").readText())
+                    .contains("\"ruleId\": \"detekt.style.MagicNumber\"")
+                projectLayout.submodules.forEach {
+                    assertThat(projectFile("${it.name}/build/reports/detekt/detekt.sarif")).exists()
                 }
             }
         }
     }
 
-    describe("XML merge is configured correctly for multi module project") {
+    @Nested
+    inner class `XML merge is configured correctly for multi module project` {
 
-        val groovy by memoized { DslTestBuilder.groovy() }
-        val groovyBuildFileContent by memoized {
+        val groovy = DslTestBuilder.groovy()
+        val groovyBuildFileContent =
             """
             |${groovy.gradlePlugins}
             |
@@ -139,9 +144,8 @@ internal class DetektReportMergeSpec : Spek({
             |  }
             |}
             |""".trimMargin()
-        }
-        val kotlin by memoized { DslTestBuilder.kotlin() }
-        val kotlinBuildFileContent by memoized {
+        val kotlin = DslTestBuilder.kotlin()
+        val kotlinBuildFileContent =
             """
             |${kotlin.gradlePlugins}
             |
@@ -170,38 +174,39 @@ internal class DetektReportMergeSpec : Spek({
             |  }
             |}
             |""".trimMargin()
-        }
 
-        it("using Groovy and Kotlin") {
-            listOf(
-                groovy to groovyBuildFileContent,
-                kotlin to kotlinBuildFileContent
-            ).forEach { (builder, mainBuildFileContent) ->
-                val projectLayout = ProjectLayout(numberOfSourceFilesInRootPerSourceDir = 0).apply {
-                    addSubmodule(
-                        name = "child1",
-                        numberOfSourceFilesPerSourceDir = 2,
-                        numberOfCodeSmells = 2
-                    )
-                    addSubmodule(
-                        name = "child2",
-                        numberOfSourceFilesPerSourceDir = 4,
-                        numberOfCodeSmells = 4
-                    )
-                }
+        fun scenarios(): List<Arguments> = listOf(
+            arguments(groovy, groovyBuildFileContent),
+            arguments(kotlin, kotlinBuildFileContent)
+        )
+
+        @ParameterizedTest(name = "Using {0}")
+        @MethodSource("scenarios")
+        fun sarifMerge(builder: DslTestBuilder, mainBuildFileContent: String) {
+            val projectLayout = ProjectLayout(numberOfSourceFilesInRootPerSourceDir = 0).apply {
+                addSubmodule(
+                    name = "child1",
+                    numberOfSourceFilesPerSourceDir = 2,
+                    numberOfCodeSmells = 2
+                )
+                addSubmodule(
+                    name = "child2",
+                    numberOfSourceFilesPerSourceDir = 4,
+                    numberOfCodeSmells = 4
+                )
+            }
 
-                val gradleRunner = DslGradleRunner(projectLayout, builder.gradleBuildName, mainBuildFileContent)
-                gradleRunner.setupProject()
-                gradleRunner.runTasksAndExpectFailure("detekt", "xmlReportMerge", "--continue") { _ ->
-                    assertThat(projectFile("build/reports/detekt/detekt.xml")).doesNotExist()
-                    assertThat(projectFile("build/reports/detekt/merge.xml")).exists()
-                    assertThat(projectFile("build/reports/detekt/merge.xml").readText())
-                        .contains("<error column=\"30\" line=\"4\"")
-                    projectLayout.submodules.forEach {
-                        assertThat(projectFile("${it.name}/build/reports/detekt/detekt.xml")).exists()
-                    }
+            val gradleRunner = DslGradleRunner(projectLayout, builder.gradleBuildName, mainBuildFileContent)
+            gradleRunner.setupProject()
+            gradleRunner.runTasksAndExpectFailure("detekt", "xmlReportMerge", "--continue") { _ ->
+                assertThat(projectFile("build/reports/detekt/detekt.xml")).doesNotExist()
+                assertThat(projectFile("build/reports/detekt/merge.xml")).exists()
+                assertThat(projectFile("build/reports/detekt/merge.xml").readText())
+                    .contains("<error column=\"30\" line=\"4\"")
+                projectLayout.submodules.forEach {
+                    assertThat(projectFile("${it.name}/build/reports/detekt/detekt.xml")).exists()
                 }
             }
         }
     }
-})
+}