2018-05-22 23:15:08 +02:00
---
title: Testing
---
2022-07-16 11:59:20 +02:00
import CodeBlock from "@site/src/components/code_block .js";
2018-05-22 23:15:08 +02:00
# Testing
2022-04-07 15:44:10 +01:00
Every application should be well tested. Actix Web provides tools to perform unit and integration tests.
2018-05-22 23:15:08 +02:00
2022-07-16 11:59:20 +02:00
## Unit Tests
2018-05-22 23:15:08 +02:00
2022-02-26 04:41:49 +00:00
For unit testing, actix-web provides a request builder type. [_TestRequest_][testrequest] implements a builder-like pattern. You can generate a `HttpRequest` instance with `to_http_request()` and call your handler with it.
2019-06-17 15:39:58 -04:00
2022-07-16 11:59:20 +02:00
< CodeBlock example = "testing" file = "main.rs" section = "unit-tests" / >
2018-05-22 23:15:08 +02:00
2022-07-16 11:59:20 +02:00
## Integration tests
2018-05-22 23:15:08 +02:00
2022-04-07 15:44:10 +01:00
There are a few methods for testing your application. Actix Web can be used to run the application with specific handlers in a real HTTP server.
2018-05-22 23:15:08 +02:00
2022-02-26 04:41:49 +00:00
`TestRequest::get()` , `TestRequest::post()` and other methods can be used to send requests to the test server.
2018-05-22 23:15:08 +02:00
2022-02-26 04:41:49 +00:00
To create a `Service` for testing, use the `test::init_service` method which accepts a regular `App` builder.
2018-05-22 23:15:08 +02:00
2020-09-12 16:21:54 +01:00
> Check the [API documentation][actixdocs] for more information.
2018-05-22 23:15:08 +02:00
2022-07-16 11:59:20 +02:00
< CodeBlock example = "testing" file = "integration_one.rs" section = "integration-one" / >
2018-05-22 23:15:08 +02:00
2022-02-26 04:41:49 +00:00
If you need more complex application configuration, testing should be very similar to creating the normal application. For example, you may need to initialize application state. Create an `App` with a `data` method and attach state just like you would from a normal application.
2018-05-22 23:15:08 +02:00
2022-07-16 11:59:20 +02:00
< CodeBlock example = "testing" file = "integration_two.rs" section = "integration-two" / >
2018-05-22 23:15:08 +02:00
2022-07-16 11:59:20 +02:00
## Stream response tests
2018-05-23 23:35:42 +03:00
2022-02-26 04:41:49 +00:00
If you need to test stream generation, it would be enough to call `take_body()` and convert a resulting [_ResponseBody_][responsebody] into a future and execute it, for example when testing [_Server Sent Events_][serversentevents].
2018-05-23 23:35:42 +03:00
2022-07-16 11:59:20 +02:00
< CodeBlock example = "testing" file = "stream_response.rs" section = "stream-response" / >
2019-06-24 23:36:32 -04:00
[serversentevents]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
2022-03-05 23:55:35 +00:00
[responsebody]: https://docs.rs/actix-web/4/actix_web/body/enum.ResponseBody.html
[actixdocs]: https://docs.rs/actix-web/4/actix_web/test/index.html
[testrequest]: https://docs.rs/actix-web/4/actix_web/test/struct.TestRequest.html