ruchy 4.2.1

A systems scripting language that transpiles to idiomatic Rust with extreme quality engineering
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
//! Benchmarking module for HTTP/HTTPS, WASM, and CLI targets
//!
//! This module provides ApacheBench-style performance testing capabilities
//! for various Ruchy targets. Each benchmark produces comprehensive statistics
//! including latency percentiles, throughput, and success rates.
//!
//! # Examples
//!
//! ```no_run
//! use ruchy::bench::{BenchmarkResults, http_benchmark};
//! use std::time::Duration;
//!
//! let results = http_benchmark(
//!     "https://api.example.com",
//!     100,  // requests
//!     10,   // concurrency
//!     "GET",
//!     None,
//!     Vec::new()
//! ).unwrap();
//!
//! println!("Requests/sec: {:.2}", results.requests_per_second());
//! ```

pub mod cli;
pub mod http;
pub mod stats;
pub mod wasm;

use std::time::Duration;

/// Results from a benchmark run
///
/// # Complexity
/// Cyclomatic complexity: ≤10 (target)
#[derive(Debug, Clone)]
pub struct BenchmarkResults {
    /// Total number of requests attempted
    pub total_requests: usize,
    /// Number of successful requests
    pub successful_requests: usize,
    /// Number of failed requests
    pub failed_requests: usize,
    /// Total duration of benchmark
    pub total_duration: Duration,
    /// Individual request times
    pub request_times: Vec<Duration>,
}

impl BenchmarkResults {
    /// Calculate requests per second (throughput)
    ///
    /// # Examples
    ///
    /// ```
    /// use ruchy::bench::BenchmarkResults;
    /// use std::time::Duration;
    ///
    /// let results = BenchmarkResults {
    ///     total_requests: 100,
    ///     successful_requests: 100,
    ///     failed_requests: 0,
    ///     total_duration: Duration::from_secs(10),
    ///     request_times: vec![Duration::from_millis(100); 100],
    /// };
    ///
    /// assert_eq!(results.requests_per_second(), 10.0);
    /// ```
    #[must_use]
    pub fn requests_per_second(&self) -> f64 {
        let secs = self.total_duration.as_secs_f64();
        if secs == 0.0 {
            0.0
        } else {
            self.total_requests as f64 / secs
        }
    }

    /// Calculate mean request time
    ///
    /// # Examples
    ///
    /// ```
    /// use ruchy::bench::BenchmarkResults;
    /// use std::time::Duration;
    ///
    /// let results = BenchmarkResults {
    ///     total_requests: 3,
    ///     successful_requests: 3,
    ///     failed_requests: 0,
    ///     total_duration: Duration::from_secs(1),
    ///     request_times: vec![
    ///         Duration::from_millis(100),
    ///         Duration::from_millis(200),
    ///         Duration::from_millis(300),
    ///     ],
    /// };
    ///
    /// assert_eq!(results.mean_time(), Duration::from_millis(200));
    /// ```
    #[must_use]
    pub fn mean_time(&self) -> Duration {
        if self.request_times.is_empty() {
            return Duration::ZERO;
        }

        let sum: Duration = self.request_times.iter().sum();
        sum / self.request_times.len() as u32
    }

    /// Calculate percentile of request times
    ///
    /// # Arguments
    ///
    /// * `p` - Percentile value (0.0-100.0)
    ///
    /// # Examples
    ///
    /// ```
    /// use ruchy::bench::BenchmarkResults;
    /// use std::time::Duration;
    ///
    /// let results = BenchmarkResults {
    ///     total_requests: 5,
    ///     successful_requests: 5,
    ///     failed_requests: 0,
    ///     total_duration: Duration::from_secs(1),
    ///     request_times: vec![
    ///         Duration::from_millis(10),
    ///         Duration::from_millis(20),
    ///         Duration::from_millis(30),
    ///         Duration::from_millis(40),
    ///         Duration::from_millis(50),
    ///     ],
    /// };
    ///
    /// assert_eq!(results.percentile(50.0), Duration::from_millis(30));
    /// ```
    #[must_use]
    pub fn percentile(&self, p: f64) -> Duration {
        if self.request_times.is_empty() {
            return Duration::ZERO;
        }

        let mut sorted = self.request_times.clone();
        sorted.sort();

        let index = ((p / 100.0) * sorted.len() as f64) as usize;
        sorted[index.min(sorted.len() - 1)]
    }

