magellan 3.2.0

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

//! Status flag tests for Magellan binary
//!
//! Tests that magellan watch --status prints correct counts.

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

#[test]
fn test_status_flag_prints_counts() {
    // Setup: Create temp directories
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    // Get the path to the magellan binary
    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file with 2 functions and 1 reference
    fs::write(&file_path, b"fn foo() {}\nfn bar() { foo(); }").unwrap();

    // Index the file by opening CodeGraph directly
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
        graph.index_references(&path_str, &source).unwrap();
    }

    // Run magellan status --db
    let output = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .output()
        .expect("Failed to execute magellan status");

    // Verify output contains counts
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success(), "Process should exit successfully");

    // Should have exactly 1 file, 2 symbols (foo, bar), 1 reference (bar -> foo)
    assert!(
        stdout.contains("files: 1"),
        "Expected 'files: 1' in output, got: {}",
        stdout
    );
    assert!(
        stdout.contains("symbols: 2"),
        "Expected 'symbols: 2' in output, got: {}",
        stdout
    );
    assert!(
        stdout.contains("references: 1"),
        "Expected 'references: 1' in output, got: {}",
        stdout
    );
}

#[test]
fn test_status_json_output_structure() {
    // Setup: Create temp directories
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    // Get the path to the magellan binary
    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file with content
    fs::write(&file_path, b"fn foo() {}\nfn bar() { foo(); }").unwrap();

    // Index the file
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
        graph.index_references(&path_str, &source).unwrap();
    }

    // Run magellan status --output json --db
    let output = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        output.status.success(),
        "Process should exit successfully: {}",
        stdout
    );

    // Parse as JSON
    let json: serde_json::Value =
        serde_json::from_str(&stdout).expect("Output should be valid JSON");

    // Verify structure
    assert_eq!(json["schema_version"], "1.0.0");
    assert!(json["execution_id"].is_string());
    assert!(json["data"].is_object());

    // Verify data fields
    let data = &json["data"];
    assert_eq!(data["files"], 1);
    assert_eq!(data["symbols"], 2);
    assert!(data["references"].is_number());
    assert!(data["calls"].is_number());
    assert!(data["code_chunks"].is_number());
}

#[test]
fn test_status_deterministic_ordering() {
    // Setup: Create temp directories
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    // Get the path to the magellan binary
    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file with content
    fs::write(&file_path, b"fn foo() {}\nfn bar() { foo(); }").unwrap();

    // Index the file
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
        graph.index_references(&path_str, &source).unwrap();
    }

    // Run magellan status --output json twice
    let output1 = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let output2 = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let stdout1 = String::from_utf8_lossy(&output1.stdout);
    let stdout2 = String::from_utf8_lossy(&output2.stdout);

    assert!(output1.status.success());
    assert!(output2.status.success());

    // Parse both as JSON
    let json1: serde_json::Value = serde_json::from_str(&stdout1).unwrap();
    let json2: serde_json::Value = serde_json::from_str(&stdout2).unwrap();

    // execution_id should differ
    assert_ne!(
        json1["execution_id"], json2["execution_id"],
        "execution_id should be unique per run"
    );

    // data field should be identical (deterministic)
    assert_eq!(
        json1["data"], json2["data"],
        "data should be identical across runs (deterministic)"
    );

    // schema_version should be identical
    assert_eq!(json1["schema_version"], json2["schema_version"]);
}

#[test]
fn test_status_schema_version_present() {
    // Setup: Create temp directories
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    // Get the path to the magellan binary
    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file
    fs::write(&file_path, b"fn test() {}").unwrap();

    // Index the file
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
    }

    // Run magellan status --output json
    let output = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let stdout = String::from_utf8_lossy(&output.stdout);

    // Verify schema_version field exists and has correct value
    assert!(
        stdout.contains("\"schema_version\""),
        "Missing schema_version field"
    );
    assert!(
        stdout.contains("\"1.0.0\""),
        "Missing or incorrect schema version value"
    );
}

#[test]
fn test_execution_id_unique() {
    // Setup: Create temp directories
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    // Get the path to the magellan binary
    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file
    fs::write(&file_path, b"fn test() {}").unwrap();

    // Index the file
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
    }

    // Run magellan status --output json twice
    let output1 = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let output2 = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .arg("--output")
        .arg("json")
        .output()
        .expect("Failed to execute magellan status");

    let stdout1 = String::from_utf8_lossy(&output1.stdout);
    let stdout2 = String::from_utf8_lossy(&output2.stdout);

    // Parse JSON and extract execution_ids
    let json1: serde_json::Value = serde_json::from_str(&stdout1).unwrap();
    let json2: serde_json::Value = serde_json::from_str(&stdout2).unwrap();

    let id1 = json1["execution_id"].as_str().unwrap();
    let id2 = json2["execution_id"].as_str().unwrap();

    // Execution IDs should be different
    assert_ne!(id1, id2, "execution_id should be unique per run");

    // Both should be valid non-empty strings
    assert!(!id1.is_empty(), "execution_id should not be empty");
    assert!(!id2.is_empty(), "execution_id should not be empty");
}

#[test]
fn test_status_human_mode_unchanged() {
    // Verify human mode still works as before
    let temp_dir = TempDir::new().unwrap();
    let root_path = temp_dir.path().to_path_buf();
    let db_path = temp_dir.path().join("magellan.db");
    let file_path = root_path.join("test.rs");

    let bin_path = std::env::var("CARGO_BIN_EXE_magellan").unwrap_or_else(|_| {
        let mut path = std::env::current_exe().unwrap();
        path.pop();
        path.pop();
        path.push("magellan");
        path.to_str().unwrap().to_string()
    });

    // Create file with 2 functions and 1 reference
    fs::write(&file_path, b"fn foo() {}\nfn bar() { foo(); }").unwrap();

    // Index the file
    {
        let mut graph = magellan::CodeGraph::open(&db_path).unwrap();
        let source = fs::read(&file_path).unwrap();
        let path_str = file_path.to_string_lossy().to_string();
        graph.index_file(&path_str, &source).unwrap();
        graph.index_references(&path_str, &source).unwrap();
    }

    // Run magellan status (default human mode, no --output flag)
    let output = Command::new(&bin_path)
        .arg("status")
        .arg("--db")
        .arg(&db_path)
        .output()
        .expect("Failed to execute magellan status");

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(output.status.success());

    // Verify human-readable format (not JSON)
    assert!(
        stdout.contains("files: 1"),
        "Should show files count in human format"
    );
    assert!(
        stdout.contains("symbols: 2"),
        "Should show symbols count in human format"
    );
    assert!(
        stdout.contains("calls:"),
        "Should show calls count in human format"
    );
    assert!(
        !stdout.contains("schema_version"),
        "Should not have JSON fields in human mode"
    );
    assert!(
        !stdout.contains("execution_id"),
        "Should not have JSON fields in human mode"
    );
}