forked from detekt/detekt
-
Notifications
You must be signed in to change notification settings - Fork 0
/
UnnamedParameterUseSpec.kt
471 lines (411 loc) · 13.6 KB
/
UnnamedParameterUseSpec.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
465
466
467
468
469
470
471
package io.gitlab.arturbosch.detekt.rules.bugs
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
@KotlinCoreEnvironmentTest
class UnnamedParameterUseSpec(private val env: KotlinCoreEnvironment) {
private val subject = UnnamedParameterUse()
@Test
fun `does not report for no param function call`() {
val code = """
fun f() {
println("f called")
}
fun test() {
f()
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report single unnamed param by default`() {
val code = """
fun f(enabled: Boolean) {
println(enabled)
}
fun test() {
f(true)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report single unnamed param when ignoreSingleParamUse is true`() {
val code = """
fun f(enabled: Boolean) {
println(enabled)
}
fun test() {
f(true)
}
""".trimIndent()
assertThat(getSubject(ignoreSingleParamUse = true).compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `report unnamed param when ignoreSingleParamUse is true and allowAdjacentDifferentTypeParams is false`() {
val code = """
fun f(enabled: Boolean) {
println(enabled)
}
fun test() {
f(true)
}
""".trimIndent()
assertThat(
getSubject(
ignoreSingleParamUse = true,
allowAdjacentDifferentTypeParams = false
).compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does report two unnamed param by default`() {
val code = """
fun f(enabled: Boolean, shouldLog: Boolean) {
if (shouldLog) println(enabled)
}
fun test() {
f(false, true)
}
""".trimIndent()
assertThat(
subject.compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `report uses the function name as location and message`() {
val code = """
fun f(enabled: Boolean, shouldLog: Boolean) {
if (shouldLog) println(enabled)
}
fun test() {
f(false, true)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code))
.hasTextLocations(102 to 103)
.singleElement()
.hasMessage("Consider using named parameters in f as they make usage of the function more safe.")
}
@Test
fun `does not report two unnamed param when both are same`() {
val code = """
fun f(enabled: Boolean, shouldLog: Boolean) {
if (shouldLog) println(enabled)
}
fun test() {
f(true, true)
}
""".trimIndent()
assertThat(
subject.compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does not report two non adjacent unnamed param by default `() {
val code = """
fun f(enabled: Boolean, tag: String, shouldLog: Boolean) {
if (shouldLog) println(tag + enabled.toString())
}
fun test() {
f(true, "", true)
}
""".trimIndent()
assertThat(
subject.compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does report two non adjacent unnamed param when allowAdjacentDifferentTypeParams is false`() {
val code = """
fun f(enabled: Boolean, tag: String, shouldLog: Boolean) {
if (shouldLog) println(tag + enabled.toString())
}
fun test() {
f(true, "", true)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = false).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does report two adjacent param with different type with one being supertype`() {
val code = """
fun f(enabled: Boolean, tag1: String, tag2: CharSequence) {
/* no-op */
}
fun test() {
f(enabled = true, "tag1", "tag2")
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does not report two adjacent same type param with one named param with adjacent allowed`() {
val code = """
fun f(tag: String, enabled: Boolean, shouldLog: Boolean) {
if (shouldLog) println(tag + enabled.toString())
}
fun test() {
f("", enabled = true, true)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does not report two adjacent same type param with one named last param with adjacent allowed`() {
val code = """
fun f(tag: String, enabled: Boolean, shouldLog: Boolean) {
if (shouldLog) println(tag + enabled.toString())
}
fun test() {
f("", enabled = true, true)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does not report non kotlin function`() {
val code = """
fun test() {
System.out.write(byteArrayOf(), 9, 9)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does not report single trailing lambda param`() {
val code = """
fun useLambda(lambda: () -> Unit) {
/* no-op */
}
fun test() {
useLambda {
/* no-op */
}
}
""".trimIndent()
assertThat(
getSubject(
ignoreSingleParamUse = false,
allowAdjacentDifferentTypeParams = false
).compileAndLintWithContext(env, code)
).isEmpty()
}
@Test
fun `does report single lambda is used inside braces`() {
val code = """
fun useLambda(lambda: () -> Unit) {
/* no-op */
}
fun test() {
useLambda({
/* no-op */
})
}
""".trimIndent()
assertThat(
getSubject(
ignoreSingleParamUse = false,
allowAdjacentDifferentTypeParams = false
).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does report when two lambda is used inside braces`() {
val code = """
fun useLambda(preCondition: () -> Boolean, lambda: () -> Boolean) {
/* no-op */
}
fun test() {
useLambda(
{ true },
{ false }
)
}
""".trimIndent()
assertThat(
subject.compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does report when two lambda is used inside braces with adjacent allowed`() {
val code = """
fun useLambda(preCondition: () -> Boolean, lambda: () -> Boolean) {
/* no-op */
}
fun test() {
useLambda(
{ true },
{ false }
)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does report class constructor is called without name`() {
val code = """
class A(x: Int, y: Int)
fun test() {
A(1, 2)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does report class constructor is called in delegation`() {
val code = """
interface Behaviour
class B(i: Int) : Behaviour
class A(i: Int, j: Int): Behaviour by B(i)
fun test() {
A(1, 2)
}
""".trimIndent()
assertThat(
getSubject(allowAdjacentDifferentTypeParams = true).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Nested
inner class WithVararg {
@Test
fun `does not report vararg call without name`() {
val code = """
fun a(a: Int, vararg b: Int) {
/* no-op */
}
fun test() {
a(9, 0)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report vararg call with first param with name`() {
val code = """
fun a(a: Int, vararg b: Int) {
/* no-op */
}
fun test() {
a(a = 9, 0)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does report vararg call with first param with name with ignoreSingleParamUse = false`() {
val code = """
fun a(a: Int, vararg b: Int) {
/* no-op */
}
fun test() {
a(9, 0)
}
""".trimIndent()
assertThat(
getSubject(
ignoreSingleParamUse = false,
allowAdjacentDifferentTypeParams = false
).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does not report one param and one vararg param with multiple values`() {
val code = """
fun a(a: Int, vararg b: Int) {
/* no-op */
}
fun test() {
a(9, 0, 0, 0)
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does report one param and one vararg param with multiple values`() {
val code = """
fun a(a: Int, vararg b: Int) {
/* no-op */
}
fun test() {
a(9, 0, 0, 0)
}
""".trimIndent()
assertThat(
getSubject(
ignoreSingleParamUse = false,
allowAdjacentDifferentTypeParams = false
).compileAndLintWithContext(env, code)
).hasSize(1)
}
@Test
fun `does not report vararg call with multiple values corresponding to same vararg`() {
val code = """
fun a(vararg a: String) {
/* no-op */
}
fun test() {
a("", "", "")
}
""".trimIndent()
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report vararg param with multiple with ignoreSingleParamUse = true`() {
val code = """
fun a(vararg a: String) {
/* no-op */
}
fun test() {
a("", "", "")
}
""".trimIndent()
assertThat(getSubject(ignoreSingleParamUse = false).compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does report vararg call used with spread with arrayOf type`() {
val code = """
fun a(vararg a: String) {
/* no-op */
}
fun test(arr: Array<String>) {
a(*arr)
}
""".trimIndent()
assertThat(getSubject(ignoreSingleParamUse = false).compileAndLintWithContext(env, code)).isEmpty()
}
}
private fun getSubject(
ignoreSingleParamUse: Boolean = true,
allowAdjacentDifferentTypeParams: Boolean = true,
): UnnamedParameterUse {
return UnnamedParameterUse(
TestConfig(
ALLOW_SINGLE_PARAM_USE to ignoreSingleParamUse,
ALLOW_NON_ADJACENT_PARAM to allowAdjacentDifferentTypeParams,
)
)
}
companion object {
private const val ALLOW_SINGLE_PARAM_USE = "allowSingleParamUse"
private const val ALLOW_NON_ADJACENT_PARAM = "allowAdjacentDifferentTypeParams"
}
}