/
UnnecessaryAbstractClassSpec.kt
326 lines (284 loc) · 11.1 KB
/
UnnecessaryAbstractClassSpec.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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.Finding
import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest
import io.gitlab.arturbosch.detekt.test.TestConfig
import io.gitlab.arturbosch.detekt.test.assertThat
import io.gitlab.arturbosch.detekt.test.compileAndLintWithContext
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
private const val EXCLUDE_ANNOTATED_CLASSES = "excludeAnnotatedClasses"
@KotlinCoreEnvironmentTest
class UnnecessaryAbstractClassSpec(val env: KotlinCoreEnvironment) {
val subject =
UnnecessaryAbstractClass(TestConfig(mapOf(EXCLUDE_ANNOTATED_CLASSES to listOf("Deprecated"))))
@Nested
inner class `abstract classes with no concrete members` {
val message = "An abstract class without a concrete member can be refactored to an interface."
@Test
fun `reports an abstract class with no concrete member`() {
val code = """
abstract class A {
abstract val i: Int
abstract fun f()
public abstract fun f2()
}
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
assertThat(findings).hasSourceLocation(1, 16)
}
@Nested
inner class `reports completely-empty abstract classes` {
@Test
fun `case 1`() {
val code = "abstract class A"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
assertThat(findings).hasSourceLocation(1, 16)
}
@Test
fun `case 2`() {
val code = "abstract class A()"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `case 3`() {
val code = "abstract class A {}"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `case 4`() {
val code = "abstract class A() {}"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `that inherits from an interface`() {
val code = """
interface A {
val i: Int
}
abstract class B : A
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `that inherits from another abstract class`() {
val code = """
@Deprecated("We don't care about this first class")
abstract class A {
abstract val i: Int
}
abstract class B : A()
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report abstract class that inherits from an abstract class and an interface in that order`() {
val code = """
interface I
@Deprecated("We don't care about this first class")
abstract class A {
abstract val i: Int
}
abstract class B: A(), I
"""
val findings = subject.compileAndLintWithContext(env, code)
assertThat(findings).isEmpty()
}
@Test
fun `does not report abstract class that inherits from an interface and an abstract class in that order`() {
val code = """
interface I
@Deprecated("We don't care about this first class")
abstract class A {
abstract val i: Int
}
abstract class B: I, A()
"""
val findings = subject.compileAndLintWithContext(env, code)
assertThat(findings).isEmpty()
}
}
@Test
fun `does not report an abstract class with concrete members derived from a base class`() {
val code = """
abstract class A {
abstract fun f()
val i: Int = 0
}
abstract class B : A() {
abstract fun g()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report an abstract class with a internal abstract member`() {
val code = """
abstract class A {
internal abstract fun f()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report an abstract class with a protected abstract member`() {
val code = """
abstract class A {
protected abstract fun f()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
}
@Nested
inner class `abstract classes with no abstract members` {
val message = "An abstract class without an abstract member can be refactored to a concrete class."
@Test
fun `reports no abstract members in abstract class`() {
val code = """
abstract class A {
val i: Int = 0
fun f() {}
}
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `reports no abstract members in nested abstract class inside a concrete class`() {
val code = """
class Outer {
abstract class Inner {
fun f() {}
}
}
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `reports no abstract members in nested abstract class inside an interface`() {
val code = """
interface Inner {
abstract class A {
fun f() {}
}
}
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `reports no abstract members in an abstract class with just a constructor`() {
val code = "abstract class A(val i: Int)"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
assertThat(findings).hasSourceLocation(1, 16)
}
@Test
fun `reports no abstract members in an abstract class with a body and a constructor`() {
val code = "abstract class A(val i: Int) {}"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
@Test
fun `reports no abstract members in an abstract class with just a constructor parameter`() {
val code = "abstract class A(i: Int)"
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
assertThat(findings).hasSourceLocation(1, 16)
}
@Test
fun `reports an abstract class with no abstract member derived from a class with abstract members`() {
val code = """
abstract class Base {
abstract val i: Int
abstract fun f()
fun f1() {}
}
abstract class Sub : Base() {
override val i: Int
get() = 1
override fun f() {}
fun g() {}
}
"""
val findings = subject.compileAndLintWithContext(env, code)
assertFindingMessage(findings, message)
}
}
@Nested
inner class `abstract classes with members` {
@Test
fun `does not report an abstract class with members and an abstract class derived from it`() {
val code = """
abstract class A {
abstract val i: Int
fun f() {}
}
abstract class B : A() {
fun g() {}
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report an abstract class with a constructor and an abstract class derived from it`() {
val code = """
abstract class A(val i: Int) {
abstract fun f()
}
abstract class B : A(0) {
fun g() {}
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report an abstract class with a function derived from an interface`() {
val code = """
abstract class A : Interface {
fun g() {}
}
interface Interface {
fun f()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report abstract classes with module annotation`() {
val code = """
@Deprecated("test")
abstract class A {
abstract fun f()
}
@kotlin.Deprecated("test")
abstract class B {
abstract fun f()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report abstract classes with properties in the primary constructor`() {
val code = """
interface I {
fun test(): Int
}
abstract class Test(val x: Int) : I
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
}
}
private fun assertFindingMessage(findings: List<Finding>, message: String) {
assertThat(findings).hasSize(1)
assertThat(findings.first()).hasMessage(message)
}