pgmt 0.5.0

PostgreSQL migration tool that keeps your schema files as the source of truth
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
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
use super::*;
use crate::config::merge::Merge;
use crate::config::types::*;

#[test]
fn test_config_input_merge() {
    let file_config = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: Some("postgres://localhost/dev".to_string()),
            shadow_url: None,
            target_url: None,
            shadow: Some(ShadowDatabaseInput {
                auto: Some(true),
                reset: None,
                url: None,
                docker: None,
            }),
        }),
        directories: Some(DirectoriesInput {
            schema_dir: Some("schema".to_string()),
            migrations_dir: None,
            baselines_dir: None,
            roles_file: None,
        }),
        objects: None,
        migration: None,
        schema: None,
        docker: None,
    };

    let cli_config = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: None, // CLI doesn't override this
            shadow_url: Some("postgres://localhost/shadow_override".to_string()),
            target_url: Some("postgres://localhost/target".to_string()),
            shadow: None,
        }),
        directories: Some(DirectoriesInput {
            schema_dir: None,
            migrations_dir: Some("migrations_override".to_string()),
            baselines_dir: Some("baselines".to_string()),
            roles_file: Some("roles.sql".to_string()),
        }),
        objects: Some(ObjectsInput {
            include: None,
            exclude: Some(ObjectExcludeInput {
                schemas: Some(vec!["temp_*".to_string()]),
                tables: None,
            }),
        }),
        migration: None,
        schema: None,
        docker: None,
    };

    let merged = file_config.merge(cli_config);

    // CLI should override file config
    assert_eq!(
        merged.databases.as_ref().unwrap().dev_url,
        Some("postgres://localhost/dev".to_string())
    );
    assert_eq!(
        merged.databases.as_ref().unwrap().shadow_url,
        Some("postgres://localhost/shadow_override".to_string())
    );
    assert_eq!(
        merged.databases.as_ref().unwrap().target_url,
        Some("postgres://localhost/target".to_string())
    );

    // CLI should override specific directory settings
    assert_eq!(
        merged.directories.as_ref().unwrap().schema_dir,
        Some("schema".to_string())
    );
    assert_eq!(
        merged.directories.as_ref().unwrap().migrations_dir,
        Some("migrations_override".to_string())
    );
    assert_eq!(
        merged.directories.as_ref().unwrap().baselines_dir,
        Some("baselines".to_string())
    );

    // CLI object config should be present with exclude patterns
    assert!(merged.objects.is_some());
    assert_eq!(
        merged
            .objects
            .as_ref()
            .unwrap()
            .exclude
            .as_ref()
            .unwrap()
            .schemas,
        Some(vec!["temp_*".to_string()])
    );
}

#[test]
fn test_config_builder_resolve() {
    let config_input = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: Some("postgres://localhost/dev".to_string()),
            shadow_url: None,
            target_url: None,
            shadow: None, // Auto mode by default
        }),
        directories: None, // Use defaults
        objects: Some(ObjectsInput {
            include: None,
            exclude: Some(ObjectExcludeInput {
                schemas: Some(vec!["pg_*".to_string()]),
                tables: Some(vec!["temp_*".to_string()]),
            }),
        }),
        migration: None, // Use defaults
        schema: None,    // Use defaults
        docker: None,    // Use defaults
    };

    // Database connections resolve separately from project config
    let dev = DevUrlArgs::default().resolve(&config_input).unwrap();
    assert_eq!(dev.as_str(), "postgres://localhost/dev");
    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Auto => {} // Expected
        _ => panic!("Expected auto shadow database"),
    }
    assert_eq!(TargetUrlArgs::default().lookup(&config_input), None);

    let config = ConfigBuilder::new()
        .with_file(config_input)
        .resolve()
        .unwrap();

    // Check directory defaults
    assert_eq!(config.directories.schema, "schema");
    assert_eq!(config.directories.migrations, "migrations");
    assert_eq!(config.directories.baselines, "schema_baselines");
    assert_eq!(config.directories.roles, "roles.sql");

    // Check object filtering
    assert_eq!(config.objects.exclude.schemas, vec!["pg_*".to_string()]);
    assert_eq!(config.objects.exclude.tables, vec!["temp_*".to_string()]);

    // Check migration defaults
    assert_eq!(config.migration.default_mode, "safe_only");
    assert!(config.migration.validate_baseline_consistency);

    // Check docker defaults
    assert!(config.docker.auto_cleanup);
    assert!(config.docker.check_system_identifier);
}

