mockforge_bench/
request_gen.rs

1//! Request template generation from OpenAPI operations
2
3use crate::error::Result;
4use crate::param_overrides::OperationOverrides;
5use crate::spec_parser::ApiOperation;
6use openapiv3::{
7    MediaType, Parameter, ParameterData, ParameterSchemaOrContent, ReferenceOr, RequestBody,
8    Schema, SchemaKind, Type,
9};
10use serde_json::{json, Value};
11use std::collections::HashMap;
12
13/// A request template for load testing
14#[derive(Debug, Clone)]
15pub struct RequestTemplate {
16    pub operation: ApiOperation,
17    pub path_params: HashMap<String, String>,
18    pub query_params: HashMap<String, String>,
19    pub headers: HashMap<String, String>,
20    pub body: Option<Value>,
21}
22
23impl RequestTemplate {
24    /// Generate the full URL path with parameters substituted
25    pub fn generate_path(&self) -> String {
26        let mut path = self.operation.path.clone();
27
28        for (key, value) in &self.path_params {
29            path = path.replace(&format!("{{{}}}", key), value);
30        }
31
32        if !self.query_params.is_empty() {
33            let query_string: Vec<String> =
34                self.query_params.iter().map(|(k, v)| format!("{}={}", k, v)).collect();
35            path = format!("{}?{}", path, query_string.join("&"));
36        }
37
38        path
39    }
40
41    /// Get all headers including content-type
42    pub fn get_headers(&self) -> HashMap<String, String> {
43        let mut headers = self.headers.clone();
44
45        if self.body.is_some() {
46            headers
47                .entry("Content-Type".to_string())
48                .or_insert_with(|| "application/json".to_string());
49        }
50
51        headers
52    }
53}
54
55/// Request template generator
56pub struct RequestGenerator;
57
58impl RequestGenerator {
59    /// Generate a request template from an API operation
60    pub fn generate_template(operation: &ApiOperation) -> Result<RequestTemplate> {
61        Self::generate_template_with_overrides(operation, None)
62    }
63
64    /// Generate a request template with optional parameter overrides
65    ///
66    /// When overrides are provided, they take precedence over auto-generated values.
67    /// This allows users to provide realistic test data instead of placeholder values.
68    pub fn generate_template_with_overrides(
69        operation: &ApiOperation,
70        overrides: Option<&OperationOverrides>,
71    ) -> Result<RequestTemplate> {
72        let mut template = RequestTemplate {
73            operation: operation.clone(),
74            path_params: HashMap::new(),
75            query_params: HashMap::new(),
76            headers: HashMap::new(),
77            body: None,
78        };
79
80        // Extract parameters from OpenAPI spec
81        for param_ref in &operation.operation.parameters {
82            if let ReferenceOr::Item(param) = param_ref {
83                Self::process_parameter_with_overrides(param, &mut template, overrides)?;
84            }
85        }
86
87        // Apply any additional overridden parameters not in the spec
88        if let Some(ovr) = overrides {
89            // Add overridden path params that weren't in the spec
90            for (name, value) in &ovr.path_params {
91                template.path_params.entry(name.clone()).or_insert_with(|| value.clone());
92            }
93            // Add overridden query params that weren't in the spec
94            for (name, value) in &ovr.query_params {
95                template.query_params.entry(name.clone()).or_insert_with(|| value.clone());
96            }
97            // Add overridden headers that weren't in the spec
98            for (name, value) in &ovr.headers {
99                template.headers.entry(name.clone()).or_insert_with(|| value.clone());
100            }
101        }
102
103        // Extract request body (override takes precedence)
104        if let Some(ovr) = overrides {
105            if let Some(body) = ovr.get_body() {
106                template.body = Some(body.clone());
107            } else if let Some(ReferenceOr::Item(request_body)) = &operation.operation.request_body
108            {
109                template.body = Self::generate_body(request_body)?;
110            }
111        } else if let Some(ReferenceOr::Item(request_body)) = &operation.operation.request_body {
112            template.body = Self::generate_body(request_body)?;
113        }
114
115        Ok(template)
116    }
117
118    /// Process a parameter with optional overrides
119    fn process_parameter_with_overrides(
120        param: &Parameter,
121        template: &mut RequestTemplate,
122        overrides: Option<&OperationOverrides>,
123    ) -> Result<()> {
124        let (param_type, param_data) = match param {
125            Parameter::Query { parameter_data, .. } => ("query", parameter_data),
126            Parameter::Path { parameter_data, .. } => ("path", parameter_data),
127            Parameter::Header { parameter_data, .. } => ("header", parameter_data),
128            Parameter::Cookie { parameter_data, .. } => ("cookie", parameter_data),
129        };
130
131        // Check for override first, then fall back to generated value
132        let value = if let Some(ovr) = overrides {
133            match param_type {
134                "path" => ovr.get_path_param(&param_data.name).cloned(),
135                "query" => ovr.get_query_param(&param_data.name).cloned(),
136                "header" => ovr.get_header(&param_data.name).cloned(),
137                _ => None,
138            }
139        } else {
140            None
141        }
142        .unwrap_or_else(|| Self::generate_param_value(param_data).unwrap_or_default());
143
144        match param_type {
145            "query" => {
146                template.query_params.insert(param_data.name.clone(), value);
147            }
148            "path" => {
149                template.path_params.insert(param_data.name.clone(), value);
150            }
151            "header" => {
152                template.headers.insert(param_data.name.clone(), value);
153            }
154            "cookie" => {
155                // Append cookie to existing Cookie header or create new one
156                let cookie_pair = format!("{}={}", param_data.name, value);
157                template
158                    .headers
159                    .entry("Cookie".to_string())
160                    .and_modify(|existing| {
161                        existing.push_str("; ");
162                        existing.push_str(&cookie_pair);
163                    })
164                    .or_insert(cookie_pair);
165            }
166            _ => {}
167        }
168
169        Ok(())
170    }
171
172    /// Generate a value for a parameter
173    fn generate_param_value(param_data: &ParameterData) -> Result<String> {
174        // Try to use example first
175        if let Some(example) = &param_data.example {
176            return Ok(example.to_string().trim_matches('"').to_string());
177        }
178
179        // Generate from schema
180        if let ParameterSchemaOrContent::Schema(ReferenceOr::Item(schema)) = &param_data.format {
181            return Ok(Self::generate_value_from_schema(schema));
182        }
183
184        // Default value based on parameter name
185        Ok(Self::default_param_value(&param_data.name))
186    }
187
188    /// Generate a default value based on parameter name
189    fn default_param_value(name: &str) -> String {
190        match name.to_lowercase().as_str() {
191            "id" => "1".to_string(),
192            "limit" => "10".to_string(),
193            "offset" => "0".to_string(),
194            "page" => "1".to_string(),
195            "sort" => "name".to_string(),
196            _ => "test-value".to_string(),
197        }
198    }
199
200    /// Generate a request body from a RequestBody definition
201    fn generate_body(request_body: &RequestBody) -> Result<Option<Value>> {
202        // Look for application/json content
203        if let Some(content) = request_body.content.get("application/json") {
204            return Ok(Some(Self::generate_json_body(content)));
205        }
206
207        Ok(None)
208    }
209
210    /// Generate JSON body from media type
211    fn generate_json_body(media_type: &MediaType) -> Value {
212        // Try to use example first
213        if let Some(example) = &media_type.example {
214            return example.clone();
215        }
216
217        // Generate from schema
218        if let Some(ReferenceOr::Item(schema)) = &media_type.schema {
219            return Self::generate_json_from_schema(schema);
220        }
221
222        json!({})
223    }
224
225    /// Generate JSON from schema
226    fn generate_json_from_schema(schema: &Schema) -> Value {
227        match &schema.schema_kind {
228            SchemaKind::Type(Type::Object(obj)) => {
229                let mut map = serde_json::Map::new();
230
231                for (key, schema_ref) in &obj.properties {
232                    if let ReferenceOr::Item(prop_schema) = schema_ref {
233                        map.insert(key.clone(), Self::generate_json_from_schema(prop_schema));
234                    }
235                }
236
237                Value::Object(map)
238            }
239            SchemaKind::Type(Type::Array(arr)) => {
240                if let Some(ReferenceOr::Item(item_schema)) = &arr.items {
241                    return json!([Self::generate_json_from_schema(item_schema)]);
242                }
243                json!([])
244            }
245            SchemaKind::Type(Type::String(_)) => Self::generate_string_value(schema),
246            SchemaKind::Type(Type::Number(n)) => n
247                .enumeration
248                .iter()
249                .flatten()
250                .next()
251                .map(|v| json!(v))
252                .unwrap_or_else(|| json!(42.0)),
253            SchemaKind::Type(Type::Integer(i)) => i
254                .enumeration
255                .iter()
256                .flatten()
257                .next()
258                .map(|v| json!(v))
259                .unwrap_or_else(|| json!(42)),
260            SchemaKind::Type(Type::Boolean(_)) => json!(true),
261            _ => json!(null),
262        }
263    }
264
265    /// Generate a string value from schema
266    fn generate_string_value(schema: &Schema) -> Value {
267        // Use example if available
268        if let Some(example) = &schema.schema_data.example {
269            return example.clone();
270        }
271        // Round 51 (#79) — respect an enum so the positive body is spec-VALID
272        // (Srikanth on 0.3.196: `billingType` was filled with the invalid
273        // literal "test-string", tripping a body enum violation on every
274        // probe). Negative body probes still override the value they attack.
275        if let SchemaKind::Type(Type::String(s)) = &schema.schema_kind {
276            if let Some(first) = s.enumeration.iter().flatten().next() {
277                return json!(first);
278            }
279        }
280
281        json!("test-string")
282    }
283
284    /// Generate a value from schema (for parameters)
285    fn generate_value_from_schema(schema: &Schema) -> String {
286        match &schema.schema_kind {
287            SchemaKind::Type(Type::String(_)) => "test-value".to_string(),
288            SchemaKind::Type(Type::Number(_)) => "42.0".to_string(),
289            SchemaKind::Type(Type::Integer(_)) => "42".to_string(),
290            SchemaKind::Type(Type::Boolean(_)) => "true".to_string(),
291            _ => "test-value".to_string(),
292        }
293    }
294}
295
296#[cfg(test)]
297mod tests {
298    use super::*;
299    use openapiv3::Operation;
300
301    // Round 51 (#79) — a string property with an enum must generate a VALID
302    // member, not the invalid literal "test-string".
303    #[test]
304    fn generate_string_value_uses_enum_member() {
305        use openapiv3::{Schema, SchemaData, SchemaKind, StringType, Type};
306        let st = StringType {
307            enumeration: vec![Some("EVALUATION".into()), Some("PAYG".into())],
308            ..Default::default()
309        };
310        let schema = Schema {
311            schema_data: SchemaData::default(),
312            schema_kind: SchemaKind::Type(Type::String(st)),
313        };
314        assert_eq!(RequestGenerator::generate_string_value(&schema), json!("EVALUATION"));
315
316        // No enum -> the generic filler is fine.
317        let plain = Schema {
318            schema_data: SchemaData::default(),
319            schema_kind: SchemaKind::Type(Type::String(StringType::default())),
320        };
321        assert_eq!(RequestGenerator::generate_string_value(&plain), json!("test-string"));
322    }
323
324    #[test]
325    fn test_generate_path() {
326        let op = ApiOperation {
327            method: "get".to_string(),
328            path: "/users/{id}".to_string(),
329            operation: Operation::default(),
330            operation_id: None,
331        };
332
333        let mut template = RequestTemplate {
334            operation: op,
335            path_params: HashMap::new(),
336            query_params: HashMap::new(),
337            headers: HashMap::new(),
338            body: None,
339        };
340
341        template.path_params.insert("id".to_string(), "123".to_string());
342        template.query_params.insert("limit".to_string(), "10".to_string());
343
344        let path = template.generate_path();
345        assert_eq!(path, "/users/123?limit=10");
346    }
347
348    #[test]
349    fn test_default_param_value() {
350        assert_eq!(RequestGenerator::default_param_value("id"), "1");
351        assert_eq!(RequestGenerator::default_param_value("limit"), "10");
352        assert_eq!(RequestGenerator::default_param_value("unknown"), "test-value");
353    }
354}
mockforge_bench/request_gen.rs

mockforge_bench/
request_gen.rs
