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 operation_count(&self) -> usize {
582 self.operations.len()
583 }
584
585 pub fn generate(&self) -> Result<(String, usize)> {
588 let mut script = String::with_capacity(16384);
589
590 script.push_str("import http from 'k6/http';\n");
592 script.push_str("import { check, group } from 'k6';\n\n");
593
594 script.push_str("export const options = {\n");
596 script.push_str(" vus: 1,\n");
597 script.push_str(" iterations: 1,\n");
598 if self.config.skip_tls_verify {
599 script.push_str(" insecureSkipTLSVerify: true,\n");
600 }
601 if self.config.has_cookie_header() {
602 script.push_str(" noCookies: true,\n");
603 }
604 script.push_str(" thresholds: {\n");
605 script.push_str(" checks: ['rate>0'],\n");
606 script.push_str(" },\n");
607 script.push_str("};\n\n");
608
609 script.push_str(&format!("const BASE_URL = '{}';\n\n", self.config.effective_base_url()));
611 script.push_str("const JSON_HEADERS = { 'Content-Type': 'application/json' };\n\n");
612
613 script.push_str("export default function () {\n");
615
616 let mut category_ops: std::collections::BTreeMap<
618 &'static str,
619 Vec<(&AnnotatedOperation, &ConformanceFeature)>,
620 > = std::collections::BTreeMap::new();
621
622 for op in &self.operations {
623 for feature in &op.features {
624 let category = feature.category();
625 if self.config.should_include_category(category) {
626 category_ops.entry(category).or_default().push((op, feature));
627 }
628 }
629 }
630
631 let mut total_checks = 0usize;
633 for (category, ops) in &category_ops {
634 script.push_str(&format!(" group('{}', function () {{\n", category));
635
636 if self.config.all_operations {
637 let mut emitted_checks: HashSet<String> = HashSet::new();
639 for (op, feature) in ops {
640 let qualified = format!("{}:{}", feature.check_name(), op.path);
641 if emitted_checks.insert(qualified.clone()) {
642 self.emit_check_named(&mut script, op, feature, &qualified);
643 total_checks += 1;
644 }
645 }
646 } else {
647 let mut emitted_checks: HashSet<&str> = HashSet::new();
649 for (op, feature) in ops {
650 if emitted_checks.insert(feature.check_name()) {
651 self.emit_check(&mut script, op, feature);
652 total_checks += 1;
653 }
654 }
655 }
656
657 script.push_str(" });\n\n");
658 }
659
660 script.push_str("}\n\n");
661
662 self.generate_handle_summary(&mut script);
664
665 Ok((script, total_checks))
666 }
667
668 fn emit_check(
670 &self,
671 script: &mut String,
672 op: &AnnotatedOperation,
673 feature: &ConformanceFeature,
674 ) {
675 self.emit_check_named(script, op, feature, feature.check_name());
676 }
677
678 fn emit_check_named(
680 &self,
681 script: &mut String,
682 op: &AnnotatedOperation,
683 feature: &ConformanceFeature,
684 check_name: &str,
685 ) {
686 let check_name = check_name.replace('\'', "\\'");
688 let check_name = check_name.as_str();
689
690 script.push_str(" {\n");
691
692 let mut url_path = op.path.clone();
694 for (name, value) in &op.path_params {
695 url_path = url_path.replace(&format!("{{{}}}", name), value);
696 }
697
698 if !op.query_params.is_empty() {
700 let qs: Vec<String> =
701 op.query_params.iter().map(|(k, v)| format!("{}={}", k, v)).collect();
702 url_path = format!("{}?{}", url_path, qs.join("&"));
703 }
704
705 let full_url = format!("${{BASE_URL}}{}", url_path);
706
707 let effective_headers = self.effective_headers(&op.header_params);
710 let has_headers = !effective_headers.is_empty();
711 let headers_obj = if has_headers {
712 Self::format_headers(&effective_headers)
713 } else {
714 String::new()
715 };
716
717 match op.method.as_str() {
719 "GET" => {
720 if has_headers {
721 script.push_str(&format!(
722 " let res = http.get(`{}`, {{ headers: {} }});\n",
723 full_url, headers_obj
724 ));
725 } else {
726 script.push_str(&format!(" let res = http.get(`{}`);\n", full_url));
727 }
728 }
729 "POST" => {
730 self.emit_request_with_body(script, "post", &full_url, op, &effective_headers);
731 }
732 "PUT" => {
733 self.emit_request_with_body(script, "put", &full_url, op, &effective_headers);
734 }
735 "PATCH" => {
736 self.emit_request_with_body(script, "patch", &full_url, op, &effective_headers);
737 }
738 "DELETE" => {
739 if has_headers {
740 script.push_str(&format!(
741 " let res = http.del(`{}`, null, {{ headers: {} }});\n",
742 full_url, headers_obj
743 ));
744 } else {
745 script.push_str(&format!(" let res = http.del(`{}`);\n", full_url));
746 }
747 }
748 "HEAD" => {
749 if has_headers {
750 script.push_str(&format!(
751 " let res = http.head(`{}`, {{ headers: {} }});\n",
752 full_url, headers_obj
753 ));
754 } else {
755 script.push_str(&format!(" let res = http.head(`{}`);\n", full_url));
756 }
757 }
758 "OPTIONS" => {
759 if has_headers {
760 script.push_str(&format!(
761 " let res = http.options(`{}`, null, {{ headers: {} }});\n",
762 full_url, headers_obj
763 ));
764 } else {
765 script.push_str(&format!(" let res = http.options(`{}`);\n", full_url));
766 }
767 }
768 _ => {
769 if has_headers {
770 script.push_str(&format!(
771 " let res = http.get(`{}`, {{ headers: {} }});\n",
772 full_url, headers_obj
773 ));
774 } else {
775 script.push_str(&format!(" let res = http.get(`{}`);\n", full_url));
776 }
777 }
778 }
779
780 if matches!(
782 feature,
783 ConformanceFeature::Response200
784 | ConformanceFeature::Response201
785 | ConformanceFeature::Response204
786 | ConformanceFeature::Response400
787 | ConformanceFeature::Response404
788 ) {
789 let expected_code = match feature {
790 ConformanceFeature::Response200 => 200,
791 ConformanceFeature::Response201 => 201,
792 ConformanceFeature::Response204 => 204,
793 ConformanceFeature::Response400 => 400,
794 ConformanceFeature::Response404 => 404,
795 _ => 200,
796 };
797 script.push_str(&format!(
798 " check(res, {{ '{}': (r) => r.status === {} }});\n",
799 check_name, expected_code
800 ));
801 } else if matches!(feature, ConformanceFeature::ResponseValidation) {
802 if let Some(schema) = &op.response_schema {
804 let validation_js = SchemaValidatorGenerator::generate_validation(schema);
805 script.push_str(&format!(
806 " try {{ let body = res.json(); check(res, {{ '{}': (r) => {{ {} }} }}); }} catch(e) {{ check(res, {{ '{}': () => false }}); }}\n",
807 check_name, validation_js, check_name
808 ));
809 }
810 } else {
811 script.push_str(&format!(
812 " check(res, {{ '{}': (r) => r.status >= 200 && r.status < 500 }});\n",
813 check_name
814 ));
815 }
816
817 script.push_str(" }\n");
818 }
819
820 fn emit_request_with_body(
822 &self,
823 script: &mut String,
824 method: &str,
825 url: &str,
826 op: &AnnotatedOperation,
827 effective_headers: &[(String, String)],
828 ) {
829 if let Some(body) = &op.sample_body {
830 let escaped_body = body.replace('\'', "\\'");
831 let headers = if !effective_headers.is_empty() {
832 format!(
833 "Object.assign({{}}, JSON_HEADERS, {})",
834 Self::format_headers(effective_headers)
835 )
836 } else {
837 "JSON_HEADERS".to_string()
838 };
839 script.push_str(&format!(
840 " let res = http.{}(`{}`, '{}', {{ headers: {} }});\n",
841 method, url, escaped_body, headers
842 ));
843 } else if !effective_headers.is_empty() {
844 script.push_str(&format!(
845 " let res = http.{}(`{}`, null, {{ headers: {} }});\n",
846 method,
847 url,
848 Self::format_headers(effective_headers)
849 ));
850 } else {
851 script.push_str(&format!(" let res = http.{}(`{}`, null);\n", method, url));
852 }
853 }
854
855 fn effective_headers(&self, spec_headers: &[(String, String)]) -> Vec<(String, String)> {
859 let custom = &self.config.custom_headers;
860 if custom.is_empty() {
861 return spec_headers.to_vec();
862 }
863
864 let mut result: Vec<(String, String)> = Vec::new();
865
866 for (name, value) in spec_headers {
868 if let Some((_, custom_val)) =
869 custom.iter().find(|(cn, _)| cn.eq_ignore_ascii_case(name))
870 {
871 result.push((name.clone(), custom_val.clone()));
872 } else {
873 result.push((name.clone(), value.clone()));
874 }
875 }
876
877 for (name, value) in custom {
879 if !spec_headers.iter().any(|(sn, _)| sn.eq_ignore_ascii_case(name)) {
880 result.push((name.clone(), value.clone()));
881 }
882 }
883
884 result
885 }
886
887 fn format_headers(headers: &[(String, String)]) -> String {
889 let entries: Vec<String> =
890 headers.iter().map(|(k, v)| format!("'{}': '{}'", k, v)).collect();
891 format!("{{ {} }}", entries.join(", "))
892 }
893
894 fn generate_handle_summary(&self, script: &mut String) {
896 let report_path = match &self.config.output_dir {
898 Some(dir) => {
899 let abs = std::fs::canonicalize(dir)
900 .unwrap_or_else(|_| dir.clone())
901 .join("conformance-report.json");
902 abs.to_string_lossy().to_string()
903 }
904 None => "conformance-report.json".to_string(),
905 };
906
907 script.push_str("export function handleSummary(data) {\n");
908 script.push_str(" let checks = {};\n");
909 script.push_str(" if (data.metrics && data.metrics.checks) {\n");
910 script.push_str(" checks.overall_pass_rate = data.metrics.checks.values.rate;\n");
911 script.push_str(" }\n");
912 script.push_str(" let checkResults = {};\n");
913 script.push_str(" function walkGroups(group) {\n");
914 script.push_str(" if (group.checks) {\n");
915 script.push_str(" for (let checkObj of group.checks) {\n");
916 script.push_str(" checkResults[checkObj.name] = {\n");
917 script.push_str(" passes: checkObj.passes,\n");
918 script.push_str(" fails: checkObj.fails,\n");
919 script.push_str(" };\n");
920 script.push_str(" }\n");
921 script.push_str(" }\n");
922 script.push_str(" if (group.groups) {\n");
923 script.push_str(" for (let subGroup of group.groups) {\n");
924 script.push_str(" walkGroups(subGroup);\n");
925 script.push_str(" }\n");
926 script.push_str(" }\n");
927 script.push_str(" }\n");
928 script.push_str(" if (data.root_group) {\n");
929 script.push_str(" walkGroups(data.root_group);\n");
930 script.push_str(" }\n");
931 script.push_str(" return {\n");
932 script.push_str(&format!(
933 " '{}': JSON.stringify({{ checks: checkResults, overall: checks }}, null, 2),\n",
934 report_path
935 ));
936 script.push_str(" stdout: textSummary(data, { indent: ' ', enableColors: true }),\n");
937 script.push_str(" };\n");
938 script.push_str("}\n\n");
939 script.push_str("function textSummary(data, opts) {\n");
940 script.push_str(" return JSON.stringify(data, null, 2);\n");
941 script.push_str("}\n");
942 }
943}
944
945#[cfg(test)]
946mod tests {
947 use super::*;
948 use openapiv3::{
949 Operation, ParameterData, ParameterSchemaOrContent, PathStyle, Response, Schema,
950 SchemaData, SchemaKind, StringType, Type,
951 };
952
953 fn make_op(method: &str, path: &str, operation: Operation) -> ApiOperation {
954 ApiOperation {
955 method: method.to_string(),
956 path: path.to_string(),
957 operation,
958 operation_id: None,
959 }
960 }
961
962 fn empty_spec() -> OpenAPI {
963 OpenAPI::default()
964 }
965
966 #[test]
967 fn test_annotate_get_with_path_param() {
968 let mut op = Operation::default();
969 op.parameters.push(ReferenceOr::Item(Parameter::Path {
970 parameter_data: ParameterData {
971 name: "id".to_string(),
972 description: None,
973 required: true,
974 deprecated: None,
975 format: ParameterSchemaOrContent::Schema(ReferenceOr::Item(Schema {
976 schema_data: SchemaData::default(),
977 schema_kind: SchemaKind::Type(Type::String(StringType::default())),
978 })),
979 example: None,
980 examples: Default::default(),
981 explode: None,
982 extensions: Default::default(),
983 },
984 style: PathStyle::Simple,
985 }));
986
987 let api_op = make_op("get", "/users/{id}", op);
988 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
989
990 assert!(annotated.features.contains(&ConformanceFeature::MethodGet));
991 assert!(annotated.features.contains(&ConformanceFeature::PathParamString));
992 assert!(annotated.features.contains(&ConformanceFeature::ConstraintRequired));
993 assert_eq!(annotated.path_params.len(), 1);
994 assert_eq!(annotated.path_params[0].0, "id");
995 }
996
997 #[test]
998 fn test_annotate_post_with_json_body() {
999 let mut op = Operation::default();
1000 let mut body = openapiv3::RequestBody::default();
1001 body.required = true;
1002 body.content
1003 .insert("application/json".to_string(), openapiv3::MediaType::default());
1004 op.request_body = Some(ReferenceOr::Item(body));
1005
1006 let api_op = make_op("post", "/items", op);
1007 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1008
1009 assert!(annotated.features.contains(&ConformanceFeature::MethodPost));
1010 assert!(annotated.features.contains(&ConformanceFeature::BodyJson));
1011 }
1012
1013 #[test]
1014 fn test_annotate_response_codes() {
1015 let mut op = Operation::default();
1016 op.responses
1017 .responses
1018 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(Response::default()));
1019 op.responses
1020 .responses
1021 .insert(openapiv3::StatusCode::Code(404), ReferenceOr::Item(Response::default()));
1022
1023 let api_op = make_op("get", "/items", op);
1024 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1025
1026 assert!(annotated.features.contains(&ConformanceFeature::Response200));
1027 assert!(annotated.features.contains(&ConformanceFeature::Response404));
1028 }
1029
1030 #[test]
1031 fn test_generate_spec_driven_script() {
1032 let config = ConformanceConfig {
1033 target_url: "http://localhost:3000".to_string(),
1034 api_key: None,
1035 basic_auth: None,
1036 skip_tls_verify: false,
1037 categories: None,
1038 base_path: None,
1039 custom_headers: vec![],
1040 output_dir: None,
1041 all_operations: false,
1042 };
1043
1044 let operations = vec![AnnotatedOperation {
1045 path: "/users/{id}".to_string(),
1046 method: "GET".to_string(),
1047 features: vec![
1048 ConformanceFeature::MethodGet,
1049 ConformanceFeature::PathParamString,
1050 ],
1051 request_body_content_type: None,
1052 sample_body: None,
1053 query_params: vec![],
1054 header_params: vec![],
1055 path_params: vec![("id".to_string(), "test-value".to_string())],
1056 response_schema: None,
1057 }];
1058
1059 let gen = SpecDrivenConformanceGenerator::new(config, operations);
1060 let (script, _check_count) = gen.generate().unwrap();
1061
1062 assert!(script.contains("import http from 'k6/http'"));
1063 assert!(script.contains("/users/test-value"));
1064 assert!(script.contains("param:path:string"));
1065 assert!(script.contains("method:GET"));
1066 assert!(script.contains("handleSummary"));
1067 }
1068
1069 #[test]
1070 fn test_generate_with_category_filter() {
1071 let config = ConformanceConfig {
1072 target_url: "http://localhost:3000".to_string(),
1073 api_key: None,
1074 basic_auth: None,
1075 skip_tls_verify: false,
1076 categories: Some(vec!["Parameters".to_string()]),
1077 base_path: None,
1078 custom_headers: vec![],
1079 output_dir: None,
1080 all_operations: false,
1081 };
1082
1083 let operations = vec![AnnotatedOperation {
1084 path: "/users/{id}".to_string(),
1085 method: "GET".to_string(),
1086 features: vec![
1087 ConformanceFeature::MethodGet,
1088 ConformanceFeature::PathParamString,
1089 ],
1090 request_body_content_type: None,
1091 sample_body: None,
1092 query_params: vec![],
1093 header_params: vec![],
1094 path_params: vec![("id".to_string(), "1".to_string())],
1095 response_schema: None,
1096 }];
1097
1098 let gen = SpecDrivenConformanceGenerator::new(config, operations);
1099 let (script, _check_count) = gen.generate().unwrap();
1100
1101 assert!(script.contains("group('Parameters'"));
1102 assert!(!script.contains("group('HTTP Methods'"));
1103 }
1104
1105 #[test]
1106 fn test_annotate_response_validation() {
1107 use openapiv3::ObjectType;
1108
1109 let mut op = Operation::default();
1111 let mut response = Response::default();
1112 let mut media = openapiv3::MediaType::default();
1113 let mut obj_type = ObjectType::default();
1114 obj_type.properties.insert(
1115 "name".to_string(),
1116 ReferenceOr::Item(Box::new(Schema {
1117 schema_data: SchemaData::default(),
1118 schema_kind: SchemaKind::Type(Type::String(StringType::default())),
1119 })),
1120 );
1121 obj_type.required = vec!["name".to_string()];
1122 media.schema = Some(ReferenceOr::Item(Schema {
1123 schema_data: SchemaData::default(),
1124 schema_kind: SchemaKind::Type(Type::Object(obj_type)),
1125 }));
1126 response.content.insert("application/json".to_string(), media);
1127 op.responses
1128 .responses
1129 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1130
1131 let api_op = make_op("get", "/users", op);
1132 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1133
1134 assert!(
1135 annotated.features.contains(&ConformanceFeature::ResponseValidation),
1136 "Should detect ResponseValidation when response has a JSON schema"
1137 );
1138 assert!(annotated.response_schema.is_some(), "Should extract the response schema");
1139
1140 let config = ConformanceConfig {
1142 target_url: "http://localhost:3000".to_string(),
1143 api_key: None,
1144 basic_auth: None,
1145 skip_tls_verify: false,
1146 categories: None,
1147 base_path: None,
1148 custom_headers: vec![],
1149 output_dir: None,
1150 all_operations: false,
1151 };
1152 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1153 let (script, _check_count) = gen.generate().unwrap();
1154
1155 assert!(
1156 script.contains("response:schema:validation"),
1157 "Script should contain the validation check name"
1158 );
1159 assert!(script.contains("try {"), "Script should wrap validation in try-catch");
1160 assert!(script.contains("res.json()"), "Script should parse response as JSON");
1161 }
1162
1163 #[test]
1164 fn test_annotate_global_security() {
1165 let op = Operation::default();
1167 let mut spec = OpenAPI::default();
1168 let mut global_req = openapiv3::SecurityRequirement::new();
1169 global_req.insert("bearerAuth".to_string(), vec![]);
1170 spec.security = Some(vec![global_req]);
1171 let mut components = openapiv3::Components::default();
1173 components.security_schemes.insert(
1174 "bearerAuth".to_string(),
1175 ReferenceOr::Item(SecurityScheme::HTTP {
1176 scheme: "bearer".to_string(),
1177 bearer_format: Some("JWT".to_string()),
1178 description: None,
1179 extensions: Default::default(),
1180 }),
1181 );
1182 spec.components = Some(components);
1183
1184 let api_op = make_op("get", "/protected", op);
1185 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1186
1187 assert!(
1188 annotated.features.contains(&ConformanceFeature::SecurityBearer),
1189 "Should detect SecurityBearer from global security + components"
1190 );
1191 }
1192
1193 #[test]
1194 fn test_annotate_security_scheme_resolution() {
1195 let mut op = Operation::default();
1197 let mut req = openapiv3::SecurityRequirement::new();
1199 req.insert("myAuth".to_string(), vec![]);
1200 op.security = Some(vec![req]);
1201
1202 let mut spec = OpenAPI::default();
1203 let mut components = openapiv3::Components::default();
1204 components.security_schemes.insert(
1205 "myAuth".to_string(),
1206 ReferenceOr::Item(SecurityScheme::APIKey {
1207 location: openapiv3::APIKeyLocation::Header,
1208 name: "X-API-Key".to_string(),
1209 description: None,
1210 extensions: Default::default(),
1211 }),
1212 );
1213 spec.components = Some(components);
1214
1215 let api_op = make_op("get", "/data", op);
1216 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1217
1218 assert!(
1219 annotated.features.contains(&ConformanceFeature::SecurityApiKey),
1220 "Should detect SecurityApiKey from SecurityScheme::APIKey, not name heuristic"
1221 );
1222 }
1223
1224 #[test]
1225 fn test_annotate_content_negotiation() {
1226 let mut op = Operation::default();
1227 let mut response = Response::default();
1228 response
1230 .content
1231 .insert("application/json".to_string(), openapiv3::MediaType::default());
1232 response
1233 .content
1234 .insert("application/xml".to_string(), openapiv3::MediaType::default());
1235 op.responses
1236 .responses
1237 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1238
1239 let api_op = make_op("get", "/items", op);
1240 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1241
1242 assert!(
1243 annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1244 "Should detect ContentNegotiation when response has multiple content types"
1245 );
1246 }
1247
1248 #[test]
1249 fn test_no_content_negotiation_for_single_type() {
1250 let mut op = Operation::default();
1251 let mut response = Response::default();
1252 response
1253 .content
1254 .insert("application/json".to_string(), openapiv3::MediaType::default());
1255 op.responses
1256 .responses
1257 .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1258
1259 let api_op = make_op("get", "/items", op);
1260 let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1261
1262 assert!(
1263 !annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1264 "Should NOT detect ContentNegotiation for a single content type"
1265 );
1266 }
1267
1268 #[test]
1269 fn test_spec_driven_with_base_path() {
1270 let annotated = AnnotatedOperation {
1271 path: "/users".to_string(),
1272 method: "GET".to_string(),
1273 features: vec![ConformanceFeature::MethodGet],
1274 path_params: vec![],
1275 query_params: vec![],
1276 header_params: vec![],
1277 request_body_content_type: None,
1278 sample_body: None,
1279 response_schema: None,
1280 };
1281 let config = ConformanceConfig {
1282 target_url: "https://192.168.2.86/".to_string(),
1283 api_key: None,
1284 basic_auth: None,
1285 skip_tls_verify: true,
1286 categories: None,
1287 base_path: Some("/api".to_string()),
1288 custom_headers: vec![],
1289 output_dir: None,
1290 all_operations: false,
1291 };
1292 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1293 let (script, _check_count) = gen.generate().unwrap();
1294
1295 assert!(
1296 script.contains("const BASE_URL = 'https://192.168.2.86/api'"),
1297 "BASE_URL should include the base_path. Got: {}",
1298 script.lines().find(|l| l.contains("BASE_URL")).unwrap_or("not found")
1299 );
1300 }
1301
1302 #[test]
1303 fn test_spec_driven_with_custom_headers() {
1304 let annotated = AnnotatedOperation {
1305 path: "/users".to_string(),
1306 method: "GET".to_string(),
1307 features: vec![ConformanceFeature::MethodGet],
1308 path_params: vec![],
1309 query_params: vec![],
1310 header_params: vec![
1311 ("X-Avi-Tenant".to_string(), "test-value".to_string()),
1312 ("X-CSRFToken".to_string(), "test-value".to_string()),
1313 ],
1314 request_body_content_type: None,
1315 sample_body: None,
1316 response_schema: None,
1317 };
1318 let config = ConformanceConfig {
1319 target_url: "https://192.168.2.86/".to_string(),
1320 api_key: None,
1321 basic_auth: None,
1322 skip_tls_verify: true,
1323 categories: None,
1324 base_path: Some("/api".to_string()),
1325 custom_headers: vec![
1326 ("X-Avi-Tenant".to_string(), "admin".to_string()),
1327 ("X-CSRFToken".to_string(), "real-csrf-token".to_string()),
1328 ("Cookie".to_string(), "sessionid=abc123".to_string()),
1329 ],
1330 output_dir: None,
1331 all_operations: false,
1332 };
1333 let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1334 let (script, _check_count) = gen.generate().unwrap();
1335
1336 assert!(
1338 script.contains("'X-Avi-Tenant': 'admin'"),
1339 "Should use custom value for X-Avi-Tenant, not test-value"
1340 );
1341 assert!(
1342 script.contains("'X-CSRFToken': 'real-csrf-token'"),
1343 "Should use custom value for X-CSRFToken, not test-value"
1344 );
1345 assert!(
1347 script.contains("'Cookie': 'sessionid=abc123'"),
1348 "Should include Cookie header from custom_headers"
1349 );
1350 assert!(
1352 !script.contains("'test-value'"),
1353 "test-value placeholders should be replaced by custom values"
1354 );
1355 }
1356
1357 #[test]
1358 fn test_effective_headers_merging() {
1359 let config = ConformanceConfig {
1360 target_url: "http://localhost".to_string(),
1361 api_key: None,
1362 basic_auth: None,
1363 skip_tls_verify: false,
1364 categories: None,
1365 base_path: None,
1366 custom_headers: vec![
1367 ("X-Auth".to_string(), "real-token".to_string()),
1368 ("Cookie".to_string(), "session=abc".to_string()),
1369 ],
1370 output_dir: None,
1371 all_operations: false,
1372 };
1373 let gen = SpecDrivenConformanceGenerator::new(config, vec![]);
1374
1375 let spec_headers = vec![
1377 ("X-Auth".to_string(), "test-value".to_string()),
1378 ("X-Other".to_string(), "keep-this".to_string()),
1379 ];
1380 let effective = gen.effective_headers(&spec_headers);
1381
1382 assert_eq!(effective[0], ("X-Auth".to_string(), "real-token".to_string()));
1384 assert_eq!(effective[1], ("X-Other".to_string(), "keep-this".to_string()));
1386 assert_eq!(effective[2], ("Cookie".to_string(), "session=abc".to_string()));
1388 }
1389}