XCribe v0.3.0 Xcribe.ConnParser View Source

Used to convert a Plug.Conn to a Xcribe.Request.

Each connection sent to documenting in your tests is given to ConnParser. 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 atribute description must be given at document macro call with the option :as:

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

  Xcribe.Helpers.Document.document(conn, as: "description here")

  ...
end

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

Link to this section Summary

Functions

Parse the given Plug.Conn and transform it to a Xcribe.Request. A description can be provided.

Link to this section Functions

Link to this function

execute(conn, description \\ "")

View Source

Parse the given Plug.Conn and transform it to a Xcribe.Request. A description can be provided.