toolu-orm-core 0.1.1

Schema definitions, migrations and driver traits for toolu-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
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

use toolu_orm_core::column::ColumnType;
use toolu_orm_core::diff::{diff_with_resolver, ColumnChange, Operation};
use toolu_orm_core::rename::NoRenames;
use toolu_orm_core::schema::SchemaRegistry;
use toolu_orm_core::snapshot::Snapshot;

use super::{col, table};

type TestResult = Result<(), Box<dyn std::error::Error>>;

#[test]
fn test_diff_create_table_from_empty() -> TestResult {
  let old = Snapshot::from_registry(&SchemaRegistry::from_tables(vec![]));
  let new_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("id", ColumnType::Text, true, false)],
  )]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 1);
  let op = ops.first().ok_or("expected one operation")?;
  assert!(
    matches!(op, Operation::CreateTable { table: t } if t.name == "conversations"),
    "expected CreateTable for conversations, got {op:?}"
  );
  Ok(())
}

#[test]
fn test_diff_drop_table() -> TestResult {
  let old_reg = SchemaRegistry::from_tables(vec![table(
    "old_table",
    vec![col("id", ColumnType::Text, true, false)],
  )]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 1);
  let op = ops.first().ok_or("expected one operation")?;
  assert!(
    matches!(op, Operation::DropTable { name } if name == "old_table"),
    "expected DropTable for old_table, got {op:?}"
  );
  Ok(())
}

#[test]
fn test_diff_add_column() -> TestResult {
  let old_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("id", ColumnType::Text, true, false)],
  )]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![
      col("id", ColumnType::Text, true, false),
      col("title", ColumnType::Text, false, false),
    ],
  )]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 1);
  let op = ops.first().ok_or("expected one operation")?;
  assert!(
    matches!(op, Operation::AddColumn { table: t, column: c }
      if t == "conversations" && c.name == "title"),
    "expected AddColumn title on conversations, got {op:?}"
  );
  Ok(())
}

#[test]
fn test_diff_drop_column() -> TestResult {
  let old_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![
      col("id", ColumnType::Text, true, false),
      col("title", ColumnType::Text, false, false),
    ],
  )]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("id", ColumnType::Text, true, false)],
  )]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 1);
  let op = ops.first().ok_or("expected one operation")?;
  assert!(
    matches!(op, Operation::DropColumn { table: t, column: c }
      if t == "conversations" && c == "title"),
    "expected DropColumn title on conversations, got {op:?}"
  );
  Ok(())
}

#[test]
fn test_diff_alter_column() -> TestResult {
  let old_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("title", ColumnType::Text, false, false)],
  )]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("title", ColumnType::Text, false, true)],
  )]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 1);
  let op = ops.first().ok_or("expected one operation")?;
  assert!(
    matches!(op, Operation::AlterColumn { table: t, ref changes, .. }
      if t == "conversations" && changes.iter().any(|c| matches!(c, ColumnChange::Nullable { column, old: true, new: false, .. } if column == "title"))),
    "expected AlterColumn for title on conversations, got {op:?}"
  );
  Ok(())
}

#[test]
fn test_diff_alter_column_type_change() {
  let old_reg = SchemaRegistry::from_tables(vec![table(
    "users",
    vec![col("age", ColumnType::Integer, false, false)],
  )]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![table(
    "users",
    vec![col("age", ColumnType::BigInt, false, false)],
  )]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  match ops.as_slice() {
    [Operation::AlterColumn {
      table,
      changes,
      table_def,
    }] => {
      assert_eq!(table, "users");
      assert_eq!(table_def.name, "users");
      match changes.as_slice() {
        [ColumnChange::Type { column, .. }] => assert_eq!(column, "age"),
        _ => assert_eq!(
          changes.len(),
          1,
          "expected one Type change, got {changes:?}"
        ),
      }
    },
    [wrong] => assert!(
      matches!(wrong, Operation::AlterColumn { .. }),
      "expected AlterColumn, got {wrong:?}"
    ),
    _ => assert_eq!(ops.len(), 1, "expected exactly one operation"),
  }
}

#[test]
fn test_diff_alter_column_multiple_changes_batched() {
  let mut old_col = col("email", ColumnType::Text, false, false);
  old_col.unique = false;
  let mut new_col = col("email", ColumnType::Text, false, true);
  new_col.unique = true;

  let old_reg = SchemaRegistry::from_tables(vec![table("users", vec![old_col])]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![table("users", vec![new_col])]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  match ops.as_slice() {
    [Operation::AlterColumn {
      changes, table_def, ..
    }] => {
      assert_eq!(changes.len(), 2);
      assert!(changes
        .iter()
        .any(|c| matches!(c, ColumnChange::Nullable { .. })));
      assert!(changes
        .iter()
        .any(|c| matches!(c, ColumnChange::Unique { .. })));
      assert_eq!(table_def.name, "users");
    },
    [wrong] => assert!(
      matches!(wrong, Operation::AlterColumn { .. }),
      "expected AlterColumn, got {wrong:?}"
    ),
    _ => assert_eq!(ops.len(), 1, "expected exactly one operation"),
  }
}

#[test]
fn test_diff_no_changes() {
  let reg = SchemaRegistry::from_tables(vec![table(
    "conversations",
    vec![col("id", ColumnType::Text, true, false)],
  )]);
  let snap = Snapshot::from_registry(&reg);
  let ops = diff_with_resolver(&snap, &reg, &NoRenames);
  assert!(ops.is_empty());
}

#[test]
fn test_diff_multiple_operations() {
  let old_reg = SchemaRegistry::from_tables(vec![
    table(
      "conversations",
      vec![col("id", ColumnType::Text, true, false)],
    ),
    table("to_drop", vec![col("id", ColumnType::Text, true, false)]),
  ]);
  let old = Snapshot::from_registry(&old_reg);
  let new_reg = SchemaRegistry::from_tables(vec![
    table(
      "conversations",
      vec![
        col("id", ColumnType::Text, true, false),
        col("title", ColumnType::Text, false, false),
      ],
    ),
    table(
      "new_table",
      vec![col("id", ColumnType::Integer, true, false)],
    ),
  ]);
  let ops = diff_with_resolver(&old, &new_reg, &NoRenames);
  assert_eq!(ops.len(), 3);
}