kshana 0.35.0

Open, reproducible PNT-resilience simulator with quantum-sensor performance models
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

// SPDX-License-Identifier: AGPL-3.0-only
//! The first minute with the command-line interface (CLI), as a registry user meets it.
//!
//! A `cargo install kshana` user has the executable and no `scenarios/` directory. Every
//! quickstart used to point at a scenario file only a clone of the repository has, so the
//! first command failed. These tests hold the answers to the first things such a user
//! types: `--help`, `--version`, a mistyped option, `kshana example`, a run of the scenario
//! it writes, and `--validate` on it.
//!
//! The bundled table is held to `scenarios/` in both directions: every scenario file is
//! either bundled byte for byte or refused with its reason, and nothing else is bundled.

use std::process::{Command, Output};

fn bin() -> &'static str {
    env!("CARGO_BIN_EXE_kshana")
}

fn kshana(args: &[&str]) -> Output {
    Command::new(bin())
        .args(args)
        .output()
        .expect("run kshana binary")
}

fn stdout(o: &Output) -> String {
    String::from_utf8(o.stdout.clone()).expect("stdout is UTF-8")
}

fn stderr(o: &Output) -> String {
    String::from_utf8(o.stderr.clone()).expect("stderr is UTF-8")
}

/// Per-call working directory under the system temp dir.
///
/// The sequence is what makes it unique, not the pid: every test in this binary runs as a
/// thread of ONE process and shares the pid, so a pid-keyed name separates concurrent
/// `cargo test` processes and nothing inside one. Enforced by `tests/source_guards.rs`.
fn temp_workdir(label: &str) -> std::path::PathBuf {
    static SEQ: std::sync::atomic::AtomicU64 = std::sync::atomic::AtomicU64::new(0);
    let seq = SEQ.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
    let dir = std::env::temp_dir().join(format!("kshana-{label}-{}-{seq}", std::process::id()));
    std::fs::create_dir_all(&dir).unwrap();
    dir
}

/// Scenario files that need data shipped with the repository only. Each must be refused by
/// `kshana example` with a reason rather than bundled.
const REPO_ONLY: &[&str] = &[
    "celeste-iod-classical-pilot-signals",
    "celeste-iod-end-to-end",
    "celeste-iod-fused-pvt",
    "leo-navmsg-celeste-iod",
    "leo-pass-celeste-iod-multiband",
    "lunar-llr-datum",
    "quantum-pnt-demonstrator.suite",
];

/// Repo-only files a release may withhold by deleting them (the Celeste IOD preset's
/// scenarios, withheld with `src/celeste_iod.rs`). The CLI must still refuse the name with
/// its reason, but the file may be absent.
const WITHHOLDABLE: &[&str] = &[
    "celeste-iod-classical-pilot-signals",
    "celeste-iod-end-to-end",
    "celeste-iod-fused-pvt",
    "leo-navmsg-celeste-iod",
    "leo-pass-celeste-iod-multiband",
];

fn scenario_stems() -> Vec<String> {
    let dir = std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("scenarios");
    let mut stems: Vec<String> = std::fs::read_dir(&dir)
        .expect("read scenarios/")
        .map(|e| e.unwrap().file_name().to_string_lossy().into_owned())
        .filter_map(|n| n.strip_suffix(".toml").map(str::to_string))
        .collect();
    stems.sort();
    stems
}

#[test]
fn help_and_version_answer_and_exit_zero() {
    for flag in ["--help", "-h", "help"] {
        let o = kshana(&[flag]);
        assert!(o.status.success(), "{flag} exited {:?}", o.status.code());
        let out = stdout(&o);
        assert!(
            out.starts_with("usage: kshana <scenario.toml>"),
            "{flag}: {out}"
        );
        assert!(out.contains("kshana example [<name>]"), "{flag}: {out}");
    }
    for flag in ["--version", "-V"] {
        let o = kshana(&[flag]);
        assert!(o.status.success(), "{flag} exited {:?}", o.status.code());
        assert_eq!(
            stdout(&o).trim(),
            format!("kshana {}", env!("CARGO_PKG_VERSION"))
        );
    }
}

