/
AnnotationExcluderSpec.kt
223 lines (174 loc) · 8.33 KB
/
AnnotationExcluderSpec.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
package io.gitlab.arturbosch.detekt.api
import io.github.detekt.test.utils.compileContentForTest
import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest
import io.gitlab.arturbosch.detekt.test.getContextForPaths
import org.assertj.core.api.Assertions.assertThat
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.jetbrains.kotlin.psi.KtAnnotationEntry
import org.jetbrains.kotlin.psi.KtFile
import org.jetbrains.kotlin.psi.KtFunction
import org.jetbrains.kotlin.resolve.BindingContext
import org.junit.jupiter.api.Disabled
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import org.junit.jupiter.params.ParameterizedTest
import org.junit.jupiter.params.provider.CsvFileSource
@KotlinCoreEnvironmentTest
class AnnotationExcluderSpec(private val env: KotlinCoreEnvironment) {
private val annotationsKtFile = compileContentForTest(
"""
package dagger
annotation class Component {
annotation class Factory
}
""".trimIndent()
)
@ParameterizedTest(
name = "Given {0} is excluded when the {1} is found then the excluder returns {2} without type solving"
)
@CsvFileSource(resources = ["/annotation_excluder.csv"])
fun `all cases`(exclusion: String, annotation: String, shouldExclude: Boolean) {
val (file, ktAnnotation) = createKtFile(annotation)
val excluder = AnnotationExcluder(file, listOf(exclusion.toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isEqualTo(shouldExclude)
}
@ParameterizedTest(
name = "Given {0} is excluded when the {1} is found then the excluder returns {2} with type solving"
)
@CsvFileSource(resources = ["/annotation_excluder.csv"])
fun `all cases - Type Solving`(exclusion: String, annotation: String, shouldExclude: Boolean) {
val (file, ktAnnotation) = createKtFile(annotation)
val binding = env.getContextForPaths(listOf(file, annotationsKtFile))
val excluder = AnnotationExcluder(file, listOf(exclusion.toRegex()), binding)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isEqualTo(shouldExclude)
}
@Nested
inner class `special cases` {
@Test
fun `should not exclude when the annotation was not found`() {
val (file, ktAnnotation) = createKtFile("@Component")
val excluder = AnnotationExcluder(file, listOf("SinceKotlin".toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isFalse()
}
@Test
fun `should not exclude when no annotations should be excluded`() {
val (file, ktAnnotation) = createKtFile("@Component")
val excluder = AnnotationExcluder(file, emptyList(), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isFalse()
}
@Test
fun `should also exclude an annotation that is not imported`() {
val (file, ktAnnotation) = createKtFile("@SinceKotlin")
val excluder = AnnotationExcluder(file, listOf("SinceKotlin".toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
}
@Test
fun `should exclude when the annotation was found with SplitPattern`() {
val (file, ktAnnotation) = createKtFile("@SinceKotlin")
@Suppress("DEPRECATION")
val excluder = AnnotationExcluder(file, SplitPattern("SinceKotlin"))
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
}
@Test
fun `should exclude when the annotation was found with List of Strings`() {
val (file, ktAnnotation) = createKtFile("@SinceKotlin")
@Suppress("DEPRECATION")
val excluder = AnnotationExcluder(file, listOf("SinceKo*"))
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
}
}
@Nested
inner class `difference between type solving and no type solving` {
@Nested
inner class `Don't mix annotations with the same name` {
@Test
fun `incorrect without type solving`() {
val (file, ktAnnotation) = createKtFile("@Deprecated")
val excluder = AnnotationExcluder(file, listOf("foo\\.Deprecated".toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
}
@Test
fun `correct without type solving`() {
val (file, ktAnnotation) = createKtFile("@Deprecated")
val binding = env.getContextForPaths(listOf(file, annotationsKtFile))
val excluder = AnnotationExcluder(file, listOf("foo\\.Deprecated".toRegex()), binding)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isFalse()
}
}
@Nested
inner class `Know where a package ends` {
val helloWorldAnnotationsKtFile = compileContentForTest(
"""
package com.Hello
annotation class World
""".trimIndent()
)
val file = compileContentForTest(
"""
package foo
import com.Hello.World
@World
fun function() = Unit
""".trimIndent()
)
val ktAnnotation = file.findChildByClass(KtFunction::class.java)!!.annotationEntries.first()!!
@Test
fun `incorrect without type solving`() {
val excluder = AnnotationExcluder(file, listOf("Hello\\.World".toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
}
@Test
@Disabled("This should be doable but it's not imlemented yet")
fun `correct with type solving`() {
val binding = env.getContextForPaths(listOf(file, helloWorldAnnotationsKtFile))
val excluder = AnnotationExcluder(file, listOf("Hello\\.World".toRegex()), binding)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isFalse()
}
}
@Nested
inner class `Know how to work with star imports` {
val helloWorldAnnotationsKtFile = compileContentForTest(
"""
package com.hello
annotation class World
""".trimIndent()
)
val file = compileContentForTest(
"""
package foo
import com.hello.*
@World
fun function() = Unit
""".trimIndent()
)
val ktAnnotation = file.findChildByClass(KtFunction::class.java)!!.annotationEntries.first()!!
@Test
fun `incorrect without type solving`() {
val excluder = AnnotationExcluder(file, listOf("foo\\.World".toRegex()), BindingContext.EMPTY)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isTrue()
val excluder2 = AnnotationExcluder(file, listOf("com\\.hello\\.World".toRegex()), BindingContext.EMPTY)
assertThat(excluder2.shouldExclude(listOf(ktAnnotation))).isTrue()
}
@Test
fun `correct with type solving`() {
val binding = env.getContextForPaths(listOf(file, helloWorldAnnotationsKtFile))
val excluder = AnnotationExcluder(file, listOf("foo\\.World".toRegex()), binding)
assertThat(excluder.shouldExclude(listOf(ktAnnotation))).isFalse()
val excluder2 = AnnotationExcluder(file, listOf("com\\.hello\\.World".toRegex()), binding)
assertThat(excluder2.shouldExclude(listOf(ktAnnotation))).isTrue()
}
}
}
}
private fun createKtFile(annotation: String): Pair<KtFile, KtAnnotationEntry> {
val file = compileContentForTest(
"""
package foo
import dagger.Component
import dagger.Component.Factory
$annotation
fun function() = Unit
""".trimIndent()
)
return file to file.findChildByClass(KtFunction::class.java)!!.annotationEntries.first()
}