/
UseRequireSpec.kt
252 lines (225 loc) · 8.51 KB
/
UseRequireSpec.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
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.rules.KotlinCoreEnvironmentTest
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 org.jetbrains.kotlin.cli.jvm.compiler.KotlinCoreEnvironment
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
@KotlinCoreEnvironmentTest
class UseRequireSpec(val env: KotlinCoreEnvironment) {
val subject = UseRequire(Config.empty)
@Test
fun `reports if a precondition throws an IllegalArgumentException`() {
val code = """
fun x(a: Int) {
if (a < 0) throw IllegalArgumentException()
doSomething()
}
"""
assertThat(subject.lint(code)).hasStartSourceLocation(2, 16)
}
@Test
fun `reports if a precondition throws an IllegalArgumentException as the only statement in block expression`() {
val code = """
fun x(a: Int) {
if (a < 0) {
throw IllegalArgumentException()
}
doSomething()
}
"""
assertThat(subject.lint(code)).hasStartSourceLocation(3, 9)
}
@Test
fun `reports if a precondition throws an IllegalArgumentException with more details`() {
val code = """
fun x(a: Int) {
if (a < 0) throw IllegalArgumentException("More details")
doSomething()
}
"""
assertThat(subject.lint(code)).hasStartSourceLocation(2, 16)
}
@Test
fun `reports if a precondition throws a fully qualified IllegalArgumentException`() {
val code = """
fun x(a: Int) {
if (a < 0) throw java.lang.IllegalArgumentException()
doSomething()
}
"""
assertThat(subject.lint(code)).hasStartSourceLocation(2, 16)
}
@Test
fun `reports if a precondition throws a fully qualified IllegalArgumentException using the kotlin type alias`() {
val code = """
fun x(a: Int) {
if (a < 0) throw kotlin.IllegalArgumentException()
doSomething()
}
"""
assertThat(subject.lint(code)).hasStartSourceLocation(2, 16)
}
@Test
fun `does not report if a precondition throws a different kind of exception`() {
val code = """
fun x(a: Int) {
if (a < 0) throw SomeBusinessException()
doSomething()
}
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception thrown has a message and a cause`() {
val code = """
private fun x(a: Int): Nothing {
doSomething()
throw IllegalArgumentException("message", cause)
}
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exceptions in thrown with more than one statement in block expression`() {
val code = """
fun x(a: Int) {
if (a < 0) {
println("bang!")
throw IllegalArgumentException()
}
doSomething()
}
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception thrown as the only action in a block`() {
val code = """
fun unsafeRunSync(): A =
foo.fold({ throw IllegalArgumentException("message") }, ::identity)
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception thrown unconditionally`() {
val code = """fun doThrow() = throw IllegalArgumentException("message")"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception thrown unconditionally in a function block`() {
val code = """fun doThrow() { throw IllegalArgumentException("message") }"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report if the exception thrown has a non-String argument`() {
val code = """
fun test(throwable: Throwable) {
if (throwable !is NumberFormatException) throw IllegalArgumentException(throwable)
}
"""
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report if the exception thrown has a String literal argument and a non-String argument`() {
val code = """
fun test(throwable: Throwable) {
if (throwable !is NumberFormatException) throw IllegalArgumentException("a", throwable)
}
"""
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Test
fun `does not report if the exception thrown has a non-String literal argument`() {
val code = """
fun test(throwable: Throwable) {
val s = ""
if (throwable !is NumberFormatException) throw IllegalArgumentException(s)
}
"""
assertThat(subject.compileAndLint(code)).isEmpty()
}
@Nested
inner class `with binding context` {
@Test
fun `does not report if the exception thrown has a non-String argument`() {
val code = """
fun test(throwable: Throwable) {
if (throwable !is NumberFormatException) throw IllegalArgumentException(throwable)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `does not report if the exception thrown has a String literal argument and a non-String argument`() {
val code = """
fun test(throwable: Throwable) {
if (throwable !is NumberFormatException) throw IllegalArgumentException("a", throwable)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).isEmpty()
}
@Test
fun `reports if the exception thrown has a non-String literal argument`() {
val code = """
fun test(throwable: Throwable) {
val s = ""
if (throwable !is NumberFormatException) throw IllegalArgumentException(s)
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
@Test
fun `reports if the exception thrown has a String literal argument`() {
val code = """
fun test(throwable: Throwable) {
if (throwable !is NumberFormatException) throw IllegalArgumentException("a")
}
"""
assertThat(subject.compileAndLintWithContext(env, code)).hasSize(1)
}
}
@Nested
inner class `throw is not after a precondition` {
@Test
fun `does not report an issue if the exception is inside a when`() {
val code = """
fun whenOrThrow(item : List<*>) = when(item) {
is ArrayList<*> -> 1
is LinkedList<*> -> 2
else -> throw IllegalArgumentException("Not supported List type")
}
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception is after a block`() {
val code = """
fun doSomethingOrThrow(test: Int): Int {
var index = 0
repeat(test){
if (Math.random() == 1.0) {
return it
}
}
throw IllegalArgumentException("Test was too big")
}
"""
assertThat(subject.lint(code)).isEmpty()
}
@Test
fun `does not report an issue if the exception is after a elvis operator`() {
val code = """
fun tryToCastOrThrow(list: List<*>) : LinkedList<*> {
val subclass = list as? LinkedList
?: throw IllegalArgumentException("List is not a LinkedList")
return subclass
}
"""
assertThat(subject.lint(code)).isEmpty()
}
}
}