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
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

use docbox_database::{models::document_box::DocumentBox, utils::DatabaseErrorExt};

use crate::common::database::test_tenant_db;

mod common;

/// Tests that a document box can be created
#[tokio::test]
async fn test_create_document_box() {
    let (db, _db_container) = test_tenant_db().await;
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    assert_eq!(document_box.scope.as_str(), "test");
}

/// Tests that the document box creation should fail when the scope is already
/// in use
#[tokio::test]
async fn test_create_document_box_duplicate_scope_failure() {
    let (db, _db_container) = test_tenant_db().await;
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    assert_eq!(document_box.scope.as_str(), "test");
    let error = DocumentBox::create(&db, "test".to_string())
        .await
        .unwrap_err();
    assert!(error.is_duplicate_record());
}

/// Tests that deleting a known document box affects a single row
#[tokio::test]
async fn test_delete_document_box_known() {
    let (db, _db_container) = test_tenant_db().await;
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    let result = document_box.delete(&db).await.unwrap();
    assert_eq!(result.rows_affected(), 1);
}

/// Tests that deleting a already deleted document box returns
/// zero affected rows
#[tokio::test]
async fn test_delete_document_box_deleted() {
    let (db, _db_container) = test_tenant_db().await;
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    let result = document_box.delete(&db).await.unwrap();
    assert_eq!(result.rows_affected(), 1);
    let result = document_box.delete(&db).await.unwrap();
    assert_eq!(result.rows_affected(), 0);
}

/// Tests that deleting a document box only deletes the expected document box
#[tokio::test]
async fn test_delete_document_box_exact() {
    let (db, _db_container) = test_tenant_db().await;
    DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    let result = document_box.delete(&db).await.unwrap();
    assert_eq!(result.rows_affected(), 1);
    let result = document_box.delete(&db).await.unwrap();
    assert_eq!(result.rows_affected(), 0);
}

/// Tests that a document box can be found when searching by scope
#[tokio::test]
async fn test_document_box_find_by_scope() {
    let (db, _db_container) = test_tenant_db().await;
    let document_box = DocumentBox::create(&db, "test".to_string()).await.unwrap();
    let result = DocumentBox::find_by_scope(&db, "test")
        .await
        .unwrap()
        .expect("should find document box");
    assert_eq!(result.scope, document_box.scope);
}

/// Tests that no document box should be found when search
/// for an unknown scope
#[tokio::test]
async fn test_document_box_find_by_scope_unknown() {
    let (db, _db_container) = test_tenant_db().await;
    DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    let result = DocumentBox::find_by_scope(&db, "test").await.unwrap();
    assert!(result.is_none());
}

/// Tests that the total number of document boxes can be
/// correctly obtained
#[tokio::test]
async fn test_document_box_total() {
    let (db, _db_container) = test_tenant_db().await;

    // Initial total should be zero
    let total = DocumentBox::total(&db).await.unwrap();
    assert_eq!(total, 0);

    // Single creation should increase total by one
    let document_box = DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    let total = DocumentBox::total(&db).await.unwrap();
    assert_eq!(total, 1);

    // Inserting results should increase total
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    DocumentBox::create(&db, "test3".to_string()).await.unwrap();

    let total = DocumentBox::total(&db).await.unwrap();
    assert_eq!(total, 3);

    // Deleting results should decrease total
    _ = document_box.delete(&db).await.unwrap();
    let total = DocumentBox::total(&db).await.unwrap();
    assert_eq!(total, 2);
}

/// Tests that the list of document boxes can be queried
#[tokio::test]
async fn test_document_box_query() {
    let (db, _db_container) = test_tenant_db().await;

    // Initial query result should be empty
    let results = DocumentBox::query(&db, 0, 5).await.unwrap();
    assert!(results.is_empty());

    // After inserting we should get back the results newest first
    DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    DocumentBox::create(&db, "test3".to_string()).await.unwrap();

    let results = DocumentBox::query(&db, 0, 5).await.unwrap();
    assert_eq!(results.len(), 3);
    assert_eq!(results[0].scope, "test3");
    assert_eq!(results[1].scope, "test2");
    assert_eq!(results[2].scope, "test1");

    // Pagination should work
    let results = DocumentBox::query(&db, 0, 2).await.unwrap();
    assert_eq!(results.len(), 2);
    assert_eq!(results[0].scope, "test3");
    assert_eq!(results[1].scope, "test2");
    let results = DocumentBox::query(&db, 2, 2).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].scope, "test1");

    let results = DocumentBox::query(&db, 3, 2).await.unwrap();
    assert!(results.is_empty());
}

/// Tests that a search query can be used to search for document boxes
#[tokio::test]
async fn test_document_box_search_query() {
    let (db, _db_container) = test_tenant_db().await;

    // Initial query result should be empty
    let results = DocumentBox::search_query(&db, "test", 0, 5).await.unwrap();
    assert!(results.is_empty());

    // Querying specific result
    DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    DocumentBox::create(&db, "test3".to_string()).await.unwrap();

    let results = DocumentBox::search_query(&db, "test3", 0, 5).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].scope, "test3");

    // Querying wildcard results
    let results = DocumentBox::search_query(&db, "test%", 0, 5).await.unwrap();
    assert_eq!(results.len(), 3);
    assert_eq!(results[0].scope, "test3");
    assert_eq!(results[1].scope, "test2");
    assert_eq!(results[2].scope, "test1");

    // Querying wildcard results offset
    let results = DocumentBox::search_query(&db, "test%", 1, 5).await.unwrap();
    assert_eq!(results.len(), 2);
    assert_eq!(results[0].scope, "test2");
    assert_eq!(results[1].scope, "test1");

    // Querying wildcard results paginated
    let results = DocumentBox::search_query(&db, "test%", 0, 2).await.unwrap();
    assert_eq!(results.len(), 2);
    assert_eq!(results[0].scope, "test3");
    assert_eq!(results[1].scope, "test2");

    let results = DocumentBox::search_query(&db, "test%", 2, 2).await.unwrap();
    assert_eq!(results.len(), 1);
    assert_eq!(results[0].scope, "test1");

    // Querying wildcard results with no matches
    let results = DocumentBox::search_query(&db, "1test:%", 0, 5)
        .await
        .unwrap();
    assert!(results.is_empty());
}

/// Tests that a search query can be used to search for document boxes total
#[tokio::test]
async fn test_document_box_search_total() {
    let (db, _db_container) = test_tenant_db().await;

    // Initial query result should be empty
    let results = DocumentBox::search_total(&db, "test").await.unwrap();
    assert_eq!(results, 0);

    // Querying specific result
    DocumentBox::create(&db, "test1".to_string()).await.unwrap();
    DocumentBox::create(&db, "test2".to_string()).await.unwrap();
    DocumentBox::create(&db, "test3".to_string()).await.unwrap();

    let results = DocumentBox::search_total(&db, "test3").await.unwrap();
    assert_eq!(results, 1);

    // Querying wildcard results
    let results = DocumentBox::search_total(&db, "test%").await.unwrap();
    assert_eq!(results, 3);

    // Querying wildcard results with no matches
    let results = DocumentBox::search_total(&db, "1test:%").await.unwrap();
    assert_eq!(results, 0);
}