Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Driftrock/mockingbird
A set of helpers to create http-aware modules that are easy to test.
https://github.com/Driftrock/mockingbird
Last synced: about 1 month ago
JSON representation
A set of helpers to create http-aware modules that are easy to test.
- Host: GitHub
- URL: https://github.com/Driftrock/mockingbird
- Owner: Driftrock
- License: apache-2.0
- Created: 2017-04-10T13:08:36.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-05-03T13:05:16.000Z (over 6 years ago)
- Last Synced: 2024-07-05T23:10:34.737Z (5 months ago)
- Language: Elixir
- Size: 36.1 KB
- Stars: 3
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - A set of helpers to test code that involves http requests. (Testing)
- fucking-awesome-elixir - mockingbird - A set of helpers to test code that involves http requests. (Testing)
- awesome-elixir - mockingbird - A set of helpers to test code that involves http requests. (Testing)
README
# Mockingbird
[](https://travis-ci.org/Driftrock/mockingbird)
[](http://inch-ci.org/github/Driftrock/mockingbird)
Mockingbird helps you create API consumers that are easy to test.
## Why use Mockingbird?
At Driftrock we have lots of small applications that communicate with other external services, these could be other Driftrock APIs or third-parties APIs. When we're working on an application we don't want to have to run and rely on all possible external services to validate changes as this dramatically slows down the development process. Instead we would much rather change, test and deploy each application independently, safe in the knowledge that integrates nicely with other services.
The prevalent solution in the Elixir community for this type of testing is to [switch external client modules for fake implementations depending on the environment](http://blog.plataformatec.com.br/2015/10/mocks-and-explicit-contracts/). This solution is simple and works nicely, however we found that our tests were not exercising enough of the production external client to provide us with the safety we needed when making changes. It's too easy to fall into the trap of only making changes to the test client and not replicating those in the production client. So we decided to drop one level deeper and switch our HTTP Client (typically `HTTPPoison`) for a fake implementation when testing. Mockingbird is our solution for that.
## Installation
Add `mockingbird` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
# ...
{:mockingbird, "~> 0.2.0"},
# ...
]
end
```
## Usage
```elixir
# lib/my_app/github.ex
defmodule MyApp.Github do
use Mockingbird, test: MyApp.MockGithubHttpClient
def get_account_info(username) do
http_client().call(:get, "https://api.github.com/users/" <> username)
end
end
# test/support/mock_github_http_client.ex
defmodule MyApp.MockGithubHttpClient do
import Mockingbird.Client
# Define `call` methods for each `call` head (ie. verb, url, params) you
# want to mock for tests
# `respond` helper method returns struct mimicking HTTPoison.Response
def call(:get, "https://api.github.com/users/amencarini") do
respond :ok, 200, """
{
"login": "amencarini",
"id": 1100003
}
"""
end
end
# test/my_app/git_test.exs
defmodule MyApp.GithubTest do
use ExUnit.Case
describe "MyApp.Github.get_account_info/1" do
test "it returns data for the selected user" do
{:ok, res} = MyApp.Github.get_account_info("amencarini")
assert Poison.decode(res.body) == %{"login" => "amencarini", "id" => 1100003}
end
end
end
```
### Fallback on live client
Sometimes you might want to fallback on the live client inside tests (e.g.: you have some
tests running against the live API you're consuming.) To do so, wrap your test
in a `with_client(environment)` call:
```elixir
# test/my_app/github_test.exs
defmodule MyApp.GithubTest do
use ExUnit.Case
describe "MyApp.Github.get_account_info/1" do
test "checks the real API hasn't changed" do
require MyApp.Github # Needed to get the `with_client` macro available
MyApp.Github.with_client(:prod) do
{:ok, res} = MyApp.Github.get_account_info("amencarini")
assert Poison.decode(res.body) == %{"login" => "amencarini", "id" => 1100003}
end
end
end
end
```
## Configuration
Mockingbird uses HTTPoison as default for HTTP calls when key for current
environment is not set in `use`. You can create or customise your default client. You can either specify this globally at config level:
```elixir
# config/config.exs
config :mockingbird,
default_client: MyApp.RealHttpClient
```
Or on a consumer basis for specific environments:
```elixir
# lib/my_app/github.ex
defmodule MyApp.Github do
use Mockingbird,
test: MyApp.MockGithubHttpClient
prod: MyApp.RealHttpClient
def get_account_info(username) do
http_client().call(:get, "https://api.github.com/users/" <> username)
end
end
```
Your live client just needs to implement a `call` function that pattern matches
on http verb, url, params and headers.
```elixir
# lib/my_app/real_http_client.ex
defmodule MyApp.RealHttpClient do
def call(verb, url, params, headers) do
# Do your magic here
end
end
```
In fact client interface is the same for live and test clients. It is only
convenient to have default client for live and on the other hand have few helpers
in test clients.
### Clients per environment
You might want to set different clients per different environments. To do so you
can setup your consumer with a list of clients to use. Keys matches with current
`Mix.env`.
```elixir
# lib/my_app/github.ex
defmodule MyApp.Github do
use Mockingbird,
test: MyApp.MockGithubHttpClient,
staging: MyApp.StagingHttpClient
def get_account_info(username) do
http_client().call(:get, "https://api.github.com/users/" <> username)
end
end
```
You can achieve the same by pointing to a `Mix.config` item. If no configuration
is found Mockingbird will fallback on the live client.
```elixir
# config/test.exs
config :my_app,
github_http_client: MyApp.MockGithubHttpClient
# lib/my_app/github.ex
defmodule MyApp.Github do
use Mockingbird, client: Application.get_env(:my_app, :github_http_client)
def get_account_info(username) do
# This will use `MyApp.GitMockHttpClient` on test, and the real http client
# in all other environments.
http_client().call(:get, "https://api.github.com/users/" <> username)
end
end
```