alef-e2e 0.17.13

Fixture-driven e2e test generator for alef
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
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

//! Regression tests for Zig e2e build.zig correctness on Zig 0.16+.
//!
//! Zig 0.16's `b.addTest(.{...})` defaults `use_llvm` to `null`, which lets
//! the compiler pick the self-hosted backend on aarch64-linux for Debug builds.
//! The self-hosted backend emits the test binary at a different cache path than
//! the `addRunArtifact` step computes via `getEmittedBin()`, so every run fails
//! with:
//!
//! ```text
//! error: failed to spawn and capture stdio from
//!     ./../e2e/zig/.zig-cache/o/<hash>/<test>_test: FileNotFound
//! ```
//!
//! even though the compile step reports success. The previous fix that pinned
//! a unique `.name = "<test>_test"` per test (see `zig_addtest_name.rs`) was
//! necessary to avoid cache collisions but not sufficient on aarch64-linux.
//!
//! Zig 0.16+ also stopped copying test binaries into `zig-out/bin/` even when
//! `addInstallArtifact` is invoked, so the earlier "install + run.dependOn
//! (install)" workaround that materialised an absolute spawn path is no longer
//! viable — every test now fails with `FileNotFound` against the would-be
//! `zig-out/bin/<name>` path. The current fix is to:
//!
//!   1. Pin every `addTest` to `.use_llvm = true` so the LLVM backend is used
//!      regardless of host arch (LLVM is already the default on x86_64).
//!   2. Run the binary via `addRunArtifact` (no `addInstallArtifact` — Zig
//!      0.16+ no longer copies test binaries to `zig-out/bin/`).
//!   3. Emit `setCwd(b.path("../../test_documents"))` ONLY when at least one
//!      fixture uses a `file_path` or `bytes` arg. Consumers whose fixtures are
//!      mock-server-only (e.g. kreuzcrawl) have no `test_documents/` directory;
//!      calling `setCwd` for them causes the OS `chdir(2)` to return ENOENT
//!      before the binary is even exec'd, surfacing as `FileNotFound` in the
//!      Zig build output even though the compile step succeeded.

use alef_core::config::NewAlefConfig;
use alef_e2e::codegen::E2eCodegen;
use alef_e2e::codegen::zig::ZigE2eCodegen;
use alef_e2e::fixture::{Assertion, Fixture, FixtureGroup, MockResponse};

/// Config for a mock-server-only consumer (no file_path / bytes args).
/// Represents kreuzcrawl-style: all fixtures reach a URL, no local files.
const CONFIG_TOML: &str = r#"
[workspace]
languages = ["zig"]

[[crates]]
name = "kreuzcrawl"
sources = ["src/lib.rs"]

[crates.e2e]
fixtures = "fixtures"
output = "e2e"

[crates.e2e.call]
function = "scrape"
module = "kreuzcrawl"
result_var = "result"
async = false
returns_result = true
args = [
  { name = "url", field = "url", type = "string" },
]
"#;

/// Config for a file-reading consumer (has file_path args).
/// Represents kreuzberg-style: fixtures read PDF/image files from test_documents/.
const CONFIG_TOML_FILE: &str = r#"
[workspace]
languages = ["zig"]

[[crates]]
name = "kreuzberg"
sources = ["src/lib.rs"]

[crates.e2e]
fixtures = "fixtures"
output = "e2e"

[crates.e2e.call]
function = "extract"
module = "kreuzberg"
result_var = "result"
async = false
returns_result = true
args = [
  { name = "path", field = "path", type = "file_path" },
]
"#;

fn fixture_for(category: &str, id: &str) -> Fixture {
    Fixture {
        id: id.to_string(),
        category: Some(category.to_string()),
        description: format!("{category} fixture {id}"),
        tags: Vec::new(),
        skip: None,
        env: None,
        call: None,
        input: serde_json::json!({ "url": "https://example.com" }),
        mock_response: Some(MockResponse {
            status: 200,
            body: Some(serde_json::Value::String("<html></html>".to_string())),
            stream_chunks: None,
            headers: std::collections::HashMap::new(),
        }),
        visitor: None,
        assertions: vec![Assertion {
            assertion_type: "not_error".to_string(),
            field: None,
            value: None,
            values: None,
            method: None,
            check: None,
            args: None,
            return_type: None,
        }],
        source: format!("{category}.json"),
        http: None,
    }
}

fn fixture_for_file(category: &str, id: &str) -> Fixture {
    Fixture {
        id: id.to_string(),
        category: Some(category.to_string()),
        description: format!("{category} fixture {id}"),
        tags: Vec::new(),
        skip: None,
        env: None,
        call: None,
        input: serde_json::json!({ "path": "pdf/sample.pdf" }),
        mock_response: None,
        visitor: None,
        assertions: vec![Assertion {
            assertion_type: "not_error".to_string(),
            field: None,
            value: None,
            values: None,
            method: None,
            check: None,
            args: None,
            return_type: None,
        }],
        source: format!("{category}.json"),
        http: None,
    }
}

fn render_build_zig(groups: Vec<FixtureGroup>) -> String {
    let cfg: NewAlefConfig = toml::from_str(CONFIG_TOML).expect("config parses");
    let resolved = cfg.clone().resolve().expect("resolves").remove(0);
    let e2e = cfg.crates[0].e2e.clone().expect("e2e config");
    let files = ZigE2eCodegen
        .generate(&groups, &e2e, &resolved, &[], &[])
        .expect("generation succeeds");
    files
        .iter()
        .find(|f| f.path.file_name().is_some_and(|n| n == "build.zig"))
        .expect("build.zig generated")
        .content
        .clone()
}

