Struct actix_web::test::TestRequest

pub struct TestRequest { /* fields omitted */ }

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_service creates ServiceRequest instance, which is used for testing middlewares and chain adapters.
• TestRequest::to_from creates ServiceFromRequest instance, which is used for testing extractors.
• 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};

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

fn main() {
    let req = test::TestRequest::with_header("content-type", "text/plain")
        .to_http_request();

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

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

Methods

impl TestRequest

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

Create TestRequest and set request uri

pub fn with_hdr<H: Header>(hdr: H) -> TestRequest

Create TestRequest and set header

pub fn with_header<K, V>(key: K, value: V) -> TestRequest where
    HeaderName: HttpTryFrom<K>,
    V: IntoHeaderValue, 

Create TestRequest and set header

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 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 set<H: Header>(self, hdr: H) -> Self

Set a header

pub fn header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: HttpTryFrom<K>,
    V: IntoHeaderValue, 

Set a header

pub fn cookie(self, cookie: Cookie) -> Self

Set cookie for this request

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

Set request payload

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

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

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

Set route data. This is equivalent of Route::data() method for testing purpose.

pub fn to_srv_request(self) -> ServiceRequest<PayloadStream>

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_request(self) -> Request<PayloadStream>

Complete request creation and generate Request instance

pub fn to_http_request(self) -> HttpRequest

Complete request creation and generate HttpRequest instance

pub fn to_from(self) -> ServiceFromRequest<PayloadStream>

Complete request creation and generate ServiceFromRequest instance

pub fn block_on<F>(f: F) -> Result<F::Item, F::Error> where
    F: Future, 

Runs the provided future, blocking the current thread until the future completes.

This function can be used to synchronously block the current thread until the provided future has resolved either successfully or with an error. The result of the future is then returned from this function call.

Note that this function is intended to be used only for testing purpose. This function panics on nested call.

Trait Implementations

impl Default for TestRequest

fn default() -> TestRequest

Returns the "default value" for a type.