satx-core 0.12.1

HP 48/49 calculator layer of satx: Kermit and XModem driver loops, calculator operations, HP objects; blocking or sans-I/O (wasm32)
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
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
//! End-to-end tests against the saturnng emulator in `emulator/`.
//!
//! Skipped unless `SATX_E2E_ADDR` is set, e.g. `tcp://localhost:4848`. Must
//! pass on the 48SX, 48GX and 49G. Every scenario leaves the calculator in
//! HOME and in ASCII transfer mode, as a fresh one is.
//!
//! The XModem scenario also needs `SATX_E2E_CONTAINER`, the name of the
//! emulator's docker container: XRECV/XSEND cannot be started through the
//! Kermit server, so it types them with `docker exec CONTAINER calc-keys`.
//! It runs only on a detected 49G or 48G/GX.
#![allow(clippy::unwrap_used, clippy::expect_used)]

/// `satx lx` (the HP 100LX/200LX): in process always, BSD Filer with
/// `FILER_E2E_ADDR`.
#[path = "e2e/lx.rs"]
mod lx;

use std::process::Command;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::{Arc, Mutex};
use std::thread::{self, JoinHandle};
use std::time::{Duration, Instant};

use satx_core::object::{self, Family, HEADER_LEN, ObjectType};
use satx_core::reply::{Iopar, looks_cut, parse_real};
use satx_core::xmodem::XmodemDirection;
use satx_core::xmodem_proto::{Check, Event};
use satx_core::{
    Calculator, Error, Model, Options, Session, TransferMode, XmodemOptions, XmodemSession,
};

type TestResult = Result<(), Box<dyn std::error::Error>>;

/// One emulator, one client at a time.
static LOCK: Mutex<()> = Mutex::new(());

/// Variables a scenario may create in HOME.
const LEFTOVERS: &[&str] = &[
    "SATXE2E", "SATXE2F", "SATXRT", "SATXTMP", "SATXBK", "SATXXM",
];

/// Run `body` against a fresh connection, then clean up whatever happened.
/// Does nothing when `SATX_E2E_ADDR` is unset.
fn scenario(body: impl FnOnce(&mut Calculator) -> TestResult) -> TestResult {
    let Some(addr) = std::env::var("SATX_E2E_ADDR")
        .ok()
        .filter(|a| !a.is_empty())
    else {
        return Ok(());
    };
    let _guard = LOCK.lock().unwrap_or_else(|e| e.into_inner());
    let mut calc = Calculator::open(&addr)?;
    let result = body(&mut calc);
    let cleanup = cleanup(&mut calc);
    result?;
    cleanup
}

/// Back to HOME and ASCII mode, remove leftovers.
fn cleanup(calc: &mut Calculator) -> TestResult {
    calc.cd(&["HOME"])?;
    let listing = calc.list()?;
    for name in LEFTOVERS {
        if listing.entries.iter().any(|e| e.name == *name) {
            eprintln!("cleanup: removing {name}");
            calc.remove(name)?;
        }
    }
    calc.set_transfer_mode(TransferMode::Ascii)?;
    Ok(())
}

fn names(calc: &mut Calculator) -> Result<Vec<String>, Error> {
    Ok(calc.list()?.entries.into_iter().map(|e| e.name).collect())
}

#[test]
fn ls() -> TestResult {
    scenario(|calc| {
        calc.mkdir("SATXE2E")?;
        calc.cd(&["HOME", "SATXE2E"])?;
        assert_eq!(calc.path()?, ["HOME", "SATXE2E"]);
        assert!(calc.list()?.entries.is_empty());
        let stored = calc.put(
            "SATXV",
            b"%%HP: T(3)A(D)F(.);\r\n42\r\n",
            TransferMode::Ascii,
        )?;
        assert_eq!(stored, "SATXV");
        assert_eq!(names(calc)?, ["SATXV"]);
        calc.cd(&["HOME"])?;
        calc.rename("SATXE2E", "SATXE2F")?;
        let listing = calc.list()?;
        assert!(
            listing
                .entries
                .iter()
                .any(|e| e.name == "SATXE2F" && e.is_directory()),
            "{listing:?}"
        );
        assert!(!listing.entries.iter().any(|e| e.name == "SATXE2E"));
        calc.remove("SATXE2F")?;
        assert!(!names(calc)?.iter().any(|n| n == "SATXE2F"));
        Ok(())
    })
}

#[test]
fn get() -> TestResult {
    scenario(|calc| {
        let ascii = calc.get("IOPAR", TransferMode::Ascii)?;
        assert!(
            ascii.starts_with(b"%%HP:"),
            "{:?}",
            String::from_utf8_lossy(&ascii)
        );
        let binary = calc.get("IOPAR", TransferMode::Binary)?;
        let info = object::inspect(&binary)?;
        assert_eq!(info.object_type, Some(ObjectType::List));
        assert!(matches!(info.header.family, Family::Hp48 | Family::Hp49));
        assert_eq!(calc.iopar()?, Iopar::default());
        Ok(())
    })
}

