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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
use crate::{Error, Migration, Runner, WrapMigrationError};
#[cfg(feature = "mysql")]
use mysql::Conn as MysqlConnection;
#[cfg(feature = "mysql_async")]
use mysql_async::Pool as MysqlAsyncPool;
#[cfg(feature = "postgres")]
use postgres::Client as PgClient;
#[cfg(feature = "postgres-previous")]
use postgres_previous::Connection as PgConnection;
#[cfg(feature = "rusqlite")]
use rusqlite::{Connection as RqlConnection, OpenFlags};
use serde::{Deserialize, Serialize};
use std::fs;
use std::path::Path;

//refinery config file used by migrate_from_config
#[derive(Serialize, Deserialize, Debug)]
pub struct Config {
    pub main: Main,
}

#[derive(Clone, Copy, Serialize, Deserialize, PartialEq, Debug)]
pub enum ConfigDbType {
    Mysql,
    Postgres,
    Sqlite,
}

impl Config {
    pub fn new(db_type: ConfigDbType) -> Config {
        Config {
            main: Main {
                db_type,
                db_path: None,
                db_host: None,
                db_port: None,
                db_user: None,
                db_pass: None,
                db_name: None,
            },
        }
    }

    /// create a new Config instance from a config file located on the file system
    pub fn from_file_location<T: AsRef<Path>>(location: T) -> Result<Config, Error> {
        let file = std::fs::read_to_string(&location)
            .map_err(|err| Error::ConfigError(format!("could not open config file, {}", err)))?;

        let mut config: Config = toml::from_str(&file)
            .map_err(|err| Error::ConfigError(format!("could not parse config file, {}", err)))?;

        //replace relative path with canonical path in case of Sqlite db
        if config.main.db_type == ConfigDbType::Sqlite {
            let config_db_path = config.main.db_path.ok_or_else(|| {
                Error::ConfigError("field path must be present for Sqlite database type".into())
            })?;
            let mut config_db_path = Path::new(&config_db_path).to_path_buf();

            if config_db_path.is_relative() {
                let mut config_db_dir = location
                    .as_ref()
                    .parent()
                    //safe to call unwrap in the below cases as the current dir exists and if config was opened there are permissions on the current dir
                    .unwrap_or(&std::env::current_dir().unwrap())
                    .to_path_buf();

                config_db_dir = fs::canonicalize(config_db_dir).unwrap();
                config_db_path = config_db_dir.join(&config_db_path)
            }

            let config_db_path = config_db_path.into_os_string().into_string().map_err(|_| {
                Error::ConfigError("sqlite db file location must be a valid utf-8 string".into())
            })?;
            config.main.db_path = Some(config_db_path);
        }

        Ok(config)
    }

    pub fn get_db_type(&self) -> ConfigDbType {
        self.main.db_type
    }

    pub fn set_db_user(self, db_user: &str) -> Config {
        Config {
            main: Main {
                db_user: Some(db_user.into()),
                ..self.main
            },
        }
    }

    pub fn set_db_pass(self, db_pass: &str) -> Config {
        Config {
            main: Main {
                db_pass: Some(db_pass.into()),
                ..self.main
            },
        }
    }

    pub fn set_db_path(self, db_path: &str) -> Config {
        Config {
            main: Main {
                db_path: Some(db_path.into()),
                ..self.main
            },
        }
    }

    pub fn set_db_host(self, db_host: &str) -> Config {
        Config {
            main: Main {
                db_host: Some(db_host.into()),
                ..self.main
            },
        }
    }

    pub fn set_db_port(self, db_port: &str) -> Config {
        Config {
            main: Main {
                db_port: Some(db_port.into()),
                ..self.main
            },
        }
    }

    pub fn set_db_name(self, db_name: &str) -> Config {
        Config {
            main: Main {
                db_name: Some(db_name.into()),
                ..self.main
            },
        }
    }
}

