635 lines
19 KiB
Rust
635 lines
19 KiB
Rust
use crate::tests::{ValidTest, ValidTestParameter};
|
|
use crate::{Valid, VALIDATION_ERROR_STATUS};
|
|
use axum::extract::{Path, Query};
|
|
use axum::routing::{get, post};
|
|
use axum::{Form, Json, Router};
|
|
use hyper::Method;
|
|
use once_cell::sync::Lazy;
|
|
use reqwest::{StatusCode, Url};
|
|
use serde::{Deserialize, Serialize};
|
|
use std::any::type_name;
|
|
use std::net::SocketAddr;
|
|
use std::ops::Deref;
|
|
use validator::Validate;
|
|
|
|
#[derive(Clone, Deserialize, Serialize, Validate, Eq, PartialEq)]
|
|
#[cfg_attr(feature = "extra_protobuf", derive(prost::Message))]
|
|
pub struct Parameters {
|
|
#[validate(range(min = 5, max = 10))]
|
|
#[cfg_attr(feature = "extra_protobuf", prost(int32, tag = "1"))]
|
|
v0: i32,
|
|
#[validate(length(min = 1, max = 10))]
|
|
#[cfg_attr(feature = "extra_protobuf", prost(string, tag = "2"))]
|
|
v1: String,
|
|
}
|
|
|
|
static VALID_PARAMETERS: Lazy<Parameters> = Lazy::new(|| Parameters {
|
|
v0: 5,
|
|
v1: String::from("0123456789"),
|
|
});
|
|
|
|
static INVALID_PARAMETERS: Lazy<Parameters> = Lazy::new(|| Parameters {
|
|
v0: 6,
|
|
v1: String::from("01234567890"),
|
|
});
|
|
|
|
impl ValidTestParameter for Parameters {
|
|
fn valid() -> &'static Self {
|
|
VALID_PARAMETERS.deref()
|
|
}
|
|
|
|
fn error() -> &'static [(&'static str, &'static str)] {
|
|
&[("not_v0_or_v1", "value")]
|
|
}
|
|
|
|
fn invalid() -> &'static Self {
|
|
INVALID_PARAMETERS.deref()
|
|
}
|
|
}
|
|
|
|
#[tokio::test]
|
|
async fn test_main() -> anyhow::Result<()> {
|
|
let router = Router::new()
|
|
.route(route::PATH, get(extract_path))
|
|
.route(route::QUERY, get(extract_query))
|
|
.route(route::FORM, post(extract_form))
|
|
.route(route::JSON, post(extract_json));
|
|
|
|
#[cfg(feature = "typed_header")]
|
|
let router = router.route(
|
|
typed_header::route::TYPED_HEADER,
|
|
post(typed_header::extract_typed_header),
|
|
);
|
|
|
|
#[cfg(feature = "extra")]
|
|
let router = router
|
|
.route(extra::route::CACHED, post(extra::extract_cached))
|
|
.route(
|
|
extra::route::WITH_REJECTION,
|
|
post(extra::extract_with_rejection),
|
|
);
|
|
|
|
#[cfg(feature = "extra_query")]
|
|
let router = router.route(
|
|
extra_query::route::EXTRA_QUERY,
|
|
post(extra_query::extract_extra_query),
|
|
);
|
|
|
|
#[cfg(feature = "extra_form")]
|
|
let router = router.route(
|
|
extra_form::route::EXTRA_FORM,
|
|
post(extra_form::extract_extra_form),
|
|
);
|
|
|
|
#[cfg(feature = "extra_protobuf")]
|
|
let router = router.route(
|
|
extra_protobuf::route::EXTRA_PROTOBUF,
|
|
post(extra_protobuf::extract_extra_protobuf),
|
|
);
|
|
|
|
#[cfg(feature = "yaml")]
|
|
let router = router.route(yaml::route::YAML, post(yaml::extract_yaml));
|
|
|
|
#[cfg(feature = "msgpack")]
|
|
let router = router
|
|
.route(msgpack::route::MSGPACK, post(msgpack::extract_msgpack))
|
|
.route(
|
|
msgpack::route::MSGPACK_RAW,
|
|
post(msgpack::extract_msgpack_raw),
|
|
);
|
|
|
|
let server = axum::Server::bind(&SocketAddr::from(([0u8, 0, 0, 0], 0u16)))
|
|
.serve(router.into_make_service());
|
|
let server_addr = server.local_addr();
|
|
println!("Axum server address: {}.", server_addr);
|
|
|
|
let (server_guard, close) = tokio::sync::oneshot::channel::<()>();
|
|
let server_handle = tokio::spawn(server.with_graceful_shutdown(async move {
|
|
let _ = close.await;
|
|
}));
|
|
|
|
let server_url = format!("http://{}", server_addr);
|
|
let test_executor = TestExecutor::from(Url::parse(&format!("http://{}", server_addr))?);
|
|
|
|
{
|
|
let path_type_name = type_name::<Path<Parameters>>();
|
|
let valid_path_response = test_executor
|
|
.client()
|
|
.get(format!(
|
|
"{}/path/{}/{}",
|
|
server_url, VALID_PARAMETERS.v0, VALID_PARAMETERS.v1
|
|
))
|
|
.send()
|
|
.await?;
|
|
assert_eq!(
|
|
valid_path_response.status(),
|
|
StatusCode::OK,
|
|
"Valid '{}' test failed.",
|
|
path_type_name
|
|
);
|
|
|
|
let error_path_response = test_executor
|
|
.client()
|
|
.get(format!("{}/path/not_i32/path", server_url))
|
|
.send()
|
|
.await?;
|
|
assert_eq!(
|
|
error_path_response.status(),
|
|
StatusCode::BAD_REQUEST,
|
|
"Error '{}' test failed.",
|
|
path_type_name
|
|
);
|
|
|
|
let invalid_path_response = test_executor
|
|
.client()
|
|
.get(format!(
|
|
"{}/path/{}/{}",
|
|
server_url, INVALID_PARAMETERS.v0, INVALID_PARAMETERS.v1
|
|
))
|
|
.send()
|
|
.await?;
|
|
assert_eq!(
|
|
invalid_path_response.status(),
|
|
VALIDATION_ERROR_STATUS,
|
|
"Invalid '{}' test failed.",
|
|
path_type_name
|
|
);
|
|
#[cfg(feature = "into_json")]
|
|
check_json(path_type_name, invalid_path_response).await;
|
|
println!("All {} tests passed.", path_type_name);
|
|
}
|
|
|
|
test_executor
|
|
.execute::<Query<Parameters>>(Method::GET, route::QUERY)
|
|
.await?;
|
|
|
|
test_executor
|
|
.execute::<Form<Parameters>>(Method::POST, route::FORM)
|
|
.await?;
|
|
|
|
test_executor
|
|
.execute::<Json<Parameters>>(Method::POST, route::JSON)
|
|
.await?;
|
|
|
|
#[cfg(feature = "typed_header")]
|
|
{
|
|
use axum::TypedHeader;
|
|
test_executor
|
|
.execute::<TypedHeader<Parameters>>(Method::POST, typed_header::route::TYPED_HEADER)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "extra")]
|
|
{
|
|
use axum_extra::extract::{Cached, WithRejection};
|
|
use extra::TestRejection;
|
|
test_executor
|
|
.execute::<Cached<Parameters>>(Method::POST, extra::route::CACHED)
|
|
.await?;
|
|
test_executor
|
|
.execute::<WithRejection<Parameters, TestRejection>>(
|
|
Method::POST,
|
|
extra::route::WITH_REJECTION,
|
|
)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "extra_query")]
|
|
{
|
|
use axum_extra::extract::Query;
|
|
test_executor
|
|
.execute::<Query<Parameters>>(Method::POST, extra_query::route::EXTRA_QUERY)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "extra_form")]
|
|
{
|
|
use axum_extra::extract::Form;
|
|
test_executor
|
|
.execute::<Form<Parameters>>(Method::POST, extra_form::route::EXTRA_FORM)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "extra_protobuf")]
|
|
{
|
|
use axum_extra::protobuf::Protobuf;
|
|
test_executor
|
|
.execute::<Protobuf<Parameters>>(Method::POST, extra_protobuf::route::EXTRA_PROTOBUF)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "yaml")]
|
|
{
|
|
use axum_yaml::Yaml;
|
|
test_executor
|
|
.execute::<Yaml<Parameters>>(Method::POST, yaml::route::YAML)
|
|
.await?;
|
|
}
|
|
|
|
#[cfg(feature = "msgpack")]
|
|
{
|
|
use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
test_executor
|
|
.execute::<MsgPack<Parameters>>(Method::POST, msgpack::route::MSGPACK)
|
|
.await?;
|
|
test_executor
|
|
.execute::<MsgPackRaw<Parameters>>(Method::POST, msgpack::route::MSGPACK_RAW)
|
|
.await?;
|
|
}
|
|
|
|
drop(server_guard);
|
|
server_handle.await??;
|
|
Ok(())
|
|
}
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub struct TestExecutor {
|
|
client: reqwest::Client,
|
|
server_url: Url,
|
|
}
|
|
|
|
impl From<Url> for TestExecutor {
|
|
fn from(server_url: Url) -> Self {
|
|
Self {
|
|
client: Default::default(),
|
|
server_url,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl TestExecutor {
|
|
/// Execute all tests
|
|
pub async fn execute<T: ValidTest>(&self, method: Method, route: &str) -> anyhow::Result<()> {
|
|
let url = {
|
|
let mut url_builder = self.server_url.clone();
|
|
url_builder.set_path(route);
|
|
url_builder
|
|
};
|
|
|
|
let type_name = type_name::<T>();
|
|
|
|
let valid_builder = self.client.request(method.clone(), url.clone());
|
|
let valid_response = T::set_valid_request(valid_builder).send().await?;
|
|
assert_eq!(
|
|
valid_response.status(),
|
|
StatusCode::OK,
|
|
"Valid '{}' test failed.",
|
|
type_name
|
|
);
|
|
|
|
let error_builder = self.client.request(method.clone(), url.clone());
|
|
let error_response = T::set_error_request(error_builder).send().await?;
|
|
assert_eq!(
|
|
error_response.status(),
|
|
T::ERROR_STATUS_CODE,
|
|
"Error '{}' test failed.",
|
|
type_name
|
|
);
|
|
|
|
let invalid_builder = self.client.request(method, url);
|
|
let invalid_response = T::set_invalid_request(invalid_builder).send().await?;
|
|
assert_eq!(
|
|
invalid_response.status(),
|
|
VALIDATION_ERROR_STATUS,
|
|
"Invalid '{}' test failed.",
|
|
type_name
|
|
);
|
|
#[cfg(feature = "into_json")]
|
|
check_json(type_name, invalid_response).await;
|
|
println!("All '{}' tests passed.", type_name);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
pub fn client(&self) -> &reqwest::Client {
|
|
&self.client
|
|
}
|
|
}
|
|
|
|
/// Check if the response is a json response
|
|
#[cfg(feature = "into_json")]
|
|
pub async fn check_json(type_name: &'static str, response: reqwest::Response) {
|
|
assert_eq!(
|
|
response.headers()[axum::http::header::CONTENT_TYPE],
|
|
axum::http::HeaderValue::from_static(mime::APPLICATION_JSON.as_ref()),
|
|
"'{}' rejection into json test failed",
|
|
type_name
|
|
);
|
|
assert!(response.json::<serde_json::Value>().await.is_ok());
|
|
}
|
|
|
|
mod route {
|
|
pub const PATH: &str = "/path/:v0/:v1";
|
|
pub const QUERY: &str = "/query";
|
|
pub const FORM: &str = "/form";
|
|
pub const JSON: &str = "/json";
|
|
}
|
|
|
|
async fn extract_path(Valid(Path(parameters)): Valid<Path<Parameters>>) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
async fn extract_query(Valid(Query(parameters)): Valid<Query<Parameters>>) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
async fn extract_form(Valid(Form(parameters)): Valid<Form<Parameters>>) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
async fn extract_json(Valid(Json(parameters)): Valid<Json<Parameters>>) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
fn validate_again<V: Validate>(validate: V) -> StatusCode {
|
|
// The `Valid` extractor has validated the `parameters` once,
|
|
// it should have returned `400 BAD REQUEST` if the `parameters` were invalid,
|
|
// Let's validate them again to check if the `Valid` extractor works well.
|
|
// If it works properly, this function will never return `500 INTERNAL SERVER ERROR`
|
|
match validate.validate() {
|
|
Ok(_) => StatusCode::OK,
|
|
Err(_) => StatusCode::INTERNAL_SERVER_ERROR,
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "typed_header")]
|
|
mod typed_header {
|
|
|
|
pub(crate) mod route {
|
|
pub const TYPED_HEADER: &str = "/typedHeader";
|
|
}
|
|
|
|
use super::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::headers::{Error, Header, HeaderName, HeaderValue};
|
|
use axum::http::StatusCode;
|
|
use axum::TypedHeader;
|
|
|
|
pub static AXUM_VALID_PARAMETERS: HeaderName = HeaderName::from_static("axum-valid-parameters");
|
|
|
|
pub(super) async fn extract_typed_header(
|
|
Valid(TypedHeader(parameters)): Valid<TypedHeader<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
impl Header for Parameters {
|
|
fn name() -> &'static HeaderName {
|
|
&AXUM_VALID_PARAMETERS
|
|
}
|
|
|
|
fn decode<'i, I>(values: &mut I) -> Result<Self, Error>
|
|
where
|
|
Self: Sized,
|
|
I: Iterator<Item = &'i HeaderValue>,
|
|
{
|
|
let value = values.next().ok_or_else(Error::invalid)?;
|
|
let src = std::str::from_utf8(value.as_bytes()).map_err(|_| Error::invalid())?;
|
|
let split = src.split(',').collect::<Vec<_>>();
|
|
match split.as_slice() {
|
|
[v0, v1] => Ok(Parameters {
|
|
v0: v0.parse().map_err(|_| Error::invalid())?,
|
|
v1: v1.to_string(),
|
|
}),
|
|
_ => Err(Error::invalid()),
|
|
}
|
|
}
|
|
|
|
fn encode<E: Extend<HeaderValue>>(&self, values: &mut E) {
|
|
let v0 = self.v0.to_string();
|
|
let mut vec = Vec::with_capacity(v0.len() + 1 + self.v1.len());
|
|
vec.extend_from_slice(v0.as_bytes());
|
|
vec.push(b',');
|
|
vec.extend_from_slice(self.v1.as_bytes());
|
|
let value = HeaderValue::from_bytes(&vec).expect("Failed to build header");
|
|
values.extend(::std::iter::once(value));
|
|
}
|
|
}
|
|
|
|
#[test]
|
|
fn parameter_is_header() -> anyhow::Result<()> {
|
|
let parameter = Parameters {
|
|
v0: 123456,
|
|
v1: "111111".to_string(),
|
|
};
|
|
let mut vec = Vec::new();
|
|
parameter.encode(&mut vec);
|
|
let mut iter = vec.iter();
|
|
assert_eq!(parameter, Parameters::decode(&mut iter)?);
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "extra")]
|
|
mod extra {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::tests::{Rejection, ValidTest, ValidTestParameter};
|
|
use crate::Valid;
|
|
use axum::extract::FromRequestParts;
|
|
use axum::http::request::Parts;
|
|
use axum::http::StatusCode;
|
|
use axum::response::{IntoResponse, Response};
|
|
use axum_extra::extract::{Cached, WithRejection};
|
|
use reqwest::RequestBuilder;
|
|
|
|
pub mod route {
|
|
pub const CACHED: &str = "/cached";
|
|
pub const WITH_REJECTION: &str = "/with_rejection";
|
|
}
|
|
pub const PARAMETERS_HEADER: &str = "parameters-header";
|
|
pub const CACHED_REJECTION_STATUS: StatusCode = StatusCode::FORBIDDEN;
|
|
|
|
// 1.2. Define you own `Rejection` type and implement `IntoResponse` for it.
|
|
pub enum ParametersRejection {
|
|
Null,
|
|
InvalidJson(serde_json::error::Error),
|
|
}
|
|
|
|
impl IntoResponse for ParametersRejection {
|
|
fn into_response(self) -> Response {
|
|
match self {
|
|
ParametersRejection::Null => {
|
|
(CACHED_REJECTION_STATUS, "My-Data header is missing").into_response()
|
|
}
|
|
ParametersRejection::InvalidJson(e) => (
|
|
CACHED_REJECTION_STATUS,
|
|
format!("My-Data is not valid json string: {e}"),
|
|
)
|
|
.into_response(),
|
|
}
|
|
}
|
|
}
|
|
|
|
// 1.3. Implement your extractor (`FromRequestParts` or `FromRequest`)
|
|
#[axum::async_trait]
|
|
impl<S> FromRequestParts<S> for Parameters
|
|
where
|
|
S: Send + Sync,
|
|
{
|
|
type Rejection = ParametersRejection;
|
|
|
|
async fn from_request_parts(parts: &mut Parts, _: &S) -> Result<Self, Self::Rejection> {
|
|
let Some(value) = parts.headers.get(PARAMETERS_HEADER) else {
|
|
return Err(ParametersRejection::Null);
|
|
};
|
|
|
|
serde_json::from_slice(value.as_bytes()).map_err(ParametersRejection::InvalidJson)
|
|
}
|
|
}
|
|
|
|
impl ValidTest for Parameters {
|
|
const ERROR_STATUS_CODE: StatusCode = CACHED_REJECTION_STATUS;
|
|
|
|
fn set_valid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
builder.header(
|
|
PARAMETERS_HEADER,
|
|
serde_json::to_string(Parameters::valid()).expect("Failed to serialize parameters"),
|
|
)
|
|
}
|
|
|
|
fn set_error_request(builder: RequestBuilder) -> RequestBuilder {
|
|
builder.header(
|
|
PARAMETERS_HEADER,
|
|
serde_json::to_string(Parameters::error()).expect("Failed to serialize parameters"),
|
|
)
|
|
}
|
|
|
|
fn set_invalid_request(builder: RequestBuilder) -> RequestBuilder {
|
|
builder.header(
|
|
PARAMETERS_HEADER,
|
|
serde_json::to_string(Parameters::invalid())
|
|
.expect("Failed to serialize parameters"),
|
|
)
|
|
}
|
|
}
|
|
|
|
pub struct TestRejection {
|
|
_inner: ParametersRejection,
|
|
}
|
|
|
|
impl Rejection for TestRejection {
|
|
const STATUS_CODE: StatusCode = StatusCode::CONFLICT;
|
|
}
|
|
|
|
impl IntoResponse for TestRejection {
|
|
fn into_response(self) -> Response {
|
|
Self::STATUS_CODE.into_response()
|
|
}
|
|
}
|
|
|
|
// satisfy the `WithRejection`'s extractor trait bound
|
|
// R: From<E::Rejection> + IntoResponse
|
|
impl From<ParametersRejection> for TestRejection {
|
|
fn from(_inner: ParametersRejection) -> Self {
|
|
Self { _inner }
|
|
}
|
|
}
|
|
|
|
pub async fn extract_cached(
|
|
Valid(Cached(parameters)): Valid<Cached<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
pub async fn extract_with_rejection(
|
|
Valid(WithRejection(parameters, _)): Valid<WithRejection<Parameters, TestRejection>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "extra_query")]
|
|
mod extra_query {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::http::StatusCode;
|
|
use axum_extra::extract::Query;
|
|
|
|
pub mod route {
|
|
pub const EXTRA_QUERY: &str = "/extra_query";
|
|
}
|
|
|
|
pub async fn extract_extra_query(
|
|
Valid(Query(parameters)): Valid<Query<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "extra_form")]
|
|
mod extra_form {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::http::StatusCode;
|
|
use axum_extra::extract::Form;
|
|
|
|
pub mod route {
|
|
pub const EXTRA_FORM: &str = "/extra_form";
|
|
}
|
|
|
|
pub async fn extract_extra_form(
|
|
Valid(Form(parameters)): Valid<Form<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "extra_protobuf")]
|
|
mod extra_protobuf {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::http::StatusCode;
|
|
use axum_extra::protobuf::Protobuf;
|
|
|
|
pub mod route {
|
|
pub const EXTRA_PROTOBUF: &str = "/extra_protobuf";
|
|
}
|
|
|
|
pub async fn extract_extra_protobuf(
|
|
Valid(Protobuf(parameters)): Valid<Protobuf<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "yaml")]
|
|
mod yaml {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::http::StatusCode;
|
|
use axum_yaml::Yaml;
|
|
|
|
pub mod route {
|
|
pub const YAML: &str = "/yaml";
|
|
}
|
|
|
|
pub async fn extract_yaml(Valid(Yaml(parameters)): Valid<Yaml<Parameters>>) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "msgpack")]
|
|
mod msgpack {
|
|
use crate::test::{validate_again, Parameters};
|
|
use crate::Valid;
|
|
use axum::http::StatusCode;
|
|
use axum_msgpack::{MsgPack, MsgPackRaw};
|
|
|
|
pub mod route {
|
|
pub const MSGPACK: &str = "/msgpack";
|
|
pub const MSGPACK_RAW: &str = "/msgpack_raw";
|
|
}
|
|
|
|
pub async fn extract_msgpack(
|
|
Valid(MsgPack(parameters)): Valid<MsgPack<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
|
|
pub async fn extract_msgpack_raw(
|
|
Valid(MsgPackRaw(parameters)): Valid<MsgPackRaw<Parameters>>,
|
|
) -> StatusCode {
|
|
validate_again(parameters)
|
|
}
|
|
}
|