sntl-migrate 0.1.2

Migrations library + CLI helpers for Sentinel ORM
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

use sntl_migrate::diff::{Change, compare, emit};
use sntl_schema::schema::{Column, PgTypeRef, Schema, Table};

fn col(name: &str, ty: &str, nullable: bool) -> Column {
    Column {
        name: name.into(),
        pg_type: PgTypeRef::simple(ty),
        oid: 0,
        nullable,
        primary_key: false,
        unique: false,
        default: None,
    }
}

fn tbl(name: &str, cols: Vec<Column>) -> Table {
    Table {
        name: name.into(),
        schema: "public".into(),
        columns: cols,
        foreign_keys: vec![],
    }
}

fn sch(tables: Vec<Table>) -> Schema {
    Schema {
        version: 1,
        postgres_version: "16".into(),
        generated_at: None,
        source: None,
        tables,
        enums: vec![],
        composites: vec![],
    }
}

#[test]
fn add_table_change() {
    let cache = sch(vec![tbl("users", vec![col("id", "int4", false)])]);
    let live = sch(vec![]);
    let changes = compare(&cache, &live);
    assert!(matches!(changes[0], Change::AddTable(_)));
}

#[test]
fn drop_table_change() {
    let cache = sch(vec![]);
    let live = sch(vec![tbl("users", vec![col("id", "int4", false)])]);
    let changes = compare(&cache, &live);
    assert!(matches!(&changes[0], Change::DropTable { name } if name == "users"));
}

#[test]
fn add_column_change() {
    let cache = sch(vec![tbl(
        "u",
        vec![col("id", "int4", false), col("name", "text", false)],
    )]);
    let live = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let changes = compare(&cache, &live);
    assert!(
        changes
            .iter()
            .any(|c| matches!(c, Change::AddColumn { table, .. } if table == "u"))
    );
}

#[test]
fn alter_type_change() {
    let cache = sch(vec![tbl("u", vec![col("id", "int8", false)])]);
    let live = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let changes = compare(&cache, &live);
    assert!(matches!(
        &changes[0],
        Change::AlterColumnType { from, to, .. } if from == "int4" && to == "int8"
    ));
}

#[test]
fn emit_add_table_clean() {
    let cache = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let changes = compare(&cache, &sch(vec![]));
    let (out, todos) = emit(&changes);
    assert!(out.contains("CREATE TABLE u"));
    assert_eq!(todos, 0);
}

#[test]
fn emit_drop_table_is_todo() {
    let live = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let changes = compare(&sch(vec![]), &live);
    let (out, todos) = emit(&changes);
    assert_eq!(todos, 1);
    assert!(out.contains("TODO: confirm DROP"));
}

#[test]
fn emit_widening_alter_is_clean() {
    let cache = sch(vec![tbl("u", vec![col("id", "int8", false)])]);
    let live = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let (out, todos) = emit(&compare(&cache, &live));
    assert_eq!(todos, 0);
    assert!(out.contains("ALTER TABLE u ALTER COLUMN id TYPE int8"));
}

#[test]
fn emit_narrowing_alter_has_todo() {
    let cache = sch(vec![tbl("u", vec![col("id", "int4", false)])]);
    let live = sch(vec![tbl("u", vec![col("id", "int8", false)])]);
    let (out, todos) = emit(&compare(&cache, &live));
    assert_eq!(todos, 1);
    assert!(out.contains("USING id::int4"));
}