#[derive(Serialize, Deserialize, Debug)]
pub struct Main {
    db_type: ConfigDbType,
    db_path: Option<String>,
    db_host: Option<String>,
    db_port: Option<String>,
    db_user: Option<String>,
    db_pass: Option<String>,
    db_name: Option<String>,
}

#[cfg(any(
    feature = "mysql",
    feature = "postgres",
    feature = "postgres-previous",
    feature = "mysql_async",
    feature = "tokio-postgres"
))]
fn build_db_url(name: &str, config: &Config) -> String {
    let mut url: String = name.to_string() + "://";

    if let Some(user) = &config.main.db_user {
        url = url + &user;
    }
    if let Some(pass) = &config.main.db_pass {
        url = url + ":" + &pass;
    }
    if let Some(host) = &config.main.db_host {
        if config.main.db_user.is_some() {
            url = url + "@" + &host;
        } else {
            url = url + &host;
        }
    }
    if let Some(port) = &config.main.db_port {
        url = url + ":" + &port;
    }
    if let Some(name) = &config.main.db_name {
        url = url + "/" + name;
    }
    url
}

/// migrates from a given config file location
/// use this function if you prefer to generate a config file either from refinery_cli or by hand,
/// and migrate without having to pass a database Connection
/// # Panics
///
/// This function panics if refinery was not built with database driver support for the target database,
/// eg trying to migrate a PostgresSQL without feature postgres enabled.
#[cfg(feature = "sync")]
pub fn migrate_from_config(
    config: &Config,
    grouped: bool,
    divergent: bool,
    missing: bool,
    migrations: &[Migration],
) -> Result<(), Error> {
    match config.main.db_type {
        ConfigDbType::Mysql => {
            cfg_if::cfg_if! {
                if #[cfg(feature = "mysql")] {
                    let url = build_db_url("mysql", &config);
                    let mut connection = MysqlConnection::new(&url).migration_err("could not connect to database")?;
                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run(&mut connection)?;
                } else {
                    panic!("tried to migrate from config for a mysql database, but feature mysql not enabled!");
                }
            }
        }
        ConfigDbType::Sqlite => {
            cfg_if::cfg_if! {
                if #[cfg(feature = "rusqlite")] {
                    //may have been checked earlier on config parsing, even if not let it fail with a Rusqlite db file not found error
                    let path = config.main.db_path.as_ref().cloned().unwrap_or_default();
                    let mut connection = RqlConnection::open_with_flags(path, OpenFlags::SQLITE_OPEN_READ_WRITE).migration_err("could not open database")?;
                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run(&mut connection)?;
                } else {
                    panic!("tried to migrate from config for a sqlite database, but feature rusqlite not enabled!");
                }
            }
        }
        ConfigDbType::Postgres => {
            cfg_if::cfg_if! {
                if #[cfg(feature = "postgres")] {
                    let path = build_db_url("postgresql", &config);
                    let mut connection = PgClient::connect(path.as_str(), postgres::NoTls).migration_err("could not connect to database")?;
                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run(&mut connection)?;
                } else if #[cfg(feature = "postgres-previous")] {
                    let path = build_db_url("postgresql", &config);
                    let mut connection = PgConnection::connect(path.as_str(), postgres_previous::TlsMode::None).migration_err("could not connect to database")?;
                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run(&mut connection)?;
                } else {
                    panic!("tried to migrate from config for a postgresql database, but feature postgres not enabled!");
                }
            }
        }
    }
    Ok(())
}

