version-migrate 0.20.0

Explicit, type-safe schema versioning and migration for Rust
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

use version_migrate::Versioned;

#[derive(Debug, PartialEq, Versioned)]
#[versioned(version = "1.0.0", auto_tag = true)]
struct TaskV1 {
    id: String,
    title: String,
}

#[derive(Debug, PartialEq, Versioned)]
#[versioned(version = "2.0.0", auto_tag = true)]
struct TaskV2 {
    id: String,
    title: String,
    description: Option<String>,
}

#[derive(Debug, PartialEq, Versioned)]
#[versioned(version = "1.0.0", version_key = "schema_version", auto_tag = true)]
struct CustomKeyTask {
    id: String,
    name: String,
}

#[test]
fn test_auto_tag_serialize() {
    let task = TaskV1 {
        id: "task-1".to_string(),
        title: "Test Task".to_string(),
    };

    let json = serde_json::to_string(&task).unwrap();
    assert!(json.contains("\"version\":\"1.0.0\""));
    assert!(json.contains("\"id\":\"task-1\""));
    assert!(json.contains("\"title\":\"Test Task\""));

    // Parse to verify structure
    let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();
    assert_eq!(parsed["version"], "1.0.0");
    assert_eq!(parsed["id"], "task-1");
    assert_eq!(parsed["title"], "Test Task");
}

#[test]
fn test_auto_tag_deserialize() {
    let json = r#"{"version":"1.0.0","id":"task-1","title":"Test Task"}"#;
    let task: TaskV1 = serde_json::from_str(json).unwrap();

    assert_eq!(task.id, "task-1");
    assert_eq!(task.title, "Test Task");
}

#[test]
fn test_auto_tag_roundtrip() {
    let original = TaskV1 {
        id: "task-1".to_string(),
        title: "Test Task".to_string(),
    };

    let json = serde_json::to_string(&original).unwrap();
    let deserialized: TaskV1 = serde_json::from_str(&json).unwrap();

    assert_eq!(original, deserialized);
}

#[test]
fn test_auto_tag_with_optional_fields() {
    let task = TaskV2 {
        id: "task-2".to_string(),
        title: "Task with description".to_string(),
        description: Some("This is a description".to_string()),
    };

    let json = serde_json::to_string(&task).unwrap();
    let deserialized: TaskV2 = serde_json::from_str(&json).unwrap();

    assert_eq!(task, deserialized);
    assert_eq!(
        deserialized.description,
        Some("This is a description".to_string())
    );
}

#[test]
fn test_auto_tag_custom_version_key() {
    let task = CustomKeyTask {
        id: "custom-1".to_string(),
        name: "Custom Task".to_string(),
    };

    let json = serde_json::to_string(&task).unwrap();
    assert!(json.contains("\"schema_version\":\"1.0.0\""));
    assert!(!json.contains("\"version\""));

    // Parse to verify structure
    let parsed: serde_json::Value = serde_json::from_str(&json).unwrap();
    assert_eq!(parsed["schema_version"], "1.0.0");
    assert_eq!(parsed["id"], "custom-1");
    assert_eq!(parsed["name"], "Custom Task");
}

#[test]
fn test_auto_tag_custom_key_roundtrip() {
    let original = CustomKeyTask {
        id: "custom-1".to_string(),
        name: "Custom Task".to_string(),
    };

    let json = serde_json::to_string(&original).unwrap();
    let deserialized: CustomKeyTask = serde_json::from_str(&json).unwrap();

    assert_eq!(original, deserialized);
}

#[test]
fn test_auto_tag_version_mismatch_error() {
    let json = r#"{"version":"2.0.0","id":"task-1","title":"Test Task"}"#;
    let result: Result<TaskV1, _> = serde_json::from_str(json);

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("version mismatch"));
}

#[test]
fn test_auto_tag_missing_version_error() {
    let json = r#"{"id":"task-1","title":"Test Task"}"#;
    let result: Result<TaskV1, _> = serde_json::from_str(json);

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("missing field"));
}

#[test]
fn test_auto_tag_missing_field_error() {
    let json = r#"{"version":"1.0.0","id":"task-1"}"#;
    let result: Result<TaskV1, _> = serde_json::from_str(json);

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("missing field"));
}

#[test]
fn test_auto_tag_pretty_print() {
    let task = TaskV1 {
        id: "task-1".to_string(),
        title: "Test Task".to_string(),
    };

    let json = serde_json::to_string_pretty(&task).unwrap();
    assert!(json.contains("\"version\": \"1.0.0\""));
    assert!(json.contains("\"id\": \"task-1\""));
    assert!(json.contains("\"title\": \"Test Task\""));
}