rpt / cowboy_gen

Helpers for generating fake Cowboy request

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

cowboy_gen 0.2.4 Build Status

Helpers for testing handlers by generating fake but valid Cowboy requests.

Works with Cowboy versions: 0.10.0, 0.9.0, 0.8.0-0.8.6.

Usage

Creating request

-type version_error() :: no_cowboy_app_in_path |
                         unsupported_cowboy_version.
-spec cowboy_gen:req(Parameters :: proplists:proplist()) ->
          {ok, Request :: cowboy_req:req()} |
          {error, Reason :: version_error()}.

Following parameters can be specified when creating a fake Cowboy request:

  • {method, Method :: binary()}
  • {headers, Headers :: proplists:proplist()}
  • {qs_vals, QueryStringValues :: proplists:proplist()}
  • {body, RequestBody :: binary()}
  • {peer, {Address :: inet:ip_address(), Port :: inet:port_number()}}

Calling handler

-type response() :: {Code :: integer(),
                     Headers :: proplists:proplist(),
                     Body :: binary()}.
-spec cowboy_gen:call(Request :: cowboy_req:req(), HandlerModule :: module()) ->
          {ok, Response :: response()} | {error, timeout}.

About

Helpers for generating fake Cowboy request


Languages

Language:Erlang 89.2%Language:Makefile 6.1%Language:Shell 4.7%