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
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
mod common;

mod destructive_rule_tests {
    use crate::common::*;
    use safe_migrate::_internal::analysis::state::AnalysisState;
    use safe_migrate::_internal::ast::identifiers::ObjectId;
    use safe_migrate::_internal::model::column::Column;
    use safe_migrate::_internal::model::relation::{Persistence, RelationKind, RelationState};
    use safe_migrate::_internal::report::violations::ViolationTier;

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

        engine
            .analyze(
                "CREATE TABLE t(id int); CREATE VIEW v AS SELECT * FROM t;",
                &mut state,
            )
            .unwrap();

        // Drop view with cascade
        let v = engine.analyze("DROP VIEW v CASCADE;", &mut state).unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "destructive-general-cascade"),
            "DROP VIEW CASCADE should trigger GeneralCascadeRule"
        );
    }

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

        let v = engine
            .analyze("DROP DATABASE test_db;", &mut state)
            .unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "drop-database"),
            "DROP DATABASE should trigger DropDatabaseRule"
        );
    }

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

        let v = engine
            .analyze(
                "CREATE TABLE backup AS SELECT * FROM source_table;",
                &mut state,
            )
            .unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "create-table-as-select"),
            "CREATE TABLE AS SELECT should trigger CreateTableAsSelectRule"
        );
    }

    #[test]
    fn test_rule_type_change_rewrite_varchar_to_text() {
        let engine = setup_engine();

        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        let mut relation = safe_migrate::_internal::model::relation::RelationState::new(
            object_id("public", "t"),
            ObjectId::new("public", "postgres"),
            0,
            Some(500),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        relation.columns.push(Column {
            name: "data".into(),
            data_type: Some("character varying(100)".into()),
            type_id: None,
            is_nullable: false,
            default: None,
            avg_width: None,
            default_expr_text: None,
            type_modifier: Some(104),
        });
        cache.insert_baseline(object_id("public", "t"), relation);

        let mut state = AnalysisState::new(cache);

        let v = engine
            .analyze("ALTER TABLE t ALTER COLUMN data TYPE text;", &mut state)
            .unwrap();

        assert!(
            !v.iter()
                .any(|violation| violation.rule_id == "type-change-rewrite"),
            "varchar to text must not be reported as a rewrite"
        );
    }

    #[test]
    fn test_rule_type_change_narrow_varchar_unbounded() {
        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(100),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        rel.apply_column_action(
            &safe_migrate::_internal::model::relation::ColumnAction::Add {
                name: "val".to_string(),
                data_type: Some("varchar".to_string()),
                not_null: false,
                default: None,
            },
        );
        cache.insert_baseline(tid, rel);
        let mut state = AnalysisState::new(cache);

        let v = engine
            .analyze(
                "ALTER TABLE t ALTER COLUMN val TYPE varchar(10);",
                &mut state,
            )
            .unwrap();

        assert!(
            v.iter().any(|viol| viol.rule_id == "type-change-rewrite"
                && viol.reason.contains("narrows VARCHAR precision (lossy)")),
            "Unbounded to bounded varchar change should be flagged as lossy narrowing: {:?}",
            v
        );
    }

    /// Varchar narrowing: 255→50 should be flagged as lossy, 50→255 should not
    #[test]
    fn test_rule_varchar_narrowing_lossy() {
        let engine = setup_engine();

        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        let mut rel = safe_migrate::_internal::model::relation::RelationState::new(
            object_id("public", "t"),
            ObjectId::new("public", "postgres"),
            0,
            Some(500),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        // Column with varchar(255): atttypmod = 255 + 4 = 259
        rel.columns.push(Column {
            name: "data".into(),
            data_type: Some("character varying(255)".into()),
            type_id: None,
            is_nullable: true,
            default: None,
            avg_width: None,
            default_expr_text: None,
            type_modifier: Some(259),
        });
        cache.insert_baseline(object_id("public", "t"), rel);

        let mut state = AnalysisState::new(cache);

        // Already has baseline column with type_modifier=259 (varchar(255))
        // Now try narrowing to varchar(50): atttypmod = 50 + 4 = 54
        let v = engine
            .analyze(
                "ALTER TABLE t ALTER COLUMN data TYPE varchar(50);",
                &mut state,
            )
            .unwrap();

        assert!(
            v.iter()
                .any(|v| v.rule_id == "type-change-rewrite" && v.reason.contains("narrows")),
            "255→50 should be flagged as lossy VARCHAR narrowing"
        );

        // Now try widening: varchar(50) → varchar(255) should NOT flag as lossy
        let mut cache2 = safe_migrate::_internal::db::cache::DbCache::new();
        let mut rel2 = safe_migrate::_internal::model::relation::RelationState::new(
            object_id("public", "t"),
            ObjectId::new("public", "postgres"),
            0,
            Some(500),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        rel2.columns.push(Column {
            name: "data".into(),
            data_type: Some("character varying(50)".into()),
            type_id: None,
            is_nullable: true,
            default: None,
            avg_width: None,
            default_expr_text: None,
            type_modifier: Some(54),
        });
        cache2.insert_baseline(object_id("public", "t"), rel2);
        let mut state2 = AnalysisState::new(cache2);

        let v2 = engine
            .analyze(
                "ALTER TABLE t ALTER COLUMN data TYPE varchar(255);",
                &mut state2,
            )
            .unwrap();

        // Should NOT be flagged as a rewrite
        assert!(
            !v2.iter().any(|v| v.rule_id == "type-change-rewrite"),
            "50→255 should be safe and NOT trigger type-change-rewrite: {:?}",
            v2
        );
    }

    /// text -> varchar(n) is a narrowing change and should be flagged
    #[test]
    fn test_rule_text_to_varchar_narrowing() {
        let engine = setup_engine();

        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        let mut rel = safe_migrate::_internal::model::relation::RelationState::new(
            object_id("public", "t"),
            ObjectId::new("public", "postgres"),
            0,
            Some(500),
            RelationKind::Table,
            Persistence::Permanent,
            0,
        );
        rel.columns.push(Column {
            name: "data".into(),
            data_type: Some("text".into()),
            type_id: None,
            is_nullable: true,
            default: None,
            avg_width: None,
            default_expr_text: None,
            type_modifier: None, // text has no modifier
        });
        cache.insert_baseline(object_id("public", "t"), rel);

        let mut state = AnalysisState::new(cache);

        let v = engine
            .analyze(
                "ALTER TABLE t ALTER COLUMN data TYPE varchar(50);",
                &mut state,
            )
            .unwrap();

        assert!(
            v.iter()
                .any(|v| v.rule_id == "type-change-rewrite" && v.reason.contains("narrows")),
            "text->varchar(50) should be flagged as lossy narrowing: {:?}",
            v
        );
    }

    /// DriftDetectionRule: DROP TABLE that doesn't exist in baseline → Tier 1
    #[test]
    fn test_rule_drift_detection_drop_missing_table() {
        // Simulate a live DB cache with table "existing_tbl"
        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        cache.insert_baseline(
            object_id("public", "existing_tbl"),
            safe_migrate::_internal::model::relation::RelationState::new(
                object_id("public", "existing_tbl"),
                ObjectId::new("public", "postgres"),
                0,
                Some(100),
                RelationKind::Table,
                Persistence::Permanent,
                0,
            ),
        );
        let engine = setup_engine();
        let mut state = AnalysisState::new(cache);

        // DROP TABLE that is NOT in baseline
        let v = engine
            .analyze("DROP TABLE nonexistent_tbl;", &mut state)
            .unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "schema-drift"),
            "DriftDetectionRule should flag DROP on table not in baseline"
        );
        // The cache is authoritative for this schema. Taint produced by this
        // statement must not downgrade the statement's own drift evidence.
        assert_eq!(
            v.iter().find(|v| v.rule_id == "schema-drift").unwrap().tier,
            ViolationTier::Tier1,
            "An exact baseline proves this missing DROP is production drift"
        );
    }

    /// DriftDetectionRule: ALTER TABLE that doesn't exist in baseline → Tier 1
    #[test]
    fn test_rule_drift_detection_alter_missing_table() {
        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        cache.insert_baseline(
            object_id("public", "existing_tbl"),
            safe_migrate::_internal::model::relation::RelationState::new(
                object_id("public", "existing_tbl"),
                ObjectId::new("public", "postgres"),
                0,
                Some(100),
                RelationKind::Table,
                Persistence::Permanent,
                0,
            ),
        );
        let engine = setup_engine();
        let mut state = AnalysisState::new(cache);

        // ALTER TABLE that is NOT in baseline
        let v = engine
            .analyze("ALTER TABLE nonexistent_tbl ADD COLUMN x int;", &mut state)
            .unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "schema-drift"),
            "DriftDetectionRule should flag ALTER on table not in baseline"
        );
        assert_eq!(
            v.iter().find(|v| v.rule_id == "schema-drift").unwrap().tier,
            ViolationTier::Tier1,
            "Drift should be Tier1"
        );
    }

    #[test]
    fn test_rule_drift_detection_drop_existing_table() {
        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        cache.insert_baseline(
            object_id("public", "existing_tbl"),
            safe_migrate::_internal::model::relation::RelationState::new(
                object_id("public", "existing_tbl"),
                ObjectId::new("public", "postgres"),
                0,
                Some(100),
                RelationKind::Table,
                Persistence::Permanent,
                0,
            ),
        );
        let engine = setup_engine();
        let mut state = AnalysisState::new(cache);

        // DROP TABLE that is in baseline should NOT flag schema-drift
        let v = engine
            .analyze("DROP TABLE existing_tbl;", &mut state)
            .unwrap();

        assert!(
            !v.iter().any(|v| v.rule_id == "schema-drift"),
            "DriftDetectionRule should NOT flag DROP on table present in baseline: {:?}",
            v
        );
    }

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

        // 1. DROP INDEX
        let v = engine
            .analyze("DROP INDEX nonexistent_idx;", &mut state)
            .unwrap();
        assert!(
            v.iter()
                .any(|v| v.rule_id == "schema-drift" && v.reason.contains("index"))
        );

        // 2. DROP SEQUENCE
        let v = engine
            .analyze("DROP SEQUENCE nonexistent_seq;", &mut state)
            .unwrap();
        assert!(
            v.iter()
                .any(|v| v.rule_id == "schema-drift" && v.reason.contains("sequence"))
        );

        // 3. ALTER TYPE
        let v = engine
            .analyze("ALTER TYPE nonexistent_type ADD VALUE 'val';", &mut state)
            .unwrap();
        assert!(
            v.iter()
                .any(|v| v.rule_id == "schema-drift" && v.reason.contains("type"))
        );

        // 4. ALTER FUNCTION
        let v = engine
            .analyze("ALTER FUNCTION nonexistent_func() IMMUTABLE;", &mut state)
            .unwrap();
        assert!(
            v.iter()
                .any(|v| v.rule_id == "schema-drift" && v.reason.contains("function"))
        );
    }

    #[test]
    fn test_rule_type_change_rewrite_unsafe_small() {
        let engine = setup_engine();

        let mut cache = safe_migrate::_internal::db::cache::DbCache::new();
        cache.insert_baseline(
            object_id("public", "t"),
            safe_migrate::_internal::model::relation::RelationState::new(
                object_id("public", "t"),
                ObjectId::new("public", "postgres"),
                0,
                Some(500),
                RelationKind::Table,
                Persistence::Permanent,
                0,
            ),
        );

        let mut state = AnalysisState::new(cache);

        engine
            .analyze("CREATE TABLE t(data int);", &mut state)
            .unwrap();

        let v = engine
            .analyze("ALTER TABLE t ALTER COLUMN data TYPE text;", &mut state)
            .unwrap();

        assert!(
            v.iter().any(|v| v.rule_id == "type-change-rewrite"),
            "int to text should trigger type-change-rewrite"
        );

        // For small tables, it should be Tier2 (not escalated)
        if let Some(viol) = v.iter().find(|v| v.rule_id == "type-change-rewrite") {
            assert_eq!(
                viol.tier,
                ViolationTier::Tier2,
                "Small table unsafe type change should be Tier2"
            );
        }
    }
}