Drop Spek (#4670)

Co-authored-by: Goooler <wangzongler@gmail.com> Co-authored-by: Nicola Corti <corti.nico@gmail.com>
detekt · Apr 11, 2022 · 8939aed · 8939aed
1 parent d28d0af
commit 8939aed
Show file tree

Hide file tree

Showing 17 changed files with 59 additions and 365 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -10,9 +10,8 @@
 - We use [JUnit 5](https://junit.org/junit5/docs/current/user-guide/) for testing. Please use the `Spec.kt` suffix on
   new test classes. If your new rule requires type resolution (i.e. it utilises `BindingContext`) then annotate your
   test class with `@KotlinCoreEnvironmentTest` and have the test class accept `KotlinCoreEnvironment` as a parameter.
-  See `SpekTestDiscoverySpec.kt` in the `custom-checks` module for a complete example.
-- We are in the process of migrating existing [Spek](https://github.com/spekframework/spek) tests to JUnit 5. For easier
-  testing of these tests you might want to use the [Spek IntelliJ Plugin](https://plugins.jetbrains.com/plugin/10915-spek-framework).
+  See "Testing a rule that uses type resolution" section of the [Using Type Resolution](../docs/pages/gettingstarted/type-resolution.md)
+  guide for details.
 - Feel free to add your name to the contributors list at the end of the readme file when opening a pull request.
 - The code in `detekt-api` and any rule in `detekt-rules` must be documented. We generate documentation for our website based on these modules.
 - If some Kotlin code in `resources` folder (like `detekt-formatting`) shows a compilation error, right click on it and use `Mark as plain text`.

diff --git a/build-logic/src/main/kotlin/module.gradle.kts b/build-logic/src/main/kotlin/module.gradle.kts
@@ -26,9 +26,6 @@ tasks.withType<PublishToMavenRepository>().configureEach {
 
 tasks.withType<Test>().configureEach {
     useJUnitPlatform()
-    systemProperty("spek2.jvm.cg.scan.concurrency", 1) // use one thread for classpath scanning
-    systemProperty("spek2.execution.test.timeout", 0) // disable test timeout
-    systemProperty("spek2.discovery.parallel.enabled", 0) // disable parallel test discovery
     systemProperty("junit.jupiter.testinstance.lifecycle.default", "per_class")
     val compileSnippetText: Boolean = if (project.hasProperty("compile-test-snippets")) {
         (project.property("compile-test-snippets") as String).toBoolean()

diff --git a/build.gradle.kts b/build.gradle.kts
@@ -27,7 +27,6 @@ allprojects {
 
     dependencies {
         detekt(project(":detekt-cli"))
-        detektPlugins(project(":custom-checks"))
         detektPlugins(project(":detekt-formatting"))
     }
 

diff --git a/code-coverage-report/build.gradle.kts b/code-coverage-report/build.gradle.kts
@@ -14,7 +14,6 @@ reporting {
 jacoco.toolVersion = libs.versions.jacoco.get()
 
 dependencies {
-    jacocoAggregation(projects.customChecks)
     jacocoAggregation(projects.detektApi)
     jacocoAggregation(projects.detektCli)
     jacocoAggregation(projects.detektCore)

diff --git a/config/detekt/detekt.yml b/config/detekt/detekt.yml
@@ -1,15 +1,3 @@
-config:
-  # is automatically ignored when custom-checks.jar is on the classpath
-  # however other CI checks use the argsfile where our plugin is not applied
-  # we need to care take of this by explicitly allowing this properties
-  excludes: 'custom-checks.*'
-
-custom-checks:
-  active: true
-  SpekTestDiscovery:
-    active: true
-    includes: ['**/test/**/*Spec.kt']
-
 comments:
   CommentOverPrivateProperty:
     active: true

diff --git a/custom-checks/build.gradle.kts b/custom-checks/build.gradle.kts
diff --git a/custom-checks/src/main/kotlin/io/github/detekt/custom/CustomChecksConfigValidator.kt b/custom-checks/src/main/kotlin/io/github/detekt/custom/CustomChecksConfigValidator.kt
diff --git a/custom-checks/src/main/kotlin/io/github/detekt/custom/CustomChecksProvider.kt b/custom-checks/src/main/kotlin/io/github/detekt/custom/CustomChecksProvider.kt
diff --git a/custom-checks/src/main/kotlin/io/github/detekt/custom/SpekTestDiscovery.kt b/custom-checks/src/main/kotlin/io/github/detekt/custom/SpekTestDiscovery.kt
diff --git a/...ecks/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.ConfigValidator b/...ecks/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.ConfigValidator
diff --git a/...ecks/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider b/...ecks/src/main/resources/META-INF/services/io.gitlab.arturbosch.detekt.api.RuleSetProvider
diff --git a/custom-checks/src/test/kotlin/io/github/detekt/custom/SpekTestDiscoverySpec.kt b/custom-checks/src/test/kotlin/io/github/detekt/custom/SpekTestDiscoverySpec.kt
diff --git a/...est-utils/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/KotlinEnvironmentTestSetup.kt b/...est-utils/src/main/kotlin/io/gitlab/arturbosch/detekt/rules/KotlinEnvironmentTestSetup.kt
@@ -11,6 +11,10 @@ import org.spekframework.spek2.dsl.Root
 import org.spekframework.spek2.lifecycle.CachingMode
 import java.nio.file.Path
 
+@Deprecated(
+    "This is specific to Spek and will be removed in a future release. Documentation has been updated to " +
+        "show alternative approaches: https://detekt.dev/type-resolution.html#testing-a-rule-that-uses-type-resolution"
+)
 fun Root.setupKotlinEnvironment(additionalJavaSourceRootPath: Path? = null) {
     val wrapper by memoized(
         CachingMode.SCOPE,