Struct actix_web::test::TestServer

pub struct TestServer { /* fields omitted */ }

The TestServer type.

TestServer is very simple test server that simplify process of writing integration tests cases for actix web applications.

Examples

use actix_web::test::TestServer;

let mut srv = TestServer::new(|app| app.handler(my_handler));

let req = srv.get().finish().unwrap();
let response = srv.execute(req.send()).unwrap();
assert!(response.status().is_success());

Methods

impl TestServer

pub fn new<F>(config: F) -> Self where
    F: Clone + Send + 'static + Fn(&mut TestApp<()>), 

Start new test server

This method accepts configuration method. You can add middlewares or set handlers for test application.

pub fn build() -> TestServerBuilder<(), impl Fn() + Clone + Send + 'static>

Create test server builder

pub fn build_with_state<S, F>(state: F) -> TestServerBuilder<S, F> where
    F: Fn() -> S + Clone + Send + 'static,
    S: 'static, 

Create test server builder with specific state factory

This method can be used for constructing application state. Also it can be used for external dependency initialization, like creating sync actors for diesel integration.

pub fn with_factory<F, H>(factory: F) -> Self where
    F: Fn() -> H + Send + Clone + 'static,
    H: IntoHttpHandler + 'static, 

Start new test server with application factory

pub fn unused_addr() -> SocketAddr

Get firat available unused address

pub fn addr(&self) -> SocketAddr

Construct test server url

pub fn url(&self, uri: &str) -> String

Construct test server url

pub fn execute<F, I, E>(&mut self, fut: F) -> Result<I, E> where
    F: Future<Item = I, Error = E>, 

Execute future on current core

pub fn ws_at(
    &mut self,
    path: &str
) -> Result<(ClientReader, ClientWriter), ClientError>

Connect to websocket server at a given path

pub fn ws(&mut self) -> Result<(ClientReader, ClientWriter), ClientError>

Connect to a websocket server

pub fn get(&self) -> ClientRequestBuilder

Create GET request

pub fn post(&self) -> ClientRequestBuilder

Create POST request

pub fn patch(&self) -> ClientRequestBuilder

Create PATCH request

pub fn head(&self) -> ClientRequestBuilder

Create HEAD request

pub fn client(&self, meth: Method, path: &str) -> ClientRequestBuilder

Connect to test http server

Trait Implementations

impl Drop for TestServer

fn drop(&mut self)

Executes the destructor for this type.