scope-cli 0.9.2

Code intelligence CLI for LLM coding agents — structural navigation, dependency graphs, and semantic search without reading full source files
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
/// Integration tests for Go language support.
///
/// Each test copies the Go fixture to a temporary directory to avoid
/// modifying the committed fixture, then drives the binary via assert_cmd.
use assert_cmd::Command;
use predicates::str::contains;
use std::path::Path;
use tempfile::TempDir;

// Path to the committed Go fixture (relative to project root).
const GO_FIXTURE: &str = "tests/fixtures/go-simple";

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

/// Copy an entire directory tree into `dest`.
fn copy_dir_all(src: &Path, dest: &Path) {
    std::fs::create_dir_all(dest).unwrap();
    for entry in std::fs::read_dir(src).unwrap() {
        let entry = entry.unwrap();
        let src_path = entry.path();
        let dest_path = dest.join(entry.file_name());
        if src_path.is_dir() {
            copy_dir_all(&src_path, &dest_path);
        } else {
            std::fs::copy(&src_path, &dest_path).unwrap();
        }
    }
}

/// Copy the Go fixture into a fresh TempDir and return it.
fn setup_go_fixture() -> TempDir {
    let dir = TempDir::new().unwrap();
    let fixture = Path::new(GO_FIXTURE);
    copy_dir_all(fixture, dir.path());
    dir
}

/// Run `scope init` in `dir`.
fn sc_init(dir: &Path) -> assert_cmd::assert::Assert {
    Command::cargo_bin("scope")
        .unwrap()
        .arg("init")
        .current_dir(dir)
        .assert()
}

/// Run `scope index --full` in `dir`.
fn sc_index_full(dir: &Path) -> assert_cmd::assert::Assert {
    Command::cargo_bin("scope")
        .unwrap()
        .args(["index", "--full"])
        .current_dir(dir)
        .assert()
}

/// Index the Go fixture and open the resulting graph.db.
fn indexed_go_fixture_db() -> (rusqlite::Connection, TempDir) {
    let dir = setup_go_fixture();

    sc_init(dir.path()).success();
    sc_index_full(dir.path()).success();

    let db_path = dir.path().join(".scope").join("graph.db");
    let conn = rusqlite::Connection::open(&db_path).unwrap();
    (conn, dir)
}

/// Helper to check if a symbol exists with a given name and kind.
fn symbol_exists(conn: &rusqlite::Connection, name: &str, kind: &str) -> bool {
    let count: i64 = conn
        .query_row(
            "SELECT COUNT(*) FROM symbols WHERE name = ?1 AND kind = ?2",
            rusqlite::params![name, kind],
            |row| row.get(0),
        )
        .unwrap();
    count > 0
}

/// Helper to get metadata JSON for a symbol by name.
fn get_metadata(conn: &rusqlite::Connection, name: &str) -> String {
    conn.query_row(
        "SELECT metadata FROM symbols WHERE name = ?1 LIMIT 1",
        rusqlite::params![name],
        |row| row.get(0),
    )
    .unwrap()
}

// ---------------------------------------------------------------------------
// Tests -- scope init detects Go
// ---------------------------------------------------------------------------

#[test]
fn test_init_detects_go_from_go_mod() {
    let dir = TempDir::new().unwrap();
    std::fs::write(
        dir.path().join("go.mod"),
        "module example.com/test\n\ngo 1.21\n",
    )
    .unwrap();

    sc_init(dir.path()).success().stdout(contains("Go"));
}

// ---------------------------------------------------------------------------
// Tests -- scope index on Go fixture
// ---------------------------------------------------------------------------

#[test]
fn test_index_full_on_go_fixture() {
    let dir = setup_go_fixture();

    sc_init(dir.path()).success();
    sc_index_full(dir.path())
        .success()
        .stderr(contains("files"))
        .stderr(contains("symbols"));

    let graph_db = dir.path().join(".scope").join("graph.db");
    assert!(graph_db.exists(), "graph.db should exist after indexing");
    assert!(
        graph_db.metadata().unwrap().len() > 0,
        "graph.db should not be empty"
    );
}

// ---------------------------------------------------------------------------
// Tests -- symbol detection (struct, interface, function, method, const)
// ---------------------------------------------------------------------------

#[test]
fn test_index_detects_go_structs() {
    let (conn, _dir) = indexed_go_fixture_db();

    assert!(
        symbol_exists(&conn, "PaymentService", "struct"),
        "PaymentService struct should be indexed"
    );
    assert!(
        symbol_exists(&conn, "PaymentResult", "struct"),
        "PaymentResult struct should be indexed"
    );
    assert!(
        symbol_exists(&conn, "CardDetails", "struct"),
        "CardDetails struct should be indexed"
    );
    assert!(
        symbol_exists(&conn, "Logger", "struct"),
        "Logger struct should be indexed"
    );
}

