thrall 0.0.25

thrall: the foot — a tool-execution client for a yog server
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

//! **What the ladder says as it climbs** (bl-3958): every rung, the punch and
//! the held line, read back off a captured sink — and a repeated outcome
//! said once.

use super::super::material::read_dir;
use super::super::{Channel, READ_TIMEOUT};
use super::advertised;
use super::ladder::roving_entry;
use crate::rendezvous::say;
use crate::test_support::engine::Engine;
use crate::test_support::engine::punched::{Punched, Turn};
use crate::test_support::roving::{commons, presence, tuned};
use crate::test_support::{Notices, Scratch, mint, roving};
use serde_json::json;
use std::time::Duration;

/// The lines a call's nonce and seq make unpredictable, with both digits
/// runs folded to `N` so a whole ladder can be asserted as one list.
fn folded(lines: Vec<String>) -> Vec<String> {
    lines
        .into_iter()
        .map(|line| {
            let mut out = String::new();
            let mut run = false;
            for c in line.chars() {
                if c.is_ascii_digit() {
                    if !run {
                        out.push('N');
                    }
                    run = true;
                } else {
                    out.push(c);
                    run = false;
                }
            }
            out
        })
        .collect()
}

/// A roving entry whose address answers says the direct rung once, however
/// many asks it dials.
#[test]
fn a_direct_rung_that_answers_is_said_once() {
    let scratch = Scratch::new();
    mint::material(scratch.path());
    roving::carried(scratch.path());
    let _engine = Engine::start(
        scratch.path(),
        crate::corpus::PROTOCOL,
        vec![vec![advertised()], vec![advertised()]],
    );
    let held = read_dir(scratch.path())
        .expect("readable")
        .expect("provisioned");
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(READ_TIMEOUT, tuned(vec![]));
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    for _ in 0..2 {
        assert!(channel.ask(&json!({"op": "advertise"})).is_ok());
    }
    assert_eq!(notices.heard(), [say::direct_connected()]);
}

/// An entry that does not rove climbs one rung and says nothing of it: its
/// only outcome already reaches the operator as the channel's sentence.
#[test]
fn an_entry_that_does_not_rove_says_nothing() {
    let scratch = Scratch::new();
    mint::material(scratch.path());
    let _engine = Engine::start(
        scratch.path(),
        crate::corpus::PROTOCOL,
        vec![vec![advertised()]],
    );
    let held = read_dir(scratch.path())
        .expect("readable")
        .expect("provisioned");
    let mut channel = Channel::open(&held).expect("opened");
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    assert!(channel.ask(&json!({"op": "advertise"})).is_ok());
    assert!(notices.heard().is_empty());
}

/// **The whole ladder, said**: the direct rung refused, the presence read,
/// the call written, the punch started and landed, the line kept — and a
/// second ask over the held line, and the pings discarded off it, add one
/// ping line and nothing else.
#[test]
fn the_rendezvous_says_every_step_and_the_held_line_its_first_ping() {
    let scratch = Scratch::new();
    let held = roving_entry(scratch.path(), "127.0.0.1:1");
    let pinged = vec![json!({"ping": true}), json!({"ping": true}), advertised()];
    let engine = Punched::start(
        scratch.path(),
        vec![
            Turn::Answer(vec![advertised()]),
            Turn::Answer(pinged.clone()),
            Turn::Answer(pinged),
        ],
    );
    let (_node, tuning) = commons(vec![presence(engine.port(), 1)]);
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(READ_TIMEOUT, tuning);
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    for _ in 0..3 {
        assert_eq!(
            channel.ask(&json!({"op": "advertise"})),
            Ok(vec![advertised()])
        );
    }
    let heard = notices.heard();
    let call = heard.get(2).cloned().unwrap_or_default();
    assert!(call.ends_with(", 1 ack(s)"), "{call}");
    assert_eq!(
        folded(heard),
        folded(vec![
            say::direct_refused(&["127.0.0.1".parse().expect("ip")], false),
            "rendezvous: presence read — seq 1, 1 endpoint(s) (1 v4)".to_owned(),
            call,
            "rendezvous: punch for call nonce 1 at 1 endpoint(s) (1 v4) — window 800ms".to_owned(),
            "rendezvous: punch landed (1 v4)".to_owned(),
            say::held_kept(),
            say::ping(),
        ])
    );
}

