pg-embed 1.0.0

Run a Postgresql database locally on Linux, MacOS or Windows as part of another Rust application or test.
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
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

use std::time::Duration;

use env_logger::Env;
use futures::stream::StreamExt;
use serial_test::file_serial;
use tempfile::TempDir;
use tokio::sync::Mutex;

use pg_embed::pg_access::PgAccess;
use pg_embed::pg_enums::{PgAuthMethod, PgServerStatus};
use pg_embed::pg_errors::{Error, Result};
use pg_embed::pg_fetch::{PgFetchSettings, PG_V17, PostgresVersion};
use pg_embed::postgres::{PgEmbed, PgSettings};

#[path = "common.rs"]
mod common;

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn start_stop() -> Result<()> {
    let (_dir, mut pg) = common::setup_with_tempdir(5432, false, None).await?;
    {
        let server_status = *pg.server_status.lock().await;
        assert_eq!(server_status, PgServerStatus::Initialized);
    }

    pg.start_db().await?;
    {
        let server_status = *pg.server_status.lock().await;
        assert_eq!(server_status, PgServerStatus::Started);
    }

    pg.stop_db().await?;
    {
        let server_status = *pg.server_status.lock().await;
        assert_eq!(server_status, PgServerStatus::Stopped);
    }

    Ok(())
}

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn server_drop() -> Result<()> {
    // dir declared before the inner scope so it outlives pg
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let db_path = dir.path().join("db");
    {
        let mut pg = common::setup(5432, db_path.clone(), false, None).await?;
        pg.start_db().await?;
        assert!(PgAccess::pg_version_file_exists(&db_path).await?);
    } // pg drops here: stop_db_sync + clean() remove db_path
    assert!(!PgAccess::pg_version_file_exists(&db_path).await?);
    Ok(())
}

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn multiple_concurrent() -> Result<()> {
    PgAccess::purge().await?;

    // TempDirs declared before pgs so they outlive PgEmbed instances
    let dir1 = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let dir2 = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;

    let tasks = vec![
        common::setup(5432, dir1.path().join("db"), false, None),
        common::setup(5434, dir2.path().join("db"), false, None),
    ];

    let pgs: Vec<Mutex<PgEmbed>> = futures::future::join_all(tasks)
        .await
        .into_iter()
        .map(|r| r.map(Mutex::new))
        .collect::<Result<Vec<_>>>()?;

    futures::stream::iter(&pgs)
        .for_each_concurrent(None, |pg| async move {
            let mut pg = pg.lock().await;
            pg.start_db().await.expect("start_db failed");
            {
                let server_status = *pg.server_status.lock().await;
                assert_eq!(server_status, PgServerStatus::Started);
            }
        })
        .await;

    futures::stream::iter(&pgs)
        .for_each_concurrent(None, |pg| async move {
            let mut pg = pg.lock().await;
            pg.stop_db().await.expect("stop_db failed");
            {
                let server_status = *pg.server_status.lock().await;
                assert_eq!(server_status, PgServerStatus::Stopped);
            }
        })
        .await;

    Ok(())
}

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn persistent_true() -> Result<()> {
    let (_dir, pg) = common::setup_with_tempdir(5432, true, None).await?;
    let database_dir = pg.pg_access.database_dir.clone();
    let pw_file_path = pg.pg_access.pw_file_path.clone();

    assert!(PgAccess::pg_version_file_exists(&database_dir).await?);

    drop(pg); // persistent=true: no cleanup on drop

    assert!(PgAccess::pg_version_file_exists(&database_dir).await?);

    PgAccess::clean_up(database_dir.clone(), pw_file_path).await?;

    assert!(!PgAccess::pg_version_file_exists(&database_dir).await?);

    Ok(())
}

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn persistent_false() -> Result<()> {
    // dir declared before inner scope so it outlives _pg
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let db_path = dir.path().join("db");
    {
        let _pg = common::setup(5432, db_path.clone(), false, None).await?;
        assert!(PgAccess::pg_version_file_exists(&db_path).await?);
    } // _pg drops: clean() removes db_path
    assert!(!PgAccess::pg_version_file_exists(&db_path).await?);

    Ok(())
}

