https://github.com/faruktoptas/okmocker
OkHttp mocking interceptor
https://github.com/faruktoptas/okmocker
Last synced: 8 months ago
JSON representation
OkHttp mocking interceptor
- Host: GitHub
- URL: https://github.com/faruktoptas/okmocker
- Owner: faruktoptas
- License: apache-2.0
- Created: 2018-12-14T06:44:17.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-01-06T19:28:39.000Z (almost 4 years ago)
- Last Synced: 2025-01-13T19:39:27.821Z (9 months ago)
- Language: Kotlin
- Homepage:
- Size: 197 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# (WIP) okmocker 
Mock OkHttp responses at Interceptor level
# Usage
## Download
Add this in your root `build.gradle` file (**not** your module `build.gradle` file):
```gradle
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
Then, add the library to your module `build.gradle`
```gradle
dependencies {
implementation 'com.github.faruktoptas.okmocker:okmocker-writer:1.1.2'
implementation 'com.github.faruktoptas.okmocker:core:1.1.2'
androidTestImplementation 'com.github.faruktoptas.okmocker:okmocker-reader:1.1.2'
androidTestImplementation 'com.github.faruktoptas.okmocker:core:1.1.2'
}
```
## Case 1 - Run Espresso tests with mock responses
### Step 1 - Add writer interceptor to save real responses
```kotlin
if (BuildConfig.DEBUG) {
okHttpClientBuilder.addInterceptor(OkMockerWriteInterceptor(SdCardWriter(context)))
}
```
Run the app. Responses from the server will be saved to the external storage. Don't forget to grant `WRITE_EXTERNAL_STORAGE` permission. (If your app doesn't need `WRITE_EXTERNAL_STORAGE` permission [you can add this permission to a specific build variant](https://medium.com/android-bits/implement-build-variant-specific-permissions-a330540871b0) that you run the tests)
### Step 2 - Pull responses from device storage to assets folder
Pull saved responses to assets under `androidTest` folder.
```bash
adb pull /sdcard/Android/data/[PACKAGE_NAME]/cache/okmocker app/src/androidTest/assets
```
### Step 3 - Add reader interceptor to tests then run the test
```kotlin
okHttpClientBuilder
.addInterceptor(OkMockerReadInterceptor(AssetsReader(InstrumentationRegistry.getContext().assets)))
```
## Case 2 - Use mock responses to speed up your development
Step 1 is the same as above
### Step 2
Pull responses to the build variant that will use mocking.
```bash
adb pull /sdcard/Android/data/[PACKAGE_NAME]/cache/okmocker app/src/[BUILD_VARIANT]/assets
````
### Step 3
Use application context
```kotlin
okHttpClientBuilder
.addInterceptor(OkMockerReadInterceptor(AssetsReader(applicationContext.assets)))
```
## Case 3 - Use your custom reader/writers
```kotlin
class MyReader : OkMockerReader {
override fun read(chain: Interceptor.Chain): ResponseBody {
val path = chain.request().url().toString().toFileName()
val content = when (path) {
"https://PATH" -> "[{\"name\":\"path\"}]"
else -> "[{\"name\":\"else\"}]"
}
return ResponseBody.create(MediaType.parse("application/json"), content)
}
override fun canRead(request: Request) = true // Always return true
}
```
Pass the reader to the interceptor
```kotlin
.addInterceptor(OkMockerReadInterceptor(MyReader()))
```
# License
[Apache License 2.0](https://github.com/faruktoptas/okmocker/blob/master/LICENSE)