#[tokio::test]
async fn test_shadow_database_url_mode() {
    // Test explicit URL mode (this doesn't require Docker)
    let shadow_db = ShadowDatabase::Url {
        url: "postgres://localhost/explicit_shadow".to_string(),
        reset: ShadowResetMode::default(),
    };
    let url = shadow_db.get_connection_string().await.unwrap();
    assert_eq!(url, "postgres://localhost/explicit_shadow");

    // Note: Auto and Docker modes require a Docker daemon and are tested
    // in integration tests (tests/integration/docker.rs)
}

#[test]
fn test_object_filter_schema_filtering() {
    let objects = Objects {
        include: ObjectInclude {
            schemas: vec!["public".to_string(), "app".to_string()],
            tables: vec![],
        },
        exclude: ObjectExclude {
            schemas: vec!["pg_*".to_string(), "information_schema".to_string()],
            tables: vec![],
        },
    };

    let tracking_table = TrackingTable::default();
    let filter = ObjectFilter::new(&objects, &tracking_table);

    // Should include specified schemas
    assert!(filter.should_include_schema("public"));
    assert!(filter.should_include_schema("app"));

    // Should exclude postgres system schemas
    assert!(!filter.should_include_schema("pg_catalog"));
    assert!(!filter.should_include_schema("information_schema"));

    // Should not include schemas not in the include list
    assert!(!filter.should_include_schema("other"));
}

#[test]
fn test_object_filter_table_filtering() {
    let objects = Objects {
        include: ObjectInclude {
            schemas: vec!["public".to_string()],
            tables: vec!["users".to_string(), "posts".to_string()],
        },
        exclude: ObjectExclude {
            schemas: vec!["pg_*".to_string()],
            tables: vec!["temp_*".to_string()],
        },
    };

    let tracking_table = TrackingTable::default();
    let filter = ObjectFilter::new(&objects, &tracking_table);

    // Should include specified tables in included schemas
    assert!(filter.should_include_table("public", "users"));
    assert!(filter.should_include_table("public", "posts"));

    // Should exclude tables matching exclude patterns
    assert!(!filter.should_include_table("public", "temp_data"));

    // Should not include tables not in the include list
    assert!(!filter.should_include_table("public", "other_table"));

    // Should not include tables in excluded schemas
    assert!(!filter.should_include_table("pg_catalog", "pg_tables"));
}

#[test]
fn test_empty_include_patterns_means_include_all() {
    let objects = Objects {
        include: ObjectInclude {
            schemas: vec![], // Empty means include all
            tables: vec![],
        },
        exclude: ObjectExclude {
            schemas: vec!["pg_*".to_string()],
            tables: vec![],
        },
    };

    let tracking_table = TrackingTable::default();
    let filter = ObjectFilter::new(&objects, &tracking_table);

    // Should include schemas not in exclude list
    assert!(filter.should_include_schema("public"));
    assert!(filter.should_include_schema("app"));
    assert!(filter.should_include_schema("custom"));

    // Should still exclude patterns
    assert!(!filter.should_include_schema("pg_catalog"));
    assert!(!filter.should_include_schema("pg_stat"));
}

#[test]
fn test_shadow_docker_version_resolution() {
    // Test version field converts to image
    let config = ShadowDockerConfig {
        version: Some("16".to_string()),
        image: ShadowDockerConfig::default().image.clone(),
        platform: None,
        environment: Default::default(),
        container_name: None,
        auto_cleanup: true,
        volumes: None,
        network: None,
    };
    assert_eq!(config.resolved_image(), "postgres:16-alpine");

    // Test explicit image takes precedence over version
    let config_with_both = ShadowDockerConfig {
        version: Some("16".to_string()),
        image: "postgres:14-bullseye".to_string(),
        platform: None,
        environment: Default::default(),
        container_name: None,
        auto_cleanup: true,
        volumes: None,
        network: None,
    };
    assert_eq!(config_with_both.resolved_image(), "postgres:14-bullseye");

    // Test default image (no version specified)
    let default_config = ShadowDockerConfig::default();
    assert_eq!(default_config.resolved_image(), "postgres:18-alpine");
}

