-
-
Notifications
You must be signed in to change notification settings - Fork 755
/
UseDataClassSpec.kt
422 lines (366 loc) · 14.2 KB
/
UseDataClassSpec.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
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.Config
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.compileAndLint
import io.gitlab.arturbosch.detekt.test.compileAndLintWithContext
import io.gitlab.arturbosch.detekt.test.lint
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
private const val ALLOW_VARS = "allowVars"
private const val EXCLUDE_ANNOTATED_CLASSES = "excludeAnnotatedClasses"
@KotlinCoreEnvironmentTest
class UseDataClassSpec(val env: KotlinCoreEnvironment) {
val subject = UseDataClass(Config.empty)
@Nested
inner class `does not report invalid data class candidates` {
@Test
fun `does not report a valid class`() {
val code = """
class NoDataClassCandidate(val i: Int) {
val i2: Int = 0
fun f() {
println()
}
object Obj
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate class with additional method`() {
val code = """
class NoDataClassCandidateWithAdditionalMethod(val i: Int) {
fun f1() {
println()
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate class with a private constructor`() {
val code = """
class NoDataClassCandidateWithOnlyPrivateCtor1 private constructor(val i: Int)
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate class with a private explicit constructor`() {
val code = """
class NoDataClassCandidateWithOnlyPrivateCtor2 {
private constructor(i: Int)
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate sealed class`() {
val code = """
sealed class NoDataClassBecauseItsSealed {
data class Success(val any: Any) : NoDataClassBecauseItsSealed()
data class Error(val error: Throwable) : NoDataClassBecauseItsSealed()
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate enum class`() {
val code = """
enum class EnumNoDataClass(val i: Int) {
FIRST(1), SECOND(2);
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate annotation class`() {
val code = """
annotation class AnnotationNoDataClass(val i: Int)
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a candidate with an interface that has methods`() {
val code = """
interface SomeInterface {
fun foo(): Int
}
class NotDataClassBecauseItsImplementingInterfaceWithMethods(val i : Int): SomeInterface {
override fun foo() = i
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report an existing data class candidate with an interface`() {
val code = """
interface SimpleInterface {
val i: Int
}
data class DataClass(override val i: Int): SimpleInterface
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a class extending a class and implementing an interface`() {
val code = """
interface SimpleInterface {
val i: Int
}
open class BaseClass(open val j: Int)
class DataClass(override val i: Int, override val j: Int): SimpleInterface, BaseClass(j)
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a class with delegating interface`() {
val code = """
interface I
class B() : I
class A(val b: B) : I by b
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
}
@Nested
inner class `does report data class candidates` {
@Test
fun `does report a data class candidate on the class name`() {
val code = """
class DataClassCandidate1(val i: Int)
""".trimIndent()
val findings = subject.compileAndLint(code)
assertThat(findings).hasSize(1)
assertThat(findings).hasStartSourceLocation(1, 7)
assertThat(findings).hasEndSourceLocation(1, 26)
}
@Test
fun `does report a candidate class with extra property`() {
val code = """
class DataClassCandidateWithProperties(val i: Int) {
val i2: Int = 0
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does report a candidate class with extra public constructor`() {
val code = """
class DataClassCandidate2(val s: String) {
private constructor(i: Int) : this(i.toString())
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does report a candidate class with both a private and public constructor`() {
val code = """
class DataClassCandidate3 private constructor(val s: String) {
constructor(i: Int) : this(i.toString())
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does report a candidate class with overridden data class methods`() {
val code = """
class DataClassCandidateWithOverriddenMethods(val i: Int) {
override fun equals(other: Any?): Boolean {
return super.equals(other)
}
override fun hashCode(): Int {
return super.hashCode()
}
override fun toString(): String {
return super.toString()
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does report a candidate class with a simple interface extension`() {
val code = """
interface SimpleInterface
class DataClass(val i: Int): SimpleInterface
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does report a candidate class with an interface extension that overrides vals`() {
val code = """
interface SimpleInterface {
val i: Int
}
class DataClass(override val i: Int): SimpleInterface
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
}
@Nested
inner class `copy method` {
@Test
fun `does report with copy method`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: String): D = D(a, b)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does report with copy method which has an implicit return type`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: String) = D(a, b)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report with copy method which has no parameters`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(): D = D(0, "")
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report with copy method which has more parameters than the primary constructor`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: String, c: String): D = D(a, b + c)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report with copy method which has different parameter types`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: Int): D = D(a, b.toString())
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report with copy method which has different parameter types 2`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: String?): D = D(a, b.toString())
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report with copy method which has a different return type`() {
val code = """
class D(val a: Int, val b: String) {
fun copy(a: Int, b: String) {
}
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
}
@Nested
inner class `does report class with vars and allowVars` {
@Test
fun `does not report class with mutable constructor parameter`() {
val code = """class DataClassCandidateWithVar(var i: Int)"""
val config = TestConfig(mapOf(ALLOW_VARS to "true"))
assertThat(UseDataClass(config).compileAndLint(code)).isEmpty()
}
@Test
fun `does not report class with mutable properties`() {
val code = """
class DataClassCandidateWithProperties(var i: Int) {
var i2: Int = 0
}
""".trimIndent()
val config = TestConfig(mapOf(ALLOW_VARS to "true"))
assertThat(UseDataClass(config).compileAndLint(code)).isEmpty()
}
@Test
fun `does not report class with both mutable property and immutable parameters`() {
val code = """
class DataClassCandidateWithMixedProperties(val i: Int) {
var i2: Int = 0
}
""".trimIndent()
val config = TestConfig(mapOf(ALLOW_VARS to "true"))
assertThat(UseDataClass(config).compileAndLint(code)).isEmpty()
}
@Test
fun `does not report class with both mutable parameter and immutable property`() {
val code = """
class DataClassCandidateWithMixedProperties(var i: Int) {
val i2: Int = 0
}
""".trimIndent()
val config = TestConfig(mapOf(ALLOW_VARS to "true"))
assertThat(UseDataClass(config).compileAndLint(code)).isEmpty()
}
}
@Test
fun `does not report inline classes`() {
assertThat(subject.lint("inline class A(val x: Int)")).isEmpty()
}
@Test
fun `does not report value classes`() {
val code = """
@JvmInline
value class A(val x: Int)
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report a class which has an ignored annotation`() {
val code = """
import kotlin.SinceKotlin
@SinceKotlin("1.0.0")
class AnnotatedClass(val i: Int) {}
""".trimIndent()
val config = TestConfig(mapOf(EXCLUDE_ANNOTATED_CLASSES to "kotlin.*"))
assertThat(UseDataClass(config).compileAndLint(code)).isEmpty()
}
@Test
fun `does not report a class with a delegated property`() {
val code = """
import kotlin.properties.Delegates
class C(val i: Int) {
var prop: String by Delegates.observable("") {
prop, old, new -> println("")
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `reports class with nested delegation`() {
val code = """
import kotlin.properties.Delegates
class C(val i: Int) {
var prop: C = C(1).apply {
var str: String by Delegates.observable("") {
prop, old, new -> println("")
}
}
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).hasSize(1)
}
@Test
fun `does not report inner classes`() {
val code = """
class Outer {
inner class Inner(val x: Int)
}
""".trimIndent()
assertThat(subject.compileAndLint(code)).isEmpty()
}
}