cqlite-core 0.11.0

Core engine for CQLite — read Apache Cassandra 5.0 SSTables locally without a cluster
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
//! Integration tests for compression detection in SSTable readers.
//!
//! These tests use real SSTable data from test-data/datasets/sstables/
//! to verify compression detection and initialization (Issue #28 compliance).

use std::path::Path;
use std::sync::Arc;

use cqlite_core::storage::sstable::compression_info::CompressionInfo;
use cqlite_core::storage::sstable::reader::{extract_sstable_base_name, SSTableReader};
use cqlite_core::{Config, Platform};

/// Helper to get test datasets root
fn get_test_datasets_root() -> Option<std::path::PathBuf> {
    std::env::var("CQLITE_DATASETS_ROOT")
        .ok()
        .map(std::path::PathBuf::from)
}

/// Helper to find SSTable directory for a table
fn find_table_dir(
    datasets_root: &Path,
    keyspace: &str,
    table_prefix: &str,
) -> Option<std::path::PathBuf> {
    let keyspace_dir = datasets_root.join("sstables").join(keyspace);
    if !keyspace_dir.exists() {
        return None;
    }

    std::fs::read_dir(&keyspace_dir)
        .ok()?
        .filter_map(|e| e.ok())
        .map(|e| e.path())
        .find(|p| {
            p.is_dir()
                && p.file_name()
                    .and_then(|n| n.to_str())
                    .map(|n| n.starts_with(table_prefix))
                    .unwrap_or(false)
        })
}

/// Helper to find Data.db file in a table directory
fn find_data_file(table_dir: &Path) -> Option<std::path::PathBuf> {
    std::fs::read_dir(table_dir)
        .ok()?
        .filter_map(|e| e.ok())
        .map(|e| e.path())
        .find(|p| {
            p.is_file()
                && p.file_name()
                    .and_then(|n| n.to_str())
                    .map(|n| n.ends_with("-Data.db"))
                    .unwrap_or(false)
        })
}

// =============================================================================
// Integration Tests with Real SSTable Data
// =============================================================================

#[tokio::test]
async fn test_compression_detection_simple_table() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let Some(table_dir) = find_table_dir(&datasets_root, "test_basic", "simple_table") else {
        eprintln!("simple_table not found, skipping test");
        return;
    };

    let Some(data_file) = find_data_file(&table_dir) else {
        eprintln!("Data.db not found in simple_table, skipping test");
        return;
    };

    // Verify CompressionInfo.db exists
    let base_name = extract_sstable_base_name(&data_file).expect("Should extract base name");
    let compression_info_path = table_dir.join(format!("{}-CompressionInfo.db", base_name));

    assert!(
        compression_info_path.exists(),
        "CompressionInfo.db should exist at {:?}",
        compression_info_path
    );

    // Open SSTable reader to verify compression detection
    let config = Config::default();
    let platform = Arc::new(
        Platform::new(&config)
            .await
            .expect("Failed to create platform"),
    );

    let reader = SSTableReader::open(&data_file, &config, platform)
        .await
        .expect("Failed to open SSTable");

    // simple_table should be compressed - verify reader opened successfully
    // The reader internally detects compression from header or CompressionInfo.db
    eprintln!(
        "Successfully opened simple_table with Cassandra version: {:?}",
        reader.header().cassandra_version
    );
}

#[tokio::test]
async fn test_compression_detection_uncompressed_table() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let Some(table_dir) = find_table_dir(&datasets_root, "test_basic", "uncompressed_table") else {
        eprintln!("uncompressed_table not found, skipping test");
        return;
    };

    let Some(data_file) = find_data_file(&table_dir) else {
        eprintln!("Data.db not found in uncompressed_table, skipping test");
        return;
    };

    // Open SSTable reader
    let config = Config::default();
    let platform = Arc::new(
        Platform::new(&config)
            .await
            .expect("Failed to create platform"),
    );

    let reader = SSTableReader::open(&data_file, &config, platform)
        .await
        .expect("Failed to open SSTable");

    eprintln!(
        "Successfully opened uncompressed_table with Cassandra version: {:?}",
        reader.header().cassandra_version
    );

    // For uncompressed tables, compression reader should not be present
    // (or indicate no compression)
}

#[tokio::test]
async fn test_compression_detection_compression_test_table() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let Some(table_dir) = find_table_dir(&datasets_root, "test_basic", "compression_test_table")
    else {
        eprintln!("compression_test_table not found, skipping test");
        return;
    };

    let Some(data_file) = find_data_file(&table_dir) else {
        eprintln!("Data.db not found in compression_test_table, skipping test");
        return;
    };

    // Open SSTable reader
    let config = Config::default();
    let platform = Arc::new(
        Platform::new(&config)
            .await
            .expect("Failed to create platform"),
    );

    let reader = SSTableReader::open(&data_file, &config, platform)
        .await
        .expect("Failed to open SSTable");

    eprintln!(
        "Successfully opened compression_test_table with Cassandra version: {:?}",
        reader.header().cassandra_version
    );
}

