1
//! Test helpers.
2

            
3
#[cfg(test)]
4
use super::{rtt::RoundtripTimeEstimator, CongestionWindow};
5

            
6
// Make a new RTT estimator.
7
#[cfg(test)]
8
10
pub(crate) fn new_rtt_estimator() -> RoundtripTimeEstimator {
9
10
    RoundtripTimeEstimator::new(&params::build_rtt_params())
10
10
}
11

            
12
// Make a new congestion window.
13
#[cfg(test)]
14
28
pub(crate) fn new_cwnd() -> CongestionWindow {
15
28
    CongestionWindow::new(&params::build_cwnd_params())
16
28
}
17

            
18
#[cfg(test)]
19
pub(crate) mod params {
20
    use tor_units::Percentage;
21

            
22
    use crate::ccparams::{
23
        Algorithm, CongestionControlParams, CongestionControlParamsBuilder, CongestionWindowParams,
24
        CongestionWindowParamsBuilder, FixedWindowParams, FixedWindowParamsBuilder,
25
        RoundTripEstimatorParams, RoundTripEstimatorParamsBuilder, VegasParamsBuilder,
26
    };
27

            
28
276
    fn build_fixed_params() -> FixedWindowParams {
29
276
        FixedWindowParamsBuilder::default()
30
276
            .circ_window_start(1000)
31
276
            .circ_window_min(100)
32
276
            .circ_window_max(1000)
33
276
            .build()
34
276
            .expect("Unable to build fixed window params")
35
276
    }
36

            
37
54
    pub(crate) fn build_cc_vegas_params() -> CongestionControlParams {
38
54
        // Following values are the default from the proposal. They likely differ from what the
39
54
        // consensus uses today.
40
54
        let params = VegasParamsBuilder::default()
41
54
            .cell_in_queue_params((186, 248, 310, 186, 600).into())
42
54
            .ss_cwnd_max(5000)
43
54
            .cwnd_full_gap(4)
44
54
            .cwnd_full_min_pct(Percentage::new(25))
45
54
            .cwnd_full_per_cwnd(1)
46
54
            .build()
47
54
            .expect("Unable to build Vegas params");
48
54
        CongestionControlParamsBuilder::default()
49
54
            .rtt_params(build_rtt_params())
50
54
            .cwnd_params(build_cwnd_params())
51
54
            .alg(Algorithm::Vegas(params))
52
54
            .fixed_window_params(build_fixed_params())
53
54
            .build()
54
54
            .expect("Unable to build CC params")
55
54
    }
56

            
57
222
    pub(crate) fn build_cc_fixed_params() -> CongestionControlParams {
58
222
        let params = build_fixed_params();
59
222
        CongestionControlParamsBuilder::default()
60
222
            .rtt_params(build_rtt_params())
61
222
            .cwnd_params(build_cwnd_params())
62
222
            .alg(Algorithm::FixedWindow(params))
63
222
            .fixed_window_params(params)
64
222
            .build()
65
222
            .expect("Unable to build CC params")
66
222
    }
67

            
68
    // Build the round trip estimator parameters. with good enough values for tests.
69
286
    pub(crate) fn build_rtt_params() -> RoundTripEstimatorParams {
70
286
        RoundTripEstimatorParamsBuilder::default()
71
286
            .ewma_cwnd_pct(Percentage::new(50))
72
286
            .ewma_max(10)
73
286
            .ewma_ss_max(2)
74
286
            .rtt_reset_pct(Percentage::new(100))
75
286
            .build()
76
286
            .expect("Unable to build RTT parameters")
77
286
    }
78

            
79
    // Build the congestion window parameters. with good enough values for tests.
80
304
    pub(crate) fn build_cwnd_params() -> CongestionWindowParams {
81
304
        // Values taken from the prop324.
82
304
        CongestionWindowParamsBuilder::default()
83
304
            .cwnd_init(124)
84
304
            .cwnd_inc_pct_ss(Percentage::new(100))
85
304
            .cwnd_inc(1)
86
304
            .cwnd_inc_rate(31)
87
304
            .cwnd_min(124)
88
304
            .cwnd_max(u32::MAX)
89
304
            .sendme_inc(31)
90
304
            .build()
91
304
            .expect("Unable to build congestion window parameters")
92
304
    }
93
}