forked from mockito/mockito-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ArgumentCaptor.kt
226 lines (198 loc) · 7.46 KB
/
ArgumentCaptor.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
/*
* The MIT License
*
* Copyright (c) 2018 Niek Haarman
* Copyright (c) 2007 Mockito contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package org.mockito.kotlin
import org.mockito.kotlin.internal.createInstance
import org.mockito.ArgumentCaptor
import java.lang.reflect.Array
import kotlin.reflect.KClass
/**
* Creates a [KArgumentCaptor] for given type.
*/
inline fun <reified T : Any> argumentCaptor(): KArgumentCaptor<T> {
return KArgumentCaptor(ArgumentCaptor.forClass(T::class.java), T::class)
}
/**
* Creates 2 [KArgumentCaptor]s for given types.
*/
inline fun <reified A : Any, reified B : Any> argumentCaptor(
a: KClass<A> = A::class,
b: KClass<B> = B::class
): Pair<KArgumentCaptor<A>, KArgumentCaptor<B>> {
return Pair(
KArgumentCaptor(ArgumentCaptor.forClass(a.java), a),
KArgumentCaptor(ArgumentCaptor.forClass(b.java), b)
)
}
/**
* Creates 3 [KArgumentCaptor]s for given types.
*/
inline fun <reified A : Any, reified B : Any, reified C : Any> argumentCaptor(
a: KClass<A> = A::class,
b: KClass<B> = B::class,
c: KClass<C> = C::class
): Triple<KArgumentCaptor<A>, KArgumentCaptor<B>, KArgumentCaptor<C>> {
return Triple(
KArgumentCaptor(ArgumentCaptor.forClass(a.java), a),
KArgumentCaptor(ArgumentCaptor.forClass(b.java), b),
KArgumentCaptor(ArgumentCaptor.forClass(c.java), c)
)
}
class ArgumentCaptorHolder4<out A, out B, out C, out D>(
val first: A,
val second: B,
val third: C,
val fourth: D
) {
operator fun component1() = first
operator fun component2() = second
operator fun component3() = third
operator fun component4() = fourth
}
class ArgumentCaptorHolder5<out A, out B, out C, out D, out E>(
val first: A,
val second: B,
val third: C,
val fourth: D,
val fifth: E
) {
operator fun component1() = first
operator fun component2() = second
operator fun component3() = third
operator fun component4() = fourth
operator fun component5() = fifth
}
/**
* Creates 4 [KArgumentCaptor]s for given types.
*/
inline fun <reified A : Any, reified B : Any, reified C : Any, reified D : Any> argumentCaptor(
a: KClass<A> = A::class,
b: KClass<B> = B::class,
c: KClass<C> = C::class,
d: KClass<D> = D::class
): ArgumentCaptorHolder4<KArgumentCaptor<A>, KArgumentCaptor<B>, KArgumentCaptor<C>, KArgumentCaptor<D>> {
return ArgumentCaptorHolder4(
KArgumentCaptor(ArgumentCaptor.forClass(a.java), a),
KArgumentCaptor(ArgumentCaptor.forClass(b.java), b),
KArgumentCaptor(ArgumentCaptor.forClass(c.java), c),
KArgumentCaptor(ArgumentCaptor.forClass(d.java), d)
)
}
/**
* Creates 4 [KArgumentCaptor]s for given types.
*/
inline fun <reified A : Any, reified B : Any, reified C : Any, reified D : Any, reified E : Any> argumentCaptor(
a: KClass<A> = A::class,
b: KClass<B> = B::class,
c: KClass<C> = C::class,
d: KClass<D> = D::class,
e: KClass<E> = E::class
): ArgumentCaptorHolder5<KArgumentCaptor<A>, KArgumentCaptor<B>, KArgumentCaptor<C>, KArgumentCaptor<D>, KArgumentCaptor<E>> {
return ArgumentCaptorHolder5(
KArgumentCaptor(ArgumentCaptor.forClass(a.java), a),
KArgumentCaptor(ArgumentCaptor.forClass(b.java), b),
KArgumentCaptor(ArgumentCaptor.forClass(c.java), c),
KArgumentCaptor(ArgumentCaptor.forClass(d.java), d),
KArgumentCaptor(ArgumentCaptor.forClass(e.java), e)
)
}
/**
* Creates a [KArgumentCaptor] for given type, taking in a lambda to allow fast verification.
*/
inline fun <reified T : Any> argumentCaptor(f: KArgumentCaptor<T>.() -> Unit): KArgumentCaptor<T> {
return argumentCaptor<T>().apply(f)
}
/**
* Creates a [KArgumentCaptor] for given nullable type.
*/
inline fun <reified T : Any> nullableArgumentCaptor(): KArgumentCaptor<T?> {
return KArgumentCaptor(ArgumentCaptor.forClass(T::class.java), T::class)
}
/**
* Creates a [KArgumentCaptor] for given nullable type, taking in a lambda to allow fast verification.
*/
inline fun <reified T : Any> nullableArgumentCaptor(f: KArgumentCaptor<T?>.() -> Unit): KArgumentCaptor<T?> {
return nullableArgumentCaptor<T>().apply(f)
}
/**
* Alias for [ArgumentCaptor.capture].
*/
inline fun <reified T : Any> capture(captor: ArgumentCaptor<T>): T {
return captor.capture() ?: createInstance()
}
class KArgumentCaptor<out T : Any?>(
private val captor: ArgumentCaptor<T>,
private val tClass: KClass<*>
) {
/**
* The first captured value of the argument.
* @throws IndexOutOfBoundsException if the value is not available.
*/
val firstValue: T
get() = captor.firstValue
/**
* The second captured value of the argument.
* @throws IndexOutOfBoundsException if the value is not available.
*/
val secondValue: T
get() = captor.secondValue
/**
* The third captured value of the argument.
* @throws IndexOutOfBoundsException if the value is not available.
*/
val thirdValue: T
get() = captor.thirdValue
/**
* The last captured value of the argument.
* @throws IndexOutOfBoundsException if the value is not available.
*/
val lastValue: T
get() = captor.lastValue
val allValues: List<T>
get() = captor.allValues
@Suppress("UNCHECKED_CAST")
fun capture(): T {
// Special handling for arrays to make it work for varargs
// In Kotlin we want have to capture vararg like this `verify(m).methodName(*captor.capture())` to make the types work
// If we return null for array types, the spread `*` operator will fail with NPE
// If we return empty array, it will fail in MatchersBinder.validateMatchers
// In Java, `captor.capture` returns null and so the method is called with `[null]`
// In Kotlin, we have to create `[null]` explicitly.
// This code-path is applied for non-vararg array arguments as well, but it seems to work fine.
return captor.capture() ?: if (tClass.java.isArray) {
singleElementArray()
} else {
createInstance(tClass)
} as T
}
private fun singleElementArray(): Any? = Array.newInstance(tClass.java.componentType, 1)
}
val <T> ArgumentCaptor<T>.firstValue: T
get() = allValues[0]
val <T> ArgumentCaptor<T>.secondValue: T
get() = allValues[1]
val <T> ArgumentCaptor<T>.thirdValue: T
get() = allValues[2]
val <T> ArgumentCaptor<T>.lastValue: T
get() = allValues.last()