/// A String object holding all 256 byte values, as a binary transfer file
/// with `header`.
fn all_bytes_string(header: &[u8]) -> Vec<u8> {
    fn field(nibbles: &mut Vec<u8>, value: u32, width: usize) {
        for i in 0..width {
            nibbles.push(((value >> (4 * i)) & 0xF) as u8);
        }
    }
    let mut nibbles = Vec::new();
    field(&mut nibbles, 0x02A2C, 5);
    field(&mut nibbles, 5 + 2 * 256, 5);
    for b in 0..=255u8 {
        nibbles.extend([b & 0xF, b >> 4]);
    }
    let mut file = header.to_vec();
    file.extend(object::pack(&nibbles));
    file
}

/// Binary mode survives byte for byte (ASCII mode on the 48SX mangles
/// bytes 0-26).
#[test]
fn put_round_trip() -> TestResult {
    scenario(|calc| {
        let iopar = calc.get("IOPAR", TransferMode::Binary)?;
        let file = all_bytes_string(&iopar[..HEADER_LEN]);
        assert_eq!(
            object::inspect(&file)?.object_type,
            Some(ObjectType::String)
        );
        assert_eq!(calc.put("SATXRT", &file, TransferMode::Binary)?, "SATXRT");
        let back = calc.get("SATXRT", TransferMode::Binary)?;
        calc.remove("SATXRT")?;
        assert_eq!(back, file);
        Ok(())
    })
}

#[test]
fn run() -> TestResult {
    scenario(|calc| {
        let reply = calc.run("6 7 *")?;
        calc.run("DROP")?;
        assert_eq!(reply.error, None);
        assert_eq!(reply.level(1).and_then(parse_real), Some(42.0));

        let reply = calc.run("'SATXNOSUCH' RCL")?;
        calc.run("DROP")?;
        assert_eq!(reply.error.as_deref(), Some("Undefined Name"));

        assert!(calc.mem()? > 0.0);
        if let Some(version) = calc.version()? {
            assert!(!version.is_empty());
            eprintln!("version: {version}");
        }

        let err = calc.run(&"1".repeat(80)).unwrap_err();
        assert!(matches!(err, Error::CommandTooLong { .. }), "{err:?}");
        let reply = calc.run("1 2 +")?;
        calc.run("DROP")?;
        assert_eq!(reply.level(1).and_then(parse_real), Some(3.0));
        Ok(())
    })
}

/// The 49G sends each stack level only as wide as its display (20
/// characters on ROM 1.18, 22 on 2.x) and cuts its two-line VERSION
/// string; in FIX 4, IOPAR's list is far wider too. With the fraction
/// mark `,` (flag -51), the 48 shows 9600 as `9.600,0000`; in `0 SCI` every
/// model shows it as `1.E4` (`1,E4`). The queries read whole values all the
/// same, leave the display mode as it was and the stack too (here the
/// flags saved by RCLF, put back at the end).
#[test]
fn queries_wider_than_the_display() -> TestResult {
    scenario(|calc| {
        let saved = calc.run("RCLF 4 FIX -51 SF")?;
        assert_eq!(saved.error, None);
        let flags = saved.level(1).unwrap_or_default().to_string();
        let depth = saved.levels.len();
        let queries =
            |calc: &mut Calculator, mode: &str| -> Result<f64, Box<dyn std::error::Error>> {
                let model = calc.model()?;
                let wide = calc.run("IOPAR")?;
                calc.run("DROP")?;
                if model == Model::Hp49G {
                    let list = wide.level(1).unwrap_or_default();
                    assert!(looks_cut(list), "IOPAR in {mode} is not cut: {list:?}");
                }
                assert_eq!(calc.iopar()?, Iopar::default(), "IOPAR in {mode}");
                if let Some(version) = calc.version()? {
                    eprintln!("version in {mode}: {version}");
                    if model == Model::Hp49G {
                        assert!(version.contains("Revision #"), "{version}");
                    }
                }
                assert_eq!(Model::from_version(calc.version()?.as_deref()), model);
                let free = calc.mem()?;
                assert!(free > 0.0);
                calc.transfer_mode()?;
                // The mode is still the user's: IOPAR as the display shows it.
                let shown = calc.run("IOPAR")?;
                calc.run("DROP")?;
                assert_eq!(shown.level(1), wide.level(1), "{mode} changed");
                let after = calc.run("DEPTH")?;
                calc.run("DROP")?;
                assert_eq!(after.levels.len(), depth + 1, "{after:?}");
                assert_eq!(after.level(2), Some(flags.as_str()), "{after:?}");
                Ok(free)
            };
        let mut both = || -> TestResult {
            let fix = queries(calc, "FIX 4")?;
            calc.run("0 SCI")?;
            let sci = queries(calc, "0 SCI")?;
            // All the digits in 0 SCI too (only the query's own levels
            // between the two reads).
            assert!(
                (fix - sci).abs() < 100.0,
                "MEM {fix} in FIX 4, {sci} in 0 SCI"
            );
            Ok(())
        };
        let result = both();
        let restored = calc.run("STOF")?;
        result?;
        assert_eq!(restored.error, None);
        Ok(())
    })
}