fn render_build_zig_file(groups: Vec<FixtureGroup>) -> String {
    let cfg: NewAlefConfig = toml::from_str(CONFIG_TOML_FILE).expect("config parses");
    let resolved = cfg.clone().resolve().expect("resolves").remove(0);
    let e2e = cfg.crates[0].e2e.clone().expect("e2e config");
    let files = ZigE2eCodegen
        .generate(&groups, &e2e, &resolved, &[], &[])
        .expect("generation succeeds");
    files
        .iter()
        .find(|f| f.path.file_name().is_some_and(|n| n == "build.zig"))
        .expect("build.zig generated")
        .content
        .clone()
}

#[test]
fn every_add_test_block_sets_use_llvm_true() {
    let groups = vec![
        FixtureGroup {
            category: "redirect".to_string(),
            fixtures: vec![fixture_for("redirect", "follows_301")],
        },
        FixtureGroup {
            category: "cookies".to_string(),
            fixtures: vec![fixture_for("cookies", "per_domain")],
        },
        FixtureGroup {
            category: "robots".to_string(),
            fixtures: vec![fixture_for("robots", "disallow_path")],
        },
    ];
    let content = render_build_zig(groups);

    let add_test_count = content.matches("b.addTest(.{").count();
    let use_llvm_count = content.matches(".use_llvm = true,").count();
    assert!(
        add_test_count >= 3,
        "expected at least three addTest blocks for three fixture groups:\n{content}"
    );
    assert_eq!(
        use_llvm_count, add_test_count,
        "every addTest block must set .use_llvm = true; \
         found {use_llvm_count} .use_llvm entries for {add_test_count} addTest blocks:\n{content}"
    );
}

#[test]
fn every_test_artifact_runs_via_addrunartifact_directly() {
    let groups = vec![
        FixtureGroup {
            category: "redirect".to_string(),
            fixtures: vec![fixture_for("redirect", "follows_301")],
        },
        FixtureGroup {
            category: "cookies".to_string(),
            fixtures: vec![fixture_for("cookies", "per_domain")],
        },
    ];
    let content = render_build_zig(groups);

    // Zig 0.16+ no longer installs test binaries to `zig-out/bin/`, so the
    // emitted build.zig must NOT use `addInstallArtifact` for test artifacts.
    assert!(
        !content.contains("addInstallArtifact"),
        "build.zig must not call addInstallArtifact for test artifacts \
         (Zig 0.16+ does not copy test binaries to zig-out/bin/):\n{content}"
    );
    assert!(
        !content.contains("getInstallStep"),
        "build.zig must not register test artifacts under getInstallStep:\n{content}"
    );

    // For mock-server-only consumers (no file_path / bytes args), setCwd must
    // NOT be emitted. The consumer has no `test_documents/` directory; zig's
    // RunStep would call chdir(2) into a non-existent path and the OS would
    // return ENOENT, surfacing as FileNotFound at spawn time even though the
    // binary compiled successfully.
    assert!(
        !content.contains("setCwd"),
        "build.zig must NOT emit setCwd for mock-server-only consumers \
         that have no test_documents/ directory:\n{content}"
    );

    // Each test must still be wired up: addTest -> addRunArtifact ->
    // test_step.dependOn(<run>.step).
    assert!(
        content.contains("const redirect_run = b.addRunArtifact(redirect_tests);"),
        "redirect run step must be created via addRunArtifact:\n{content}"
    );
    assert!(
        content.contains("test_step.dependOn(&redirect_run.step);"),
        "redirect run step must be wired into the test_step:\n{content}"
    );

    // Order: addTest -> addRunArtifact -> test_step.dependOn(run).
    let add_test_pos = content
        .find("const redirect_tests = b.addTest(")
        .expect("redirect addTest present");
    let run_pos = content
        .find("const redirect_run = b.addRunArtifact(redirect_tests);")
        .expect("redirect run present");
    let depend_pos = content
        .find("test_step.dependOn(&redirect_run.step);")
        .expect("redirect test_step dependency present");
    assert!(
        add_test_pos < run_pos && run_pos < depend_pos,
        "expected addTest -> addRunArtifact -> test_step.dependOn(run) order:\n{content}"
    );
}

#[test]
fn set_cwd_emitted_only_for_file_fixture_consumers() {
    // Consumer with file_path args (kreuzberg-style): setCwd must be present.
    let groups_file = vec![FixtureGroup {
        category: "smoke".to_string(),
        fixtures: vec![fixture_for_file("smoke", "pdf_basic")],
    }];
    let content_file = render_build_zig_file(groups_file);
    assert!(
        content_file.contains(".setCwd(b.path(\"../../test_documents\"));"),
        "build.zig for file-fixture consumer must emit setCwd pointing at \
         test_documents/:\n{content_file}"
    );

    // Consumer without file_path args (kreuzcrawl-style): setCwd must be absent.
    let groups_mock = vec![FixtureGroup {
        category: "scrape".to_string(),
        fixtures: vec![fixture_for("scrape", "basic_html")],
    }];
    let content_mock = render_build_zig(groups_mock);
    assert!(
        !content_mock.contains("setCwd"),
        "build.zig for mock-server-only consumer must NOT emit setCwd \
         (no test_documents/ directory exists):\n{content_mock}"
    );
}