magellan 3.3.6

Deterministic codebase mapping tool for local development
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
480
481
482
483
484
485
486
487
488
489
490
//! Integration tests for rich span JSON output
//!
//! Tests verify that refs and get commands correctly populate rich span fields
//! when the corresponding CLI flags are provided.

use std::fs;
use std::process::Command;
use tempfile::TempDir;

/// Helper function to index a test file using CodeGraph API
fn index_test_file(source_file: &std::path::Path, db_path: &std::path::Path) {
    let mut graph = magellan::CodeGraph::open(db_path).unwrap();
    let source_bytes = fs::read(source_file).unwrap();
    let path_str = source_file.to_string_lossy().to_string();
    graph.index_file(&path_str, &source_bytes).unwrap();
}

#[test]
fn test_refs_with_context() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    // Create a simple Rust file with a function that calls another
    std::fs::write(
        &source_file,
        r#"
fn helper() {
    println!("Helper function");
}

fn main() {
    helper();
    println!("Hello, world!");
}
"#,
    )
    .unwrap();

    index_test_file(&source_file, &db_path);

    // Query refs with --with-context
    let refs_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("refs")
        .arg("--db")
        .arg(&db_path)
        .arg("--name")
        .arg("helper")
        .arg("--path")
        .arg(&source_file)
        .arg("--direction")
        .arg("out")
        .arg("--with-context")
        .arg("--context-lines")
        .arg("2")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run refs command");

    assert!(refs_output.status.success(), "Refs command should succeed");

    let json: serde_json::Value = serde_json::from_slice(&refs_output.stdout).unwrap();

    // Verify response structure
    assert_eq!(json["schema_version"], "1.0.0");
    assert_eq!(json["tool"], "magellan");
    assert!(json["timestamp"].is_string());

    // Verify data is an object
    assert!(json["data"].is_object());
    let data = &json["data"];
    assert!(data.get("references").is_some());

    // Verify references have context when flag is set
    if let Some(references) = data["references"].as_array() {
        if !references.is_empty() {
            let first_ref = &references[0];
            if let Some(span) = first_ref.get("span") {
                assert!(
                    span.get("context").is_some(),
                    "Context should be present with --with-context flag"
                );
                let context = &span["context"];
                assert!(
                    context.get("before").is_some()
                        || context.get("after").is_some()
                        || context.get("selected").is_some()
                );
            }
        }
    }
}

#[test]
fn test_refs_with_checksums() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    std::fs::write(&source_file, "fn test() {}").unwrap();

    index_test_file(&source_file, &db_path);

    // Query with --with-checksums
    let refs_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("refs")
        .arg("--db")
        .arg(&db_path)
        .arg("--name")
        .arg("test")
        .arg("--path")
        .arg(&source_file)
        .arg("--direction")
        .arg("out")
        .arg("--with-checksums")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run refs command");

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

    let json: serde_json::Value = serde_json::from_slice(&refs_output.stdout).unwrap();

    // Verify checksums are present
    let data = &json["data"];
    if let Some(references) = data["references"].as_array() {
        if !references.is_empty() {
            let first_ref = &references[0];
            if let Some(span) = first_ref.get("span") {
                assert!(
                    span.get("checksums").is_some(),
                    "Checksums should be present with --with-checksums flag"
                );
                let checksums = &span["checksums"];
                assert!(checksums.get("checksum_before").is_some());
                // Verify checksum format
                if let Some(checksum) = checksums["checksum_before"].as_str() {
                    assert!(checksum.starts_with("sha256:"));
                }
            }
        }
    }
}

