tegdb 0.5.0

The name TegridyDB (short for TegDB) is inspired by the Tegridy Farm in South Park and tries to correct some of the wrong database implementations, such as null support, implicit conversion support, etc.
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

//! Comprehensive tests for tgstream (cloud sync) functionality
//!
//! Note: Many tests require MinIO/S3 setup and environment variables:
//! - TGSTREAM_IT=1
//! - AWS_ACCESS_KEY_ID
//! - AWS_SECRET_ACCESS_KEY
//! - AWS_ENDPOINT_URL
//! - TGSTREAM_BUCKET (optional, defaults to "tgstream-test")

use std::env;
use std::fs::OpenOptions;
use std::io::{Seek, SeekFrom, Write};

use tegdb::log::{STORAGE_FORMAT_VERSION, STORAGE_HEADER_SIZE, STORAGE_MAGIC, TX_COMMIT_MARKER};
use tegdb::tgstream::config::{Config, S3Config};
use tegdb::tgstream::parser::find_last_commit_offset;
use tegdb::tgstream::restore::Restore;
use tegdb::tgstream::tailer::Tailer;

fn write_header(file: &mut std::fs::File) {
    let mut header = vec![0u8; STORAGE_HEADER_SIZE];
    header[0..STORAGE_MAGIC.len()].copy_from_slice(STORAGE_MAGIC);
    header[6..8].copy_from_slice(&STORAGE_FORMAT_VERSION.to_be_bytes());
    header[8..12].copy_from_slice(&0u32.to_be_bytes());
    header[12..16].copy_from_slice(&(1024u32).to_be_bytes());
    header[16..20].copy_from_slice(&(256 * 1024u32).to_be_bytes());
    header[20] = 1u8;
    file.write_all(&header).unwrap();
}

fn write_record(file: &mut std::fs::File, key: &[u8], value: &[u8]) {
    let key_len = (key.len() as u32).to_be_bytes();
    let val_len = (value.len() as u32).to_be_bytes();
    file.write_all(&key_len).unwrap();
    file.write_all(&val_len).unwrap();
    file.write_all(key).unwrap();
    file.write_all(value).unwrap();
}

fn get_test_config(db_path: std::path::PathBuf) -> Option<Config> {
    if env::var("TGSTREAM_IT").unwrap_or_default() != "1" {
        return None;
    }
    if env::var("AWS_ACCESS_KEY_ID").is_err() {
        return None;
    }
    if env::var("AWS_SECRET_ACCESS_KEY").is_err() {
        return None;
    }
    if env::var("AWS_ENDPOINT_URL").is_err() {
        return None;
    }

    let bucket = env::var("TGSTREAM_BUCKET").unwrap_or_else(|_| "tgstream-test".to_string());
    let prefix = format!("tgstream/{:?}", std::process::id());
    let region = env::var("AWS_REGION").unwrap_or_else(|_| "us-east-1".to_string());

    Some(Config {
        database_path: db_path,
        s3: S3Config {
            bucket,
            prefix,
            region,
            endpoint: env::var("AWS_ENDPOINT_URL").ok(),
            access_key_id: env::var("AWS_ACCESS_KEY_ID").ok(),
            secret_access_key: env::var("AWS_SECRET_ACCESS_KEY").ok(),
        },
        retention: Default::default(),
        base: Default::default(),
        segment: Default::default(),
        gzip: true,
    })
}

#[tokio::test]
async fn test_backup_creation_and_verification() {
    let config = match get_test_config(tempfile::tempdir().unwrap().path().join("backup_test.teg"))
    {
        Some(cfg) => cfg,
        None => return,
    };

    let dir = tempfile::tempdir().unwrap();
    let db_path = dir.path().join("backup_test.teg");
    let mut f = OpenOptions::new()
        .create(true)
        .truncate(true)
        .read(true)
        .write(true)
        .open(&db_path)
        .unwrap();

    write_header(&mut f);
    write_record(&mut f, b"test_key", b"test_value");
    write_record(&mut f, TX_COMMIT_MARKER, b"");
    f.flush().unwrap();

    // Create backup
    let mut tailer = Tailer::new(config.clone()).await.unwrap();
    tailer.snapshot_once().await.unwrap();

    // Verify backup was created by checking restore works
    let out_path = dir.path().join("restored_backup.teg");
    let rest = Restore::new(&config.s3, &config.s3_prefix()).await.unwrap();
    rest.restore_to(&out_path, None).await.unwrap();

    // Verify restored database
    let mut rf = OpenOptions::new().read(true).open(&out_path).unwrap();
    let off_restored = find_last_commit_offset(&mut rf).unwrap();
    assert!(off_restored > STORAGE_HEADER_SIZE as u64);
}

#[tokio::test]
async fn test_restore_from_backup() {
    let config = match get_test_config(tempfile::tempdir().unwrap().path().join("restore_test.teg"))
    {
        Some(cfg) => cfg,
        None => return,
    };

    let dir = tempfile::tempdir().unwrap();
    let db_path = dir.path().join("restore_test.teg");
    let mut f = OpenOptions::new()
        .create(true)
        .truncate(true)
        .read(true)
        .write(true)
        .open(&db_path)
        .unwrap();

    write_header(&mut f);
    write_record(&mut f, b"key1", b"value1");
    write_record(&mut f, b"key2", b"value2");
    write_record(&mut f, TX_COMMIT_MARKER, b"");
    f.flush().unwrap();

    // Create backup
    let mut tailer = Tailer::new(config.clone()).await.unwrap();
    tailer.snapshot_once().await.unwrap();

    // Restore
    let out_path = dir.path().join("restored.teg");
    let rest = Restore::new(&config.s3, &config.s3_prefix()).await.unwrap();
    rest.restore_to(&out_path, None).await.unwrap();

    // Verify restore succeeded
    let mut rf = OpenOptions::new().read(true).open(&out_path).unwrap();
    let off_restored = find_last_commit_offset(&mut rf).unwrap();
    let mut of = OpenOptions::new().read(true).open(&db_path).unwrap();
    let off_src = find_last_commit_offset(&mut of).unwrap();
    assert!(off_restored >= off_src);
}

