refinery_core/
util.rs

1use crate::error::{Error, Kind};
2use crate::runner::Type;
3use crate::Migration;
4use regex::Regex;
5use std::ffi::OsStr;
6use std::path::{Path, PathBuf};
7use std::sync::OnceLock;
8use walkdir::{DirEntry, WalkDir};
9
10#[cfg(not(feature = "int8-versions"))]
11pub type SchemaVersion = i32;
12#[cfg(feature = "int8-versions")]
13pub type SchemaVersion = i64;
14
15const STEM_RE: &str = r"^([U|V])(\d+(?:\.\d+)?)__(\w+)";
16
17/// Matches the stem of a migration file.
18fn file_stem_re() -> &'static Regex {
19    static RE: OnceLock<Regex> = OnceLock::new();
20    RE.get_or_init(|| Regex::new(STEM_RE).unwrap())
21}
22
23/// Matches the stem + extension of a SQL migration file.
24fn file_re_sql() -> &'static Regex {
25    static RE: OnceLock<Regex> = OnceLock::new();
26    RE.get_or_init(|| Regex::new([STEM_RE, r"\.sql$"].concat().as_str()).unwrap())
27}
28
29/// Matches the stem + extension of any migration file.
30fn file_re_all() -> &'static Regex {
31    static RE: OnceLock<Regex> = OnceLock::new();
32    RE.get_or_init(|| Regex::new([STEM_RE, r"\.(rs|sql)$"].concat().as_str()).unwrap())
33}
34
35/// enum containing the migration types used to search for migrations
36/// either just .sql files or both .sql and .rs
37pub enum MigrationType {
38    All,
39    Sql,
40}
41
42impl MigrationType {
43    fn file_match_re(&self) -> &'static Regex {
44        match self {
45            MigrationType::All => file_re_all(),
46            MigrationType::Sql => file_re_sql(),
47        }
48    }
49}
50
51/// Parse a migration filename stem into a prefix, version, and name.
52pub fn parse_migration_name(name: &str) -> Result<(Type, SchemaVersion, String), Error> {
53    let captures = file_stem_re()
54        .captures(name)
55        .filter(|caps| caps.len() == 4)
56        .ok_or_else(|| Error::new(Kind::InvalidName, None))?;
57    let version: SchemaVersion = captures[2]
58        .parse()
59        .map_err(|_| Error::new(Kind::InvalidVersion, None))?;
60
61    let name: String = (&captures[3]).into();
62    let prefix = match &captures[1] {
63        "V" => Type::Versioned,
64        "U" => Type::Unversioned,
65        _ => unreachable!(),
66    };
67
68    Ok((prefix, version, name))
69}
70
71/// find migrations on file system recursively across directories given a location and [MigrationType]
72pub fn find_migration_files(
73    location: impl AsRef<Path>,
74    migration_type: MigrationType,
75) -> Result<impl Iterator<Item = PathBuf>, Error> {
76    let location: &Path = location.as_ref();
77    let location = location.canonicalize().map_err(|err| {
78        Error::new(
79            Kind::InvalidMigrationPath(location.to_path_buf(), err),
80            None,
81        )
82    })?;
83
84    let re = migration_type.file_match_re();
85    let file_paths = WalkDir::new(location)
86        .into_iter()
87        .filter_map(Result::ok)
88        .map(DirEntry::into_path)
89        // filter by migration file regex
90        .filter(
91            move |entry| match entry.file_name().and_then(OsStr::to_str) {
92                Some(file_name) if re.is_match(file_name) => true,
93                Some(file_name) => {
94                    log::warn!(
95                        "File \"{}\" does not adhere to the migration naming convention. Migrations must be named in the format [U|V]{{1}}__{{2}}.sql or [U|V]{{1}}__{{2}}.rs, where {{1}} represents the migration version and {{2}} the name.",
96                        file_name
97                    );
98                    false
99                }
100                None => false,
101            },
102        );
103
104    Ok(file_paths)
105}
106
107/// Loads SQL migrations from a path. This enables dynamic migration discovery, as opposed to
108/// embedding. The resulting collection is ordered by version.
109pub fn load_sql_migrations(location: impl AsRef<Path>) -> Result<Vec<Migration>, Error> {
110    let migration_files = find_migration_files(location, MigrationType::Sql)?;
111
112    let mut migrations = vec![];
113
114    for path in migration_files {
115        let sql = std::fs::read_to_string(path.as_path()).map_err(|e| {
116            let path = path.to_owned();
117            let kind = match e.kind() {
118                std::io::ErrorKind::NotFound => Kind::InvalidMigrationPath(path, e),
119                _ => Kind::InvalidMigrationFile(path, e),
120            };
121
122            Error::new(kind, None)
123        })?;
124
125        //safe to call unwrap as find_migration_filenames returns canonical paths
126        let filename = path
127            .file_stem()
128            .and_then(|file| file.to_os_string().into_string().ok())
129            .unwrap();
130
131        let migration = Migration::unapplied(&filename, &sql)?;
132        migrations.push(migration);
133    }
134
135    migrations.sort();
136    Ok(migrations)
137}
138
139#[cfg(test)]
140mod tests {
141    use super::{find_migration_files, load_sql_migrations, MigrationType};
142    use std::fs;
143    use std::path::PathBuf;
144    use tempfile::TempDir;
145
146    #[test]
147    fn finds_mod_migrations() {
148        let tmp_dir = TempDir::new().unwrap();
149        let migrations_dir = tmp_dir.path().join("migrations");
150        fs::create_dir(&migrations_dir).unwrap();
151        let sql1 = migrations_dir.join("V1__first.rs");
152        fs::File::create(&sql1).unwrap();
153        let sql2 = migrations_dir.join("V2__second.rs");
154        fs::File::create(&sql2).unwrap();
155
156        let mut mods: Vec<PathBuf> = find_migration_files(migrations_dir, MigrationType::All)
157            .unwrap()
158            .collect();
159        mods.sort();
160        assert_eq!(sql1.canonicalize().unwrap(), mods[0]);
161        assert_eq!(sql2.canonicalize().unwrap(), mods[1]);
162    }
163
164    #[test]
165    fn ignores_mod_files_without_migration_regex_match() {
166        let tmp_dir = TempDir::new().unwrap();
167        let migrations_dir = tmp_dir.path().join("migrations");
168        fs::create_dir(&migrations_dir).unwrap();
169        let sql1 = migrations_dir.join("V1first.rs");
170        fs::File::create(sql1).unwrap();
171        let sql2 = migrations_dir.join("V2second.rs");
172        fs::File::create(sql2).unwrap();
173
174        let mut mods = find_migration_files(migrations_dir, MigrationType::All).unwrap();
175        assert!(mods.next().is_none());
176    }
177
178    #[test]
179    fn finds_sql_migrations() {
180        let tmp_dir = TempDir::new().unwrap();
181        let migrations_dir = tmp_dir.path().join("migrations");
182        fs::create_dir(&migrations_dir).unwrap();
183        let sql1 = migrations_dir.join("V1__first.sql");
184        fs::File::create(&sql1).unwrap();
185        let sql2 = migrations_dir.join("V2__second.sql");
186        fs::File::create(&sql2).unwrap();
187
188        let mut mods: Vec<PathBuf> = find_migration_files(migrations_dir, MigrationType::All)
189            .unwrap()
190            .collect();
191        mods.sort();
192        assert_eq!(sql1.canonicalize().unwrap(), mods[0]);
193        assert_eq!(sql2.canonicalize().unwrap(), mods[1]);
194    }
195
196    #[test]
197    fn finds_unversioned_migrations() {
198        let tmp_dir = TempDir::new().unwrap();
199        let migrations_dir = tmp_dir.path().join("migrations");
200        fs::create_dir(&migrations_dir).unwrap();
201        let sql1 = migrations_dir.join("U1__first.sql");
202        fs::File::create(&sql1).unwrap();
203        let sql2 = migrations_dir.join("U2__second.sql");
204        fs::File::create(&sql2).unwrap();
205
206        let mut mods: Vec<PathBuf> = find_migration_files(migrations_dir, MigrationType::All)
207            .unwrap()
208            .collect();
209        mods.sort();
210        assert_eq!(sql1.canonicalize().unwrap(), mods[0]);
211        assert_eq!(sql2.canonicalize().unwrap(), mods[1]);
212    }
213
214    #[test]
215    fn ignores_sql_files_without_migration_regex_match() {
216        let tmp_dir = TempDir::new().unwrap();
217        let migrations_dir = tmp_dir.path().join("migrations");
218        fs::create_dir(&migrations_dir).unwrap();
219        let sql1 = migrations_dir.join("V1first.sql");
220        fs::File::create(sql1).unwrap();
221        let sql2 = migrations_dir.join("V2second.sql");
222        fs::File::create(sql2).unwrap();
223
224        let mut mods = find_migration_files(migrations_dir, MigrationType::All).unwrap();
225        assert!(mods.next().is_none());
226    }
227
228    #[test]
229    fn loads_migrations_from_path() {
230        let tmp_dir = TempDir::new().unwrap();
231        let migrations_dir = tmp_dir.path().join("migrations");
232        fs::create_dir(&migrations_dir).unwrap();
233        let sql1 = migrations_dir.join("V1__first.sql");
234        fs::File::create(&sql1).unwrap();
235        let sql2 = migrations_dir.join("V2__second.sql");
236        fs::File::create(&sql2).unwrap();
237        let rs3 = migrations_dir.join("V3__third.rs");
238        fs::File::create(&rs3).unwrap();
239
240        let migrations = load_sql_migrations(migrations_dir).unwrap();
241        assert_eq!(migrations.len(), 2);
242        assert_eq!(&migrations[0].to_string(), "V1__first");
243        assert_eq!(&migrations[1].to_string(), "V2__second");
244    }
245}
refinery_core/util.rs

refinery_core/
util.rs
