Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viniciusgerevini/http-test-server
Programatically create resources and pre-defined responses for tests
https://github.com/viniciusgerevini/http-test-server
http mock test
Last synced: 4 days ago
JSON representation
Programatically create resources and pre-defined responses for tests
- Host: GitHub
- URL: https://github.com/viniciusgerevini/http-test-server
- Owner: viniciusgerevini
- License: apache-2.0
- Created: 2018-10-06T14:07:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-27T01:27:45.000Z (over 1 year ago)
- Last Synced: 2024-10-08T08:52:36.172Z (about 1 month ago)
- Topics: http, mock, test
- Language: Rust
- Homepage:
- Size: 71.3 KB
- Stars: 10
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# HTTP Test Server
[](https://docs.rs/http-test-server/) [](https://github.com/viniciusgerevini/http-test-server/actions/workflows/rust.yml)
Programatically create end-points that listen for connections and return pre-defined responses.
- Allows multiple endpoints and simultaneous client connections
- Streaming support
- Helper functions to retrieve data such as request count, number of connected clients and
requests metadata
- Automatically allocates free port and close server after use
# Examples:
Accept POST requests:
```rust
extern crate http_test_server;
use http_test_server::{TestServer, Resource};
use http_test_server::http::{Status, Method};
let server = TestServer::new().unwrap();
let resource = server.create_resource("/some-endpoint/new");
resource
.status(Status::Created)
.method(Method::POST)
.header("Content-Type", "application/json")
.header("Cache-Control", "no-cache")
.body("{ \"message\": \"this is a message\" }");
// request: POST /some-endpoint/new
// HTTP/1.1 201 Created\r\n
// Content-Type: application/json\r\n
// Cache-Control: no-cache\r\n
// \r\n
// { "message": "this is a message" }
```
Use path and query parameters
```rust
extern crate http_test_server;
use http_test_server::{TestServer, Resource};
use http_test_server::http::{Status, Method};
let server = TestServer::new().unwrap();
let resource = server.create_resource("/user/{userId}?filter=*");
resource
.status(Status::OK)
.header("Content-Type", "application/json")
.header("Cache-Control", "no-cache")
.body(r#"{ "id": "{path.userId}", "filter": "{query.filter}" }"#);
// request: GET /user/abc123?filter=all
// HTTP/1.1 200 Ok\r\n
// Content-Type: application/json\r\n
// Cache-Control: no-cache\r\n
// \r\n
// { "id": "abc123", "filter": "all" }
```
Expose a persistent stream:
```rust
let server = TestServer::new().unwrap();
let resource = server.create_resource("/sub");
resource
.header("Content-Type", "text/event-stream")
.header("Cache-Control", "no-cache")
.stream()
.body(": initial data");
// ...
resource
.send("some data")
.send(" some extra data\n")
.send_line("some extra data with line break")
.close_open_connections();
// request: GET /sub
// HTTP/1.1 200 Ok\r\n
// Content-Type: text/event-stream\r\n
// Cache-Control: no-cache\r\n
// \r\n
// : initial data
// some data some extra data\n
// some extra data with line break\n
```
Redirects:
```rust
let server = TestServer::new().unwrap();
let resource_redirect = server.create_resource("/original");
let resource_target = server.create_resource("/new");
resource_redirect
.status(Status::SeeOther)
.header("Location", "/new" );
resource_target.body("Hi!");
// request: GET /original
// HTTP/1.1 303 See Other\r\n
// Location: /new\r\n
// \r\n
```
Regex URI:
```rust
let server = TestServer::new().unwrap();
let resource = server.create_resource("/hello/[0-9]/[A-z]/.*");
// request: GET /hello/8/b/doesntmatter-hehe
// HTTP/1.1 200 Ok\r\n
// \r\n
```
Check [/tests/integration_test.rs](tests/integration_test.rs) for more usage examples.
---
*NOTE*: This is not intended to work as a full featured server. For this reason, many validations
and behaviours are not implemented. e.g: A request with `Accept` header with not supported
`Content-Type` won't trigger a `406 Not Acceptable`.
As this crate was devised to be used in tests, smart behaviours could be confusing and misleading. Having said that, for the sake of convenience, some default behaviours were implemented:
- Server returns `404 Not Found` when requested resource was not configured.
- Server returns `405 Method Not Allowed` when trying to reach resource with different method from those configured.
- When a resource is created it responds to `GET` with `200 Ok` by default.
---
## License
Licensed under either of
* Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE))
* MIT license
([LICENSE-MIT](LICENSE-MIT))
at your option.
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.