Api integration testing flutter Kata. The main goal is to practice api integration testing using MockWebServer
This kata is a Flutter version of the kata KataTODOApiClientKotlin of Karumi.
- We are here to practice integration testing using flutter HTTP stubbing.
- We are going to use MockWebserver package to return stub responses.
- We are going to use test package to write tests and to perform assertions.
- We are going to practice pair programming.
This repository contains 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 package named http. Review the project documentation if needed.
Your task as a Flutter 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:
-
Before starting
- Fork this repository.
- Checkout
api-integration-testing-flutter-kata
branch. - Execute the repository playground and make yourself familiar with the code.
- Execute
todo_api_client_test
file and watch the only test it contains pass.
-
To help you get started, these are some tests already written at
todo_api_client_test
file. 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
Accept
headers are sent. - Test that the list of
Task
instances obtained invoking the getter method of the propertyallTasks
contains 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,
master
branch contains all the tests already solved. -
You will find some utilities to help you test the APIClient easily in:
MockApi
and the test/api/responses directory.
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:
- Flutter Test documentation
- HTTP documentation
- How to create a REST API client and its integration tests in Flutter
Copyright 2020 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
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.