mirror of
https://github.com/actix/actix-website
synced 2024-11-27 10:02:57 +01:00
2aacdf2f70
* chore: add VS Code extension recommendations * Update image URLs in README and documentation files * chore: disable no-inline-html rule * chore: use standard md/mdx syntax, and use .jsx for react components * chore: fix email links in Code of Conduct The commit message suggests fixing the email links in the Code of Conduct file to use the correct `mailto:` syntax. * chore: update actix-web error helper links Update the links to the `actix-web` error helper traits in the `databases.md` and `errors.md` files to use the correct URLs. * chore: restore unused actix-web error helper links * Update src/pages/community/coc.md Co-authored-by: Rob Ede <robjtede@icloud.com> * Update docs/getting-started.md Co-authored-by: Rob Ede <robjtede@icloud.com> --------- Co-authored-by: Rob Ede <robjtede@icloud.com>
45 lines
2.5 KiB
Markdown
45 lines
2.5 KiB
Markdown
---
|
|
title: Testing
|
|
---
|
|
|
|
import CodeBlock from "@site/src/components/code_block";
|
|
|
|
# Testing
|
|
|
|
Every application should be well tested. Actix Web provides tools to perform integration tests against your applications and unit test tools for custom extractors and middleware.
|
|
|
|
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 handlers or extractors with it. Also see
|
|
|
|
## Integration Testing For Applications
|
|
|
|
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.
|
|
|
|
`TestRequest::get()`, `TestRequest::post()` and other methods can be used to send requests to the test server.
|
|
|
|
To create a `Service` for testing, use the `test::init_service` method which accepts a regular `App` builder.
|
|
|
|
> Check the [API documentation][actixdocs] for more information.
|
|
|
|
<CodeBlock 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.
|
|
|
|
<CodeBlock example="testing" file="integration_two.rs" section="integration-two" />
|
|
|
|
## Stream Response Testing
|
|
|
|
If you need to test stream generation, it would be enough to call [`into_parts()`][resintoparts] and convert the resulting body into a future and execute it, for example when testing [_Server Sent Events_][serversentevents].
|
|
|
|
<CodeBlock example="testing" file="stream_response.rs" section="stream-response" />
|
|
|
|
## Unit Testing Extractors
|
|
|
|
Unit testing has pretty limited value for applications, but can be useful when developing extractors, middleware, and responders. Given that, calling directly into handler functions **which are defined stand-alone, without using routing macros** (like `#[get("/")]`) is possible if you want to make assertions on custom `Responder`s.
|
|
|
|
<CodeBlock example="testing" file="main.rs" section="unit-tests" />
|
|
|
|
[serversentevents]: https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events
|
|
[resintoparts]: https://docs.rs/actix-web/4/actix_web/struct.HttpResponse.html#method.into_parts
|
|
[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
|