https://github.com/wickie73/mockito4kotlin-annotation
Mockito Annotations for Kotlin
https://github.com/wickie73/mockito4kotlin-annotation
annotations kotlin kotlin-testing mockito mockito-kotlin test-driven-development unit-testing
Last synced: 6 months ago
JSON representation
Mockito Annotations for Kotlin
- Host: GitHub
- URL: https://github.com/wickie73/mockito4kotlin-annotation
- Owner: wickie73
- License: mit
- Created: 2018-02-24T20:47:21.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2022-04-24T20:19:56.000Z (about 4 years ago)
- Last Synced: 2023-07-28T10:11:27.914Z (almost 3 years ago)
- Topics: annotations, kotlin, kotlin-testing, mockito, mockito-kotlin, test-driven-development, unit-testing
- Language: Kotlin
- Homepage:
- Size: 623 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Mockito Annotations for Kotlin
[](https://github.com/wickie73/mockito4kotlin-annotation/blob/master/LICENSE)
[  ](https://maven-badges.herokuapp.com/maven-central/io.github.wickie73/mockito4kotlin-annotation)
This is a small Kotlin library which supports Annotations for Mockito 2.x or Kotlin libraries based on Mockito like
[mockito-kotlin](https://github.com/mockito/mockito-kotlin/tree/main/).
In this library the initialization of fields annotated with Mockito annotations by code
`MockitoAnnotations.initMocks(testClass)`
is replaced by
`KMockitoAnnotations.initMocks(testClass)`
which is written in Kotlin and supports most of Kotlin specific features.
It is compatible with [MockitoAnnotations.initMocks(testClass)](https://javadoc.io/doc/org.mockito/mockito-core/3.8.0/org/mockito/ArgumentMatcher.html).
## Content
* [Installing](#installing)
* [Examples](#examples)
* [Limitations](#limitations)
* [@KCapture vs. @Captor Annotation](#kcapture-vs-captor-annotation)
Installing
----------
Mockito Annotations for Kotlin is available on jcenter.
### gradle
```gradle
testCompile 'io.github.wickie73:mockito4kotlin-annotation:0.5.x'
```
### maven
```xml
io.github.wickie73
mockito4kotlin-annotation
0.5.x
test
```
Examples
--------
Mock with Annotation:
```kotlin
@Mock
lateinit var addressDAO: AddressDAO
@Mock
lateinit var address: Address
@Before
fun setUp() {
KMockitoAnnotations.initMocks(this)
}
@Test
fun testService() {
val addressList = listOf(address)
// with Mockito
`when`(addressDAO.getAddressList()).thenReturn(addressList)
// or with Mockito-Kotlin
whenever(addressDAO.getAddressList()).thenReturn(addressList)
}
```
Spy with Annotation:
```kotlin
@Spy
var addressDAO = AddressDAO()
@Mock
lateinit var address: Address
@Before
fun setUp() {
KMockitoAnnotations.initMocks(this)
}
@Test
fun testService() {
val addressList = listOf(address)
// with Mockito
`when`(addressDAO.getAddressList()).thenReturn(addressList)
// or with Mockito-Kotlin
whenever(addressDAO.getAddressList()).thenReturn(addressList)
}
```
ArgumentCaptor with Annotation:
```kotlin
@Captor
lateinit var captor: ArgumentCaptor
@Mock
lateinit var addressDAO: AddressDAO
@Before
fun setUp() {
KMockitoAnnotations.initMocks(this)
}
@Test
fun testService() {
val address: Address().apply {
street = "Abbey Road 73"
city = "London"
}
addressDAO.save(address)
verify(addressDAO).save(captor.capture())
assertEquals(address, captor.value)
}
interface AddressDAO {
fun getAddressList(): List
fun save(address: Address?) // 'Address?' has to be nullable here
}
```
[Mockito-Kotlin](https://github.com/mockito/mockito-kotlin/tree/main/) KArgumentCaptor with KCapture Annotation:
```kotlin
@KCaptor
lateinit var captor: KArgumentCaptor
@Mock
lateinit var addressDAO: AddressDAO
@Before
fun setUp() {
KMockitoAnnotations.initMocks(this)
}
@Test
fun testService() {
val address: Address().apply {
street = "Abbey Road 73"
city = "London"
}
addressDAO.save(address)
verify(addressDAO).save(captor.capture())
assertEquals(address, captor.firstValue)
}
interface AddressDAO {
fun getAddressList(): List
fun save(address: Address) // 'Address' has not to be nullable here
}
```
Inject Mocks with Annotation:
```kotlin
@Spy
lateinit var addressList: List
@Mock
lateinit var addressDatabase: AddressDatabase
@InjectMocks
val addressDAO: AddressDAOImpl()
@Before
fun setUp() {
KMockitoAnnotations.initMocks(this)
}
@Test
fun testService() {
// with Mockito
`when`(addressList.size()).thenReturn(2)
// or with Mockito-Kotlin
whenever(addressList.size()).thenReturn(2)
verify(addressDatabase).addListener(any(ArticleListener.class))
assertEquals(addressList, addressDAO.addressList)
assertEquals(addressDatabase, addressDAO.addressDatabase)
assertThat(addressDAO.addressList).hasSize(2)
}
class AddressDAOImpl {
lateinit var addressList: List
lateinit var addressDatabase: AddressDatabase
}
```
Limitations
-----------
Stubbing does not work with
* immutable properties ( `val address: Address()` )
* properties of final classes (use `interface` or `open class` )
* properties of sealed classes (only `@Spy` )
* properties of private/internal inner classes
* properties of companion objects
* properties of objects
* delegated properties ( `var p: String by Delegate()` )
Instead stubbing works with
* properties in sealed classes
* properties in private/internal inner classes
* properties in companion objects
* properties in objects
* properties in data classes
* properties of data classes
@KCapture vs. @Captor Annotation
--------------------------------
Mockitos `ArgumentCaptor#capture()` returns null. So like in this example
the type of the argument of method `save(address: Address?)` in interface `AddressDAO` has to be `nullable`:
```kotlin
@Captor
lateinit var captor: ArgumentCaptor
// ...
KMockitoAnnotations.initMocks(this)
// ...
verify(addressDAO).save(captor.capture())
// with:
interface AddressDAO {
fun save(address: Address?) // 'Address?' has to be nullable here
}
```
With [Mockito-Kotlin](https://github.com/mockito/mockito-kotlin) KArgumentCaptor you don't have to be care about
`nullable` parameters:
```kotlin
@KCaptor
lateinit var captor: KArgumentCaptor
// ...
KMockitoAnnotations.initMocks(this)
// ...
verify(addressDAO).save(captor.capture())
// with:
interface AddressDAO {
fun save(address: Address) // 'Address' has not to be nullable here
}
```