pgdrift 0.1.2

Command-line tool for detecting schema drift in PostgreSQL JSONB columns
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291

use pgdrift::commands::scan_all;
use pgdrift::output::OutputFormat;
use pgdrift_db::fixtures;
use pgdrift_db::test_utils::TestDb;

// ============================================================================
// Basic Functionality Tests
// ============================================================================

#[tokio::test]
async fn test_scan_all_single_column() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_multiple_columns() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Create multiple tables with JSONB columns
    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create users fixture");

    fixtures::create_products_schema_evolution(&test_db.pool)
        .await
        .expect("Failed to create products fixture");

    fixtures::create_users_ghost_keys(&test_db.pool)
        .await
        .expect("Failed to create sparse users fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_with_drift_issues() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Create tables with known drift issues
    fixtures::create_users_type_inconsistency(&test_db.pool)
        .await
        .expect("Failed to create type inconsistency fixture");

    fixtures::create_users_ghost_keys(&test_db.pool)
        .await
        .expect("Failed to create ghost keys fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_no_columns() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Don't create any JSONB columns
    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all should succeed with no columns: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

// ============================================================================
// Output Format Tests
// ============================================================================

#[tokio::test]
async fn test_scan_all_table_format() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Table).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_markdown_format() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Markdown).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

// ============================================================================
// Configuration Tests
// ============================================================================

#[tokio::test]
async fn test_scan_all_with_custom_sample_size() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(
        test_db.database_url(),
        100, // small sample size
        OutputFormat::Json,
    )
    .await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

// ============================================================================
// Error Handling Tests
// ============================================================================

#[tokio::test]
async fn test_scan_all_invalid_database_url() {
    let result = scan_all::run(
        "postgres://invalid:invalid@localhost:5432/invalid",
        1000,
        OutputFormat::Json,
    )
    .await;

    assert!(
        result.is_err(),
        "Scan all should fail for invalid database URL"
    );
}

#[tokio::test]
async fn test_scan_all_continues_on_column_error() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Create one valid table
    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    // Create a table with all NULL JSONB values (will cause error during analysis)
    sqlx::query(
        "CREATE TABLE users_null (
            id SERIAL PRIMARY KEY,
            metadata JSONB
        )",
    )
    .execute(&test_db.pool)
    .await
    .expect("Failed to create table");

    sqlx::query("INSERT INTO users_null (metadata) SELECT NULL FROM generate_series(1, 100)")
        .execute(&test_db.pool)
        .await
        .expect("Failed to insert data");

    // scan_all should succeed overall even if one column fails
    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all should continue despite column errors: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

// ============================================================================
// Complex Scenarios
// ============================================================================

#[tokio::test]
async fn test_scan_all_with_schema_evolution() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_products_schema_evolution(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_with_deep_nesting() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    fixtures::create_users_nested(&test_db.pool)
        .await
        .expect("Failed to create fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}

#[tokio::test]
async fn test_scan_all_aggregates_drift_correctly() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Create tables with varying levels of drift
    fixtures::create_users_consistent(&test_db.pool)
        .await
        .expect("Failed to create consistent fixture");

    fixtures::create_users_type_inconsistency(&test_db.pool)
        .await
        .expect("Failed to create type inconsistency fixture");

    fixtures::create_users_ghost_keys(&test_db.pool)
        .await
        .expect("Failed to create ghost keys fixture");

    let result = scan_all::run(test_db.database_url(), 1000, OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Scan all command failed: {:?}",
        result.err()
    );

    test_db.cleanup().await.expect("Failed to cleanup");
}