vespertide-core 0.2.1

Data models for tables, columns, constraints, indexes, and migration actions
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

use crate::schema::names::{ColumnName, TableName};

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum TableValidationError {
    DuplicateColumnName {
        table: TableName,
        column: ColumnName,
    },
    DuplicateIndexColumn {
        index_name: String,
        column_name: String,
    },
    InvalidForeignKeyFormat {
        column_name: String,
        value: String,
    },
    /// Internal invariant violation in normalization; valid user input should not trigger this.
    InvariantViolation {
        context: String,
    },
}

impl std::fmt::Display for TableValidationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            TableValidationError::DuplicateColumnName { table, column } => {
                write!(f, "table '{table}' has duplicate column name '{column}'")
            }
            TableValidationError::DuplicateIndexColumn {
                index_name,
                column_name,
            } => {
                write!(
                    f,
                    "Duplicate index '{index_name}' on column '{column_name}': the same index name cannot be applied to the same column multiple times"
                )
            }
            TableValidationError::InvalidForeignKeyFormat { column_name, value } => {
                write!(
                    f,
                    "Invalid foreign key format '{value}' on column '{column_name}': expected 'table.column' format"
                )
            }
            TableValidationError::InvariantViolation { context } => {
                write!(
                    f,
                    "internal table normalization invariant violated: {context}"
                )
            }
        }
    }
}

impl std::error::Error for TableValidationError {}

#[cfg(test)]
mod tests {
    //! Coverage-closure tests for the `InvalidForeignKeyFormat` Display arm.
    //! Targets `uncovered-detail.json` lines 35, 36
    //! (the multi-line `write!` body for `DuplicateIndexColumn` / `InvalidForeignKeyFormat`).
    use super::*;
    use rstest::rstest;

    #[rstest]
    #[case::duplicate_index(
        TableValidationError::DuplicateIndexColumn {
            index_name: "ix_user__email".into(),
            column_name: "email".into(),
        },
        "Duplicate index 'ix_user__email' on column 'email'",
    )]
    #[case::invalid_fk(
        TableValidationError::InvalidForeignKeyFormat {
            column_name: "author_id".into(),
            value: "broken".into(),
        },
        "Invalid foreign key format 'broken' on column 'author_id'",
    )]
    fn display_emits_descriptive_messages(#[case] err: TableValidationError, #[case] needle: &str) {
        let rendered = err.to_string();
        assert!(
            rendered.contains(needle),
            "expected `{needle}` to appear in `{rendered}`"
        );
    }

    #[test]
    fn display_duplicate_column_name() {
        // Pre-existing covered arm; included so the file's `mod tests` also
        // documents the canonical case.
        let err = TableValidationError::DuplicateColumnName {
            table: "user".into(),
            column: "email".into(),
        };
        assert_eq!(
            err.to_string(),
            "table 'user' has duplicate column name 'email'",
        );
    }

    #[test]
    fn display_invariant_violation() {
        let err = TableValidationError::InvariantViolation {
            context: "normalize() collapsed two unique constraints".into(),
        };
        assert!(err.to_string().contains("normalize()"));
    }
}