#[test]
fn test_index_detects_go_interfaces() {
    let (conn, _dir) = indexed_go_fixture_db();

    assert!(
        symbol_exists(&conn, "Processor", "struct"),
        "Processor interface should be indexed (kind=struct from infer_symbol_kind, refined via metadata)"
    );

    // Verify metadata marks it as an interface
    let metadata = get_metadata(&conn, "Processor");
    assert!(
        metadata.contains("\"type_kind\":\"interface\""),
        "Processor should have type_kind=interface in metadata; got: {metadata}"
    );
}

#[test]
fn test_index_detects_go_functions() {
    let (conn, _dir) = indexed_go_fixture_db();

    assert!(
        symbol_exists(&conn, "main", "function"),
        "main function should be indexed"
    );
    assert!(
        symbol_exists(&conn, "NewPaymentService", "function"),
        "NewPaymentService function should be indexed"
    );
    assert!(
        symbol_exists(&conn, "NewLogger", "function"),
        "NewLogger function should be indexed"
    );
    assert!(
        symbol_exists(&conn, "validateCard", "function"),
        "validateCard (unexported) function should be indexed"
    );
    assert!(
        symbol_exists(&conn, "calculateFee", "function"),
        "calculateFee (unexported) function should be indexed"
    );
    assert!(
        symbol_exists(&conn, "formatMessage", "function"),
        "formatMessage (unexported) function should be indexed"
    );
}

#[test]
fn test_index_detects_go_methods() {
    let (conn, _dir) = indexed_go_fixture_db();

    assert!(
        symbol_exists(&conn, "ProcessPayment", "method"),
        "ProcessPayment method should be indexed"
    );
    assert!(
        symbol_exists(&conn, "Refund", "method"),
        "Refund method should be indexed"
    );
    assert!(
        symbol_exists(&conn, "SetCurrency", "method"),
        "SetCurrency method should be indexed"
    );
    assert!(
        symbol_exists(&conn, "Info", "method"),
        "Info method should be indexed"
    );
    assert!(
        symbol_exists(&conn, "Error", "method"),
        "Error method should be indexed"
    );
}

#[test]
fn test_index_detects_go_constants() {
    let (conn, _dir) = indexed_go_fixture_db();

    assert!(
        symbol_exists(&conn, "MaxConnections", "const"),
        "MaxConnections const should be indexed"
    );
    assert!(
        symbol_exists(&conn, "DefaultCurrency", "const"),
        "DefaultCurrency const should be indexed"
    );
}

// ---------------------------------------------------------------------------
// Tests -- edge detection (imports, calls, extends)
// ---------------------------------------------------------------------------

#[test]
fn test_index_detects_go_edges() {
    let (conn, _dir) = indexed_go_fixture_db();

    let total: i64 = conn
        .query_row("SELECT COUNT(*) FROM edges", [], |row| row.get(0))
        .unwrap();

    assert!(
        total > 0,
        "edge count should be > 0 after indexing Go fixture; got {total}"
    );

    let edge_kind_exists = |kind: &str| -> bool {
        let count: i64 = conn
            .query_row(
                "SELECT COUNT(*) FROM edges WHERE kind = ?1",
                rusqlite::params![kind],
                |row| row.get(0),
            )
            .unwrap();
        count > 0
    };

    assert!(
        edge_kind_exists("imports"),
        "Go fixture should have 'imports' edges"
    );
    assert!(
        edge_kind_exists("calls"),
        "Go fixture should have 'calls' edges"
    );
    assert!(
        edge_kind_exists("extends"),
        "Go fixture should have 'extends' edges (PaymentService embeds Logger)"
    );
}

// ---------------------------------------------------------------------------
// Tests -- metadata: exported status
// ---------------------------------------------------------------------------

#[test]
fn test_index_go_exported_metadata() {
    let (conn, _dir) = indexed_go_fixture_db();

    // Exported symbol (starts with uppercase)
    let meta = get_metadata(&conn, "ProcessPayment");
    assert!(
        meta.contains("\"exported\":true"),
        "ProcessPayment should be exported; got: {meta}"
    );

    // Unexported symbol (starts with lowercase)
    let meta = get_metadata(&conn, "validateCard");
    assert!(
        meta.contains("\"exported\":false"),
        "validateCard should not be exported; got: {meta}"
    );
}

// ---------------------------------------------------------------------------
// Tests -- metadata: method receiver
// ---------------------------------------------------------------------------

#[test]
fn test_index_go_pointer_receiver_metadata() {
    let (conn, _dir) = indexed_go_fixture_db();

    // ProcessPayment has pointer receiver (*PaymentService)
    let meta = get_metadata(&conn, "ProcessPayment");
    assert!(
        meta.contains("\"receiver\":\"PaymentService\""),
        "ProcessPayment should have receiver=PaymentService; got: {meta}"
    );
    assert!(
        meta.contains("\"is_pointer_receiver\":true"),
        "ProcessPayment should have is_pointer_receiver=true; got: {meta}"
    );
}

