alef 0.83.1

Opinionated polyglot binding generator for Rust libraries
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

//! Regression for the "two paths disagree" defect: `alef docs`/`alef all` used to run a
//! pre-flight, purely-static gate (the deleted `build_dependency::enforce_build_dependency`)
//! ahead of `run_validation` that bailed under `strict` whenever a language had no configured
//! `docs.snippets.sessions.<target>.before` step -- regardless of whether the language's own
//! validator needed one. `alef snippets check` never ran that gate at all, and a consumer's real
//! `compile`-level validators (which build the snippet from source themselves) reported clean
//! passes for languages the gate had already condemned as "no build guarantee" before a single
//! toolchain ran.
//!
//! `RustValidator` is exactly such a self-building validator: with no session configured
//! (`session: None`), `validate_batch_with_context` compiles the snippet in an isolated scratch
//! crate via `cargo check`, no external `before` step required (see
//! `validators::rust::RustValidator::validate_batch_with_context`). A plain Rust snippet with
//! zero `docs.snippets.sessions` configuration must therefore validate cleanly at `compile`
//! level, strict or not -- the deleted gate used to bail on it anyway, purely from the absence of
//! a `before` command in static config. ~keep

use super::*;
use std::fs;

#[test]
fn strict_compile_validation_does_not_bail_without_a_configured_before_step() {
    let tmp = tempfile::tempdir().unwrap();
    let root = tmp.path();
    fs::create_dir_all(root.join("src")).unwrap();
    fs::create_dir_all(root.join("docs/snippets/rust")).unwrap();
    fs::write(
        root.join("docs/snippets/rust/example.md"),
        "```rust\nfn add(left: i32, right: i32) -> i32 {\n    left + right\n}\n```\n",
    )
    .unwrap();

    let config = config_from_toml(
        r#"
[workspace]
languages = ["python"]

[workspace.docs.snippets]
dirs = ["docs/snippets"]
validation_level = "compile"
strict = true

[[crates]]
name = "mylib"
sources = ["src/lib.rs"]
"#,
    );
    let api = make_minimal_api("1.0.0");

    let (_files, result) = generate_docs_stage(&api, &config, &[Language::Python], None, root);

    result.expect(
        "a language with no configured `before` build step must not fail strict validation when \
         its own validator compiles the snippet standalone -- the removed pre-flight gate used to \
         bail here from static session config alone, without ever checking what the validator \
         actually does",
    );
}