https://github.com/carpodaster/rodeo

Test your API consuming Elixir app against a real (one-off) webserver
https://github.com/carpodaster/rodeo

api cowboy elixir http testing

Last synced: about 3 hours ago
JSON representation

Test your API consuming Elixir app against a real (one-off) webserver

• Host: GitHub
• URL: https://github.com/carpodaster/rodeo
• Owner: carpodaster
• License: bsd-3-clause
• Created: 2017-04-22T09:18:44.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-26T05:51:18.000Z (over 7 years ago)
• Last Synced: 2024-09-21T12:43:26.436Z (4 days ago)
• Topics: api, cowboy, elixir, http, testing
• Language: Elixir
• Homepage: https://hex.pm/packages/rodeo
• Size: 33.2 KB
• Stars: 15
• Watchers: 3
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Rodeo [![Build Status](https://travis-ci.org/carpodaster/rodeo.svg?branch=master)](https://travis-ci.org/carpodaster/rodeo) [![Inline docs](http://inch-ci.org/github/carpodaster/rodeo.svg)](http://inch-ci.org/github/carpodaster/rodeo)

When testing HTTP calls made by your Mix application, your options are to either fire them to the real HTTP endpoint (requires net availability and may count against an API's rate limit) or use a mock (be it is a [noun or a verb](http://blog.plataformatec.com.br/2015/10/mocks-and-explicit-contracts/)).

Or you could fire real HTTP requests to a real _in promptu_ webserver instead. Rodeo spawns one-off [cowboy](https://hex.pm/packages/cowboy) webserver instances that reply based on a simple handler API.

(Cowboy… Rodeo… get it?)

## Installation

1. Add `rodeo` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [{:rodeo, "~> 0.3.0"}]

end

```

2. Ensure `rodeo` is started before your application. Also, you need to add `cowboy`:

```elixir

def application do

  [applications: [:cowboy, :rodeo]]

end

```

## Usage

Rodeo provides `with_webserver` that can be used in a test case:

```elixir

defmodule MyApp.APIClientTest do

  use ExUnit.Case

  use Rodeo.HTTPCase

  test "will start a new cowboy server on a free tcp port" do

    with_webserver fn rodeo ->

      # rodeo is a %Rodeo{} struct, holding the port of the web server

      assert HTTPoison.get!("http://127.0.0.1:#{rodeo.port}/") == "Hello World"

    end

    # The webserver is torn down again at this point

  end

  test "uses a custom request handler" do

    defmodule Teapot do

      use Rodeo.Handler

      def body(_req),   do: "I'm a teapot"

      def status(_req), do: 418

    end

    with_webserver Teapot, fn rodeo ->

      # Rodeo.base_url is a convenience function to

      # glue scheme, ip and port together

      assert HTTPoison.get!(Rodeo.base_url(rodeo) <> "/earl-grey") == "I'm a teapot"

    end

  end

end

```

## Writing your own handlers

Rodeo provides `Rodeo.Handler` that can be used as a template for custom handlers (see [module documentation](https://hexdocs.pm/rodeo/Rodeo.Handler.html)).

```elixir

defmodule MyApp.InternalServerError do

  use Rodeo.Handler

  def status(_),  do: 500

  def body(_),    do: "Oooops!"

  def headers(_), do: [{"X-Reason", "Server rolled a 1"}]

end

```