forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ExplicitCollectionElementAccessMethodSpec.kt
464 lines (416 loc) · 15.4 KB
/
ExplicitCollectionElementAccessMethodSpec.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
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
package io.gitlab.arturbosch.detekt.rules.style
import io.github.detekt.test.utils.createEnvironment
import io.github.detekt.test.utils.resourceAsPath
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest
import io.gitlab.arturbosch.detekt.test.compileAndLintWithContext
import io.gitlab.arturbosch.detekt.test.lintWithContext
import org.assertj.core.api.Assertions.assertThat
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.junit.jupiter.api.AfterAll
import org.junit.jupiter.api.DisplayName
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
@KotlinCoreEnvironmentTest
class ExplicitCollectionElementAccessMethodSpec(val env: KotlinCoreEnvironment) {
val subject = ExplicitCollectionElementAccessMethod(Config.empty)
@Nested
inner class `Kotlin map` {
@Test
fun `reports map element access with get method`() {
val code = """
fun f() {
val map = mapOf<String, String>()
val value = map.get("key")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report safe map element access`() {
val code = """
fun f() {
val map = mapOf<String, String>()
val value = map?.get("key")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports map set method usage with unused return value`() {
val code = """
fun f() {
val map = mutableMapOf<String, String>()
map.set("key", "value")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports map put method usage with unused return value`() {
val code = """
fun f() {
val map = mutableMapOf<String, String>()
map.put("key", "val")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report map put method usage with variable assignment`() {
val code = """
fun f() {
val map = mutableMapOf<String, String>()
val oldValue = map.put("key", "val")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report map put method with used return value`() {
val code = """
fun f(): Boolean {
val map = mutableMapOf<String, String>()
return map.put("key", "val") == null
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports map element access with get method of non-abstract map`() {
val code = """
fun f() {
val map = hashMapOf<String, String>()
val value = map.get("key")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports map element insert with put method of non-abstract map`() {
val code = """
fun f() {
val map = hashMapOf<String, String>()
map.put("key", "value")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
@DisplayName("does not report map access with []")
fun noReportMapAccessWithBrackets() {
val code = """
fun f() {
val map = mapOf<String, String>()
val value = map["key"]
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
@DisplayName("does not report map insert with []")
fun noReportMapInsertWithBrackets() {
val code = """
fun f() {
val map = mutableMapOf<String, String>()
map["key"] = "value"
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports map element access with get method from map in a chain`() {
val code = """
fun f() {
val map = mapOf<String, String>()
val value = listOf("1", "2").associateBy { it }.get("1")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports map element access with get method from non-abstract map`() {
val code = """
fun f() {
val map = linkedMapOf<String, String>()
val value = map.get("key")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report calls on implicit receiver`() {
val code = """
fun f() {
val map = mapOf<String, Int>()
with(map) { get("a") }
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(0)
}
}
@Nested
inner class `Kotlin list` {
@Test
fun `reports list element access with get method`() {
val code = """
fun f() {
val list = listOf<String>()
val value = list.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports mutable list element access with get method`() {
val code = """
fun f() {
val list = mutableListOf<String>()
val value = list.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
@DisplayName("does not report element access with []")
fun noReportElementAccessWithBrackets() {
val code = """
fun f() {
val list = listOf<String>()
val value = list[0]
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports element access with get method of non-abstract list`() {
val code = """
fun f() {
val list = arrayListOf<String>()
val value = list.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report calls on implicit receiver`() {
val code = """
fun f() {
val list = listOf<String>()
val value = with(list) { get(0) }
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(0)
}
}
@Nested
inner class `Java map` {
@Test
fun `reports map element access with get method`() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
val value = map.get("key")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports map set method usage with unused return value`() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
map.set("key", "val")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports map put method usage with unused return value`() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
map.put("key", "val")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
@DisplayName("does not report map access with []")
fun noReportMapAccessWithBrackets() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
val value = map["key"]
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
@DisplayName("does not report map insert with []")
fun noReportMapInsertWithBrackets() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
map["key"] = "value"
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports map element access with get method from map in a chain`() {
val code = """
fun f() {
val map = java.util.HashMap<String, String>()
val value = listOf("1", "2").associateBy { it }.get("1")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
}
@Nested
inner class `custom operators` {
@Test
fun `reports custom get operator`() {
val code = """
class Custom { operator fun get(i: Int) = 42 }
fun f() {
val custom = Custom()
val value = custom.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report non-operator get method`() {
val code = """
class Custom { fun get(i: Int) = 42 }
fun f() {
val custom = Custom()
val value = custom.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports custom set operator with unused return value`() {
val code = """
class Custom { operator fun set(key: String, value: String) {} }
fun f() {
val custom = Custom()
custom.set("key", "value")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `does not report non-operator set method`() {
val code = """
class Custom { fun set(key: String, value: String) {} }
fun f() {
val custom = Custom()
custom.set("key", "value")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
}
@Nested
inner class `Java list` {
@Test
fun `reports list element access with get method`() {
val code = """
fun f() {
val list = java.util.ArrayList<String>()
val value = list.get(0)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
@DisplayName("does not report element access with []")
fun noReportElementAccessWithBrackets() {
val code = """
fun f() {
val list = java.util.ArrayList<String>()
val value = list[0]
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
}
@Nested
inner class `edge cases` {
@Test
fun `does not crash for getter`() {
val code = """
class A {
val i: Int get() = 1 + 2
val c: Char? get() = "".first() ?: throw IllegalArgumentException("getter")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not crash for fluent api`() {
val code = """
val string = ""
.toString()
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report for unresolvable code`() {
val code = """
fun f() {
val unknownType = UnknownType()
val value = unknownType.put("answer", 42)
}
"""
assertThat(subject.lintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report for put functions without caller`() {
val code = """
fun put() { }
fun f() {
put()
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Nested
inner class JavaSourceTests {
private val environmentWrapper =
createEnvironment(additionalJavaSourceRootPaths = listOf(resourceAsPath("java").toFile()))
private val customEnv = environmentWrapper.env
@AfterAll
fun disposeEnvironment() {
environmentWrapper.dispose()
}
@Test
fun `reports setter from java with 2 or less parameters`() {
// this test case ensures that the test environment are set up correctly.
val code = """
import com.example.fromjava.Rect
fun foo() {
val rect = Rect()
rect.set(0, 1)
}
"""
assertThat(subject.lintWithContext(customEnv, code)).hasSize(1)
}
@Test
fun `does not report if the function has 3 or more arguments and it's defined in java - #4288`() {
val code = """
import com.example.fromjava.Rect
fun foo() {
val rect = Rect()
rect.set(0, 1, 2)
}
"""
assertThat(subject.lintWithContext(customEnv, code)).isEmpty()
}
}
}
}