pgsafe 0.8.6

Static safety linter for PostgreSQL DDL migrations — catches unsafe schema changes before they lock or break production.
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

use std::fs;

use assert_cmd::Command;
use predicates::prelude::*;
use tempfile::tempdir;

fn run_in(dir: &std::path::Path, args: &[&str]) -> assert_cmd::assert::Assert {
    Command::cargo_bin("pgsafe")
        .unwrap()
        .current_dir(dir)
        .args(args)
        .assert()
}

#[test]
fn since_lints_only_files_after_the_cutoff() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join("0001_legacy.sql"), "DROP TABLE a;\n").unwrap();
    fs::write(dir.path().join("0002_cut.sql"), "DROP TABLE b;\n").unwrap();
    fs::write(
        dir.path().join("0003_new.sql"),
        "CREATE INDEX i ON t (x);\n",
    )
    .unwrap();
    run_in(
        dir.path(),
        &[
            "--since",
            "0002_cut.sql",
            "0001_legacy.sql",
            "0002_cut.sql",
            "0003_new.sql",
        ],
    )
    // 0001/0002 (<= cutoff) excluded → no drop-table; 0003 (> cutoff) linted → add-index fires.
    .stdout(
        predicate::str::contains("drop-table")
            .not()
            .and(predicate::str::contains("add-index-non-concurrent")),
    );
}

#[test]
fn config_since_is_honored_and_cli_overrides_it() {
    let dir = tempdir().unwrap();
    fs::write(
        dir.path().join(".pgsafe.toml"),
        "since = \"0002_cut.sql\"\n",
    )
    .unwrap();
    fs::write(dir.path().join("0001_legacy.sql"), "DROP TABLE a;\n").unwrap();
    fs::write(dir.path().join("0002_cut.sql"), "DROP TABLE b;\n").unwrap();
    fs::write(dir.path().join("0003_new.sql"), "DROP TABLE c;\n").unwrap();
    // config since=0002 → only 0003 is linted.
    run_in(
        dir.path(),
        &["0001_legacy.sql", "0002_cut.sql", "0003_new.sql"],
    )
    .stdout(
        predicate::str::contains("0003_new.sql")
            .and(predicate::str::contains("0001_legacy.sql").not()),
    );
    // CLI --since 0001 overrides config → 0002 and 0003 linted (not 0001).
    run_in(
        dir.path(),
        &[
            "--since",
            "0001_legacy.sql",
            "0001_legacy.sql",
            "0002_cut.sql",
            "0003_new.sql",
        ],
    )
    .stdout(
        predicate::str::contains("0002_cut.sql")
            .and(predicate::str::contains("0003_new.sql"))
            .and(predicate::str::contains("0001_legacy.sql").not()),
    );
}

#[test]
fn since_and_git_diff_are_mutually_exclusive() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join("m.sql"), "DROP TABLE a;\n").unwrap();
    run_in(
        dir.path(),
        &["--since", "0001.sql", "--git-diff", "HEAD", "m.sql"],
    )
    .failure()
    .code(2); // clap conflicts_with → usage error
}

#[test]
fn since_rejects_stdin() {
    let dir = tempdir().unwrap();
    fs::write(dir.path().join("m.sql"), "DROP TABLE a;\n").unwrap();
    // Explicit --since with `-` in the paths.
    run_in(dir.path(), &["--since", "0001.sql", "m.sql", "-"])
        .failure()
        .code(2)
        .stderr(predicate::str::contains("stdin"));
    // A config `since` cutoff also rejects stdin, and the message mentions `since`.
    fs::write(dir.path().join(".pgsafe.toml"), "since = \"0001.sql\"\n").unwrap();
    run_in(dir.path(), &["m.sql", "-"])
        .failure()
        .code(2)
        .stderr(predicate::str::contains("since"));
}