Skip to content

Commit

Permalink
Refactor some path derive with IntoParmas tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@juhaku
juhaku committed Nov 26, 2022
1 parent afa62d2 commit 436cccb
Showing 1 changed file with 126 additions and 187 deletions.
313 changes: 126 additions & 187 deletions utoipa-gen/tests/path_derive.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,38 @@ test_api_fn! {
#[deprecated]
}

macro_rules! api_fn_doc_with_params {
( $method:ident: $path:literal => $( #[$attr:meta] )* $key:ident $name:ident $body:tt ) => {{
#[allow(dead_code)]
#[derive(serde::Deserialize, utoipa::IntoParams)]
$(#[$attr])*
$key $name $body

#[utoipa::path(
$method,
path = $path,
responses(
(status = 200, description = "success response")
),
params(
$name,
)
)]
#[allow(unused)]
fn my_operation(params: MyParams) -> String {
"".to_string()
}

let operation: Value = test_api_fn_doc! {
my_operation,
operation: $method,
path: $path
};

operation
}};
}

#[test]
fn derive_path_with_all_info_success() {
let operation = test_api_fn_doc! {
Expand Down Expand Up @@ -423,11 +455,6 @@ fn derive_path_params_map() {
"".to_string()
}

use utoipa::OpenApi;
#[derive(OpenApi, Default)]
#[openapi(paths(use_maps))]
struct ApiDoc;

let operation: Value = test_api_fn_doc! {
use_maps,
operation: get,
Expand Down Expand Up @@ -466,55 +493,75 @@ fn derive_path_params_map() {
}

#[test]
fn derive_required_path_params() {
#[derive(serde::Deserialize, IntoParams)]
#[into_params(parameter_in = Query)]
#[allow(dead_code)]
struct MyParams {
#[serde(default)]
vec_default: Option<Vec<String>>,

#[serde(default)]
string_default: Option<String>,
fn derive_path_params_with_examples() {
let operation = api_fn_doc_with_params! {get: "/foo" =>
struct MyParams {
#[param(example = json!({"key": "value"}))]
map: HashMap<String, String>,
#[param(example = json!(["value1", "value2"]))]
vec: Vec<String>,
}
};
let parameters = operation.get("parameters").unwrap();

#[serde(default)]
vec_default_required: Vec<String>,
assert_json_eq! {
parameters,
json!{[
{
"in": "path",
"name": "map",
"required": true,
"example": {
"key": "value"
},
"schema": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
{
"in": "path",
"name": "vec",
"required": true,
"example": ["value1", "value2"],
"schema": {
"items": {
"type": "string"
},
"type": "array"
}
}
]}
}
}

#[serde(default)]
string_default_required: String,
#[test]
fn derive_required_path_params() {
let operation = api_fn_doc_with_params! {get: "/list/{id}" =>
#[into_params(parameter_in = Query)]
struct MyParams {
#[serde(default)]
vec_default: Option<Vec<String>>,

vec_option: Option<Vec<String>>,
#[serde(default)]
string_default: Option<String>,

string_option: Option<String>,
#[serde(default)]
vec_default_required: Vec<String>,

vec: Vec<String>,
#[serde(default)]
string_default_required: String,

string: String,
}
vec_option: Option<Vec<String>>,

#[utoipa::path(
get,
path = "/list/{id}",
responses(
(status = 200, description = "success response")
),
params(
MyParams,
)
)]
#[allow(unused)]
fn list(id: i64) -> String {
"".to_string()
}
string_option: Option<String>,

#[derive(utoipa::OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;
vec: Vec<String>,

let operation: Value = test_api_fn_doc! {
list,
operation: get,
path: "/list/{id}"
string: String,
}
};

let parameters = operation.get("parameters").unwrap();
Expand Down Expand Up @@ -604,52 +651,26 @@ fn derive_required_path_params() {

#[test]
fn derive_path_params_with_serde_and_custom_rename() {
#[derive(serde::Deserialize, IntoParams)]
#[into_params(parameter_in = Query)]
#[serde(rename_all = "camelCase")]
#[allow(dead_code)]
struct MyParams {
vec_default: Option<Vec<String>>,
let operation = api_fn_doc_with_params! {get: "/list/{id}" =>
#[into_params(parameter_in = Query)]
#[serde(rename_all = "camelCase")]
struct MyParams {
vec_default: Option<Vec<String>>,

#[serde(default, rename = "STRING")]
string_default: Option<String>,

#[serde(default, rename = "VEC")]
#[param(rename = "vec2")]
vec_default_required: Vec<String>,

#[serde(default)]
#[param(rename = "string_r2")]
string_default_required: String,
#[serde(default, rename = "STRING")]
string_default: Option<String>,

string: String,
}

#[utoipa::path(
get,
path = "/list/{id}",
responses(
(status = 200, description = "success response")
),
params(
MyParams,
)
)]
#[allow(unused)]
fn list(id: i64) -> String {
"".to_string()
}
#[serde(default, rename = "VEC")]
#[param(rename = "vec2")]
vec_default_required: Vec<String>,

#[derive(utoipa::OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;
#[serde(default)]
#[param(rename = "string_r2")]
string_default_required: String,

let operation: Value = test_api_fn_doc! {
list,
operation: get,
path: "/list/{id}"
string: String,
}
};

let parameters = operation.get("parameters").unwrap();

assert_json_eq!(
Expand Down Expand Up @@ -707,38 +728,12 @@ fn derive_path_params_with_serde_and_custom_rename() {

#[test]
fn derive_path_params_custom_rename_all() {
#[derive(serde::Deserialize, IntoParams)]
#[into_params(rename_all = "camelCase", parameter_in = Query)]
#[allow(dead_code)]
struct MyParams {
vec_default: Option<Vec<String>>,
}

#[utoipa::path(
get,
path = "/list/{id}",
responses(
(status = 200, description = "success response")
),
params(
MyParams,
)
)]
#[allow(unused)]
fn list(id: i64) -> String {
"".to_string()
}

#[derive(utoipa::OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;

let operation: Value = test_api_fn_doc! {
list,
operation: get,
path: "/list/{id}"
let operation = api_fn_doc_with_params! {get: "/list/{id}" =>
#[into_params(rename_all = "camelCase", parameter_in = Query)]
struct MyParams {
vec_default: Option<Vec<String>>,
}
};

let parameters = operation.get("parameters").unwrap();

assert_json_eq!(
Expand All @@ -761,39 +756,13 @@ fn derive_path_params_custom_rename_all() {

#[test]
fn derive_path_params_custom_rename_all_serde_will_override() {
#[derive(serde::Deserialize, IntoParams)]
#[into_params(rename_all = "camelCase", parameter_in = Query)]
#[serde(rename_all = "UPPERCASE")]
#[allow(dead_code)]
struct MyParams {
vec_default: Option<Vec<String>>,
}

#[utoipa::path(
get,
path = "/list/{id}",
responses(
(status = 200, description = "success response")
),
params(
MyParams,
)
)]
#[allow(unused)]
fn list(id: i64) -> String {
"".to_string()
}

#[derive(utoipa::OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;

let operation: Value = test_api_fn_doc! {
list,
operation: get,
path: "/list/{id}"
let operation = api_fn_doc_with_params! {get: "/list/{id}" =>
#[into_params(rename_all = "camelCase", parameter_in = Query)]
#[serde(rename_all = "UPPERCASE")]
struct MyParams {
vec_default: Option<Vec<String>>,
}
};

let parameters = operation.get("parameters").unwrap();

assert_json_eq!(
Expand All @@ -816,40 +785,15 @@ fn derive_path_params_custom_rename_all_serde_will_override() {

#[test]
fn derive_path_parameters_container_level_default() {
#[derive(serde::Deserialize, IntoParams, Default)]
#[into_params(parameter_in = Query)]
#[serde(default)]
#[allow(dead_code)]
struct MyParams {
vec_default: Vec<String>,
string: String,
}

#[utoipa::path(
get,
path = "/list/{id}",
responses(
(status = 200, description = "success response")
),
params(
MyParams,
)
)]
#[allow(unused)]
fn list(id: i64) -> String {
"".to_string()
}

#[derive(utoipa::OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;

let operation: Value = test_api_fn_doc! {
list,
operation: get,
path: "/list/{id}"
let operation = api_fn_doc_with_params! {get: "/list/{id}" =>
#[derive(Default)]
#[into_params(parameter_in = Query)]
#[serde(default)]
struct MyParams {
vec_default: Vec<String>,
string: String,
}
};

let parameters = operation.get("parameters").unwrap();

assert_json_eq!(
Expand Down Expand Up @@ -932,11 +876,6 @@ fn derive_path_params_intoparams() {
"".to_string()
}

use utoipa::OpenApi;
#[derive(OpenApi, Default)]
#[openapi(paths(list))]
struct ApiDoc;

let operation: Value = test_api_fn_doc! {
list,
operation: get,
Expand Down

0 comments on commit 436cccb

Please sign in to comment.