pgmt 0.5.0

PostgreSQL migration tool that keeps your schema files as the source of truth
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

//! SQL rendering for grant operations

use crate::catalog::id::DbObjectId;
use crate::diff::operations::GrantOperation;
use crate::render::{RenderedSql, SqlRenderer};

impl SqlRenderer for GrantOperation {
    fn to_sql(&self) -> Vec<RenderedSql> {
        match self {
            GrantOperation::Grant { grant } => {
                vec![RenderedSql::new(
                    crate::render::sql::render_grant_statement(grant),
                )]
            }
            GrantOperation::Revoke { grant } => {
                vec![RenderedSql::new(
                    crate::render::sql::render_revoke_statement(grant),
                )]
            }
            GrantOperation::GrantColumns(cg) => {
                vec![RenderedSql::new(
                    crate::render::sql::render_column_grant_statement(cg),
                )]
            }
            GrantOperation::RevokeColumns(cg) => {
                vec![RenderedSql::new(
                    crate::render::sql::render_column_revoke_statement(cg),
                )]
            }
        }
    }

    fn db_object_id(&self) -> DbObjectId {
        match self {
            GrantOperation::Grant { grant } => DbObjectId::Grant { id: grant.id() },
            GrantOperation::Revoke { grant } => DbObjectId::Grant { id: grant.id() },
            GrantOperation::GrantColumns(cg) => DbObjectId::Grant {
                id: cg.rep_id.clone(),
            },
            GrantOperation::RevokeColumns(cg) => DbObjectId::Grant {
                id: cg.rep_id.clone(),
            },
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::catalog::grant::{Grant, GranteeType};
    use crate::catalog::id::DbObjectId;
    use crate::catalog::target::AttrTarget;
    use crate::render::Safety;

    fn create_table_grant() -> Grant {
        Grant {
            grantee: GranteeType::Role("app_user".to_string()),
            target: AttrTarget::object(DbObjectId::Table {
                schema: "public".to_string(),
                name: "users".to_string(),
            }),
            privileges: vec!["SELECT".to_string(), "INSERT".to_string()],
            with_grant_option: false,
            depends_on: vec![],
            object_owner: "admin".to_string(),
            is_default_acl: false,
        }
    }

    #[test]
    fn test_render_grant() {
        let grant = create_table_grant();
        let op = GrantOperation::Grant { grant };
        let rendered = op.to_sql();
        assert_eq!(rendered.len(), 1);
        assert!(rendered[0].sql.contains("GRANT"));
        assert!(rendered[0].sql.contains("SELECT"));
        assert!(rendered[0].sql.contains("INSERT"));
        assert!(rendered[0].sql.contains("app_user"));
    }

    #[test]
    fn test_render_revoke() {
        let grant = create_table_grant();
        let op = GrantOperation::Revoke { grant };
        let rendered = op.to_sql();
        assert_eq!(rendered.len(), 1);
        assert!(rendered[0].sql.contains("REVOKE"));
    }

    #[test]
    fn test_render_grant_to_public() {
        let grant = Grant {
            grantee: GranteeType::Public,
            target: AttrTarget::object(DbObjectId::Function {
                schema: "public".to_string(),
                name: "my_func".to_string(),
                arguments: "integer".to_string(),
            }),
            privileges: vec!["EXECUTE".to_string()],
            with_grant_option: false,
            depends_on: vec![],
            object_owner: "admin".to_string(),
            is_default_acl: false,
        };
        let op = GrantOperation::Grant { grant };
        let rendered = op.to_sql();
        assert!(rendered[0].sql.contains("PUBLIC"));
    }

    #[test]
    fn test_has_destructive_sql() {
        let grant = create_table_grant();
        let grant_op = GrantOperation::Grant {
            grant: grant.clone(),
        };
        let revoke_op = GrantOperation::Revoke { grant };

        // Grants/revokes don't destroy data - permissions can be re-granted
        assert!(
            !grant_op
                .to_sql()
                .iter()
                .any(|s| s.safety == Safety::Destructive)
        );
        assert!(
            !revoke_op
                .to_sql()
                .iter()
                .any(|s| s.safety == Safety::Destructive)
        );
    }

    #[test]
    fn test_db_object_id() {
        let grant = create_table_grant();
        let op = GrantOperation::Grant {
            grant: grant.clone(),
        };
        let expected_id = grant.id();
        assert_eq!(op.db_object_id(), DbObjectId::Grant { id: expected_id });
    }
}