Skip to content

Commit

Permalink
Improve tests making them more exhaustive
Browse files Browse the repository at this point in the history
  • Loading branch information
@BraisGabin
BraisGabin committed Dec 10, 2021
1 parent 69b5566 commit f117e87
Showing 1 changed file with 80 additions and 29 deletions.
109 changes: 80 additions & 29 deletions detekt-api/src/test/kotlin/io/gitlab/arturbosch/detekt/api/AnnotationExcluderSpec.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,50 +12,101 @@ class AnnotationExcluderSpec : Spek({
val psiFactory by memoized(CachingMode.SCOPE) { createPsiFactory() }

describe("a kt file with some imports") {

val jvmFieldAnnotation by memoized { psiFactory.createAnnotationEntry("@JvmField") }
val fullyQualifiedJvmFieldAnnotation by memoized { psiFactory.createAnnotationEntry("@kotlin.jvm.JvmField") }
val sinceKotlinAnnotation by memoized { psiFactory.createAnnotationEntry("@SinceKotlin") }

val file by memoized {
compileContentForTest(
"""
package foo

import kotlin.jvm.JvmField
import dagger.Component
import dagger.Component.Factory
""".trimIndent()
)
}

it("should exclude when the annotation was found") {
val excluder = AnnotationExcluder(file, listOf("JvmField"))
assertThat(excluder.shouldExclude(listOf(jvmFieldAnnotation))).isTrue()
}
context("All cases") {
data class Case(val excludes: String, val annotation: String)

it("should not exclude when the annotation was not found") {
val excluder = AnnotationExcluder(file, listOf("Jvm Field"))
assertThat(excluder.shouldExclude(listOf(jvmFieldAnnotation))).isFalse()
}
mapOf(
Case("Component", "@Component") to true,
Case("Component", "@dagger.Component") to true,
Case("Component", "@Factory") to true, // false positive
Case("Component", "@Component.Factory") to true, // false positive
Case("Component", "@dagger.Component.Factory") to true, // false positive
Case("dagger.Component", "@Component") to true,
Case("dagger.Component", "@dagger.Component") to true,
Case("dagger.Component", "@Factory") to true, // false positive
Case("dagger.Component", "@Component.Factory") to false,
Case("dagger.Component", "@dagger.Component.Factory") to true, // false positive
Case("Component.Factory", "@Component") to false,
Case("Component.Factory", "@dagger.Component") to false,
Case("Component.Factory", "@Factory") to true,
Case("Component.Factory", "@Component.Factory") to true,
Case("Component.Factory", "@dagger.Component.Factory") to true,
Case("dagger.Component.Factory", "@Component") to false,
Case("dagger.Component.Factory", "@dagger.Component") to false,
Case("dagger.Component.Factory", "@Factory") to true,
Case("dagger.Component.Factory", "@Component.Factory") to false, // false negative
Case("dagger.Component.Factory", "@dagger.Component.Factory") to true,
Case("Factory", "@Component") to false,
Case("Factory", "@dagger.Component") to false,
Case("Factory", "@Factory") to true,
Case("Factory", "@Component.Factory") to true,
Case("Factory", "@dagger.Component.Factory") to true,
Case("dagger.", "@Component") to true,
Case("dagger.", "@dagger.Component") to true,
Case("dagger.", "@Factory") to true,
Case("dagger.", "@Component.Factory") to false, // false positive
Case("dagger.", "@dagger.Component.Factory") to true,
Case(".Component.Factory", "@Component") to false,
Case(".Component.Factory", "@dagger.Component") to false,
Case(".Component.Factory", "@Factory") to true,
Case(".Component.Factory", "@Component.Factory") to false, // false negative
Case(".Component.Factory", "@dagger.Component.Factory") to true,
Case(".Component.", "@Component") to false,
Case(".Component.", "@dagger.Component") to false,
Case(".Component.", "@Factory") to true,
Case(".Component.", "@Component.Factory") to false, // false negative
Case(".Component.", "@dagger.Component.Factory") to true,
Case("foo.Component", "@Component") to false,
Case("foo.Component", "@dagger.Component") to false,
Case("foo.Component", "@Factory") to false,
Case("foo.Component", "@Component.Factory") to false,
Case("foo.Component", "@dagger.Component.Factory") to false,
).forEach { (case, expected) ->
val (exclude, annotation) = case
it("With exclude $exclude and annotation $annotation") {
val excluder = AnnotationExcluder(file, listOf(exclude))

it("should not exclude when no annotations should be excluded") {
val excluder = AnnotationExcluder(file, emptyList())
assertThat(excluder.shouldExclude(listOf(jvmFieldAnnotation))).isFalse()
val ktAnnotation = psiFactory.createAnnotationEntry(annotation)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isEqualTo(expected)
}
}
}

it("should exclude when the annotation was found with its fully qualified name") {
val excluder = AnnotationExcluder(file, listOf("JvmField"))
assertThat(excluder.shouldExclude(listOf(fullyQualifiedJvmFieldAnnotation))).isTrue()
}
context("special cases") {
val annotation by memoized { psiFactory.createAnnotationEntry("@Component") }
val sinceKotlinAnnotation by memoized { psiFactory.createAnnotationEntry("@SinceKotlin") }

it("should also exclude an annotation that is not imported") {
val excluder = AnnotationExcluder(file, listOf("SinceKotlin"))
assertThat(excluder.shouldExclude(listOf(sinceKotlinAnnotation))).isTrue()
}
it("should not exclude when the annotation was not found") {
val excluder = AnnotationExcluder(file, listOf("SinceKotlin"))
assertThat(excluder.shouldExclude(listOf(annotation))).isFalse()
}

it("should not exclude when no annotations should be excluded") {
val excluder = AnnotationExcluder(file, emptyList())
assertThat(excluder.shouldExclude(listOf(annotation))).isFalse()
}

it("should also exclude an annotation that is not imported") {
val excluder = AnnotationExcluder(file, listOf("SinceKotlin"))
assertThat(excluder.shouldExclude(listOf(sinceKotlinAnnotation))).isTrue()
}

it("should exclude when the annotation was found with SplitPattern") {
@Suppress("DEPRECATION")
val excluder = AnnotationExcluder(file, SplitPattern("JvmField"))
assertThat(excluder.shouldExclude(listOf(jvmFieldAnnotation))).isTrue()
it("should exclude when the annotation was found with SplitPattern") {
@Suppress("DEPRECATION")
val excluder = AnnotationExcluder(file, SplitPattern("SinceKotlin"))
assertThat(excluder.shouldExclude(listOf(sinceKotlinAnnotation))).isTrue()
}
}
}
})

0 comments on commit f117e87

Please sign in to comment.