diesel-guard 0.2.0

Catch unsafe PostgreSQL migrations in Diesel before they take down production
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

//! 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);
        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.
#[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);
        assert_eq!(
            violations.len(),
            0,
            "Expected no violations but found {}",
            violations.len()
        );
    }};
}

#[cfg(test)]
pub use test_helpers::*;

#[cfg(test)]
mod test_helpers {
    use sqlparser::ast::Statement;
    use sqlparser::dialect::PostgreSqlDialect;
    use sqlparser::parser::Parser;

    /// Parse a SQL string into a Statement for testing.
    ///
    /// # Panics
    /// Panics if the SQL cannot be parsed or contains no statements.
    pub fn parse_sql(sql: &str) -> Statement {
        let dialect = PostgreSqlDialect {};
        Parser::parse_sql(&dialect, sql)
            .expect("Failed to parse SQL")
            .into_iter()
            .next()
            .expect("No statements found")
    }
}