/
Matchers.kt
472 lines (387 loc) · 12.4 KB
/
Matchers.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
package io.mockk
import io.mockk.InternalPlatformDsl.toArray
import io.mockk.InternalPlatformDsl.toStr
import kotlin.math.min
import kotlin.reflect.KClass
/**
* Matcher that checks equality. By reference and by value (equals method)
*/
data class EqMatcher<in T : Any>(private val valueArg: T, val ref: Boolean = false, val inverse: Boolean = false) :
Matcher<T> {
val value = InternalPlatformDsl.unboxChar(valueArg)
override fun match(arg: T?): Boolean {
val result = if (ref) {
arg === value
} else {
if (arg == null) {
false
} else {
val unboxedArg = InternalPlatformDsl.unboxChar(arg)
InternalPlatformDsl.deepEquals(unboxedArg, value)
}
}
return if (inverse) !result else result
}
override fun substitute(map: Map<Any, Any>) =
copy(valueArg = valueArg.internalSubstitute(map))
override fun toString(): String {
return if (ref)
"${if (inverse) "refNonEq" else "refEq"}(${value.toStr()})"
else
"${if (inverse) "nonEq" else "eq"}(${value.toStr()})"
}
}
/**
* Matcher that always returns one same value.
*/
data class ConstantMatcher<in T : Any>(val constValue: Boolean) : Matcher<T> {
override fun match(arg: T?): Boolean = constValue
override fun toString(): String = if (constValue) "any()" else "none()"
}
/**
* Delegates matching to lambda function
*/
data class FunctionMatcher<in T : Any>(
val matchingFunc: (T) -> Boolean,
override val argumentType: KClass<*>
) : Matcher<T>, TypedMatcher, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher(true)
override fun match(arg: T?): Boolean {
return if(arg == null) {
false
} else {
matchingFunc(arg)
}
}
override fun toString(): String = "matcher<${argumentType.simpleName}>()"
}
data class FunctionWithNullableArgMatcher<in T : Any>(
val matchingFunc: (T?) -> Boolean,
override val argumentType: KClass<*>
) : Matcher<T>, TypedMatcher, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher(true)
override fun match(arg: T?): Boolean = matchingFunc(arg)
override fun checkType(arg: Any?): Boolean {
if(arg == null) {
return true
}
return super.checkType(arg)
}
override fun toString(): String = "matcher<${argumentType.simpleName}>()"
}
/**
* Matcher capturing all results to the list.
*/
data class CaptureMatcher<T : Any>(
val captureList: MutableList<T>,
override val argumentType: KClass<*>
) : Matcher<T>, CapturingMatcher, TypedMatcher, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher<Any>(true)
@Suppress("UNCHECKED_CAST")
override fun capture(arg: Any?) {
captureList.add(arg as T)
}
override fun match(arg: T?): Boolean = true
override fun toString(): String = "capture<${argumentType.simpleName}>()"
}
/**
* Matcher capturing all results to the list. Allows nulls
*/
data class CaptureNullableMatcher<T : Any>(
val captureList: MutableList<T?>,
override val argumentType: KClass<*>
) : Matcher<T>, CapturingMatcher, TypedMatcher, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher(true)
@Suppress("UNCHECKED_CAST")
override fun capture(arg: Any?) {
captureList.add(arg as T?)
}
override fun match(arg: T?): Boolean = true
override fun checkType(arg: Any?): Boolean {
if(arg == null) {
return true
}
return super.checkType(arg)
}
override fun toString(): String = "capture<${argumentType.simpleName}?>()"
}
/**
* Matcher capturing one last value to the CapturingSlot
*/
data class CapturingSlotMatcher<T : Any>(
val captureSlot: CapturingSlot<T>,
override val argumentType: KClass<*>
) : Matcher<T>, CapturingMatcher, TypedMatcher, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher<Any>(true)
@Suppress("UNCHECKED_CAST")
override fun capture(arg: Any?) {
if (arg == null) {
captureSlot.isNull = true
} else {
captureSlot.isNull = false
captureSlot.captured = arg as T
}
captureSlot.isCaptured = true
}
override fun match(arg: T?): Boolean = true
override fun toString(): String = "slotCapture<${argumentType.simpleName}>()"
}
/**
* Matcher comparing values
*/
data class ComparingMatcher<T : Comparable<T>>(
val value: T,
val cmpFunc: Int,
override val argumentType: KClass<T>
) : Matcher<T>, TypedMatcher {
override fun match(arg: T?): Boolean {
if (arg == null) return false
val n = arg.compareTo(value)
return when (cmpFunc) {
2 -> n >= 0
1 -> n > 0
0 -> n == 0
-1 -> n < 0
-2 -> n <= 0
else -> throw MockKException("Bad comparison function")
}
}
override fun substitute(map: Map<Any, Any>) =
copy(value = value.internalSubstitute(map))
override fun toString(): String =
when (cmpFunc) {
-2 -> "lessAndEquals($value)"
-1 -> "less($value)"
0 -> "cmpEq($value)"
1 -> "more($value)"
2 -> "moreAndEquals($value)"
else -> throw MockKException("Bad comparison function")
}
}
/**
* Boolean logic "AND" and "OR" matcher composed of two other matchers
*/
data class AndOrMatcher<T : Any>(
val and: Boolean,
val first: T,
val second: T
) : Matcher<T>, CompositeMatcher<T>, CapturingMatcher {
override val operandValues: List<T>
get() = listOf(first, second)
override var subMatchers: List<Matcher<T>>? = null
override fun match(arg: T?): Boolean =
if (and)
subMatchers!![0].match(arg) && subMatchers!![1].match(arg)
else
subMatchers!![0].match(arg) || subMatchers!![1].match(arg)
override fun substitute(map: Map<Any, Any>): Matcher<T> {
val matcher = copy(
first = first.internalSubstitute(map),
second = second.internalSubstitute(map)
)
val sm = subMatchers
if (sm != null) {
matcher.subMatchers = sm.map { it.substitute(map) }
}
return matcher
}
override fun capture(arg: Any?) {
captureSubMatchers(arg)
}
override fun toString(): String {
val sm = subMatchers
val op = if (and) "and" else "or"
return if (sm != null)
"$op(${sm[0]}, ${sm[1]})"
else
"$op()"
}
}
/**
* Boolean logic "NOT" matcher composed of one matcher
*/
data class NotMatcher<T : Any>(val value: T) : Matcher<T>, CompositeMatcher<T>, CapturingMatcher {
override val operandValues: List<T>
get() = listOf(value)
override var subMatchers: List<Matcher<T>>? = null
override fun match(arg: T?): Boolean =
!subMatchers!![0].match(arg)
override fun substitute(map: Map<Any, Any>): Matcher<T> {
val matcher = copy(value = value.internalSubstitute(map))
val sm = subMatchers
if (sm != null) {
matcher.subMatchers = sm.map { it.substitute(map) }
}
return matcher
}
override fun capture(arg: Any?) {
captureSubMatchers(arg)
}
override fun toString(): String {
val sm = subMatchers
return if (sm != null)
"not(${sm[0]})"
else
"not()"
}
}
/**
* Checks if argument is null or non-null
*/
data class NullCheckMatcher<in T : Any>(val inverse: Boolean = false) : Matcher<T> {
override fun match(arg: T?): Boolean = if (inverse) arg != null else arg == null
override fun toString(): String {
return if (inverse)
"notNull()"
else
"null()"
}
}
/**
* Checks matcher data type
*/
data class OfTypeMatcher<in T : Any>(val cls: KClass<*>) : Matcher<T> {
override fun match(arg: T?): Boolean = cls.isInstance(arg)
override fun toString() = "ofType(${cls.simpleName})"
}
/**
* Matcher to replace all unspecified argument matchers to any()
* Handled by logic in a special way
*/
class AllAnyMatcher<T> : Matcher<T> {
override fun match(arg: T?): Boolean = true
override fun toString() = "allAny()"
}
/**
* Invokes lambda
*/
class InvokeMatcher<in T : Any>(val block: (T) -> Unit) : Matcher<T>, EquivalentMatcher {
override fun equivalent(): Matcher<Any> = ConstantMatcher<Any>(true)
override fun match(arg: T?): Boolean {
if (arg == null) {
return true
}
block(arg)
return true
}
override fun toString(): String = "coInvoke()"
}
/**
* Matcher that can match arrays via provided matchers for each element.
*/
data class ArrayMatcher<in T : Any>(private val matchers: List<Matcher<Any>>) : Matcher<T>, CapturingMatcher {
override fun capture(arg: Any?) {
if (arg == null) {
return
}
val arr = arg.toArray()
repeat(min(arr.size, matchers.size)) { i ->
val matcher = matchers[i]
if (matcher is CapturingMatcher) {
matcher.capture(arr[i])
}
}
}
override fun match(arg: T?): Boolean {
if (arg == null) {
return false
}
val arr = arg.toArray()
if (arr.size != matchers.size) {
return false
}
repeat(arr.size) { i ->
if (!matchers[i].match(arr[i])) {
return false
}
}
return true
}
override fun substitute(map: Map<Any, Any>) =
copy(matchers = matchers.map { it.substitute(map) })
override fun toString(): String {
return matchers.joinToString(prefix = "[", postfix = "]")
}
}
data class VarargMatcher<T : Any>(
private val all: Boolean,
private val matcher: MockKMatcherScope.MockKVarargScope.(T?) -> Boolean,
private val prefix: List<Matcher<T>> = listOf(),
private val postfix: List<Matcher<T>> = listOf()
) : Matcher<Any>, CapturingMatcher {
@Suppress("UNCHECKED_CAST")
override fun match(arg: Any?): Boolean {
if (arg == null) {
return false
}
val arr = arg.toArray()
if (arr.size < prefix.size + postfix.size) {
return false
}
repeat(prefix.size) {
val el = arr[it] as T?
if (!prefix[it].match(el)) {
return false
}
}
repeat(postfix.size) {
val el = arr[arr.size - postfix.size + it] as T?
if (!postfix[it].match(el)) {
return false
}
}
val centralPartSize = arr.size - postfix.size - prefix.size
if (all) {
repeat(centralPartSize) {
val position = it + prefix.size
val el = arr[position] as T?
val scope = MockKMatcherScope.MockKVarargScope(position, arr.size)
if (!scope.matcher(el)) {
return false
}
}
return true
} else {
repeat(centralPartSize) {
val position = it + prefix.size
val el = arr[position] as T?
val scope = MockKMatcherScope.MockKVarargScope(position, arr.size)
if (scope.matcher(el)) {
return true
}
}
return false
}
}
@Suppress("UNCHECKED_CAST")
override fun capture(arg: Any?) {
if (arg == null) {
return
}
val arr = arg.toArray()
if (arr.size < prefix.size + postfix.size) {
return
}
repeat(prefix.size) {
val el = arr[it] as T?
val elMatcher = prefix[it]
if (elMatcher is CapturingMatcher) {
elMatcher.capture(el)
}
}
repeat(postfix.size) {
val el = arr[arr.size - postfix.size + it] as T?
val elMatcher = postfix[it]
if (elMatcher is CapturingMatcher) {
elMatcher.capture(el)
}
}
}
override fun toString() = "VarargMatcher(all=$all, prefix=$prefix, postfix=$postfix, centralPart=lambda)"
}
fun CompositeMatcher<*>.captureSubMatchers(arg: Any?) {
subMatchers?.let {
it.filterIsInstance<CapturingMatcher>()
.forEach { it.capture(arg) }
}
}