bynk 0.142.0

The Bynk developer front-end — links the compiler pipeline in-process and orchestrates the Node toolchain (doctor / new / dev).
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

//! `bynk check` / `bynk fmt` / `bynk test` — the everyday commands the driver
//! grew in v0.138 (#487).
//!
//! Two things are pinned:
//!  1. **The in-process commands work through the driver** — `check` and `fmt`
//!     run with no `bynkc` binary in play, over the real CLI wiring (clap →
//!     dispatch → module), with deterministic (relative-path) output.
//!  2. **Drop-in equivalence with `bynkc`** — when the sibling `bynkc` binary is
//!     present next to `bynk` (a full workspace build), `bynk check`/`fmt` are
//!     byte-for-byte identical to `bynkc check`/`fmt`, and `bynk test` delegates
//!     to it. These parity checks **skip** (rather than fail) when `bynkc` was
//!     not built — e.g. under a bare `cargo test -p bynk` — so the file is green
//!     either way and exhaustive under a workspace test run.

use std::path::{Path, PathBuf};
use std::process::{Command, Stdio};

// ---------------------------------------------------------------------------
// Harness
// ---------------------------------------------------------------------------

/// The `bynk` binary under test.
fn bynk() -> PathBuf {
    PathBuf::from(env!("CARGO_BIN_EXE_bynk"))
}

/// The sibling `bynkc` the driver would resolve — present only when the whole
/// workspace was built. Parity tests gate on this.
fn bynkc_sibling() -> Option<PathBuf> {
    let p = bynk().parent().unwrap().join("bynkc");
    p.exists().then_some(p)
}

/// A clean, empty scratch directory unique to `name`, under the crate's test
/// tmpdir (cleaned between runs).
fn scratch(name: &str) -> PathBuf {
    let dir = PathBuf::from(env!("CARGO_TARGET_TMPDIR")).join(name);
    let _ = std::fs::remove_dir_all(&dir);
    std::fs::create_dir_all(&dir).unwrap();
    dir
}

fn write(path: &Path, contents: &str) {
    if let Some(parent) = path.parent() {
        std::fs::create_dir_all(parent).unwrap();
    }
    std::fs::write(path, contents).unwrap();
}

/// Run `bynk <args>` in `cwd`, capturing (code, stdout, stderr).
fn run_bynk_in(cwd: &Path, args: &[&str]) -> (i32, String, String) {
    run_in(&bynk(), cwd, args, None)
}

/// Run a binary in `cwd`, optionally feeding `stdin`, capturing (code, out, err).
fn run_in(bin: &Path, cwd: &Path, args: &[&str], stdin: Option<&str>) -> (i32, String, String) {
    let mut cmd = Command::new(bin);
    cmd.args(args)
        .current_dir(cwd)
        .stdout(Stdio::piped())
        .stderr(Stdio::piped());
    if stdin.is_some() {
        cmd.stdin(Stdio::piped());
    }
    let mut child = cmd.spawn().expect("spawn");
    if let Some(text) = stdin {
        use std::io::Write;
        child
            .stdin
            .take()
            .unwrap()
            .write_all(text.as_bytes())
            .unwrap();
    }
    let out = child.wait_with_output().expect("wait");
    (
        out.status.code().unwrap_or(-1),
        String::from_utf8_lossy(&out.stdout).into_owned(),
        String::from_utf8_lossy(&out.stderr).into_owned(),
    )
}

const CLEAN_COMMONS: &str = "commons calc {\n  fn dbl(n: Int) -> Int { n + n }\n}\n";
const BAD_SOURCE: &str = "commons demo\n\nlet x: Int = \"nope\"\n";

// ---------------------------------------------------------------------------
// bynk check
// ---------------------------------------------------------------------------

#[test]
fn check_clean_project_exits_zero() {
    let proj = scratch("check-clean");
    write(
        &proj.join("bynk.toml"),
        "[project]\nname = \"calc\"\nversion = \"0.1.0\"\n",
    );
    write(&proj.join("src/calc.bynk"), CLEAN_COMMONS);
    let (code, _out, err) = run_bynk_in(&proj, &["check", "."]);
    assert_eq!(code, 0, "clean project should check clean; stderr:\n{err}");
}

#[test]
fn check_single_file_error_short_is_deterministic() {
    // A single-file error, `--format short`, rendered against a *relative* path
    // so the tooling line is stable across machines.
    let dir = scratch("check-short");
    write(&dir.join("bad.bynk"), BAD_SOURCE);
    let (code, out, err) = run_bynk_in(&dir, &["check", "bad.bynk", "--format", "short"]);
    assert_eq!(code, 1, "an error source must exit non-zero");
    assert!(out.is_empty(), "diagnostics go to stderr, not stdout");
    let first = err.lines().next().unwrap_or_default();
    assert!(
        first.starts_with("bad.bynk:") && first.contains("error["),
        "expected a `bad.bynk:line:col: error[...]` short line, got:\n{err}"
    );
}