#[tokio::test]
async fn test_compression_info_discovery_all_test_basic_tables() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let keyspace_dir = datasets_root.join("sstables").join("test_basic");
    if !keyspace_dir.exists() {
        eprintln!("test_basic keyspace not found, skipping test");
        return;
    }

    let entries: Vec<_> = std::fs::read_dir(&keyspace_dir)
        .expect("Should read keyspace dir")
        .filter_map(|e| e.ok())
        .filter(|e| e.path().is_dir())
        .collect();

    eprintln!("Found {} tables in test_basic", entries.len());

    let mut tables_with_compression = 0;
    let mut tables_without_compression = 0;

    for entry in entries {
        let table_dir = entry.path();
        let table_name = table_dir
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or("unknown");

        // Find Data.db file
        let Some(data_file) = find_data_file(&table_dir) else {
            eprintln!("  {} - No Data.db found", table_name);
            continue;
        };

        // Check for CompressionInfo.db
        if let Some(base_name) = extract_sstable_base_name(&data_file) {
            let compression_info_path = table_dir.join(format!("{}-CompressionInfo.db", base_name));
            if compression_info_path.exists() {
                let metadata =
                    std::fs::metadata(&compression_info_path).expect("Should get metadata");
                eprintln!(
                    "  {} - CompressionInfo.db: {} bytes",
                    table_name,
                    metadata.len()
                );
                tables_with_compression += 1;
            } else {
                eprintln!("  {} - No CompressionInfo.db (uncompressed)", table_name);
                tables_without_compression += 1;
            }
        } else {
            eprintln!("  {} - Could not extract base name", table_name);
        }
    }

    eprintln!(
        "\nSummary: {} compressed, {} uncompressed",
        tables_with_compression, tables_without_compression
    );

    // We expect at least some tables to be compressed
    assert!(
        tables_with_compression > 0,
        "Expected at least some compressed tables"
    );
}

#[tokio::test]
async fn test_extract_base_name_on_real_files() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let Some(table_dir) = find_table_dir(&datasets_root, "test_basic", "simple_table") else {
        eprintln!("simple_table not found, skipping test");
        return;
    };

    // Test on all .db files in the table directory
    let entries: Vec<_> = std::fs::read_dir(&table_dir)
        .expect("Should read table dir")
        .filter_map(|e| e.ok())
        .filter(|e| e.path().extension().map(|ext| ext == "db").unwrap_or(false))
        .collect();

    eprintln!("Found {} .db files in simple_table", entries.len());

    let mut extracted_base_names: std::collections::HashSet<String> =
        std::collections::HashSet::new();

    for entry in entries {
        let path = entry.path();
        let filename = path.file_name().and_then(|n| n.to_str()).unwrap_or("");

        if let Some(base_name) = extract_sstable_base_name(&path) {
            eprintln!("  {} -> {}", filename, base_name);
            extracted_base_names.insert(base_name);
        } else {
            eprintln!("  {} -> (no base name extracted)", filename);
        }
    }

    // All component files should have the same base name
    assert_eq!(
        extracted_base_names.len(),
        1,
        "All component files should have the same base name, got {:?}",
        extracted_base_names
    );
}

#[tokio::test]
async fn test_compression_info_file_sizes() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let keyspace_dir = datasets_root.join("sstables").join("test_basic");
    if !keyspace_dir.exists() {
        eprintln!("test_basic keyspace not found, skipping test");
        return;
    }

    // Find all CompressionInfo.db files and validate their sizes
    let mut compression_files: Vec<(String, u64)> = Vec::new();

    for entry in std::fs::read_dir(&keyspace_dir)
        .expect("Should read keyspace dir")
        .filter_map(|e| e.ok())
        .filter(|e| e.path().is_dir())
    {
        let table_dir = entry.path();
        for file_entry in std::fs::read_dir(&table_dir)
            .expect("Should read table dir")
            .filter_map(|e| e.ok())
        {
            let path = file_entry.path();
            if path
                .file_name()
                .and_then(|n| n.to_str())
                .map(|n| n.ends_with("-CompressionInfo.db"))
                .unwrap_or(false)
            {
                let metadata = std::fs::metadata(&path).expect("Should get metadata");
                let name = path
                    .parent()
                    .and_then(|p| p.file_name())
                    .and_then(|n| n.to_str())
                    .unwrap_or("unknown")
                    .to_string();
                compression_files.push((name, metadata.len()));
            }
        }
    }

    eprintln!("CompressionInfo.db file sizes:");
    for (name, size) in &compression_files {
        eprintln!("  {}: {} bytes", name, size);

        // Sanity check: CompressionInfo.db files should have minimum size
        // Header (4 bytes) + algorithm (at least 1 byte) + some chunk data
        assert!(
            *size >= 8,
            "CompressionInfo.db for {} is suspiciously small: {} bytes",
            name,
            size
        );
    }
}

