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
use futures::{TryFutureExt};
use std::process::{Command, Child};
use crate::fetch;
use crate::errors::PgEmbedError;
#[cfg(any(feature = "rt_tokio", feature = "rt_tokio_migrate"))]
use tokio::io::AsyncWriteExt;
use crate::errors::PgEmbedError::PgCleanUpFailure;
#[cfg(feature = "rt_tokio_migrate")]
use sqlx_tokio::{Postgres};
use std::time::Duration;
#[cfg(any(feature = "rt_tokio", feature = "rt_tokio_migrate"))]
use tokio::time::sleep;
#[cfg(feature = "rt_tokio_migrate")]
use sqlx_tokio::migrate::{Migrator, MigrateDatabase};
use std::path::PathBuf;
pub struct PgSettings {
pub executables_dir: PathBuf,
pub database_dir: PathBuf,
pub port: i16,
pub user: String,
pub password: String,
pub auth_method: PgAuthMethod,
pub persistent: bool,
pub start_timeout: Duration,
pub migration_dir: Option<PathBuf>,
}
pub enum PgAuthMethod {
Plain,
MD5,
ScramSha256,
}
pub struct PgEmbed {
pub pg_settings: PgSettings,
pub fetch_settings: fetch::FetchSettings,
pub process: Option<Child>,
pub db_uri: String,
}
impl Drop for PgEmbed {
fn drop(&mut self) {
let _ = &self.stop_db();
if !&self.pg_settings.persistent {
let _ = &self.clean();
}
}
}
impl PgEmbed {
pub fn new(pg_settings: PgSettings, fetch_settings: fetch::FetchSettings) -> Self {
let password: &str = &pg_settings.password;
let db_uri = format!(
"postgres://{}:{}@localhost:{}",
&pg_settings.user,
&password,
&pg_settings.port
);
PgEmbed {
pg_settings,
fetch_settings,
process: None,
db_uri,
}
}
pub fn clean(&self) -> Result<(), PgEmbedError> {
let exec_dir = self.pg_settings.executables_dir.to_str().unwrap();
let bin_dir = format!("{}/bin", exec_dir);
let lib_dir = format!("{}/lib", exec_dir);
let share_dir = format!("{}/share", exec_dir);
let pw_file = format!("{}/pwfile", exec_dir);
std::fs::remove_dir_all(&self.pg_settings.database_dir).map_err(|e| PgCleanUpFailure(e))?;
std::fs::remove_dir_all(bin_dir).map_err(|e| PgCleanUpFailure(e))?;
std::fs::remove_dir_all(lib_dir).map_err(|e| PgCleanUpFailure(e))?;
std::fs::remove_dir_all(share_dir).map_err(|e| PgCleanUpFailure(e))?;
std::fs::remove_file(pw_file).map_err(|e| PgCleanUpFailure(e))?;
Ok(())
}
pub async fn setup(&self) -> Result<(), PgEmbedError> {
&self.aquire_postgres().await?;
&self.create_password_file().await?;
&self.init_db().await?;
Ok(())
}
pub async fn aquire_postgres(&self) -> Result<(), PgEmbedError> {
let pg_file = fetch::fetch_postgres(&self.fetch_settings, &self.pg_settings.executables_dir).await?;
fetch::unpack_postgres(&pg_file, &self.pg_settings.executables_dir).await
}
pub async fn init_db(&self) -> Result<bool, PgEmbedError> {
let database_path = self.pg_settings.database_dir.as_path();
if !database_path.is_dir() {
let init_db_executable = format!("{}/bin/initdb", &self.pg_settings.executables_dir.to_str().unwrap());
let password_file_arg = format!("--pwfile={}/pwfile", &self.pg_settings.executables_dir.to_str().unwrap());
let auth_host =
match &self.pg_settings.auth_method {
PgAuthMethod::Plain => {
"password"
}
PgAuthMethod::MD5 => {
"md5"
}
PgAuthMethod::ScramSha256 => {
"scram-sha-256"
}
};
Command::new(init_db_executable).args(&[
"-A",
auth_host,
"-U",
&self.pg_settings.user,
"-D",
&self.pg_settings.database_dir.to_str().unwrap(),
&password_file_arg,
]).spawn().map_err(|e| PgEmbedError::PgInitFailure(e))?;
sleep(self.pg_settings.start_timeout).await;
Ok(true)
} else {
Ok(false)
}
}
pub async fn start_db(&mut self) -> Result<(), PgEmbedError> {
let pg_ctl_executable = format!("{}/bin/pg_ctl", &self.pg_settings.executables_dir.to_str().unwrap());
let port_arg = format!("-F -p {}", &self.pg_settings.port.to_string());
let process = Command::new(
pg_ctl_executable,
)
.args(&[
"-o", &port_arg, "start", "-w", "-D", &self.pg_settings.database_dir.to_str().unwrap()
])
.spawn().map_err(|e| PgEmbedError::PgStartFailure(e))?;
self.process = Some(process);
sleep(self.pg_settings.start_timeout).await;
Ok(())
}
pub fn stop_db(&mut self) -> Result<(), PgEmbedError> {
let pg_ctl_executable = format!("{}/bin/pg_ctl", &self.pg_settings.executables_dir.to_str().unwrap());
let mut process = Command::new(
pg_ctl_executable,
)
.args(&[
"stop", "-w", "-D", &self.pg_settings.database_dir.to_str().unwrap(),
])
.spawn().map_err(|e| PgEmbedError::PgStopFailure(e))?;
match process.try_wait() {
Ok(Some(status)) => {
println!("postgresql stopped");
self.process = None;
Ok(())
}
Ok(None) => {
println!("... waiting for postgresql to stop");
let res = process.wait();
println!("result: {:?}", res);
Ok(())
}
Err(e) => Err(PgEmbedError::PgStopFailure(e)),
}
}
pub async fn create_password_file(&self) -> Result<(), PgEmbedError> {
let mut file_path = self.pg_settings.executables_dir.clone();
file_path.push("pwfile");
let mut file: tokio::fs::File = tokio::fs::File::create(&file_path.as_path()).map_err(|e| PgEmbedError::WriteFileError(e)).await?;
let _ = file
.write(&self.pg_settings.password.as_bytes()).map_err(|e| PgEmbedError::WriteFileError(e))
.await?;
Ok(())
}
#[cfg(any(feature = "rt_tokio_migrate", feature = "rt_async_std_migrate", feature = "rt_actix_migrate"))]
pub async fn create_database(&self, db_name: &str) -> Result<(), PgEmbedError> {
Postgres::create_database(&self.full_db_uri(db_name)).await?;
Ok(())
}
#[cfg(any(feature = "rt_tokio_migrate", feature = "rt_async_std_migrate", feature = "rt_actix_migrate"))]
pub async fn drop_database(&self, db_name: &str) -> Result<(), PgEmbedError> {
Postgres::drop_database(&self.full_db_uri(db_name)).await?;
Ok(())
}
#[cfg(any(feature = "rt_tokio_migrate", feature = "rt_async_std_migrate", feature = "rt_actix_migrate"))]
pub async fn database_exists(&self, db_name: &str) -> Result<bool, PgEmbedError> {
let result = Postgres::database_exists(&self.full_db_uri(db_name)).await?;
Ok(result)
}
pub fn full_db_uri(&self, db_name: &str) -> String {
format!("{}/{}", &self.db_uri, db_name)
}
#[cfg(any(feature = "rt_tokio_migrate", feature = "rt_async_std_migrate", feature = "rt_actix_migrate"))]
pub async fn migrate(&self, db_name: &str) -> Result<(), PgEmbedError> {
if let Some(migration_dir) = &self.pg_settings.migration_dir {
let m = Migrator::new(std::path::Path::new(migration_dir)).await?;
let pool = sqlx_tokio::postgres::PgPoolOptions::new().connect(&self.full_db_uri(db_name)).await?;
m.run(&pool).await?;
}
Ok(())
}
}