sqry-lang-shell 18.0.2

Shell script language plugin for sqry
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
//! Graph builder tests for the Shell language plugin.
//!
//! Covers:
//! - Function node extraction (POSIX and Bash syntax)
//! - Call edge detection
//! - Source/. import edges
//! - Error handling for malformed input

use sqry_core::graph::unified::StagingGraph;
use sqry_core::graph::unified::build::staging::StagingOp;
use sqry_core::graph::unified::edge::EdgeKind;
use sqry_core::graph::{GraphBuilder, Language};
use sqry_lang_shell::ShellGraphBuilder;
use std::path::Path;

fn parse_shell(source: &str) -> tree_sitter::Tree {
    let mut parser = tree_sitter::Parser::new();
    parser
        .set_language(&tree_sitter_bash::LANGUAGE.into())
        .expect("failed to set Bash language");
    parser
        .parse(source.as_bytes(), None)
        .expect("failed to parse shell code")
}

fn count_edges_of_kind(staging: &StagingGraph, kind_check: impl Fn(&EdgeKind) -> bool) -> usize {
    staging
        .operations()
        .iter()
        .filter(|op| {
            if let StagingOp::AddEdge { kind, .. } = op {
                kind_check(kind)
            } else {
                false
            }
        })
        .count()
}

fn count_call_edges(staging: &StagingGraph) -> usize {
    count_edges_of_kind(staging, |k| matches!(k, EdgeKind::Calls { .. }))
}

fn count_import_edges(staging: &StagingGraph) -> usize {
    count_edges_of_kind(staging, |k| matches!(k, EdgeKind::Imports { .. }))
}

fn has_interned_string_containing(staging: &StagingGraph, pattern: &str) -> bool {
    staging.operations().iter().any(|op| {
        if let StagingOp::InternString { value, .. } = op {
            value.contains(pattern)
        } else {
            false
        }
    })
}

// ==================== Basic Node Extraction ====================

#[test]
fn test_posix_function_extraction() {
    let source = r#"
#!/bin/sh

greet() {
    echo "Hello, $1"
}

add() {
    echo $(($1 + $2))
}

greet "World"
add 3 4
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(
            &tree,
            source.as_bytes(),
            Path::new("script.sh"),
            &mut staging,
        )
        .unwrap();

    let stats = staging.stats();
    assert!(
        stats.nodes_staged >= 2,
        "Expected at least 2 function nodes, got {}",
        stats.nodes_staged
    );
    assert!(
        has_interned_string_containing(&staging, "greet"),
        "Expected 'greet' function"
    );
}

#[test]
fn test_bash_function_keyword() {
    let source = r#"
#!/bin/bash

function setup() {
    mkdir -p /tmp/test
    echo "Setup done"
}

function teardown() {
    rm -rf /tmp/test
    echo "Cleanup done"
}
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), Path::new("test.sh"), &mut staging)
        .unwrap();

    let stats = staging.stats();
    assert!(
        stats.nodes_staged >= 2,
        "Expected at least 2 function nodes, got {}",
        stats.nodes_staged
    );
    assert!(
        has_interned_string_containing(&staging, "setup"),
        "Expected 'setup' function"
    );
}

#[test]
fn test_mixed_function_styles() {
    let source = r#"
#!/bin/bash

# POSIX style
posix_func() {
    echo "posix"
}

# Bash style
function bash_func {
    echo "bash"
}

posix_func
bash_func
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(
            &tree,
            source.as_bytes(),
            Path::new("mixed.sh"),
            &mut staging,
        )
        .unwrap();

    let stats = staging.stats();
    assert!(
        stats.nodes_staged >= 2,
        "Expected at least 2 function nodes, got {}",
        stats.nodes_staged
    );
}

// ==================== Call Edge Detection ====================

#[test]
fn test_call_edge_detection() {
    let source = r#"
#!/bin/bash

helper() {
    echo "I am helper"
}

main() {
    helper
    echo "Done"
}

main
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), Path::new("main.sh"), &mut staging)
        .unwrap();

    let call_count = count_call_edges(&staging);
    assert!(
        call_count >= 1,
        "Expected at least 1 call edge, got {call_count}"
    );
}

