pgtemp 0.7.1

Start local postgres servers for testing without Docker
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

//! Basic startup/shutdown tests

use pgtemp::{PgTempDB, PgTempDBBuilder};
use std::{io::Write, os::unix::fs::OpenOptionsExt};
use tempfile::TempDir;

#[test]
/// We can bring up a temp db and its data directory is gone after dropping it.
fn test_tempdb_bringup_shutdown() {
    let db = PgTempDB::new();
    let data_dir = db.data_dir().clone();
    let conf_file = data_dir.join("postgresql.conf");

    assert!(conf_file.exists());

    drop(db);

    assert!(!conf_file.exists());
}

#[test]
/// Calling shutdown is the same as drop
fn test_tempdb_shutdown_consumes() {
    let db = PgTempDB::new();
    let data_dir = db.data_dir().clone();
    let conf_file = data_dir.join("postgresql.conf");

    assert!(conf_file.exists());

    db.shutdown();

    assert!(!conf_file.exists());
}

#[tokio::test]
/// Async version of tempdb_bringup_shutdown
async fn test_tempdb_bringup_shutdown_async() {
    let db = PgTempDB::async_new().await;
    let data_dir = db.data_dir().clone();
    let conf_file = data_dir.join("postgresql.conf");

    assert!(conf_file.exists());

    drop(db);

    assert!(!conf_file.exists());
}

#[test]
/// We can bring up a temp db and its data directory is saved when enabling the persist flag.
fn test_tempdb_bringup_shutdown_persist() {
    let temp = tempfile::tempdir().unwrap(); // just so we don't have to manually clean up at the
                                             // end of the test
    let db = PgTempDB::builder()
        .persist_data(true)
        .with_data_dir_prefix(temp.path())
        .start();
    let data_dir = db.data_dir().clone();
    let conf_file = data_dir.join("postgresql.conf");

    assert!(conf_file.exists());

    drop(db);

    assert!(conf_file.exists());
}

#[test]
#[should_panic(expected = "this is not initdb")]
/// Start a database by specifying the bin_path
fn test_tempdb_bin_path() {
    use std::io::Write;
    use std::os::unix::fs::PermissionsExt;

    let bindir = tempfile::tempdir().unwrap();
    for name in ["initdb", "createdb", "postgres"] {
        let path = bindir.path().join(name);
        let mut f = std::fs::File::create(&path).unwrap();
        f.write_all(format!("#!/bin/sh\necho this is not {name}\nexit 1").as_bytes())
            .unwrap();
        let mut p = f.metadata().unwrap().permissions();
        p.set_mode(0o700);
        f.set_permissions(p).unwrap();
        f.sync_all().unwrap();
        drop(f);
    }
    let _db = PgTempDB::builder().with_bin_path(&bindir).start();
}

#[test]
fn test_slow_postgres_startup() {
    let temp_dir = TempDir::new().expect("Failed to create temp dir");
    let dir_path = temp_dir.path().to_owned();

    for cmd in ["postgres", "createdb", "psql", "initdb"] {
        let sleep_cmd = if cmd == "postgres" { "sleep 0.5" } else { "" };
        let exec_cmd = format!("exec {cmd} \"$@\"");
        let wrapper_binary = vec!["#!/bin/bash", sleep_cmd, exec_cmd.as_str()].join("\n");

        let wrapper_postgres_bin = dir_path.join(cmd);
        let mut file = std::fs::OpenOptions::new()
            .write(true)
            .create(true)
            .mode(0o755)
            .open(&wrapper_postgres_bin)
            .expect("Failed to create executable wrapper script");
        file.write_all(wrapper_binary.as_bytes())
            .expect("Failed to write script content");
    }

    let _db = PgTempDBBuilder::new()
        .with_bin_path(dir_path)
        .with_dbname("unique_db_name")
        .start();
}