1use super::generator::ConformanceConfig;
7use super::schema_validator::SchemaValidatorGenerator;
8use super::spec::ConformanceFeature;
9use crate::error::Result;
10use crate::request_gen::RequestGenerator;
11use crate::spec_parser::ApiOperation;
12use openapiv3::{
13 OpenAPI, Operation, Parameter, ParameterSchemaOrContent, ReferenceOr, RequestBody, Response,
14 Schema, SchemaKind, SecurityScheme, StringFormat, Type, VariantOrUnknownOrEmpty,
15};
16use std::collections::HashSet;
17
18mod ref_resolver {
20 use super::*;
21
22 pub fn resolve_parameter<'a>(
23 param_ref: &'a ReferenceOr<Parameter>,
24 spec: &'a OpenAPI,
25 ) -> Option<&'a Parameter> {
26 match param_ref {
27 ReferenceOr::Item(param) => Some(param),
28 ReferenceOr::Reference { reference } => {
29 let name = reference.strip_prefix("#/components/parameters/")?;
30 let components = spec.components.as_ref()?;
31 match components.parameters.get(name)? {
32 ReferenceOr::Item(param) => Some(param),
33 ReferenceOr::Reference { .. } => None, }
35 }
36 }
37 }
38
39 pub fn resolve_request_body<'a>(
40 body_ref: &'a ReferenceOr<RequestBody>,
41 spec: &'a OpenAPI,
42 ) -> Option<&'a RequestBody> {
43 match body_ref {
44 ReferenceOr::Item(body) => Some(body),
45 ReferenceOr::Reference { reference } => {
46 let name = reference.strip_prefix("#/components/requestBodies/")?;
47 let components = spec.components.as_ref()?;
48 match components.request_bodies.get(name)? {
49 ReferenceOr::Item(body) => Some(body),
50 ReferenceOr::Reference { .. } => None,
51 }
52 }
53 }
54 }
55
56 pub fn resolve_schema<'a>(
57 schema_ref: &'a ReferenceOr<Schema>,
58 spec: &'a OpenAPI,
59 ) -> Option<&'a Schema> {
60 resolve_schema_with_visited(schema_ref, spec, &mut HashSet::new())
61 }
62
63 fn resolve_schema_with_visited<'a>(
64 schema_ref: &'a ReferenceOr<Schema>,
65 spec: &'a OpenAPI,
66 visited: &mut HashSet<String>,
67 ) -> Option<&'a Schema> {
68 match schema_ref {
69 ReferenceOr::Item(schema) => Some(schema),
70 ReferenceOr::Reference { reference } => {
71 if !visited.insert(reference.clone()) {
72 return None; }
74 let name = reference.strip_prefix("#/components/schemas/")?;
75 let components = spec.components.as_ref()?;
76 let nested = components.schemas.get(name)?;
77 resolve_schema_with_visited(nested, spec, visited)
78 }
79 }
80 }
81
82 pub fn resolve_boxed_schema<'a>(
84 schema_ref: &'a ReferenceOr<Box<Schema>>,
85 spec: &'a OpenAPI,
86 ) -> Option<&'a Schema> {
87 match schema_ref {
88 ReferenceOr::Item(schema) => Some(schema.as_ref()),
89 ReferenceOr::Reference { reference } => {
90 let name = reference.strip_prefix("#/components/schemas/")?;
92 let components = spec.components.as_ref()?;
93 let nested = components.schemas.get(name)?;
94 resolve_schema_with_visited(nested, spec, &mut HashSet::new())
95 }
96 }
97 }
98
99 pub fn resolve_response<'a>(
100 resp_ref: &'a ReferenceOr<Response>,
101 spec: &'a OpenAPI,
102 ) -> Option<&'a Response> {
103 match resp_ref {
104 ReferenceOr::Item(resp) => Some(resp),
105 ReferenceOr::Reference { reference } => {
106 let name = reference.strip_prefix("#/components/responses/")?;
107 let components = spec.components.as_ref()?;
108 match components.responses.get(name)? {
109 ReferenceOr::Item(resp) => Some(resp),
110 ReferenceOr::Reference { .. } => None,
111 }
112 }
113 }
114 }
115}
116
117#[derive(Debug, Clone)]
119pub struct AnnotatedOperation {
120 pub path: String,
121 pub method: String,
122 pub features: Vec<ConformanceFeature>,
123 pub request_body_content_type: Option<String>,
124 pub sample_body: Option<String>,
125 pub query_params: Vec<(String, String)>,
126 pub header_params: Vec<(String, String)>,
127 pub path_params: Vec<(String, String)>,
128 pub response_schema: Option<Schema>,
130}
131
132pub struct SpecDrivenConformanceGenerator {
134 config: ConformanceConfig,
135 operations: Vec<AnnotatedOperation>,
136}
137
138impl SpecDrivenConformanceGenerator {
139 pub fn new(config: ConformanceConfig, operations: Vec<AnnotatedOperation>) -> Self {
140 Self { config, operations }
141 }
142
143 pub fn annotate_operations(
145 operations: &[ApiOperation],
146 spec: &OpenAPI,
147 ) -> Vec<AnnotatedOperation> {
148 operations.iter().map(|op| Self::annotate_operation(op, spec)).collect()
149 }
150
151 fn annotate_operation(op: &ApiOperation, spec: &OpenAPI) -> AnnotatedOperation {
153 let mut features = Vec::new();
154 let mut query_params = Vec::new();
155 let mut header_params = Vec::new();
156 let mut path_params = Vec::new();
157
158 match op.method.to_uppercase().as_str() {
160 "GET" => features.push(ConformanceFeature::MethodGet),
161 "POST" => features.push(ConformanceFeature::MethodPost),
162 "PUT" => features.push(ConformanceFeature::MethodPut),
163 "PATCH" => features.push(ConformanceFeature::MethodPatch),
164 "DELETE" => features.push(ConformanceFeature::MethodDelete),
165 "HEAD" => features.push(ConformanceFeature::MethodHead),
166 "OPTIONS" => features.push(ConformanceFeature::MethodOptions),
167 _ => {}
168 }
169
170 for param_ref in &op.operation.parameters {
172 if let Some(param) = ref_resolver::resolve_parameter(param_ref, spec) {
173 Self::annotate_parameter(
174 param,
175 spec,
176 &mut features,
177 &mut query_params,
178 &mut header_params,
179 &mut path_params,
180 );
181 }
182 }
183
184 for segment in op.path.split('/') {
186 if segment.starts_with('{') && segment.ends_with('}') {
187 let name = &segment[1..segment.len() - 1];
188 if !path_params.iter().any(|(n, _)| n == name) {
190 path_params.push((name.to_string(), "test-value".to_string()));
191 if !features.contains(&ConformanceFeature::PathParamString)
193 && !features.contains(&ConformanceFeature::PathParamInteger)
194 {
195 features.push(ConformanceFeature::PathParamString);
196 }
197 }
198 }
199 }
200
201 let mut request_body_content_type = None;
203 let mut sample_body = None;
204
205 let resolved_body = op
206 .operation
207 .request_body
208 .as_ref()
209 .and_then(|b| ref_resolver::resolve_request_body(b, spec));
210
211 if let Some(body) = resolved_body {
212 for (content_type, _media) in &body.content {
213 match content_type.as_str() {
214 "application/json" => {
215 features.push(ConformanceFeature::BodyJson);
216 request_body_content_type = Some("application/json".to_string());
217 if let Ok(template) = RequestGenerator::generate_template(op) {
219 if let Some(body_val) = &template.body {
220 sample_body = Some(body_val.to_string());
221 }
222 }
223 }
224 "application/x-www-form-urlencoded" => {
225 features.push(ConformanceFeature::BodyFormUrlencoded);
226 request_body_content_type =
227 Some("application/x-www-form-urlencoded".to_string());
228 }
229 "multipart/form-data" => {
230 features.push(ConformanceFeature::BodyMultipart);
231 request_body_content_type = Some("multipart/form-data".to_string());
232 }
233 _ => {}
234 }
235 }
236
237 if let Some(media) = body.content.get("application/json") {
239 if let Some(schema_ref) = &media.schema {
240 if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
241 Self::annotate_schema(schema, spec, &mut features);
242 }
243 }
244 }
245 }
246
247 Self::annotate_responses(&op.operation, spec, &mut features);
249
250 let response_schema = Self::extract_response_schema(&op.operation, spec);
252 if response_schema.is_some() {
253 features.push(ConformanceFeature::ResponseValidation);
254 }
255
256 Self::annotate_content_negotiation(&op.operation, spec, &mut features);
258
259 Self::annotate_security(&op.operation, spec, &mut features);
261
262 features.sort_by_key(|f| f.check_name());
264 features.dedup_by_key(|f| f.check_name());
265
266 AnnotatedOperation {
267 path: op.path.clone(),
268 method: op.method.to_uppercase(),
269 features,
270 request_body_content_type,
271 sample_body,
272 query_params,
273 header_params,
274 path_params,
275 response_schema,
276 }
277 }
278
279 fn annotate_parameter(
281 param: &Parameter,
282 spec: &OpenAPI,
283 features: &mut Vec<ConformanceFeature>,
284 query_params: &mut Vec<(String, String)>,
285 header_params: &mut Vec<(String, String)>,
286 path_params: &mut Vec<(String, String)>,
287 ) {
288 let (location, data) = match param {
289 Parameter::Query { parameter_data, .. } => ("query", parameter_data),
290 Parameter::Path { parameter_data, .. } => ("path", parameter_data),
291 Parameter::Header { parameter_data, .. } => ("header", parameter_data),
292 Parameter::Cookie { .. } => {
293 features.push(ConformanceFeature::CookieParam);
294 return;
295 }
296 };
297
298 let is_integer = Self::param_schema_is_integer(data, spec);
300 let is_array = Self::param_schema_is_array(data, spec);
301
302 let sample = if is_integer {
304 "42".to_string()
305 } else if is_array {
306 "a,b".to_string()
307 } else {
308 "test-value".to_string()
309 };
310
311 match location {
312 "path" => {
313 if is_integer {
314 features.push(ConformanceFeature::PathParamInteger);
315 } else {
316 features.push(ConformanceFeature::PathParamString);
317 }
318 path_params.push((data.name.clone(), sample));
319 }
320 "query" => {
321 if is_array {
322 features.push(ConformanceFeature::QueryParamArray);
323 } else if is_integer {
324 features.push(ConformanceFeature::QueryParamInteger);
325 } else {
326 features.push(ConformanceFeature::QueryParamString);
327 }
328 query_params.push((data.name.clone(), sample));
329 }
330 "header" => {
331 features.push(ConformanceFeature::HeaderParam);
332 header_params.push((data.name.clone(), sample));
333 }
334 _ => {}
335 }
336
337 if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
339 if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
340 Self::annotate_schema(schema, spec, features);
341 }
342 }
343
344 if data.required {
346 features.push(ConformanceFeature::ConstraintRequired);
347 } else {
348 features.push(ConformanceFeature::ConstraintOptional);
349 }
350 }
351
352 fn param_schema_is_integer(data: &openapiv3::ParameterData, spec: &OpenAPI) -> bool {
353 if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
354 if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
355 return matches!(&schema.schema_kind, SchemaKind::Type(Type::Integer(_)));
356 }
357 }
358 false
359 }
360
361 fn param_schema_is_array(data: &openapiv3::ParameterData, spec: &OpenAPI) -> bool {
362 if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
363 if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
364 return matches!(&schema.schema_kind, SchemaKind::Type(Type::Array(_)));
365 }
366 }
367 false
368 }
369
370 fn annotate_schema(schema: &Schema, spec: &OpenAPI, features: &mut Vec<ConformanceFeature>) {
372 match &schema.schema_kind {
373 SchemaKind::Type(Type::String(s)) => {
374 features.push(ConformanceFeature::SchemaString);
375 match &s.format {
377 VariantOrUnknownOrEmpty::Item(StringFormat::Date) => {
378 features.push(ConformanceFeature::FormatDate);
379 }
380 VariantOrUnknownOrEmpty::Item(StringFormat::DateTime) => {
381 features.push(ConformanceFeature::FormatDateTime);
382 }
383 VariantOrUnknownOrEmpty::Unknown(fmt) => match fmt.as_str() {
384 "email" => features.push(ConformanceFeature::FormatEmail),
385 "uuid" => features.push(ConformanceFeature::FormatUuid),
386 "uri" | "url" => features.push(ConformanceFeature::FormatUri),
387 "ipv4" => features.push(ConformanceFeature::FormatIpv4),
388 "ipv6" => features.push(ConformanceFeature::FormatIpv6),
389 _ => {}
390 },
391 _ => {}
392 }
393 if s.pattern.is_some() {
395 features.push(ConformanceFeature::ConstraintPattern);
396 }
397 if !s.enumeration.is_empty() {
398 features.push(ConformanceFeature::ConstraintEnum);
399 }
400 if s.min_length.is_some() || s.max_length.is_some() {
401 features.push(ConformanceFeature::ConstraintMinMax);
402 }
403 }
404 SchemaKind::Type(Type::Integer(i)) => {
405 features.push(ConformanceFeature::SchemaInteger);
406 if i.minimum.is_some() || i.maximum.is_some() {
407 features.push(ConformanceFeature::ConstraintMinMax);
408 }
409 if !i.enumeration.is_empty() {
410 features.push(ConformanceFeature::ConstraintEnum);
411 }
412 }
413 SchemaKind::Type(Type::Number(n)) => {
414 features.push(ConformanceFeature::SchemaNumber);
415 if n.minimum.is_some() || n.maximum.is_some() {
416 features.push(ConformanceFeature::ConstraintMinMax);
417 }
418 }
419 SchemaKind::Type(Type::Boolean(_)) => {
420 features.push(ConformanceFeature::SchemaBoolean);
421 }
422 SchemaKind::Type(Type::Array(arr)) => {
423 features.push(ConformanceFeature::SchemaArray);
424 if let Some(item_ref) = &arr.items {
425 if let Some(item_schema) = ref_resolver::resolve_boxed_schema(item_ref, spec) {
426 Self::annotate_schema(item_schema, spec, features);
427 }
428 }
429 }
430 SchemaKind::Type(Type::Object(obj)) => {
431 features.push(ConformanceFeature::SchemaObject);
432 if !obj.required.is_empty() {
434 features.push(ConformanceFeature::ConstraintRequired);
435 }
436 for (_name, prop_ref) in &obj.properties {
438 if let Some(prop_schema) = ref_resolver::resolve_boxed_schema(prop_ref, spec) {
439 Self::annotate_schema(prop_schema, spec, features);
440 }
441 }
442 }
443 SchemaKind::OneOf { .. } => {
444 features.push(ConformanceFeature::CompositionOneOf);
445 }
446 SchemaKind::AnyOf { .. } => {
447 features.push(ConformanceFeature::CompositionAnyOf);
448 }
449 SchemaKind::AllOf { .. } => {
450 features.push(ConformanceFeature::CompositionAllOf);
451 }
452 _ => {}
453 }
454 }
455
456 fn annotate_responses(
458 operation: &Operation,
459 spec: &OpenAPI,
460 features: &mut Vec<ConformanceFeature>,
461 ) {
462 for (status_code, resp_ref) in &operation.responses.responses {
463 if ref_resolver::resolve_response(resp_ref, spec).is_some() {
465 match status_code {
466 openapiv3::StatusCode::Code(200) => {
467 features.push(ConformanceFeature::Response200)
468 }
469 openapiv3::StatusCode::Code(201) => {
470 features.push(ConformanceFeature::Response201)
471 }
472 openapiv3::StatusCode::Code(204) => {
473 features.push(ConformanceFeature::Response204)
474 }
475 openapiv3::StatusCode::Code(400) => {
476 features.push(ConformanceFeature::Response400)
477 }
478 openapiv3::StatusCode::Code(404) => {
479 features.push(ConformanceFeature::Response404)
480 }
481 _ => {}
482 }
483 }
484 }
485 }
486
487 fn extract_response_schema(operation: &Operation, spec: &OpenAPI) -> Option<Schema> {
490 for code in [200u16, 201] {
492 if let Some(resp_ref) =
493 operation.responses.responses.get(&openapiv3::StatusCode::Code(code))
494 {
495 if let Some(response) = ref_resolver::resolve_response(resp_ref, spec) {
496 if let Some(media) = response.content.get("application/json") {
497 if let Some(schema_ref) = &media.schema {
498 if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
499 return Some(schema.clone());
500 }
501 }
502 }
503 }
504 }
505 }
506 None
507 }
508
509 fn annotate_content_negotiation(
511 operation: &Operation,
512 spec: &OpenAPI,
513 features: &mut Vec<ConformanceFeature>,
514 ) {
515 for (_status_code, resp_ref) in &operation.responses.responses {
516 if let Some(response) = ref_resolver::resolve_response(resp_ref, spec) {
517 if response.content.len() > 1 {
518 features.push(ConformanceFeature::ContentNegotiation);
519 return; }
521 }
522 }
523 }
524
525 fn annotate_security(
529 operation: &Operation,
530 spec: &OpenAPI,
531 features: &mut Vec<ConformanceFeature>,
532 ) {
533 let security_reqs = operation.security.as_ref().or(spec.security.as_ref());
535
536 if let Some(security) = security_reqs {
537 for security_req in security {
538 for scheme_name in security_req.keys() {
539 if let Some(resolved) = Self::resolve_security_scheme(scheme_name, spec) {
541 match resolved {
542 SecurityScheme::HTTP { ref scheme, .. } => {
543 if scheme.eq_ignore_ascii_case("bearer") {
544 features.push(ConformanceFeature::SecurityBearer);
545 } else if scheme.eq_ignore_ascii_case("basic") {
546 features.push(ConformanceFeature::SecurityBasic);
547 }
548 }
549 SecurityScheme::APIKey { .. } => {
550 features.push(ConformanceFeature::SecurityApiKey);
551 }
552 _ => {}
554 }
555 } else {
556 let name_lower = scheme_name.to_lowercase();
558 if name_lower.contains("bearer") || name_lower.contains("jwt") {
559 features.push(ConformanceFeature::SecurityBearer);
560 } else if name_lower.contains("api") && name_lower.contains("key") {
561 features.push(ConformanceFeature::SecurityApiKey);
562 } else if name_lower.contains("basic") {
563 features.push(ConformanceFeature::SecurityBasic);
564 }
565 }
566 }
567 }
568 }
569 }
570
571 fn resolve_security_scheme<'a>(name: &str, spec: &'a OpenAPI) -> Option<&'a SecurityScheme> {
573 let components = spec.components.as_ref()?;
574 match components.security_schemes.get(name)? {
575 ReferenceOr::Item(scheme) => Some(scheme),
576 ReferenceOr::Reference { .. } => None,
577 }
578 }
579
580 pub fn generate(&self) -> Result<String> {
582 let mut script = String::with_capacity(16384);
583
584 script.push_str("import http from 'k6/http';\n");
586 script.push_str("import { check, group } from 'k6';\n\n");
587
588 script.push_str("export const options = {\n");
590 script.push_str(" vus: 1,\n");
591 script.push_str(" iterations: 1,\n");
592 if self.config.skip_tls_verify {
593 script.push_str(" insecureSkipTLSVerify: true,\n");
594 }
595 script.push_str(" thresholds: {\n");
596 script.push_str(" checks: ['rate>0'],\n");
597 script.push_str(" },\n");
598 script.push_str("};\n\n");
599
600 script.push_str(&format!("const BASE_URL = '{}';\n\n", self.config.effective_base_url()));
602 script.push_str("const JSON_HEADERS = { 'Content-Type': 'application/json' };\n\n");
603
604 if self.config.has_custom_headers() {
606 script.push_str(&format!(
607 "const CUSTOM_HEADERS = {};\n\n",
608 self.config.custom_headers_js_object()
609 ));
610 }
611
612 script.push_str("export default function () {\n");
614
615 let mut category_ops: std::collections::BTreeMap<
617 &'static str,
618 Vec<(&AnnotatedOperation, &ConformanceFeature)>,
619 > = std::collections::BTreeMap::new();
620
621 for op in &self.operations {
622 for feature in &op.features {
623 let category = feature.category();
624 if self.config.should_include_category(category) {
625 category_ops.entry(category).or_default().push((op, feature));
626 }
627 }
628 }
629
630 for (category, ops) in &category_ops {
632 script.push_str(&format!(" group('{}', function () {{\n", category));
633
634 let mut emitted_checks: HashSet<&str> = HashSet::new();
636
637 for (op, feature) in ops {
638 if !emitted_checks.insert(feature.check_name()) {
639 continue; }
641
642 self.emit_check(&mut script, op, feature);
643 }
644
645 script.push_str(" });\n\n");
646 }
647
648 script.push_str("}\n\n");
649
650 self.generate_handle_summary(&mut script);
652
653 Ok(script)
654 }
655
656 fn emit_check(
658 &self,
659 script: &mut String,
660 op: &AnnotatedOperation,
661 feature: &ConformanceFeature,
662 ) {
663 script.push_str(" {\n");
664
665 let mut url_path = op.path.clone();
667 for (name, value) in &op.path_params {
668 url_path = url_path.replace(&format!("{{{}}}", name), value);
669 }
670
671 if !op.query_params.is_empty() {
673 let qs: Vec<String> =
674 op.query_params.iter().map(|(k, v)| format!("{}={}", k, v)).collect();
675 url_path = format!("{}?{}", url_path, qs.join("&"));
676 }
677
678 let full_url = format!("${{BASE_URL}}{}", url_path);
679
680 let effective_headers = self.effective_headers(&op.header_params);
683 let has_headers = !effective_headers.is_empty();
684 let headers_obj = if has_headers {
685 Self::format_headers(&effective_headers)
686 } else {
687 String::new()
688 };
689
690 match op.method.as_str() {
692 "GET" => {
693 if has_headers {
694 script.push_str(&format!(
695 " let res = http.get(`{}`, {{ headers: {} }});\n",
696 full_url, headers_obj
697 ));
698 } else {
699 script.push_str(&format!(" let res = http.get(`{}`);\n", full_url));
700 }
701 }
702 "POST" => {
703 self.emit_request_with_body(script, "post", &full_url, op, &effective_headers);
704 }
705 "PUT" => {
706 self.emit_request_with_body(script, "put", &full_url, op, &effective_headers);
707 }
708 "PATCH" => {
709 self.emit_request_with_body(script, "patch", &full_url, op, &effective_headers);
710 }
711 "DELETE" => {
712 if has_headers {
713 script.push_str(&format!(
714 " let res = http.del(`{}`, null, {{ headers: {} }});\n",
715 full_url, headers_obj
716 ));
717 } else {
718 script.push_str(&format!(" let res = http.del(`{}`);\n", full_url));
719 }
720 }
721 "HEAD" => {
722 if has_headers {
723 script.push_str(&format!(
724 " let res = http.head(`{}`, {{ headers: {} }});\n",
725 full_url, headers_obj
726 ));
727 } else {
728 script.push_str(&format!(" let res = http.head(`{}`);\n", full_url));
729 }
730 }
731 "OPTIONS" => {
732 if has_headers {
733 script.push_str(&format!(
734 " let res = http.options(`{}`, null, {{ headers: {} }});\n",
735 full_url, headers_obj
736 ));
737 } else {
738 script.push_str(&format!(" let res = http.options(`{}`);\n", full_url));
739 }
740 }
741 _ => {
742 if has_headers {
743 script.push_str(&format!(
744 " let res = http.get(`{}`, {{ headers: {} }});\n",
745 full_url, headers_obj
746 ));
747 } else {
748 script.push_str(&format!(" let res = http.get(`{}`);\n", full_url));
749 }
750 }
751 }
752
753 let check_name = feature.check_name();
755 if matches!(
756 feature,
757 ConformanceFeature::Response200
758 | ConformanceFeature::Response201
759 | ConformanceFeature::Response204
760 | ConformanceFeature::Response400
761 | ConformanceFeature::Response404
762 ) {
763 let expected_code = match feature {
764 ConformanceFeature::Response200 => 200,
765 ConformanceFeature::Response201 => 201,
766 ConformanceFeature::Response204 => 204,
767 ConformanceFeature::Response400 => 400,
768 ConformanceFeature::Response404 => 404,
769 _ => 200,
770 };
771 script.push_str(&format!(
772 " check(res, {{ '{}': (r) => r.status === {} }});\n",
773 check_name, expected_code
774 ));
775 } else if matches!(feature, ConformanceFeature::ResponseValidation) {
776 if let Some(schema) = &op.response_schema {
778 let validation_js = SchemaValidatorGenerator::generate_validation(schema);
779 script.push_str(&format!(
780 " try {{ let body = res.json(); check(res, {{ '{}': (r) => {{ {} }} }}); }} catch(e) {{ check(res, {{ '{}': () => false }}); }}\n",
781 check_name, validation_js, check_name
782 ));
783 }
784 } else {
785 script.push_str(&format!(
786 " check(res, {{ '{}': (r) => r.status >= 200 && r.status < 500 }});\n",
787 check_name
788 ));
789 }
790
791 script.push_str(" }\n");
792 }
793
794 fn emit_request_with_body(
796 &self,
797 script: &mut String,
798 method: &str,
799 url: &str,
800 op: &AnnotatedOperation,
801 effective_headers: &[(String, String)],
802 ) {
803 if let Some(body) = &op.sample_body {
804 let escaped_body = body.replace('\'', "\\'");
805 let headers = if !effective_headers.is_empty() {
806 format!(
807 "Object.assign({{}}, JSON_HEADERS, {})",
808 Self::format_headers(effective_headers)
809 )
810 } else {
811 "JSON_HEADERS".to_string()
812 };
813 script.push_str(&format!(
814 " let res = http.{}(`{}`, '{}', {{ headers: {} }});\n",
815 method, url, escaped_body, headers
816 ));
817 } else if !effective_headers.is_empty() {
818 script.push_str(&format!(
819 " let res = http.{}(`{}`, null, {{ headers: {} }});\n",
820 method,
821 url,
822 Self::format_headers(effective_headers)
823 ));
824 } else {
825 script.push_str(&format!(" let res = http.{}(`{}`, null);\n", method, url));
826 }
827 }
828
829 fn effective_headers(&self, spec_headers: &[(String, String)]) -> Vec<(String, String)> {
833 let custom = &self.config.custom_headers;
834 if custom.is_empty() {
835 return spec_headers.to_vec();
836 }
837
838 let mut result: Vec<(String, String)> = Vec::new();
839
840 for (name, value) in spec_headers {
842 if let Some((_, custom_val)) =
843 custom.iter().find(|(cn, _)| cn.eq_ignore_ascii_case(name))
844 {
845 result.push((name.clone(), custom_val.clone()));
846 } else {
847 result.push((name.clone(), value.clone()));
848 }
849 }
850
851 for (name, value) in custom {
853 if !spec_headers.iter().any(|(sn, _)| sn.eq_ignore_ascii_case(name)) {
854 result.push((name.clone(), value.clone()));
855 }
856 }
857
858 result
859 }
860
861 fn format_headers(headers: &[(String, String)]) -> String {
863 let entries: Vec<String> =
864 headers.iter().map(|(k, v)| format!("'{}': '{}'", k, v)).collect();
865 format!("{{ {} }}", entries.join(", "))
866 }
867
868 fn generate_handle_summary(&self, script: &mut String) {
870 script.push_str("export function handleSummary(data) {\n");
871 script.push_str(" let checks = {};\n");
872 script.push_str(" if (data.metrics && data.metrics.checks) {\n");
873 script.push_str(" checks.overall_pass_rate = data.metrics.checks.values.rate;\n");
874 script.push_str(" }\n");
875 script.push_str(" let checkResults = {};\n");
876 script.push_str(" function walkGroups(group) {\n");
877 script.push_str(" if (group.checks) {\n");
878 script.push_str(" for (let checkObj of group.checks) {\n");
879 script.push_str(" checkResults[checkObj.name] = {\n");
880 script.push_str(" passes: checkObj.passes,\n");
881 script.push_str(" fails: checkObj.fails,\n");
882 script.push_str(" };\n");
883 script.push_str(" }\n");
884 script.push_str(" }\n");
885 script.push_str(" if (group.groups) {\n");
886 script.push_str(" for (let subGroup of group.groups) {\n");
887 script.push_str(" walkGroups(subGroup);\n");
888 script.push_str(" }\n");
889 script.push_str(" }\n");
890 script.push_str(" }\n");
891 script.push_str(" if (data.root_group) {\n");
892 script.push_str(" walkGroups(data.root_group);\n");
893 script.push_str(" }\n");
894 script.push_str(" return {\n");
895 script.push_str(" 'conformance-report.json': JSON.stringify({ checks: checkResults, overall: checks }, null, 2),\n");
896 script.push_str(" stdout: textSummary(data, { indent: ' ', enableColors: true }),\n");
897 script.push_str(" };\n");
898 script.push_str("}\n\n");
899 script.push_str("function textSummary(data, opts) {\n");
900 script.push_str(" return JSON.stringify(data, null, 2);\n");
901 script.push_str("}\n");
902 }
903}
904
905#[cfg(test)]
906mod tests {
907 use super::*;
908 use openapiv3::{
909 Operation, ParameterData, ParameterSchemaOrContent, PathStyle, Response, Schema,
910 SchemaData, SchemaKind, StringType, Type,
911 };
912
913 fn make_op(method: &str, path: &str, operation: Operation) -> ApiOperation {
914 ApiOperation {
915 method: method.to_string(),
916 path: path.to_string(),
917 operation,
918 operation_id: None,
919 }
920 }
921
922 fn empty_spec() -> OpenAPI {
923 OpenAPI::default()
924 }
925
926 #[test]
927 fn test_annotate_get_with_path_param() {
928 let mut op = Operation::default();
929 op.parameters.push(ReferenceOr::Item(Parameter::Path {
930 parameter_data: ParameterData {
931 name: "id".to_string(),
932 description: None,
933 required: true,
934 deprecated: None,
935 format: ParameterSchemaOrContent::Schema(ReferenceOr::Item(Schema {
936 schema_data: SchemaData::default(),
937 schema_kind: SchemaKind::Type(Type::String(StringType::default())),
938 })),
939 example: None,
940 examples: Default::default(),
941 explode: None,
942 extensions: Default::default(),
943 },
944 style: PathStyle::Simple,
945 }));
946
947 let api_op = make_op("get", "/users/{id}", op);
948 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
949
950 assert!(annotated.features.contains(&ConformanceFeature::MethodGet));
951 assert!(annotated.features.contains(&ConformanceFeature::PathParamString));
952 assert!(annotated.features.contains(&ConformanceFeature::ConstraintRequired));
953 assert_eq!(annotated.path_params.len(), 1);
954 assert_eq!(annotated.path_params[0].0, "id");
955 }
956
957 #[test]
958 fn test_annotate_post_with_json_body() {
959 let mut op = Operation::default();
960 let mut body = openapiv3::RequestBody::default();
961 body.required = true;
962 body.content
963 .insert("application/json".to_string(), openapiv3::MediaType::default());
964 op.request_body = Some(ReferenceOr::Item(body));
965
966 let api_op = make_op("post", "/items", op);
967 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
968
969 assert!(annotated.features.contains(&ConformanceFeature::MethodPost));
970 assert!(annotated.features.contains(&ConformanceFeature::BodyJson));
971 }
972
973 #[test]
974 fn test_annotate_response_codes() {
975 let mut op = Operation::default();
976 op.responses
977 .responses
978 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(Response::default()));
979 op.responses
980 .responses
981 .insert(openapiv3::StatusCode::Code(404), ReferenceOr::Item(Response::default()));
982
983 let api_op = make_op("get", "/items", op);
984 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
985
986 assert!(annotated.features.contains(&ConformanceFeature::Response200));
987 assert!(annotated.features.contains(&ConformanceFeature::Response404));
988 }
989
990 #[test]
991 fn test_generate_spec_driven_script() {
992 let config = ConformanceConfig {
993 target_url: "http://localhost:3000".to_string(),
994 api_key: None,
995 basic_auth: None,
996 skip_tls_verify: false,
997 categories: None,
998 base_path: None,
999 custom_headers: vec![],
1000 };
1001
1002 let operations = vec![AnnotatedOperation {
1003 path: "/users/{id}".to_string(),
1004 method: "GET".to_string(),
1005 features: vec![
1006 ConformanceFeature::MethodGet,
1007 ConformanceFeature::PathParamString,
1008 ],
1009 request_body_content_type: None,
1010 sample_body: None,
1011 query_params: vec![],
1012 header_params: vec![],
1013 path_params: vec![("id".to_string(), "test-value".to_string())],
1014 response_schema: None,
1015 }];
1016
1017 let gen = SpecDrivenConformanceGenerator::new(config, operations);
1018 let script = gen.generate().unwrap();
1019
1020 assert!(script.contains("import http from 'k6/http'"));
1021 assert!(script.contains("/users/test-value"));
1022 assert!(script.contains("param:path:string"));
1023 assert!(script.contains("method:GET"));
1024 assert!(script.contains("handleSummary"));
1025 }
1026
1027 #[test]
1028 fn test_generate_with_category_filter() {
1029 let config = ConformanceConfig {
1030 target_url: "http://localhost:3000".to_string(),
1031 api_key: None,
1032 basic_auth: None,
1033 skip_tls_verify: false,
1034 categories: Some(vec!["Parameters".to_string()]),
1035 base_path: None,
1036 custom_headers: vec![],
1037 };
1038
1039 let operations = vec![AnnotatedOperation {
1040 path: "/users/{id}".to_string(),
1041 method: "GET".to_string(),
1042 features: vec![
1043 ConformanceFeature::MethodGet,
1044 ConformanceFeature::PathParamString,
1045 ],
1046 request_body_content_type: None,
1047 sample_body: None,
1048 query_params: vec![],
1049 header_params: vec![],
1050 path_params: vec![("id".to_string(), "1".to_string())],
1051 response_schema: None,
1052 }];
1053
1054 let gen = SpecDrivenConformanceGenerator::new(config, operations);
1055 let script = gen.generate().unwrap();
1056
1057 assert!(script.contains("group('Parameters'"));
1058 assert!(!script.contains("group('HTTP Methods'"));
1059 }
1060
1061 #[test]
1062 fn test_annotate_response_validation() {
1063 use openapiv3::ObjectType;
1064
1065 let mut op = Operation::default();
1067 let mut response = Response::default();
1068 let mut media = openapiv3::MediaType::default();
1069 let mut obj_type = ObjectType::default();
1070 obj_type.properties.insert(
1071 "name".to_string(),
1072 ReferenceOr::Item(Box::new(Schema {
1073 schema_data: SchemaData::default(),
1074 schema_kind: SchemaKind::Type(Type::String(StringType::default())),
1075 })),
1076 );
1077 obj_type.required = vec!["name".to_string()];
1078 media.schema = Some(ReferenceOr::Item(Schema {
1079 schema_data: SchemaData::default(),
1080 schema_kind: SchemaKind::Type(Type::Object(obj_type)),
1081 }));
1082 response.content.insert("application/json".to_string(), media);
1083 op.responses
1084 .responses
1085 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1086
1087 let api_op = make_op("get", "/users", op);
1088 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1089
1090 assert!(
1091 annotated.features.contains(&ConformanceFeature::ResponseValidation),
1092 "Should detect ResponseValidation when response has a JSON schema"
1093 );
1094 assert!(annotated.response_schema.is_some(), "Should extract the response schema");
1095
1096 let config = ConformanceConfig {
1098 target_url: "http://localhost:3000".to_string(),
1099 api_key: None,
1100 basic_auth: None,
1101 skip_tls_verify: false,
1102 categories: None,
1103 base_path: None,
1104 custom_headers: vec![],
1105 };
1106 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1107 let script = gen.generate().unwrap();
1108
1109 assert!(
1110 script.contains("response:schema:validation"),
1111 "Script should contain the validation check name"
1112 );
1113 assert!(script.contains("try {"), "Script should wrap validation in try-catch");
1114 assert!(script.contains("res.json()"), "Script should parse response as JSON");
1115 }
1116
1117 #[test]
1118 fn test_annotate_global_security() {
1119 let op = Operation::default();
1121 let mut spec = OpenAPI::default();
1122 let mut global_req = openapiv3::SecurityRequirement::new();
1123 global_req.insert("bearerAuth".to_string(), vec![]);
1124 spec.security = Some(vec![global_req]);
1125 let mut components = openapiv3::Components::default();
1127 components.security_schemes.insert(
1128 "bearerAuth".to_string(),
1129 ReferenceOr::Item(SecurityScheme::HTTP {
1130 scheme: "bearer".to_string(),
1131 bearer_format: Some("JWT".to_string()),
1132 description: None,
1133 extensions: Default::default(),
1134 }),
1135 );
1136 spec.components = Some(components);
1137
1138 let api_op = make_op("get", "/protected", op);
1139 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1140
1141 assert!(
1142 annotated.features.contains(&ConformanceFeature::SecurityBearer),
1143 "Should detect SecurityBearer from global security + components"
1144 );
1145 }
1146
1147 #[test]
1148 fn test_annotate_security_scheme_resolution() {
1149 let mut op = Operation::default();
1151 let mut req = openapiv3::SecurityRequirement::new();
1153 req.insert("myAuth".to_string(), vec![]);
1154 op.security = Some(vec![req]);
1155
1156 let mut spec = OpenAPI::default();
1157 let mut components = openapiv3::Components::default();
1158 components.security_schemes.insert(
1159 "myAuth".to_string(),
1160 ReferenceOr::Item(SecurityScheme::APIKey {
1161 location: openapiv3::APIKeyLocation::Header,
1162 name: "X-API-Key".to_string(),
1163 description: None,
1164 extensions: Default::default(),
1165 }),
1166 );
1167 spec.components = Some(components);
1168
1169 let api_op = make_op("get", "/data", op);
1170 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1171
1172 assert!(
1173 annotated.features.contains(&ConformanceFeature::SecurityApiKey),
1174 "Should detect SecurityApiKey from SecurityScheme::APIKey, not name heuristic"
1175 );
1176 }
1177
1178 #[test]
1179 fn test_annotate_content_negotiation() {
1180 let mut op = Operation::default();
1181 let mut response = Response::default();
1182 response
1184 .content
1185 .insert("application/json".to_string(), openapiv3::MediaType::default());
1186 response
1187 .content
1188 .insert("application/xml".to_string(), openapiv3::MediaType::default());
1189 op.responses
1190 .responses
1191 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1192
1193 let api_op = make_op("get", "/items", op);
1194 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1195
1196 assert!(
1197 annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1198 "Should detect ContentNegotiation when response has multiple content types"
1199 );
1200 }
1201
1202 #[test]
1203 fn test_no_content_negotiation_for_single_type() {
1204 let mut op = Operation::default();
1205 let mut response = Response::default();
1206 response
1207 .content
1208 .insert("application/json".to_string(), openapiv3::MediaType::default());
1209 op.responses
1210 .responses
1211 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1212
1213 let api_op = make_op("get", "/items", op);
1214 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1215
1216 assert!(
1217 !annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1218 "Should NOT detect ContentNegotiation for a single content type"
1219 );
1220 }
1221
1222 #[test]
1223 fn test_spec_driven_with_base_path() {
1224 let annotated = AnnotatedOperation {
1225 path: "/users".to_string(),
1226 method: "GET".to_string(),
1227 features: vec![ConformanceFeature::MethodGet],
1228 path_params: vec![],
1229 query_params: vec![],
1230 header_params: vec![],
1231 request_body_content_type: None,
1232 sample_body: None,
1233 response_schema: None,
1234 };
1235 let config = ConformanceConfig {
1236 target_url: "https://192.168.2.86/".to_string(),
1237 api_key: None,
1238 basic_auth: None,
1239 skip_tls_verify: true,
1240 categories: None,
1241 base_path: Some("/api".to_string()),
1242 custom_headers: vec![],
1243 };
1244 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1245 let script = gen.generate().unwrap();
1246
1247 assert!(
1248 script.contains("const BASE_URL = 'https://192.168.2.86/api'"),
1249 "BASE_URL should include the base_path. Got: {}",
1250 script.lines().find(|l| l.contains("BASE_URL")).unwrap_or("not found")
1251 );
1252 }
1253
1254 #[test]
1255 fn test_spec_driven_with_custom_headers() {
1256 let annotated = AnnotatedOperation {
1257 path: "/users".to_string(),
1258 method: "GET".to_string(),
1259 features: vec![ConformanceFeature::MethodGet],
1260 path_params: vec![],
1261 query_params: vec![],
1262 header_params: vec![
1263 ("X-Avi-Tenant".to_string(), "test-value".to_string()),
1264 ("X-CSRFToken".to_string(), "test-value".to_string()),
1265 ],
1266 request_body_content_type: None,
1267 sample_body: None,
1268 response_schema: None,
1269 };
1270 let config = ConformanceConfig {
1271 target_url: "https://192.168.2.86/".to_string(),
1272 api_key: None,
1273 basic_auth: None,
1274 skip_tls_verify: true,
1275 categories: None,
1276 base_path: Some("/api".to_string()),
1277 custom_headers: vec![
1278 ("X-Avi-Tenant".to_string(), "admin".to_string()),
1279 ("X-CSRFToken".to_string(), "real-csrf-token".to_string()),
1280 ("Cookie".to_string(), "sessionid=abc123".to_string()),
1281 ],
1282 };
1283 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1284 let script = gen.generate().unwrap();
1285
1286 assert!(
1288 script.contains("'X-Avi-Tenant': 'admin'"),
1289 "Should use custom value for X-Avi-Tenant, not test-value"
1290 );
1291 assert!(
1292 script.contains("'X-CSRFToken': 'real-csrf-token'"),
1293 "Should use custom value for X-CSRFToken, not test-value"
1294 );
1295 assert!(
1297 script.contains("'Cookie': 'sessionid=abc123'"),
1298 "Should include Cookie header from custom_headers"
1299 );
1300 assert!(
1302 !script.contains("'test-value'"),
1303 "test-value placeholders should be replaced by custom values"
1304 );
1305 }
1306
1307 #[test]
1308 fn test_effective_headers_merging() {
1309 let config = ConformanceConfig {
1310 target_url: "http://localhost".to_string(),
1311 api_key: None,
1312 basic_auth: None,
1313 skip_tls_verify: false,
1314 categories: None,
1315 base_path: None,
1316 custom_headers: vec![
1317 ("X-Auth".to_string(), "real-token".to_string()),
1318 ("Cookie".to_string(), "session=abc".to_string()),
1319 ],
1320 };
1321 let gen = SpecDrivenConformanceGenerator::new(config, vec![]);
1322
1323 let spec_headers = vec![
1325 ("X-Auth".to_string(), "test-value".to_string()),
1326 ("X-Other".to_string(), "keep-this".to_string()),
1327 ];
1328 let effective = gen.effective_headers(&spec_headers);
1329
1330 assert_eq!(effective[0], ("X-Auth".to_string(), "real-token".to_string()));
1332 assert_eq!(effective[1], ("X-Other".to_string(), "keep-this".to_string()));
1334 assert_eq!(effective[2], ("Cookie".to_string(), "session=abc".to_string()));
1336 }
1337}