sipmon 0.1.5

Passive SIP/RTP signaling & media quality monitoring (pcap/live, TUI + JSONL export)
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

//! End-to-end tests running the sipmon binary against a real pcap fixture
//! (INVITE -> 100 -> 200 -> ACK -> RTP/RTCP (both directions) -> BYE -> 200),
//! captured from two sipbot instances on loopback.

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

fn bin() -> Command {
    Command::new(env!("CARGO_BIN_EXE_sipmon"))
}

fn fixture() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join("tests/pcap_fixtures/sipbot_call.pcap")
}

struct CallLine {
    state: String,
    setup_ms: Option<i64>,
    crit: i64,
}

fn run_headless(pcap: &PathBuf, extra: &[&str]) -> Vec<CallLine> {
    let mut cmd = bin();
    for a in extra {
        cmd.arg(a);
    }
    cmd.arg("file").arg("-r").arg(pcap).arg("--no-tui");
    let out = cmd.output().expect("run sipmon");
    assert!(
        out.status.success(),
        "sipmon failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    String::from_utf8_lossy(&out.stdout)
        .lines()
        .filter_map(|l| {
            let v: serde_json::Value = serde_json::from_str(l).ok()?;
            Some(CallLine {
                state: v["state"].as_str()?.to_string(),
                setup_ms: v["setup_ms"].as_i64(),
                crit: v["crit"].as_i64().unwrap_or(0),
            })
        })
        .collect()
}

#[test]
fn file_analysis_finds_completed_call() {
    let calls = run_headless(&fixture(), &[]);
    assert_eq!(calls.len(), 1, "expected exactly one call in the fixture");
    let c = &calls[0];
    assert_eq!(c.state, "Completed");
    assert!(c.setup_ms.unwrap_or(0) > 0, "setup_ms should be positive");
    assert_eq!(
        c.crit, 0,
        "no critical diagnostics expected on a clean call"
    );
}

#[test]
fn default_positional_pcap_mode() {
    // `sipmon <file.pcap>` without a subcommand is equivalent to `file -r`.
    let mut cmd = bin();
    cmd.arg("--no-tui").arg(fixture());
    let out = cmd.output().expect("run sipmon");
    assert!(
        out.status.success(),
        "sipmon failed: {}",
        String::from_utf8_lossy(&out.stderr)
    );
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("\"state\":\"Completed\""),
        "default pcap mode must analyze the file, got: {stdout}"
    );
}

#[test]
fn default_positional_evlog_replays() {
    // `sipmon <file.evlog>` without a subcommand is equivalent to `replay -l`.
    let dir = tempfile::tempdir().unwrap();
    let evlog = dir.path().join("t.evlog");
    let mut cmd = bin();
    cmd.arg("--evlog")
        .arg(&evlog)
        .arg("file")
        .arg("-r")
        .arg(fixture())
        .arg("--no-tui");
    let out = cmd.output().expect("run sipmon");
    assert!(out.status.success());
    assert!(evlog.exists(), "event log must be written");

    let r = bin().arg("--no-tui").arg(&evlog).output().unwrap();
    assert!(
        r.status.success(),
        "default evlog mode failed: {}",
        String::from_utf8_lossy(&r.stderr)
    );
    let rout = String::from_utf8_lossy(&r.stdout);
    assert!(
        rout.contains("Completed"),
        "default evlog mode must replay the log, got: {rout}"
    );
}

