Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rust validation handling #15288

Merged
merged 20 commits into from
Jun 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -334,4 +334,8 @@ public String toApiDocFilename(String name) {
return toApiName(name);
}

@Override
public String addRegularExpressionDelimiter(String pattern) {
return pattern;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ mime = "0.3"

serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
validator = { version = "0.16", features = ["derive"] }

# Crates included if required by the API definition
{{#usesXml}}
Expand All @@ -103,7 +104,7 @@ mime_0_2 = { package = "mime", version = "0.2.6", optional = true }
multipart = { version = "0.16", default-features = false, optional = true }
{{/apiUsesMultipartFormData}}
{{#apiUsesUuid}}
uuid = {version = "0.8", features = ["serde", "v4"]}
uuid = {version = "1.3.1", features = ["serde", "v4"]}
{{/apiUsesUuid}}

# Common between server and client features
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
#![allow(unused_qualifications)]

use validator::Validate;

use crate::models;
#[cfg(any(feature = "client", feature = "server"))]
use crate::header;
Expand Down Expand Up @@ -243,7 +245,7 @@ impl std::str::FromStr for {{{classname}}} {
{{/arrayModelType}}
{{^arrayModelType}}
{{! general struct}}
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize)]
#[derive(Debug, Clone, PartialEq, serde::Serialize, serde::Deserialize, validator::Validate)]
#[cfg_attr(feature = "conversion", derive(frunk::LabelledGeneric))]
{{#xmlName}}
#[serde(rename = "{{{.}}}")]
Expand All @@ -258,6 +260,44 @@ pub struct {{{classname}}} {
#[serde(serialize_with = "wrap_in_{{{x-item-xml-name}}}")]
{{/x-item-xml-name}}
{{/vendorExtensions}}
{{#hasValidation}}
#[validate(
{{#maxLength}}
{{#minLength}}
length(min = {{minLength}}, max = {{maxLength}}),
{{/minLength}}
{{^minLength}}
length(max = {{maxLength}}),
{{/minLength}}
{{/maxLength}}
{{^maxLength}}
{{#minLength}}
length(min = {{minLength}}),
{{/minLength}}
{{/maxLength}}
{{#pattern}}
{{^isByteArray}}
regex = "RE_{{#lambda.uppercase}}{{{classname}}}_{{{name}}}{{/lambda.uppercase}}",
{{/isByteArray}}
{{#isByteArray}}
custom ="validate_byte_{{#lambda.lowercase}}{{{classname}}}_{{{name}}}{{/lambda.lowercase}}"
{{/isByteArray}}
{{/pattern}}
{{#maximum}}
{{#minimum}}
range(min = {{minimum}}, max = {{maximum}}),
{{/minimum}}
{{^minimum}}
range(max = {{maximum}}),
{{/minimum}}
{{/maximum}}
{{#minimum}}
{{^maximum}}
range(min = {{minimum}}),
{{/maximum}}
{{/minimum}}
)]
{{/hasValidation}}
{{#required}}
pub {{{name}}}: {{#isNullable}}swagger::Nullable<{{/isNullable}}{{{dataType}}}{{#isNullable}}>{{/isNullable}},
{{/required}}
Expand All @@ -273,6 +313,31 @@ pub struct {{{classname}}} {
{{/vars}}
}

{{#vars}}
{{#hasValidation}}
{{#pattern}}
{{^isByteArray}}
lazy_static::lazy_static! {
static ref RE_{{#lambda.uppercase}}{{{classname}}}_{{{name}}}{{/lambda.uppercase}}: regex::Regex = regex::Regex::new(r"{{ pattern }}").unwrap();
}
{{/isByteArray}}
{{#isByteArray}}
lazy_static::lazy_static! {
static ref RE_{{#lambda.uppercase}}{{{classname}}}_{{{name}}}{{/lambda.uppercase}}: regex::bytes::Regex = regex::bytes::Regex::new(r"{{ pattern }}").unwrap();
}
fn validate_byte_{{#lambda.lowercase}}{{{classname}}}_{{{name}}}{{/lambda.lowercase}}(
b: &swagger::ByteArray
) -> Result<(), validator::ValidationError> {
if !RE_{{#lambda.uppercase}}{{{classname}}}_{{{name}}}{{/lambda.uppercase}}.is_match(b) {
return Err(validator::ValidationError::new("Character not allowed"));
}
Ok(())
}
{{/isByteArray}}
{{/pattern}}
{{/hasValidation}}
{{/vars}}

impl {{{classname}}} {
#[allow(clippy::new_without_default)]
pub fn new({{#vars}}{{^defaultValue}}{{{name}}}: {{#isNullable}}swagger::Nullable<{{/isNullable}}{{{dataType}}}{{#isNullable}}>{{/isNullable}}, {{/defaultValue}}{{/vars}}) -> {{{classname}}} {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -670,12 +670,14 @@ components:
id:
type: integer
format: int64
minimum: 0
petId:
type: integer
format: int64
quantity:
type: integer
format: int32
minimum: 0
shipDate:
type: string
format: date-time
Expand Down Expand Up @@ -714,10 +716,14 @@ components:
format: int64
username:
type: string
maxLength: 90
minLength: 1
pattern: '^[a-z][-a-z0-9]*$'
firstName:
type: string
lastName:
type: string
minLength: 1
email:
type: string
password:
Expand All @@ -728,6 +734,9 @@ components:
type: integer
format: int32
description: User Status
required:
- username
- lastName
xml:
name: User
Tag:
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/rust/hyper/petstore/docs/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i64**> | | [optional]
**username** | Option<**String**> | | [optional]
**username** | **String** | |
**first_name** | Option<**String**> | | [optional]
**last_name** | Option<**String**> | | [optional]
**last_name** | **String** | |
**email** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**phone** | Option<**String**> | | [optional]
Expand Down
14 changes: 7 additions & 7 deletions samples/client/petstore/rust/hyper/petstore/src/models/user.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
pub struct User {
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "username", skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
#[serde(rename = "username")]
pub username: String,
#[serde(rename = "firstName", skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "lastName", skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(rename = "lastName")]
pub last_name: String,
#[serde(rename = "email", skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "password", skip_serializing_if = "Option::is_none")]
Expand All @@ -35,12 +35,12 @@ pub struct User {

impl User {
/// A User who is purchasing from the pet store
pub fn new() -> User {
pub fn new(username: String, last_name: String) -> User {
User {
id: None,
username: None,
username,
first_name: None,
last_name: None,
last_name,
email: None,
password: None,
phone: None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i64**> | | [optional]
**username** | Option<**String**> | | [optional]
**username** | **String** | |
**first_name** | Option<**String**> | | [optional]
**last_name** | Option<**String**> | | [optional]
**last_name** | **String** | |
**email** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**phone** | Option<**String**> | | [optional]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
pub struct User {
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "username", skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
#[serde(rename = "username")]
pub username: String,
#[serde(rename = "firstName", skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "lastName", skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(rename = "lastName")]
pub last_name: String,
#[serde(rename = "email", skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "password", skip_serializing_if = "Option::is_none")]
Expand All @@ -35,12 +35,12 @@ pub struct User {

impl User {
/// A User who is purchasing from the pet store
pub fn new() -> User {
pub fn new(username: String, last_name: String) -> User {
User {
id: None,
username: None,
username,
first_name: None,
last_name: None,
last_name,
email: None,
password: None,
phone: None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i64**> | | [optional]
**username** | Option<**String**> | | [optional]
**username** | **String** | |
**first_name** | Option<**String**> | | [optional]
**last_name** | Option<**String**> | | [optional]
**last_name** | **String** | |
**email** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**phone** | Option<**String**> | | [optional]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
pub struct User {
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "username", skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
#[serde(rename = "username")]
pub username: String,
#[serde(rename = "firstName", skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "lastName", skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(rename = "lastName")]
pub last_name: String,
#[serde(rename = "email", skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "password", skip_serializing_if = "Option::is_none")]
Expand All @@ -35,12 +35,12 @@ pub struct User {

impl User {
/// A User who is purchasing from the pet store
pub fn new() -> User {
pub fn new(username: String, last_name: String) -> User {
User {
id: None,
username: None,
username,
first_name: None,
last_name: None,
last_name,
email: None,
password: None,
phone: None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i64**> | | [optional]
**username** | Option<**String**> | | [optional]
**username** | **String** | |
**first_name** | Option<**String**> | | [optional]
**last_name** | Option<**String**> | | [optional]
**last_name** | **String** | |
**email** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**phone** | Option<**String**> | | [optional]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
pub struct User {
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "username", skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
#[serde(rename = "username")]
pub username: String,
#[serde(rename = "firstName", skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "lastName", skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(rename = "lastName")]
pub last_name: String,
#[serde(rename = "email", skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "password", skip_serializing_if = "Option::is_none")]
Expand All @@ -35,12 +35,12 @@ pub struct User {

impl User {
/// A User who is purchasing from the pet store
pub fn new() -> User {
pub fn new(username: String, last_name: String) -> User {
User {
id: None,
username: None,
username,
first_name: None,
last_name: None,
last_name,
email: None,
password: None,
phone: None,
Expand Down
4 changes: 2 additions & 2 deletions samples/client/petstore/rust/reqwest/petstore/docs/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | Option<**i64**> | | [optional]
**username** | Option<**String**> | | [optional]
**username** | **String** | |
**first_name** | Option<**String**> | | [optional]
**last_name** | Option<**String**> | | [optional]
**last_name** | **String** | |
**email** | Option<**String**> | | [optional]
**password** | Option<**String**> | | [optional]
**phone** | Option<**String**> | | [optional]
Expand Down
14 changes: 7 additions & 7 deletions samples/client/petstore/rust/reqwest/petstore/src/models/user.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@
pub struct User {
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<i64>,
#[serde(rename = "username", skip_serializing_if = "Option::is_none")]
pub username: Option<String>,
#[serde(rename = "username")]
pub username: String,
#[serde(rename = "firstName", skip_serializing_if = "Option::is_none")]
pub first_name: Option<String>,
#[serde(rename = "lastName", skip_serializing_if = "Option::is_none")]
pub last_name: Option<String>,
#[serde(rename = "lastName")]
pub last_name: String,
#[serde(rename = "email", skip_serializing_if = "Option::is_none")]
pub email: Option<String>,
#[serde(rename = "password", skip_serializing_if = "Option::is_none")]
Expand All @@ -35,12 +35,12 @@ pub struct User {

impl User {
/// A User who is purchasing from the pet store
pub fn new() -> User {
pub fn new(username: String, last_name: String) -> User {
User {
id: None,
username: None,
username,
first_name: None,
last_name: None,
last_name,
email: None,
password: None,
phone: None,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ mime = "0.3"

serde = { version = "1.0", features = ["derive"] }
serde_json = "1.0"
validator = { version = "0.16", features = ["derive"] }

# Crates included if required by the API definition
mime_0_2 = { package = "mime", version = "0.2.6", optional = true }
Expand Down
Loading
Loading