/
CyclomaticComplexitySpec.kt
255 lines (216 loc) · 7.81 KB
/
CyclomaticComplexitySpec.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
package io.github.detekt.metrics
import io.github.detekt.test.utils.compileContentForTest
import io.gitlab.arturbosch.detekt.rules.safeAs
import org.assertj.core.api.Assertions.assertThat
import org.jetbrains.kotlin.psi.KtElement
import org.jetbrains.kotlin.psi.KtNamed
import org.jetbrains.kotlin.psi.KtNamedFunction
import org.jetbrains.kotlin.psi.psiUtil.getChildOfType
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
class CyclomaticComplexitySpec {
val defaultFunctionComplexity = 1
@Nested
inner class `basic function expressions are tested` {
@Test
fun `counts for safe navigation`() {
val code = compileContentForTest(
"""
fun test() = null as? String ?: ""
""".trimIndent()
)
val actual = CyclomaticComplexity.calculate(code)
assertThat(actual).isEqualTo(defaultFunctionComplexity + 1)
}
@Test
fun `counts 'and' and 'or' expressions`() {
val code = compileContentForTest(
"""
fun test() = if (true || true && false) 1 else 0
""".trimIndent()
)
val actual = CyclomaticComplexity.calculate(code)
assertThat(actual).isEqualTo(defaultFunctionComplexity + 3)
}
@Test
fun `counts while, continue and break`() {
val code = compileContentForTest(
"""
fun test(i: Int) {
var j = i
while(true) { // 1
if (j == 5) { // 1
continue // 1
} else if (j == 2) { // 1
break // 1
} else {
j += i
}
}
println("finished")
}
""".trimIndent()
)
val actual = CyclomaticComplexity.calculate(code)
assertThat(actual).isEqualTo(defaultFunctionComplexity + 5)
}
}
@Nested
inner class `counts function calls used for nesting` {
private val code = compileContentForTest(
"""
fun test(i: Int) {
(1..10).forEach { println(it) }
}
""".trimIndent()
)
@Test
fun `counts them by default`() {
assertThat(
CyclomaticComplexity.calculate(code)
).isEqualTo(defaultFunctionComplexity + 1)
}
@Test
fun `does not count them when ignored`() {
assertThat(
CyclomaticComplexity.calculate(code) {
ignoreNestingFunctions = true
}
).isEqualTo(defaultFunctionComplexity)
}
@Test
fun `does not count when forEach is not specified`() {
assertThat(
CyclomaticComplexity.calculate(code) {
nestingFunctions = emptySet()
}
).isEqualTo(defaultFunctionComplexity)
}
@Test
fun `counts them when forEach is specified`() {
assertThat(
CyclomaticComplexity.calculate(code) {
nestingFunctions = setOf("forEach")
}
).isEqualTo(defaultFunctionComplexity + 1)
}
}
@Nested
inner class `ignoreSimpleWhenEntries is false` {
@Test
fun `counts simple when branches as 1`() {
val function = compileContentForTest(
"""
fun test() {
when (System.currentTimeMillis()) {
0 -> println("Epoch!")
1 -> println("1 past epoch.")
else -> println("Meh")
}
}
""".trimIndent()
).getFunctionByName("test")
val actual = CyclomaticComplexity.calculate(function) {
ignoreSimpleWhenEntries = false
}
assertThat(actual).isEqualTo(defaultFunctionComplexity + 3)
}
@Test
fun `counts block when branches as 1`() {
val function = compileContentForTest(
"""
fun test() {
when (System.currentTimeMillis()) {
0 -> {
println("Epoch!")
}
1 -> println("1 past epoch.")
else -> println("Meh")
}
}
""".trimIndent()
).getFunctionByName("test")
val actual = CyclomaticComplexity.calculate(function) {
ignoreSimpleWhenEntries = false
}
assertThat(actual).isEqualTo(defaultFunctionComplexity + 3)
}
}
@Nested
inner class `ignoreSimpleWhenEntries is true` {
@Test
fun `counts a when with only simple branches as 1`() {
val function = compileContentForTest(
"""
fun test() {
when (System.currentTimeMillis()) {
0 -> println("Epoch!")
1 -> println("1 past epoch.")
else -> println("Meh")
}
}
""".trimIndent()
).getFunctionByName("test")
val actual = CyclomaticComplexity.calculate(function) {
ignoreSimpleWhenEntries = true
}
assertThat(actual).isEqualTo(defaultFunctionComplexity + 1)
}
@Test
fun `does not count simple when branches`() {
val function = compileContentForTest(
"""
fun test() {
when (System.currentTimeMillis()) {
0 -> {
println("Epoch!")
println("yay")
}
1 -> {
println("1 past epoch!")
}
else -> println("Meh")
}
}
""".trimIndent()
).getFunctionByName("test")
val actual = CyclomaticComplexity.calculate(function) {
ignoreSimpleWhenEntries = true
}
assertThat(actual).isEqualTo(defaultFunctionComplexity + 2)
}
@Test
fun `counts block when branches as 1`() {
val function = compileContentForTest(
"""
fun test() {
when (System.currentTimeMillis()) {
0 -> {
println("Epoch!")
println("yay!")
}
1 -> {
println("1 past epoch.")
println("yay?")
}
2 -> println("shrug")
else -> println("Meh")
}
}
""".trimIndent()
).getFunctionByName("test")
val actual = CyclomaticComplexity.calculate(function) {
ignoreSimpleWhenEntries = true
}
assertThat(actual).isEqualTo(defaultFunctionComplexity + 2)
}
}
}
private fun KtElement.getFunctionByName(name: String): KtNamedFunction {
val node = getChildOfType<KtNamedFunction>() ?: error("Expected node of type ${KtNamedFunction::class}")
val identifier = node.safeAs<KtNamed>()?.nameAsName?.identifier
require(identifier == name) {
"Node should be $name, but was $identifier"
}
return node
}