wickra-xray 0.1.1

Reference command-line X-Ray over the Wickra wickra-xray-core: load a spec and a recorded dataset, build a frame, print it as text or JSON.
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

//! End-to-end verification of the `wickra-xray` binary (ยง2.4 verify clause).
//!
//! Runs the built binary against a fixture dataset and checks that `--format
//! json` reproduces `wickra-xray-core`'s frame byte-for-byte and that `--at` yields an
//! earlier, clipped frame.

use std::fs;
use std::path::PathBuf;
use std::process::Command;

use wickra_xray_core::{Dataset, Xray};

const SPEC: &str = r#"{ "dataset_ref": "m", "symbol": "AAA",
    "panels": [ { "kind": "footprint", "price_bin": 1.0, "bucket_ms": 60000 } ] }"#;
const TRADES: &str = r#"[ { "ts": 1000, "price": 100.4, "qty": 2.0, "side": "buy" },
    { "ts": 1100, "price": 100.9, "qty": 1.0, "side": "sell" },
    { "ts": 1200, "price": 101.2, "qty": 3.0, "side": "buy" } ]"#;

/// Write the fixture into a fresh temp directory and return `(base, spec, data)`.
fn fixture(tag: &str) -> (PathBuf, PathBuf, PathBuf) {
    let base = std::env::temp_dir().join(format!("wickra-xray-cli-it-{tag}"));
    let data = base.join("data");
    let _ = fs::remove_dir_all(&base);
    fs::create_dir_all(&data).unwrap();
    let spec = base.join("spec.json");
    fs::write(&spec, SPEC).unwrap();
    fs::write(data.join("trades.json"), TRADES).unwrap();
    (base, spec, data)
}

/// The library's own frame string, for comparison with the CLI output.
fn expected_frame(at: Option<i64>) -> String {
    let mut xray = Xray::new(SPEC).unwrap();
    xray.load(Dataset::from_json(&format!(r#"{{ "trades": {TRADES} }}"#)).unwrap())
        .unwrap();
    let frame = match at {
        Some(ts) => xray.frame_at(ts).unwrap(),
        None => xray.frame().unwrap(),
    };
    serde_json::to_string(&frame).unwrap()
}

fn run_json(spec: &PathBuf, data: &PathBuf, at: Option<i64>) -> String {
    let mut cmd = Command::new(env!("CARGO_BIN_EXE_wickra-xray"));
    cmd.arg("--spec").arg(spec).arg("--data").arg(data);
    if let Some(ts) = at {
        cmd.arg("--at").arg(ts.to_string());
    }
    cmd.arg("--format").arg("json");
    let out = cmd.output().unwrap();
    assert!(out.status.success(), "binary failed: {:?}", out.status);
    String::from_utf8(out.stdout).unwrap().trim().to_owned()
}

#[test]
fn json_output_matches_build_frame_byte_for_byte() {
    let (base, spec, data) = fixture("full");
    assert_eq!(run_json(&spec, &data, None), expected_frame(None));
    fs::remove_dir_all(&base).unwrap();
}

#[test]
fn at_yields_an_earlier_clipped_frame() {
    let (base, spec, data) = fixture("at");
    let clipped = run_json(&spec, &data, Some(1100));
    assert_eq!(clipped, expected_frame(Some(1100)));
    // Only the ts<=1100 trades are in range, so the cursor moved back.
    assert!(clipped.contains(r#""cursor_ts":1100"#));
    assert!(!clipped.contains(r#""cursor_ts":1200"#));
    fs::remove_dir_all(&base).unwrap();
}