Xcribe v0.7.9 Xcribe.Document View Source

Exposes document/2 macro to be used in test specs.

Link to this section Summary

Functions

Document a request by a given Plug.Conn.

Link to this section Functions

Link to this macro

document(conn, opts \\ [])

View Source (macro)

Document a request by a given Plug.Conn.

Each connection sent to documenting in your tests is parsed. Is expected that connection has been passed through the app Endpoint as a finished request. The parser will extract all needed info from Conn and uses app Router for additional information about the request.

The attribute description may be given at document macro call with the option :as:

test "test name", %{conn: conn} do
  ...

  document(conn, as: "description here")

  ...
end

If no description is given the current test description will be used.