Trendyol / mockingstar-android

Mocking Star Kotlin helper library for Android applications.

Mocking Star 🌟

Mocking Star is a powerful request mocking tool designed to simplify the process of http request mocking, network debugging, and using UI tests for your mobile applications. With just a single line of code, you can use Mocking Star in your project.

Key Features

• Mocking Requests: Easily mock requests and test different cases with scenarios.
• Modifying Requests: Modify intercepted requests to test different edge cases, allowing you to assess your application's performance under different conditions.
• Debugging Support: Use Mocking Star to debug your network requests on your mac.
• UI Testing: Integrate Mocking Star into your UI tests, creating a reliable and controlled testing environment to validate your mobile application's functionality.

Mocking Star App -> Mocking Star
iOS Library -> Mocking Star iOS Library

Installation

Library is distributed through JitPack.

Add repository to the root build.gradle

repositories {
	maven { url("https://jitpack.io") }
}

Add the library

implementation("com.github.Trendyol:mockingstar-android:{latest-version}")

You can check the latest version from the Releases

How to Use

Library consists of an OkHttp Interceptor called MockingStarInterceptor.

It can take two parameters:

• MockUrlParam: class to customize the connection url should you decide to update.
• header: A string map, is used to supply any custom header pair you want to add to the ongoing request.

class MockingStarInterceptor(
	private val params: MockUrlParams = MockUrlParams(),
	private val header: Map<String, String> = emptyMap(),
) : Interceptor {

// Class contents

}

To use it, pass the MockingStarInterceptor to your OkHttpClient. After this, you can monitor the requests that are sent from your application on Mockingstar.

OkHttpClient.Builder()
  // configuration code
  .addInterceptor(MockingStarInterceptor())
  .build()

Warning!

Default address to communicate with MockingStar application is 10.0.2.2. This type of network access is disabled by default in Android Applications. You must add

android:usesCleartextTraffic="true"

to the application block in your AndroidManifest.xml to enable it.

License

This library is released under the MIT license. See LICENSE for details.