#[test]
fn check_matches_bynkc_when_present() {
    let Some(bynkc) = bynkc_sibling() else {
        eprintln!("skipping: sibling bynkc not built (run the workspace test suite for parity)");
        return;
    };
    let dir = scratch("check-parity");
    write(&dir.join("bad.bynk"), BAD_SOURCE);
    write(&dir.join("ok.bynk"), CLEAN_COMMONS);
    for args in [
        vec!["check", "bad.bynk"],
        vec!["check", "bad.bynk", "--format", "short"],
        vec!["check", "ok.bynk"],
    ] {
        let driven = run_bynk_in(&dir, &args);
        let direct = run_in(&bynkc, &dir, &args, None);
        assert_eq!(
            driven,
            direct,
            "`bynk {0}` must match `bynkc {0}` exactly",
            args.join(" ")
        );
    }
}

// ---------------------------------------------------------------------------
// bynk fmt
// ---------------------------------------------------------------------------

/// A valid commons whose whitespace is not canonical (a doubled blank line the
/// formatter collapses), so `fmt` has something to change.
const MESSY: &str = "commons calc {\n\n\n  fn dbl(n: Int) -> Int { n + n }\n}\n";

fn canonical(source: &str) -> String {
    bynk_fmt::format_source(source, &bynk_fmt::FormatOptions::default()).expect("MESSY parses")
}

#[test]
fn fmt_stdin_writes_canonical_to_stdout() {
    let dir = scratch("fmt-stdin");
    let want = canonical(MESSY);
    assert_ne!(
        MESSY, want,
        "MESSY must be non-canonical for this test to bite"
    );
    let (code, out, err) = run_in(&bynk(), &dir, &["fmt", "-"], Some(MESSY));
    assert_eq!(code, 0, "stdin fmt should succeed; stderr:\n{err}");
    assert_eq!(out, want, "`bynk fmt -` must emit the canonical form");
}

#[test]
fn fmt_check_flags_noncanonical_without_writing() {
    let dir = scratch("fmt-check");
    let file = dir.join("calc.bynk");
    write(&file, MESSY);
    let (code, _out, err) = run_bynk_in(&dir, &["fmt", "calc.bynk", "--check"]);
    assert_eq!(
        code, 1,
        "--check must exit non-zero on a non-canonical file"
    );
    assert!(
        err.contains("not canonically formatted"),
        "expected a non-canonical notice, got:\n{err}"
    );
    assert_eq!(
        std::fs::read_to_string(&file).unwrap(),
        MESSY,
        "--check must not rewrite the file"
    );
}

#[test]
fn fmt_rewrites_in_place() {
    let dir = scratch("fmt-write");
    let file = dir.join("calc.bynk");
    write(&file, MESSY);
    let (code, _out, err) = run_bynk_in(&dir, &["fmt", "calc.bynk"]);
    assert_eq!(code, 0, "fmt should succeed; stderr:\n{err}");
    assert_eq!(
        std::fs::read_to_string(&file).unwrap(),
        canonical(MESSY),
        "fmt must rewrite the file to its canonical form"
    );
}

// ---------------------------------------------------------------------------
// bynk test (delegation)
// ---------------------------------------------------------------------------

#[test]
fn test_discovery_delegates_and_matches_bynkc() {
    let Some(bynkc) = bynkc_sibling() else {
        eprintln!("skipping: sibling bynkc not built (delegation parity needs it)");
        return;
    };
    // `--no-run --format json` is a pure compile — no `tsc`/`node` needed — so
    // this exercises delegation and the discovery document on any machine.
    let proj = scratch("test-discovery");
    write(
        &proj.join("bynk.toml"),
        "[project]\nname = \"calc\"\nversion = \"0.1.0\"\n",
    );
    write(
        &proj.join("src/calc.bynk"),
        "commons calc {\n  fn dbl(n: Int) -> Int { n + n }\n}\n\nsuite calc {\n  case \"doubles\" {\n    expect dbl(3) == 6\n  }\n}\n",
    );
    let args = ["test", ".", "--no-run", "--format", "json"];
    let driven = run_bynk_in(&proj, &args);
    let direct = run_in(&bynkc, &proj, &args, None);
    assert_eq!(driven.0, direct.0, "delegated exit code must match bynkc's");
    assert_eq!(
        driven.1, direct.1,
        "delegated discovery document must match bynkc's byte-for-byte"
    );
}