-
-
Notifications
You must be signed in to change notification settings - Fork 757
/
MayBeConstSpec.kt
373 lines (337 loc) · 10.5 KB
/
MayBeConstSpec.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
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.SourceLocation
import io.gitlab.arturbosch.detekt.test.assertThat
import io.gitlab.arturbosch.detekt.test.compileAndLint
import io.gitlab.arturbosch.detekt.test.lint
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
class MayBeConstSpec {
val subject = MayBeConst()
@Nested
inner class `some valid constants` {
@Test
fun `is a valid constant`() {
val code = """
object Something {
const val X = 42
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `is const vals in object`() {
val code = """
object Test {
const val TEST = "Test"
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `isconst vals in companion objects`() {
val code = """
class Test {
companion object {
const val B = 1
}
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `does not report const vals that use other const vals`() {
val code = """
object Something {
const val A = 0
}
class Test {
companion object {
const val B = Something.A + 1
}
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `does not report none const val candidates`() {
val code = """
object Something {
const val a = 0
}
val p = Pair(Something.a, Something.a + Something.a)
val p2 = emptyList<Int>().plus(Something.a)
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
}
@Nested
inner class `some vals that could be constants` {
@Test
fun `is a simple val`() {
val code = """
val x = 1
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(1, 5)
)
}
@Test
fun `is a simple JvmField val`() {
val code = """
@JvmField val x = 1
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(1, 15)
)
}
@Test
fun `is a field in an object`() {
val code = """
object Test {
@JvmField val test = "Test"
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(2, 19)
)
}
@Test
fun `reports vals in companion objects`() {
val code = """
class Test {
companion object {
val b = 1
}
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(3, 13)
)
}
}
@Nested
inner class `vals that can be constants but detekt doesn't handle yet` {
@Test
fun `is a constant binary expression`() {
val code = """
object Something {
const val one = 1
val two = one * 2
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(3, 9)
)
}
@Test
fun `is a constant binary expression in a companion object`() {
val code = """
class Test {
companion object {
const val one = 1
val two = one * 2
}
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(4, 13)
)
}
@Test
fun `is a nested constant binary expression`() {
val code = """
object Something {
const val one = 1
val two = one * 2 + 1
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(3, 9)
)
}
@Test
fun `is a nested constant parenthesised expression`() {
val code = """
object Something {
const val one = 1
val two = one * (2 + 1)
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(3, 9)
)
}
@Test
fun `reports vals that use other const vals`() {
val code = """
object Something {
const val a = 0
@JvmField
val b = a + 1
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(5, 9)
)
}
@Test
fun `reports concatenated string vals`() {
val code = """
object Something {
private const val A = "a"
private val B = A + "b"
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1).hasStartSourceLocations(
SourceLocation(3, 17)
)
}
}
@Nested
inner class `vals that cannot be constants` {
@Test
fun `does not report arrays`() {
val code = "val arr = arrayOf(\"a\", \"b\")"
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `is a var`() {
val code = "var test = 1"
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `has a getter`() {
val code = "val withGetter get() = 42"
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `is initialized to null`() {
val code = "val test = null"
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `is a JvmField in a class`() {
val code = """
class Test {
@JvmField val a = 3
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `has some annotation`() {
val code = """
annotation class A
@A val a = 55
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `overrides something`() {
val code = """
interface Base {
val property: Int
}
object Derived : Base {
override val property = 1
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `does not detect just a dollar as interpolation`() {
val code = """ val hasDollar = "$" """
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(1)
}
@Test
fun `does not report interpolated strings`() {
val innerCode = "\"\"\"object Test { val TEST = \"Test \$test_var\"}\"\"\""
val classReference = "\${AnotherClass::class.java.name}"
val staticReference = "\${AnotherClass.staticVariable}"
val code = """
class AnotherClass {
companion object {
const val staticVariable = ""
}
}
object Something {
val const = "$classReference.EXTRA_DETAILS"
private val A = "asdf=$staticReference"
}
var test_var = "test"
var code = $innerCode
"""
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `does not report vals inside anonymous object declaration`() {
subject.compileAndLint(
"""
fun main() {
val versions = object {
val prop = ""
}
}
"""
)
assertThat(subject.findings).isEmpty()
}
@Test
fun `does not report actual vals`() {
// Until the [KotlinScriptEngine] can compile KMP, we will only lint.
subject.lint("""actual val abc123 = "abc123" """)
assertThat(subject.findings).isEmpty()
}
}
@Nested
inner class `some const val candidates in nested objects` {
@Test
fun `reports the const val candidates`() {
val code = """
object Root {
const val ROOT_CONST = 1
object A1 {
val ACONST = ROOT_CONST + 1
const val ACONST_1 = 1
object B1 {
val BCONST = ACONST_1 + 1
}
}
object A2 {
val ACONST = ROOT_CONST + 1
}
}
"""
subject.compileAndLint(code)
assertThat(subject.findings).hasSize(3).hasStartSourceLocations(
SourceLocation(4, 13),
SourceLocation(7, 17),
SourceLocation(11, 13)
)
}
}
}