https://github.com/mockito/mockito-kotlin

Using Mockito with Kotlin
https://github.com/mockito/mockito-kotlin

kotlin mockito mockito-kotlin

Last synced: about 12 hours ago
JSON representation

Using Mockito with Kotlin

• Host: GitHub
• URL: https://github.com/mockito/mockito-kotlin
• Owner: mockito
• License: mit
• Created: 2016-01-18T20:48:20.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2024-04-09T17:49:23.000Z (9 months ago)
• Last Synced: 2024-05-21T01:59:06.671Z (8 months ago)
• Topics: kotlin, mockito, mockito-kotlin
• Language: Kotlin
• Homepage:
• Size: 642 KB
• Stars: 3,078
• Watchers: 44
• Forks: 198
• Open Issues: 72
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• stars - mockito/mockito-kotlin
• awesome-kotlin - mockito-kotlin - Using Mockito with Kotlin (Libraries)
• awesome-list - mockito/mockito-kotlin - Using Mockito with Kotlin (Kotlin)

README

        
# Mockito-Kotlin

[ ![Download](https://maven-badges.herokuapp.com/maven-central/org.mockito.kotlin/mockito-kotlin/badge.svg) ](https://maven-badges.herokuapp.com/maven-central/org.mockito.kotlin/mockito-kotlin)

[![Nexus Snapshot](https://img.shields.io/nexus/s/org.mockito.kotlin/mockito-kotlin?server=https%3A%2F%2Fs01.oss.sonatype.org%2F)](https://s01.oss.sonatype.org/content/repositories/snapshots/org/mockito/kotlin/mockito-kotlin/)

A small library that provides helper functions to work with [Mockito](https://github.com/mockito/mockito) in Kotlin.

## Install

Mockito-Kotlin is available on Maven Central.

For Gradle users, add the following to your `build.gradle`, replacing `x.x.x` with the latest version:

```groovy

testImplementation "org.mockito.kotlin:mockito-kotlin:x.x.x"

```

## Example

A test using Mockito-Kotlin typically looks like the following:

```kotlin

@Test

fun doAction_doesSomething(){ 

  /* Given */

  val mock = mock {

    on { getText() } doReturn "text"

  }

  val classUnderTest = ClassUnderTest(mock)

  

  /* When */

  classUnderTest.doAction()

  

  /* Then */

  verify(mock).doSomething(any())

}

```

For more info and samples, see the [Wiki](https://github.com/mockito/mockito-kotlin/wiki).

## Building

Mockito-Kotlin is built with Gradle.

 - `./gradlew build` builds and tests the project

 - `./gradlew publishToMavenLocal` installs the maven artifacts in your local repository

 - `./gradlew check` runs the test suite (See Testing below)

### Versioning

Mockito-Kotlin roughly follows SEMVER

### Testing

Mockito-Kotlin's test suite is located in a separate `tests` module,

to allow running the tests using several Kotlin versions whilst still

keeping the base module at a recent version.

 - `./gradlew check` runs the checks including tests.

Usually it is enough to test only using the default Kotlin versions;

CI will test against multiple versions.

If you want to test using a different Kotlin version locally,

add the `-PtestKotlinVersion=1.2.3` argument to the Gradle invocation while running the tests.

### Acknowledgements

`mockito-kotlin` was created and developed by [nhaarman@](https://github.com/nhaarman) after which the repository was integrated into the official Mockito GitHub organization.

We would like to thank Niek for the original idea and extensive work plus support that went into `mockito-kotlin`.