#[test]
fn test_refs_with_semantics() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    std::fs::write(&source_file, "fn test_function() {}").unwrap();

    index_test_file(&source_file, &db_path);

    // Query with --with-semantics
    let refs_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("refs")
        .arg("--db")
        .arg(&db_path)
        .arg("--name")
        .arg("test_function")
        .arg("--path")
        .arg(&source_file)
        .arg("--direction")
        .arg("out")
        .arg("--with-semantics")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run refs command");

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

    let json: serde_json::Value = serde_json::from_slice(&refs_output.stdout).unwrap();

    // Verify semantics are present
    let data = &json["data"];
    if let Some(references) = data["references"].as_array() {
        if !references.is_empty() {
            let first_ref = &references[0];
            if let Some(span) = first_ref.get("span") {
                assert!(
                    span.get("semantics").is_some(),
                    "Semantics should be present with --with-semantics flag"
                );
                let semantics = &span["semantics"];
                assert!(semantics.get("kind").is_some());
                assert!(semantics.get("language").is_some());
                assert_eq!(span["semantics"]["language"], "rust");
            }
        }
    }
}

#[test]
fn test_get_with_context() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.py");

    // Create a Python file
    std::fs::write(
        &source_file,
        r#"
def my_function():
    print("Hello")
    print("World")
"#,
    )
    .unwrap();

    index_test_file(&source_file, &db_path);

    // Query with --with-context
    let get_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("get")
        .arg("--db")
        .arg(&db_path)
        .arg("--file")
        .arg(&source_file)
        .arg("--symbol")
        .arg("my_function")
        .arg("--with-context")
        .arg("--context-lines")
        .arg("1")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run get command");

    if !get_output.status.success() {
        let stderr = String::from_utf8_lossy(&get_output.stderr);
        panic!("get command failed: {}", stderr);
    }

    let json: serde_json::Value = serde_json::from_slice(&get_output.stdout).unwrap();

    // Verify response structure
    assert_eq!(json["schema_version"], "1.0.0");

    // Verify data has symbol with context
    let data = &json["data"];
    assert!(data.get("symbol").is_some());
    let symbol = &data["symbol"];

    if let Some(span) = symbol.get("span") {
        assert!(
            span.get("context").is_some(),
            "Context should be present with --with-context flag"
        );
        let context = &span["context"];
        // At least one of the context fields should be present
        assert!(
            context.get("before").is_some()
                || context.get("selected").is_some()
                || context.get("after").is_some()
        );
    }
}

#[test]
fn test_get_with_checksums() {
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.js");

    std::fs::write(&source_file, "function test() { return 42; }").unwrap();

    index_test_file(&source_file, &db_path);

    // Query with --with-checksums
    let get_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("get")
        .arg("--db")
        .arg(&db_path)
        .arg("--file")
        .arg(&source_file)
        .arg("--symbol")
        .arg("test")
        .arg("--with-checksums")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run get command");

    if !get_output.status.success() {
        let stderr = String::from_utf8_lossy(&get_output.stderr);
        panic!("get command failed: {}", stderr);
    }

    let json: serde_json::Value = serde_json::from_slice(&get_output.stdout).unwrap();

    // Verify checksums are present
    let data = &json["data"];
    if let Some(symbol) = data.get("symbol") {
        if let Some(span) = symbol.get("span") {
            assert!(
                span.get("checksums").is_some(),
                "Checksums should be present with --with-checksums flag"
            );
            let checksums = &span["checksums"];
            assert!(checksums.get("checksum_before").is_some());
            // Verify checksum format
            if let Some(checksum) = checksums["checksum_before"].as_str() {
                assert!(checksum.starts_with("sha256:"));
            }
        }
    }
}

