rorm-cli 0.9.0

The cli tool for managing rorm applications.
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

use std::fmt::Debug;
use std::fs::{read_to_string, File};
use std::io::Write;
use std::path::Path;

use anyhow::Context;
use rorm_declaration::config::DatabaseConfig;
use serde::{Deserialize, Serialize};

/// Outer wrapper for the database configuration file.
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "PascalCase")]
pub struct DatabaseConfigFile {
    pub database: DatabaseConfig,
}

const EXAMPLE_DATABASE_CONFIG: &str = r#"
# Example database configuration for each supported database.
# Uncomment the database you'd like to use.

[Database]
# -------------------------------
# Example SQLite configuration
# -------------------------------
Driver = "SQLite"
 
# Filename / path of the sqlite database 
Filename = ""

# -------------------------------
# Example MySQL configuration
# -------------------------------
# Driver = "MySQL"
# Name = "dbname"
# Host = "127.0.0.1"
# Port = 3306
# User = "dbuser"
# Password = "super-secure-password"

# -------------------------------
# Example Postgres configuration
# -------------------------------
# Driver = "Postgres"
# Name = "dbname"
# Host = "127.0.0.1"
# Port = 5432
# User = "dbuser"
# Password = "super-secure-password"
"#;

#[cfg(test)]
mod test {
    use crate::migrate::config::{DatabaseConfigFile, EXAMPLE_DATABASE_CONFIG};

    #[test]
    fn test_example_database_config() {
        let db_conf = toml::from_str::<DatabaseConfigFile>(EXAMPLE_DATABASE_CONFIG);
        assert!(db_conf.is_ok());
    }
}

/// Helper method to create a dummy database configuration file
pub(crate) fn create_db_config(path: &Path) -> anyhow::Result<()> {
    let fh = File::create(path).with_context(|| format!("Couldn't open {path:?} for writing"))?;

    writeln!(&fh, "{EXAMPLE_DATABASE_CONFIG}").with_context(|| {
        format!("Couldn't write serialized database configuration to {path:?}",)
    })?;

    Ok(())
}

/// Helper method to deserialize an existing database configuration file
///
/// - `path`: [`&Path`](Path): Path to the configuration file
pub fn deserialize_db_conf(path: &Path) -> anyhow::Result<DatabaseConfig> {
    let db_conf_toml =
        read_to_string(path).with_context(|| "Couldn't read database configuration file")?;

    let db_conf = toml::from_str::<DatabaseConfigFile>(db_conf_toml.as_str())
        .with_context(|| "Couldn't deserialize database configuration file")?
        .database;

    Ok(db_conf)
}