docbox-database 0.11.1

Docbox database structures, logic, and migrations
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

use docbox_database::{
    DbPool,
    models::{
        document_box::DocumentBox,
        file::{CreateFile, File},
        folder::{CreateFolder, Folder},
        link::{CreateLink, Link},
        user::User,
    },
};
use uuid::Uuid;

pub mod database;

/// Make a test document box (and root folder) for test case with an
/// optional created by user
#[allow(unused)]
pub async fn make_test_document_box(
    db: &DbPool,
    scope: impl Into<String>,
    created_by: Option<String>,
) -> (DocumentBox, Folder) {
    let document_box = DocumentBox::create(db, scope.into()).await.unwrap();
    let root = Folder::create(
        db,
        CreateFolder {
            name: "Root".to_string(),
            document_box: document_box.scope.clone(),
            folder_id: None,
            created_by,
        },
    )
    .await
    .unwrap();

    (document_box, root)
}

/// Make a test folder
#[allow(unused)]
pub async fn make_test_folder(
    db: &DbPool,
    parent: &Folder,
    name: impl Into<String>,
    created_by: Option<String>,
) -> Folder {
    Folder::create(
        db,
        CreateFolder {
            name: name.into(),
            document_box: parent.document_box.clone(),
            folder_id: Some(parent.id),
            created_by,
        },
    )
    .await
    .unwrap()
}

/// Make a test link
#[allow(unused)]
pub async fn make_test_link(
    db: &DbPool,
    parent: &Folder,
    name: impl Into<String>,
    created_by: Option<String>,
) -> Link {
    Link::create(
        db,
        CreateLink {
            name: name.into(),
            // Random UUID value to ensure the value is captured from the DB properly
            // for testing asserts
            value: Uuid::new_v4().to_string(),
            folder_id: parent.id,
            created_by,
        },
    )
    .await
    .unwrap()
}

/// Make a test link
#[allow(unused)]
pub async fn make_test_file(
    db: &DbPool,
    parent: &Folder,
    name: impl Into<String>,
    created_by: Option<String>,
) -> File {
    File::create(
        db,
        CreateFile {
            id: Uuid::new_v4(),
            name: name.into(),
            folder_id: parent.id,
            created_by,
            ..Default::default()
        },
    )
    .await
    .unwrap()
}

/// Make a test link
#[allow(unused)]
pub async fn make_test_file_type(
    db: &DbPool,
    parent: &Folder,
    name: impl Into<String>,
    mime: impl Into<String>,
    created_by: Option<String>,
) -> File {
    File::create(
        db,
        CreateFile {
            id: Uuid::new_v4(),
            name: name.into(),
            folder_id: parent.id,
            created_by,
            mime: mime.into(),
            ..Default::default()
        },
    )
    .await
    .unwrap()
}

/// Make a test user
#[allow(unused)]
pub async fn make_test_user(db: &DbPool, name: impl Into<String>) -> User {
    User::store(
        db,
        Uuid::new_v4().to_string(),
        Some(name.into()),
        Some("image.png".to_string()),
    )
    .await
    .unwrap()
}