#[test]
fn test_context_lines_limit() {
    // Test that --context-lines caps at 100
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    // Create a file with many lines
    let content = (0..200)
        .map(|i| format!("fn line_{}() {{}}", i))
        .collect::<Vec<_>>()
        .join("\n");
    std::fs::write(&source_file, content).unwrap();

    index_test_file(&source_file, &db_path);

    // Request 150 context lines (should cap at 100)
    let get_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("get")
        .arg("--db")
        .arg(&db_path)
        .arg("--file")
        .arg(&source_file)
        .arg("--symbol")
        .arg("line_50")
        .arg("--with-context")
        .arg("--context-lines")
        .arg("150")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run get command");

    if !get_output.status.success() {
        let stderr = String::from_utf8_lossy(&get_output.stderr);
        panic!("get command failed: {}", stderr);
    }

    let json: serde_json::Value = serde_json::from_slice(&get_output.stdout).unwrap();

    // Verify context is capped
    let data = &json["data"];
    if let Some(symbol) = data.get("symbol") {
        if let Some(span) = symbol.get("span") {
            if let Some(context) = span.get("context") {
                // Context should be capped, not 150 lines
                let before_len = context["before"].as_array().map(|v| v.len()).unwrap_or(0);
                let after_len = context["after"].as_array().map(|v| v.len()).unwrap_or(0);
                assert!(
                    before_len <= 100,
                    "Context before should be capped at 100, got {}",
                    before_len
                );
                assert!(
                    after_len <= 100,
                    "Context after should be capped at 100, got {}",
                    after_len
                );
            }
        }
    }
}

#[test]
fn test_refs_without_flags_has_no_rich_data() {
    // Verify default behavior doesn't include rich fields
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    std::fs::write(&source_file, "fn test() {}").unwrap();

    index_test_file(&source_file, &db_path);

    // Query WITHOUT rich span flags
    let refs_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("refs")
        .arg("--db")
        .arg(&db_path)
        .arg("--name")
        .arg("test")
        .arg("--path")
        .arg(&source_file)
        .arg("--direction")
        .arg("out")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run refs command");

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

    let json: serde_json::Value = serde_json::from_slice(&refs_output.stdout).unwrap();

    // Verify rich fields are not present when flags not set
    let data = &json["data"];
    if let Some(references) = data["references"].as_array() {
        if !references.is_empty() {
            let first_ref = &references[0];
            if let Some(span) = first_ref.get("span") {
                // Rich fields should not be present when flags not set
                let has_context = span.get("context").is_some() && !span["context"].is_null();
                let has_semantics = span.get("semantics").is_some() && !span["semantics"].is_null();
                let has_checksums = span.get("checksums").is_some() && !span["checksums"].is_null();

                assert!(
                    !has_context,
                    "Context should not be present without --with-context flag"
                );
                assert!(
                    !has_semantics,
                    "Semantics should not be present without --with-semantics flag"
                );
                assert!(
                    !has_checksums,
                    "Checksums should not be present without --with-checksums flag"
                );
            }
        }
    }
}

#[test]
fn test_get_without_flags_has_no_rich_data() {
    // Verify default behavior doesn't include rich fields
    let temp_dir = TempDir::new().unwrap();
    let db_path = temp_dir.path().join("test.db");
    let source_file = temp_dir.path().join("test.rs");

    std::fs::write(&source_file, "fn test() {}").unwrap();

    index_test_file(&source_file, &db_path);

    // Query WITHOUT rich span flags
    let get_output = Command::new(env!("CARGO_BIN_EXE_magellan"))
        .arg("get")
        .arg("--db")
        .arg(&db_path)
        .arg("--file")
        .arg(&source_file)
        .arg("--symbol")
        .arg("test")
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to run get command");

    if !get_output.status.success() {
        let stderr = String::from_utf8_lossy(&get_output.stderr);
        panic!("get command failed: {}", stderr);
    }

    let json: serde_json::Value = serde_json::from_slice(&get_output.stdout).unwrap();

    // Verify rich fields are not present when flags not set
    let data = &json["data"];
    if let Some(symbol) = data.get("symbol") {
        if let Some(span) = symbol.get("span") {
            // Rich fields should not be present when flags not set
            let has_context = span.get("context").is_some() && !span["context"].is_null();
            let has_semantics = span.get("semantics").is_some() && !span["semantics"].is_null();
            let has_checksums = span.get("checksums").is_some() && !span["checksums"].is_null();

            assert!(
                !has_context,
                "Context should not be present without --with-context flag"
            );
            assert!(
                !has_semantics,
                "Semantics should not be present without --with-semantics flag"
            );
            assert!(
                !has_checksums,
                "Checksums should not be present without --with-checksums flag"
            );
        }
    }
}