vpxtool 0.33.9

Terminal based frontend and utilities for Visual Pinball
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

//! Aborting at an overwrite prompt must exit non-zero so scripted callers
//! can detect that nothing was written.
//! See https://github.com/francisdb/vpxtool/issues/827

use std::io::Write;
use std::path::Path;
use std::process::{Command, Output, Stdio};
use testdir::testdir;

/// Runs the vpxtool binary in `dir`. `stdin` of `None` means stdin is closed
/// (the no-TTY scripted case); `Some` pipes the given answer to the prompt.
fn vpxtool(dir: &Path, args: &[&str], stdin: Option<&str>) -> Output {
    let mut child = Command::new(env!("CARGO_BIN_EXE_vpxtool"))
        .args(args)
        .current_dir(dir)
        .stdin(if stdin.is_some() {
            Stdio::piped()
        } else {
            Stdio::null()
        })
        .stdout(Stdio::piped())
        .stderr(Stdio::piped())
        .spawn()
        .expect("failed to spawn vpxtool");
    if let Some(input) = stdin {
        child
            .stdin
            .as_mut()
            .expect("stdin not piped")
            .write_all(input.as_bytes())
            .expect("failed to write to stdin");
    }
    child
        .wait_with_output()
        .expect("failed to wait for vpxtool")
}

fn assert_aborted(output: &Output) {
    let stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert!(
        stdout.contains("Aborted"),
        "expected \"Aborted\" on stdout, got stdout: {stdout:?}, stderr: {stderr:?}"
    );
    assert_eq!(
        output.status.code(),
        Some(1),
        "expected exit code 1 on abort, got {:?}, stdout: {stdout:?}, stderr: {stderr:?}",
        output.status.code()
    );
}

#[test]
fn assemble_abort_answer_no_exits_nonzero() {
    let dir = testdir!();
    std::fs::create_dir(dir.join("expanded")).unwrap();
    std::fs::write(dir.join("out.vpx"), b"original").unwrap();

    let output = vpxtool(&dir, &["assemble", "expanded", "out.vpx"], Some("n\n"));

    assert_aborted(&output);
    assert_eq!(std::fs::read(dir.join("out.vpx")).unwrap(), b"original");
}

#[test]
fn assemble_abort_closed_stdin_exits_nonzero() {
    let dir = testdir!();
    std::fs::create_dir(dir.join("expanded")).unwrap();
    std::fs::write(dir.join("out.vpx"), b"original").unwrap();

    let output = vpxtool(&dir, &["assemble", "expanded", "out.vpx"], None);

    assert_aborted(&output);
    assert_eq!(std::fs::read(dir.join("out.vpx")).unwrap(), b"original");
}

#[test]
fn extract_abort_answer_no_exits_nonzero() {
    let dir = testdir!();
    std::fs::write(dir.join("table.vpx"), b"not read before the prompt").unwrap();
    // default output dir is the vpx path without extension
    std::fs::create_dir(dir.join("table")).unwrap();
    std::fs::write(dir.join("table").join("keep.txt"), b"keep").unwrap();

    let output = vpxtool(&dir, &["extract", "table.vpx"], Some("n\n"));

    assert_aborted(&output);
    assert!(dir.join("table").join("keep.txt").exists());
}

#[test]
fn info_extract_abort_answer_no_exits_nonzero() {
    let dir = testdir!();
    std::fs::write(dir.join("table.vpx"), b"not read before the prompt").unwrap();
    std::fs::write(dir.join("table.info.json"), b"original").unwrap();

    let output = vpxtool(&dir, &["info", "extract", "table.vpx"], Some("n\n"));

    assert_aborted(&output);
    assert_eq!(
        std::fs::read(dir.join("table.info.json")).unwrap(),
        b"original"
    );
}

#[test]
fn export_vpxz_abort_answer_no_exits_nonzero() {
    let dir = testdir!();
    std::fs::write(dir.join("table.vpx"), b"not read before the prompt").unwrap();
    std::fs::write(dir.join("out.vpxz"), b"original").unwrap();

    let output = vpxtool(
        &dir,
        &["export", "vpxz", "table.vpx", "-o", "out.vpxz"],
        Some("n\n"),
    );

    assert_aborted(&output);
    assert_eq!(std::fs::read(dir.join("out.vpxz")).unwrap(), b"original");
}

/// Positive control: confirming the prompt still succeeds with exit code 0.
#[test]
fn info_extract_answer_yes_exits_zero() {
    let dir = testdir!();
    let output = vpxtool(&dir, &["new", "table.vpx"], None);
    assert!(
        output.status.success(),
        "failed to create test vpx: {:?}",
        String::from_utf8_lossy(&output.stderr)
    );
    std::fs::write(dir.join("table.info.json"), b"stale").unwrap();

    let output = vpxtool(&dir, &["info", "extract", "table.vpx"], Some("y\n"));

    let stdout = String::from_utf8_lossy(&output.stdout);
    let stderr = String::from_utf8_lossy(&output.stderr);
    assert_eq!(
        output.status.code(),
        Some(0),
        "stdout: {stdout:?}, stderr: {stderr:?}"
    );
    assert_ne!(
        std::fs::read(dir.join("table.info.json")).unwrap(),
        b"stale"
    );
}