    /// Print ApacheBench-style summary to stdout
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use ruchy::bench::BenchmarkResults;
    /// use std::time::Duration;
    ///
    /// let results = BenchmarkResults {
    ///     total_requests: 100,
    ///     successful_requests: 98,
    ///     failed_requests: 2,
    ///     total_duration: Duration::from_secs(10),
    ///     request_times: vec![Duration::from_millis(100); 98],
    /// };
    ///
    /// results.print_summary();
    /// ```
    pub fn print_summary(&self) {
        println!(
            "Requests per second:    {:.2} [#/sec] (mean)",
            self.requests_per_second()
        );
        println!(
            "Time per request:       {:.3} [ms] (mean)",
            self.mean_time().as_secs_f64() * 1000.0
        );

        if self.failed_requests > 0 {
            println!("Failed requests:        {}", self.failed_requests);
        }

        println!("\nPercentage of requests served within a certain time (ms)");
        for p in &[50, 66, 75, 80, 90, 95, 98, 99, 100] {
            let time = self.percentile(f64::from(*p));
            println!("  {:3}%  {:6.0}", p, time.as_secs_f64() * 1000.0);
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    /// Test `requests_per_second` calculation
    ///
    /// RED: This test should PASS because `requests_per_second()` is implemented
    #[test]
    fn test_requests_per_second() {
        let results = BenchmarkResults {
            total_requests: 100,
            successful_requests: 100,
            failed_requests: 0,
            total_duration: Duration::from_secs(10),
            request_times: vec![Duration::from_millis(100); 100],
        };

        assert_eq!(results.requests_per_second(), 10.0);
    }

    /// Test `mean_time` calculation
    ///
    /// RED: This test should PASS because `mean_time()` is implemented
    #[test]
    fn test_mean_time() {
        let results = BenchmarkResults {
            total_requests: 3,
            successful_requests: 3,
            failed_requests: 0,
            total_duration: Duration::from_secs(1),
            request_times: vec![
                Duration::from_millis(100),
                Duration::from_millis(200),
                Duration::from_millis(300),
            ],
        };

        assert_eq!(results.mean_time(), Duration::from_millis(200));
    }

    /// Test percentile calculation
    ///
    /// RED: This test should PASS because `percentile()` is implemented
    #[test]
    fn test_percentile() {
        let results = BenchmarkResults {
            total_requests: 5,
            successful_requests: 5,
            failed_requests: 0,
            total_duration: Duration::from_secs(1),
            request_times: vec![
                Duration::from_millis(10),
                Duration::from_millis(20),
                Duration::from_millis(30),
                Duration::from_millis(40),
                Duration::from_millis(50),
            ],
        };

        assert_eq!(results.percentile(50.0), Duration::from_millis(30));
        assert_eq!(results.percentile(100.0), Duration::from_millis(50));
    }

    /// Test edge case: empty `request_times`
    #[test]
    fn test_empty_results() {
        let results = BenchmarkResults {
            total_requests: 0,
            successful_requests: 0,
            failed_requests: 0,
            total_duration: Duration::ZERO,
            request_times: vec![],
        };

        assert_eq!(results.requests_per_second(), 0.0);
        assert_eq!(results.mean_time(), Duration::ZERO);
        assert_eq!(results.percentile(50.0), Duration::ZERO);
    }

    /// Property test: Percentiles should be monotonically increasing
    #[test]
    fn prop_percentiles_monotonic() {
        use proptest::prelude::*;

        proptest!(|(times in prop::collection::vec(0u64..10000, 10..100))| {
            let request_times: Vec<Duration> = times.iter()
                .map(|&t| Duration::from_millis(t))
                .collect();

            let results = BenchmarkResults {
                total_requests: request_times.len(),
                successful_requests: request_times.len(),
                failed_requests: 0,
                total_duration: Duration::from_secs(1),
                request_times,
            };

            // Percentiles should be monotonically increasing
            let p50 = results.percentile(50.0);
            let p75 = results.percentile(75.0);
            let p90 = results.percentile(90.0);
            let p99 = results.percentile(99.0);

            prop_assert!(p50 <= p75);
            prop_assert!(p75 <= p90);
            prop_assert!(p90 <= p99);
        });
    }

    #[test]
    fn test_zero_duration_rps() {
        let results = BenchmarkResults {
            total_requests: 100,
            successful_requests: 100,
            failed_requests: 0,
            total_duration: Duration::ZERO,
            request_times: vec![Duration::from_millis(100); 100],
        };
        // Zero duration should return 0.0 to avoid div by zero
        assert_eq!(results.requests_per_second(), 0.0);
    }

    #[test]
    fn test_single_request() {
        let results = BenchmarkResults {
            total_requests: 1,
            successful_requests: 1,
            failed_requests: 0,
            total_duration: Duration::from_millis(500),
            request_times: vec![Duration::from_millis(100)],
        };
        assert_eq!(results.mean_time(), Duration::from_millis(100));
        assert_eq!(results.percentile(50.0), Duration::from_millis(100));
        assert_eq!(results.percentile(100.0), Duration::from_millis(100));
    }

    #[test]
    fn test_failed_requests_ratio() {
        let results = BenchmarkResults {
            total_requests: 10,
            successful_requests: 7,
            failed_requests: 3,
            total_duration: Duration::from_secs(1),
            request_times: vec![Duration::from_millis(100); 7],
        };
        assert_eq!(results.total_requests, 10);
        assert_eq!(results.successful_requests + results.failed_requests, 10);
    }

    #[test]
    fn test_benchmark_results_clone() {
        let results = BenchmarkResults {
            total_requests: 5,
            successful_requests: 5,
            failed_requests: 0,
            total_duration: Duration::from_millis(500),
            request_times: vec![Duration::from_millis(100); 5],
        };
        let cloned = results.clone();
        assert_eq!(cloned.total_requests, results.total_requests);
        assert_eq!(cloned.request_times.len(), results.request_times.len());
    }

    #[test]
    fn test_percentile_boundary_0() {
        let results = BenchmarkResults {
            total_requests: 5,
            successful_requests: 5,
            failed_requests: 0,
            total_duration: Duration::from_secs(1),
            request_times: vec![
                Duration::from_millis(10),
                Duration::from_millis(20),
                Duration::from_millis(30),
                Duration::from_millis(40),
                Duration::from_millis(50),
            ],
        };
        // 0th percentile should be first element
        assert_eq!(results.percentile(0.0), Duration::from_millis(10));
    }

    #[test]
    fn test_high_throughput() {
        let results = BenchmarkResults {
            total_requests: 1000,
            successful_requests: 1000,
            failed_requests: 0,
            total_duration: Duration::from_millis(100),
            request_times: vec![Duration::from_micros(100); 1000],
        };
        // 1000 requests in 100ms = 10000 RPS
        assert_eq!(results.requests_per_second(), 10000.0);
    }

    #[test]
    fn test_percentile_90th() {
        let results = BenchmarkResults {
            total_requests: 10,
            successful_requests: 10,
            failed_requests: 0,
            total_duration: Duration::from_secs(1),
            request_times: (1..=10).map(|i| Duration::from_millis(i * 10)).collect(),
        };
        // 90th percentile of [10, 20, 30, 40, 50, 60, 70, 80, 90, 100]
        assert_eq!(results.percentile(90.0), Duration::from_millis(100));
    }

    #[test]
    fn test_mean_time_large_values() {
        let results = BenchmarkResults {
            total_requests: 2,
            successful_requests: 2,
            failed_requests: 0,
            total_duration: Duration::from_secs(10),
            request_times: vec![Duration::from_secs(2), Duration::from_secs(4)],
        };
        assert_eq!(results.mean_time(), Duration::from_secs(3));
    }

    #[test]
    fn test_debug_impl() {
        let results = BenchmarkResults {
            total_requests: 1,
            successful_requests: 1,
            failed_requests: 0,
            total_duration: Duration::from_millis(100),
            request_times: vec![Duration::from_millis(100)],
        };
        let debug_str = format!("{results:?}");
        assert!(debug_str.contains("BenchmarkResults"));
        assert!(debug_str.contains("total_requests"));
    }

    #[test]
    fn test_fractional_rps() {
        let results = BenchmarkResults {
            total_requests: 3,
            successful_requests: 3,
            failed_requests: 0,
            total_duration: Duration::from_secs(2),
            request_times: vec![Duration::from_millis(100); 3],
        };
        // 3 requests in 2 seconds = 1.5 RPS
        assert_eq!(results.requests_per_second(), 1.5);
    }
}