#[test]
fn pict() -> TestResult {
    scenario(|calc| {
        // A fresh PICT is 0x0; ERASE makes it 131x64. One pixel at (10, 10).
        let reply = calc.run("ERASE { # 10d # 10d } PIXON")?;
        assert_eq!(reply.error, None);
        let grob = calc.pict()?;
        assert_eq!((grob.width, grob.height), (131, 64));
        assert!(grob.pixel(10, 10));
        let lit = (0..64)
            .flat_map(|y| (0..131).map(move |x| (x, y)))
            .filter(|&(x, y)| grob.pixel(x, y))
            .count();
        assert_eq!(lit, 1);
        assert!(!names(calc)?.iter().any(|n| n == "SATXTMP"));
        // Back to 0x0: ERASE would keep an empty 131x64 PICT (1.1 KB).
        calc.run("PICT PURGE")?;
        Ok(())
    })
}

#[test]
fn backup() -> TestResult {
    scenario(|calc| {
        let data = calc.backup()?;
        let info = object::inspect(&data)?;
        assert_eq!(info.object_type, Some(ObjectType::Directory));
        assert!(info.size_nibbles.is_some_and(|n| n > 0));
        assert!(!names(calc)?.iter().any(|n| n == "SATXBK"));
        Ok(())
    })
}

// ---- XModem ----

/// Variable the XModem scenario transfers.
const XMODEM_VAR: &str = "SATXXM";

/// Press `keys` on the emulated calculator (`calc-keys`, one tmux key name
/// each; `;` is ALPHA, `\` is ON).
fn press(container: &str, keys: &[&str]) -> TestResult {
    let status = Command::new("docker")
        .args(["exec", container, "calc-keys"])
        .args(keys)
        .status()?;
    if !status.success() {
        return Err(format!("calc-keys {keys:?}: {status}").into());
    }
    Ok(())
}

/// Press ON first (alpha mode can still be on after the Kermit server ended;
/// on the 49G a stale alpha lock turned `xsend` into `SIN(X)!`), then type
/// `word` in alpha-lock mode, then ENTER.
fn type_word(container: &str, word: &str) -> TestResult {
    let letters: Vec<String> = word.chars().map(|c| c.to_string()).collect();
    let mut keys = vec!["\\", ";", ";"];
    keys.extend(letters.iter().map(String::as_str));
    keys.push("Enter");
    press(container, &keys)
}

/// How long a typed XRECV/XSEND may take to start the transfer before it is
/// typed again, and how often it is typed at most. On a loaded runner the
/// emulator loses typed keys (kb/backlog/satx-flaky-xmodem-e2e.md); the
/// transfer waits 60 s for its start, which fits three tries.
const RETYPE_AFTER: Duration = Duration::from_secs(15);
const TYPE_TRIES: u32 = 3;

/// Type `word` after `delay`, in the background (the transfer is waiting
/// meanwhile), and again (ON first, in `type_word`) while `started` stays
/// false for `RETYPE_AFTER`.
fn type_later(
    container: &str,
    word: &str,
    delay: Duration,
    started: Arc<AtomicBool>,
) -> JoinHandle<Result<(), String>> {
    let (container, word) = (container.to_string(), word.to_string());
    thread::spawn(move || {
        thread::sleep(delay);
        for attempt in 1..=TYPE_TRIES {
            if attempt > 1 {
                eprintln!("xmodem: no start after {RETYPE_AFTER:?}; typing {word} again");
            }
            type_word(&container, &word).map_err(|e| e.to_string())?;
            let typed = Instant::now();
            while typed.elapsed() < RETYPE_AFTER {
                if started.load(Ordering::SeqCst) {
                    return Ok(());
                }
                thread::sleep(Duration::from_millis(200));
            }
        }
        Ok(())
    })
}

/// A progress callback that also records the transfer's start in `started`.
fn progress(started: &Arc<AtomicBool>) -> impl FnMut(&Event) + '_ {
    move |event| {
        if matches!(event, Event::Started { .. }) {
            started.store(true, Ordering::SeqCst);
        }
        print_progress(event);
    }
}

