flowscope-cli 0.6.0

Command-line interface for FlowScope SQL lineage analyzer
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

//! CLI integration tests for templating functionality.

use std::process::Command;
use tempfile::tempdir;

#[test]
fn template_dbt_ref_macro() {
    let dir = tempdir().expect("temp dir");
    let sql_path = dir.path().join("model.sql");

    std::fs::write(&sql_path, "SELECT * FROM {{ ref('users') }}").expect("write sql");

    let output = Command::new(env!("CARGO_BIN_EXE_flowscope"))
        .args([
            "--template",
            "dbt",
            "-f",
            "json",
            sql_path.to_str().expect("sql path"),
        ])
        .output()
        .expect("run CLI");

    assert!(output.status.success(), "CLI should succeed");
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains(r#""label":"users""#) || stdout.contains(r#""label": "users""#),
        "Should detect 'users' table from ref(): {stdout}"
    );
}

#[test]
fn template_dbt_source_macro() {
    let dir = tempdir().expect("temp dir");
    let sql_path = dir.path().join("model.sql");

    std::fs::write(&sql_path, "SELECT * FROM {{ source('raw', 'events') }}").expect("write sql");

    let output = Command::new(env!("CARGO_BIN_EXE_flowscope"))
        .args([
            "--template",
            "dbt",
            "-f",
            "json",
            sql_path.to_str().expect("sql path"),
        ])
        .output()
        .expect("run CLI");

    assert!(output.status.success(), "CLI should succeed");
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("raw.events"),
        "Should detect 'raw.events' table from source(): {stdout}"
    );
}

#[test]
fn template_jinja_with_variable() {
    let dir = tempdir().expect("temp dir");
    let sql_path = dir.path().join("query.sql");

    std::fs::write(&sql_path, "SELECT * FROM {{ table_name }}").expect("write sql");

    let output = Command::new(env!("CARGO_BIN_EXE_flowscope"))
        .args([
            "--template",
            "jinja",
            "--template-var",
            "table_name=orders",
            "-f",
            "json",
            sql_path.to_str().expect("sql path"),
        ])
        .output()
        .expect("run CLI");

    assert!(output.status.success(), "CLI should succeed");
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains(r#""label":"orders""#) || stdout.contains(r#""label": "orders""#),
        "Should detect 'orders' table from template var: {stdout}"
    );
}

#[test]
fn template_jinja_undefined_var_reports_error() {
    let dir = tempdir().expect("temp dir");
    let sql_path = dir.path().join("query.sql");

    std::fs::write(&sql_path, "SELECT * FROM {{ undefined_table }}").expect("write sql");

    let output = Command::new(env!("CARGO_BIN_EXE_flowscope"))
        .args([
            "--template",
            "jinja",
            "-f",
            "json",
            sql_path.to_str().expect("sql path"),
        ])
        .output()
        .expect("run CLI");

    // Should exit with error code 1 (has_errors)
    assert_eq!(
        output.status.code(),
        Some(1),
        "Should report template error"
    );
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("TEMPLATE_ERROR"),
        "Should report TEMPLATE_ERROR: {stdout}"
    );
}

#[test]
fn template_dbt_complex_model() {
    let dir = tempdir().expect("temp dir");
    let sql_path = dir.path().join("model.sql");

    std::fs::write(
        &sql_path,
        r#"{{ config(materialized='table') }}

WITH stg AS (
    SELECT * FROM {{ ref('stg_orders') }}
)
SELECT id, amount FROM stg"#,
    )
    .expect("write sql");

    let output = Command::new(env!("CARGO_BIN_EXE_flowscope"))
        .args([
            "--template",
            "dbt",
            "-f",
            "json",
            sql_path.to_str().expect("sql path"),
        ])
        .output()
        .expect("run CLI");

    assert!(output.status.success(), "CLI should succeed");
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains("stg_orders"),
        "Should detect 'stg_orders' from ref(): {stdout}"
    );
}