sqry-cli 6.0.15

CLI for sqry - semantic code search
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
//! CLI integration tests for Zig relation queries
//!
//! Tests that relation queries work end-to-end through the CLI for Zig:
//! - Callers queries (function calls, method calls)
//! - Callees queries (what a function calls)
//! - Exports queries (pub functions, pub types, pub constants)
//! - Imports queries (@import statements)
//!
//! This validates the Zig relation extraction implementation.

mod common;
use common::sqry_bin;

use assert_cmd::Command;
use predicates::prelude::*;
use tempfile::TempDir;

// ============================================================================
// Exports Queries - pub Functions, Types, Constants
// ============================================================================

#[test]
fn cli_zig_exports_functions_and_types() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const std = @import("std");

pub fn add(a: i32, b: i32) i32 {
    return a + b;
}

fn privateHelper() i32 {
    return 42;
}

pub const Point = struct {
    x: f32,
    y: f32,

    pub fn distance(self: Point) f32 {
        return @sqrt(self.x * self.x + self.y * self.y);
    }
};

const PrivateType = struct {
    value: i32,
};

pub const API_VERSION = "1.0.0";
"#;
    std::fs::write(project.path().join("module.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for exported function
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:add")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("module.zig"));

    // Query for exported type
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:Point")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("module.zig"));

    // Query for exported constant
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:API_VERSION")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("module.zig"));
}

#[test]
fn cli_zig_exports_hide_private() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const std = @import("std");

pub fn publicFunction() i32 {
    return privateHelper();
}

fn privateHelper() i32 {
    return 42;
}

pub const PublicType = struct {
    value: i32,
};

const PrivateType = struct {
    value: i32,
};
"#;
    std::fs::write(project.path().join("visibility.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Public function should be exported
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:publicFunction")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("publicFunction"));

    // Public type should be exported
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:PublicType")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("PublicType"));

    // Private function should NOT be exported
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:privateHelper")
        .arg(project.path())
        .assert()
        .success()
        .stderr(predicate::str::contains("No matches found"));

    // Private type should NOT be exported
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:PrivateType")
        .arg(project.path())
        .assert()
        .success()
        .stderr(predicate::str::contains("No matches found"));
}

#[test]
fn cli_zig_exports_nested_pub_members() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const PrivateContainer = struct {
    pub fn publicMethod() i32 {
        return 42;
    }

    pub const PUBLIC_CONST: i32 = 100;
};

pub const PublicContainer = struct {
    fn privateMethod() i32 {
        return 42;
    }
};
"#;
    std::fs::write(project.path().join("nested.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Private container should NOT be exported, even with pub members inside
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:PrivateContainer")
        .arg(project.path())
        .assert()
        .success()
        .stderr(predicate::str::contains("No matches found"));

    // Public container SHOULD be exported
    Command::new(sqry_bin())
        .arg("query")
        .arg("exports:PublicContainer")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("PublicContainer"));
}

// ============================================================================
// Imports Queries - @import Statements
// ============================================================================

#[test]
fn cli_zig_imports() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const std = @import("std");
const builtin = @import("builtin");

pub fn main() void {
    std.debug.print("Hello, Zig!\n", .{});
}
"#;
    std::fs::write(project.path().join("main.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for std import
    Command::new(sqry_bin())
        .arg("query")
        .arg("imports:std")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("main.zig"));

    // Query for builtin import
    Command::new(sqry_bin())
        .arg("query")
        .arg("imports:builtin")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("main.zig"));
}

// ============================================================================
// Callers Queries - Function Calls
// ============================================================================

#[test]
fn cli_zig_callers_function_calls() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const std = @import("std");

fn validate(x: i32) bool {
    return x > 0;
}

fn process(value: i32) i32 {
    if (validate(value)) {
        return value * 2;
    }
    return 0;
}

fn analyze(num: i32) bool {
    return validate(num);
}
"#;
    std::fs::write(project.path().join("functions.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for callers of validate
    Command::new(sqry_bin())
        .arg("query")
        .arg("callers:validate")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("process"))
        .stdout(predicate::str::contains("analyze"));
}

#[test]
fn cli_zig_callers_method_calls() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const Point = struct {
    x: f32,
    y: f32,

    fn distance(self: Point) f32 {
        return @sqrt(self.x * self.x + self.y * self.y);
    }

    fn normalize(self: *Point) void {
        const d = self.distance();
        if (d > 0) {
            self.x /= d;
            self.y /= d;
        }
    }
};
"#;
    std::fs::write(project.path().join("methods.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for callers of distance
    Command::new(sqry_bin())
        .arg("query")
        .arg("callers:distance")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("normalize"));
}

// ============================================================================
// Callees Queries - What Functions Call
// ============================================================================

#[test]
fn cli_zig_callees_function() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
const std = @import("std");

fn log(message: []const u8) void {
    std.debug.print("{s}\n", .{message});
}

fn warn(message: []const u8) void {
    std.debug.print("WARNING: {s}\n", .{message});
}

fn handleError(error_msg: []const u8) void {
    log("Error occurred");
    warn(error_msg);
}
"#;
    std::fs::write(project.path().join("logger.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for callees of handleError
    Command::new(sqry_bin())
        .arg("query")
        .arg("callees:handleError")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("log"))
        .stdout(predicate::str::contains("warn"));
}

// ============================================================================
// Integration Tests - Complex Scenarios
// ============================================================================

#[test]
fn cli_zig_multi_file_calls() {
    let project = TempDir::new().unwrap();

    let utils_code = r#"
const std = @import("std");

pub fn log(message: []const u8) void {
    std.debug.print("[LOG] {s}\n", .{message});
}

pub fn validate(input: i32) bool {
    return input > 0;
}
"#;
    std::fs::write(project.path().join("utils.zig"), utils_code).unwrap();

    let main_code = r#"
const utils = @import("utils.zig");

pub fn process(data: i32) void {
    utils.log("processing");
    _ = utils.validate(data);
}
"#;
    std::fs::write(project.path().join("main.zig"), main_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for callers of log
    Command::new(sqry_bin())
        .arg("query")
        .arg("callers:log")
        .arg(project.path())
        .assert()
        .success()
        .stdout(predicate::str::contains("process"));
}

// ============================================================================
// Negative Tests
// ============================================================================

#[test]
fn cli_zig_callers_no_results() {
    let project = TempDir::new().unwrap();

    let zig_code = r#"
fn unusedFunction() i32 {
    return 42;
}

pub fn main() void {
    const value: i32 = 10;
    _ = value;
}
"#;
    std::fs::write(project.path().join("unused.zig"), zig_code).unwrap();

    Command::new(sqry_bin())
        .arg("index")
        .arg(project.path())
        .assert()
        .success();

    // Query for callers of unused function - should return no matches
    Command::new(sqry_bin())
        .arg("query")
        .arg("callers:unusedFunction")
        .arg(project.path())
        .assert()
        .success()
        .stderr(predicate::str::contains("No matches found"));
}