/// migrates from a given config file location
/// use this function if you prefer to generate a config file either from refinery_cli or by hand,
/// and migrate without having to pass a database Connection
/// # Panics
///
/// This function panics if refinery was not built with database driver support for the target database,
/// eg trying to migrate a PostgresSQL without feature postgres enabled.
#[cfg(feature = "async")]
pub async fn migrate_from_config_async(
    config: &Config,
    grouped: bool,
    divergent: bool,
    missing: bool,
    migrations: &[Migration],
) -> Result<(), Error> {
    match config.main.db_type {
        ConfigDbType::Mysql => {
            cfg_if::cfg_if! {
                if #[cfg(feature = "mysql_async")] {
                    let url = build_db_url("mysql", &config);
                    let mut pool = MysqlAsyncPool::from_url(&url).migration_err("could not connect to the database")?;
                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run_async(&mut pool).await?;
                } else {
                    panic!("tried to migrate async from config for a mysql database, but feature mysql_async not enabled!");
                }
            }
        }
        ConfigDbType::Sqlite => {
            panic!("tried to migrate async from config for a sqlite database, but this feature is not implemented yet");
        }
        ConfigDbType::Postgres => {
            cfg_if::cfg_if! {
                if #[cfg(feature = "tokio-postgres")] {
                    let path = build_db_url("postgresql", &config);
                    let (mut client, connection ) = tokio_postgres::connect(path.as_str(), tokio_postgres::NoTls).await.migration_err("could not connect to database")?;
                    tokio::spawn(async move {
                        if let Err(e) = connection.await {
                            eprintln!("connection error: {}", e);
                        }
                    });

                    Runner::new(migrations).set_grouped(grouped).set_abort_divergent(divergent).set_abort_missing(missing).run_async(&mut client).await?;
                } else {
                    panic!("tried to migrate async from config for a postgresql database, but feature tokio-postgres not enabled!");
                }
            }
        }
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::{build_db_url, Config, Error};
    use std::io::Write;

    #[test]
    fn returns_config_error_from_invalid_config_location() {
        let config = Config::from_file_location("invalid_path").unwrap_err();
        match config {
            Error::ConfigError(msg) => assert!(msg.contains("could not open config file")),
            _ => panic!("test failed"),
        }
    }

    #[test]
    fn returns_config_error_from_invalid_toml_file() {
        let config = "[<$%
                     db_type = \"Sqlite\" \n";

        let mut config_file = tempfile::NamedTempFile::new_in(".").unwrap();
        config_file.write_all(config.as_bytes()).unwrap();
        let config = Config::from_file_location(config_file.path()).unwrap_err();
        match config {
            Error::ConfigError(msg) => assert!(msg.contains("could not parse config file")),
            _ => panic!("test failed"),
        }
    }

    #[test]
    fn returns_config_error_from_sqlite_with_missing_path() {
        let config = "[main] \n
                     db_type = \"Sqlite\" \n";

        let mut config_file = tempfile::NamedTempFile::new_in(".").unwrap();
        config_file.write_all(config.as_bytes()).unwrap();
        let config = Config::from_file_location(config_file.path()).unwrap_err();
        match config {
            Error::ConfigError(msg) => {
                assert_eq!("field path must be present for Sqlite database type", msg)
            }
            _ => panic!("test failed"),
        }
    }

    #[test]
    fn builds_sqlite_path_from_relative_path() {
        let config = "[main] \n
                     db_type = \"Sqlite\" \n
                     db_path = \"./refinery.db\"";

        let mut config_file = tempfile::NamedTempFile::new_in(".").unwrap();
        config_file.write_all(config.as_bytes()).unwrap();
        let config = Config::from_file_location(config_file.path()).unwrap();
        let parent = config_file.path().parent().unwrap();
        assert!(parent.is_dir());
        assert_eq!(
            parent.join("./refinery.db").to_str().unwrap(),
            config.main.db_path.unwrap()
        );
    }

    #[test]
    fn builds_db_url() {
        let config = "[main] \n
                     db_type = \"Postgres\" \n
                     db_host = \"localhost\" \n
                     db_port = \"5432\" \n
                     db_user = \"root\" \n
                     db_pass = \"1234\" \n
                     db_name = \"refinery\"";

        let config: Config = toml::from_str(&config).unwrap();

        assert_eq!(
            "postgres://root:1234@localhost:5432/refinery",
            build_db_url("postgres", &config)
        );
    }
}