Struct poem::test::TestClient

pub struct TestClient<E> { /* private fields */ }

Available on crate feature test only.

A client for testing.

Implementations

impl<E: Endpoint> TestClient<E>

pub fn new<T>(ep: T) -> TestClient<T::Endpoint>where
    T: IntoEndpoint<Endpoint = E>,

Create a new client for the specified endpoint.

pub fn default_header<K, V>(self, key: K, value: V) -> Selfwhere
    K: TryInto<HeaderName>,
    V: TryInto<HeaderValue>,

Sets the default header for each requests.

Examples

use poem::{handler, http::HeaderMap, test::TestClient, Route};

#[handler]
fn index(headers: &HeaderMap) -> String {
    headers
        .get("X-Custom-Header")
        .and_then(|value| value.to_str().ok())
        .unwrap_or_default()
        .to_string()
}

let app = Route::new().at("/", index);
let cli = TestClient::new(app).default_header("X-Custom-Header", "test");

let resp = cli.get("/").send().await;
resp.assert_status_is_ok();
resp.assert_text("test").await;

pub fn default_content_type(self, content_type: impl AsRef<str>) -> Self

Sets the default content type for each requests.

pub fn request(
    &self,
    method: Method,
    uri: impl Into<String>
) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder.

pub fn get(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with GET method.

pub fn post(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with POST method.

pub fn put(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with PUT method.

pub fn delete(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with DELETE method.

pub fn head(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with HEAD method.

pub fn options(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with OPTIONS method.

pub fn connect(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with CONNECT method.

pub fn patch(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with PATCH method.

pub fn trace(&self, uri: impl Into<String>) -> TestRequestBuilder<'_, E>

Create a TestRequestBuilder with TRACE method.