/// **Silence past the bound is said as the held line dropped**, by class.
#[test]
fn a_hangup_is_said_as_the_held_line_silent_past_it() {
    let scratch = Scratch::new();
    let held = roving_entry(scratch.path(), "127.0.0.1:1");
    let engine = Punched::start(scratch.path(), vec![Turn::Silence]);
    let (_node, tuning) = commons(vec![presence(engine.port(), 1)]);
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(Duration::from_millis(300), tuning);
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    assert!(channel.ask(&json!({"op": "advertise"})).is_err());
    assert_eq!(
        notices.heard().last().cloned(),
        Some(
            "rendezvous: held line dropped — the receive failed (silent past the hangup)"
                .to_owned()
        )
    );
}

/// **A re-call nobody answers falls to the full rendezvous** (ruling yog
/// bl-278f): the engine that closed the held line is gone, so the re-call
/// at its cached endpoints expires, the cache is cleared, and the same climb
/// reads presence afresh — which names the engine now listening.
#[test]
fn a_re_call_nobody_answers_is_said_and_presence_is_read_again() {
    let scratch = Scratch::new();
    let held = roving_entry(scratch.path(), "127.0.0.1:1");
    let gone = Punched::start(scratch.path(), vec![Turn::Answer(vec![advertised()])]);
    let (_node, tuning) = commons(vec![presence(gone.port(), 1)]);
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(READ_TIMEOUT, tuning);
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    assert!(channel.ask(&json!({"op": "advertise"})).is_ok());
    // The script is spent: the engine closes the line and its punch port.
    assert!(channel.ask(&json!({"op": "advertise"})).is_err());
    let back = Punched::start(scratch.path(), vec![Turn::Answer(vec![advertised()])]);
    let (_node, tuning) = commons(vec![presence(back.port(), 2)]);
    channel.tune(READ_TIMEOUT, tuning);
    assert!(channel.ask(&json!({"op": "advertise"})).is_ok());
    let heard = notices.heard();
    let mut tail: Vec<String> = heard.iter().skip(6).cloned().collect();
    let written = |l: &str, head: &str| l.starts_with(head) && l.ends_with(", 1 ack(s)");
    let recall = tail.get(1).cloned().unwrap_or_default();
    let call = tail.get(5).cloned().unwrap_or_default();
    assert!(
        written(&recall, "rendezvous: re-call from cached presence — nonce "),
        "{heard:?}"
    );
    assert!(written(&call, "rendezvous: call nonce "), "{heard:?}");
    tail.retain(|l| *l != recall && *l != call);
    assert_eq!(
        folded(tail),
        folded(vec![
            "rendezvous: held line dropped — the receive failed (closed by the far end)".to_owned(),
            "rendezvous: punch for call nonce 1 at 1 endpoint(s) (1 v4) — window 800ms".to_owned(),
            "rendezvous: punch expired after 800ms with no stream".to_owned(),
            "rendezvous: presence read — seq 2, 1 endpoint(s) (1 v4)".to_owned(),
            "rendezvous: punch for call nonce 1 at 1 endpoint(s) (1 v4) — window 800ms".to_owned(),
            "rendezvous: punch landed (1 v4)".to_owned(),
            say::held_kept(),
        ]),
        "{heard:?}"
    );
}

/// No rung answering says the direct refusal and why the commons could not
/// be read — the families, never the address.
#[test]
fn no_rung_answering_says_the_direct_refusal_and_the_presence_unread() {
    let scratch = Scratch::new();
    let held = roving_entry(scratch.path(), "127.0.0.1:1");
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(READ_TIMEOUT, tuned(vec![]));
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    for _ in 0..2 {
        assert!(channel.ask(&json!({"op": "advertise"})).is_err());
    }
    assert_eq!(
        notices.heard(),
        [
            "rendezvous: direct rung refused — 1 address(es) tried (1 v4)".to_owned(),
            say::presence_unread(say::NO_WALK),
        ],
        "a second climb to the same outcome says nothing"
    );
}

/// An address that does not resolve tried nothing, and says so by count.
#[test]
fn an_address_that_does_not_resolve_says_nothing_was_tried() {
    let scratch = Scratch::new();
    let held = roving_entry(scratch.path(), "no-port-here");
    let mut channel = Channel::open(&held).expect("opened");
    channel.tune(READ_TIMEOUT, tuned(vec![]));
    let (notices, sink) = Notices::new();
    channel.speak_to(&sink);
    assert!(channel.ask(&json!({"op": "advertise"})).is_err());
    assert_eq!(
        notices.heard().first().cloned(),
        Some("rendezvous: direct rung refused — 0 address(es) tried (none)".to_owned())
    );
}