#[test]
fn test_nested_function_calls() {
    let source = r#"
#!/bin/bash

level3() {
    echo "level 3"
}

level2() {
    level3
    echo "level 2"
}

level1() {
    level2
    echo "level 1"
}
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(
            &tree,
            source.as_bytes(),
            Path::new("levels.sh"),
            &mut staging,
        )
        .unwrap();

    let call_count = count_call_edges(&staging);
    assert!(
        call_count >= 2,
        "Expected at least 2 call edges, got {call_count}"
    );
}

// ==================== Source/. Import Edges ====================

#[test]
fn test_source_import() {
    let source = r#"
#!/bin/bash

source ./utils.sh
source /etc/environment

main() {
    log_message "Starting"
}
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), Path::new("main.sh"), &mut staging)
        .unwrap();

    let import_count = count_import_edges(&staging);
    assert!(
        import_count >= 1,
        "Expected at least 1 import edge for source, got {import_count}"
    );
}

#[test]
fn test_dot_source_import() {
    let source = r"
#!/bin/sh

. ./lib/helpers.sh
. ./lib/config.sh

run() {
    init_config
    do_work
}
";
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(&tree, source.as_bytes(), Path::new("run.sh"), &mut staging)
        .unwrap();

    let import_count = count_import_edges(&staging);
    assert!(
        import_count >= 1,
        "Expected at least 1 import edge for . sourcing, got {import_count}"
    );
}

// ==================== Builder Properties ====================

#[test]
fn test_builder_language() {
    let builder = ShellGraphBuilder::default();
    assert_eq!(builder.language(), Language::Shell);
}

#[test]
fn test_builder_is_send_sync() {
    fn assert_send_sync<T: Send + Sync>() {}
    assert_send_sync::<ShellGraphBuilder>();
}

// ==================== Error Handling ====================

#[test]
fn test_empty_file() {
    let source = "";
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    let result = builder.build_graph(
        &tree,
        source.as_bytes(),
        Path::new("empty.sh"),
        &mut staging,
    );
    assert!(result.is_ok(), "Empty shell file should succeed");
}

#[test]
fn test_malformed_shell() {
    // Incomplete shell - tree-sitter is error-tolerant
    let source = r"
function broken(
"; // incomplete
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    // Should not panic
    let result = builder.build_graph(
        &tree,
        source.as_bytes(),
        Path::new("broken.sh"),
        &mut staging,
    );
    let _ = result;
}

#[test]
fn test_comments_only() {
    let source = r"
# This is a comment
# Another comment
## Section header
";
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    let result = builder.build_graph(
        &tree,
        source.as_bytes(),
        Path::new("comments.sh"),
        &mut staging,
    );
    assert!(result.is_ok(), "Comments-only shell file should succeed");
}

#[test]
fn test_script_without_functions() {
    let source = r#"
#!/bin/bash

set -euo pipefail

echo "Starting script"
mkdir -p /tmp/output
cp /etc/hosts /tmp/output/
echo "Done"
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    let result = builder.build_graph(
        &tree,
        source.as_bytes(),
        Path::new("simple.sh"),
        &mut staging,
    );
    assert!(
        result.is_ok(),
        "Script without functions should succeed: {:?}",
        result.err()
    );
}

#[test]
fn test_complete_script() {
    let source = r#"
#!/bin/bash

source ./config.sh

log() {
    echo "[$(date)] $1"
}

check_deps() {
    command -v curl >/dev/null 2>&1 || { echo "curl required"; exit 1; }
    command -v jq >/dev/null 2>&1 || { echo "jq required"; exit 1; }
}

download() {
    local url="$1"
    local dest="$2"
    curl -fsSL "$url" -o "$dest"
}

main() {
    check_deps
    log "Starting download"
    download "https://example.com/file" "/tmp/file"
    log "Done"
}

main "$@"
"#;
    let tree = parse_shell(source);
    let mut staging = StagingGraph::new();
    let builder = ShellGraphBuilder::default();

    builder
        .build_graph(
            &tree,
            source.as_bytes(),
            Path::new("deploy.sh"),
            &mut staging,
        )
        .unwrap();

    let stats = staging.stats();
    assert!(
        stats.nodes_staged >= 3,
        "Expected at least 3 function nodes, got {}",
        stats.nodes_staged
    );
}