squawk-linter 2.60.0

Linter for Postgres migrations & SQL
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

use squawk_syntax::{
    Parse, SourceFile, SyntaxNode,
    ast::{self, AstNode},
};

use crate::{Linter, Rule, Violation};

pub(crate) fn require_table_schema(ctx: &mut Linter, parse: &Parse<SourceFile>) {
    let file = parse.tree();
    for stmt in file.stmts() {
        match stmt {
            ast::Stmt::CreateTable(create_table) => {
                if matches!(create_table.persistence(), Some(ast::Persistence::Temp(_))) {
                    continue;
                }
                check_path(
                    ctx,
                    create_table.table_name().and_then(|table| table.path()),
                );
            }
            ast::Stmt::CreateTableAs(create_table_as) => {
                if matches!(
                    create_table_as.persistence(),
                    Some(ast::Persistence::Temp(_))
                ) {
                    continue;
                }
                check_path(
                    ctx,
                    create_table_as.table_name().and_then(|table| table.path()),
                );
            }
            ast::Stmt::AlterTable(alter_table) => {
                check_path_ref(
                    ctx,
                    alter_table
                        .table_relation_name()
                        .and_then(|relation| relation.table_name_ref())
                        .and_then(|table| table.path_ref()),
                );
            }
            ast::Stmt::DropTable(drop_table) => {
                for table in drop_table.table_name_refs() {
                    check_path_ref(ctx, table.path_ref());
                }
            }
            _ => (),
        }
    }
}

fn check_path(ctx: &mut Linter, path: Option<ast::Path>) {
    if let Some(path) = path
        && path.qualifier().is_none()
    {
        report_missing_schema(ctx, path.syntax());
    }
}

fn check_path_ref(ctx: &mut Linter, path: Option<ast::PathRef>) {
    if let Some(path) = path
        && path.qualifier().is_none()
    {
        report_missing_schema(ctx, path.syntax());
    }
}

fn report_missing_schema(ctx: &mut Linter, node: &SyntaxNode) {
    ctx.report(Violation::for_node(
        Rule::RequireTableSchema,
        "Table name is not schema-qualified. Use schema.table (e.g., public.my_table).".into(),
        node,
    ));
}

#[cfg(test)]
mod test {
    use insta::assert_snapshot;

    use crate::Rule;
    use crate::test_utils::{lint_errors, lint_ok};

    #[test]
    fn create_table_err() {
        let sql = r#"
CREATE TABLE my_table (id int);
"#;
        assert_snapshot!(lint_errors(sql, Rule::RequireTableSchema));
    }

    #[test]
    fn create_table_ok() {
        let sql = r#"
CREATE TABLE public.my_table (id int);
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }

    #[test]
    fn alter_table_err() {
        let sql = r#"
ALTER TABLE my_table ADD COLUMN name text;
"#;
        assert_snapshot!(lint_errors(sql, Rule::RequireTableSchema));
    }

    #[test]
    fn alter_table_ok() {
        let sql = r#"
ALTER TABLE public.my_table ADD COLUMN name text;
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }

    #[test]
    fn drop_table_err() {
        let sql = r#"
DROP TABLE my_table;
"#;
        assert_snapshot!(lint_errors(sql, Rule::RequireTableSchema));
    }

    #[test]
    fn drop_table_ok() {
        let sql = r#"
DROP TABLE public.my_table;
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }

    #[test]
    fn create_table_as_err() {
        let sql = r#"
CREATE TABLE my_table AS SELECT 1;
"#;
        assert_snapshot!(lint_errors(sql, Rule::RequireTableSchema));
    }

    #[test]
    fn create_table_as_ok() {
        let sql = r#"
CREATE TABLE public.my_table AS SELECT 1;
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }

    #[test]
    fn create_temp_table_ok() {
        let sql = r#"
CREATE TEMP TABLE temp_mapping_table (id int4) ON COMMIT DROP;
CREATE TEMPORARY TABLE other_temp (id int4);
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }

    #[test]
    fn create_temp_table_as_ok() {
        let sql = r#"
CREATE TEMP TABLE temp_mapping_table AS SELECT 1;
"#;
        lint_ok(sql, Rule::RequireTableSchema);
    }
}