#[test]
fn test_index_go_value_receiver_metadata() {
    let (conn, _dir) = indexed_go_fixture_db();

    // SetCurrency has value receiver (PaymentService, not *PaymentService)
    let meta = get_metadata(&conn, "SetCurrency");
    assert!(
        meta.contains("\"receiver\":\"PaymentService\""),
        "SetCurrency should have receiver=PaymentService; got: {meta}"
    );
    assert!(
        meta.contains("\"is_pointer_receiver\":false"),
        "SetCurrency should have is_pointer_receiver=false; got: {meta}"
    );
}

// ---------------------------------------------------------------------------
// Tests -- embedded struct method call edge capture (G13 regression)
// ---------------------------------------------------------------------------

#[test]
fn test_go_embedded_struct_method_call_creates_edge() {
    let (conn, _dir) = indexed_go_fixture_db();

    // PaymentService embeds utils.Logger. In ProcessPayment, `s.Info(...)` calls
    // Logger.Info via the embedding. The selector pattern captures this as
    // to_id = "s.Info" with kind = "calls".
    let count: i64 = conn
        .query_row(
            "SELECT COUNT(*) FROM edges WHERE kind = 'calls' AND to_id = 's.Info'",
            [],
            |row| row.get(0),
        )
        .unwrap();

    assert!(
        count > 0,
        "s.Info() call on embedded Logger should produce a calls edge; got count={count}"
    );
}

// ---------------------------------------------------------------------------
// Tests -- Go symbol count is reasonable
// ---------------------------------------------------------------------------

#[test]
fn test_index_go_symbol_count_is_reasonable() {
    let (conn, _dir) = indexed_go_fixture_db();

    let total: i64 = conn
        .query_row("SELECT COUNT(*) FROM symbols", [], |row| row.get(0))
        .unwrap();

    // We expect at least ~20 symbols from the fixture:
    // structs: PaymentService, PaymentResult, CardDetails, Logger
    // interfaces: Processor (stored as struct, refined via metadata)
    // type alias: Currency (stored as struct, refined via metadata)
    // functions: main, NewPaymentService, NewLogger, validateCard, calculateFee, formatMessage
    // methods: ProcessPayment, Refund, SetCurrency, Info, Error, Debug
    // consts: MaxConnections, DefaultCurrency
    assert!(
        total >= 18,
        "expected at least 18 symbols from Go fixture; got {total}"
    );
}

// ---------------------------------------------------------------------------
// Tests -- scope sketch on Go symbols
// ---------------------------------------------------------------------------

#[test]
fn test_sketch_go_struct() {
    let dir = setup_go_fixture();
    sc_init(dir.path()).success();
    sc_index_full(dir.path()).success();

    Command::cargo_bin("scope")
        .unwrap()
        .args(["sketch", "PaymentService"])
        .current_dir(dir.path())
        .assert()
        .success()
        .stdout(contains("PaymentService"));
}

#[test]
fn test_sketch_go_struct_json() {
    let dir = setup_go_fixture();
    sc_init(dir.path()).success();
    sc_index_full(dir.path()).success();

    let output = Command::cargo_bin("scope")
        .unwrap()
        .args(["sketch", "PaymentService", "--json"])
        .current_dir(dir.path())
        .output()
        .unwrap();

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

    let json: serde_json::Value =
        serde_json::from_slice(&output.stdout).expect("Output should be valid JSON");

    assert_eq!(json["command"], "sketch");
}

#[test]
fn test_sketch_go_method_shows_receiver() {
    let dir = setup_go_fixture();
    sc_init(dir.path()).success();
    sc_index_full(dir.path()).success();

    // ProcessPayment has a *PaymentService pointer receiver — sketch the method directly
    let output = Command::cargo_bin("scope")
        .unwrap()
        .args(["sketch", "ProcessPayment"])
        .current_dir(dir.path())
        .output()
        .unwrap();

    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("(p *PaymentService)"),
        "Sketch should show receiver prefix on ProcessPayment. Got:\n{stdout}"
    );
}

// ---------------------------------------------------------------------------
// Tests -- scope refs on Go symbols
// ---------------------------------------------------------------------------

#[test]
fn test_refs_finds_go_callers() {
    let dir = setup_go_fixture();
    sc_init(dir.path()).success();
    sc_index_full(dir.path()).success();

    // validateCard is called from ProcessPayment
    Command::cargo_bin("scope")
        .unwrap()
        .args(["refs", "validateCard"])
        .current_dir(dir.path())
        .assert()
        .success();
}