pgsafe 0.11.0

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

use std::fs;

use assert_cmd::Command;
use tempfile::tempdir;

fn pgsafe() -> Command {
    Command::cargo_bin("pgsafe").unwrap()
}

#[test]
fn sarif_format_emits_parseable_sarif_and_gates() {
    let assert = pgsafe()
        .args(["--format", "sarif"])
        .write_stdin("CREATE INDEX i ON t (x);\n")
        .assert()
        .failure()
        .code(1);
    let out = &assert.get_output().stdout;
    let v: serde_json::Value = serde_json::from_slice(out).unwrap();
    assert_eq!(v["version"], "2.1.0");
    assert_eq!(v["runs"][0]["tool"]["driver"]["name"], "pgsafe");
    assert!(v["runs"][0]["results"]
        .as_array()
        .unwrap()
        .iter()
        .any(|r| r["ruleId"] == "add-index-non-concurrent"));
}

#[test]
fn sarif_clean_input_exits_zero() {
    pgsafe()
        .args(["--format", "sarif"])
        .write_stdin("SELECT 1;\n")
        .assert()
        .success();
}

#[test]
fn fix_conflicts_with_sarif_format() {
    pgsafe()
        .args(["--fix", "--format", "sarif"])
        .write_stdin("SELECT 1;")
        .assert()
        .failure()
        .code(2);
}

#[test]
fn sarif_parse_error_exits_2_with_notification() {
    let assert = pgsafe()
        .args(["--format", "sarif"])
        .write_stdin("ALTER TABLE;")
        .assert()
        .failure()
        .code(2);
    let v: serde_json::Value = serde_json::from_slice(&assert.get_output().stdout).unwrap();
    let inv = &v["runs"][0]["invocations"][0];
    assert_eq!(inv["executionSuccessful"], false);
    assert!(!inv["toolExecutionNotifications"]
        .as_array()
        .unwrap()
        .is_empty());
}

#[test]
fn fix_conflicts_with_config_format_sarif() {
    // A config-file `format = "sarif"` must still block --fix (the guard checks the
    // resolved format, not just the --format flag).
    let dir = tempdir().unwrap();
    fs::write(dir.path().join(".pgsafe.toml"), "format = \"sarif\"\n").unwrap();
    pgsafe()
        .current_dir(dir.path())
        .args(["--fix", "-"])
        .write_stdin("CREATE INDEX i ON t (x);")
        .assert()
        .failure()
        .code(2);
}