knok-build 0.3.3

Build-script graph tracing and code generation for knok
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

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

use tempfile::TempDir;

struct Fixture {
    name: &'static str,
    build_rs: &'static str,
    expected: &'static [&'static str],
}

#[test]
fn build_script_tracing_failures_are_reported() {
    let fixtures = [
        Fixture {
            name: "shape_mismatch",
            build_rs: r#"
use knok_build::prelude::*;

#[knok_build::graph(backend = Backend::LlvmCpu)]
fn forward(x: Tensor2<f32, 2, 3>, y: Tensor2<f32, 4, 3>) -> Tensor2<f32, 2, 3> {
    x + y
}

fn main() {
    knok_build::compile_graphs_with_options!(
        BuildOptions::stub_artifacts_for_check();
        forward
    );
}
"#,
            expected: &[
                "knok build failed",
                "elementwise operands are not broadcast-compatible",
            ],
        },
        Fixture {
            name: "return_type_mismatch",
            build_rs: r#"
use knok_build::prelude::*;

#[knok_build::graph(backend = Backend::LlvmCpu)]
fn forward(x: Tensor2<f32, 2, 3>) -> Tensor1<f32, 3> {
    sum_axis(x, 1)
}

fn main() {
    knok_build::compile_graphs_with_options!(
        BuildOptions::stub_artifacts_for_check();
        forward
    );
}
"#,
            expected: &["knok build failed", "return type mismatch"],
        },
        Fixture {
            name: "invalid_axis",
            build_rs: r#"
use knok_build::prelude::*;

#[knok_build::graph(backend = Backend::LlvmCpu)]
fn forward(x: Tensor2<f32, 2, 3>) -> Tensor1<f32, 2> {
    sum_axis(x, 3)
}

fn main() {
    knok_build::compile_graphs_with_options!(
        BuildOptions::stub_artifacts_for_check();
        forward
    );
}
"#,
            expected: &["knok build failed", "axis 3 is out of bounds"],
        },
    ];

    let temp = TempDir::new().expect("create temp fixture root");
    let target_dir = temp.path().join("target");
    let knok_root = workspace_root();
    for fixture in fixtures {
        let project = temp.path().join(fixture.name);
        write_fixture(&project, fixture.name, &knok_root, fixture.build_rs);

        let output = Command::new(env::var_os("CARGO").unwrap_or_else(|| "cargo".into()))
            .arg("check")
            .arg("--offline")
            .arg("--manifest-path")
            .arg(project.join("Cargo.toml"))
            .env("CARGO_TARGET_DIR", &target_dir)
            .output()
            .expect("run cargo check fixture");
        let stderr = String::from_utf8_lossy(&output.stderr);
        let stdout = String::from_utf8_lossy(&output.stdout);
        let combined = format!("{stdout}\n{stderr}");

        assert!(
            !output.status.success(),
            "fixture `{}` unexpectedly passed\n{}",
            fixture.name,
            combined
        );
        for expected in fixture.expected {
            assert!(
                combined.contains(expected),
                "fixture `{}` output did not contain `{}`\n{}",
                fixture.name,
                expected,
                combined
            );
        }
    }
}

fn write_fixture(project: &Path, name: &str, knok_root: &Path, build_rs: &str) {
    fs::create_dir_all(project.join("src")).expect("create fixture src");
    fs::write(
        project.join("Cargo.toml"),
        format!(
            r#"[package]
name = "knok-build-negative-{name}"
version = "0.0.0"
edition = "2021"
publish = false

[build-dependencies]
knok-build = {{ path = "{}" }}
"#,
            toml_path(&knok_root.join("crates/knok-build"))
        ),
    )
    .expect("write fixture manifest");
    fs::write(project.join("build.rs"), build_rs).expect("write fixture build script");
    fs::write(project.join("src/lib.rs"), "").expect("write fixture lib");
}

fn workspace_root() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .parent()
        .and_then(Path::parent)
        .expect("knok-build crate lives two levels below the workspace root")
        .to_path_buf()
}

fn toml_path(path: &Path) -> String {
    path.display().to_string().replace('\\', "\\\\")
}