#[tokio::test]
async fn test_open_all_test_basic_tables_with_compression() {
    let Some(datasets_root) = get_test_datasets_root() else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let keyspace_dir = datasets_root.join("sstables").join("test_basic");
    if !keyspace_dir.exists() {
        eprintln!("test_basic keyspace not found, skipping test");
        return;
    }

    let config = Config::default();
    let platform = Arc::new(
        Platform::new(&config)
            .await
            .expect("Failed to create platform"),
    );

    let entries: Vec<_> = std::fs::read_dir(&keyspace_dir)
        .expect("Should read keyspace dir")
        .filter_map(|e| e.ok())
        .filter(|e| e.path().is_dir())
        .collect();

    let mut success_count = 0;
    let mut fail_count = 0;

    for entry in entries {
        let table_dir = entry.path();
        let table_name = table_dir
            .file_name()
            .and_then(|n| n.to_str())
            .unwrap_or("unknown");

        let Some(data_file) = find_data_file(&table_dir) else {
            eprintln!("  {} - No Data.db found", table_name);
            continue;
        };

        match SSTableReader::open(&data_file, &config, platform.clone()).await {
            Ok(reader) => {
                eprintln!(
                    "{} - Opened successfully (version: {:?})",
                    table_name,
                    reader.header().cassandra_version
                );
                success_count += 1;
            }
            Err(e) => {
                eprintln!("{} - Failed: {}", table_name, e);
                fail_count += 1;
            }
        }
    }

    eprintln!(
        "\nResults: {} succeeded, {} failed",
        success_count, fail_count
    );

    // Most tables should open successfully
    assert!(
        success_count > 0,
        "Expected at least some tables to open successfully"
    );
}

/// Helper: find any nb-1-big-CompressionInfo.db under the datasets root.
/// Prefers the sensor_data table; falls back to any match for robustness.
fn find_compression_info_file(datasets_root: &Path) -> Option<std::path::PathBuf> {
    // Preferred path
    let preferred = datasets_root.join(
        "sstables/test_timeseries/sensor_data-6c698230a25111f0a3fef1a551383fb9/nb-1-big-CompressionInfo.db",
    );
    if preferred.exists() {
        return Some(preferred);
    }

    // Fallback: walk sstables directory for any CompressionInfo.db
    let sstables_root = datasets_root.join("sstables");
    if !sstables_root.exists() {
        return None;
    }
    for keyspace_entry in std::fs::read_dir(&sstables_root)
        .ok()?
        .filter_map(|e| e.ok())
    {
        let keyspace_dir = keyspace_entry.path();
        if !keyspace_dir.is_dir() {
            continue;
        }
        for table_entry in std::fs::read_dir(&keyspace_dir)
            .ok()?
            .filter_map(|e| e.ok())
        {
            let table_dir = table_entry.path();
            if !table_dir.is_dir() {
                continue;
            }
            for file_entry in std::fs::read_dir(&table_dir).ok()?.filter_map(|e| e.ok()) {
                let path = file_entry.path();
                if path
                    .file_name()
                    .and_then(|n| n.to_str())
                    .map(|n| n.ends_with("-CompressionInfo.db"))
                    .unwrap_or(false)
                {
                    return Some(path);
                }
            }
        }
    }
    None
}

/// Real-fixture integration test: parse a CompressionInfo.db file from the test
/// dataset and validate the key fields (Issue #638 fix).
///
/// Asserts:
/// - algorithm == "LZ4Compressor"
/// - chunk_length == 16384
/// - chunk_offsets is non-empty
/// - chunk_offsets are strictly increasing
#[test]
fn test_real_fixture_compression_info_parse() {
    let Some(datasets_root) = std::env::var("CQLITE_DATASETS_ROOT")
        .ok()
        .map(std::path::PathBuf::from)
    else {
        eprintln!("CQLITE_DATASETS_ROOT not set, skipping test");
        return;
    };

    let Some(ci_path) = find_compression_info_file(&datasets_root) else {
        eprintln!("No CompressionInfo.db found under datasets root, skipping test");
        return;
    };

    eprintln!("Parsing: {:?}", ci_path);

    let data =
        std::fs::read(&ci_path).unwrap_or_else(|e| panic!("Failed to read {:?}: {}", ci_path, e));

    let info = CompressionInfo::parse(&data)
        .unwrap_or_else(|e| panic!("CompressionInfo::parse failed on {:?}: {}", ci_path, e));

    assert_eq!(
        info.algorithm, "LZ4Compressor",
        "Expected LZ4Compressor, got {:?}",
        info.algorithm
    );

    assert_eq!(
        info.chunk_length, 16384,
        "Expected chunk_length == 16384, got {}",
        info.chunk_length
    );

    assert!(
        !info.chunk_offsets.is_empty(),
        "chunk_offsets must be non-empty"
    );

    // Verify chunk_offsets are strictly increasing
    for window in info.chunk_offsets.windows(2) {
        assert!(
            window[1] > window[0],
            "chunk_offsets must be strictly increasing: {} >= {}",
            window[0],
            window[1]
        );
    }

    eprintln!(
        "CompressionInfo parsed OK: algorithm={}, chunk_length={}, offsets={}",
        info.algorithm,
        info.chunk_length,
        info.chunk_offsets.len()
    );
}