qrab 0.1.0

A readable quantum-circuit compiler for TikZ and Typst
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

use std::fs;

use assert_cmd::cargo::cargo_bin_cmd;
use predicates::prelude::*;

#[test]
fn clap_handles_help_errors_delimiters_and_conflicts() {
    cargo_bin_cmd!("qrab")
        .arg("--help")
        .assert()
        .success()
        .stdout(predicate::str::contains("Usage: qrab <COMMAND>"));
    cargo_bin_cmd!("qrab")
        .args(["check", "--version"])
        .assert()
        .success()
        .stdout(predicate::str::contains(env!("CARGO_PKG_VERSION")));
    cargo_bin_cmd!("qrab")
        .args(["compil", "missing.qrab"])
        .assert()
        .code(2)
        .stderr(predicate::str::contains("compile"));
    cargo_bin_cmd!("qrab")
        .args(["compile", "missing.qrab", "-o", "--target"])
        .assert()
        .code(2)
        .stderr(predicate::str::contains("--output <OUTPUT>"));
    cargo_bin_cmd!("qrab")
        .args(["compile", "missing.qrab", "-t", "latex", "-t", "typst"])
        .assert()
        .code(2)
        .stderr(predicate::str::contains("cannot be used multiple times"));
    cargo_bin_cmd!("qrab")
        .args([
            "compile",
            "missing.qrab",
            "-o",
            "output.tex",
            "--target",
            "all",
        ])
        .assert()
        .code(2)
        .stderr(predicate::str::contains(
            "cannot be used with '--target all'",
        ));

    let directory =
        std::env::temp_dir().join(format!("qrab-cli-{}-{}", std::process::id(), line!()));
    fs::create_dir(&directory).expect("create CLI test directory");
    let source = directory.join("input.qrab");
    fs::write(&source, "circuit cli { qubit q; h q }\n").expect("write CLI test source");
    cargo_bin_cmd!("qrab")
        .args(["compile", "--"])
        .arg(&source)
        .assert()
        .success();
    assert!(source.with_extension("tex").is_file());
    assert!(source.with_extension("typ").is_file());
    assert!(source.with_extension("svg").is_file());
    fs::remove_dir_all(directory).expect("remove CLI test directory");

    let missing = std::env::temp_dir().join(format!(
        "qrab-missing-source-{}-{}.qrab",
        std::process::id(),
        line!()
    ));
    cargo_bin_cmd!("qrab")
        .arg("check")
        .arg(missing)
        .assert()
        .code(1)
        .stderr(predicate::str::contains("cannot read"))
        .stderr(predicate::str::contains("Usage:").not());
}

/// The man pages ship in every release archive, and their version comes from
/// whichever crate compiled `cli.rs`. That is `xtask`, not this one, so the
/// override in `xtask` is the only thing keeping them from advertising a
/// version that was never released.
#[test]
fn shipped_man_pages_carry_this_crate_version() {
    let version = env!("CARGO_PKG_VERSION");
    for page in ["qrab.1", "qrab-check.1", "qrab-compile.1"] {
        let path = concat!(env!("CARGO_MANIFEST_DIR"), "/assets/");
        let text = fs::read_to_string(format!("{path}{page}"))
            .unwrap_or_else(|error| panic!("reading assets/{page}: {error}"));
        assert!(
            text.contains(version),
            "assets/{page} does not mention version {version}; run `just gen-assets`"
        );
    }
}

#[test]
fn miette_reports_imported_source_help_and_multiple_errors() {
    let directory = std::env::temp_dir().join(format!(
        "qrab-diagnostics-{}-{}",
        std::process::id(),
        line!()
    ));
    fs::create_dir(&directory).expect("create diagnostic test directory");
    fs::write(
        directory.join("gates.qrab"),
        "fn broken(a) { // context before\n\th missing\n} // context after\n",
    )
    .expect("write imported source");
    let imported = directory.join("imported.qrab");
    fs::write(
        &imported,
        "import \"gates.qrab\"\ncircuit imported { qubit q; broken(q) }\n",
    )
    .expect("write importing source");
    cargo_bin_cmd!("qrab")
        .env("NO_COLOR", "1")
        .arg("check")
        .arg(&imported)
        .assert()
        .code(1)
        .stderr(predicate::str::contains("gates.qrab:2:4"))
        .stderr(predicate::str::contains("context before"))
        .stderr(predicate::str::contains("context after"))
        .stderr(predicate::str::contains("h missing"))
        .stderr(predicate::str::contains(
            "declare it before use or enable `autowires`",
        ));

    let multiple = directory.join("multiple.qrab");
    fs::write(
        &multiple,
        "circuit bad {\n\tqubit q\n\th missing\n\tx absent\n}\n",
    )
    .expect("write multiple-error source");
    cargo_bin_cmd!("qrab")
        .env("NO_COLOR", "1")
        .arg("check")
        .arg(&multiple)
        .assert()
        .code(1)
        .stderr(predicate::str::contains("2 errors found"))
        .stderr(predicate::str::contains("unknown wire `missing`"))
        .stderr(predicate::str::contains("unknown wire `absent`"));

    fs::remove_dir_all(directory).expect("remove diagnostic test directory");
}