otelite 0.1.0

Otelite: OTLP receiver, dashboard, and CLI for local OpenTelemetry observability
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

//! Integration tests for CLI scripting and Unix conventions
//!
//! These tests verify that the CLI follows Unix conventions:
//! - Exit codes: 0=success, 1=error, 2=connection, 3=not found
//! - Errors write to stderr
//! - Data writes to stdout
//! - JSON output is parseable by jq

use assert_cmd::Command;
use mockito::{Matcher, Server};
use predicates::prelude::*;

// T083: Integration test for exit codes (0, 1, 2, 3)

#[tokio::test]
async fn test_exit_code_success() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/logs")
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("limit".into(), "50".into()),
            Matcher::UrlEncoded("since".into(), "1h".into()),
        ]))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"{"logs": [], "total": 0, "limit": 50, "offset": 0}"#)
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("logs")
        .arg("list")
        .assert()
        .success()
        .stdout(predicate::str::contains("No logs found"));
}

#[tokio::test]
async fn test_exit_code_connection_error() {
    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg("http://localhost:9999")
        .arg("--timeout")
        .arg("1")
        .arg("logs")
        .arg("list")
        .assert()
        .failure()
        .code(2)
        .stderr(predicate::str::contains("Failed to connect"))
        .stderr(predicate::str::contains("Suggestions"));
}

#[tokio::test]
async fn test_exit_code_not_found() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/logs/9999999999999999")
        .with_status(404)
        .with_header("content-type", "application/json")
        .with_body(r#"{"error":"Not found"}"#)
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("logs")
        .arg("show")
        .arg("9999999999999999")
        .assert()
        .failure()
        .code(3)
        .stderr(predicate::str::contains("not found"))
        .stderr(predicate::str::contains("Suggestions"));
}

#[tokio::test]
async fn test_exit_code_invalid_argument() {
    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--timeout")
        .arg("invalid")
        .arg("logs")
        .arg("list")
        .assert()
        .failure()
        .code(2);
}

// T084: Integration test for stderr error output

#[tokio::test]
async fn test_errors_write_to_stderr() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/logs/1705315800000000000")
        .with_status(404)
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("logs")
        .arg("show")
        .arg("1705315800000000000")
        .assert()
        .failure()
        .stderr(predicate::str::contains("not found"))
        .stdout(predicate::str::is_empty());
}

#[tokio::test]
async fn test_connection_error_message_format() {
    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg("http://localhost:9999")
        .arg("--timeout")
        .arg("1")
        .arg("logs")
        .arg("list")
        .assert()
        .failure()
        .stderr(predicate::str::contains("Failed to connect"))
        .stderr(predicate::str::contains("Suggestions:"))
        .stderr(predicate::str::contains(
            "Check if Otelite server is running",
        ))
        .stderr(predicate::str::contains("Verify the endpoint URL"));
}

#[tokio::test]
async fn test_not_found_error_message_format() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/traces/missing-trace")
        .with_status(404)
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("traces")
        .arg("show")
        .arg("missing-trace")
        .assert()
        .failure()
        .stderr(predicate::str::contains("not found"))
        .stderr(predicate::str::contains("Suggestions:"))
        .stderr(predicate::str::contains("Verify the ID is correct"));
}

// T085: Integration test for stdout data output

#[tokio::test]
async fn test_data_writes_to_stdout() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/logs")
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("limit".into(), "50".into()),
            Matcher::UrlEncoded("since".into(), "1h".into()),
        ]))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(
            r#"{"logs": [{
                "timestamp": 1705315800000000000,
                "severity": "INFO",
                "severity_text": "INFO",
                "body": "Test log message",
                "attributes": {},
                "resource_attributes": {},
                "scope_name": "test",
                "trace_id": null,
                "span_id": null
            }], "total": 1, "limit": 50, "offset": 0}"#,
        )
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("logs")
        .arg("list")
        .assert()
        .success()
        .stdout(predicate::str::contains("1705315800000000000"))
        .stdout(predicate::str::contains("Test log message"))
        .stderr(predicate::str::is_empty());
}

