forked from detekt/detekt
/
MultilineRawStringIndentationSpec.kt
403 lines (369 loc) · 12.5 KB
/
MultilineRawStringIndentationSpec.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
package io.gitlab.arturbosch.detekt.rules.style
import io.gitlab.arturbosch.detekt.api.Config
import io.gitlab.arturbosch.detekt.test.TestConfig
import io.gitlab.arturbosch.detekt.test.assertThat
import io.gitlab.arturbosch.detekt.test.compileAndLint
import org.junit.jupiter.api.Nested
import org.junit.jupiter.api.Test
class MultilineRawStringIndentationSpec {
val subject = MultilineRawStringIndentation(Config.empty)
@Nested
inner class IfTheOpeningDoesNotStartTheLine {
@Test
fun `raise multiline raw string without indentation`() {
val code = """
val a = $TQ
Hello world!
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(2, 1)
.hasEndSourceLocation(2, 13)
.hasTextLocations("Hello world!")
}
@Test
fun `raise multiline raw strings without indentation`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(2)
.hasTextLocations("Hello world!", "How are you?")
}
@Test
fun `raise multiline raw strings without right indentation`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(2, 2)
.hasEndSourceLocation(2, 14)
.hasTextLocations("Hello world!")
}
@Test
fun `raise multiline raw strings with too much indentation`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(2, 5)
.hasEndSourceLocation(3, 18)
.hasTextLocations(" Hello world!\n How are you?")
}
@Test
fun `don't raise multiline raw strings if one has correct indentation and the other more`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `don't raise multiline raw strings if all have the correct indentation`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `don't raise multiline raw strings if all have the correct indentation or empty`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `raise multiline raw strings if a blank line doesn't have the minimum indentation`() {
val code = """
val a = $TQ
Hello world!
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(3, 1)
.hasEndSourceLocation(3, 3)
}
@Test
fun `raise multiline raw strings with indentation on closing`() {
val code = """
val a = $TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(4, 1)
.hasEndSourceLocation(4, 5)
}
}
@Nested
inner class IfTheOpeningStartTheLine {
@Test
fun `raise multiline raw string without indentation`() {
val code = """
val a =
$TQ
Hello world!
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(3, 5)
.hasEndSourceLocation(3, 17)
}
@Test
fun `raise multiline raw strings without indentation`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(2)
}
@Test
fun `raise multiline raw strings without right indentation`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(3, 6)
.hasEndSourceLocation(3, 18)
}
@Test
fun `raise multiline raw strings with too much indentation`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(3, 9)
.hasEndSourceLocation(4, 22)
.hasTextLocations(" Hello world!\n How are you?")
}
@Test
fun `don't raise multiline raw strings if one has correct indentation and the other more`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `don't raise multiline raw strings if all have the correct indentation`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `raise multiline raw strings with too much indentation on closing`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(5, 5)
.hasEndSourceLocation(5, 9)
}
@Test
fun `raise multiline raw strings with too little indentation on closing`() {
val code = """
val a =
$TQ
Hello world!
How are you?
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
.hasStartSourceLocation(5, 3)
.hasEndSourceLocation(5, 6)
}
}
@Nested
inner class CasesThatShouldBeIgnored {
@Test
fun `doesn't raise multiline raw strings without trim`() {
val code = """
val a = $TQ
Hello world!
$TQ
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `don't raise one line raw strings`() {
val code = """
val a = ${TQ}Hello world!$TQ
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `doesn't raise if it is not a raw string`() {
val code = """
val a = "Hello world!"
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
@Test
fun `don't raise if it isEmpty`() {
val code = """
val a = $TQ
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `don't raise if it has no line breaks`() {
val code = """
val a = ${TQ}Hello world!$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.isEmpty()
}
@Test
fun `don't raise multiline raw strings if all have the correct indentation - tabs`() {
val code = """
fun respond(content: String, status: Int) {}
fun redirect(accessToken: String, refreshToken: String) {
${TAB}respond(
$TAB${TAB}content = $TQ
$TAB$TAB$TAB{
$TAB$TAB$TAB "access_token": "${'$'}{accessToken}",
$TAB$TAB$TAB "token_type": "fake_token_type",
$TAB$TAB$TAB "expires_in": 3600,
$TAB$TAB$TAB "refresh_token": "${'$'}{refreshToken}"
$TAB$TAB$TAB}
$TAB$TAB$TQ.trimIndent(),
$TAB${TAB}status = 302
$TAB)
}
""".trimIndent()
val subject = MultilineRawStringIndentation(TestConfig(mapOf("indentSize" to 1)))
subject.compileAndLint(code)
assertThat(subject.findings).isEmpty()
}
}
@Nested
inner class MissingBreakingLine {
@Test
fun `raise missing break line start`() {
val code = """
val a = ${TQ}Hello world!
Hola mundo!
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
}
@Test
fun `raise missing break line end`() {
val code = """
val a = $TQ
Hello world!
Hola mundo!$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
}
@Test
fun `raise missing break line both`() {
val code = """
val a = ${TQ}Hello world!
Hola mundo!$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(1)
}
@Test
fun `don't raise multiline raw string when correct`() {
val code = """
val a = $TQ
Hello world!
Hola mundo!
$TQ.trimIndent()
""".trimIndent()
subject.compileAndLint(code)
assertThat(subject.findings)
.hasSize(0)
}
}
}
private const val TQ = "\"\"\""
private const val TAB = "\t"