cqlite-cli 0.11.0

Command-line interface for CQLite — read Apache Cassandra 5.0 SSTables 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
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
//! Integration tests for one-shot SELECT execution with ingestion
//!
//! Tests Issue #135: Wire ingestion into one-shot SELECT
//!
//! Requirements:
//! - `cqlite --schema ... --data-dir ... -e "SELECT ..."` reads SSTables via catalog
//! - Non-empty rows on `test-data`
//! - Correct exit codes: 3 (schema), 4 (data-dir/discovery), 5 (unsupported/query errors)
//! - Supports version precedence: flag > SSTable metadata > metadata.yml > unknown

#![allow(clippy::all)]

use std::path::PathBuf;
use std::process::Command;

const CLI_BINARY: &str = "cqlite";

/// Test helper to run CLI commands and capture output
fn run_cli_command(args: &[&str]) -> std::process::Output {
    Command::new("cargo")
        .args(&["run", "--quiet", "--bin", CLI_BINARY, "--"])
        .args(args)
        .output()
        .expect("Failed to execute CLI command")
}

/// Get the test data root directory from environment or default path
fn get_test_data_root() -> PathBuf {
    std::env::var("CQLITE_DATASETS_ROOT")
        .map(PathBuf::from)
        .unwrap_or_else(|_| {
            PathBuf::from(env!("CARGO_MANIFEST_DIR"))
                .parent()
                .unwrap()
                .join("test-data/datasets")
        })
}

