Skip to main content

mockforge_bench/
executor.rs

1//! k6 execution and output handling
2
3use crate::error::{BenchError, Result};
4use indicatif::{ProgressBar, ProgressStyle};
5use std::path::Path;
6use std::process::Stdio;
7use std::sync::Arc;
8use tokio::io::{AsyncBufReadExt, BufReader};
9use tokio::process::Command as TokioCommand;
10
11/// Extract a `MOCKFORGE_<KIND>:` JSON payload from a k6 output line.
12///
13/// k6 emits these via `console.log`, which goes through one of two paths
14/// depending on the runner config:
15/// - **Raw**: `MOCKFORGE_EXCHANGE:{"check":"...", ...}` straight to stdout.
16/// - **Logfmt**: `time="..." level=info msg="MOCKFORGE_EXCHANGE:{...}" source=console`
17///   where the JSON's `"` are escaped as `\"` and `\` as `\\` so it fits
18///   inside the `msg="..."` field.
19///
20/// Round 46 (#79) — Srikanth on 0.3.190: a multipart upload landed `[]`
21/// in `conformance-requests.json` even though `MOCKFORGE_EXCHANGE:` was
22/// present in the k6 log. Root cause: the previous parser used a naive
23/// `replace("\\\\", "\\").replace("\\\"", "\"")` chain. With binary
24/// multipart bytes the JSON content includes sequences like `\\"`
25/// (literal backslash followed by literal quote inside a JSON string),
26/// which logfmt-escapes to `\\\\\"`. The replace chain processed `\\`
27/// → `\` first, leaving `\\\"`, then `\"` → `"`, mangling the JSON.
28/// Replaced with a single character walk that consumes one logfmt
29/// escape at a time. Also rewrote the suffix-strip to scan for the
30/// matching closing `"` of the `msg="..."` field instead of a
31/// fixed-string suffix so we tolerate any trailing logfmt fields k6
32/// might add.
33fn extract_mockforge_marker_json(line: &str, marker: &str) -> Option<String> {
34    let start = line.find(marker)?;
35    let json_start = start + marker.len();
36    let rest = &line[json_start..];
37
38    // Is this the logfmt-wrapped form? The `msg="` opener sits 5 bytes
39    // before the marker. (Plain `msg=MOCKFORGE_...` would also be valid
40    // logfmt for a value with no spaces, but k6 always quote-wraps.)
41    let is_logfmt = start >= 5 && line.as_bytes().get(start - 5..start) == Some(b"msg=\"");
42    if is_logfmt {
43        // Walk forward until the unescaped closing `"` of msg=. Inside
44        // the field, `\\` is one escaped backslash and `\"` is one
45        // escaped quote — those bytes belong to the JSON content. Any
46        // unescaped `"` is the field terminator.
47        let bytes = rest.as_bytes();
48        let mut i = 0;
49        let mut out = String::with_capacity(rest.len());
50        while i < bytes.len() {
51            let b = bytes[i];
52            if b == b'"' {
53                // End of msg= field.
54                return Some(out);
55            }
56            if b == b'\\' && i + 1 < bytes.len() {
57                let next = bytes[i + 1];
58                match next {
59                    b'"' => out.push('"'),
60                    b'\\' => out.push('\\'),
61                    // Other escapes (`\n`, `\r`, `\t`, `\uXXXX`) are
62                    // PART of the JSON content — keep them verbatim so
63                    // serde_json::from_str interprets them.
64                    other => {
65                        out.push('\\');
66                        out.push(other as char);
67                    }
68                }
69                i += 2;
70                continue;
71            }
72            // Non-ASCII multi-byte UTF-8 codepoint or plain ASCII char.
73            // `rest` is a `&str` so we can rely on UTF-8 boundaries.
74            let ch_start = i;
75            // Advance i past the codepoint.
76            i += 1;
77            while i < bytes.len() && (bytes[i] & 0b1100_0000) == 0b1000_0000 {
78                i += 1;
79            }
80            out.push_str(&rest[ch_start..i]);
81        }
82        // Reached EOL without a closing quote — return what we have so
83        // the downstream parser can decide whether to keep it.
84        if out.is_empty() {
85            None
86        } else {
87            Some(out)
88        }
89    } else {
90        // Raw form: rest of the line is the JSON, possibly with trailing
91        // whitespace. No escape processing needed.
92        let trimmed = rest.trim();
93        if trimmed.is_empty() {
94            None
95        } else {
96            Some(trimmed.to_string())
97        }
98    }
99}
100
101/// Extract `MOCKFORGE_EXCHANGE:` JSON payload from a k6 output line (--export-requests).
102fn extract_exchange_json(line: &str) -> Option<String> {
103    extract_mockforge_marker_json(line, "MOCKFORGE_EXCHANGE:")
104}
105
106/// Extract `MOCKFORGE_FAILURE:` JSON payload from a k6 output line.
107fn extract_failure_json(line: &str) -> Option<String> {
108    extract_mockforge_marker_json(line, "MOCKFORGE_FAILURE:")
109}
110
111/// Round 47 (#79) — extract `MOCKFORGE_NETWORK_EVENT:` JSON payload.
112/// Emitted by the k6 captureExchange when `res.status === 0`, capturing
113/// the wire-level failure with a classified `kind`.
114fn extract_network_event_json(line: &str) -> Option<String> {
115    extract_mockforge_marker_json(line, "MOCKFORGE_NETWORK_EVENT:")
116}
117
118/// Merge `http2client=0` into `GODEBUG` without clobbering other flags.
119///
120/// Round 63 (#79) / grafana/k6#2222: k6 has no per-request HTTP/1.1 API.
121/// An explicit `http2client=` already in the environment is left alone.
122pub(crate) fn merge_godebug_http2client_off(existing: Option<&str>) -> String {
123    const FLAG: &str = "http2client=0";
124    let existing = existing.unwrap_or("").trim();
125    if existing.is_empty() {
126        return FLAG.to_string();
127    }
128    if existing.split(',').any(|part| part.trim().starts_with("http2client=")) {
129        return existing.to_string();
130    }
131    format!("{existing},{FLAG}")
132}
133
134/// k6 executor
135pub struct K6Executor {
136    k6_path: String,
137    /// Comma-joined IPs/ranges/CIDRs forwarded to `k6 run --local-ips`.
138    /// Empty → flag omitted. Populated by callers that pass through the
139    /// CLI's `--source-ip`; lets a VU make requests from one of several
140    /// bound interfaces (k6 supports this natively, contrary to my
141    /// round-22 warning).
142    local_ips: String,
143    /// Round 56 (#79) — when true, set `K6_DISCARD_RESPONSE_BODIES=true` so k6
144    /// does not buffer every response body in memory. On long, high-concurrency
145    /// multi-target runs (Srikanth on 0.3.203 saw `k6 ... signal: 9 (SIGKILL)`,
146    /// i.e. the OOM killer) the buffered bodies plus k6's own metric
147    /// accumulation exhaust RAM. Plain load only checks status codes, so
148    /// dropping the bodies is safe there.
149    discard_response_bodies: bool,
150    /// Round 61 (#79) — value for `k6 run --dns "policy=<...>"`. Empty → flag
151    /// omitted (k6 default `preferIPv4`). Srikanth on 0.3.208 GEODB-tests a WAF
152    /// via hostnames (his proxy routes by Host/SNI, so he can't pass bracket
153    /// IPs), but needs those hostnames resolved to their AAAA/IPv6 record;
154    /// k6/Go default to IPv4, which then can't be dialed from his IPv6
155    /// `--local-ips` source ("no suitable address found"). `preferIPv6` /
156    /// `onlyIPv6` fix that while keeping the hostname on the wire.
157    dns_policy: String,
158    /// Round 63 (#79) — set `GODEBUG=http2client=0` so k6/Go does not
159    /// ALPN-negotiate HTTP/2. HTTP/2 forbids `Connection`; WAF hop-by-hop
160    /// cases must keep that header. grafana/k6#2222: no per-request HTTP/1.1
161    /// API, process-wide GODEBUG is the workaround.
162    force_http1: bool,
163    /// Round 67 (#79) — when false, do not buffer every k6 stdout/stderr
164    /// line and do not write `k6-output.log` or the automatic detail
165    /// sidecars (`conformance-failure-details.json`,
166    /// `conformance-network-events.json`). Srikanth's 24–48h
167    /// `--repeat-until` campaigns wrote a full k6 output dump per
168    /// round × target and filled the disk. `summary.json` (needed for
169    /// results) and an explicitly-requested `--export-requests` dump are
170    /// unaffected.
171    capture_logs: bool,
172}
173
174impl K6Executor {
175    /// Create a new k6 executor
176    pub fn new() -> Result<Self> {
177        let k6_path = which::which("k6")
178            .map_err(|_| BenchError::K6NotFound)?
179            .to_string_lossy()
180            .to_string();
181
182        Ok(Self {
183            k6_path,
184            local_ips: String::new(),
185            discard_response_bodies: false,
186            dns_policy: String::new(),
187            force_http1: false,
188            capture_logs: true,
189        })
190    }
191
192    /// Set the `--local-ips` value for subsequent k6 invocations.
193    /// Accepts a comma-joined list of IPs, ranges (`10.0.0.1-10.0.0.5`),
194    /// and/or CIDRs (`192.168.0.0/24`) - same syntax k6 expects.
195    pub fn with_local_ips(mut self, local_ips: impl Into<String>) -> Self {
196        self.local_ips = local_ips.into();
197        self
198    }
199
200    /// Round 56 (#79) — enable `K6_DISCARD_RESPONSE_BODIES` so k6 does not hold
201    /// response bodies in memory. Use for plain load runs (status-only checks);
202    /// do NOT use where the script inspects/extracts response bodies.
203    pub fn with_discard_response_bodies(mut self, discard: bool) -> Self {
204        self.discard_response_bodies = discard;
205        self
206    }
207
208    /// Round 61 (#79) — set the `--dns` resolution policy (e.g. `preferIPv6`,
209    /// `onlyIPv6`, `preferIPv4`, `onlyIPv4`, `any`). Empty string → flag omitted
210    /// (k6 default). Passed to k6 as `--dns "policy=<value>"`.
211    pub fn with_dns_policy(mut self, policy: impl Into<String>) -> Self {
212        self.dns_policy = policy.into();
213        self
214    }
215
216    /// Round 63 (#79) — force HTTP/1.1 for this k6 process via
217    /// `GODEBUG=http2client=0`. Use when the script sets a `Connection`
218    /// header or when `--wafbench-verbatim` is on.
219    pub fn with_force_http1(mut self, force: bool) -> Self {
220        self.force_http1 = force;
221        self
222    }
223
224    /// Round 67 (#79) — pass `false` to skip writing `k6-output.log` and the
225    /// automatic detail sidecars, and to stop buffering k6's whole output in
226    /// memory. Use for long campaigns where per-run logs outgrow the disk.
227    /// `summary.json` and `--export-requests` output still write.
228    pub fn with_capture_logs(mut self, capture: bool) -> Self {
229        self.capture_logs = capture;
230        self
231    }
232
233    /// `GODEBUG` value this executor will set, or `None` when HTTP/2 is left
234    /// alone. Used by tests; `execute_with_port` applies the same string.
235    #[cfg(test)]
236    pub(crate) fn godebug_env_value(&self) -> Option<String> {
237        if !self.force_http1 {
238            return None;
239        }
240        Some(merge_godebug_http2client_off(std::env::var("GODEBUG").ok().as_deref()))
241    }
242
243    /// Check if k6 is installed
244    pub fn is_k6_installed() -> bool {
245        which::which("k6").is_ok()
246    }
247
248    /// Warn when the installed k6 predates the 1.x semantics this crate
249    /// relies on (#860): `constant-arrival-rate` executor behaviour and the
250    /// JSON-summary keys that stabilised in 1.x. Best-effort — a missing or
251    /// unparsable `k6 version` never blocks a run.
252    pub async fn warn_if_pre_v1() {
253        const DOCS: &str =
254            "See https://mockforge.dev/docs/reference/bench-capacity-sizing#tooling-requirements";
255        let output = match TokioCommand::new("k6").arg("version").output().await {
256            Ok(o) if o.status.success() => o,
257            _ => return,
258        };
259        let stdout = String::from_utf8_lossy(&output.stdout);
260        let Some(major) = stdout
261            .split_whitespace()
262            .find_map(|t| t.strip_prefix('v'))
263            .and_then(|rest| rest.split('.').next())
264            .and_then(|major| major.parse::<u64>().ok())
265        else {
266            return;
267        };
268        if major < 1 {
269            crate::reporter::TerminalReporter::print_warning(&format!(
270                "Detected k6 {}.x; mockforge bench requires k6 >= 1.0.0 \
271                 (older versions break executors and summary parsing). Upgrade k6. {DOCS}",
272                major
273            ));
274        }
275    }
276
277    /// Get k6 version
278    pub async fn get_version(&self) -> Result<String> {
279        let output = TokioCommand::new(&self.k6_path)
280            .arg("version")
281            .output()
282            .await
283            .map_err(|e| BenchError::K6ExecutionFailed(e.to_string()))?;
284
285        if !output.status.success() {
286            return Err(BenchError::K6ExecutionFailed("Failed to get k6 version".to_string()));
287        }
288
289        Ok(String::from_utf8_lossy(&output.stdout).trim().to_string())
290    }
291
292    /// Execute a k6 script.
293    ///
294    /// `api_port` — when set, overrides k6's default API server address (`localhost:6565`)
295    /// to `localhost:<api_port>`. This prevents "address already in use" errors when
296    /// running multiple k6 instances in parallel (e.g., multi-target bench).
297    /// Pass `Some(0)` to bind an OS-assigned ephemeral port — the collision-proof
298    /// choice for parallel runs, since the kernel never hands out a busy port
299    /// (see the k6 `CannotStartRESTAPI` / exit-106 fix in `parallel_executor`).
300    /// Pass `None` for single-target runs (uses k6's default `localhost:6565`).
301    pub async fn execute(
302        &self,
303        script_path: &Path,
304        output_dir: Option<&Path>,
305        verbose: bool,
306    ) -> Result<K6Results> {
307        self.execute_with_port(script_path, output_dir, verbose, None).await
308    }
309
310    /// Execute a k6 script with an optional custom API server port.
311    pub async fn execute_with_port(
312        &self,
313        script_path: &Path,
314        output_dir: Option<&Path>,
315        verbose: bool,
316        api_port: Option<u16>,
317    ) -> Result<K6Results> {
318        println!("Starting load test...\n");
319
320        let mut cmd = TokioCommand::new(&self.k6_path);
321        cmd.arg("run");
322
323        // When running multiple k6 instances in parallel, each needs its own API server port
324        // to avoid "bind: address already in use" on the default port 6565.
325        if let Some(port) = api_port {
326            cmd.arg("--address").arg(format!("localhost:{}", port));
327        }
328
329        // `--local-ips` rotates each VU through a pool of source IPs that
330        // must already be bound on the host (CIDRs/ranges accepted). This
331        // gives the k6 path the same source-IP coverage as the native
332        // self-test driver's `--source-ip`.
333        if !self.local_ips.is_empty() {
334            cmd.arg("--local-ips").arg(&self.local_ips);
335        }
336
337        // Round 56 (#79) — drop response bodies to bound k6's memory on long,
338        // high-concurrency runs (guards against the SIGKILL/OOM Srikanth hit).
339        if self.discard_response_bodies {
340            cmd.env("K6_DISCARD_RESPONSE_BODIES", "true");
341        }
342
343        // Round 63 (#79) — disable the Go HTTP/2 client so WAF `Connection`
344        // headers are not rejected as `http2: invalid Connection request
345        // header`. Merge with an existing GODEBUG rather than clobbering it.
346        if self.force_http1 {
347            let existing = std::env::var("GODEBUG").ok();
348            cmd.env("GODEBUG", merge_godebug_http2client_off(existing.as_deref()));
349        }
350
351        // Round 61 (#79) — force a DNS resolution policy so hostname targets can
352        // be pinned to IPv6 (or IPv4). Needed for GEODB IPv6 tests where the
353        // proxy routes by Host/SNI (so the target must stay a hostname) but the
354        // dial has to use the AAAA record to match an IPv6 `--local-ips` source.
355        if !self.dns_policy.is_empty() {
356            cmd.arg("--dns").arg(format!("policy={}", self.dns_policy));
357        }
358
359        // summary.json is written by the k6 script's handleSummary() function
360        // (relative to CWD, set to output_dir below). We no longer use
361        // --summary-export as it's deprecated in newer k6 versions and
362        // conflicts with handleSummary when both try to write the same file.
363
364        // Add verbosity
365        if verbose {
366            cmd.arg("--verbose");
367        }
368
369        // Use absolute path for the script so it's found regardless of CWD.
370        let abs_script =
371            std::fs::canonicalize(script_path).unwrap_or_else(|_| script_path.to_path_buf());
372        cmd.arg(&abs_script);
373
374        // Set working directory to output dir so handleSummary's relative
375        // "summary.json" path lands next to the script.
376        if let Some(dir) = output_dir {
377            cmd.current_dir(dir);
378        }
379
380        cmd.stdout(Stdio::piped());
381        cmd.stderr(Stdio::piped());
382
383        let mut child = cmd.spawn().map_err(|e| BenchError::K6ExecutionFailed(e.to_string()))?;
384
385        let stdout = child
386            .stdout
387            .take()
388            .ok_or_else(|| BenchError::K6ExecutionFailed("Failed to capture stdout".to_string()))?;
389
390        let stderr = child
391            .stderr
392            .take()
393            .ok_or_else(|| BenchError::K6ExecutionFailed("Failed to capture stderr".to_string()))?;
394
395        // Stream output
396        let stdout_reader = BufReader::new(stdout);
397        let stderr_reader = BufReader::new(stderr);
398
399        let mut stdout_lines = stdout_reader.lines();
400        let mut stderr_lines = stderr_reader.lines();
401
402        // Create progress indicator
403        let spinner = ProgressBar::new_spinner();
404        spinner.set_style(
405            ProgressStyle::default_spinner().template("{spinner:.green} {msg}").unwrap(),
406        );
407        spinner.set_message("Running load test...");
408
409        // Collect failure details from k6's console.log output
410        // k6 may emit console.log to either stdout or stderr depending on version/config
411        let failure_details: Arc<tokio::sync::Mutex<Vec<String>>> =
412            Arc::new(tokio::sync::Mutex::new(Vec::new()));
413        let fd_stdout = Arc::clone(&failure_details);
414        let fd_stderr = Arc::clone(&failure_details);
415
416        // Collect request/response exchanges for --export-requests
417        let exchange_details: Arc<tokio::sync::Mutex<Vec<String>>> =
418            Arc::new(tokio::sync::Mutex::new(Vec::new()));
419        let ex_stdout = Arc::clone(&exchange_details);
420        let ex_stderr = Arc::clone(&exchange_details);
421
422        // Round 47 (#79) — collect wire-level network events the
423        // k6 script emits on status=0 (connect / tls / timeout). Same
424        // shape as the native + self-test sinks so we can write a
425        // unified `conformance-network-events.json`.
426        let network_events: Arc<tokio::sync::Mutex<Vec<String>>> =
427            Arc::new(tokio::sync::Mutex::new(Vec::new()));
428        let ne_stdout = Arc::clone(&network_events);
429        let ne_stderr = Arc::clone(&network_events);
430
431        // Collect all k6 output for saving to a log file
432        let log_lines: Arc<tokio::sync::Mutex<Vec<String>>> =
433            Arc::new(tokio::sync::Mutex::new(Vec::new()));
434        let log_stdout = Arc::clone(&log_lines);
435        let log_stderr = Arc::clone(&log_lines);
436
437        // Round 67 (#79): when capture_logs is off, lines are drained (k6's
438        // pipes must be emptied or it blocks) and echoed, but nothing is
439        // buffered for the on-disk log / detail sidecars.
440        let capture_logs = self.capture_logs;
441        let capture_stdout = capture_logs;
442        let capture_stderr = capture_logs;
443
444        // Read stdout lines, capturing MOCKFORGE_FAILURE / MOCKFORGE_EXCHANGE / MOCKFORGE_NETWORK_EVENT markers
445        let stdout_handle = tokio::spawn(async move {
446            while let Ok(Some(line)) = stdout_lines.next_line().await {
447                if capture_stdout {
448                    log_stdout.lock().await.push(format!("[stdout] {}", line));
449                }
450                if let Some(json_str) = extract_failure_json(&line) {
451                    if capture_stdout {
452                        fd_stdout.lock().await.push(json_str);
453                    }
454                } else if let Some(json_str) = extract_exchange_json(&line) {
455                    ex_stdout.lock().await.push(json_str);
456                } else if let Some(json_str) = extract_network_event_json(&line) {
457                    if capture_stdout {
458                        ne_stdout.lock().await.push(json_str);
459                    }
460                } else {
461                    spinner.set_message(line.clone());
462                    if !line.is_empty() && !line.contains("running") && !line.contains("default") {
463                        println!("{}", line);
464                    }
465                }
466            }
467            spinner.finish_and_clear();
468        });
469
470        // Read stderr lines, capturing MOCKFORGE_FAILURE / MOCKFORGE_EXCHANGE / MOCKFORGE_NETWORK_EVENT markers
471        let stderr_handle = tokio::spawn(async move {
472            while let Ok(Some(line)) = stderr_lines.next_line().await {
473                if !line.is_empty() {
474                    if capture_stderr {
475                        log_stderr.lock().await.push(format!("[stderr] {}", line));
476                    }
477                    if let Some(json_str) = extract_failure_json(&line) {
478                        if capture_stderr {
479                            fd_stderr.lock().await.push(json_str);
480                        }
481                    } else if let Some(json_str) = extract_exchange_json(&line) {
482                        ex_stderr.lock().await.push(json_str);
483                    } else if let Some(json_str) = extract_network_event_json(&line) {
484                        if capture_stderr {
485                            ne_stderr.lock().await.push(json_str);
486                        }
487                    } else {
488                        eprintln!("{}", line);
489                    }
490                }
491            }
492        });
493
494        // Wait for completion
495        let status =
496            child.wait().await.map_err(|e| BenchError::K6ExecutionFailed(e.to_string()))?;
497
498        // Wait for both reader tasks to finish processing all lines
499        let _ = stdout_handle.await;
500        let _ = stderr_handle.await;
501
502        // k6 exit code 99 = thresholds crossed. The test DID run and summary.json
503        // should still be present. Only treat non-99 failures as hard errors.
504        //
505        // Round 65 (#79): when the OS OOM-kills k6, `ExitStatus::code()` is
506        // None and Unix reports signal 9 (SIGKILL). Surface that hint so the
507        // next run uses --no-per-op-metrics / lower --max-concurrency /
508        // --discard-response-bodies instead of chasing a phantom k6 bug.
509        let exit_code = status.code().unwrap_or(-1);
510        if !status.success() && exit_code != 99 {
511            let oom_hint = {
512                #[cfg(unix)]
513                {
514                    use std::os::unix::process::ExitStatusExt;
515                    if status.signal() == Some(9) {
516                        " — process received SIGKILL (signal 9). This is usually the \
517                         Linux OOM killer, not a k6 bug. For huge OpenAPI specs or \
518                         multi-hour longevity runs: pass --no-per-op-metrics, lower \
519                         --max-concurrency, and/or --discard-response-bodies; ensure \
520                         the client has enough RAM (see docs.mockforge.dev/reference/\
521                         bench-capacity-sizing.html)."
522                    } else {
523                        ""
524                    }
525                }
526                #[cfg(not(unix))]
527                {
528                    ""
529                }
530            };
531            return Err(BenchError::K6ExecutionFailed(format!(
532                "k6 exited with status: {}{}",
533                status, oom_hint
534            )));
535        }
536        if exit_code == 99 {
537            tracing::warn!("k6 thresholds crossed (exit code 99) — results will still be parsed");
538        }
539
540        // Write failure details to file if any were captured
541        if let Some(dir) = output_dir {
542            if capture_logs {
543                let details = failure_details.lock().await;
544                if !details.is_empty() {
545                    let failure_path = dir.join("conformance-failure-details.json");
546                    let parsed: Vec<serde_json::Value> =
547                        details.iter().filter_map(|s| serde_json::from_str(s).ok()).collect();
548                    if let Ok(json) = serde_json::to_string_pretty(&parsed) {
549                        let _ = std::fs::write(&failure_path, json);
550                    }
551                }
552            }
553
554            // Write exchange details (--export-requests) if any were captured.
555            // Deliberately NOT gated on capture_logs: --export-requests is an
556            // explicit output request, not an automatic debug sidecar.
557            let exchanges = exchange_details.lock().await;
558            if !exchanges.is_empty() {
559                let exchange_path = dir.join("conformance-requests.json");
560                let parsed: Vec<serde_json::Value> =
561                    exchanges.iter().filter_map(|s| serde_json::from_str(s).ok()).collect();
562                if let Ok(json) = serde_json::to_string_pretty(&parsed) {
563                    let _ = std::fs::write(&exchange_path, json);
564                    tracing::info!(
565                        "Exported {} request/response pairs to {}",
566                        parsed.len(),
567                        exchange_path.display()
568                    );
569                }
570            }
571
572            if capture_logs {
573                // Round 47 (#79) — write the wire-level events sink. We
574                // ALWAYS write the file (empty array when nothing failed)
575                // so a caller can tell "everything succeeded" from "nobody
576                // looked" at a glance. (Round 67: skipped under
577                // --no-k6-logs, where the caller opted out of per-run
578                // artifacts entirely.)
579                let net_events = network_events.lock().await;
580                let net_path = dir.join("conformance-network-events.json");
581                let parsed: Vec<serde_json::Value> =
582                    net_events.iter().filter_map(|s| serde_json::from_str(s).ok()).collect();
583                if let Ok(json) = serde_json::to_string_pretty(&parsed) {
584                    let _ = std::fs::write(&net_path, json);
585                    if !parsed.is_empty() {
586                        tracing::warn!(
587                            "Recorded {} wire-level network event(s) to {}",
588                            parsed.len(),
589                            net_path.display()
590                        );
591                    }
592                }
593
594                // Save full k6 output to a log file for debugging
595                let lines = log_lines.lock().await;
596                if !lines.is_empty() {
597                    let log_path = dir.join("k6-output.log");
598                    let _ = std::fs::write(&log_path, lines.join("\n"));
599                    println!("k6 output log saved to: {}", log_path.display());
600                }
601            }
602        }
603
604        // Parse results if output directory was specified
605        let results = if let Some(dir) = output_dir {
606            Self::parse_results(dir)?
607        } else {
608            K6Results::default()
609        };
610
611        Ok(results)
612    }
613
614    /// Parse k6 results from JSON output
615    fn parse_results(output_dir: &Path) -> Result<K6Results> {
616        let summary_path = output_dir.join("summary.json");
617
618        if !summary_path.exists() {
619            return Ok(K6Results::default());
620        }
621
622        let content = std::fs::read_to_string(summary_path)
623            .map_err(|e| BenchError::ResultsParseError(e.to_string()))?;
624
625        let json: serde_json::Value = serde_json::from_str(&content)
626            .map_err(|e| BenchError::ResultsParseError(e.to_string()))?;
627
628        let duration_values = &json["metrics"]["http_req_duration"]["values"];
629
630        let server_latency = &json["metrics"]["mockforge_server_injected_latency_ms"]["values"];
631        let server_jitter = &json["metrics"]["mockforge_server_injected_jitter_ms"]["values"];
632        let server_fault = &json["metrics"]["mockforge_server_fault_total"]["values"]["count"];
633
634        // Issue #79 (round 5) — surface TCP connect / TLS handshake stats and
635        // a connection-rate count for `--cps` runs.
636        //
637        // Round 6 follow-up: k6's `http_req_connecting` Trend doesn't expose a
638        // `count` field in summary.json (only avg/min/med/max/p90/p95), so we
639        // can't use it for "connections opened". The template now feeds a
640        // dedicated Counter, `mockforge_connections_opened`, every time a
641        // request's `res.timings.connecting > 0`. That gives us an accurate
642        // count for both `--cps` (≈ total_requests) and pooled-reuse (≈ vus_max)
643        // runs. The Trend is still useful for the avg/max timing display.
644        let tcp_connecting = &json["metrics"]["http_req_connecting"]["values"];
645        let tls_handshake = &json["metrics"]["http_req_tls_handshaking"]["values"];
646        let mf_conns_opened = &json["metrics"]["mockforge_connections_opened"]["values"]["count"];
647
648        Ok(K6Results {
649            total_requests: json["metrics"]["http_reqs"]["values"]["count"].as_u64().unwrap_or(0),
650            // k6 Rate metric: `passes` = count of non-zero values.
651            // For http_req_failed, non-zero means the request failed.
652            // So `passes` = failed request count, `fails` = successful request count.
653            failed_requests: json["metrics"]["http_req_failed"]["values"]["passes"]
654                .as_u64()
655                .unwrap_or(0),
656            avg_duration_ms: duration_values["avg"].as_f64().unwrap_or(0.0),
657            p95_duration_ms: duration_values["p(95)"].as_f64().unwrap_or(0.0),
658            p99_duration_ms: duration_values["p(99)"].as_f64().unwrap_or(0.0),
659            rps: json["metrics"]["http_reqs"]["values"]["rate"].as_f64().unwrap_or(0.0),
660            vus_max: json["metrics"]["vus_max"]["values"]["value"].as_u64().unwrap_or(0) as u32,
661            min_duration_ms: duration_values["min"].as_f64().unwrap_or(0.0),
662            max_duration_ms: duration_values["max"].as_f64().unwrap_or(0.0),
663            med_duration_ms: duration_values["med"].as_f64().unwrap_or(0.0),
664            p90_duration_ms: duration_values["p(90)"].as_f64().unwrap_or(0.0),
665            server_injected_latency_samples: server_latency["count"].as_u64().unwrap_or(0),
666            server_injected_latency_avg_ms: server_latency["avg"].as_f64().unwrap_or(0.0),
667            server_injected_latency_max_ms: server_latency["max"].as_f64().unwrap_or(0.0),
668            server_injected_jitter_samples: server_jitter["count"].as_u64().unwrap_or(0),
669            server_injected_jitter_avg_ms: server_jitter["avg"].as_f64().unwrap_or(0.0),
670            server_reported_faults: server_fault.as_u64().unwrap_or(0),
671            // Counter from the template, not the Trend's count (which is
672            // absent in k6 summary JSON).
673            tcp_connect_samples: mf_conns_opened.as_u64().unwrap_or(0),
674            tcp_connect_avg_ms: tcp_connecting["avg"].as_f64().unwrap_or(0.0),
675            tcp_connect_max_ms: tcp_connecting["max"].as_f64().unwrap_or(0.0),
676            // TLS handshake Trend has no `count` either; gate display on avg>0.
677            tls_handshake_samples: if tls_handshake["avg"].as_f64().unwrap_or(0.0) > 0.0 {
678                // Use connection count as a proxy — every new TLS session
679                // requires a handshake.
680                mf_conns_opened.as_u64().unwrap_or(0)
681            } else {
682                0
683            },
684            tls_handshake_avg_ms: tls_handshake["avg"].as_f64().unwrap_or(0.0),
685            tls_handshake_max_ms: tls_handshake["max"].as_f64().unwrap_or(0.0),
686            iterations_completed: json["metrics"]["iterations"]["values"]["count"]
687                .as_u64()
688                .unwrap_or(0),
689        })
690    }
691}
692
693impl Default for K6Executor {
694    fn default() -> Self {
695        Self::new().expect("k6 not found")
696    }
697}
698
699/// k6 test results
700#[derive(Debug, Clone, Default, serde::Serialize, serde::Deserialize)]
701pub struct K6Results {
702    pub total_requests: u64,
703    pub failed_requests: u64,
704    pub avg_duration_ms: f64,
705    pub p95_duration_ms: f64,
706    pub p99_duration_ms: f64,
707    pub rps: f64,
708    pub vus_max: u32,
709    pub min_duration_ms: f64,
710    pub max_duration_ms: f64,
711    pub med_duration_ms: f64,
712    pub p90_duration_ms: f64,
713    /// Issue #79 — client-side visibility into MockForge-injected latency,
714    /// parsed from the `X-Mockforge-Injected-Latency-Ms` response header that
715    /// the chaos middleware sets. Zero when chaos isn't firing or the target
716    /// isn't MockForge.
717    #[serde(default)]
718    pub server_injected_latency_samples: u64,
719    #[serde(default)]
720    pub server_injected_latency_avg_ms: f64,
721    #[serde(default)]
722    pub server_injected_latency_max_ms: f64,
723    #[serde(default)]
724    pub server_injected_jitter_samples: u64,
725    #[serde(default)]
726    pub server_injected_jitter_avg_ms: f64,
727    /// Count of responses that carried an `X-Mockforge-Fault` header.
728    #[serde(default)]
729    pub server_reported_faults: u64,
730    /// Issue #79 (round 5) — TCP connect samples / timing. With `--cps`
731    /// (`noConnectionReuse: true`) k6 records one connect per request, so
732    /// `tcp_connect_samples` equals connections opened. Without `--cps` this
733    /// is typically a small count (k6 reuses pooled connections), so it tells
734    /// you whether reuse was actually happening.
735    #[serde(default)]
736    pub tcp_connect_samples: u64,
737    #[serde(default)]
738    pub tcp_connect_avg_ms: f64,
739    #[serde(default)]
740    pub tcp_connect_max_ms: f64,
741    /// TLS handshake samples / timing — same shape as TCP connect, but only
742    /// non-zero for HTTPS targets.
743    #[serde(default)]
744    pub tls_handshake_samples: u64,
745    #[serde(default)]
746    pub tls_handshake_avg_ms: f64,
747    #[serde(default)]
748    pub tls_handshake_max_ms: f64,
749    /// Issue #79 round 10 — k6 iteration counter from `iterations.values.count`.
750    /// For `constant-arrival-rate` (`--rps`), this is the number of full
751    /// iterations completed within the duration. When `iterations × num_ops`
752    /// is much less than `total_requests`, mid-iteration cancellation truncated
753    /// the run and not every operation in the spec was exercised.
754    #[serde(default)]
755    pub iterations_completed: u64,
756}
757
758impl K6Results {
759    /// Get error rate as a percentage
760    pub fn error_rate(&self) -> f64 {
761        if self.total_requests == 0 {
762            return 0.0;
763        }
764        (self.failed_requests as f64 / self.total_requests as f64) * 100.0
765    }
766
767    /// Get success rate as a percentage
768    pub fn success_rate(&self) -> f64 {
769        100.0 - self.error_rate()
770    }
771}
772
773#[cfg(test)]
774mod tests {
775    use super::*;
776
777    #[test]
778    fn test_k6_results_error_rate() {
779        let results = K6Results {
780            total_requests: 100,
781            failed_requests: 5,
782            avg_duration_ms: 100.0,
783            p95_duration_ms: 200.0,
784            p99_duration_ms: 300.0,
785            ..Default::default()
786        };
787
788        assert_eq!(results.error_rate(), 5.0);
789        assert_eq!(results.success_rate(), 95.0);
790    }
791
792    #[test]
793    fn test_k6_results_zero_requests() {
794        let results = K6Results::default();
795        assert_eq!(results.error_rate(), 0.0);
796    }
797
798    #[test]
799    fn discard_response_bodies_defaults_off_and_builder_flips_it() {
800        // Round 56 (#79) — guards the OOM fix for multi-target load runs.
801        // Default must stay off so body-inspecting paths (extract/conformance)
802        // are unaffected; the builder opts a run in.
803        let exec = K6Executor {
804            k6_path: "k6".to_string(),
805            local_ips: String::new(),
806            discard_response_bodies: false,
807            dns_policy: String::new(),
808            force_http1: false,
809            capture_logs: true,
810        };
811        assert!(!exec.discard_response_bodies);
812        let exec = exec.with_discard_response_bodies(true);
813        assert!(exec.discard_response_bodies);
814    }
815
816    #[test]
817    fn dns_policy_defaults_empty_and_builder_sets_it() {
818        // Round 61 (#79) — empty default → k6's `--dns` flag is omitted; the
819        // builder records the policy string the executor turns into
820        // `--dns "policy=<value>"`.
821        let exec = K6Executor {
822            k6_path: "k6".to_string(),
823            local_ips: String::new(),
824            discard_response_bodies: false,
825            dns_policy: String::new(),
826            force_http1: false,
827            capture_logs: true,
828        };
829        assert!(exec.dns_policy.is_empty());
830        let exec = exec.with_dns_policy("preferIPv6");
831        assert_eq!(exec.dns_policy, "preferIPv6");
832    }
833
834    #[test]
835    fn capture_logs_defaults_on_and_builder_disables() {
836        // Round 67 (#79) — the default keeps writing k6-output.log and the
837        // detail sidecars; --no-k6-logs opts a run out so longevity
838        // campaigns do not buffer/write a full k6 dump per round × target.
839        let exec = K6Executor {
840            k6_path: "k6".to_string(),
841            local_ips: String::new(),
842            discard_response_bodies: false,
843            dns_policy: String::new(),
844            force_http1: false,
845            capture_logs: true,
846        };
847        assert!(exec.capture_logs);
848        let exec = exec.with_capture_logs(false);
849        assert!(!exec.capture_logs);
850    }
851
852    #[test]
853    fn test_extract_failure_json_raw() {
854        let line = r#"MOCKFORGE_FAILURE:{"check":"test","expected":"status === 200"}"#;
855        let result = extract_failure_json(line).unwrap();
856        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
857        assert_eq!(parsed["check"], "test");
858    }
859
860    #[test]
861    fn test_extract_failure_json_logfmt() {
862        let line = r#"time="2026-01-01T00:00:00Z" level=info msg="MOCKFORGE_FAILURE:{\"check\":\"test\",\"response\":{\"body\":\"{\\\"key\\\":\\\"val\\\"}\"}} " source=console"#;
863        let result = extract_failure_json(line).unwrap();
864        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
865        assert_eq!(parsed["check"], "test");
866        assert_eq!(parsed["response"]["body"], r#"{"key":"val"}"#);
867    }
868
869    #[test]
870    fn test_extract_failure_json_no_marker() {
871        assert!(extract_failure_json("just a regular log line").is_none());
872    }
873
874    /// Round 46 (#79) — regression: Srikanth's multipart upload landed
875    /// `[]` in `conformance-requests.json` because the old
876    /// `replace("\\\\","\\").replace("\\\"","\"")` chain misparsed
877    /// adjacent backslashes inside the JSON body (binary multipart
878    /// bytes encoded as `\\u00XX` etc.). Pin both shapes here.
879    #[test]
880    fn test_extract_exchange_logfmt_with_backslash_escapes() {
881        // A JSON body that contains a JSON-encoded `` (one escape
882        // sequence the validator survives). Logfmt wraps it: each `\`
883        // becomes `\\`, each `"` becomes `\"`.
884        let line = r#"time="2026-06-26T10:00:00Z" level=info msg="MOCKFORGE_EXCHANGE:{\"check\":\"u\",\"request\":{\"body\":\"--bnd\\r\\n\\u001a\"}}" source=console"#;
885        let result = extract_exchange_json(line).unwrap();
886        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
887        assert_eq!(parsed["check"], "u");
888        // The unescape preserves the JSON's `\r\n` and `` so the
889        // downstream consumer can interpret them as JSON escapes.
890        assert_eq!(parsed["request"]["body"], "--bnd\r\n\u{001a}");
891    }
892
893    #[test]
894    fn test_extract_exchange_raw_no_logfmt_wrapping() {
895        let line =
896            r#"MOCKFORGE_EXCHANGE:{"check":"x","request":{"body":""},"response":{"status":200}}"#;
897        let result = extract_exchange_json(line).unwrap();
898        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
899        assert_eq!(parsed["check"], "x");
900        assert_eq!(parsed["response"]["status"], 200);
901    }
902
903    /// The end of `msg="..."` is a single unescaped `"`, not the old
904    /// fixed-string `" source=console`. If k6 ever appends another
905    /// logfmt field (or omits source=), we still get the JSON out.
906    #[test]
907    fn test_extract_exchange_logfmt_tolerates_extra_trailing_fields() {
908        let line = r#"msg="MOCKFORGE_EXCHANGE:{\"check\":\"t\"}" source=console vu=1 iter=0"#;
909        let result = extract_exchange_json(line).unwrap();
910        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
911        assert_eq!(parsed["check"], "t");
912    }
913
914    /// Round 46 — JSON-encoded backslash inside a JSON string (`\\u00XX`
915    /// in the JSON, `\\\\u00XX` in logfmt) must round-trip cleanly.
916    /// The naive `.replace` chain choked on this exact pattern.
917    #[test]
918    fn test_extract_exchange_double_backslash_followed_by_quote() {
919        // JSON content: `\\"x"` is `\` then `"x"`. Logfmt:
920        // `\\\\\"x\"` (4 backslashes + escaped quote + x + escaped quote).
921        let line = r#"msg="MOCKFORGE_EXCHANGE:{\"k\":\"a\\\\\\\"x\\\"\"}" source=console"#;
922        let result = extract_exchange_json(line).unwrap();
923        let parsed: serde_json::Value = serde_json::from_str(&result).unwrap();
924        assert_eq!(parsed["k"], r#"a\"x""#);
925    }
926
927    #[test]
928    fn merge_godebug_appends_http2client_off_and_honors_existing() {
929        assert_eq!(merge_godebug_http2client_off(None), "http2client=0");
930        assert_eq!(merge_godebug_http2client_off(Some("")), "http2client=0");
931        assert_eq!(merge_godebug_http2client_off(Some("netdns=go")), "netdns=go,http2client=0");
932        assert_eq!(
933            merge_godebug_http2client_off(Some("http2client=1")),
934            "http2client=1",
935            "an explicit http2client= in the environment wins"
936        );
937        assert_eq!(merge_godebug_http2client_off(Some("http2client=0")), "http2client=0");
938    }
939
940    #[test]
941    fn force_http1_builder_sets_godebug_env_value() {
942        let exec = K6Executor {
943            k6_path: "k6".to_string(),
944            local_ips: String::new(),
945            discard_response_bodies: false,
946            dns_policy: String::new(),
947            force_http1: false,
948            capture_logs: true,
949        };
950        assert!(exec.godebug_env_value().is_none());
951        let exec = exec.with_force_http1(true);
952        let value = exec.godebug_env_value().expect("force_http1 must set GODEBUG");
953        assert!(
954            value.split(',').any(|p| p.trim() == "http2client=0"),
955            "spawn env must contain http2client=0, got {value}"
956        );
957    }
958
959    #[test]
960    fn execute_with_port_applies_godebug_when_force_http1() {
961        let src = include_str!("executor.rs");
962        assert!(
963            src.contains("merge_godebug_http2client_off"),
964            "k6 spawn must merge GODEBUG=http2client=0 so Connection headers survive HTTPS ALPN"
965        );
966        assert!(
967            src.contains("if self.force_http1"),
968            "GODEBUG must be gated on force_http1, not applied to every k6 run"
969        );
970    }
971}