#[tokio::test]
async fn test_json_output_to_stdout() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/metrics")
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("limit".into(), "50".into()),
            Matcher::UrlEncoded("since".into(), "1h".into()),
        ]))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(
            r#"[{
                "name": "cpu_usage",
                "description": null,
                "unit": null,
                "metric_type": "gauge",
                "value": 45.2,
                "timestamp": 1705315800000000000,
                "attributes": {"host": "server1"},
                "resource": null
            }]"#,
        )
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    cmd.arg("--endpoint")
        .arg(server.url())
        .arg("--format")
        .arg("json")
        .arg("metrics")
        .arg("list")
        .assert()
        .success()
        .stdout(predicate::str::contains("cpu_usage"))
        .stdout(predicate::str::contains("45.2"))
        .stderr(predicate::str::is_empty());
}

// T086: Integration test for JSON piping to jq

#[tokio::test]
async fn test_json_output_is_valid() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/logs")
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("limit".into(), "50".into()),
            Matcher::UrlEncoded("since".into(), "1h".into()),
        ]))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(
            r#"{"logs": [{
                "timestamp": 1705315800000000000,
                "severity": "INFO",
                "severity_text": "INFO",
                "body": "Test",
                "attributes": {},
                "resource_attributes": {},
                "scope_name": "test",
                "trace_id": null,
                "span_id": null
            }], "total": 1, "limit": 50, "offset": 0}"#,
        )
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    let output = cmd
        .arg("--endpoint")
        .arg(server.url())
        .arg("--format")
        .arg("json")
        .arg("logs")
        .arg("list")
        .output()
        .expect("Failed to execute command");

    assert!(output.status.success());

    let stdout = String::from_utf8(output.stdout).expect("Invalid UTF-8");
    let parsed: serde_json::Value = serde_json::from_str(&stdout).expect("Invalid JSON output");

    assert!(parsed.is_array());
    let array = parsed.as_array().unwrap();
    assert_eq!(array.len(), 1);
    assert_eq!(array[0]["timestamp"], 1705315800000000000_i64);
    assert_eq!(array[0]["severity"], "INFO");
}

#[tokio::test]
async fn test_json_output_can_be_piped() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/traces")
        .match_query(Matcher::UrlEncoded("limit".into(), "50".into()))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(
            r#"{"traces": [{
                "trace_id": "trace-123",
                "root_span_name": "http-request",
                "start_time": 1705315800000000000,
                "duration": 150000000,
                "span_count": 1,
                "service_names": [],
                "has_errors": false
            }], "total": 1, "limit": 50, "offset": 0}"#,
        )
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    let output = cmd
        .arg("--endpoint")
        .arg(server.url())
        .arg("--format")
        .arg("json")
        .arg("traces")
        .arg("list")
        .output()
        .expect("Failed to execute command");

    assert!(output.status.success());

    let stdout = String::from_utf8(output.stdout).expect("Invalid UTF-8");
    let parsed: serde_json::Value = serde_json::from_str(&stdout).expect("Invalid JSON");

    let trace_id = parsed[0]["trace_id"].as_str().unwrap();
    assert_eq!(trace_id, "trace-123");

    let duration = parsed[0]["duration"].as_i64().unwrap();
    assert_eq!(duration, 150000000);
}

#[tokio::test]
async fn test_empty_json_array_is_valid() {
    let mut server = Server::new_async().await;
    let _mock = server
        .mock("GET", "/api/metrics")
        .match_query(Matcher::AllOf(vec![
            Matcher::UrlEncoded("limit".into(), "50".into()),
            Matcher::UrlEncoded("since".into(), "1h".into()),
        ]))
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body(r#"[]"#)
        .create_async()
        .await;

    let mut cmd = Command::cargo_bin("otelite").unwrap();
    let output = cmd
        .arg("--endpoint")
        .arg(server.url())
        .arg("--format")
        .arg("json")
        .arg("metrics")
        .arg("list")
        .output()
        .expect("Failed to execute command");

    assert!(output.status.success());

    let stdout = String::from_utf8(output.stdout).expect("Invalid UTF-8");
    let parsed: serde_json::Value = serde_json::from_str(&stdout).expect("Invalid JSON");
    assert!(parsed.is_array());
    assert_eq!(parsed.as_array().unwrap().len(), 0);
}