1use crate::swagger_convert;
9use mockforge_foundation::error::{Error, Result};
10use openapiv3::{OpenAPI, ReferenceOr, Schema};
11use std::collections::HashSet;
12use std::path::Path;
13use tokio::fs;
14use tracing;
15
16#[derive(Debug, Clone)]
18pub struct OpenApiSpec {
19 pub spec: OpenAPI,
21 pub file_path: Option<String>,
23 pub raw_document: Option<serde_json::Value>,
25}
26
27impl OpenApiSpec {
28 pub async fn from_file<P: AsRef<Path>>(path: P) -> Result<Self> {
33 let path_ref = path.as_ref();
34 let content = fs::read_to_string(path_ref)
35 .await
36 .map_err(|e| Error::io_with_context("reading OpenAPI spec file", e.to_string()))?;
37
38 let raw_json = if path_ref.extension().and_then(|s| s.to_str()) == Some("yaml")
39 || path_ref.extension().and_then(|s| s.to_str()) == Some("yml")
40 {
41 let yaml_value: serde_yaml::Value = serde_yaml::from_str(&content)
42 .map_err(|e| Error::config(format!("Failed to parse YAML OpenAPI spec: {}", e)))?;
43 serde_json::to_value(&yaml_value).map_err(|e| {
44 Error::config(format!("Failed to convert YAML OpenAPI spec to JSON: {}", e))
45 })?
46 } else {
47 serde_json::from_str(&content)
48 .map_err(|e| Error::config(format!("Failed to parse JSON OpenAPI spec: {}", e)))?
49 };
50
51 let (raw_document, spec) = if swagger_convert::is_swagger_2(&raw_json) {
53 tracing::info!("Detected Swagger 2.0 specification, converting to OpenAPI 3.0");
54 let converted =
55 swagger_convert::convert_swagger_to_openapi3(&raw_json).map_err(|e| {
56 Error::config(format!("Failed to convert Swagger 2.0 to OpenAPI 3.0: {}", e))
57 })?;
58 let spec: OpenAPI = serde_json::from_value(converted.clone()).map_err(|e| {
59 Error::config(format!("Failed to parse converted OpenAPI spec: {}", e))
60 })?;
61 (converted, spec)
62 } else {
63 let spec: OpenAPI = serde_json::from_value(raw_json.clone()).map_err(|e| {
64 let error_str = format!("{}", e);
66 let mut error_msg = format!("Failed to read OpenAPI spec: {}", e);
67
68 if error_str.contains("missing field") {
70 tracing::error!("OpenAPI deserialization error: {}", error_str);
71
72 if let Some(info) = raw_json.get("info") {
74 if let Some(info_obj) = info.as_object() {
75 let has_desc = info_obj.contains_key("description");
76 error_msg
77 .push_str(&format!(" | Info.description present: {}", has_desc));
78 }
79 }
80 if let Some(servers) = raw_json.get("servers") {
81 if let Some(servers_arr) = servers.as_array() {
82 error_msg.push_str(&format!(" | Servers count: {}", servers_arr.len()));
83 }
84 }
85 }
86
87 Error::config(error_msg)
88 })?;
89 (raw_json, spec)
90 };
91
92 Ok(Self {
93 spec,
94 file_path: path_ref.to_str().map(|s| s.to_string()),
95 raw_document: Some(raw_document),
96 })
97 }
98
99 pub fn from_string(content: &str, format: Option<&str>) -> Result<Self> {
104 let raw_json = if format == Some("yaml") || format == Some("yml") {
105 let yaml_value: serde_yaml::Value = serde_yaml::from_str(content)
106 .map_err(|e| Error::config(format!("Failed to parse YAML OpenAPI spec: {}", e)))?;
107 serde_json::to_value(&yaml_value).map_err(|e| {
108 Error::config(format!("Failed to convert YAML OpenAPI spec to JSON: {}", e))
109 })?
110 } else {
111 serde_json::from_str(content)
112 .map_err(|e| Error::config(format!("Failed to parse JSON OpenAPI spec: {}", e)))?
113 };
114
115 let (raw_document, spec) = if swagger_convert::is_swagger_2(&raw_json) {
117 let converted =
118 swagger_convert::convert_swagger_to_openapi3(&raw_json).map_err(|e| {
119 Error::config(format!("Failed to convert Swagger 2.0 to OpenAPI 3.0: {}", e))
120 })?;
121 let spec: OpenAPI = serde_json::from_value(converted.clone()).map_err(|e| {
122 Error::config(format!("Failed to parse converted OpenAPI spec: {}", e))
123 })?;
124 (converted, spec)
125 } else {
126 let spec: OpenAPI = serde_json::from_value(raw_json.clone())
127 .map_err(|e| Error::io_with_context("reading OpenAPI spec", e.to_string()))?;
128 (raw_json, spec)
129 };
130
131 Ok(Self {
132 spec,
133 file_path: None,
134 raw_document: Some(raw_document),
135 })
136 }
137
138 pub fn from_json(json: serde_json::Value) -> Result<Self> {
143 let (raw_document, spec) = if swagger_convert::is_swagger_2(&json) {
145 let converted = swagger_convert::convert_swagger_to_openapi3(&json).map_err(|e| {
146 Error::config(format!("Failed to convert Swagger 2.0 to OpenAPI 3.0: {}", e))
147 })?;
148 let spec: OpenAPI = serde_json::from_value(converted.clone()).map_err(|e| {
149 Error::config(format!("Failed to parse converted OpenAPI spec: {}", e))
150 })?;
151 (converted, spec)
152 } else {
153 let json_for_doc = json.clone();
154 let spec: OpenAPI = serde_json::from_value(json)
155 .map_err(|e| Error::config(format!("Failed to parse JSON OpenAPI spec: {}", e)))?;
156 (json_for_doc, spec)
157 };
158
159 Ok(Self {
160 spec,
161 file_path: None,
162 raw_document: Some(raw_document),
163 })
164 }
165
166 pub fn validate(&self) -> Result<()> {
171 if self.spec.paths.paths.is_empty() {
173 return Err(Error::validation("OpenAPI spec must contain at least one path"));
174 }
175
176 if self.spec.info.title.is_empty() {
178 return Err(Error::validation("OpenAPI spec info must have a title"));
179 }
180
181 if self.spec.info.version.is_empty() {
182 return Err(Error::validation("OpenAPI spec info must have a version"));
183 }
184
185 Ok(())
186 }
187
188 pub fn validate_enhanced(&self) -> crate::spec_parser::ValidationResult {
190 if let Some(raw) = &self.raw_document {
192 let format = if raw.get("swagger").is_some() {
193 crate::spec_parser::SpecFormat::OpenApi20
194 } else if let Some(version) = raw.get("openapi").and_then(|v| v.as_str()) {
195 if version.starts_with("3.1") {
196 crate::spec_parser::SpecFormat::OpenApi31
197 } else {
198 crate::spec_parser::SpecFormat::OpenApi30
199 }
200 } else {
201 crate::spec_parser::SpecFormat::OpenApi30
203 };
204 crate::spec_parser::OpenApiValidator::validate(raw, format)
205 } else {
206 crate::spec_parser::ValidationResult::failure(vec![
208 crate::spec_parser::ValidationError::new(
209 "Cannot perform enhanced validation without raw document".to_string(),
210 ),
211 ])
212 }
213 }
214
215 pub fn version(&self) -> &str {
217 &self.spec.openapi
218 }
219
220 pub fn title(&self) -> &str {
222 &self.spec.info.title
223 }
224
225 pub fn description(&self) -> Option<&str> {
227 self.spec.info.description.as_deref()
228 }
229
230 pub fn api_version(&self) -> &str {
232 &self.spec.info.version
233 }
234
235 pub fn servers(&self) -> &[openapiv3::Server] {
237 &self.spec.servers
238 }
239
240 pub fn paths(&self) -> &openapiv3::Paths {
242 &self.spec.paths
243 }
244
245 pub fn schemas(&self) -> Option<&indexmap::IndexMap<String, ReferenceOr<Schema>>> {
247 self.spec.components.as_ref().map(|c| &c.schemas)
248 }
249
250 pub fn security_schemes(
252 &self,
253 ) -> Option<&indexmap::IndexMap<String, ReferenceOr<openapiv3::SecurityScheme>>> {
254 self.spec.components.as_ref().map(|c| &c.security_schemes)
255 }
256
257 pub fn operations_for_path(
259 &self,
260 path: &str,
261 ) -> std::collections::HashMap<String, openapiv3::Operation> {
262 let mut operations = std::collections::HashMap::new();
263
264 if let Some(path_item_ref) = self.spec.paths.paths.get(path) {
265 if let Some(path_item) = path_item_ref.as_item() {
267 let resolved_path_params: Vec<ReferenceOr<openapiv3::Parameter>> =
285 path_item.parameters.iter().map(|p| self.resolve_parameter_ref(p)).collect();
286 let merge = |op: &openapiv3::Operation| -> openapiv3::Operation {
287 let mut resolved_op = op.clone();
289 resolved_op.parameters =
290 op.parameters.iter().map(|p| self.resolve_parameter_ref(p)).collect();
291 merge_path_params_into_operation(&resolved_op, &resolved_path_params)
292 };
293 if let Some(op) = &path_item.get {
294 operations.insert("GET".to_string(), merge(op));
295 }
296 if let Some(op) = &path_item.post {
297 operations.insert("POST".to_string(), merge(op));
298 }
299 if let Some(op) = &path_item.put {
300 operations.insert("PUT".to_string(), merge(op));
301 }
302 if let Some(op) = &path_item.delete {
303 operations.insert("DELETE".to_string(), merge(op));
304 }
305 if let Some(op) = &path_item.patch {
306 operations.insert("PATCH".to_string(), merge(op));
307 }
308 if let Some(op) = &path_item.head {
309 operations.insert("HEAD".to_string(), merge(op));
310 }
311 if let Some(op) = &path_item.options {
312 operations.insert("OPTIONS".to_string(), merge(op));
313 }
314 if let Some(op) = &path_item.trace {
315 operations.insert("TRACE".to_string(), merge(op));
316 }
317 }
318 }
319
320 operations
321 }
322
323 pub fn all_paths_and_operations(
325 &self,
326 ) -> std::collections::HashMap<String, std::collections::HashMap<String, openapiv3::Operation>>
327 {
328 self.spec
329 .paths
330 .paths
331 .iter()
332 .map(|(path, _)| (path.clone(), self.operations_for_path(path)))
333 .collect()
334 }
335
336 pub fn get_schema(&self, reference: &str) -> Option<crate::schema::OpenApiSchema> {
338 self.resolve_schema(reference).map(crate::schema::OpenApiSchema::new)
339 }
340
341 pub fn resolve_schema_ref(&self, reference: &str) -> Option<Schema> {
346 self.resolve_schema(reference)
347 }
348
349 pub fn resolve_parameter_ref(
363 &self,
364 p_ref: &ReferenceOr<openapiv3::Parameter>,
365 ) -> ReferenceOr<openapiv3::Parameter> {
366 match p_ref {
367 ReferenceOr::Item(_) => p_ref.clone(),
368 ReferenceOr::Reference { reference } => {
369 let Some(name) = reference.strip_prefix("#/components/parameters/") else {
370 return p_ref.clone();
371 };
372 let Some(components) = self.spec.components.as_ref() else {
373 return p_ref.clone();
374 };
375 match components.parameters.get(name) {
376 Some(ReferenceOr::Item(p)) => ReferenceOr::Item(p.clone()),
377 Some(ReferenceOr::Reference { reference: nested }) => {
378 let Some(nested_name) = nested.strip_prefix("#/components/parameters/")
381 else {
382 return p_ref.clone();
383 };
384 match components.parameters.get(nested_name) {
385 Some(ReferenceOr::Item(p)) => ReferenceOr::Item(p.clone()),
386 _ => p_ref.clone(),
387 }
388 }
389 None => p_ref.clone(),
390 }
391 }
392 }
393 }
394
395 pub fn validate_security_requirements(
397 &self,
398 security_requirements: &[openapiv3::SecurityRequirement],
399 auth_header: Option<&str>,
400 api_key: Option<&str>,
401 ) -> Result<()> {
402 if security_requirements.is_empty() {
403 return Ok(());
404 }
405
406 for requirement in security_requirements {
408 if self.is_security_requirement_satisfied(requirement, auth_header, api_key)? {
409 return Ok(());
410 }
411 }
412
413 Err(Error::validation(
414 "Security validation failed: no valid authentication provided",
415 ))
416 }
417
418 fn resolve_schema(&self, reference: &str) -> Option<Schema> {
419 let mut visited = HashSet::new();
420 self.resolve_schema_recursive(reference, &mut visited)
421 }
422
423 fn resolve_schema_recursive(
424 &self,
425 reference: &str,
426 visited: &mut HashSet<String>,
427 ) -> Option<Schema> {
428 if !visited.insert(reference.to_string()) {
429 tracing::warn!("Detected recursive schema reference: {}", reference);
430 return None;
431 }
432
433 let schema_name = reference.strip_prefix("#/components/schemas/")?;
434 let components = self.spec.components.as_ref()?;
435 let schema_ref = components.schemas.get(schema_name)?;
436
437 match schema_ref {
438 ReferenceOr::Item(schema) => Some(schema.clone()),
439 ReferenceOr::Reference { reference: nested } => {
440 self.resolve_schema_recursive(nested, visited)
441 }
442 }
443 }
444
445 fn is_security_requirement_satisfied(
447 &self,
448 requirement: &openapiv3::SecurityRequirement,
449 auth_header: Option<&str>,
450 api_key: Option<&str>,
451 ) -> Result<bool> {
452 for (scheme_name, _scopes) in requirement {
454 if !self.is_security_scheme_satisfied(scheme_name, auth_header, api_key)? {
455 return Ok(false);
456 }
457 }
458 Ok(true)
459 }
460
461 fn is_security_scheme_satisfied(
463 &self,
464 scheme_name: &str,
465 auth_header: Option<&str>,
466 api_key: Option<&str>,
467 ) -> Result<bool> {
468 let security_schemes = match self.security_schemes() {
469 Some(schemes) => schemes,
470 None => return Ok(false),
471 };
472
473 let scheme = match security_schemes.get(scheme_name) {
474 Some(scheme) => scheme,
475 None => {
476 return Err(Error::config(format!("Security scheme '{}' not found", scheme_name)))
477 }
478 };
479
480 let scheme = match scheme {
481 ReferenceOr::Item(s) => s,
482 ReferenceOr::Reference { reference } => {
483 let ref_name =
485 reference.strip_prefix("#/components/securitySchemes/").ok_or_else(|| {
486 Error::config(format!(
487 "Unsupported security scheme reference format: {}",
488 reference
489 ))
490 })?;
491 match security_schemes.get(ref_name) {
492 Some(ReferenceOr::Item(resolved)) => resolved,
493 Some(ReferenceOr::Reference { .. }) => {
494 return Err(Error::config(format!(
495 "Nested security scheme reference not supported: {}",
496 ref_name
497 )))
498 }
499 None => {
500 return Err(Error::config(format!(
501 "Security scheme '{}' not found",
502 ref_name
503 )))
504 }
505 }
506 }
507 };
508
509 match scheme {
510 openapiv3::SecurityScheme::HTTP { scheme, .. } => {
511 match scheme.as_str() {
512 "bearer" => match auth_header {
513 Some(header) if header.starts_with("Bearer ") => Ok(true),
514 _ => Ok(false),
515 },
516 "basic" => match auth_header {
517 Some(header) if header.starts_with("Basic ") => Ok(true),
518 _ => Ok(false),
519 },
520 _ => Ok(false), }
522 }
523 openapiv3::SecurityScheme::APIKey { location, .. } => match location {
524 openapiv3::APIKeyLocation::Header => Ok(auth_header.is_some()),
525 openapiv3::APIKeyLocation::Query => Ok(api_key.is_some()),
526 openapiv3::APIKeyLocation::Cookie => Ok(api_key.is_some()),
527 },
528 openapiv3::SecurityScheme::OpenIDConnect { .. } => {
529 match auth_header {
531 Some(header) if header.starts_with("Bearer ") => Ok(true),
532 _ => Ok(false),
533 }
534 }
535 openapiv3::SecurityScheme::OAuth2 { .. } => {
536 match auth_header {
538 Some(header) if header.starts_with("Bearer ") => Ok(true),
539 _ => Ok(false),
540 }
541 }
542 }
543 }
544
545 pub fn get_global_security_requirements(&self) -> Vec<openapiv3::SecurityRequirement> {
547 self.spec.security.clone().unwrap_or_default()
548 }
549
550 pub fn get_request_body(&self, reference: &str) -> Option<&openapiv3::RequestBody> {
552 if let Some(components) = &self.spec.components {
553 if let Some(param_name) = reference.strip_prefix("#/components/requestBodies/") {
554 if let Some(request_body_ref) = components.request_bodies.get(param_name) {
555 return request_body_ref.as_item();
556 }
557 }
558 }
559 None
560 }
561
562 pub fn get_response(&self, reference: &str) -> Option<&openapiv3::Response> {
564 if let Some(components) = &self.spec.components {
565 if let Some(response_name) = reference.strip_prefix("#/components/responses/") {
566 if let Some(response_ref) = components.responses.get(response_name) {
567 return response_ref.as_item();
568 }
569 }
570 }
571 None
572 }
573
574 pub fn get_example(&self, reference: &str) -> Option<&openapiv3::Example> {
576 if let Some(components) = &self.spec.components {
577 if let Some(example_name) = reference.strip_prefix("#/components/examples/") {
578 if let Some(example_ref) = components.examples.get(example_name) {
579 return example_ref.as_item();
580 }
581 }
582 }
583 None
584 }
585}
586
587pub(crate) fn merge_path_params_into_operation(
596 operation: &openapiv3::Operation,
597 path_level_params: &[ReferenceOr<openapiv3::Parameter>],
598) -> openapiv3::Operation {
599 use std::collections::HashSet;
600 if path_level_params.is_empty() {
601 return operation.clone();
602 }
603 let mut op_keys: HashSet<(String, String)> = HashSet::new();
604 for p_ref in &operation.parameters {
605 if let Some(key) = parameter_key(p_ref) {
606 op_keys.insert(key);
607 }
608 }
609 let mut merged: Vec<ReferenceOr<openapiv3::Parameter>> =
610 Vec::with_capacity(path_level_params.len() + operation.parameters.len());
611 for p_ref in path_level_params {
612 match parameter_key(p_ref) {
613 Some(key) if op_keys.contains(&key) => {}
614 _ => merged.push(p_ref.clone()),
615 }
616 }
617 merged.extend(operation.parameters.iter().cloned());
618 let mut cloned = operation.clone();
619 cloned.parameters = merged;
620 cloned
621}
622
623fn parameter_key(p_ref: &ReferenceOr<openapiv3::Parameter>) -> Option<(String, String)> {
624 let p = p_ref.as_item()?;
625 let (name, in_loc) = match p {
626 openapiv3::Parameter::Path { parameter_data, .. } => (parameter_data.name.clone(), "path"),
627 openapiv3::Parameter::Query { parameter_data, .. } => {
628 (parameter_data.name.clone(), "query")
629 }
630 openapiv3::Parameter::Header { parameter_data, .. } => {
631 (parameter_data.name.clone(), "header")
632 }
633 openapiv3::Parameter::Cookie { parameter_data, .. } => {
634 (parameter_data.name.clone(), "cookie")
635 }
636 };
637 Some((name, in_loc.to_string()))
638}
639
640#[cfg(test)]
641mod tests {
642 use super::*;
643 use openapiv3::{SchemaKind, Type};
644
645 #[test]
646 fn resolves_security_scheme_ref() {
647 let yaml = r#"
648openapi: 3.0.3
649info:
650 title: Test API
651 version: "1.0.0"
652paths:
653 /test:
654 get:
655 security:
656 - BearerRef: []
657 responses:
658 '200':
659 description: OK
660components:
661 securitySchemes:
662 BearerAuth:
663 type: http
664 scheme: bearer
665 BearerRef:
666 $ref: '#/components/securitySchemes/BearerAuth'
667 "#;
668
669 let spec = OpenApiSpec::from_string(yaml, Some("yaml")).expect("spec parses");
670
671 let result = spec
673 .is_security_scheme_satisfied("BearerRef", Some("Bearer token123"), None)
674 .expect("should resolve ref");
675 assert!(result);
676
677 let result = spec
679 .is_security_scheme_satisfied("BearerRef", None, None)
680 .expect("should resolve ref");
681 assert!(!result);
682 }
683
684 #[test]
685 fn resolves_nested_schema_references() {
686 let yaml = r#"
687openapi: 3.0.3
688info:
689 title: Test API
690 version: "1.0.0"
691paths: {}
692components:
693 schemas:
694 Apiary:
695 type: object
696 properties:
697 id:
698 type: string
699 hive:
700 $ref: '#/components/schemas/Hive'
701 Hive:
702 type: object
703 properties:
704 name:
705 type: string
706 HiveWrapper:
707 $ref: '#/components/schemas/Hive'
708 "#;
709
710 let spec = OpenApiSpec::from_string(yaml, Some("yaml")).expect("spec parses");
711
712 let apiary = spec.get_schema("#/components/schemas/Apiary").expect("resolve apiary schema");
713 assert!(matches!(apiary.schema.schema_kind, SchemaKind::Type(Type::Object(_))));
714
715 let wrapper = spec
716 .get_schema("#/components/schemas/HiveWrapper")
717 .expect("resolve wrapper schema");
718 assert!(matches!(wrapper.schema.schema_kind, SchemaKind::Type(Type::Object(_))));
719 }
720}