@spec conn(String.Chars.t(), binary(), params()) :: Plug.Conn.t()

Creates a test connection.

The request method and path are required arguments. method may be any value that implements to_string/1 and it will be properly converted and normalized (e.g., :get or "post").

The path is commonly the request path with optional query string but it may also be a complete URI. When a URI is given, the host and schema will be used as part of the request too.

The params_or_body field must be one of:

• nil - meaning there is no body;
• a binary - containing a request body. For such cases, :headers must be given as option with a content-type;
• a map or list - containing the parameters which will automatically set the content-type to multipart. The map or list may contain other lists or maps and all entries will be normalized to string keys;

examples

Examples

conn(:get, "/foo?bar=10")
conn(:get, "/foo", %{bar: 10})
conn(:post, "/")
conn("patch", "/", "") |> put_req_header("content-type", "application/json")

@spec delete_req_cookie(Plug.Conn.t(), binary()) :: Plug.Conn.t()

Deletes a request cookie.

@spec init_test_session(Plug.Conn.t(), %{optional(String.t() | atom()) => any()}) ::
  Plug.Conn.t()

Initializes the session with the given contents.

If the session has already been initialized, the new contents will be merged with the previous ones.

Puts the HTTP protocol.

Puts the peer data.

@spec put_req_cookie(Plug.Conn.t(), binary(), binary()) :: Plug.Conn.t()

Puts a request cookie.

@spec recycle_cookies(Plug.Conn.t(), Plug.Conn.t()) :: Plug.Conn.t()

Moves cookies from a connection into a new connection for subsequent requests.

This function copies the cookie information in old_conn into new_conn, emulating multiple requests done by clients where cookies are always passed forward, and returns the new version of new_conn.

Returns the informational requests that have been sent.

This function depends on gathering the messages sent by the test adapter when informational messages, such as an early hint, are sent. Calling this function will clear the informational request messages from the inbox for the process. To assert on multiple informs, the result of the function should be stored in a variable.

examples

Examples

conn = conn(:get, "/foo", "bar=10")
informs = Plug.Test.sent_informs(conn)
assert {"/static/application.css", [{"accept", "text/css"}]} in informs
assert {"/static/application.js", [{"accept", "application/javascript"}]} in informs

Returns the assets that have been pushed.

This function depends on gathering the messages sent by the test adapter when assets are pushed. Calling this function will clear the pushed message from the inbox for the process. To assert on multiple pushes, the result of the function should be stored in a variable.

examples

Examples

conn = conn(:get, "/foo?bar=10")
pushes = Plug.Test.sent_pushes(conn)
assert {"/static/application.css", [{"accept", "text/css"}]} in pushes
assert {"/static/application.js", [{"accept", "application/javascript"}]} in pushes

Returns the sent response.

This function is useful when the code being invoked crashes and there is a need to verify a particular response was sent, even with the crash. It returns a tuple with {status, headers, body}.

Returns the upgrade requests that have been sent.

This function depends on gathering the messages sent by the test adapter when upgrade requests are sent. Calling this function will clear the upgrade request messages from the inbox for the process.

examples

Examples

conn = conn(:get, "/foo", "bar=10")
upgrades = Plug.Test.send_upgrades(conn)
assert {:websocket, [opt: :value]} in upgrades