/// Cancel whatever runs (ON) and type SERVER, then reconnect Kermit on the
/// same link. The calculator is out of server mode after XRECV/XSEND.
fn restart_server(
    container: &str,
    xs: XmodemSession,
) -> Result<Calculator, Box<dyn std::error::Error>> {
    thread::sleep(Duration::from_secs(2));
    press(container, &["\\"])?;
    thread::sleep(Duration::from_secs(1));
    type_word(container, "server")?;
    thread::sleep(Duration::from_secs(2));
    Ok(Calculator::new(Session::new(
        xs.into_transport(),
        Options::default(),
    )?))
}

fn print_progress(event: &Event) {
    match event {
        Event::Started { check } => eprintln!("xmodem: started, check {check:?}"),
        Event::Done => eprintln!("xmodem: done"),
        Event::Error(e) => eprintln!("xmodem: error {e}"),
        _ => {}
    }
}

/// Put a 269-byte string holding all 256 byte values with XRECV, check it
/// with a Kermit GET, get it back with XSEND and compare byte for byte after
/// the padding cut. 49G: HP's CRC (`D`); 48G/GX: checksum.
#[test]
fn xmodem_round_trip() -> TestResult {
    let Some(addr) = std::env::var("SATX_E2E_ADDR")
        .ok()
        .filter(|a| !a.is_empty())
    else {
        return Ok(());
    };
    let Some(container) = std::env::var("SATX_E2E_CONTAINER")
        .ok()
        .filter(|c| !c.is_empty())
    else {
        eprintln!("xmodem: SATX_E2E_CONTAINER not set, skipped");
        return Ok(());
    };
    let _guard = LOCK.lock().unwrap_or_else(|e| e.into_inner());
    let mut calc = Calculator::open(&addr)?;
    let model = calc.model()?;
    if !matches!(model, Model::Hp49G | Model::Hp48Gx) {
        eprintln!("xmodem: {} has no XModem, skipped", model.name());
        return Ok(());
    }
    cleanup(&mut calc)?;
    let iopar = calc.get("IOPAR", TransferMode::Binary)?;
    let file = all_bytes_string(&iopar[..HEADER_LEN]);
    let options = XmodemOptions::for_model(model)?;
    let want_check = match model {
        Model::Hp49G => Check::HpCrc,
        _ => Check::Checksum,
    };

    // XRECV: the plan leaves `« 'SATXXM' XRECV »` on the stack; EVAL
    // (typed, as the EVAL key does) runs it.
    let plan = calc.prepare_for_xmodem(XmodemDirection::ToCalculator, XMODEM_VAR)?;
    eprintln!("xmodem: {}", plan.instructions());
    let switched_to_rpn = plan.switched_to_rpn;
    let mut xs = XmodemSession::new(calc.into_transport(), options.clone());
    let started = Arc::new(AtomicBool::new(false));
    let typer = type_later(&container, "eval", Duration::from_secs(2), started.clone());
    let start = Instant::now();
    let sent = xs.send_with(&file, &mut progress(&started));
    eprintln!("xmodem: XRECV took {:?}", start.elapsed());
    let typed = typer.join().map_err(|_| "typing thread panicked")?;
    let mut calc = restart_server(&container, xs)?;
    let result = (|| -> TestResult {
        typed?;
        let report = sent?;
        assert_eq!(report.check, want_check);
        assert_eq!(report.bytes, file.len() as u64);
        let back = calc.get(XMODEM_VAR, TransferMode::Binary)?;
        assert_eq!(back, file, "XRECV stored something else");
        Ok(())
    })();
    if let Err(e) = result {
        let _ = cleanup(&mut calc);
        return Err(e);
    }

    // XSEND, the same way.
    let plan = calc.prepare_for_xmodem(XmodemDirection::FromCalculator, XMODEM_VAR)?;
    eprintln!("xmodem: {}", plan.instructions());
    let mut xs = XmodemSession::new(calc.into_transport(), options);
    let started = Arc::new(AtomicBool::new(false));
    let typer = type_later(&container, "eval", Duration::from_secs(2), started.clone());
    let start = Instant::now();
    let received = xs.receive_with(&mut progress(&started));
    eprintln!("xmodem: XSEND took {:?}", start.elapsed());
    let typed = typer.join().map_err(|_| "typing thread panicked")?;
    let mut calc = restart_server(&container, xs)?;
    let result = (|| -> TestResult {
        typed?;
        let got = received?;
        eprintln!(
            "xmodem: received {} bytes, last block {}, cut {:?}",
            got.received, got.last_block, got.stripped
        );
        assert_eq!(got.check, want_check);
        assert_eq!(got.stripped, Some(got.received - file.len()));
        assert_eq!(got.data, file, "XSEND sent something else");
        Ok(())
    })();
    if switched_to_rpn {
        calc.run("-95 SF")?;
    }
    let cleaned = cleanup(&mut calc);
    result?;
    cleaned
}