pgdumpx 0.2.0

Read-only, bounded inspection, extraction, and row scanning for PostgreSQL custom-format dumps
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

use crate::{Compression, ErrorCategory, PgDumpError, ResourceLimit};
use std::{error::Error as _, io};

#[test]
fn callers_can_classify_representative_errors_without_display_parsing() {
    let utf8_source = String::from_utf8(vec![0xff]).unwrap_err().utf8_error();
    let cases = [
        (
            PgDumpError::Io {
                offset: 4,
                source: io::Error::other("read failed"),
            },
            ErrorCategory::Io,
        ),
        (
            PgDumpError::InvalidArchiveMagic { offset: 0 },
            ErrorCategory::Format,
        ),
        (
            PgDumpError::DataBlockDumpIdMismatch {
                expected: 7,
                actual: 8,
                offset: 41,
            },
            ErrorCategory::Integrity,
        ),
        (
            PgDumpError::DecompressionFailed {
                dump_id: 7,
                algorithm: "gzip",
                source: io::Error::new(io::ErrorKind::InvalidData, "bad stream"),
            },
            ErrorCategory::Decompression,
        ),
        (
            PgDumpError::MalformedCopyEscape {
                row: 2,
                byte_offset: 19,
            },
            ErrorCategory::Copy,
        ),
        (
            PgDumpError::UnsupportedTableDataRepresentation {
                dump_id: 7,
                representation: crate::TableDataRepresentation::Insert,
            },
            ErrorCategory::Representation,
        ),
        (
            PgDumpError::InvalidUtf8 {
                context: "archive metadata",
                source: utf8_source,
            },
            ErrorCategory::Encoding,
        ),
        (
            PgDumpError::ArchiveStringLimitExceeded {
                length: 11,
                limit: 10,
                offset: 5,
            },
            ErrorCategory::Resource,
        ),
        (
            PgDumpError::ArithmeticOverflow { offset: 9 },
            ErrorCategory::Arithmetic,
        ),
    ];

    for (error, expected) in cases {
        assert_eq!(error.category(), expected, "error={error}");
    }
}

#[test]
fn representative_errors_expose_typed_context() {
    let truncation = PgDumpError::UnexpectedEof { offset: 123 };
    assert_eq!(truncation.byte_offset(), Some(123));

    let mismatch = PgDumpError::DataBlockDumpIdMismatch {
        expected: 17,
        actual: 18,
        offset: 456,
    };
    assert_eq!(mismatch.byte_offset(), Some(456));
    assert_eq!(mismatch.dump_id().unwrap().as_i32(), 17);

    let malformed = PgDumpError::MalformedCopyEscape {
        row: 9,
        byte_offset: 321,
    };
    assert_eq!(malformed.row_number(), Some(9));
    assert_eq!(malformed.byte_offset(), Some(321));

    let decompression = PgDumpError::DecompressionFailed {
        dump_id: 20,
        algorithm: "gzip",
        source: io::Error::new(io::ErrorKind::InvalidData, "bad stream"),
    };
    assert_eq!(decompression.dump_id().unwrap().as_i32(), 20);
    assert_eq!(decompression.compression(), Some(Compression::Gzip));
}

#[test]
fn structural_limit_errors_expose_resource_limit_and_consumed_work() {
    let error = PgDumpError::ArchiveStringLimitExceeded {
        length: 11,
        limit: 10,
        offset: 5,
    };
    let context = error.limit_context().expect("resource limit context");

    assert_eq!(context.resource(), ResourceLimit::ArchiveStringBytes);
    assert_eq!(context.limit(), 10);
    assert_eq!(context.consumed(), 11);
}

#[test]
fn io_decompression_and_typed_io_adapter_sources_remain_reachable() {
    let io_error = PgDumpError::Io {
        offset: 0,
        source: io::Error::other("read failed"),
    };
    assert!(io_error.source().is_some());

    let decompression = PgDumpError::DecompressionFailed {
        dump_id: 1,
        algorithm: "gzip",
        source: io::Error::new(io::ErrorKind::InvalidData, "bad stream"),
    };
    assert!(decompression.source().is_some());

    let adapted = crate::error::into_io_error(PgDumpError::ArchiveStringLimitExceeded {
        length: 2,
        limit: 1,
        offset: 0,
    });
    let typed = adapted
        .get_ref()
        .and_then(|source| source.downcast_ref::<PgDumpError>())
        .expect("typed pgdumpx error must be the io::Error source");
    assert_eq!(typed.category(), ErrorCategory::Resource);
}