#[test]
fn evlog_roundtrip_and_query() {
    let dir = tempfile::tempdir().unwrap();
    let evlog = dir.path().join("t.evlog");

    let mut cmd = bin();
    cmd.arg("--evlog")
        .arg(&evlog)
        .arg("file")
        .arg("-r")
        .arg(fixture())
        .arg("--no-tui");
    let out = cmd.output().expect("run sipmon");
    assert!(out.status.success());
    let stdout = String::from_utf8_lossy(&out.stdout);
    let call_id: String = {
        let v: serde_json::Value = serde_json::from_str(stdout.lines().next().unwrap()).unwrap();
        v["call_id"].as_str().unwrap().to_string()
    };
    assert!(evlog.exists(), "event log must be written");

    // query: full flow for the call
    let q = bin()
        .args(["query", "-l"])
        .arg(&evlog)
        .arg("-c")
        .arg(&call_id)
        .output()
        .unwrap();
    assert!(q.status.success());
    let qout = String::from_utf8_lossy(&q.stdout);
    let sip_msgs = qout.lines().filter(|l| l.contains("\"msg\"")).count();
    let streams = qout.lines().filter(|l| l.contains("\"stream\"")).count();
    assert!(
        sip_msgs >= 6,
        "expected INVITE/100/200/ACK/BYE/200, got {sip_msgs}"
    );
    assert!(
        streams >= 2,
        "expected periodic stream snapshots, got {streams}"
    );

    // replay reproduces the same terminal state
    let r = bin()
        .args(["replay", "-l"])
        .arg(&evlog)
        .arg("--no-tui")
        .output()
        .unwrap();
    assert!(r.status.success());
    let rout = String::from_utf8_lossy(&r.stdout);
    assert!(
        rout.contains(&call_id) && rout.contains("Completed"),
        "replay must reproduce the completed call"
    );

    // export jsonl
    let jsonl = dir.path().join("t.jsonl");
    let e = bin()
        .args(["export", "-l"])
        .arg(&evlog)
        .arg("--jsonl")
        .arg(&jsonl)
        .output()
        .unwrap();
    assert!(e.status.success());
    let content = std::fs::read_to_string(&jsonl).unwrap();
    assert!(content.contains("\"kind\":\"call\""));
    assert!(content.contains("\"kind\":\"stream\""));
    assert!(content.contains("PCMU"));
}

#[test]
fn dry_run_writes_no_files() {
    let dir = tempfile::tempdir().unwrap();
    let before: Vec<_> = std::fs::read_dir(dir.path()).unwrap().collect();
    assert!(before.is_empty());

    let mut cmd = bin();
    cmd.arg("--dry-run")
        .arg("--evlog")
        .arg(dir.path().join("should-not-exist.evlog"))
        .arg("file")
        .arg("-r")
        .arg(fixture())
        .arg("--no-tui");
    let out = cmd.output().unwrap();
    assert!(out.status.success());
    let after: Vec<_> = std::fs::read_dir(dir.path()).unwrap().collect();
    assert!(after.is_empty(), "dry-run must not write any files");
}

#[test]
fn caps_limit_retained_calls() {
    // The fixture has one call; cap of 1 keeps it (no crash, sane output).
    let calls = run_headless(&fixture(), &["--max-calls", "1", "--max-streams", "2"]);
    assert!(!calls.is_empty());
}

#[test]
fn stdin_stream_mode() {
    // tcpdump-style: re-emit the fixture as a pcap stream on stdin.
    let raw = std::fs::read(fixture()).unwrap();
    let mut child = bin()
        .arg("-")
        .env_remove("TERM")
        .stdin(std::process::Stdio::piped())
        .stdout(std::process::Stdio::piped())
        .stderr(std::process::Stdio::null())
        .spawn()
        .unwrap();
    use std::io::Write;
    child.stdin.take().unwrap().write_all(&raw).unwrap();
    let out = child.wait_with_output().unwrap();
    assert!(out.status.success());
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("Completed"),
        "stdin mode must analyze the piped pcap stream"
    );
}

#[test]
fn record_requires_evlog() {
    let out = bin().arg("record").arg("-i").arg("lo").output().unwrap();
    assert!(!out.status.success(), "record without --evlog must fail");
    let err = String::from_utf8_lossy(&out.stderr);
    assert!(
        err.contains("--evlog"),
        "error should mention --evlog: {err}"
    );
}

#[test]
fn record_bad_interface_clean_error() {
    let dir = tempfile::tempdir().unwrap();
    let evlog = dir.path().join("t.evlog");
    let out = bin()
        .arg("record")
        .arg("-i")
        .arg("definitely-not-an-interface-xyz")
        .arg("-w")
        .arg(&evlog)
        .output()
        .unwrap();
    assert!(!out.status.success(), "bad interface must fail cleanly");
    let err = String::from_utf8_lossy(&out.stderr);
    assert!(err.contains("Error"), "expected a clean error, got: {err}");
    assert!(
        !evlog.exists(),
        "no evlog should be created when the interface fails"
    );
}