1
0
mirror of https://github.com/actix/actix-website synced 2024-11-28 02:22:57 +01:00
actix-website/content/docs/testing.md
2019-06-24 17:43:31 -04:00

53 lines
2.0 KiB
Markdown

---
title: Testing
menu: docs_advanced
weight: 210
---
# Testing
Every application should be well tested. Actix-web provides tools to perform unit and
integration tests.
# Unit Tests
For unit testing, actix-web provides a request builder type and a simple handler runner.
[*TestRequest*](https://docs.rs/actix-web/1.0.2/actix_web/test/struct.TestRequest.html)
implements a builder-like pattern.
You can generate a `HttpRequest` instance with `to_http_request()`, or you can
run your handler with `block_on()`.
{{< include-example example="testing" file="main.rs" section="unit-tests" >}}
# Integration tests
There a few methods for testing your application. Actix-web can be used
to run the application with specific handlers in a real http server.
`TestRequest::get()`, `TestRequest::post()`, and `TestRequest::client()`
methods can be used to send requests to the test server.
To create a `Service` for testing, use the `test::init_serivce` method which accepts a
regular `App` builder.
> Check the [api documentation](https://docs.rs/actix-web/1.0.2/actix_web/test/index.html)
> for more information.
{{< include-example example="testing" file="integration_one.rs" section="integration-one" >}}
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.
{{< include-example example="testing" file="integration_two.rs" section="integration-two" >}}
# Stream response tests
If you need to test stream it would be enough to convert a
[*ClientResponse*](../../actix-web/actix_web/client/struct.ClientResponse.html) to future
and execute it.
For example of testing
[*Server Sent Events*](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events).
{{< include-example example="testing" file="stream_response.rs" section="stream-response" >}}