socle 3.0.0

Opinionated axum service bootstrap: telemetry, database, rate limiting, and shutdown in one builder
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

use sqlx::PgPool;
use testcontainers::ContainerAsync;
use testcontainers_modules::postgres::Postgres;

/// A running Postgres Docker container. The container is stopped and removed when this struct is dropped.
///
/// # Examples
///
/// ```rust,no_run
/// # #[cfg(feature = "testing-postgres")]
/// # mod example {
/// use socle::testing::postgres::EphemeralPostgres;
///
/// #[tokio::test]
/// async fn with_real_database() {
///     let pg = EphemeralPostgres::start().await;
///     let pool = pg.pool().await;
///     let (n,): (i64,) = sqlx::query_as("SELECT 1").fetch_one(&pool).await.unwrap();
///     assert_eq!(n, 1);
/// }
/// # }
/// ```
pub struct EphemeralPostgres {
    _container: ContainerAsync<Postgres>,
    connection_url: String,
}

impl EphemeralPostgres {
    /// Pull (if needed) and start a Postgres 16 container on a random host port.
    pub async fn start() -> Self {
        use testcontainers::runners::AsyncRunner;

        let container = Postgres::default()
            .start()
            .await
            .expect("failed to start Postgres container");

        let host_port = container
            .get_host_port_ipv4(5432)
            .await
            .expect("failed to get mapped port");

        let connection_url = format!("postgres://postgres:postgres@127.0.0.1:{host_port}/postgres");

        Self {
            _container: container,
            connection_url,
        }
    }

    /// Return the Postgres connection URL for this container.
    pub fn connection_url(&self) -> &str {
        &self.connection_url
    }

    /// Open a `sqlx` connection pool to this container.
    pub async fn pool(&self) -> PgPool {
        PgPool::connect(&self.connection_url)
            .await
            .expect("failed to connect to ephemeral Postgres")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    #[ignore]
    async fn start_pool_select_one() {
        let pg = EphemeralPostgres::start().await;
        let pool = pg.pool().await;
        let row: (i64,) = sqlx::query_as("SELECT 1").fetch_one(&pool).await.unwrap();
        assert_eq!(row.0, 1);
    }
}