/// Get the schemas directory
fn get_schemas_dir() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .unwrap()
        .join("test-data/schemas")
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_with_ingestion_basic() {
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found at {:?}",
        data_dir
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--format",
        "json",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should succeed (exit code 0)
    assert!(
        output.status.success(),
        "One-shot SELECT should succeed. Exit code: {:?}",
        output.status.code()
    );

    // Should produce output (rows or empty result, but not an error)
    let _stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);

    // Should not contain critical errors
    assert!(
        !stderr.contains("error") || stderr.contains("INFO"),
        "Should not contain errors in stderr"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_with_invalid_schema_exit_code_3() {
    let data_dir = get_test_data_root().join("sstables");
    let invalid_schema = PathBuf::from("/tmp/nonexistent_schema.cql");

    // Assert test data is available
    assert!(
        data_dir.exists(),
        "Test requires full SSTable dataset: test data not found at {:?}",
        data_dir
    );

    let output = run_cli_command(&[
        "--schema",
        invalid_schema.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should fail with exit code 3 (schema error)
    let exit_code = output.status.code().unwrap_or(1);
    assert_eq!(
        exit_code, 3,
        "Invalid schema should return exit code 3, got {}",
        exit_code
    );

    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("schema")
            || stderr.contains("Ingestion failed")
            || stderr.contains("Path does not exist"),
        "Error message should mention schema or path error"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_with_invalid_data_dir_exit_code_4() {
    let invalid_data_dir = PathBuf::from("/tmp/nonexistent_data_directory");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Skip if schema not available
    assert!(
        schema_file.exists(),
        "Test requires full SSTable dataset: schema not found at {:?}",
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        invalid_data_dir.to_str().unwrap(),
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should fail with exit code 4 (discovery/data-dir error)
    let exit_code = output.status.code().unwrap_or(1);
    assert_eq!(
        exit_code, 4,
        "Invalid data-dir should return exit code 4, got {}",
        exit_code
    );

    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stderr.contains("data")
            || stderr.contains("directory")
            || stderr.contains("Path does not exist")
            || stderr.contains("Ingestion failed"),
        "Error message should mention data directory error"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_with_version_hint() {
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--cassandra-version",
        "5.0",
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--format",
        "json",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should succeed with version hint
    assert!(
        output.status.success(),
        "One-shot SELECT with version hint should succeed"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_table_format() {
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--format",
        "table",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(
        output.status.success(),
        "Table format output should succeed"
    );

    // Table format should produce some output
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(!stdout.is_empty(), "Table format should produce output");
}

#[test]
#[cfg(feature = "state_machine")]
fn test_one_shot_select_csv_format() {
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "-e",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--format",
        "csv",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(output.status.success(), "CSV format output should succeed");

    // CSV format should produce some output
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(!stdout.is_empty(), "CSV format should produce output");
}

// ============================================================================
// Issue #223: --query parameter tests (alias for --execute)
// ============================================================================

#[test]
#[cfg(feature = "state_machine")]
fn test_query_parameter_alias_for_execute() {
    // Issue #223: --query should work identically to --execute
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query", // Using --query alias instead of -e
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--format",
        "json",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should succeed (exit code 0)
    assert!(
        output.status.success(),
        "--query alias should succeed. Exit code: {:?}",
        output.status.code()
    );

    // Should produce non-empty output
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        !stdout.is_empty(),
        "--query should produce output identical to -e"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_out_parameter_json_format() {
    // Issue #223: --out should control output format
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--out", // Using --out instead of --format
        "json",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(
        output.status.success(),
        "--out json should succeed. Exit code: {:?}",
        output.status.code()
    );

    // Output should be valid JSON (starts with { or [)
    let stdout = String::from_utf8_lossy(&output.stdout);
    let trimmed = stdout.trim();
    assert!(
        trimmed.starts_with('{') || trimmed.starts_with('['),
        "--out json should produce JSON output, got: {}",
        &trimmed[..trimmed.len().min(100)]
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_out_parameter_csv_format() {
    // Issue #223: --out csv should produce CSV output
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--out",
        "csv",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(
        output.status.success(),
        "--out csv should succeed. Exit code: {:?}",
        output.status.code()
    );

    // CSV output should contain commas (header line at minimum)
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(
        stdout.contains(',') || stdout.lines().count() > 0,
        "--out csv should produce CSV-like output"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_out_parameter_table_format() {
    // Issue #223: --out table should produce table output
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query",
        "SELECT * FROM test_basic.simple_table LIMIT 5",
        "--out",
        "table",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(
        output.status.success(),
        "--out table should succeed. Exit code: {:?}",
        output.status.code()
    );

    // Table output should contain some output
    let stdout = String::from_utf8_lossy(&output.stdout);
    assert!(!stdout.is_empty(), "--out table should produce output");
}

#[test]
#[cfg(feature = "state_machine")]
fn test_query_and_out_combined_prd_example() {
    // Issue #223: Test the exact PRD example usage pattern
    // cqlite --schema schema.json --data-dir /path/to/sstables \
    //   --query "SELECT * FROM users WHERE id = 'abc'" \
    //   --out json
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query",
        "SELECT * FROM test_basic.simple_table LIMIT 3",
        "--out",
        "json",
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));
    eprintln!("STDERR:\n{}", String::from_utf8_lossy(&output.stderr));

    // Should succeed - this is the PRD-specified usage
    assert!(
        output.status.success(),
        "PRD example (--query + --out json) should succeed. Exit code: {:?}",
        output.status.code()
    );

    // Should produce JSON output
    let stdout = String::from_utf8_lossy(&output.stdout);
    let trimmed = stdout.trim();
    assert!(
        trimmed.starts_with('{') || trimmed.starts_with('['),
        "PRD example should produce JSON output"
    );
}

#[test]
#[cfg(feature = "state_machine")]
fn test_out_takes_precedence_over_format() {
    // Issue #223: --out should override --format when both are specified
    let data_dir = get_test_data_root().join("sstables");
    let schema_file = get_schemas_dir().join("basic-types.cql");

    // Assert test data is available
    assert!(
        data_dir.exists() && schema_file.exists(),
        "Test requires full SSTable dataset: test data not found. data_dir={:?}, schema_file={:?}",
        data_dir,
        schema_file
    );

    let output = run_cli_command(&[
        "--schema",
        schema_file.to_str().unwrap(),
        "--data-dir",
        data_dir.to_str().unwrap(),
        "--query",
        "SELECT id, name FROM test_basic.simple_table LIMIT 1",
        "--format",
        "table", // This should be overridden
        "--out",
        "json", // This should win
    ]);

    eprintln!("Exit status: {}", output.status);
    eprintln!("STDOUT:\n{}", String::from_utf8_lossy(&output.stdout));

    // Should succeed
    assert!(
        output.status.success(),
        "--out should take precedence over --format. Exit code: {:?}",
        output.status.code()
    );

    // Output should be JSON (not table format)
    let stdout = String::from_utf8_lossy(&output.stdout);
    let trimmed = stdout.trim();
    assert!(
        trimmed.starts_with('{') || trimmed.starts_with('['),
        "--out json should override --format table, but got: {}",
        &trimmed[..trimmed.len().min(100)]
    );
}