Skip to content

Latest commit

 

History

History
86 lines (67 loc) · 3 KB

SAMPLE.md

File metadata and controls

86 lines (67 loc) · 3 KB

Sample usage of MockWebServer path dispatcher.

MockWebServer is a library for mocking server responses. MockwebServer path dispatcher is a helper library that helps write tests in more concise and readable way. Some ideas were taken from MockWebServer+ - library that uses yaml files to store responses in resources package.

Setup

First thing to do is to change your BASE_API_URL. The easiest way to do that is to create new build type or product flavor that contains changed API URL to localhost.

productFlavors {
        letswift {
            buildConfigField 'String', 'BASE_API_URL', '"https://api.letswift.pl/api/v1/"'
        }
        mockUiTest {
            buildConfigField 'String', 'BASE_API_URL', '"http://localhost:12345"'
        }
    }

Second thing is to add mockWebServer-path-dispatcher to your test dependencies.

androidTestImplementation "pl.droidsonroids.testing:mockwebserver-path-dispatcher:1.0.1"

Next you need to create resources/fixtures directory. And put there your responses.

src
├── test
│   ├── java
│   ├── resources
│   │   ├── fixtures
│   │   │   ├── events_200.yaml
│   │   │   ├── event17_200.yaml

Sample response in yaml file:

statusCode : 200
headers:
- 'Content-Type: application/json; charset=UTF-8'
body: >
    {
      "events": "body"
    }

Implementation

Last step is to implement it into your test class.

@JvmField
@Rule
val activityRule = ActivityTestRule(MainActivity::class.java, true, false) //launchActivity should be set to false because you want to execute your mockWebServer code before activity start

val mockWebServer = MockWebServer

private fun setPathDispatcher() {
        val dispatcher = FixtureDispatcher()
        val condition = PathQueryConditionFactory("/api/v1/") //pathPrefix is optional you can put empty string here if your paths does not have common part
        dispatcher.putResponse(condition.withPathInfix("path"), "yaml_file_response") //URL with whole path will look like this http://localhost:12345/api/v1/path
        dispatcher.putResponse(condition.withPathInfix("events"), "events_200")
        dispatcher.putResponse(condition.withPathInfix("/events/17"), "event17_200")
        mockWebServer.setPathDispatcher(dispatcher)
}

@Before
fun setup() {
    setPathDispatcher() //Set your dispatcher before server is started
    mockWebServer.start(12345) //Start mockWebServer using port you set in API URL
    activityRule.launchActivity(null)
}

@After
fun tearDown() {
    mockWebServer.shutdown()
}

Clone project to test it in action.

Documentation

MockWebServer path dispatcher have also ability to match your responses by pathAndQueryParameter. Check detailed documentation for more info -> HERE