vmdk-cli 0.3.0

CLI tool for inspecting VMDK disk images
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
use std::process::Command;

fn vmdk_bin() -> Command {
    Command::new(env!("CARGO_BIN_EXE_vmdk"))
}

fn data_path(name: &str) -> String {
    // CARGO_MANIFEST_DIR is vmdk-cli/ → workspace root is one level up
    std::path::Path::new(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .expect("workspace root")
        .join("vmdk/tests/data")
        .join(name)
        .to_string_lossy()
        .into_owned()
}

// ── info ──────────────────────────────────────────────────────────────────────

#[test]
fn info_shows_virtual_disk_size_minimal() {
    let out = vmdk_bin()
        .args(["info", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit status: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("1,048,576") || stdout.contains("1 MiB"),
        "expected virtual disk size in output, got: {stdout}"
    );
}

#[test]
fn info_shows_format_monolithic_sparse() {
    let out = vmdk_bin()
        .args(["info", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit status: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("monolithicSparse"),
        "expected monolithicSparse in format line, got: {stdout}"
    );
}

#[test]
fn info_shows_sector_size() {
    let out = vmdk_bin()
        .args(["info", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit status: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("512"),
        "expected sector size 512 in output, got: {stdout}"
    );
}

#[test]
fn info_dfvfs_ext2_virtual_disk_size() {
    let out = vmdk_bin()
        .args(["info", &data_path("dfvfs_ext2.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit status: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("4,194,304") || stdout.contains("4 MiB"),
        "expected 4 MiB virtual disk size, got: {stdout}"
    );
}

#[test]
fn info_errors_on_missing_file() {
    let out = vmdk_bin()
        .args(["info", "nonexistent.vmdk"])
        .output()
        .expect("vmdk binary must run");
    assert!(
        !out.status.success(),
        "should exit non-zero for missing file"
    );
}

#[test]
fn info_shows_stream_optimized_disk_type() {
    let out = vmdk_bin()
        .args(["info", &data_path("stream_opt.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("streamOptimized"),
        "expected streamOptimized in output, got: {stdout}"
    );
}

#[test]
fn info_shows_flat_vmdk_disk_type() {
    let out = vmdk_bin()
        .args(["info", &data_path("flat.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("twoGbMaxExtentFlat"),
        "expected twoGbMaxExtentFlat in output, got: {stdout}"
    );
}

#[test]
fn info_lists_companion_extent_files() {
    // A multi-file VMDK's info must name the companion file(s) to collect.
    let out = vmdk_bin()
        .args(["info", &data_path("flat.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("flat-f001.vmdk"),
        "info must list the companion extent file, got: {stdout}"
    );
}

#[test]
fn info_omits_dependencies_for_self_contained() {
    // A self-contained binary VMDK must not print a dependencies section.
    let out = vmdk_bin()
        .args(["info", &data_path("dfvfs_ext2.vmdk")])
        .output()
        .expect("vmdk binary must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        !stdout.to_lowercase().contains("companion") && !stdout.to_lowercase().contains("depends"),
        "self-contained VMDK must omit the dependencies section, got: {stdout}"
    );
}

// ── info --descriptor (folds in old `descriptor` command) ─────────────────────

#[test]
fn info_descriptor_flag_shows_create_type() {
    let out = vmdk_bin()
        .args(["info", "--descriptor", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk info --descriptor must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("createType") || stdout.contains("monolithicSparse"),
        "expected raw descriptor text, got: {stdout}"
    );
}

// ── info --chain (folds in old `snapshot-chain` command) ──────────────────────

#[test]
fn info_chain_flag_base_image_shows_depth_one() {
    let out = vmdk_bin()
        .args(["info", "--chain", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk info --chain must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("1 layer") || stdout.contains("depth: 1"),
        "expected chain depth 1, got: {stdout}"
    );
}

// ── map (renamed from `sectors`) ──────────────────────────────────────────────

#[test]
fn map_all_sparse_shows_no_allocated() {
    let out = vmdk_bin()
        .args(["map", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk map must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("start_lba")
            || stdout.contains("No allocated")
            || stdout.contains("sparse"),
        "got: {stdout}"
    );
}

#[test]
fn map_dfvfs_shows_allocated_grains() {
    let out = vmdk_bin()
        .args(["map", &data_path("dfvfs_ext2.vmdk")])
        .output()
        .expect("vmdk map must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains(',') || stdout.contains("allocated grain"),
        "expected allocated grain ranges, got: {stdout}"
    );
}

// ── dump (folds in cat + extract + hexdump) ───────────────────────────────────

#[test]
fn dump_to_stdout_outputs_disk_bytes() {
    // Default dump (no -o, no --hex) writes raw bytes to stdout (was: cat).
    let out = vmdk_bin()
        .args(["dump", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk dump must run");
    assert!(out.status.success(), "exit: {}", out.status);
    // minimal.vmdk is 1 MiB all-zeros → stdout should be 1,048,576 zero bytes
    assert_eq!(
        out.stdout.len(),
        1_048_576,
        "dump must emit full virtual disk to stdout"
    );
    assert!(
        out.stdout.iter().all(|&b| b == 0),
        "all-sparse disk must dump as zeros"
    );
}

#[test]
fn dump_hex_flag_outputs_hex() {
    let out = vmdk_bin()
        .args([
            "dump",
            "--hex",
            "--offset",
            "0",
            "--length",
            "32",
            &data_path("dfvfs_ext2.vmdk"),
        ])
        .output()
        .expect("vmdk dump --hex must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("00000000"),
        "expected hex offset column, got: {stdout}"
    );
}

#[test]
fn dump_output_file_produces_raw_of_correct_size() {
    let tmp = tempfile::tempdir().expect("tempdir");
    let out_path = tmp.path().join("out.raw");
    let status = vmdk_bin()
        .args([
            "dump",
            "-o",
            out_path.to_str().unwrap(),
            &data_path("minimal.vmdk"),
        ])
        .status()
        .expect("vmdk dump -o must run");
    assert!(status.success(), "exit: {status}");
    let meta = std::fs::metadata(&out_path).expect("output file must exist");
    assert_eq!(meta.len(), 1_048_576, "raw file must be 1 MiB");
}

#[test]
fn dump_offset_length_reads_subrange() {
    // Dump 16 bytes at offset 1024 of dfvfs_ext2 (has real data there) to a file.
    let tmp = tempfile::tempdir().expect("tempdir");
    let out_path = tmp.path().join("range.raw");
    let status = vmdk_bin()
        .args([
            "dump",
            "--offset",
            "1024",
            "--length",
            "16",
            "-o",
            out_path.to_str().unwrap(),
            &data_path("dfvfs_ext2.vmdk"),
        ])
        .status()
        .expect("vmdk dump range must run");
    assert!(status.success(), "exit: {status}");
    let meta = std::fs::metadata(&out_path).expect("output file");
    assert_eq!(meta.len(), 16, "range dump must be exactly 16 bytes");
}

// ── hash ──────────────────────────────────────────────────────────────────────

#[test]
fn hash_produces_sha256_and_md5() {
    let out = vmdk_bin()
        .args(["hash", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk hash must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("SHA-256"),
        "expected SHA-256 line, got: {stdout}"
    );
    assert!(stdout.contains("MD5"), "expected MD5 line, got: {stdout}");
}

#[test]
fn hash_minimal_vmdk_matches_known_md5() {
    let out = vmdk_bin()
        .args(["hash", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk hash must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("b6d81b360a5672d80c27430f39153e2c"),
        "MD5 mismatch, got: {stdout}"
    );
}

// ── verify ────────────────────────────────────────────────────────────────────

#[test]
fn verify_minimal_vmdk_exits_ok() {
    let out = vmdk_bin()
        .args(["verify", &data_path("minimal.vmdk")])
        .output()
        .expect("vmdk verify must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("OK"),
        "expected OK in verify output, got: {stdout}"
    );
}

#[test]
fn verify_reports_integrity_for_clean_image() {
    let out = vmdk_bin()
        .args(["verify", &data_path("dfvfs_ext2.vmdk")])
        .output()
        .expect("vmdk verify must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("Integrity"),
        "verify must report an integrity line, got: {stdout}"
    );
}

#[test]
fn verify_detects_corruption_and_exits_nonzero() {
    // Truncate a real allocated-grain image so its grain pointers dangle.
    let tmp = tempfile::tempdir().expect("tempdir");
    let mut data = std::fs::read(data_path("dfvfs_ext2.vmdk")).expect("read corpus");
    data.truncate(data.len() / 2);
    let p = tmp.path().join("truncated.vmdk");
    std::fs::write(&p, &data).expect("write truncated");
    let out = vmdk_bin()
        .args(["verify", p.to_str().unwrap()])
        .output()
        .expect("vmdk verify must run");
    assert!(
        !out.status.success(),
        "verify must exit non-zero on a corrupted image"
    );
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.to_uppercase().contains("FAIL") || stdout.contains("out-of-bounds"),
        "verify must flag the corruption, got: {stdout}"
    );
}

// ── diff ──────────────────────────────────────────────────────────────────────

#[test]
fn diff_identical_vmdk_reports_identical() {
    let path = data_path("minimal.vmdk");
    let out = vmdk_bin()
        .args(["diff", &path, &path])
        .output()
        .expect("vmdk diff must run");
    assert!(out.status.success(), "exit: {}", out.status);
    let stdout = String::from_utf8_lossy(&out.stdout);
    assert!(
        stdout.contains("IDENTICAL"),
        "expected IDENTICAL, got: {stdout}"
    );
}

#[test]
fn diff_different_vmdks_exits_nonzero() {
    let out = vmdk_bin()
        .args([
            "diff",
            &data_path("minimal.vmdk"),
            &data_path("dfvfs_ext2.vmdk"),
        ])
        .output()
        .expect("vmdk diff must run");
    assert!(
        !out.status.success(),
        "diff of different VMDKs (different sizes) must exit non-zero"
    );
}

// ── e2e coverage: per-command error / output branches ────────────────────────

fn write_tmp(dir: &tempfile::TempDir, name: &str, bytes: &[u8]) -> String {
    let p = dir.path().join(name);
    std::fs::write(&p, bytes).expect("write fixture");
    p.to_string_lossy().into_owned()
}

#[test]
fn info_shows_parent_cid_for_delta() {
    let dir = tempfile::tempdir().unwrap();
    let desc = "# Disk DescriptorFile\nversion=1\nCID=00000002\nparentCID=00000001\nparentFileNameHint=\"base.vmdk\"\ncreateType=\"monolithicSparse\"\n";
    let bytes = vmdk::testutil::test_sparse_vmdk_with_descriptor(&[0u8; 512], desc);
    let p = write_tmp(&dir, "delta.vmdk", &bytes);
    let out = vmdk_bin().args(["info", &p]).output().unwrap();
    assert!(out.status.success(), "exit: {}", out.status);
    let s = String::from_utf8_lossy(&out.stdout);
    assert!(
        s.contains("Parent CID"),
        "delta must show Parent CID, got: {s}"
    );
}

#[test]
fn info_descriptor_errors_when_absent() {
    // A binary VMDK with descriptor_offset/size = 0 has no embedded descriptor.
    let dir = tempfile::tempdir().unwrap();
    let mut bytes = vmdk::testutil::test_sparse_vmdk(&[0u8; 512]);
    bytes[28..36].copy_from_slice(&0u64.to_le_bytes()); // descriptor_offset = 0
    bytes[36..44].copy_from_slice(&0u64.to_le_bytes()); // descriptor_size = 0
    let p = write_tmp(&dir, "nodesc.vmdk", &bytes);
    let out = vmdk_bin()
        .args(["info", "--descriptor", &p])
        .output()
        .unwrap();
    assert!(
        !out.status.success(),
        "no-descriptor image must error on --descriptor"
    );
}

#[test]
fn info_chain_falls_back_on_missing_parent() {
    let dir = tempfile::tempdir().unwrap();
    let desc = "# Disk DescriptorFile\nversion=1\nCID=00000002\nparentCID=00000001\nparentFileNameHint=\"missing-base.vmdk\"\ncreateType=\"monolithicSparse\"\n";
    let bytes = vmdk::testutil::test_sparse_vmdk_with_descriptor(&[0u8; 512], desc);
    let p = write_tmp(&dir, "delta.vmdk", &bytes);
    let out = vmdk_bin().args(["info", "--chain", &p]).output().unwrap();
    assert!(out.status.success(), "exit: {}", out.status);
    let s = String::from_utf8_lossy(&out.stdout);
    assert!(
        s.contains("Parent CID") || s.contains("parent file not found"),
        "missing-parent chain must report the dangling parent, got: {s}"
    );
}

#[test]
fn commands_error_on_non_vmdk_file() {
    let dir = tempfile::tempdir().unwrap();
    let p = write_tmp(&dir, "garbage.bin", b"not a vmdk at all, just bytes");
    for cmd in [["info"], ["map"], ["verify"], ["hash"]] {
        let out = vmdk_bin().args([cmd[0], &p]).output().unwrap();
        assert!(
            !out.status.success(),
            "{} on garbage must exit non-zero",
            cmd[0]
        );
    }
}

#[test]
fn dump_output_to_unwritable_path_errors() {
    let p = data_path("minimal.vmdk");
    let out = vmdk_bin()
        .args(["dump", "-o", "/no_such_dir_xyz/out.raw", &p])
        .output()
        .unwrap();
    assert!(
        !out.status.success(),
        "dump to an uncreatable path must error"
    );
}

#[test]
fn dump_hex_partial_line_and_nonprintable() {
    // Length 20 → one full 16-byte row + a 4-byte partial row (exercises padding);
    // dfvfs offset 1024 contains a mix of printable and non-printable bytes.
    let out = vmdk_bin()
        .args([
            "dump",
            "--hex",
            "--offset",
            "1024",
            "--length",
            "20",
            &data_path("dfvfs_ext2.vmdk"),
        ])
        .output()
        .unwrap();
    assert!(out.status.success(), "exit: {}", out.status);
    let s = String::from_utf8_lossy(&out.stdout);
    assert!(s.contains("00000400"), "offset column present");
    assert!(
        s.lines().count() >= 2,
        "partial second row must render, got: {s}"
    );
}

#[test]
fn verify_reports_rgd_ok_for_image_with_matching_rgd() {
    // test_sparse_vmdk writes a redundant grain directory identical to the primary.
    let dir = tempfile::tempdir().unwrap();
    let bytes = vmdk::testutil::test_sparse_vmdk(&[0u8; 512]);
    let p = write_tmp(&dir, "withrgd.vmdk", &bytes);
    let out = vmdk_bin().args(["verify", &p]).output().unwrap();
    assert!(out.status.success(), "exit: {}", out.status);
    let s = String::from_utf8_lossy(&out.stdout);
    assert!(s.contains("RGD:     OK"), "must report RGD OK, got: {s}");
}

#[test]
fn diff_same_size_different_content_reports_differences() {
    let dir = tempfile::tempdir().unwrap();
    let mut a_data = vec![0u8; 512];
    a_data[0] = 0xAA;
    let mut b_data = vec![0u8; 512];
    b_data[0] = 0xBB;
    let a = write_tmp(&dir, "a.vmdk", &vmdk::testutil::test_sparse_vmdk(&a_data));
    let b = write_tmp(&dir, "b.vmdk", &vmdk::testutil::test_sparse_vmdk(&b_data));
    let out = vmdk_bin().args(["diff", &a, &b]).output().unwrap();
    assert!(!out.status.success(), "differing images must exit non-zero");
    let s = String::from_utf8_lossy(&out.stdout);
    assert!(s.contains("DIFFER"), "must report DIFFER, got: {s}");
}