#[test]
fn test_config_builder_shadow_docker_version() {
    // Test version configuration through ConfigBuilder
    let config_input = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: Some("postgres://localhost/dev".to_string()),
            shadow_url: None,
            target_url: None,
            shadow: Some(ShadowDatabaseInput {
                auto: None,
                reset: None,
                url: None,
                docker: Some(ShadowDockerInput {
                    version: Some("16".to_string()),
                    image: None,
                    platform: None,
                    environment: None,
                    container_name: None,
                    auto_cleanup: None,
                    volumes: None,
                    network: None,
                }),
            }),
        }),
        directories: None,
        objects: None,
        migration: None,
        schema: None,
        docker: None,
    };

    // Verify version was set correctly
    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Docker(docker_config) => {
            assert_eq!(docker_config.version, Some("16".to_string()));
            assert_eq!(docker_config.resolved_image(), "postgres:16-alpine");
        }
        _ => panic!("Expected Docker shadow database"),
    }
}

#[test]
fn test_config_builder_shadow_docker_explicit_image() {
    // Test explicit image configuration (should take precedence)
    let config_input = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: Some("postgres://localhost/dev".to_string()),
            shadow_url: None,
            target_url: None,
            shadow: Some(ShadowDatabaseInput {
                auto: None,
                reset: None,
                url: None,
                docker: Some(ShadowDockerInput {
                    version: Some("16".to_string()), // This should be ignored
                    image: Some("postgres:14-bullseye".to_string()),
                    platform: None,
                    environment: None,
                    container_name: None,
                    auto_cleanup: None,
                    volumes: None,
                    network: None,
                }),
            }),
        }),
        directories: None,
        objects: None,
        migration: None,
        schema: None,
        docker: None,
    };

    // Verify explicit image takes precedence
    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Docker(docker_config) => {
            assert_eq!(docker_config.resolved_image(), "postgres:14-bullseye");
        }
        _ => panic!("Expected Docker shadow database"),
    }
}

#[test]
fn test_default_shadow_docker_version() {
    // Verify default version is PostgreSQL 18
    let default_config = ShadowDockerConfig::default();
    assert_eq!(default_config.image, "postgres:18-alpine");
    assert_eq!(default_config.resolved_image(), "postgres:18-alpine");
    // Default requests no specific platform (host-native).
    assert_eq!(default_config.platform, None);
}

#[test]
fn test_config_builder_shadow_docker_platform() {
    // Platform flows through the builder for single-arch images (e.g. PostGIS).
    let config_input = ConfigInput {
        databases: Some(DatabasesInput {
            dev_url: Some("postgres://localhost/dev".to_string()),
            shadow_url: None,
            target_url: None,
            shadow: Some(ShadowDatabaseInput {
                auto: None,
                reset: None,
                url: None,
                docker: Some(ShadowDockerInput {
                    version: None,
                    image: Some("postgis/postgis:16-3.5".to_string()),
                    platform: Some("linux/amd64".to_string()),
                    environment: None,
                    container_name: None,
                    auto_cleanup: None,
                    volumes: None,
                    network: None,
                }),
            }),
        }),
        directories: None,
        objects: None,
        migration: None,
        schema: None,
        docker: None,
    };

    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Docker(docker_config) => {
            assert_eq!(docker_config.resolved_image(), "postgis/postgis:16-3.5");
            assert_eq!(docker_config.platform.as_deref(), Some("linux/amd64"));
        }
        _ => panic!("Expected Docker shadow database"),
    }
}

#[test]
fn test_shadow_merge_docker_over_docker_preserves_unanswered_fields() {
    // Both layers are docker mode: the overlay only replaces fields it sets,
    // so hand-maintained fields (environment, container_name, auto_cleanup)
    // survive a re-init that re-answers docker mode.
    let base = ShadowDatabaseInput {
        auto: None,
        reset: None,
        url: None,
        docker: Some(ShadowDockerInput {
            image: Some("postgis/postgis:16-3.4".to_string()),
            container_name: Some("pgmt_shadow_app".to_string()),
            auto_cleanup: Some(false),
            environment: Some([("POSTGRES_PASSWORD".to_string(), "secret".to_string())].into()),
            ..Default::default()
        }),
    };
    let overlay = ShadowDatabaseInput {
        auto: None,
        reset: None,
        url: None,
        docker: Some(ShadowDockerInput {
            image: Some("postgis/postgis:17-3.5".to_string()),
            ..Default::default()
        }),
    };

    let merged = base.merge_with(overlay);
    let docker = merged.docker.expect("docker mode preserved");
    assert_eq!(docker.image.as_deref(), Some("postgis/postgis:17-3.5"));
    assert_eq!(docker.container_name.as_deref(), Some("pgmt_shadow_app"));
    assert_eq!(docker.auto_cleanup, Some(false));
    assert!(docker.environment.is_some());
    assert_eq!(merged.url, None);
}