#[test]
fn unknown_options_and_extra_arguments_fail_with_a_message() {
    let o = kshana(&["--exprot-sp3", "out.sp3", "s.toml"]);
    assert_eq!(o.status.code(), Some(2));
    let err = stderr(&o);
    assert!(err.contains("unknown option '--exprot-sp3'"), "{err}");
    assert!(err.contains("usage: kshana"), "{err}");

    let o = kshana(&["a.toml", "b.toml"]);
    assert_eq!(o.status.code(), Some(2));
    let err = stderr(&o);
    assert!(err.contains("unexpected argument 'b.toml'"), "{err}");
    assert!(err.contains("usage: kshana"), "{err}");

    let o = kshana(&["example", "clock-holdover", "extra"]);
    assert_eq!(o.status.code(), Some(2));
    assert!(stderr(&o).contains("unexpected argument 'extra'"));
}

#[test]
fn a_missing_scenario_file_points_at_kshana_example() {
    let dir = temp_workdir("missing");
    let missing = dir.join("clock-holdover.toml");
    let o = kshana(&[missing.to_str().unwrap()]);
    assert!(!o.status.success());
    let err = stderr(&o);
    assert!(err.contains("cannot read"), "{err}");
    assert!(err.contains("kshana example"), "{err}");
    std::fs::remove_dir_all(&dir).ok();
}

#[test]
fn every_scenario_file_is_bundled_byte_for_byte_or_refused_with_a_reason() {
    let stems = scenario_stems();
    assert!(
        stems.len() > 50,
        "found only {} scenario files",
        stems.len()
    );

    let listing = kshana(&["example"]);
    assert!(listing.status.success());
    let listed: Vec<String> = stdout(&listing).lines().map(str::to_string).collect();
    let expected: Vec<String> = stems
        .iter()
        .filter(|s| !REPO_ONLY.contains(&s.as_str()))
        .cloned()
        .collect();
    assert_eq!(
        listed, expected,
        "`kshana example` must list exactly the scenario files that run on their own; \
         add the new file to src/bundled_scenarios.rs (or to its REPO_ONLY table)"
    );

    let root = std::path::Path::new(env!("CARGO_MANIFEST_DIR"));
    for stem in &expected {
        let o = kshana(&["example", stem]);
        assert!(o.status.success(), "kshana example {stem} failed");
        let file = std::fs::read(root.join("scenarios").join(format!("{stem}.toml"))).unwrap();
        assert!(
            o.stdout == file,
            "kshana example {stem} is not byte-identical to scenarios/{stem}.toml"
        );
    }
    // A trailing `.toml` names the same scenario.
    let o = kshana(&["example", "clock-holdover.toml"]);
    assert!(o.status.success());
    assert_eq!(stdout(&o), include_str!("../scenarios/clock-holdover.toml"));

    for stem in REPO_ONLY {
        assert!(
            stems.iter().any(|s| s == stem) || WITHHOLDABLE.contains(stem),
            "{stem} is listed as repo-only but no scenarios/{stem}.toml exists"
        );
        let o = kshana(&["example", stem]);
        assert_eq!(o.status.code(), Some(2), "kshana example {stem}");
        let err = stderr(&o);
        assert!(
            err.contains("not bundled") && err.contains("repository"),
            "kshana example {stem} must say why it is repo-only: {err}"
        );
    }

    let o = kshana(&["example", "no-such-scenario"]);
    assert_eq!(o.status.code(), Some(2));
    assert!(stderr(&o).contains("no bundled scenario named 'no-such-scenario'"));
}

#[test]
fn the_quickstart_runs_as_written_from_an_empty_directory() {
    // kshana example clock-holdover > clock-holdover.toml
    // kshana clock-holdover.toml
    // kshana --validate clock-holdover.toml
    let dir = temp_workdir("quickstart");
    let o = kshana(&["example", "clock-holdover"]);
    assert!(o.status.success());
    let scn = dir.join("clock-holdover.toml");
    std::fs::write(&scn, &o.stdout).unwrap();

    let run = kshana(&[scn.to_str().unwrap()]);
    assert!(run.status.success(), "run failed: {}", stderr(&run));
    for ext in ["result.json", "chart.svg", "report.html"] {
        let p = dir.join(format!("clock-holdover.{ext}"));
        assert!(p.exists(), "expected {}", p.display());
    }

    let v = kshana(&["--validate", scn.to_str().unwrap()]);
    assert!(v.status.success(), "validate failed: {}", stderr(&v));
    let out = stdout(&v);
    assert_eq!(
        out.lines().count(),
        1,
        "--validate prints one line on success: {out}"
    );
    assert!(out.starts_with("ok: clock"), "{out}");
    std::fs::remove_dir_all(&dir).ok();
}