safe-migrate 0.8.0

Check PostgreSQL migrations against a synchronized database baseline
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
mod common;

mod state_machine_guards_tests {
    use crate::common::*;
    use safe_migrate::_internal::analysis::state::AnalysisState;
    use safe_migrate::_internal::model::relation::{
        Persistence, RelationKind, RelationOverlay, RelationState,
    };

    #[test]
    fn test_skip_guard_create_table() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze("CREATE TABLE t(id INT);", &mut state)
            .unwrap();
        engine
            .analyze("CREATE TABLE IF NOT EXISTS t(new_col INT);", &mut state)
            .unwrap();

        let rel = state.get_relation(&object_id("public", "t")).unwrap();
        if let RelationOverlay::Present(r) = rel {
            assert!(r.has_column("id"));
            assert!(!r.has_column("new_col"));
        } else {
            panic!("relation should be present");
        }
    }

    #[test]
    fn test_reversibility_type_widen() {
        let engine = setup_engine();
        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        let tid = object_id("public", "t");
        let mut rel = RelationState::new(
            tid.clone(),
            object_id("public", "postgres"),
            0,
            Some(10),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        rel.apply_column_action(
            &safe_migrate::_internal::model::relation::ColumnAction::Add {
                name: "val".to_string(),
                data_type: Some("int".to_string()),
                not_null: false,
                default: None,
            },
        );
        cache.insert_baseline(tid, rel);
        let mut state = AnalysisState::new(cache);

        // Run analysis
        let v = engine
            .analyze("ALTER TABLE t ALTER COLUMN val TYPE bigint;", &mut state)
            .unwrap();

        // Ensure that ReversibilityRule did not flag this as irreversible
        // We are checking for specific violations and widening SHOULD NOT trigger "irreversible-migration"
        // If TypeChangeRewriteRule flags it, that's fine.
        assert!(
            v.iter()
                .all(|viol| viol.rule_id != "irreversible-migration"),
            "ReversibilityRule flagged widening as irreversible: {:?}",
            v.iter()
                .filter(|viol| viol.rule_id == "irreversible-migration")
                .collect::<Vec<_>>()
        );
    }

    #[test]
    fn test_skip_guard_drop_column() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze("CREATE TABLE t(id INT);", &mut state)
            .unwrap();
        assert!(
            engine
                .analyze("ALTER TABLE t DROP COLUMN IF EXISTS missing;", &mut state)
                .is_ok()
        );
    }

    #[test]
    fn test_skip_guard_drop_missing_objects() {
        let engine = setup_engine();
        let mut state = setup_state();

        assert!(
            engine
                .analyze("DROP TABLE IF EXISTS missing;", &mut state)
                .is_ok()
        );
        assert!(
            engine
                .analyze("DROP VIEW IF EXISTS missing;", &mut state)
                .is_ok()
        );
        assert!(
            engine
                .analyze("DROP MATERIALIZED VIEW IF EXISTS missing;", &mut state)
                .is_ok()
        );
        assert!(
            engine
                .analyze("DROP INDEX IF EXISTS missing;", &mut state)
                .is_ok()
        );
        assert!(
            engine
                .analyze("DROP SEQUENCE IF EXISTS missing;", &mut state)
                .is_ok()
        );
        assert!(
            engine
                .analyze("DROP DOMAIN IF EXISTS missing;", &mut state)
                .is_ok()
        );
    }

    #[test]
    fn schema_neutral_application_name_keeps_exact_confidence() {
        let engine = setup_engine();
        let mut state = setup_state();

        let violations = engine
            .analyze("SET application_name = 'migration-check';", &mut state)
            .unwrap();

        assert!(violations.is_empty());
        assert_eq!(
            state.local.confidence,
            safe_migrate::_internal::analysis::state::Confidence::Exact
        );
    }

    #[test]
    fn unknown_scoped_target_in_multi_drop_preserves_known_targets() {
        let engine = setup_engine();
        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        cache.metadata.schemas = Some(vec!["app".to_string()]);
        let table_id = object_id("app", "known_table");
        let view_id = object_id("app", "known_view");
        let materialized_view_id = object_id("app", "known_materialized_view");
        cache.insert_baseline(
            table_id.clone(),
            RelationState::new(
                table_id.clone(),
                object_id("", "postgres"),
                0,
                None,
                RelationKind::Table,
                Persistence::Permanent,
                0,
            ),
        );
        cache.insert_baseline(
            view_id.clone(),
            RelationState::new(
                view_id.clone(),
                object_id("", "postgres"),
                0,
                None,
                RelationKind::View,
                Persistence::Permanent,
                0,
            ),
        );
        cache.insert_baseline(
            materialized_view_id.clone(),
            RelationState::new(
                materialized_view_id.clone(),
                object_id("", "postgres"),
                0,
                None,
                RelationKind::MaterializedView,
                Persistence::Permanent,
                0,
            ),
        );
        let mut state = AnalysisState::new(cache);

        engine
            .analyze(
                "DROP TABLE IF EXISTS app.known_table, tenant.unknown_table;",
                &mut state,
            )
            .unwrap();
        engine
            .analyze("DROP VIEW app.known_view, tenant.unknown_view;", &mut state)
            .unwrap();
        engine
            .analyze(
                "DROP MATERIALIZED VIEW app.known_materialized_view, tenant.unknown_materialized_view;",
                &mut state,
            )
            .unwrap();

        assert!(state.relation_is_present(&table_id));
        assert!(state.relation_is_present(&view_id));
        assert!(state.relation_is_present(&materialized_view_id));
        assert_eq!(
            state.local.confidence,
            safe_migrate::_internal::analysis::state::Confidence::Tainted
        );
    }

    #[test]
    fn alter_view_rename_column_taints_instead_of_becoming_an_exact_noop() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze(
                "CREATE TABLE source (id int); CREATE VIEW v AS SELECT id FROM source;",
                &mut state,
            )
            .expect("view setup should analyze");
        engine
            .analyze("ALTER VIEW v RENAME COLUMN id TO renamed_id;", &mut state)
            .expect("typed but unsupported view alteration should analyze");

        assert_eq!(
            state.local.confidence,
            safe_migrate::_internal::analysis::state::Confidence::Tainted
        );
    }

    #[test]
    fn all_tables_in_schema_grants_are_tainted_when_relation_scope_is_incomplete() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze(
                "CREATE SCHEMA app; CREATE TABLE app.entries (id int); GRANT SELECT ON ALL TABLES IN SCHEMA app TO reader;",
                &mut state,
            )
            .expect("schema-wide grant should analyze");

        assert_eq!(
            state.local.confidence,
            safe_migrate::_internal::analysis::state::Confidence::Tainted
        );
    }

    #[test]
    fn schema_cascade_skips_already_dropped_sequences_without_panicking() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze(
                "CREATE SCHEMA app; CREATE SEQUENCE app.counter; DROP SEQUENCE app.counter; DROP SCHEMA app CASCADE;",
                &mut state,
            )
            .expect("schema cascade after sequence drop should analyze");

        assert!(matches!(
            state.local.schemas.get("app"),
            Some(safe_migrate::_internal::model::schema::SchemaOverlay::Dropped)
        ));
    }

    #[test]
    fn conflicting_cascade_does_not_report_dependencies_that_were_not_dropped() {
        let engine = setup_engine();
        let mut state = setup_state();
        engine
            .analyze(
                "CREATE TABLE parent (id int PRIMARY KEY); CREATE TABLE child (id int REFERENCES parent(id));",
                &mut state,
            )
            .expect("dependency setup should analyze");

        let findings = engine
            .analyze("DROP TABLE parent, missing CASCADE;", &mut state)
            .expect("conflicting cascade should analyze");

        assert!(
            findings
                .iter()
                .any(|finding| finding.rule_id == "chain-conflict")
        );
        assert!(
            findings
                .iter()
                .all(|finding| finding.rule_id != "destructive-cascade")
        );
    }

    #[test]
    fn missing_unguarded_drop_aborts_following_transaction_statements() {
        let engine = setup_engine();
        let mut state = setup_state();

        let violations = engine
            .analyze(
                "BEGIN; DROP VIEW missing_view; CREATE TABLE should_not_exist(id int); COMMIT;",
                &mut state,
            )
            .unwrap();

        assert!(
            violations
                .iter()
                .any(|violation| violation.rule_id == "chain-conflict")
        );
        assert!(!state.relation_is_present(&object_id("public", "should_not_exist")));
    }

    #[test]
    fn guarded_drop_still_rejects_the_wrong_relation_kind() {
        let engine = setup_engine();
        let mut state = setup_state();
        engine
            .analyze("CREATE TABLE t(id int);", &mut state)
            .unwrap();

        let violations = engine
            .analyze("DROP VIEW IF EXISTS t;", &mut state)
            .unwrap();

        assert!(state.relation_is_present(&object_id("public", "t")));
        assert!(
            violations
                .iter()
                .any(|violation| violation.rule_id == "chain-conflict")
        );
    }

    #[test]
    fn test_skip_guard_create_index() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine
            .analyze("CREATE TABLE t(id int);", &mut state)
            .unwrap();
        engine
            .analyze("CREATE INDEX idx ON t(id);", &mut state)
            .unwrap();

        let edge_count = state
            .local
            .graph
            .edges()
            .iter()
            .filter(|e| {
                matches!(
                    e.kind,
                    safe_migrate::_internal::analysis::graph::DependencyKind::IndexOnRelation { .. }
                )
            })
            .count();
        engine
            .analyze("CREATE INDEX IF NOT EXISTS idx ON t(id);", &mut state)
            .unwrap();

        assert_eq!(
            state
                .local
                .graph
                .edges()
                .iter()
                .filter(|e| matches!(
                    e.kind,
                    safe_migrate::_internal::analysis::graph::DependencyKind::IndexOnRelation { .. }
                ))
                .count(),
            edge_count
        );
    }

    #[test]
    fn test_skip_guard_create_sequence() {
        let engine = setup_engine();
        let mut state = setup_state();

        engine.analyze("CREATE SEQUENCE s;", &mut state).unwrap();
        let before = state
            .local
            .graph
            .edges()
            .iter()
            .filter(|e| {
                matches!(
                    e.kind,
                    safe_migrate::_internal::analysis::graph::DependencyKind::SequenceOwnedBy { .. }
                )
            })
            .count();
        engine
            .analyze(
                "CREATE SEQUENCE IF NOT EXISTS s OWNED BY foo.bar;",
                &mut state,
            )
            .unwrap();
        assert_eq!(
            state
                .local
                .graph
                .edges()
                .iter()
                .filter(|e| matches!(
                    e.kind,
                    safe_migrate::_internal::analysis::graph::DependencyKind::SequenceOwnedBy { .. }
                ))
                .count(),
            before
        );
    }
}