Skip to main content

mockforge_bench/conformance/
spec_driven.rs

1//! Spec-driven conformance testing
2//!
3//! Analyzes the user's OpenAPI spec to determine which features their API uses,
4//! then generates k6 conformance tests against their real endpoints.
5
6use 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
18/// Resolve `$ref` references against the OpenAPI components
19mod 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 {
34                        reference: inner_ref,
35                    } => {
36                        // One level of recursive resolution
37                        let inner_name = inner_ref.strip_prefix("#/components/parameters/")?;
38                        match components.parameters.get(inner_name)? {
39                            ReferenceOr::Item(param) => Some(param),
40                            ReferenceOr::Reference { .. } => None,
41                        }
42                    }
43                }
44            }
45        }
46    }
47
48    pub fn resolve_request_body<'a>(
49        body_ref: &'a ReferenceOr<RequestBody>,
50        spec: &'a OpenAPI,
51    ) -> Option<&'a RequestBody> {
52        match body_ref {
53            ReferenceOr::Item(body) => Some(body),
54            ReferenceOr::Reference { reference } => {
55                let name = reference.strip_prefix("#/components/requestBodies/")?;
56                let components = spec.components.as_ref()?;
57                match components.request_bodies.get(name)? {
58                    ReferenceOr::Item(body) => Some(body),
59                    ReferenceOr::Reference {
60                        reference: inner_ref,
61                    } => {
62                        // One level of recursive resolution
63                        let inner_name = inner_ref.strip_prefix("#/components/requestBodies/")?;
64                        match components.request_bodies.get(inner_name)? {
65                            ReferenceOr::Item(body) => Some(body),
66                            ReferenceOr::Reference { .. } => None,
67                        }
68                    }
69                }
70            }
71        }
72    }
73
74    pub fn resolve_schema<'a>(
75        schema_ref: &'a ReferenceOr<Schema>,
76        spec: &'a OpenAPI,
77    ) -> Option<&'a Schema> {
78        resolve_schema_with_visited(schema_ref, spec, &mut HashSet::new())
79    }
80
81    fn resolve_schema_with_visited<'a>(
82        schema_ref: &'a ReferenceOr<Schema>,
83        spec: &'a OpenAPI,
84        visited: &mut HashSet<String>,
85    ) -> Option<&'a Schema> {
86        match schema_ref {
87            ReferenceOr::Item(schema) => Some(schema),
88            ReferenceOr::Reference { reference } => {
89                if !visited.insert(reference.clone()) {
90                    return None; // Cycle detected
91                }
92                let name = reference.strip_prefix("#/components/schemas/")?;
93                let components = spec.components.as_ref()?;
94                let nested = components.schemas.get(name)?;
95                resolve_schema_with_visited(nested, spec, visited)
96            }
97        }
98    }
99
100    /// Resolve a boxed schema reference (used by array items and object properties)
101    pub fn resolve_boxed_schema<'a>(
102        schema_ref: &'a ReferenceOr<Box<Schema>>,
103        spec: &'a OpenAPI,
104    ) -> Option<&'a Schema> {
105        match schema_ref {
106            ReferenceOr::Item(schema) => Some(schema.as_ref()),
107            ReferenceOr::Reference { reference } => {
108                // Delegate to the regular schema resolver
109                let name = reference.strip_prefix("#/components/schemas/")?;
110                let components = spec.components.as_ref()?;
111                let nested = components.schemas.get(name)?;
112                resolve_schema_with_visited(nested, spec, &mut HashSet::new())
113            }
114        }
115    }
116
117    pub fn resolve_response<'a>(
118        resp_ref: &'a ReferenceOr<Response>,
119        spec: &'a OpenAPI,
120    ) -> Option<&'a Response> {
121        match resp_ref {
122            ReferenceOr::Item(resp) => Some(resp),
123            ReferenceOr::Reference { reference } => {
124                let name = reference.strip_prefix("#/components/responses/")?;
125                let components = spec.components.as_ref()?;
126                match components.responses.get(name)? {
127                    ReferenceOr::Item(resp) => Some(resp),
128                    ReferenceOr::Reference {
129                        reference: inner_ref,
130                    } => {
131                        // One level of recursive resolution
132                        let inner_name = inner_ref.strip_prefix("#/components/responses/")?;
133                        match components.responses.get(inner_name)? {
134                            ReferenceOr::Item(resp) => Some(resp),
135                            ReferenceOr::Reference { .. } => None,
136                        }
137                    }
138                }
139            }
140        }
141    }
142}
143
144/// Resolved security scheme details for an operation
145#[derive(Debug, Clone)]
146pub enum SecuritySchemeInfo {
147    /// HTTP Bearer token
148    Bearer,
149    /// HTTP Basic auth
150    Basic,
151    /// API Key in header, query, or cookie
152    ApiKey {
153        location: ApiKeyLocation,
154        name: String,
155    },
156}
157
158/// Where an API key is transmitted
159#[derive(Debug, Clone, PartialEq)]
160pub enum ApiKeyLocation {
161    Header,
162    Query,
163    Cookie,
164}
165
166/// An API operation annotated with the conformance features it exercises
167#[derive(Debug, Clone)]
168pub struct AnnotatedOperation {
169    pub path: String,
170    pub method: String,
171    pub features: Vec<ConformanceFeature>,
172    pub request_body_content_type: Option<String>,
173    pub sample_body: Option<String>,
174    pub query_params: Vec<(String, String)>,
175    pub header_params: Vec<(String, String)>,
176    pub path_params: Vec<(String, String)>,
177    /// Response schema for validation (JSON string of the schema)
178    pub response_schema: Option<Schema>,
179    /// Security scheme details resolved from the OpenAPI spec
180    pub security_schemes: Vec<SecuritySchemeInfo>,
181}
182
183/// Generates spec-driven conformance k6 scripts
184pub struct SpecDrivenConformanceGenerator {
185    config: ConformanceConfig,
186    operations: Vec<AnnotatedOperation>,
187}
188
189impl SpecDrivenConformanceGenerator {
190    pub fn new(config: ConformanceConfig, operations: Vec<AnnotatedOperation>) -> Self {
191        Self { config, operations }
192    }
193
194    /// Annotate a list of API operations with conformance features
195    pub fn annotate_operations(
196        operations: &[ApiOperation],
197        spec: &OpenAPI,
198    ) -> Vec<AnnotatedOperation> {
199        operations.iter().map(|op| Self::annotate_operation(op, spec)).collect()
200    }
201
202    /// Analyze an operation and determine which conformance features it exercises
203    fn annotate_operation(op: &ApiOperation, spec: &OpenAPI) -> AnnotatedOperation {
204        let mut features = Vec::new();
205        let mut query_params = Vec::new();
206        let mut header_params = Vec::new();
207        let mut path_params = Vec::new();
208
209        // Detect HTTP method feature
210        match op.method.to_uppercase().as_str() {
211            "GET" => features.push(ConformanceFeature::MethodGet),
212            "POST" => features.push(ConformanceFeature::MethodPost),
213            "PUT" => features.push(ConformanceFeature::MethodPut),
214            "PATCH" => features.push(ConformanceFeature::MethodPatch),
215            "DELETE" => features.push(ConformanceFeature::MethodDelete),
216            "HEAD" => features.push(ConformanceFeature::MethodHead),
217            "OPTIONS" => features.push(ConformanceFeature::MethodOptions),
218            _ => {}
219        }
220
221        // Detect parameter features (resolves $ref)
222        for param_ref in &op.operation.parameters {
223            if let Some(param) = ref_resolver::resolve_parameter(param_ref, spec) {
224                Self::annotate_parameter(
225                    param,
226                    spec,
227                    &mut features,
228                    &mut query_params,
229                    &mut header_params,
230                    &mut path_params,
231                );
232            }
233        }
234
235        // Detect path parameters from the path template itself
236        for segment in op.path.split('/') {
237            if segment.starts_with('{') && segment.ends_with('}') {
238                let name = &segment[1..segment.len() - 1];
239                // Only add if not already found from parameters
240                if !path_params.iter().any(|(n, _)| n == name) {
241                    path_params.push((name.to_string(), "test-value".to_string()));
242                    // Determine type from path params we didn't already handle
243                    if !features.contains(&ConformanceFeature::PathParamString)
244                        && !features.contains(&ConformanceFeature::PathParamInteger)
245                    {
246                        features.push(ConformanceFeature::PathParamString);
247                    }
248                }
249            }
250        }
251
252        // Detect request body features (resolves $ref)
253        let mut request_body_content_type = None;
254        let mut sample_body = None;
255
256        let resolved_body = op
257            .operation
258            .request_body
259            .as_ref()
260            .and_then(|b| ref_resolver::resolve_request_body(b, spec));
261
262        if let Some(body) = resolved_body {
263            for (content_type, _media) in &body.content {
264                match content_type.as_str() {
265                    "application/json" => {
266                        features.push(ConformanceFeature::BodyJson);
267                        request_body_content_type = Some("application/json".to_string());
268                        // Generate sample body from schema
269                        if let Ok(template) = RequestGenerator::generate_template(op) {
270                            if let Some(body_val) = &template.body {
271                                sample_body = Some(body_val.to_string());
272                            }
273                        }
274                    }
275                    "application/x-www-form-urlencoded" => {
276                        features.push(ConformanceFeature::BodyFormUrlencoded);
277                        request_body_content_type =
278                            Some("application/x-www-form-urlencoded".to_string());
279                    }
280                    "multipart/form-data" => {
281                        features.push(ConformanceFeature::BodyMultipart);
282                        request_body_content_type = Some("multipart/form-data".to_string());
283                    }
284                    _ => {}
285                }
286            }
287
288            // Detect schema features in request body (resolves $ref in schema)
289            if let Some(media) = body.content.get("application/json") {
290                if let Some(schema_ref) = &media.schema {
291                    if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
292                        Self::annotate_schema(schema, spec, &mut features);
293                    }
294                }
295            }
296        }
297
298        // Detect response code features
299        Self::annotate_responses(&op.operation, spec, &mut features);
300
301        // Extract response schema for validation (resolves $ref)
302        let response_schema = Self::extract_response_schema(&op.operation, spec);
303        if response_schema.is_some() {
304            features.push(ConformanceFeature::ResponseValidation);
305        }
306
307        // Detect content negotiation (response with multiple content types)
308        Self::annotate_content_negotiation(&op.operation, spec, &mut features);
309
310        // Detect security features and resolve scheme details
311        let mut security_schemes = Vec::new();
312        Self::annotate_security(&op.operation, spec, &mut features, &mut security_schemes);
313
314        // Deduplicate features
315        features.sort_by_key(|f| f.check_name());
316        features.dedup_by_key(|f| f.check_name());
317
318        AnnotatedOperation {
319            path: op.path.clone(),
320            method: op.method.to_uppercase(),
321            features,
322            request_body_content_type,
323            sample_body,
324            query_params,
325            header_params,
326            path_params,
327            response_schema,
328            security_schemes,
329        }
330    }
331
332    /// Annotate parameter features
333    fn annotate_parameter(
334        param: &Parameter,
335        spec: &OpenAPI,
336        features: &mut Vec<ConformanceFeature>,
337        query_params: &mut Vec<(String, String)>,
338        header_params: &mut Vec<(String, String)>,
339        path_params: &mut Vec<(String, String)>,
340    ) {
341        let (location, data) = match param {
342            Parameter::Query { parameter_data, .. } => ("query", parameter_data),
343            Parameter::Path { parameter_data, .. } => ("path", parameter_data),
344            Parameter::Header { parameter_data, .. } => ("header", parameter_data),
345            Parameter::Cookie { .. } => {
346                features.push(ConformanceFeature::CookieParam);
347                return;
348            }
349        };
350
351        // Detect type from schema
352        let is_integer = Self::param_schema_is_integer(data, spec);
353        let is_array = Self::param_schema_is_array(data, spec);
354
355        // Generate sample value
356        let sample = if is_integer {
357            "42".to_string()
358        } else if is_array {
359            "a,b".to_string()
360        } else {
361            "test-value".to_string()
362        };
363
364        match location {
365            "path" => {
366                if is_integer {
367                    features.push(ConformanceFeature::PathParamInteger);
368                } else {
369                    features.push(ConformanceFeature::PathParamString);
370                }
371                path_params.push((data.name.clone(), sample));
372            }
373            "query" => {
374                if is_array {
375                    features.push(ConformanceFeature::QueryParamArray);
376                } else if is_integer {
377                    features.push(ConformanceFeature::QueryParamInteger);
378                } else {
379                    features.push(ConformanceFeature::QueryParamString);
380                }
381                query_params.push((data.name.clone(), sample));
382            }
383            "header" => {
384                features.push(ConformanceFeature::HeaderParam);
385                header_params.push((data.name.clone(), sample));
386            }
387            _ => {}
388        }
389
390        // Check for constraint features on the parameter (resolves $ref)
391        if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
392            if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
393                Self::annotate_schema(schema, spec, features);
394            }
395        }
396
397        // Required/optional
398        if data.required {
399            features.push(ConformanceFeature::ConstraintRequired);
400        } else {
401            features.push(ConformanceFeature::ConstraintOptional);
402        }
403    }
404
405    fn param_schema_is_integer(data: &openapiv3::ParameterData, spec: &OpenAPI) -> bool {
406        if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
407            if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
408                return matches!(&schema.schema_kind, SchemaKind::Type(Type::Integer(_)));
409            }
410        }
411        false
412    }
413
414    fn param_schema_is_array(data: &openapiv3::ParameterData, spec: &OpenAPI) -> bool {
415        if let ParameterSchemaOrContent::Schema(schema_ref) = &data.format {
416            if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
417                return matches!(&schema.schema_kind, SchemaKind::Type(Type::Array(_)));
418            }
419        }
420        false
421    }
422
423    /// Annotate schema-level features (types, composition, formats, constraints)
424    fn annotate_schema(schema: &Schema, spec: &OpenAPI, features: &mut Vec<ConformanceFeature>) {
425        match &schema.schema_kind {
426            SchemaKind::Type(Type::String(s)) => {
427                features.push(ConformanceFeature::SchemaString);
428                // Check format
429                match &s.format {
430                    VariantOrUnknownOrEmpty::Item(StringFormat::Date) => {
431                        features.push(ConformanceFeature::FormatDate);
432                    }
433                    VariantOrUnknownOrEmpty::Item(StringFormat::DateTime) => {
434                        features.push(ConformanceFeature::FormatDateTime);
435                    }
436                    VariantOrUnknownOrEmpty::Unknown(fmt) => match fmt.as_str() {
437                        "email" => features.push(ConformanceFeature::FormatEmail),
438                        "uuid" => features.push(ConformanceFeature::FormatUuid),
439                        "uri" | "url" => features.push(ConformanceFeature::FormatUri),
440                        "ipv4" => features.push(ConformanceFeature::FormatIpv4),
441                        "ipv6" => features.push(ConformanceFeature::FormatIpv6),
442                        _ => {}
443                    },
444                    _ => {}
445                }
446                // Check constraints
447                if s.pattern.is_some() {
448                    features.push(ConformanceFeature::ConstraintPattern);
449                }
450                if !s.enumeration.is_empty() {
451                    features.push(ConformanceFeature::ConstraintEnum);
452                }
453                if s.min_length.is_some() || s.max_length.is_some() {
454                    features.push(ConformanceFeature::ConstraintMinMax);
455                }
456            }
457            SchemaKind::Type(Type::Integer(i)) => {
458                features.push(ConformanceFeature::SchemaInteger);
459                if i.minimum.is_some() || i.maximum.is_some() {
460                    features.push(ConformanceFeature::ConstraintMinMax);
461                }
462                if !i.enumeration.is_empty() {
463                    features.push(ConformanceFeature::ConstraintEnum);
464                }
465            }
466            SchemaKind::Type(Type::Number(n)) => {
467                features.push(ConformanceFeature::SchemaNumber);
468                if n.minimum.is_some() || n.maximum.is_some() {
469                    features.push(ConformanceFeature::ConstraintMinMax);
470                }
471            }
472            SchemaKind::Type(Type::Boolean(_)) => {
473                features.push(ConformanceFeature::SchemaBoolean);
474            }
475            SchemaKind::Type(Type::Array(arr)) => {
476                features.push(ConformanceFeature::SchemaArray);
477                if let Some(item_ref) = &arr.items {
478                    if let Some(item_schema) = ref_resolver::resolve_boxed_schema(item_ref, spec) {
479                        Self::annotate_schema(item_schema, spec, features);
480                    }
481                }
482            }
483            SchemaKind::Type(Type::Object(obj)) => {
484                features.push(ConformanceFeature::SchemaObject);
485                // Check required fields
486                if !obj.required.is_empty() {
487                    features.push(ConformanceFeature::ConstraintRequired);
488                }
489                // Walk properties (resolves $ref)
490                for (_name, prop_ref) in &obj.properties {
491                    if let Some(prop_schema) = ref_resolver::resolve_boxed_schema(prop_ref, spec) {
492                        Self::annotate_schema(prop_schema, spec, features);
493                    }
494                }
495            }
496            SchemaKind::OneOf { .. } => {
497                features.push(ConformanceFeature::CompositionOneOf);
498            }
499            SchemaKind::AnyOf { .. } => {
500                features.push(ConformanceFeature::CompositionAnyOf);
501            }
502            SchemaKind::AllOf { .. } => {
503                features.push(ConformanceFeature::CompositionAllOf);
504            }
505            _ => {}
506        }
507    }
508
509    /// Detect response code features (resolves $ref in responses)
510    fn annotate_responses(
511        operation: &Operation,
512        spec: &OpenAPI,
513        features: &mut Vec<ConformanceFeature>,
514    ) {
515        for (status_code, resp_ref) in &operation.responses.responses {
516            // Only count features for responses that actually resolve
517            if ref_resolver::resolve_response(resp_ref, spec).is_some() {
518                match status_code {
519                    openapiv3::StatusCode::Code(200) => {
520                        features.push(ConformanceFeature::Response200)
521                    }
522                    openapiv3::StatusCode::Code(201) => {
523                        features.push(ConformanceFeature::Response201)
524                    }
525                    openapiv3::StatusCode::Code(204) => {
526                        features.push(ConformanceFeature::Response204)
527                    }
528                    openapiv3::StatusCode::Code(400) => {
529                        features.push(ConformanceFeature::Response400)
530                    }
531                    openapiv3::StatusCode::Code(404) => {
532                        features.push(ConformanceFeature::Response404)
533                    }
534                    _ => {}
535                }
536            }
537        }
538    }
539
540    /// Extract the response schema for the primary success response (200 or 201)
541    /// Resolves $ref for both the response and the schema within it.
542    fn extract_response_schema(operation: &Operation, spec: &OpenAPI) -> Option<Schema> {
543        // Try 200 first, then 201
544        for code in [200u16, 201] {
545            if let Some(resp_ref) =
546                operation.responses.responses.get(&openapiv3::StatusCode::Code(code))
547            {
548                if let Some(response) = ref_resolver::resolve_response(resp_ref, spec) {
549                    if let Some(media) = response.content.get("application/json") {
550                        if let Some(schema_ref) = &media.schema {
551                            if let Some(schema) = ref_resolver::resolve_schema(schema_ref, spec) {
552                                return Some(schema.clone());
553                            }
554                        }
555                    }
556                }
557            }
558        }
559        None
560    }
561
562    /// Detect content negotiation: response supports multiple content types
563    fn annotate_content_negotiation(
564        operation: &Operation,
565        spec: &OpenAPI,
566        features: &mut Vec<ConformanceFeature>,
567    ) {
568        for (_status_code, resp_ref) in &operation.responses.responses {
569            if let Some(response) = ref_resolver::resolve_response(resp_ref, spec) {
570                if response.content.len() > 1 {
571                    features.push(ConformanceFeature::ContentNegotiation);
572                    return; // Only need to detect once per operation
573                }
574            }
575        }
576    }
577
578    /// Detect security scheme features.
579    /// Checks operation-level security first, falling back to global security requirements.
580    /// Resolves scheme names against SecurityScheme definitions in components.
581    fn annotate_security(
582        operation: &Operation,
583        spec: &OpenAPI,
584        features: &mut Vec<ConformanceFeature>,
585        security_schemes: &mut Vec<SecuritySchemeInfo>,
586    ) {
587        // Use operation-level security if present, otherwise fall back to global
588        let security_reqs = operation.security.as_ref().or(spec.security.as_ref());
589
590        if let Some(security) = security_reqs {
591            for security_req in security {
592                for scheme_name in security_req.keys() {
593                    // Try to resolve the scheme from components for accurate type detection
594                    if let Some(resolved) = Self::resolve_security_scheme(scheme_name, spec) {
595                        match resolved {
596                            SecurityScheme::HTTP { ref scheme, .. } => {
597                                if scheme.eq_ignore_ascii_case("bearer") {
598                                    features.push(ConformanceFeature::SecurityBearer);
599                                    security_schemes.push(SecuritySchemeInfo::Bearer);
600                                } else if scheme.eq_ignore_ascii_case("basic") {
601                                    features.push(ConformanceFeature::SecurityBasic);
602                                    security_schemes.push(SecuritySchemeInfo::Basic);
603                                }
604                            }
605                            SecurityScheme::APIKey { location, name, .. } => {
606                                features.push(ConformanceFeature::SecurityApiKey);
607                                let loc = match location {
608                                    openapiv3::APIKeyLocation::Query => ApiKeyLocation::Query,
609                                    openapiv3::APIKeyLocation::Header => ApiKeyLocation::Header,
610                                    openapiv3::APIKeyLocation::Cookie => ApiKeyLocation::Cookie,
611                                };
612                                security_schemes.push(SecuritySchemeInfo::ApiKey {
613                                    location: loc,
614                                    name: name.clone(),
615                                });
616                            }
617                            // OAuth2 and OpenIDConnect don't map to our current feature set
618                            _ => {}
619                        }
620                    } else {
621                        // Fallback: heuristic name matching for unresolvable schemes
622                        let name_lower = scheme_name.to_lowercase();
623                        if name_lower.contains("bearer") || name_lower.contains("jwt") {
624                            features.push(ConformanceFeature::SecurityBearer);
625                            security_schemes.push(SecuritySchemeInfo::Bearer);
626                        } else if name_lower.contains("api") && name_lower.contains("key") {
627                            features.push(ConformanceFeature::SecurityApiKey);
628                            security_schemes.push(SecuritySchemeInfo::ApiKey {
629                                location: ApiKeyLocation::Header,
630                                name: "X-API-Key".to_string(),
631                            });
632                        } else if name_lower.contains("basic") {
633                            features.push(ConformanceFeature::SecurityBasic);
634                            security_schemes.push(SecuritySchemeInfo::Basic);
635                        }
636                    }
637                }
638            }
639        }
640    }
641
642    /// Resolve a security scheme name to its SecurityScheme definition
643    fn resolve_security_scheme<'a>(name: &str, spec: &'a OpenAPI) -> Option<&'a SecurityScheme> {
644        let components = spec.components.as_ref()?;
645        match components.security_schemes.get(name)? {
646            ReferenceOr::Item(scheme) => Some(scheme),
647            ReferenceOr::Reference { .. } => None,
648        }
649    }
650
651    /// Returns the number of operations being tested
652    pub fn operation_count(&self) -> usize {
653        self.operations.len()
654    }
655
656    /// Generate the k6 conformance script.
657    /// Returns (script, check_count) where check_count is the number of unique checks emitted.
658    pub fn generate(&self) -> Result<(String, usize)> {
659        let mut script = String::with_capacity(16384);
660
661        // Imports
662        script.push_str("import http from 'k6/http';\n");
663        script.push_str("import { check, group } from 'k6';\n");
664        if self.config.request_delay_ms > 0 {
665            script.push_str("import { sleep } from 'k6';\n");
666        }
667        script.push('\n');
668
669        // Tell k6 that all HTTP status codes are "expected" in conformance mode.
670        // Without this, k6 counts 4xx responses (e.g. intentional 404 tests) as
671        // http_req_failed errors, producing a misleading error rate percentage.
672        script.push_str(
673            "http.setResponseCallback(http.expectedStatuses({ min: 100, max: 599 }));\n\n",
674        );
675
676        // Options
677        script.push_str("export const options = {\n");
678        script.push_str("  vus: 1,\n");
679        script.push_str("  iterations: 1,\n");
680        if self.config.skip_tls_verify {
681            script.push_str("  insecureSkipTLSVerify: true,\n");
682        }
683        script.push_str("  thresholds: {\n");
684        script.push_str("    checks: ['rate>0'],\n");
685        script.push_str("  },\n");
686        script.push_str("};\n\n");
687
688        // Base URL (includes base_path if configured)
689        script.push_str(&format!("const BASE_URL = '{}';\n\n", self.config.effective_base_url()));
690        script.push_str("const JSON_HEADERS = { 'Content-Type': 'application/json' };\n\n");
691
692        // Failure detail collector — logs req/res info for failed checks via console.log
693        // (k6's handleSummary runs in a separate JS context, so we can't use module-level arrays)
694        script
695            .push_str("function __captureFailure(checkName, res, expected, schemaViolations) {\n");
696        script.push_str("  let bodyStr = '';\n");
697        script.push_str("  try { bodyStr = res.body ? res.body.substring(0, 2000) : ''; } catch(e) { bodyStr = '<unreadable>'; }\n");
698        script.push_str("  let reqHeaders = {};\n");
699        script.push_str(
700            "  if (res.request && res.request.headers) { reqHeaders = res.request.headers; }\n",
701        );
702        script.push_str("  let reqBody = '';\n");
703        script.push_str("  if (res.request && res.request.body) { try { reqBody = res.request.body.substring(0, 2000); } catch(e) {} }\n");
704        script.push_str("  let payload = {\n");
705        script.push_str("    check: checkName,\n");
706        script.push_str("    request: {\n");
707        script.push_str("      method: res.request ? res.request.method : 'unknown',\n");
708        script.push_str("      url: res.request ? res.request.url : res.url || 'unknown',\n");
709        script.push_str("      headers: reqHeaders,\n");
710        script.push_str("      body: reqBody,\n");
711        script.push_str("    },\n");
712        script.push_str("    response: {\n");
713        script.push_str("      status: res.status,\n");
714        script.push_str("      headers: res.headers ? Object.fromEntries(Object.entries(res.headers).slice(0, 20)) : {},\n");
715        script.push_str("      body: bodyStr,\n");
716        script.push_str("    },\n");
717        script.push_str("    expected: expected,\n");
718        script.push_str("  };\n");
719        script.push_str("  if (schemaViolations && schemaViolations.length > 0) { payload.schema_violations = schemaViolations; }\n");
720        script.push_str("  console.log('MOCKFORGE_FAILURE:' + JSON.stringify(payload));\n");
721        script.push_str("}\n\n");
722
723        // Request/response capture for --export-requests
724        if self.config.export_requests {
725            script.push_str("function __captureExchange(checkName, res) {\n");
726            script.push_str("  let bodyStr = '';\n");
727            script.push_str("  try { bodyStr = res.body ? res.body.substring(0, 2000) : ''; } catch(e) { bodyStr = '<unreadable>'; }\n");
728            script.push_str("  let reqHeaders = {};\n");
729            script.push_str(
730                "  if (res.request && res.request.headers) { reqHeaders = res.request.headers; }\n",
731            );
732            script.push_str("  let reqBody = '';\n");
733            script.push_str("  if (res.request && res.request.body) { try { reqBody = res.request.body.substring(0, 2000); } catch(e) {} }\n");
734            script.push_str("  console.log('MOCKFORGE_EXCHANGE:' + JSON.stringify({\n");
735            script.push_str("    check: checkName,\n");
736            script.push_str("    request: {\n");
737            script.push_str("      method: res.request ? res.request.method : 'unknown',\n");
738            script.push_str("      url: res.request ? res.request.url : res.url || 'unknown',\n");
739            script.push_str("      headers: reqHeaders,\n");
740            script.push_str("      body: reqBody,\n");
741            script.push_str("    },\n");
742            script.push_str("    response: {\n");
743            script.push_str("      status: res.status,\n");
744            script.push_str("      headers: res.headers ? Object.fromEntries(Object.entries(res.headers).slice(0, 30)) : {},\n");
745            script.push_str("      body: bodyStr,\n");
746            script.push_str("    },\n");
747            script.push_str("  }));\n");
748            script.push_str("}\n\n");
749        }
750
751        // Default function
752        script.push_str("export default function () {\n");
753
754        if self.config.has_cookie_header() {
755            script.push_str(
756                "  // Clear cookie jar to prevent server Set-Cookie from duplicating custom Cookie header\n",
757            );
758            script.push_str("  http.cookieJar().clear(BASE_URL);\n\n");
759        }
760
761        // Group operations by category
762        let mut category_ops: std::collections::BTreeMap<
763            &'static str,
764            Vec<(&AnnotatedOperation, &ConformanceFeature)>,
765        > = std::collections::BTreeMap::new();
766
767        for op in &self.operations {
768            for feature in &op.features {
769                let category = feature.category();
770                if self.config.should_include_category(category) {
771                    category_ops.entry(category).or_default().push((op, feature));
772                }
773            }
774        }
775
776        // Emit grouped tests
777        let mut total_checks = 0usize;
778        for (category, ops) in &category_ops {
779            script.push_str(&format!("  group('{}', function () {{\n", category));
780
781            if self.config.all_operations {
782                // All-operations mode: test every operation, using path-qualified check names
783                let mut emitted_checks: HashSet<String> = HashSet::new();
784                for (op, feature) in ops {
785                    let qualified = format!("{}:{}", feature.check_name(), op.path);
786                    if emitted_checks.insert(qualified.clone()) {
787                        self.emit_check_named(&mut script, op, feature, &qualified);
788                        total_checks += 1;
789                    }
790                }
791            } else {
792                // Default: one representative operation per feature, with path-qualified
793                // check names so failures identify which endpoint was tested.
794                let mut emitted_features: HashSet<&str> = HashSet::new();
795                for (op, feature) in ops {
796                    if emitted_features.insert(feature.check_name()) {
797                        let qualified = format!("{}:{}", feature.check_name(), op.path);
798                        self.emit_check_named(&mut script, op, feature, &qualified);
799                        total_checks += 1;
800                    }
801                }
802            }
803
804            script.push_str("  });\n\n");
805        }
806
807        // Custom checks from YAML file
808        if let Some(custom_group) = self.config.generate_custom_group()? {
809            script.push_str(&custom_group);
810        }
811
812        script.push_str("}\n\n");
813
814        // handleSummary
815        self.generate_handle_summary(&mut script);
816
817        Ok((script, total_checks))
818    }
819
820    /// Emit a single k6 check for an operation + feature with a custom check name
821    fn emit_check_named(
822        &self,
823        script: &mut String,
824        op: &AnnotatedOperation,
825        feature: &ConformanceFeature,
826        check_name: &str,
827    ) {
828        // Escape single quotes in check name since it's embedded in JS single-quoted strings
829        let check_name = check_name.replace('\'', "\\'");
830        let check_name = check_name.as_str();
831
832        script.push_str("    {\n");
833
834        // Build the URL path with parameters substituted
835        let mut url_path = op.path.clone();
836        for (name, value) in &op.path_params {
837            url_path = url_path.replace(&format!("{{{}}}", name), value);
838        }
839
840        // Build query string
841        if !op.query_params.is_empty() {
842            let qs: Vec<String> =
843                op.query_params.iter().map(|(k, v)| format!("{}={}", k, v)).collect();
844            url_path = format!("{}?{}", url_path, qs.join("&"));
845        }
846
847        let full_url = format!("${{BASE_URL}}{}", url_path);
848
849        // Build effective headers: merge spec-derived headers with custom headers.
850        // Custom headers override spec-derived ones with the same name.
851        let mut effective_headers = self.effective_headers(&op.header_params);
852
853        // For non-default response code checks, add header to tell the mock server
854        // which status code to return (the server defaults to the first declared status)
855        if matches!(feature, ConformanceFeature::Response400 | ConformanceFeature::Response404) {
856            let expected_code = match feature {
857                ConformanceFeature::Response400 => "400",
858                ConformanceFeature::Response404 => "404",
859                _ => unreachable!(),
860            };
861            effective_headers
862                .push(("X-Mockforge-Response-Status".to_string(), expected_code.to_string()));
863        }
864
865        // For security checks AND for all requests on endpoints with security requirements,
866        // inject auth credentials so the server doesn't reject with 401.
867        // Only inject if the user hasn't already provided the header via --custom-headers.
868        let needs_auth = matches!(
869            feature,
870            ConformanceFeature::SecurityBearer
871                | ConformanceFeature::SecurityBasic
872                | ConformanceFeature::SecurityApiKey
873        ) || !op.security_schemes.is_empty();
874
875        if needs_auth {
876            self.inject_security_headers(&op.security_schemes, &mut effective_headers);
877        }
878
879        let has_headers = !effective_headers.is_empty();
880        let headers_obj = if has_headers {
881            Self::format_headers(&effective_headers)
882        } else {
883            String::new()
884        };
885
886        // Determine HTTP method and emit request
887        match op.method.as_str() {
888            "GET" => {
889                if has_headers {
890                    script.push_str(&format!(
891                        "      let res = http.get(`{}`, {{ headers: {} }});\n",
892                        full_url, headers_obj
893                    ));
894                } else {
895                    script.push_str(&format!("      let res = http.get(`{}`);\n", full_url));
896                }
897            }
898            "POST" => {
899                self.emit_request_with_body(script, "post", &full_url, op, &effective_headers);
900            }
901            "PUT" => {
902                self.emit_request_with_body(script, "put", &full_url, op, &effective_headers);
903            }
904            "PATCH" => {
905                self.emit_request_with_body(script, "patch", &full_url, op, &effective_headers);
906            }
907            "DELETE" => {
908                if has_headers {
909                    script.push_str(&format!(
910                        "      let res = http.del(`{}`, null, {{ headers: {} }});\n",
911                        full_url, headers_obj
912                    ));
913                } else {
914                    script.push_str(&format!("      let res = http.del(`{}`);\n", full_url));
915                }
916            }
917            "HEAD" => {
918                if has_headers {
919                    script.push_str(&format!(
920                        "      let res = http.head(`{}`, {{ headers: {} }});\n",
921                        full_url, headers_obj
922                    ));
923                } else {
924                    script.push_str(&format!("      let res = http.head(`{}`);\n", full_url));
925                }
926            }
927            "OPTIONS" => {
928                if has_headers {
929                    script.push_str(&format!(
930                        "      let res = http.options(`{}`, null, {{ headers: {} }});\n",
931                        full_url, headers_obj
932                    ));
933                } else {
934                    script.push_str(&format!("      let res = http.options(`{}`);\n", full_url));
935                }
936            }
937            _ => {
938                if has_headers {
939                    script.push_str(&format!(
940                        "      let res = http.get(`{}`, {{ headers: {} }});\n",
941                        full_url, headers_obj
942                    ));
943                } else {
944                    script.push_str(&format!("      let res = http.get(`{}`);\n", full_url));
945                }
946            }
947        }
948
949        // Capture request/response for --export-requests
950        if self.config.export_requests {
951            script.push_str(&format!(
952                "      if (typeof __captureExchange === 'function') __captureExchange('{}', res);\n",
953                check_name.replace('\'', "\\'")
954            ));
955        }
956
957        // Check: emit assertion based on feature type, with failure detail capture
958        if matches!(
959            feature,
960            ConformanceFeature::Response200
961                | ConformanceFeature::Response201
962                | ConformanceFeature::Response204
963                | ConformanceFeature::Response400
964                | ConformanceFeature::Response404
965        ) {
966            let expected_code = match feature {
967                ConformanceFeature::Response200 => 200,
968                ConformanceFeature::Response201 => 201,
969                ConformanceFeature::Response204 => 204,
970                ConformanceFeature::Response400 => 400,
971                ConformanceFeature::Response404 => 404,
972                _ => 200,
973            };
974            script.push_str(&format!(
975                "      {{ let ok = check(res, {{ '{}': (r) => r.status === {} }}); if (!ok) __captureFailure('{}', res, 'status === {}'); }}\n",
976                check_name, expected_code, check_name, expected_code
977            ));
978        } else if matches!(feature, ConformanceFeature::ResponseValidation) {
979            // Response schema validation — validate the response body against the schema
980            // Uses inline field-level error collection so failure details include
981            // which specific fields violated the schema (field_path, violation_type,
982            // expected, actual) — matching the Ajv `errors` array structure.
983            if let Some(schema) = &op.response_schema {
984                let validation_js = SchemaValidatorGenerator::generate_validation(schema);
985                let schema_json = serde_json::to_string(schema).unwrap_or_default();
986                // Escape backticks and backslashes for JS template literal safety
987                let schema_json_escaped = schema_json.replace('\\', "\\\\").replace('`', "\\`");
988                script.push_str(&format!(
989                    concat!(
990                        "      try {{\n",
991                        "        let body = res.json();\n",
992                        "        let ok = check(res, {{ '{check}': (r) => ( {validation} ) }});\n",
993                        "        if (!ok) {{\n",
994                        "          let __violations = [];\n",
995                        "          try {{\n",
996                        "            let __schema = JSON.parse(`{schema}`);\n",
997                        "            function __collectErrors(schema, data, path) {{\n",
998                        "              if (!schema || typeof schema !== 'object') return;\n",
999                        "              let st = schema.type || (schema.schema_kind && schema.schema_kind.Type && Object.keys(schema.schema_kind.Type)[0]);\n",
1000                        "              if (st) {{ st = st.toLowerCase(); }}\n",
1001                        "              if (st === 'object') {{\n",
1002                        "                if (typeof data !== 'object' || data === null) {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'object', actual: typeof data }}); return; }}\n",
1003                        "                let props = schema.properties || (schema.schema_kind && schema.schema_kind.Type && schema.schema_kind.Type.Object && schema.schema_kind.Type.Object.properties) || {{}};\n",
1004                        "                let req = schema.required || (schema.schema_kind && schema.schema_kind.Type && schema.schema_kind.Type.Object && schema.schema_kind.Type.Object.required) || [];\n",
1005                        "                for (let f of req) {{ if (!(f in data)) {{ __violations.push({{ field_path: path + '/' + f, violation_type: 'required', expected: 'present', actual: 'missing' }}); }} }}\n",
1006                        "                for (let [k, v] of Object.entries(props)) {{ if (data[k] !== undefined) {{ let ps = v.Item || v; __collectErrors(ps, data[k], path + '/' + k); }} }}\n",
1007                        "              }} else if (st === 'array') {{\n",
1008                        "                if (!Array.isArray(data)) {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'array', actual: typeof data }}); return; }}\n",
1009                        "                let items = schema.items || (schema.schema_kind && schema.schema_kind.Type && schema.schema_kind.Type.Array && schema.schema_kind.Type.Array.items);\n",
1010                        "                if (items) {{ let is = items.Item || items; for (let i = 0; i < Math.min(data.length, 5); i++) {{ __collectErrors(is, data[i], path + '/' + i); }} }}\n",
1011                        "              }} else if (st === 'string') {{\n",
1012                        "                if (typeof data !== 'string') {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'string', actual: typeof data }}); }}\n",
1013                        "              }} else if (st === 'integer') {{\n",
1014                        "                if (typeof data !== 'number' || !Number.isInteger(data)) {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'integer', actual: typeof data }}); }}\n",
1015                        "              }} else if (st === 'number') {{\n",
1016                        "                if (typeof data !== 'number') {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'number', actual: typeof data }}); }}\n",
1017                        "              }} else if (st === 'boolean') {{\n",
1018                        "                if (typeof data !== 'boolean') {{ __violations.push({{ field_path: path || '/', violation_type: 'type', expected: 'boolean', actual: typeof data }}); }}\n",
1019                        "              }}\n",
1020                        "            }}\n",
1021                        "            __collectErrors(__schema, body, '');\n",
1022                        "          }} catch(_e) {{}}\n",
1023                        "          __captureFailure('{check}', res, 'schema validation', __violations);\n",
1024                        "        }}\n",
1025                        "      }} catch(e) {{ check(res, {{ '{check}': () => false }}); __captureFailure('{check}', res, 'JSON parse failed: ' + e.message); }}\n",
1026                    ),
1027                    check = check_name,
1028                    validation = validation_js,
1029                    schema = schema_json_escaped,
1030                ));
1031            }
1032        } else if matches!(
1033            feature,
1034            ConformanceFeature::SecurityBearer
1035                | ConformanceFeature::SecurityBasic
1036                | ConformanceFeature::SecurityApiKey
1037        ) {
1038            // Security checks verify the server accepts the auth credentials (not 401/403)
1039            script.push_str(&format!(
1040                "      {{ let ok = check(res, {{ '{}': (r) => r.status >= 200 && r.status < 400 }}); if (!ok) __captureFailure('{}', res, 'status >= 200 && status < 400 (auth accepted)'); }}\n",
1041                check_name, check_name
1042            ));
1043        } else {
1044            script.push_str(&format!(
1045                "      {{ let ok = check(res, {{ '{}': (r) => r.status >= 200 && r.status < 500 }}); if (!ok) __captureFailure('{}', res, 'status >= 200 && status < 500'); }}\n",
1046                check_name, check_name
1047            ));
1048        }
1049
1050        // Clear cookie jar after each request to prevent Set-Cookie leaking
1051        let has_cookie = self.config.has_cookie_header()
1052            || effective_headers.iter().any(|(h, _)| h.eq_ignore_ascii_case("Cookie"));
1053        if has_cookie {
1054            script.push_str("      http.cookieJar().clear(BASE_URL);\n");
1055        }
1056
1057        script.push_str("    }\n");
1058
1059        // Rate-limit delay between checks (to avoid 429 from target API)
1060        if self.config.request_delay_ms > 0 {
1061            script.push_str(&format!(
1062                "    sleep({:.3});\n",
1063                self.config.request_delay_ms as f64 / 1000.0
1064            ));
1065        }
1066    }
1067
1068    /// Emit an HTTP request with a body
1069    fn emit_request_with_body(
1070        &self,
1071        script: &mut String,
1072        method: &str,
1073        url: &str,
1074        op: &AnnotatedOperation,
1075        effective_headers: &[(String, String)],
1076    ) {
1077        if let Some(body) = &op.sample_body {
1078            let escaped_body = body.replace('\'', "\\'");
1079            let headers = if !effective_headers.is_empty() {
1080                format!(
1081                    "Object.assign({{}}, JSON_HEADERS, {})",
1082                    Self::format_headers(effective_headers)
1083                )
1084            } else {
1085                "JSON_HEADERS".to_string()
1086            };
1087            script.push_str(&format!(
1088                "      let res = http.{}(`{}`, '{}', {{ headers: {} }});\n",
1089                method, url, escaped_body, headers
1090            ));
1091        } else if !effective_headers.is_empty() {
1092            script.push_str(&format!(
1093                "      let res = http.{}(`{}`, null, {{ headers: {} }});\n",
1094                method,
1095                url,
1096                Self::format_headers(effective_headers)
1097            ));
1098        } else {
1099            script.push_str(&format!("      let res = http.{}(`{}`, null);\n", method, url));
1100        }
1101    }
1102
1103    /// Build effective headers by merging spec-derived headers with custom headers.
1104    /// Custom headers override spec-derived ones with the same name (case-insensitive).
1105    /// Custom headers not in the spec are appended.
1106    fn effective_headers(&self, spec_headers: &[(String, String)]) -> Vec<(String, String)> {
1107        let custom = &self.config.custom_headers;
1108        if custom.is_empty() {
1109            return spec_headers.to_vec();
1110        }
1111
1112        let mut result: Vec<(String, String)> = Vec::new();
1113
1114        // Start with spec headers, replacing values if a custom header matches
1115        for (name, value) in spec_headers {
1116            if let Some((_, custom_val)) =
1117                custom.iter().find(|(cn, _)| cn.eq_ignore_ascii_case(name))
1118            {
1119                result.push((name.clone(), custom_val.clone()));
1120            } else {
1121                result.push((name.clone(), value.clone()));
1122            }
1123        }
1124
1125        // Append custom headers that aren't already in spec headers
1126        for (name, value) in custom {
1127            if !spec_headers.iter().any(|(sn, _)| sn.eq_ignore_ascii_case(name)) {
1128                result.push((name.clone(), value.clone()));
1129            }
1130        }
1131
1132        result
1133    }
1134
1135    /// Inject security headers based on resolved security scheme details.
1136    /// Respects user-provided custom headers (won't overwrite if already set).
1137    fn inject_security_headers(
1138        &self,
1139        schemes: &[SecuritySchemeInfo],
1140        headers: &mut Vec<(String, String)>,
1141    ) {
1142        let mut to_add: Vec<(String, String)> = Vec::new();
1143
1144        let has_header = |name: &str, headers: &[(String, String)]| {
1145            headers.iter().any(|(h, _)| h.eq_ignore_ascii_case(name))
1146                || self.config.custom_headers.iter().any(|(h, _)| h.eq_ignore_ascii_case(name))
1147        };
1148
1149        // If user provides Cookie header, they're using session-based auth — skip auto auth
1150        let has_cookie_auth = has_header("Cookie", headers);
1151
1152        for scheme in schemes {
1153            match scheme {
1154                SecuritySchemeInfo::Bearer => {
1155                    if !has_cookie_auth && !has_header("Authorization", headers) {
1156                        // MockForge mock server accepts any Bearer token
1157                        to_add.push((
1158                            "Authorization".to_string(),
1159                            "Bearer mockforge-conformance-test-token".to_string(),
1160                        ));
1161                    }
1162                }
1163                SecuritySchemeInfo::Basic => {
1164                    if !has_cookie_auth && !has_header("Authorization", headers) {
1165                        let creds = self.config.basic_auth.as_deref().unwrap_or("test:test");
1166                        use base64::Engine;
1167                        let encoded =
1168                            base64::engine::general_purpose::STANDARD.encode(creds.as_bytes());
1169                        to_add.push(("Authorization".to_string(), format!("Basic {}", encoded)));
1170                    }
1171                }
1172                SecuritySchemeInfo::ApiKey { location, name } => match location {
1173                    ApiKeyLocation::Header => {
1174                        if !has_header(name, headers) {
1175                            let key = self
1176                                .config
1177                                .api_key
1178                                .as_deref()
1179                                .unwrap_or("mockforge-conformance-test-key");
1180                            to_add.push((name.clone(), key.to_string()));
1181                        }
1182                    }
1183                    ApiKeyLocation::Cookie => {
1184                        if !has_header("Cookie", headers) {
1185                            to_add.push((
1186                                "Cookie".to_string(),
1187                                format!("{}=mockforge-conformance-test-session", name),
1188                            ));
1189                        }
1190                    }
1191                    ApiKeyLocation::Query => {
1192                        // Query params are handled via URL, not headers — skip here
1193                    }
1194                },
1195            }
1196        }
1197
1198        headers.extend(to_add);
1199    }
1200
1201    /// Format header params as a JS object literal
1202    fn format_headers(headers: &[(String, String)]) -> String {
1203        let entries: Vec<String> = headers
1204            .iter()
1205            .map(|(k, v)| format!("'{}': '{}'", k, v.replace('\'', "\\'")))
1206            .collect();
1207        format!("{{ {} }}", entries.join(", "))
1208    }
1209
1210    /// handleSummary — same format as reference mode for report compatibility
1211    fn generate_handle_summary(&self, script: &mut String) {
1212        // Use absolute path for report output so k6 writes where the CLI expects
1213        let report_path = match &self.config.output_dir {
1214            Some(dir) => {
1215                let abs = std::fs::canonicalize(dir)
1216                    .unwrap_or_else(|_| dir.clone())
1217                    .join("conformance-report.json");
1218                abs.to_string_lossy().to_string()
1219            }
1220            None => "conformance-report.json".to_string(),
1221        };
1222
1223        script.push_str("export function handleSummary(data) {\n");
1224        script.push_str("  let checks = {};\n");
1225        script.push_str("  if (data.metrics && data.metrics.checks) {\n");
1226        script.push_str("    checks.overall_pass_rate = data.metrics.checks.values.rate;\n");
1227        script.push_str("  }\n");
1228        script.push_str("  let checkResults = {};\n");
1229        script.push_str("  function walkGroups(group) {\n");
1230        script.push_str("    if (group.checks) {\n");
1231        script.push_str("      for (let checkObj of group.checks) {\n");
1232        script.push_str("        checkResults[checkObj.name] = {\n");
1233        script.push_str("          passes: checkObj.passes,\n");
1234        script.push_str("          fails: checkObj.fails,\n");
1235        script.push_str("        };\n");
1236        script.push_str("      }\n");
1237        script.push_str("    }\n");
1238        script.push_str("    if (group.groups) {\n");
1239        script.push_str("      for (let subGroup of group.groups) {\n");
1240        script.push_str("        walkGroups(subGroup);\n");
1241        script.push_str("      }\n");
1242        script.push_str("    }\n");
1243        script.push_str("  }\n");
1244        script.push_str("  if (data.root_group) {\n");
1245        script.push_str("    walkGroups(data.root_group);\n");
1246        script.push_str("  }\n");
1247        script.push_str("  return {\n");
1248        script.push_str(&format!(
1249            "    '{}': JSON.stringify({{ checks: checkResults, overall: checks }}, null, 2),\n",
1250            report_path
1251        ));
1252        script.push_str("    'summary.json': JSON.stringify(data),\n");
1253        script.push_str("    stdout: textSummary(data, { indent: '  ', enableColors: true }),\n");
1254        script.push_str("  };\n");
1255        script.push_str("}\n\n");
1256        script.push_str("function textSummary(data, opts) {\n");
1257        script.push_str("  return JSON.stringify(data, null, 2);\n");
1258        script.push_str("}\n");
1259    }
1260}
1261
1262#[cfg(test)]
1263mod tests {
1264    use super::*;
1265    use openapiv3::{
1266        Operation, ParameterData, ParameterSchemaOrContent, PathStyle, Response, Schema,
1267        SchemaData, SchemaKind, StringType, Type,
1268    };
1269
1270    fn make_op(method: &str, path: &str, operation: Operation) -> ApiOperation {
1271        ApiOperation {
1272            method: method.to_string(),
1273            path: path.to_string(),
1274            operation,
1275            operation_id: None,
1276        }
1277    }
1278
1279    fn empty_spec() -> OpenAPI {
1280        OpenAPI::default()
1281    }
1282
1283    #[test]
1284    fn test_annotate_get_with_path_param() {
1285        let mut op = Operation::default();
1286        op.parameters.push(ReferenceOr::Item(Parameter::Path {
1287            parameter_data: ParameterData {
1288                name: "id".to_string(),
1289                description: None,
1290                required: true,
1291                deprecated: None,
1292                format: ParameterSchemaOrContent::Schema(ReferenceOr::Item(Schema {
1293                    schema_data: SchemaData::default(),
1294                    schema_kind: SchemaKind::Type(Type::String(StringType::default())),
1295                })),
1296                example: None,
1297                examples: Default::default(),
1298                explode: None,
1299                extensions: Default::default(),
1300            },
1301            style: PathStyle::Simple,
1302        }));
1303
1304        let api_op = make_op("get", "/users/{id}", op);
1305        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1306
1307        assert!(annotated.features.contains(&ConformanceFeature::MethodGet));
1308        assert!(annotated.features.contains(&ConformanceFeature::PathParamString));
1309        assert!(annotated.features.contains(&ConformanceFeature::ConstraintRequired));
1310        assert_eq!(annotated.path_params.len(), 1);
1311        assert_eq!(annotated.path_params[0].0, "id");
1312    }
1313
1314    #[test]
1315    fn test_annotate_post_with_json_body() {
1316        let mut op = Operation::default();
1317        let mut body = openapiv3::RequestBody {
1318            required: true,
1319            ..Default::default()
1320        };
1321        body.content
1322            .insert("application/json".to_string(), openapiv3::MediaType::default());
1323        op.request_body = Some(ReferenceOr::Item(body));
1324
1325        let api_op = make_op("post", "/items", op);
1326        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1327
1328        assert!(annotated.features.contains(&ConformanceFeature::MethodPost));
1329        assert!(annotated.features.contains(&ConformanceFeature::BodyJson));
1330    }
1331
1332    #[test]
1333    fn test_annotate_response_codes() {
1334        let mut op = Operation::default();
1335        op.responses
1336            .responses
1337            .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(Response::default()));
1338        op.responses
1339            .responses
1340            .insert(openapiv3::StatusCode::Code(404), ReferenceOr::Item(Response::default()));
1341
1342        let api_op = make_op("get", "/items", op);
1343        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1344
1345        assert!(annotated.features.contains(&ConformanceFeature::Response200));
1346        assert!(annotated.features.contains(&ConformanceFeature::Response404));
1347    }
1348
1349    #[test]
1350    fn test_generate_spec_driven_script() {
1351        let config = ConformanceConfig {
1352            target_url: "http://localhost:3000".to_string(),
1353            api_key: None,
1354            basic_auth: None,
1355            skip_tls_verify: false,
1356            categories: None,
1357            base_path: None,
1358            custom_headers: vec![],
1359            output_dir: None,
1360            all_operations: false,
1361            custom_checks_file: None,
1362            request_delay_ms: 0,
1363            custom_filter: None,
1364            export_requests: false,
1365            validate_requests: false,
1366        };
1367
1368        let operations = vec![AnnotatedOperation {
1369            path: "/users/{id}".to_string(),
1370            method: "GET".to_string(),
1371            features: vec![
1372                ConformanceFeature::MethodGet,
1373                ConformanceFeature::PathParamString,
1374            ],
1375            request_body_content_type: None,
1376            sample_body: None,
1377            query_params: vec![],
1378            header_params: vec![],
1379            path_params: vec![("id".to_string(), "test-value".to_string())],
1380            response_schema: None,
1381            security_schemes: vec![],
1382        }];
1383
1384        let gen = SpecDrivenConformanceGenerator::new(config, operations);
1385        let (script, _check_count) = gen.generate().unwrap();
1386
1387        assert!(script.contains("import http from 'k6/http'"));
1388        assert!(script.contains("/users/test-value"));
1389        assert!(script.contains("param:path:string"));
1390        assert!(script.contains("method:GET"));
1391        assert!(script.contains("handleSummary"));
1392    }
1393
1394    #[test]
1395    fn test_generate_with_category_filter() {
1396        let config = ConformanceConfig {
1397            target_url: "http://localhost:3000".to_string(),
1398            api_key: None,
1399            basic_auth: None,
1400            skip_tls_verify: false,
1401            categories: Some(vec!["Parameters".to_string()]),
1402            base_path: None,
1403            custom_headers: vec![],
1404            output_dir: None,
1405            all_operations: false,
1406            custom_checks_file: None,
1407            request_delay_ms: 0,
1408            custom_filter: None,
1409            export_requests: false,
1410            validate_requests: false,
1411        };
1412
1413        let operations = vec![AnnotatedOperation {
1414            path: "/users/{id}".to_string(),
1415            method: "GET".to_string(),
1416            features: vec![
1417                ConformanceFeature::MethodGet,
1418                ConformanceFeature::PathParamString,
1419            ],
1420            request_body_content_type: None,
1421            sample_body: None,
1422            query_params: vec![],
1423            header_params: vec![],
1424            path_params: vec![("id".to_string(), "1".to_string())],
1425            response_schema: None,
1426            security_schemes: vec![],
1427        }];
1428
1429        let gen = SpecDrivenConformanceGenerator::new(config, operations);
1430        let (script, _check_count) = gen.generate().unwrap();
1431
1432        assert!(script.contains("group('Parameters'"));
1433        assert!(!script.contains("group('HTTP Methods'"));
1434    }
1435
1436    #[test]
1437    fn test_annotate_response_validation() {
1438        use openapiv3::ObjectType;
1439
1440        // Operation with a 200 response that has a JSON schema
1441        let mut op = Operation::default();
1442        let mut response = Response::default();
1443        let mut media = openapiv3::MediaType::default();
1444        let mut obj_type = ObjectType::default();
1445        obj_type.properties.insert(
1446            "name".to_string(),
1447            ReferenceOr::Item(Box::new(Schema {
1448                schema_data: SchemaData::default(),
1449                schema_kind: SchemaKind::Type(Type::String(StringType::default())),
1450            })),
1451        );
1452        obj_type.required = vec!["name".to_string()];
1453        media.schema = Some(ReferenceOr::Item(Schema {
1454            schema_data: SchemaData::default(),
1455            schema_kind: SchemaKind::Type(Type::Object(obj_type)),
1456        }));
1457        response.content.insert("application/json".to_string(), media);
1458        op.responses
1459            .responses
1460            .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1461
1462        let api_op = make_op("get", "/users", op);
1463        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1464
1465        assert!(
1466            annotated.features.contains(&ConformanceFeature::ResponseValidation),
1467            "Should detect ResponseValidation when response has a JSON schema"
1468        );
1469        assert!(annotated.response_schema.is_some(), "Should extract the response schema");
1470
1471        // Verify generated script includes schema validation with try-catch
1472        let config = ConformanceConfig {
1473            target_url: "http://localhost:3000".to_string(),
1474            api_key: None,
1475            basic_auth: None,
1476            skip_tls_verify: false,
1477            categories: None,
1478            base_path: None,
1479            custom_headers: vec![],
1480            output_dir: None,
1481            all_operations: false,
1482            custom_checks_file: None,
1483            request_delay_ms: 0,
1484            custom_filter: None,
1485            export_requests: false,
1486            validate_requests: false,
1487        };
1488        let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1489        let (script, _check_count) = gen.generate().unwrap();
1490
1491        assert!(
1492            script.contains("response:schema:validation"),
1493            "Script should contain the validation check name"
1494        );
1495        assert!(script.contains("try {"), "Script should wrap validation in try-catch");
1496        assert!(script.contains("res.json()"), "Script should parse response as JSON");
1497    }
1498
1499    #[test]
1500    fn test_annotate_global_security() {
1501        // Spec with global security requirement, operation without its own security
1502        let op = Operation::default();
1503        let mut spec = OpenAPI::default();
1504        let mut global_req = openapiv3::SecurityRequirement::new();
1505        global_req.insert("bearerAuth".to_string(), vec![]);
1506        spec.security = Some(vec![global_req]);
1507        // Define the security scheme in components
1508        let mut components = openapiv3::Components::default();
1509        components.security_schemes.insert(
1510            "bearerAuth".to_string(),
1511            ReferenceOr::Item(SecurityScheme::HTTP {
1512                scheme: "bearer".to_string(),
1513                bearer_format: Some("JWT".to_string()),
1514                description: None,
1515                extensions: Default::default(),
1516            }),
1517        );
1518        spec.components = Some(components);
1519
1520        let api_op = make_op("get", "/protected", op);
1521        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1522
1523        assert!(
1524            annotated.features.contains(&ConformanceFeature::SecurityBearer),
1525            "Should detect SecurityBearer from global security + components"
1526        );
1527    }
1528
1529    #[test]
1530    fn test_annotate_security_scheme_resolution() {
1531        // Test that security scheme type is resolved from components, not just name heuristic
1532        let mut op = Operation::default();
1533        // Use a generic name that wouldn't match name heuristics
1534        let mut req = openapiv3::SecurityRequirement::new();
1535        req.insert("myAuth".to_string(), vec![]);
1536        op.security = Some(vec![req]);
1537
1538        let mut spec = OpenAPI::default();
1539        let mut components = openapiv3::Components::default();
1540        components.security_schemes.insert(
1541            "myAuth".to_string(),
1542            ReferenceOr::Item(SecurityScheme::APIKey {
1543                location: openapiv3::APIKeyLocation::Header,
1544                name: "X-API-Key".to_string(),
1545                description: None,
1546                extensions: Default::default(),
1547            }),
1548        );
1549        spec.components = Some(components);
1550
1551        let api_op = make_op("get", "/data", op);
1552        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &spec);
1553
1554        assert!(
1555            annotated.features.contains(&ConformanceFeature::SecurityApiKey),
1556            "Should detect SecurityApiKey from SecurityScheme::APIKey, not name heuristic"
1557        );
1558    }
1559
1560    #[test]
1561    fn test_annotate_content_negotiation() {
1562        let mut op = Operation::default();
1563        let mut response = Response::default();
1564        // Response with multiple content types
1565        response
1566            .content
1567            .insert("application/json".to_string(), openapiv3::MediaType::default());
1568        response
1569            .content
1570            .insert("application/xml".to_string(), openapiv3::MediaType::default());
1571        op.responses
1572            .responses
1573            .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1574
1575        let api_op = make_op("get", "/items", op);
1576        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1577
1578        assert!(
1579            annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1580            "Should detect ContentNegotiation when response has multiple content types"
1581        );
1582    }
1583
1584    #[test]
1585    fn test_no_content_negotiation_for_single_type() {
1586        let mut op = Operation::default();
1587        let mut response = Response::default();
1588        response
1589            .content
1590            .insert("application/json".to_string(), openapiv3::MediaType::default());
1591        op.responses
1592            .responses
1593            .insert(openapiv3::StatusCode::Code(200), ReferenceOr::Item(response));
1594
1595        let api_op = make_op("get", "/items", op);
1596        let annotated = SpecDrivenConformanceGenerator::annotate_operation(&api_op, &empty_spec());
1597
1598        assert!(
1599            !annotated.features.contains(&ConformanceFeature::ContentNegotiation),
1600            "Should NOT detect ContentNegotiation for a single content type"
1601        );
1602    }
1603
1604    #[test]
1605    fn test_spec_driven_with_base_path() {
1606        let annotated = AnnotatedOperation {
1607            path: "/users".to_string(),
1608            method: "GET".to_string(),
1609            features: vec![ConformanceFeature::MethodGet],
1610            path_params: vec![],
1611            query_params: vec![],
1612            header_params: vec![],
1613            request_body_content_type: None,
1614            sample_body: None,
1615            response_schema: None,
1616            security_schemes: vec![],
1617        };
1618        let config = ConformanceConfig {
1619            target_url: "https://192.168.2.86/".to_string(),
1620            api_key: None,
1621            basic_auth: None,
1622            skip_tls_verify: true,
1623            categories: None,
1624            base_path: Some("/api".to_string()),
1625            custom_headers: vec![],
1626            output_dir: None,
1627            all_operations: false,
1628            custom_checks_file: None,
1629            request_delay_ms: 0,
1630            custom_filter: None,
1631            export_requests: false,
1632            validate_requests: false,
1633        };
1634        let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1635        let (script, _check_count) = gen.generate().unwrap();
1636
1637        assert!(
1638            script.contains("const BASE_URL = 'https://192.168.2.86/api'"),
1639            "BASE_URL should include the base_path. Got: {}",
1640            script.lines().find(|l| l.contains("BASE_URL")).unwrap_or("not found")
1641        );
1642    }
1643
1644    #[test]
1645    fn test_spec_driven_with_custom_headers() {
1646        let annotated = AnnotatedOperation {
1647            path: "/users".to_string(),
1648            method: "GET".to_string(),
1649            features: vec![ConformanceFeature::MethodGet],
1650            path_params: vec![],
1651            query_params: vec![],
1652            header_params: vec![
1653                ("X-Avi-Tenant".to_string(), "test-value".to_string()),
1654                ("X-CSRFToken".to_string(), "test-value".to_string()),
1655            ],
1656            request_body_content_type: None,
1657            sample_body: None,
1658            response_schema: None,
1659            security_schemes: vec![],
1660        };
1661        let config = ConformanceConfig {
1662            target_url: "https://192.168.2.86/".to_string(),
1663            api_key: None,
1664            basic_auth: None,
1665            skip_tls_verify: true,
1666            categories: None,
1667            base_path: Some("/api".to_string()),
1668            custom_headers: vec![
1669                ("X-Avi-Tenant".to_string(), "admin".to_string()),
1670                ("X-CSRFToken".to_string(), "real-csrf-token".to_string()),
1671                ("Cookie".to_string(), "sessionid=abc123".to_string()),
1672            ],
1673            output_dir: None,
1674            all_operations: false,
1675            custom_checks_file: None,
1676            request_delay_ms: 0,
1677            custom_filter: None,
1678            export_requests: false,
1679            validate_requests: false,
1680        };
1681        let gen = SpecDrivenConformanceGenerator::new(config, vec![annotated]);
1682        let (script, _check_count) = gen.generate().unwrap();
1683
1684        // Custom headers should override spec-derived test-value placeholders
1685        assert!(
1686            script.contains("'X-Avi-Tenant': 'admin'"),
1687            "Should use custom value for X-Avi-Tenant, not test-value"
1688        );
1689        assert!(
1690            script.contains("'X-CSRFToken': 'real-csrf-token'"),
1691            "Should use custom value for X-CSRFToken, not test-value"
1692        );
1693        // Custom headers not in spec should be appended
1694        assert!(
1695            script.contains("'Cookie': 'sessionid=abc123'"),
1696            "Should include Cookie header from custom_headers"
1697        );
1698        // test-value should NOT appear
1699        assert!(
1700            !script.contains("'test-value'"),
1701            "test-value placeholders should be replaced by custom values"
1702        );
1703    }
1704
1705    #[test]
1706    fn test_effective_headers_merging() {
1707        let config = ConformanceConfig {
1708            target_url: "http://localhost".to_string(),
1709            api_key: None,
1710            basic_auth: None,
1711            skip_tls_verify: false,
1712            categories: None,
1713            base_path: None,
1714            custom_headers: vec![
1715                ("X-Auth".to_string(), "real-token".to_string()),
1716                ("Cookie".to_string(), "session=abc".to_string()),
1717            ],
1718            output_dir: None,
1719            all_operations: false,
1720            custom_checks_file: None,
1721            request_delay_ms: 0,
1722            custom_filter: None,
1723            export_requests: false,
1724            validate_requests: false,
1725        };
1726        let gen = SpecDrivenConformanceGenerator::new(config, vec![]);
1727
1728        // Spec headers with a matching custom header
1729        let spec_headers = vec![
1730            ("X-Auth".to_string(), "test-value".to_string()),
1731            ("X-Other".to_string(), "keep-this".to_string()),
1732        ];
1733        let effective = gen.effective_headers(&spec_headers);
1734
1735        // X-Auth should be overridden
1736        assert_eq!(effective[0], ("X-Auth".to_string(), "real-token".to_string()));
1737        // X-Other should be kept as-is
1738        assert_eq!(effective[1], ("X-Other".to_string(), "keep-this".to_string()));
1739        // Cookie should be appended
1740        assert_eq!(effective[2], ("Cookie".to_string(), "session=abc".to_string()));
1741    }
1742}