/
UnusedPrivateMemberSpec.kt
1651 lines (1417 loc) · 50.9 KB
/
UnusedPrivateMemberSpec.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
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.SourceLocation
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 io.gitlab.arturbosch.detekt.test.lintWithContext
import org.assertj.core.api.Assertions.assertThat
import org.assertj.core.api.Assertions.assertThatExceptionOfType
import org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
import java.util.regex.PatternSyntaxException
private const val ALLOWED_NAMES_PATTERN = "allowedNames"
@KotlinCoreEnvironmentTest
class UnusedPrivateMemberSpec(val env: KotlinCoreEnvironment) {
val subject = UnusedPrivateMember()
val regexTestingCode = """
class Test {
private val used = "This is used"
private val unused = "This is not used"
fun use() {
println(used)
}
}
""".trimIndent()
@Nested
inner class `interface functions` {
@Test
fun `should not report parameters in interface functions`() {
val code = """
interface UserPlugin {
fun plug(application: Application)
fun unplug()
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `expect functions and classes` {
@Test
fun `should not report parameters in expect class functions`() {
val code = """
expect class Foo {
fun bar(i: Int)
fun baz(i: Int, s: String)
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report parameters in expect object functions`() {
val code = """
expect object Foo {
fun bar(i: Int)
fun baz(i: Int, s: String)
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report parameters in expect functions`() {
val code = """
expect fun bar(i: Int)
expect fun baz(i: Int, s: String)
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report parameters in expect class with constructor`() {
val code = """
expect class Foo1(private val bar: String) {}
expect class Foo2(bar: String) {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `actual functions and classes` {
@Test
fun `should not report unused parameters in actual functions`() {
val code = """
actual class Foo {
actual fun bar(i: Int) {}
actual fun baz(i: Int, s: String) {}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report unused parameters in actual constructors`() {
val code = """
actual class Foo actual constructor(bar: String) {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report unused actual fields defined as parameters of primary constructors`() {
val code = """
actual class Foo actual constructor(actual val bar: String) {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `reports unused private fields defined as parameters of primary constructors`() {
val code = """
actual class Foo actual constructor(private val bar: String) {}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
}
@Nested
inner class `external functions` {
@Test
fun `should not report parameters in external functions`() {
val code = "external fun foo(bar: String)"
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `external classes` {
@Test
fun `should not report functions in external classes`() {
val code = """
external class Bugsnag {
companion object {
fun start(value: Int)
fun notify(error: String)
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `protected functions` {
@Test
fun `should not report parameters in protected functions`() {
val code = """
open class Foo {
protected fun fee(bar: String) {}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `overridden functions` {
@Test
fun `should not report parameters in not private functions`() {
val code = """
override fun funA() {
objectA.resolve(valA, object : MyCallback {
override fun onResolveFailed(throwable: Throwable) {
errorMessage.visibility = View.VISIBLE
}
})
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `should not report in overriden classes`() {
val code = """
abstract class Parent {
abstract fun abstractFun(arg: Any)
open fun openFun(arg: Any): Int = 0
}
class Child : Parent() {
override fun abstractFun(arg: Any) {
println(arg)
}
override fun openFun(arg: Any): Int {
println(arg)
return 1
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `non-private classes` {
@Test
fun `should not report internal classes`() {
val code = """
internal class IC // unused but internal
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `classes accessing constants from companion objects` {
@Test
fun `should not report used constants`() {
val code = """
class A {
companion object {
private const val MY_CONST = 42
}
fun a() {
Completable.timer(MY_CONST.toLong(), TimeUnit.MILLISECONDS)
.subscribe()
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `classes with properties` {
@Test
fun `reports an unused member`() {
val code = """
class Test {
private val unused = "This is not used"
fun use() {
println("This is not using a property")
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report unused public members`() {
val code = """
class Test {
val unused = "This is not used"
fun use() {
println("This is not using a property")
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report used members`() {
val code = """
class Test {
private val used = "This is used"
fun use() {
println(used)
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report used members but reports unused members`() {
val code = """
class Test {
private val used = "This is used"
private val unused = "This is not used"
fun use() {
println(used)
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not fail when disabled with invalid regex`() {
val configRules = mapOf(
"active" to "false",
ALLOWED_NAMES_PATTERN to "*foo"
)
val config = TestConfig(configRules)
assertThat(UnusedPrivateMember(config).lint(regexTestingCode)).isEmpty()
}
@Test
fun `does fail when enabled with invalid regex`() {
val configRules = mapOf(ALLOWED_NAMES_PATTERN to "*foo")
val config = TestConfig(configRules)
assertThatExceptionOfType(PatternSyntaxException::class.java)
.isThrownBy { UnusedPrivateMember(config).lint(regexTestingCode) }
}
}
@Nested
inner class `classes with properties and local properties` {
@Test
fun `reports multiple unused properties`() {
val code = """
class UnusedPrivateMemberPositive {
private val unusedField = 5
val publicField = 2
private val clashingName = 4
private fun unusedFunction(unusedParam: Int) {
val unusedLocal = 5
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(5)
}
@Test
fun `reports an unused member`() {
val code = """
class Test {
private val unused = "This is not used"
fun use() {
val used = "This is used"
println(used)
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report used members`() {
val code = """
class Test {
private val used = "This is used"
fun use() {
val text = used
println(text)
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report used members and properties`() {
val code = """
class C {
val myNumber = 5
fun publicFunction(usedParam: String) {
println(usedParam)
println(PC.THE_CONST)
println("Hello " ext "World" ext "!")
println(::doubleColonObjectReferenced)
println(this::doubleColonThisReferenced)
}
fun usesAllowedNames() {
for ((index, _) in mapOf(0 to 0, 1 to 1, 2 to 2)) { // unused but allowed name
println(index)
}
try {
} catch (_: OutOfMemoryError) { // unused but allowed name
}
}
private fun doubleColonThisReferenced() {}
companion object {
private infix fun String.ext(other: String): String {
return this + other
}
private fun doubleColonObjectReferenced() {}
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report used private classes`() {
val code = """
private class PC { // used private class
companion object {
internal const val THE_CONST = "" // used private const
object OO {
const val BLA = 4
}
}
}
internal fun libraryFunction() = run {
val o: Function1<Any, Any> = object : Function1<Any, Any> {
override fun invoke(p1: Any): Any { // unused but overridden param
throw UnsupportedOperationException("not implemented")
}
}
println(o("$\{PC.Companion.OO.BLA.toString() + ""}"))
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(0)
}
@Test
fun `reports unused local properties`() {
val code = """
class Test {
private val used = "This is used"
fun use() {
val unused = used
println(used)
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
}
@Nested
inner class `objects with properties` {
@Test
fun `reports multiple unused properties`() {
val code = """
object UnusedPrivateMemberPositiveObject {
private const val unusedObjectConst = 2
private val unusedField = 5
private val clashingName = 5
val useForClashingName = clashingName
private val unusedObjectField = 4
object Foo {
private val unusedNestedVal = 1
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(4)
}
@Test
fun `does not report public properties`() {
val code = """
object O { // public
const val NUMBER = 5 // public
}
private object PO { // private, but constants may be used
const val TEXT = "text"
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `loop iterators` {
@Test
fun `should not depend on evaluation order of functions or properties`() {
val code = """
fun RuleSetProvider.provided() = ruleSetId in defaultRuleSetIds
val defaultRuleSetIds = listOf("comments", "complexity", "empty-blocks",
"exceptions", "potential-bugs", "performance", "style")
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `doesn't report loop properties`() {
val code = """
class Test {
fun use() {
for (i in 0 until 10) {
println(i)
}
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `reports unused loop property`() {
val code = """
class Test {
fun use() {
for (i in 0 until 10) {
}
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `reports unused loop property in indexed array`() {
val code = """
class Test {
fun use() {
val array = intArrayOf(1, 2, 3)
for ((index, value) in array.withIndex()) {
println(index)
}
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `reports all unused loop properties in indexed array`() {
val code = """
class Test {
fun use() {
val array = intArrayOf(1, 2, 3)
for ((index, value) in array.withIndex()) {
}
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(2)
}
@Test
fun `does not report used loop properties in indexed array`() {
val code = """
class Test {
fun use() {
val array = intArrayOf(1, 2, 3)
for ((index, value) in array.withIndex()) {
println(index)
println(value)
}
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `properties used to initialize other properties` {
@Test
fun `does not report properties used by other properties`() {
val code = """
class Test {
private val used = "This is used"
private val text = used
fun use() {
println(text)
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report properties used by inner classes`() {
val code = """
class Test {
private val unused = "This is not used"
inner class Something {
val test = unused
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `top level functions` {
@Test
fun `reports top-level unused functions`() {
val code = """
private fun unusedTopLevelFunction() = 5
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report used top level functions`() {
val code = """
private fun calledFromMain() {}
fun main(args: Array<String>) {
calledFromMain()
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `top level properties` {
@Test
fun `reports single parameters if they are unused`() {
val code = """
private val usedTopLevelVal = 1
private const val unusedTopLevelConst = 1
private val unusedTopLevelVal = usedTopLevelVal
""".trimIndent()
assertThat(subject.lint(code)).hasSize(2)
}
@Test
fun `does not report used top level properties`() {
val code = """
val stuff = object : Iterator<String?> {
var mutatable: String? = null
private fun preCall() {
mutatable = "done"
}
override fun next(): String? {
preCall()
return mutatable
}
override fun hasNext(): Boolean = true
}
fun main(args: Array<String>) {
println(stuff.next())
calledFromMain()
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `unused private functions` {
@Test
fun `does not report used private functions`() {
val code = """
class Test {
val value = usedMethod()
private fun usedMethod(): Int {
return 5
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `reports unused private functions`() {
val code = """
class Test {
private fun unusedFunction(): Int {
return 5
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report function used in interface - #1613`() {
val code = """
interface Bar {
fun doSomething() {
doSomethingElse()
}
}
private fun doSomethingElse() {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `private functions only used by unused private functions` {
@Test
fun `reports the non called private function`() {
val code = """
class Test {
private fun unusedFunction(): Int {
return someOtherUnusedFunction()
}
private fun someOtherUnusedFunction() {
println("Never used")
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
}
@Nested
inner class `unused class declarations which are allowed` {
@Test
fun `does not report the unused private property`() {
val code = """
class Test {
private val ignored = ""
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report the unused private function and parameter`() {
val code = """
class Test {
private fun ignored(ignored: Int) {}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `nested class declarations` {
@Test
fun `reports unused nested private property`() {
val code = """
class Test {
class Inner {
private val unused = 1
}
}
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report used nested private property`() {
val code = """
class Test {
class Inner {
private val used = 1
fun someFunction() = used
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `properties in primary constructors` {
@Test
fun `reports unused private property`() {
val code = """
class Test(private val unused: Any)
""".trimIndent()
assertThat(subject.lint(code)).hasSize(1)
}
@Test
fun `does not report public property`() {
val code = """
class Test(val unused: Any)
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report private property used in init block`() {
val code = """
class Test(private val used: Any) {
init { used.toString() }
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report private property used in function`() {
val code = """
class Test(private val used: Any) {
fun something() {
used.toString()
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
}
@Nested
inner class `error messages` {
@Test
fun `are specific for function parameters`() {
val code = """
fun foo(unused: Int){}
""".trimIndent()
val lint = subject.lint(code)
assertThat(lint.first().message).startsWith("Function parameter")
}
@Test
fun `are specific for local variables`() {
val code = """
fun foo(){ val unused = 1 }
""".trimIndent()
val lint = subject.lint(code)
assertThat(lint.first().message).startsWith("Private property")
}
@Test
fun `are specific for private functions`() {
val code = """
class Test {
private fun unusedFunction(): Int {
return 5
}
}
""".trimIndent()
val lint = subject.lint(code)
assertThat(lint.first().message).startsWith("Private function")
}
}
@Nested
inner class `suppress unused property warning annotations` {
@Test
fun `does not report annotated private constructor properties`() {
val code = """
class Test(@Suppress("unused") private val foo: String) {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `reports private constructor properties without annotation`() {
val code = """
class Test(
@Suppress("unused") private val foo: String,
private val bar: String
) {}
""".trimIndent()
val lint = subject.lint(code)
assertThat(lint).hasSize(1)
assertThat(lint[0].entity.signature).isEqualTo("Test.kt\$Test\$private val bar: String")
}
@Test
fun `does not report private constructor properties in annotated class`() {
val code = """
@Suppress("unused")
class Test(
private val foo: String,
private val bar: String
) {}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report private constructor properties in class with annotated outer class`() {
val code = """
@Suppress("unused")
class Test(
private val foo: String,
private val bar: String
) {
class InnerTest(
private val baz: String
) {}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report private constructor properties in annotated file`() {
val code = """
@file:Suppress("unused")
class Test(
private val foo: String,
private val bar: String
) {
class InnerTest(
private val baz: String
) {}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report annotated private properties`() {
val code = """
class Test {
@Suppress("unused") private val foo: String
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `reports private properties without annotation`() {
val code = """
class Test {
@Suppress("unused") private val foo: String
private val bar: String
}
""".trimIndent()
val lint = subject.lint(code)
assertThat(lint).hasSize(1)
assertThat(lint[0].entity.signature).isEqualTo("Test.kt\$Test\$private val bar: String")
}
@Test
fun `does not report private properties in annotated class`() {
val code = """
@Suppress("unused")
class Test {
private val foo: String
private val bar: String
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report private properties in class with annotated outer class`() {
val code = """
@Suppress("unused")
class Test {
private val foo: String
private val bar: String
class InnerTest {
private val baz: String
}
}
""".trimIndent()
assertThat(subject.lint(code)).isEmpty()
}
@Test