sqlx-cli 0.9.0

Command-line utility for SQLx, the Rust SQL toolkit.
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

use assert_cmd::{assert::Assert, Command};

use sqlx::_unstable::config::Config;
use sqlx::{migrate::Migrate, Connection, SqliteConnection};
use std::{
    env, fs,
    path::{Path, PathBuf},
};

pub struct TestDatabase {
    file_path: PathBuf,
    migrations_path: PathBuf,
    pub config_path: Option<PathBuf>,
}

pub enum MigrateCommand {
    Run,
    Revert,
    Skip,
}

impl AsRef<str> for MigrateCommand {
    fn as_ref(&self) -> &str {
        match self {
            MigrateCommand::Run => "run",
            MigrateCommand::Revert => "revert",
            MigrateCommand::Skip => "override skip",
        }
    }
}

impl TestDatabase {
    pub fn new(name: &str, migrations: &str) -> Self {
        // Note: only set when _building_
        let temp_dir = option_env!("CARGO_TARGET_TMPDIR").map_or_else(env::temp_dir, PathBuf::from);

        let test_dir = temp_dir.join("migrate");

        fs::create_dir_all(&test_dir)
            .unwrap_or_else(|e| panic!("error creating directory: {test_dir:?}: {e}"));

        let file_path = test_dir.join(format!("test-{name}.db"));

        if file_path.exists() {
            fs::remove_file(&file_path)
                .unwrap_or_else(|e| panic!("error deleting test database {file_path:?}: {e}"));
        }

        let this = Self {
            file_path,
            migrations_path: Path::new("tests").join(migrations),
            config_path: None,
        };

        Command::cargo_bin("cargo-sqlx")
            .unwrap()
            .args([
                "sqlx",
                "database",
                "create",
                "--database-url",
                &this.connection_string(),
            ])
            .assert()
            .success();
        this
    }

    pub fn set_migrations(&mut self, migrations: &str) {
        self.migrations_path = Path::new("tests").join(migrations);
    }

    pub fn connection_string(&self) -> String {
        format!("sqlite://{}", self.file_path.display())
    }

    pub fn run_migration(
        &self,
        migrate_command: MigrateCommand,
        version: Option<i64>,
        dry_run: bool,
    ) -> Assert {
        let mut command = Command::cargo_bin("sqlx").unwrap();
        command
            .arg("migrate")
            .args(migrate_command.as_ref().split_whitespace())
            .args(["--database-url", &self.connection_string(), "--source"])
            .arg(&self.migrations_path);

        if let Some(config_path) = &self.config_path {
            command.arg("--config").arg(config_path);
        }

        if let Some(version) = version {
            command.arg("--target-version").arg(version.to_string());
        }

        if dry_run {
            command.arg("--dry-run");
        }

        command.assert()
    }

    pub async fn applied_migrations(&self) -> Vec<i64> {
        let mut conn = SqliteConnection::connect(&self.connection_string())
            .await
            .unwrap();

        let config = Config::default();

        conn.list_applied_migrations(config.migrate.table_name())
            .await
            .unwrap()
            .iter()
            .map(|m| m.version)
            .collect()
    }

    pub fn migrate_info(&self) -> Assert {
        let mut command = Command::cargo_bin("sqlx").unwrap();
        command
            .args([
                "migrate",
                "info",
                "--database-url",
                &self.connection_string(),
                "--source",
            ])
            .arg(&self.migrations_path);

        if let Some(config_path) = &self.config_path {
            command.arg("--config").arg(config_path);
        }

        command.assert()
    }
}

impl Drop for TestDatabase {
    fn drop(&mut self) {
        // Only remove the database if there isn't a failure.
        if !std::thread::panicking() {
            fs::remove_file(&self.file_path).unwrap_or_else(|e| {
                panic!("error deleting test database {:?}: {e}", self.file_path)
            });
        }
    }
}