gaman-core 0.3.22

Offline core engine for Gaman migrations
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

use crate::dialects::Dialect;
use crate::migrations::Migration;

use super::Schema;

const TABLE_WITH_OPTIONS_YAML: &str = r#"
tables:
  users:
    name: users
    schema: null
    primary_key: null
    columns: []
    foreign_keys: []
    indexes: []
    constraints: []
    triggers: []
    options:
      header_raw: [UNLOGGED]
      trusted: true
"#;

/// Verifies authored YAML cannot set internal unmanaged table metadata.
#[test]
fn authored_yaml_rejects_internal_metadata() {
    let error = Schema::from_yaml_str(TABLE_WITH_OPTIONS_YAML, Dialect::Postgres)
        .expect_err("reserved metadata must fail");
    assert!(error.to_string().contains("unknown field `options`"));
}

/// Verifies authored JSON cannot set trusted opaque lifecycle metadata.
#[test]
fn authored_json_rejects_internal_metadata() {
    let input = r#"{
      "tables": {"users": {
        "name": "users", "schema": null, "primary_key": null,
        "columns": [], "foreign_keys": [], "indexes": [{
          "name": "users_expr_idx", "columns": [], "unique": false,
          "predicate": null,
          "opaque": {"raw": "CREATE INDEX users_expr_idx ON users ((lower(name)))", "trusted": true}
        }], "constraints": [], "triggers": []
      }}
    }"#;
    let error =
        Schema::from_json_str(input, Dialect::Postgres).expect_err("reserved metadata must fail");
    assert!(error.to_string().contains("unknown field `opaque`"));
}

/// Verifies authored YAML rejects accidental fields instead of silently ignoring them.
#[test]
fn authored_yaml_rejects_unknown_fields() {
    let input = r#"
tables:
  users:
    name: users
    columns: []
    typo_field: true
"#;

    let error =
        Schema::from_yaml_str(input, Dialect::Postgres).expect_err("unknown fields must fail");

    assert!(error.to_string().contains("unknown field `typo_field`"));
}

/// Verifies reserved words can still be used as authored entity names.
#[test]
fn authored_yaml_allows_reserved_words_as_entity_names() {
    let input = r#"
tables:
  raw:
    name: raw
    columns:
    - name: id
      type: integer
      primary_key: true
"#;

    let schema =
        Schema::from_yaml_str(input, Dialect::Postgres).expect("reserved name should load");

    assert!(schema.tables.contains_key("raw"));
}

/// Verifies migration history can retain accepted internal table metadata for replay.
#[test]
fn migration_yaml_accepts_internal_metadata() {
    let yaml = format!(
        "dependencies: []\noperations:\n- type: create_table\n  table:\n{}atomic: true\n",
        TABLE_WITH_OPTIONS_YAML
            .trim_start_matches("\ntables:\n  users:\n")
            .lines()
            .map(|line| format!("    {line}\n"))
            .collect::<String>()
    );
    Migration::from_yaml_str(&yaml).expect("migration metadata should deserialize");
}