Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/icerockdev/moko-test
Test utilities for mobile (android & ios) Kotlin Multiplatform development
https://github.com/icerockdev/moko-test
android ios kotlin kotlin-multiplatform kotlin-native
Last synced: 3 months ago
JSON representation
Test utilities for mobile (android & ios) Kotlin Multiplatform development
- Host: GitHub
- URL: https://github.com/icerockdev/moko-test
- Owner: icerockdev
- License: apache-2.0
- Created: 2021-01-07T17:49:16.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T14:40:53.000Z (almost 3 years ago)
- Last Synced: 2024-10-02T03:01:31.858Z (4 months ago)
- Topics: android, ios, kotlin, kotlin-multiplatform, kotlin-native
- Language: Kotlin
- Homepage: https://moko.icerock.dev/
- Size: 148 KB
- Stars: 11
- Watchers: 7
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](http://www.apache.org/licenses/LICENSE-2.0)
[ ](https://repo1.maven.org/maven2/dev/icerock/moko/test-core/)
# Mobile Kotlin test utils
This is a Kotlin Multiplatform library that provides utilities for run tests.
## Table of Contents
- [Features](#features)
- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Samples](#samples)
- [Set Up Locally](#set-up-locally)
- [Contributing](#contributing)
- [License](#license)
## Features
- **...** - ...;
## Requirements
- Gradle version 6.8+
- Android API 16+
- iOS version 11.0+
## Installation
root build.gradle
```groovy
allprojects {
repositories {
mavenCentral()
}
}
```
project build.gradle
```groovy
dependencies {
commonTestApi("dev.icerock.moko:test-core:0.6.1")
commonTestApi("dev.icerock.moko:test-roboelectric:0.6.1") // for android-roboelectric tests support
}
```
## Usage
### runBlocking
```kotlin
import dev.icerock.moko.test.runBlocking
fun test() {
runBlocking {
// some suspend functions
}
}
```
### TestCases
```kotlin
class MyTests : TestCases() {
override val rules: List = listOf(
InstantTaskRule() // apply https://developer.android.com/reference/android/arch/core/executor/testing/InstantTaskExecutorRule for android
)
@Test
fun `my test`() {
// ...
}
}
```
also available creation of own rules by inherit `dev.icerock.moko.test.cases.TestCases.Rule`
```kotlin
class InstantTaskRule : TestCases.Rule {
override fun setup() {
// do some action before each test
}
override fun tearDown() {
// do some action after each test
}
}
```
### Roboelectric support
```kotlin
class MyTests : RoboelectricTestCases() {
override val rules: List = listOf(
// ...
)
@Test
fun `my test`() {
// ...
}
}
```
## Samples
Please see more examples in the [sample directory](sample).
## Set Up Locally
- The [test directory](test) contains the `test` library;
- In [sample directory](sample) contains sample mpp-library with tests.
## Contributing
All development (both new features and bug fixes) is performed in the `develop` branch. This
way `master` always contains the sources of the most recently released version. Please send PRs with
bug fixes to the `develop` branch. Documentation fixes in the markdown files are an exception to
this rule. They are updated directly in `master`.
The `develop` branch is pushed to `master` on release.
For more details on contributing please see the [contributing guide](CONTRIBUTING.md).
## License
Copyright 2021 IceRock MAG Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.