- We are here to practice integration testing using HTTP stubbing.
- We are going to use KtorClientMock to return stub responses.
- We are going to use KotlinTest to write tests and to perform assertions.
- We are going to practice pair programming.
This repository contains an kotlin multiplatform library with an API client to interact with the JSONPlaceholder service.
This API Client is based on one class with name
TodoApiClient containing some methods to interact with the API. Using this class we can get all the tasks, get a task using the task id, add a new task, update a task or delete an already created task.
The API client has been implemented using a multiplatform networking framework named Ktor. Review the project documentation if needed.
Your task as a multiplatform Kotlin Developer is to write all the integration tests needed to check if the API Client is working as expected.
This repository is ready to build the application, pass the checkstyle using ktlint and your tests in Travis-CI environments.
My recommendation for this exercise is:
- Fork this repository.
- Execute the repository playground and make yourself familiar with the code.
TodoApiClientShouldand watch the only test it contains pass.
To help you get started, these are some tests already written at
TodoApiClientShouldclass. Review it carefully before to start writing your own tests. Here you have the description of some tests you can write to start working on this Kata:
- Test that the
Acceptheaders are sent.
- Test that the list of
Taskinstances obtained invoking the getter method of the property
allTaskscontains the expected values.
- Test that the request is sent to the correct path using the correct HTTP method.
- Test that adding a task the body sent to the server is the correct one.
- Test that the
If you get stuck,
masterbranch contains all the tests already solved.
You will find some utilities to help you test the APIClient easily in:
TodoApiMockEngineand the common/responses directory in commonTest source set.
If you've covered all the application functionality using integration tests you can continue with some extra tasks:
- Create your own API client to consume one of the services described in this web: http://jsonplaceholder.typicode.com/
There are some links which can be useful to finish these tasks:
- KtorMockClient official documentation
- Kotlin Test documentation
- Ktor documentation
- How to create a REST API client and its integration tests in Kotlin Multiplatform (English version)
- Cómo crear un cliente API REST y sus tests de integración en Kotlin Multiplatform (Spanish version)
Copyright 2019 Jorge Sánchez Fernández
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
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.