#[test]
fn test_shadow_merge_mode_switch_to_auto_clears_docker() {
    // Picking Auto is a deliberate mode choice: the stale docker block must
    // not survive, or the resolver would still pick docker mode.
    let base = ShadowDatabaseInput {
        auto: None,
        reset: None,
        url: None,
        docker: Some(ShadowDockerInput {
            image: Some("postgis/postgis:16-3.5".to_string()),
            container_name: Some("pgmt_shadow_app".to_string()),
            ..Default::default()
        }),
    };
    let overlay = ShadowDatabaseInput {
        auto: Some(true),
        reset: None,
        url: None,
        docker: None,
    };

    let merged = base.merge_with(overlay);
    assert_eq!(merged.auto, Some(true));
    assert_eq!(merged.url, None);
    assert!(
        merged.docker.is_none(),
        "stale docker block must be cleared"
    );
}

#[test]
fn test_shadow_merge_mode_switch_to_url_clears_docker() {
    let base = ShadowDatabaseInput {
        auto: None,
        reset: None,
        url: None,
        docker: Some(ShadowDockerInput {
            image: Some("postgis/postgis:16-3.5".to_string()),
            ..Default::default()
        }),
    };
    let overlay = ShadowDatabaseInput {
        auto: Some(false),
        reset: None,
        url: Some("postgres://localhost/shadow".to_string()),
        docker: None,
    };

    let merged = base.merge_with(overlay);
    assert_eq!(merged.url.as_deref(), Some("postgres://localhost/shadow"));
    assert!(
        merged.docker.is_none(),
        "stale docker block must be cleared"
    );
}

#[test]
fn test_shadow_merge_mode_switch_url_to_docker_clears_url() {
    let base = ShadowDatabaseInput {
        auto: Some(false),
        reset: None,
        url: Some("postgres://localhost/shadow".to_string()),
        docker: None,
    };
    let overlay = ShadowDatabaseInput {
        auto: None,
        reset: None,
        url: None,
        docker: Some(ShadowDockerInput {
            image: Some("postgres:18-alpine".to_string()),
            ..Default::default()
        }),
    };

    let merged = base.merge_with(overlay);
    assert!(merged.url.is_none(), "stale url must be cleared");
    assert_eq!(
        merged.docker.and_then(|d| d.image).as_deref(),
        Some("postgres:18-alpine")
    );
}

#[test]
fn test_object_exclude_accepts_both_key_spellings() {
    // `exclude.schemas` is the documented key (mirrors include.schemas);
    // `exclude_schemas` is the legacy spelling accepted via serde alias.
    let new_style: ConfigInput = serde_yaml::from_str(
        "objects:\n  exclude:\n    schemas: [\"pg_*\"]\n    tables: [\"cache_*\"]\n",
    )
    .unwrap();
    let legacy: ConfigInput = serde_yaml::from_str(
        "objects:\n  exclude:\n    exclude_schemas: [\"pg_*\"]\n    exclude_tables: [\"cache_*\"]\n",
    )
    .unwrap();

    assert_eq!(new_style.objects, legacy.objects);
    let exclude = new_style.objects.unwrap().exclude.unwrap();
    assert_eq!(exclude.schemas, Some(vec!["pg_*".to_string()]));
    assert_eq!(exclude.tables, Some(vec!["cache_*".to_string()]));
}

#[test]
fn test_shadow_url_reset_mode_resolution() {
    let config_input: ConfigInput = serde_yaml::from_str(
        "databases:\n  dev_url: postgres://localhost/dev\n  shadow:\n    url: postgres://ci/shadow\n    reset: branch\n",
    )
    .unwrap();
    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Url { url, reset } => {
            assert_eq!(url, "postgres://ci/shadow");
            assert_eq!(reset, ShadowResetMode::Branch);
        }
        _ => panic!("Expected Url shadow"),
    }

    // Omitted reset defaults to the conservative clean mode.
    let config_input: ConfigInput = serde_yaml::from_str(
        "databases:\n  dev_url: postgres://localhost/dev\n  shadow:\n    url: postgres://ci/shadow\n",
    )
    .unwrap();
    match ShadowUrlArgs::default().resolve(&config_input).unwrap() {
        ShadowDatabase::Url { reset, .. } => assert_eq!(reset, ShadowResetMode::Clean),
        _ => panic!("Expected Url shadow"),
    }
}