diesel-guard 0.10.0

Linter for dangerous Postgres migration patterns in Diesel and SQLx. Prevents downtime caused by unsafe schema changes.
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

//! Common test utilities for check modules.
//!
//! This module provides shared helper functions and macros used across all check tests,
//! reducing code duplication and ensuring consistent test setup.

/// Assert that a check detects exactly one violation with the given operation name.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_violation {
    ($check:expr, $sql:expr, $operation:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(
            &stmt,
            &$crate::config::Config::default(),
            &$crate::checks::MigrationContext::default(),
        );
        assert_eq!(violations.len(), 1, "Expected exactly 1 violation");
        assert_eq!(
            violations[0].operation, $operation,
            "Expected operation '{}' but got '{}'",
            $operation, violations[0].operation
        );
    }};
}

/// Assert that a check detects exactly one violation with the given operation name, using explicit config.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_violation_with_config {
    ($check:expr, $sql:expr, $operation:expr, $config:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(&stmt, $config, &$crate::checks::MigrationContext::default());
        assert_eq!(violations.len(), 1, "Expected exactly 1 violation");
        assert_eq!(
            violations[0].operation, $operation,
            "Expected operation '{}' but got '{}'",
            $operation, violations[0].operation
        );
    }};
}

/// Assert that a check detects exactly one violation with the given operation name, using explicit MigrationContext.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_violation_with_context {
    ($check:expr, $sql:expr, $operation:expr, $ctx:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(&stmt, &$crate::config::Config::default(), &$ctx);
        assert_eq!(violations.len(), 1, "Expected exactly 1 violation");
        assert_eq!(
            violations[0].operation, $operation,
            "Expected operation '{}' but got '{}'",
            $operation, violations[0].operation
        );
    }};
}

/// Assert that a check allows (finds no violations in) the given SQL, using explicit MigrationContext.
#[cfg(test)]
#[macro_export]
macro_rules! assert_allows_with_context {
    ($check:expr, $sql:expr, $ctx:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(&stmt, &$crate::config::Config::default(), &$ctx);
        assert_eq!(
            violations.len(),
            0,
            "Expected no violations but found {}",
            violations.len()
        );
    }};
}

/// Assert that a check allows (finds no violations in) the given SQL, using explicit config.
#[cfg(test)]
#[macro_export]
macro_rules! assert_allows_with_config {
    ($check:expr, $sql:expr, $config:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(&stmt, $config, &$crate::checks::MigrationContext::default());
        assert_eq!(
            violations.len(),
            0,
            "Expected no violations but found {}",
            violations.len()
        );
    }};
}

/// Assert that a check allows (finds no violations in) the given SQL.
#[cfg(test)]
#[macro_export]
macro_rules! assert_allows {
    ($check:expr, $sql:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(
            &stmt,
            &$crate::config::Config::default(),
            &$crate::checks::MigrationContext::default(),
        );
        assert_eq!(
            violations.len(),
            0,
            "Expected no violations but found {}",
            violations.len()
        );
    }};
}

/// Assert that a check detects exactly 1 violation with the given operation name,
/// and that the violation's `problem` contains every given substring.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_violation_containing {
    ($check:expr, $sql:expr, $operation:expr, $($substring:expr),+) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(
            &stmt,
            &$crate::config::Config::default(),
            &$crate::checks::MigrationContext::default(),
        );
        assert_eq!(violations.len(), 1, "Expected exactly 1 violation");
        assert_eq!(
            violations[0].operation, $operation,
            "Expected operation '{}' but got '{}'",
            $operation, violations[0].operation
        );
        $(
            assert!(
                violations[0].problem.contains($substring),
                "Expected problem to contain {:?} but got: {}",
                $substring, violations[0].problem
            );
        )+
    }};
}

/// Assert that a check detects exactly N violations, and that for each given substring,
/// at least one violation's `problem` contains it.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_n_violations_any_containing {
    ($check:expr, $sql:expr, $n:expr, $($substring:expr),+) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(
            &stmt,
            &$crate::config::Config::default(),
            &$crate::checks::MigrationContext::default(),
        );
        assert_eq!(violations.len(), $n, "Expected exactly {} violations", $n);
        $(
            assert!(
                violations.iter().any(|v| v.problem.contains($substring)),
                "Expected some violation's problem to contain {:?}",
                $substring
            );
        )+
    }};
}

/// Assert that a check detects exactly N violations all sharing the same operation name.
#[cfg(test)]
#[macro_export]
macro_rules! assert_detects_n_violations {
    ($check:expr, $sql:expr, $n:expr, $operation:expr) => {{
        use $crate::checks::test_utils::parse_sql;
        let stmt = parse_sql($sql);
        let violations = $check.check(
            &stmt,
            &$crate::config::Config::default(),
            &$crate::checks::MigrationContext::default(),
        );
        assert_eq!(violations.len(), $n, "Expected exactly {} violations", $n);
        for v in &violations {
            assert_eq!(
                v.operation, $operation,
                "Expected operation '{}' but got '{}'",
                $operation, v.operation
            );
        }
    }};
}

#[cfg(test)]
pub fn parse_sql(sql: &str) -> crate::checks::pg_helpers::NodeEnum {
    let result = pg_query::parse(sql).expect("Failed to parse SQL");
    result
        .protobuf
        .stmts
        .into_iter()
        .next()
        .expect("No statements found")
        .stmt
        .expect("No stmt node")
        .node
        .expect("No node")
}