pglockanalyze 0.0.4

See what PostgreSQL locks your migrations acquired
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

use pglockanalyze::analyzer::*;
use pglockanalyze::statement::*;
use pretty_assertions::assert_eq;
use serde::Deserialize;
use std::path::PathBuf;
use std::str::FromStr;

// these are set in Makefile
const DB_NAME: &str = "pglatests";
const DB_USER: &str = "pglauser";
const DB_PASS: &str = "pglapass";
const DB_HOST: &str = "localhost";
const DB_PORT: &str = "38471";

#[derive(Debug, Deserialize)]
struct TestCase {
    // inputs
    initial_schema: String,
    statements: String,

    // output
    expected: Vec<Statement>,
}

// we do not want to execute tests in parallel, since they act on the same
// database and we'll have deadlocks
#[test]
fn test_all() {
    test_wrap_in_transaction_rollback();
    test_no_wrap_in_transaction_commit();
    test_locations();
}

fn test_wrap_in_transaction_rollback() {
    let test_cases = load_fixture_file("fixture.yml");

    for test_case in &test_cases {
        reset_db(&test_case.initial_schema);

        let cfg = AnalyzerConfig {
            db_connection_string: db(),
            distinct_transactions: false,
            commit: false,
        };

        let stmts = Analyzer::try_from(cfg)
            .unwrap()
            .analyze(&test_case.statements)
            .unwrap();

        let actual = serde_yaml::to_string(&stmts).unwrap();
        let expected = serde_yaml::to_string(&test_case.expected).unwrap();

        assert_eq!(actual, expected);
    }
}

fn test_no_wrap_in_transaction_commit() {
    let test_cases = load_fixture_file("fixture_non_wrapping.yml");

    for test_case in &test_cases {
        reset_db(&test_case.initial_schema);

        let cfg = AnalyzerConfig {
            db_connection_string: db(),
            distinct_transactions: true,
            commit: true,
        };

        let stmts = Analyzer::try_from(cfg)
            .unwrap()
            .analyze(&test_case.statements)
            .unwrap();

        let actual = serde_yaml::to_string(&stmts).unwrap();
        let expected = serde_yaml::to_string(&test_case.expected).unwrap();

        assert_eq!(actual, expected);
    }
}

fn test_locations() {
    let test_cases = load_fixture_file("fixture_locations.yml");

    for test_case in &test_cases {
        reset_db(&test_case.initial_schema);

        let cfg = AnalyzerConfig {
            db_connection_string: db(),
            distinct_transactions: true,
            commit: true,
        };

        let stmts = Analyzer::try_from(cfg)
            .unwrap()
            .analyze(&test_case.statements)
            .unwrap();

        let actual = serde_yaml::to_string(&stmts).unwrap();
        let expected = serde_yaml::to_string(&test_case.expected).unwrap();

        assert_eq!(actual, expected);
    }
}

fn load_fixture_file(fname: &str) -> Vec<TestCase> {
    let file = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join(file!())
        .parent()
        .unwrap()
        .join(fname);

    let fixture = std::fs::read_to_string(file).unwrap();

    serde_yaml::from_str(&fixture).unwrap()
}

fn reset_db(bootstrap: &str) {
    let mut client = postgres::Config::from_str(&db())
        .unwrap()
        .connect(postgres::NoTls)
        .unwrap();

    let cleanup_sql = format!(
        "DROP SCHEMA IF EXISTS public CASCADE;
             CREATE SCHEMA public;
             GRANT ALL ON SCHEMA public TO {DB_USER};
             GRANT ALL ON SCHEMA public TO public;
             SET search_path = public;"
    );

    client.batch_execute(&cleanup_sql).unwrap();
    client.batch_execute(bootstrap).unwrap();
}

fn db() -> String {
    format!("postgresql://{DB_USER}:{DB_PASS}@{DB_HOST}:{DB_PORT}/{DB_NAME}")
}