-
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathparams.rs
More file actions
391 lines (326 loc) · 11 KB
/
params.rs
File metadata and controls
391 lines (326 loc) · 11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
use std::{
collections::HashMap,
fmt::{Display, Formatter},
str::FromStr,
};
use serde::{Deserialize, Serialize};
use snafu::{ResultExt, Snafu, ensure};
#[cfg(feature = "openapi")]
use utoipa::ToSchema;
/// Parameter descibes a common parameter format. This format is used in demo
/// and stack definitions.
#[derive(Clone, Debug, Deserialize, Serialize)]
#[cfg_attr(feature = "openapi", derive(ToSchema))]
#[serde(rename_all = "camelCase")]
pub struct Parameter {
/// Parameter description
pub description: String,
/// Parameter default value
pub default: String,
/// Parameer value
#[serde(skip)]
pub value: String,
/// Parameter name
pub name: String,
}
#[derive(Debug, Snafu, PartialEq)]
pub enum IntoParametersError {
#[snafu(display("failed to parse raw parameter"))]
RawParse { source: RawParameterParseError },
#[snafu(display("invalid parameter {parameter:?}, expected one of {expected:?}"))]
InvalidParameter { parameter: String, expected: String },
}
pub trait IntoParameters: Sized + IntoRawParameters {
fn into_params<T>(
self,
valid_parameters: T,
) -> Result<HashMap<String, String>, IntoParametersError>
where
T: AsRef<[Parameter]>,
{
let raw_parameters = self.into_raw_params().context(RawParseSnafu)?;
let parameters = valid_parameters.as_ref();
let mut parameters: HashMap<String, String> = parameters
.iter()
.map(|p| (p.name.clone(), p.default.clone()))
.collect();
for raw_paramater in raw_parameters {
if !parameters.contains_key(&raw_paramater.name) {
return InvalidParameterSnafu {
parameter: raw_paramater.name,
expected: parameters
.keys()
.cloned()
.collect::<Vec<String>>()
.join(", "),
}
.fail();
}
parameters.insert(raw_paramater.name, raw_paramater.value);
}
Ok(parameters)
}
}
impl IntoParameters for Vec<String> {}
impl IntoParameters for &String {}
impl IntoParameters for String {}
impl IntoParameters for &str {}
/// RawParameter describes a common raw parameter format. Raw parameters are passed in as strings and have the following
/// format: `<NAME>=<VALUE>`.
#[derive(Debug, PartialEq)]
pub struct RawParameter {
/// Parameter value
pub value: String,
/// Parameter name
pub name: String,
}
#[derive(Debug, Snafu, PartialEq)]
pub enum RawParameterParseError {
#[snafu(display("invalid equal sign count in parameter, expected one"))]
InvalidEqualSignCount,
#[snafu(display("invalid parameter value, cannot be empty"))]
EmptyValue,
#[snafu(display("invalid parameter name, cannot be empty"))]
EmptyName,
#[snafu(display("invalid (empty) parameter input"))]
EmptyInput,
}
impl Display for RawParameter {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "{name}={value}", name = self.name, value = self.value)
}
}
impl FromStr for RawParameter {
type Err = RawParameterParseError;
fn from_str(s: &str) -> Result<Self, Self::Err> {
let input = s.trim();
// Empty input is not allowed
ensure!(!input.is_empty(), EmptyInputSnafu);
// Split at each equal sign
let parts: Vec<&str> = input.split('=').collect();
let len = parts.len();
// Input without any or more than one sign character is invalid
ensure!(len == 2, InvalidEqualSignCountSnafu);
// If there is an equal sign, but no key before
if parts[0].is_empty() {
return Err(RawParameterParseError::EmptyName);
}
// If there is an equal sign, but no value after
if parts[1].is_empty() {
return Err(RawParameterParseError::EmptyValue);
}
Ok(Self {
name: parts[0].to_string(),
value: parts[1].to_string(),
})
}
}
impl TryFrom<String> for RawParameter {
type Error = RawParameterParseError;
fn try_from(value: String) -> Result<Self, Self::Error> {
Self::from_str(value.as_str())
}
}
impl TryFrom<&str> for RawParameter {
type Error = RawParameterParseError;
fn try_from(value: &str) -> Result<Self, Self::Error> {
Self::from_str(value)
}
}
pub trait IntoRawParameters: Sized {
fn into_raw_params(self) -> Result<Vec<RawParameter>, RawParameterParseError>;
}
impl IntoRawParameters for &String {
fn into_raw_params(self) -> Result<Vec<RawParameter>, RawParameterParseError> {
self.to_owned().into_raw_params()
}
}
impl IntoRawParameters for String {
fn into_raw_params(self) -> Result<Vec<RawParameter>, RawParameterParseError> {
self.as_str().into_raw_params()
}
}
impl IntoRawParameters for &str {
fn into_raw_params(self) -> Result<Vec<RawParameter>, RawParameterParseError> {
let input = self.trim();
if input.is_empty() {
return Err(RawParameterParseError::EmptyInput);
}
let mut params = Vec::new();
let parts: Vec<&str> = input.split(' ').collect();
for part in parts {
let param: RawParameter = part.parse()?;
params.push(param);
}
Ok(params)
}
}
impl IntoRawParameters for Vec<String> {
fn into_raw_params(self) -> Result<Vec<RawParameter>, RawParameterParseError> {
let parameters = self
.iter()
.map(|s| s.parse())
.collect::<Result<Vec<RawParameter>, RawParameterParseError>>()?;
Ok(parameters)
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn single_parameter_str() {
match RawParameter::try_from("param=value") {
Ok(param) => {
assert_eq!(param.name, "param".to_string());
assert_eq!(param.value, "value".to_string());
}
Err(err) => panic!("{err}"),
}
}
#[test]
fn single_parameter_string() {
match RawParameter::try_from("param=value".to_string()) {
Ok(param) => {
assert_eq!(param.name, "param".to_string());
assert_eq!(param.value, "value".to_string());
}
Err(err) => panic!("{err}"),
}
}
#[test]
fn single_parameter_no_equal_sign() {
match RawParameter::try_from("param") {
Ok(param) => panic!("SHOULD FAIL: {param}"),
Err(err) => assert_eq!(err, RawParameterParseError::InvalidEqualSignCount),
}
}
#[test]
fn single_parameter_equal_sign_no_value() {
match RawParameter::try_from("param=") {
Ok(param) => panic!("SHOULD FAIL: {param}"),
Err(err) => assert_eq!(err, RawParameterParseError::EmptyValue),
}
}
#[test]
fn single_parameter_only_equal_sign() {
match RawParameter::try_from("=") {
Ok(param) => panic!("SHOULD FAIL: {param}"),
Err(err) => assert_eq!(err, RawParameterParseError::EmptyName),
}
}
#[test]
fn single_parameter_multi_equal_sign() {
match RawParameter::try_from("param=value=invalid") {
Ok(param) => panic!("SHOULD FAIL: {param}"),
Err(err) => assert_eq!(err, RawParameterParseError::InvalidEqualSignCount),
}
}
#[test]
fn single_parameter_multi_only_equal_sign() {
match RawParameter::try_from("==") {
Ok(param) => panic!("SHOULD FAIL: {param}"),
Err(err) => assert_eq!(err, RawParameterParseError::InvalidEqualSignCount),
}
}
#[test]
fn multi_raw_parameters_str() {
match "param1=value1 param2=value2".into_raw_params() {
Ok(params) => {
assert_eq!(params.len(), 2);
let mut iter = params.iter();
let p = iter.next();
assert!(p.is_some());
assert_eq!(
p.unwrap(),
&RawParameter {
name: "param1".into(),
value: "value1".into()
}
);
let p = iter.next();
assert!(p.is_some());
assert_eq!(
p.unwrap(),
&RawParameter {
name: "param2".into(),
value: "value2".into()
}
);
let p = iter.next();
assert!(p.is_none());
}
Err(err) => panic!("{err}"),
}
}
#[test]
fn multi_raw_parameters_string() {
match "param1=value1 param2=value2".to_string().into_raw_params() {
Ok(params) => {
assert_eq!(params.len(), 2);
let mut iter = params.iter();
let p = iter.next();
assert!(p.is_some());
assert_eq!(
p.unwrap(),
&RawParameter {
name: "param1".into(),
value: "value1".into()
}
);
let p = iter.next();
assert!(p.is_some());
assert_eq!(
p.unwrap(),
&RawParameter {
name: "param2".into(),
value: "value2".into()
}
);
let p = iter.next();
assert!(p.is_none());
}
Err(err) => panic!("{err}"),
}
}
#[test]
fn multi_parameter_valid() {
let valid_parameters = vec![Parameter {
description: "Description1".into(),
default: "Default value 1".into(),
name: "param1".into(),
value: "".into(),
}];
let input = "param1=value1";
match input.into_params(valid_parameters) {
Ok(validated) => {
assert_eq!(validated.len(), 1);
if let Some(value) = validated.get("param1") {
assert_eq!(*value, "value1".to_string());
return;
}
panic!("No parameter in map with name param1");
}
Err(err) => panic!("{err}"),
}
}
#[test]
fn multi_parameter_invalid() {
let valid_parameters = vec![Parameter {
description: "Description1".into(),
default: "Default value 1".into(),
name: "param1".into(),
value: "".into(),
}];
let input = "param2=value2";
match input.into_params(valid_parameters) {
Ok(validated) => panic!("SHOULD FAIL: {validated:?}"),
Err(err) => assert_eq!(
err,
IntoParametersError::InvalidParameter {
parameter: "param2".into(),
expected: "param1".into()
}
),
}
}
}