rtimed 0.14.0

High-performance NTP/PTP time synchronization daemon (NTPv4, NTS, PTP). Installs as the `rtime` binary.
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

//! Configuration loading and parsing integration tests.

use rtime_core::config::RtimeConfig;

#[test]
fn minimal_config() {
    let toml_str = r#"
        [general]
        log_level = "debug"
    "#;

    let config: RtimeConfig = toml::from_str(toml_str).expect("parse minimal config");
    assert_eq!(config.general.log_level, "debug");

    // All other sections should have their defaults.
    assert!(config.clock.discipline);
    assert_eq!(config.clock.step_threshold_ms, 128.0);
    assert!(config.ntp.enabled);
    assert_eq!(config.ntp.listen, "127.0.0.1:123");
    assert!(config.ntp.sources.is_empty());
    assert!(!config.ptp.enabled);
    assert!(config.metrics.enabled);
    assert!(config.management.enabled);
}

#[test]
fn full_config() {
    let toml_str = r#"
        [general]
        log_level = "trace"

        [clock]
        discipline = false
        step_threshold_ms = 256.0
        panic_threshold_ms = 2000.0
        interface = "ptp0"

        [ntp]
        enabled = true
        listen = "0.0.0.0:1123"

        [ntp.nts]
        enabled = true
        ke_listen = "0.0.0.0:4460"
        certificate = "/etc/rtime/cert.pem"
        private_key = "/etc/rtime/key.pem"

        [[ntp.sources]]
        address = "pool.ntp.org"
        nts = false

        [[ntp.sources]]
        address = "time.cloudflare.com"
        nts = true

        [ptp]
        enabled = true
        domain = 24
        interface = "eth1"
        transport = "udp-ipv6"
        priority1 = 100
        priority2 = 200
        delay_mechanism = "p2p"

        [metrics]
        enabled = false
        listen = "0.0.0.0:9200"

        [management]
        enabled = false
        listen = "127.0.0.1:9300"
    "#;

    let config: RtimeConfig = toml::from_str(toml_str).expect("parse full config");

    // General
    assert_eq!(config.general.log_level, "trace");

    // Clock
    assert!(!config.clock.discipline);
    assert_eq!(config.clock.step_threshold_ms, 256.0);
    assert_eq!(config.clock.panic_threshold_ms, 2000.0);
    assert_eq!(config.clock.interface, "ptp0");

    // NTP
    assert!(config.ntp.enabled);
    assert_eq!(config.ntp.listen, "0.0.0.0:1123");
    assert!(config.ntp.nts.enabled);
    assert_eq!(config.ntp.nts.ke_listen, "0.0.0.0:4460");
    assert_eq!(
        config.ntp.nts.certificate.as_deref(),
        Some("/etc/rtime/cert.pem")
    );
    assert_eq!(
        config.ntp.nts.private_key.as_deref(),
        Some("/etc/rtime/key.pem")
    );

    // NTP sources
    assert_eq!(config.ntp.sources.len(), 2);
    assert_eq!(config.ntp.sources[0].address, "pool.ntp.org");
    assert!(!config.ntp.sources[0].nts);
    assert_eq!(config.ntp.sources[1].address, "time.cloudflare.com");
    assert!(config.ntp.sources[1].nts);

    // PTP
    assert!(config.ptp.enabled);
    assert_eq!(config.ptp.domain, 24);
    assert_eq!(config.ptp.interface, "eth1");
    assert_eq!(config.ptp.transport, "udp-ipv6");
    assert_eq!(config.ptp.priority1, 100);
    assert_eq!(config.ptp.priority2, 200);
    assert_eq!(config.ptp.delay_mechanism, "p2p");

    // Metrics
    assert!(!config.metrics.enabled);
    assert_eq!(config.metrics.listen, "0.0.0.0:9200");

    // Management
    assert!(!config.management.enabled);
    assert_eq!(config.management.listen, "127.0.0.1:9300");
}

#[test]
fn defaults_for_missing_sections() {
    // Completely empty config -- everything should default.
    let config: RtimeConfig = toml::from_str("").expect("parse empty config");

    assert_eq!(config.general.log_level, "info");
    assert!(config.clock.discipline);
    assert_eq!(config.clock.step_threshold_ms, 128.0);
    assert_eq!(config.clock.panic_threshold_ms, 1_000_000.0);
    assert!(config.clock.allow_initial_step);
    assert_eq!(config.clock.interface, "system");
    assert!(config.ntp.enabled);
    assert_eq!(config.ntp.listen, "127.0.0.1:123");
    assert!(!config.ntp.nts.enabled);
    assert_eq!(config.ntp.nts.ke_listen, "127.0.0.1:4460");
    assert!(config.ntp.nts.certificate.is_none());
    assert!(config.ntp.nts.private_key.is_none());
    assert!(config.ntp.sources.is_empty());
    assert!(!config.ptp.enabled);
    assert_eq!(config.ptp.domain, 0);
    assert_eq!(config.ptp.interface, "eth0");
    assert_eq!(config.ptp.transport, "udp-ipv4");
    assert_eq!(config.ptp.priority1, 128);
    assert_eq!(config.ptp.priority2, 128);
    assert_eq!(config.ptp.delay_mechanism, "e2e");
    assert!(config.metrics.enabled);
    assert_eq!(config.metrics.listen, "127.0.0.1:9100");
    assert!(config.management.enabled);
    assert_eq!(config.management.listen, "127.0.0.1:9200");
}

#[test]
fn invalid_config_rejected() {
    // Invalid TOML syntax.
    let bad_toml = r#"
        [general
        log_level = "info"
    "#;
    let result: Result<RtimeConfig, _> = toml::from_str(bad_toml);
    assert!(result.is_err(), "invalid TOML should be rejected");
}

#[test]
fn unknown_fields_are_ignored() {
    // TOML with unknown fields -- toml crate with serde defaults ignores them.
    let toml_str = r#"
        [general]
        log_level = "info"
        unknown_field = "value"

        [some_unknown_section]
        key = "val"
    "#;
    // This may or may not error depending on serde configuration. If the
    // RtimeConfig uses deny_unknown_fields it would error; otherwise it passes.
    let result: Result<RtimeConfig, _> = toml::from_str(toml_str);
    // Just verify we get a definitive result (no panic).
    let _outcome = result.is_ok() || result.is_err();
}

#[test]
fn partial_sections() {
    // Only some fields in a section -- others should default.
    let toml_str = r#"
        [clock]
        discipline = false

        [ntp]
        enabled = false
    "#;

    let config: RtimeConfig = toml::from_str(toml_str).expect("parse partial config");

    assert!(!config.clock.discipline);
    assert_eq!(config.clock.step_threshold_ms, 128.0); // default
    assert_eq!(config.clock.interface, "system"); // default

    assert!(!config.ntp.enabled);
    assert_eq!(config.ntp.listen, "127.0.0.1:123"); // default
}