a3s-orm 0.3.1

A type-safe, executor-neutral SQL query builder 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

use std::sync::Mutex;

use a3s_orm::{
    AppliedMigration, Migration, MigrationBackend, MigrationError, MigrationLedger,
    MigrationReport, Migrator, PreparedMigration,
};
use async_trait::async_trait;

#[derive(Default)]
struct RecordingBackend {
    migrations: Mutex<Vec<PreparedMigration>>,
    applied: Mutex<Vec<AppliedMigration>>,
}

#[derive(Debug, thiserror::Error)]
#[error("recording backend failed")]
struct RecordingError;

#[async_trait]
impl MigrationBackend for RecordingBackend {
    type Error = RecordingError;

    async fn apply(
        &self,
        migrations: &[PreparedMigration],
    ) -> Result<MigrationReport, Self::Error> {
        self.migrations
            .lock()
            .unwrap()
            .extend_from_slice(migrations);
        Ok(MigrationReport {
            applied: migrations
                .iter()
                .map(|migration| migration.version().to_owned())
                .collect(),
        })
    }
}

#[async_trait]
impl MigrationLedger for RecordingBackend {
    type Error = RecordingError;

    async fn applied_migrations(&self) -> Result<Vec<AppliedMigration>, Self::Error> {
        Ok(self.applied.lock().unwrap().clone())
    }
}

#[tokio::test]
async fn validates_sorts_and_checksums_migrations_before_backend_execution() {
    let migrator = Migrator::new(RecordingBackend::default());
    let report = migrator
        .run([
            Migration::new("002", "second", "create table second (id integer)"),
            Migration::new("001", "first", "create table first (id integer)"),
        ])
        .await
        .unwrap();
    assert_eq!(report.applied, ["001", "002"]);
    let recorded = migrator.backend().migrations.lock().unwrap();
    assert_eq!(recorded[0].version(), "001");
    assert_eq!(recorded[0].checksum().len(), 64);
    assert_eq!(
        recorded[0].checksum(),
        "10e0a2282e051aa0de3c957c7ef36d748cea0a244fed443abb5917b55d7a8384"
    );
    assert_ne!(recorded[0].checksum(), recorded[1].checksum());
}

#[tokio::test]
async fn rejects_invalid_and_duplicate_versions_without_calling_backend() {
    let migrator = Migrator::new(RecordingBackend::default());
    let error = migrator
        .run([
            Migration::new("001", "first", "select 1"),
            Migration::new("001", "duplicate", "select 2"),
        ])
        .await
        .unwrap_err();
    assert!(matches!(
        error,
        a3s_orm::migration::MigrationRunError::Validation(
            MigrationError::DuplicateVersion(version)
        ) if version == "001"
    ));
    assert!(migrator.backend().migrations.lock().unwrap().is_empty());
}

#[tokio::test]
async fn verifies_required_migrations_without_applying_or_rejecting_a_compatible_superset() {
    let required = Migration::new("001", "first", "select 1");
    let checksum = {
        let recorder = Migrator::new(RecordingBackend::default());
        recorder.run([required.clone()]).await.unwrap();
        let checksum = recorder.backend().migrations.lock().unwrap()[0]
            .checksum()
            .to_owned();
        checksum
    };
    let backend = RecordingBackend {
        applied: Mutex::new(vec![
            AppliedMigration {
                version: "001".into(),
                checksum,
            },
            AppliedMigration {
                version: "002".into(),
                checksum: "a later migration is outside this binary's required set".into(),
            },
        ]),
        ..RecordingBackend::default()
    };
    let migrator = Migrator::new(backend);

    migrator.verify_required([required]).await.unwrap();
    assert!(migrator.backend().migrations.lock().unwrap().is_empty());
}

#[tokio::test]
async fn rejects_missing_or_changed_required_migrations() {
    let missing = Migrator::new(RecordingBackend::default())
        .verify_required([Migration::new("001", "first", "select 1")])
        .await
        .unwrap_err();
    assert!(matches!(
        missing,
        a3s_orm::migration::MigrationRunError::Validation(
            MigrationError::MissingAppliedMigration(version)
        ) if version == "001"
    ));

    let changed = Migrator::new(RecordingBackend {
        applied: Mutex::new(vec![AppliedMigration {
            version: "001".into(),
            checksum: "wrong".into(),
        }]),
        ..RecordingBackend::default()
    })
    .verify_required([Migration::new("001", "first", "select 1")])
    .await
    .unwrap_err();
    assert!(matches!(
        changed,
        a3s_orm::migration::MigrationRunError::Validation(
            MigrationError::ChecksumMismatch { version, .. }
        ) if version == "001"
    ));
}