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

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

/// Test discover command with single JSONB column
#[tokio::test]
async fn test_discover_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");

    // Run discover command
    let result = discover::run(test_db.database_url(), OutputFormat::Json).await;

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

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

/// Test discover command with multiple JSONB columns
#[tokio::test]
async fn test_discover_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");

    // Run discover command
    let result = discover::run(test_db.database_url(), OutputFormat::Json).await;

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

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

/// Test discover command with all output formats
#[tokio::test]
async fn test_discover_output_formats() {
    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");

    // Test all output formats
    for format in [
        OutputFormat::Table,
        OutputFormat::Json,
        OutputFormat::Markdown,
    ] {
        let result = discover::run(test_db.database_url(), format.clone()).await;

        assert!(
            result.is_ok(),
            "Discover command failed for {:?} format: {:?}",
            format,
            result.err()
        );
    }

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

/// Test discover command with no JSONB columns
#[tokio::test]
async fn test_discover_no_jsonb_columns() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

    // Create a table with no JSONB columns
    sqlx::query(
        "CREATE TABLE regular_table (
            id SERIAL PRIMARY KEY,
            name TEXT NOT NULL,
            age INTEGER
        )",
    )
    .execute(&test_db.pool)
    .await
    .expect("Failed to create table");

    // Run discover command - should succeed but find no columns
    let result = discover::run(test_db.database_url(), OutputFormat::Json).await;

    assert!(
        result.is_ok(),
        "Discover command should succeed even with no JSONB columns"
    );

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

/// Test discover command with invalid database URL
#[tokio::test]
async fn test_discover_invalid_database_url() {
    let result = discover::run(
        "postgres://invalid:invalid@localhost:9999/invalid",
        OutputFormat::Json,
    )
    .await;

    assert!(result.is_err(), "Expected error for invalid database URL");
}

/// Test discover command excludes system schemas
#[tokio::test]
async fn test_discover_excludes_system_schemas() {
    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");

    // The discover command should only find columns in the public schema,
    // not in pg_catalog or information_schema
    let result = discover::run(test_db.database_url(), OutputFormat::Json).await;

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

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

/// Test discover command with nested JSON in different tables
#[tokio::test]
async fn test_discover_different_jsonb_structures() {
    let test_db = TestDb::new().await.expect("Failed to create test database");

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

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

    // Run discover - should find both tables with different JSONB structures
    let result = discover::run(test_db.database_url(), OutputFormat::Json).await;

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

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