-
-
Notifications
You must be signed in to change notification settings - Fork 757
/
ComplexMethodSpec.kt
244 lines (202 loc) · 8.05 KB
/
ComplexMethodSpec.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
package io.gitlab.arturbosch.detekt.rules.complexity
import io.github.detekt.test.utils.resourceAsPath
import io.gitlab.arturbosch.detekt.api.SourceLocation
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.isThresholded
import io.gitlab.arturbosch.detekt.test.lint
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
private val defaultConfigMap: Map<String, Any> = mapOf("threshold" to "1")
class ComplexMethodSpec {
val defaultComplexity = 1
@Nested
inner class `different complex constructs` {
@Test
fun `counts different loops`() {
val findings = ComplexMethod(TestConfig(defaultConfigMap)).compileAndLint(
"""
fun test() {
for (i in 1..10) {}
while (true) {}
do {} while(true)
(1..10).forEach {}
}
"""
)
assertThat(findings.first()).isThresholded().withValue(defaultComplexity + 4)
}
@Test
fun `counts catch blocks`() {
val findings = ComplexMethod(TestConfig(defaultConfigMap)).compileAndLint(
"""
fun test() {
try {} catch(e: IllegalArgumentException) {} catch(e: Exception) {} finally {}
}
"""
)
assertThat(findings.first()).isThresholded().withValue(defaultComplexity + 2)
}
@Test
fun `counts nested conditional statements`() {
val findings = ComplexMethod(TestConfig(defaultConfigMap)).compileAndLint(
"""
fun test() {
try {
while (true) {
if (true) {
when ("string") {
"" -> println()
else -> println()
}
}
}
} finally {
// only catches count
}
}
"""
)
assertThat(findings.first()).isThresholded().withValue(defaultComplexity + 4)
}
}
@Nested
inner class `nesting functions` {
val code = """
fun test() {
for (i in 1..10) {}
(1..10).forEach {}
}
"""
@Test
fun `counts three with nesting function 'forEach'`() {
val config = TestConfig(defaultConfigMap.plus("ignoreNestingFunctions" to "false"))
assertExpectedComplexityValue(code, config, expectedValue = 3)
}
@Test
fun `can ignore nesting functions like 'forEach'`() {
val config = TestConfig(defaultConfigMap.plus("ignoreNestingFunctions" to "true"))
assertExpectedComplexityValue(code, config, expectedValue = 2)
}
@Test
fun `skips all if if the nested functions is empty`() {
val config = TestConfig(defaultConfigMap.plus("nestingFunctions" to ""))
assertExpectedComplexityValue(code, config, expectedValue = 2)
}
@Test
fun `skips 'forEach' as it is not specified`() {
val config = TestConfig(defaultConfigMap.plus("nestingFunctions" to "let,apply,also"))
assertExpectedComplexityValue(code, config, expectedValue = 2)
}
@Test
fun `skips 'forEach' as it is not specified list`() {
val config = TestConfig(defaultConfigMap.plus("nestingFunctions" to listOf("let", "apply", "also")))
assertExpectedComplexityValue(code, config, expectedValue = 2)
}
}
@Nested
inner class `several complex methods` {
val path = resourceAsPath("ComplexMethods.kt")
@Test
fun `does not report complex methods with a single when expression`() {
val config = TestConfig(
mapOf(
"threshold" to "4",
"ignoreSingleWhenExpression" to "true"
)
)
val subject = ComplexMethod(config)
assertThat(subject.lint(path)).hasStartSourceLocations(SourceLocation(43, 5))
}
@Test
fun `reports all complex methods`() {
val config = TestConfig(mapOf("threshold" to "4"))
val subject = ComplexMethod(config)
assertThat(subject.lint(path)).hasStartSourceLocations(
SourceLocation(6, 5),
SourceLocation(15, 5),
SourceLocation(25, 5),
SourceLocation(35, 5),
SourceLocation(43, 5)
)
}
@Test
fun `does not trip for a reasonable amount of simple when entries when ignoreSimpleWhenEntries is true`() {
val config = TestConfig(mapOf("ignoreSimpleWhenEntries" to "true"))
val subject = ComplexMethod(config)
val code = """
fun f() {
val map = HashMap<Any, String>()
for ((key, value) in map) {
when (key) {
is Int -> print("int")
is String -> print("String")
is Float -> print("Float")
is Double -> print("Double")
is Byte -> print("Byte")
is Short -> print("Short")
is Long -> print("Long")
is Boolean -> print("Boolean")
else -> throw IllegalArgumentException("Unexpected type value")
}
}
}
"""
val findings = subject.compileAndLint(code)
assertThat(findings).isEmpty()
}
}
@Nested
inner class `function containing object literal with many overridden functions` {
val code = """
fun f(): List<Any> {
return object : List<Any> {
override val size: Int get() = TODO("not implemented")
override fun contains(element: Any): Boolean {
TODO("not implemented")
}
override fun containsAll(elements: Collection<Any>): Boolean {
TODO("not implemented")
}
override fun get(index: Int): Any {
TODO("not implemented")
}
override fun indexOf(element: Any): Int {
TODO("not implemented")
}
override fun isEmpty(): Boolean {
TODO("not implemented")
}
override fun iterator(): Iterator<Any> {
TODO("not implemented")
}
override fun lastIndexOf(element: Any): Int {
TODO("not implemented")
}
override fun listIterator(): ListIterator<Any> {
TODO("not implemented")
}
override fun listIterator(index: Int): ListIterator<Any> {
TODO("not implemented")
}
override fun subList(fromIndex: Int, toIndex: Int): List<Any> {
TODO("not implemented")
}
}
}
"""
@Test
fun `should not count these overridden functions to base functions complexity`() {
assertThat(ComplexMethod().compileAndLint(code)).isEmpty()
}
}
}
private fun assertExpectedComplexityValue(code: String, config: TestConfig, expectedValue: Int) {
val findings = ComplexMethod(config).lint(code)
assertThat(findings).hasStartSourceLocations(SourceLocation(1, 5))
assertThat(findings.first())
.isThresholded()
.withValue(expectedValue)
.withThreshold(1)
}