#[tokio::test]
async fn test_incremental_backups() {
    let config = match get_test_config(
        tempfile::tempdir()
            .unwrap()
            .path()
            .join("incremental_test.teg"),
    ) {
        Some(cfg) => cfg,
        None => return,
    };

    let dir = tempfile::tempdir().unwrap();
    let db_path = dir.path().join("incremental_test.teg");
    let mut f = OpenOptions::new()
        .create(true)
        .truncate(true)
        .read(true)
        .write(true)
        .open(&db_path)
        .unwrap();

    write_header(&mut f);
    write_record(&mut f, b"initial", b"data");
    write_record(&mut f, TX_COMMIT_MARKER, b"");
    f.flush().unwrap();

    // First backup
    let mut tailer = Tailer::new(config.clone()).await.unwrap();
    tailer.snapshot_once().await.unwrap();

    // Add more data
    f.seek(SeekFrom::End(0)).unwrap();
    write_record(&mut f, b"incremental", b"data");
    write_record(&mut f, TX_COMMIT_MARKER, b"");
    f.flush().unwrap();

    // Second backup (incremental)
    tailer.snapshot_once().await.unwrap();

    // Restore should include both commits
    let out_path = dir.path().join("restored_incremental.teg");
    let rest = Restore::new(&config.s3, &config.s3_prefix()).await.unwrap();
    rest.restore_to(&out_path, None).await.unwrap();

    // Verify both commits are in restored database
    let mut rf = OpenOptions::new().read(true).open(&out_path).unwrap();
    let off_restored = find_last_commit_offset(&mut rf).unwrap();
    let mut of = OpenOptions::new().read(true).open(&db_path).unwrap();
    let off_src = find_last_commit_offset(&mut of).unwrap();
    assert!(off_restored >= off_src);
}

#[tokio::test]
async fn test_backup_with_transactions() {
    let config = match get_test_config(
        tempfile::tempdir()
            .unwrap()
            .path()
            .join("tx_backup_test.teg"),
    ) {
        Some(cfg) => cfg,
        None => return,
    };

    let dir = tempfile::tempdir().unwrap();
    let db_path = dir.path().join("tx_backup_test.teg");
    let mut f = OpenOptions::new()
        .create(true)
        .truncate(true)
        .read(true)
        .write(true)
        .open(&db_path)
        .unwrap();

    write_header(&mut f);

    // Multiple transactions
    for i in 1..=5 {
        write_record(
            &mut f,
            format!("key{}", i).as_bytes(),
            format!("value{}", i).as_bytes(),
        );
        write_record(&mut f, TX_COMMIT_MARKER, b"");
    }
    f.flush().unwrap();

    // Backup
    let mut tailer = Tailer::new(config.clone()).await.unwrap();
    tailer.snapshot_once().await.unwrap();

    // Restore
    let out_path = dir.path().join("restored_tx.teg");
    let rest = Restore::new(&config.s3, &config.s3_prefix()).await.unwrap();
    rest.restore_to(&out_path, None).await.unwrap();

    // Verify all transactions are preserved
    let mut rf = OpenOptions::new().read(true).open(&out_path).unwrap();
    let off_restored = find_last_commit_offset(&mut rf).unwrap();
    assert!(off_restored > STORAGE_HEADER_SIZE as u64);
}

#[tokio::test]
async fn test_multiple_backup_restore_cycles() {
    let config = match get_test_config(tempfile::tempdir().unwrap().path().join("cycles_test.teg"))
    {
        Some(cfg) => cfg,
        None => return,
    };

    let dir = tempfile::tempdir().unwrap();
    let db_path = dir.path().join("cycles_test.teg");
    let mut f = OpenOptions::new()
        .create(true)
        .truncate(true)
        .read(true)
        .write(true)
        .open(&db_path)
        .unwrap();

    write_header(&mut f);
    let mut tailer = Tailer::new(config.clone()).await.unwrap();

    // Multiple backup/restore cycles
    for cycle in 1..=3 {
        // Add data
        f.seek(SeekFrom::End(0)).unwrap();
        write_record(
            &mut f,
            format!("cycle{}", cycle).as_bytes(),
            format!("data{}", cycle).as_bytes(),
        );
        write_record(&mut f, TX_COMMIT_MARKER, b"");
        f.flush().unwrap();

        // Backup
        tailer.snapshot_once().await.unwrap();

        // Restore
        let out_path = dir.path().join(format!("restored_cycle{}.teg", cycle));
        let rest = Restore::new(&config.s3, &config.s3_prefix()).await.unwrap();
        rest.restore_to(&out_path, None).await.unwrap();

        // Verify
        let mut rf = OpenOptions::new().read(true).open(&out_path).unwrap();
        let off_restored = find_last_commit_offset(&mut rf).unwrap();
        assert!(off_restored > STORAGE_HEADER_SIZE as u64);
    }
}