/// Verify that a persistent cluster is reused by a second `PgEmbed` on the same
/// directory: `setup()` detects the existing `PG_VERSION` file and skips `initdb`.
#[tokio::test]
#[file_serial(pg_port_5432)]
async fn cluster_reuse() -> Result<()> {
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let db_path = dir.path().join("db");

    // First lifecycle — create and start with persistent=true
    {
        let mut pg = common::setup(5432, db_path.clone(), true, None).await?;
        pg.start_db().await?;
        pg.stop_db().await?;
    } // drop: persistent=true, so no cleanup

    // Cluster files survive the drop
    assert!(PgAccess::pg_version_file_exists(&db_path).await?);

    // Second lifecycle — reuse the existing cluster
    {
        let mut pg = common::setup(5432, db_path.clone(), true, None).await?;
        // setup() should have detected the existing cluster and set Initialized
        {
            let server_status = *pg.server_status.lock().await;
            assert_eq!(server_status, PgServerStatus::Initialized);
        }
        pg.start_db().await?;
        {
            let server_status = *pg.server_status.lock().await;
            assert_eq!(server_status, PgServerStatus::Started);
        }
        pg.stop_db().await?;
        // Manual cleanup since persistent=true
        PgAccess::clean_up(db_path.clone(), pg.pg_access.pw_file_path.clone()).await?;
    }

    assert!(!PgAccess::pg_version_file_exists(&db_path).await?);
    Ok(())
}

#[tokio::test]
#[file_serial(pg_port_5432)]
async fn server_timeout() -> Result<()> {
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let _ = env_logger::Builder::from_env(Env::default().default_filter_or("info"))
        .is_test(true)
        .try_init();
    let pg_settings = PgSettings {
        database_dir: dir.path().join("db"),
        port: 5432,
        user: "postgres".to_string(),
        password: "password".to_string(),
        auth_method: PgAuthMethod::MD5,
        persistent: false,
        timeout: Some(Duration::from_secs(10)),
        migration_dir: None,
    };
    let fetch_settings = PgFetchSettings {
        version: PG_V17,
        ..Default::default()
    };
    let mut pg = PgEmbed::new(pg_settings, fetch_settings).await?;
    pg.setup().await?;
    pg.pg_settings.timeout = Some(Duration::from_millis(10));
    let res = pg.start_db().await.err();
    assert_eq!(Some(Error::PgTimedOutError), res);

    Ok(())
}

/// Verify that `timeout: None` allows the server to start without an enforced deadline.
#[tokio::test]
#[file_serial(pg_port_5432)]
async fn timeout_none() -> Result<()> {
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let pg_settings = PgSettings {
        database_dir: dir.path().join("db"),
        port: 5432,
        user: "postgres".to_string(),
        password: "password".to_string(),
        auth_method: PgAuthMethod::MD5,
        persistent: false,
        timeout: None,
        migration_dir: None,
    };
    let fetch_settings = PgFetchSettings { version: PG_V17, ..Default::default() };
    let mut pg = PgEmbed::new(pg_settings, fetch_settings).await?;
    pg.setup().await?;
    pg.start_db().await?;
    {
        let server_status = *pg.server_status.lock().await;
        assert_eq!(server_status, PgServerStatus::Started);
    }
    pg.stop_db().await?;
    Ok(())
}

/// Verify that an unreachable Maven host produces `Error::DownloadFailure`.
#[tokio::test]
async fn download_failure() -> Result<()> {
    let dir = TempDir::new().map_err(|e| Error::DirCreationError(e.to_string()))?;
    let fetch_settings = PgFetchSettings {
        // Port 19999 is almost certainly not listening; use a non-existent version
        // so cached binaries are never found.
        host: "http://127.0.0.1:19999".to_string(),
        version: PostgresVersion("99.0.0"),
        ..Default::default()
    };
    let pg_settings = PgSettings {
        database_dir: dir.path().join("db"),
        port: 5499,
        user: "postgres".to_string(),
        password: "password".to_string(),
        auth_method: PgAuthMethod::MD5,
        persistent: false,
        timeout: Some(Duration::from_secs(10)),
        migration_dir: None,
    };
    let mut pg = PgEmbed::new(pg_settings, fetch_settings).await?;
    let result = pg.setup().await;
    assert!(matches!(result, Err(Error::DownloadFailure(_))));
    Ok(())
}