Struct actix_web::test::TestRequest

pub struct TestRequest { /* private fields */ }

Test Request builder.

For unit testing, actix provides a request builder type and a simple handler runner. TestRequest implements a builder-like pattern. You can generate various types of request via TestRequest’s methods:

• TestRequest::to_request creates actix_http::Request instance.
• TestRequest::to_srv_request creates ServiceRequest instance, which is used for testing middlewares and chain adapters.
• TestRequest::to_srv_response creates ServiceResponse instance.
• TestRequest::to_http_request creates HttpRequest instance, which is used for testing handlers.

use actix_web::{test, HttpRequest, HttpResponse, HttpMessage};
use actix_web::http::{header, StatusCode};

async fn index(req: HttpRequest) -> HttpResponse {
    if let Some(hdr) = req.headers().get(header::CONTENT_TYPE) {
        HttpResponse::Ok().into()
    } else {
        HttpResponse::BadRequest().into()
    }
}

#[actix_web::test]
async fn test_index() {
    let req = test::TestRequest::default().insert_header("content-type", "text/plain")
        .to_http_request();

    let resp = index(req).await.unwrap();
    assert_eq!(resp.status(), StatusCode::OK);

    let req = test::TestRequest::default().to_http_request();
    let resp = index(req).await.unwrap();
    assert_eq!(resp.status(), StatusCode::BAD_REQUEST);
}

Implementations

impl TestRequest

pub fn with_uri(path: &str) -> TestRequest

Create TestRequest and set request uri

pub fn get() -> TestRequest

Create TestRequest and set method to Method::GET

pub fn post() -> TestRequest

Create TestRequest and set method to Method::POST

pub fn put() -> TestRequest

Create TestRequest and set method to Method::PUT

pub fn patch() -> TestRequest

Create TestRequest and set method to Method::PATCH

pub fn delete() -> TestRequest

Create TestRequest and set method to Method::DELETE

pub fn version(self, ver: Version) -> Self

Set HTTP version of this request

pub fn method(self, meth: Method) -> Self

Set HTTP method of this request

pub fn uri(self, path: &str) -> Self

Set HTTP Uri of this request

pub fn insert_header(self, header: impl TryIntoHeaderPair) -> Self

Insert a header, replacing any that were set with an equivalent field name.

pub fn append_header(self, header: impl TryIntoHeaderPair) -> Self

Append a header, keeping any that were set with an equivalent field name.

pub fn param(
    self,
    name: impl Into<Cow<'static, str>>,
    value: impl Into<Cow<'static, str>>
) -> Self

Set request path pattern parameter.

Examples

use actix_web::test::TestRequest;

let req = TestRequest::default().param("foo", "bar");
let req = TestRequest::default().param("foo".to_owned(), "bar".to_owned());

pub fn peer_addr(self, addr: SocketAddr) -> Self

Set peer addr.

pub fn set_payload<B: Into<Bytes>>(self, data: B) -> Self

Set request payload.

pub fn set_form<T: Serialize>(self, data: &T) -> Self

Serialize data to a URL encoded form and set it as the request payload. The Content-Type header is set to application/x-www-form-urlencoded.

pub fn set_json<T: Serialize>(self, data: &T) -> Self

Serialize data to JSON and set it as the request payload. The Content-Type header is set to application/json.

pub fn data<T: 'static>(self, data: T) -> Self

Set application data. This is equivalent of App::data() method for testing purpose.

pub fn app_data<T: 'static>(self, data: T) -> Self

Set application data. This is equivalent of App::app_data() method for testing purpose.

pub fn to_request(self) -> Request

Complete request creation and generate Request instance

pub fn to_srv_request(self) -> ServiceRequest

Complete request creation and generate ServiceRequest instance

pub fn to_srv_response<B>(self, res: HttpResponse<B>) -> ServiceResponse<B>

Complete request creation and generate ServiceResponse instance

pub fn to_http_request(self) -> HttpRequest

Complete request creation and generate HttpRequest instance

pub fn to_http_parts(self) -> (HttpRequest, Payload)

Complete request creation and generate HttpRequest and Payload instances

pub async fn send_request<S, B, E>(self, app: &S) -> S::Response where
    S: Service<Request, Response = ServiceResponse<B>, Error = E>,
    E: Debug, 

Complete request creation, calls service and waits for response future completion.

Trait Implementations

impl Default for TestRequest

fn default() -> TestRequest

Returns the “default value” for a type.