docbox-core 0.13.2

Docbox core business logic and functionality
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

use docbox_database::migrations::{apply_root_migrations, initialize_root_migrations};
use docbox_database::{
    DbPool, PgConnectOptions, PgPoolOptions, migrations::force_apply_tenant_migrations,
};
use testcontainers::ImageExt;
use testcontainers_modules::testcontainers::runners::AsyncRunner;
use testcontainers_modules::{postgres::Postgres, testcontainers::ContainerAsync};

const TEST_DB_NAME: &str = "docbox_test";
const TEST_DB_USER: &str = "docbox";
const TEST_DB_PASSWORD: &str = "docbox";

pub async fn test_database_container() -> ContainerAsync<Postgres> {
    testcontainers_modules::postgres::Postgres::default()
        .with_db_name(TEST_DB_NAME)
        .with_user(TEST_DB_USER)
        .with_password(TEST_DB_PASSWORD)
        .with_tag("18.1-alpine")
        .start()
        .await
        .unwrap()
}

#[allow(dead_code)]
pub async fn test_database(container: &ContainerAsync<Postgres>) -> DbPool {
    let host_ip = container.get_host().await.unwrap();
    let host_port = container.get_host_port_ipv4(5432).await.unwrap();

    let options = PgConnectOptions::new()
        .host(&host_ip.to_string())
        .port(host_port)
        .username(TEST_DB_USER)
        .password(TEST_DB_PASSWORD)
        .database(TEST_DB_NAME)
        .ssl_mode(docbox_database::sqlx::postgres::PgSslMode::Disable);

    PgPoolOptions::new()
        .max_connections(100)
        .connect_with(options)
        .await
        .unwrap()
}

/// Testing utility to create and setup a database for a tenant to use in tests that
/// require database access
///
/// Requires that the test runner have docker available to launch the postgres
/// container that will be used
///
/// Marked with #[allow(dead_code)] as it is used by tests but
/// rustc doesn't believe us
#[allow(dead_code)]
pub async fn test_tenant_database(container: &ContainerAsync<Postgres>) -> DbPool {
    let db = test_database(container).await;
    let mut trans = db.begin().await.unwrap();
    force_apply_tenant_migrations(&mut trans, None)
        .await
        .unwrap();
    trans.commit().await.unwrap();
    db
}

/// Testing utility to create and setup a database for the root to use in tests that
/// require database access
///
/// Requires that the test runner have docker available to launch the postgres
/// container that will be used
///
/// Marked with #[allow(dead_code)] as it is used by tests but
/// rustc doesn't believe us
#[allow(dead_code)]
pub async fn test_root_database(container: &ContainerAsync<Postgres>) -> DbPool {
    let db = test_database(container).await;

    initialize_root_migrations(&db).await.unwrap();

    let mut trans = db.begin().await.unwrap();
    apply_root_migrations(&mut trans, None).await.unwrap();
    trans.commit().await.unwrap();
    db
}

/// Creates a test tenant level database
#[allow(dead_code)]
pub async fn test_tenant_db() -> (DbPool, ContainerAsync<Postgres>) {
    let db_container = test_database_container().await;
    let db = test_tenant_database(&db_container).await;

    (db, db_container)
}

/// Creates a test root level database
#[allow(dead_code)]
pub async fn test_root_db() -> (DbPool, ContainerAsync<Postgres>) {
    let db_container = test_database_container().await;
    let db = test_root_database(&db_container).await;

    (db, db_container)
}