alef 0.62.0

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
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

//! Regression coverage for the workspace-package-inheritance membership check.
//!
//! A generated crate can only emit `<field>.workspace = true` when it can actually
//! *reach* a `[workspace.package]` that defines the field: either it is a member of the
//! workspace rooted at `config.workspace_root` (i.e. not named in that root's
//! `[workspace] exclude`), or it self-hosts its own `[workspace.package]`. Blindly
//! trusting the root regardless of exclusion produces a manifest `cargo metadata` can
//! never resolve for any crate excluded from the root workspace -- exactly the shape of
//! the Elixir NIF and Ruby native-extension crates, which are excluded so their own
//! toolchain, not the root workspace's resolver, builds them.

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

fn write_root_cargo_toml(root: &std::path::Path, body: &str) {
    fs::write(root.join("Cargo.toml"), body).expect("write root Cargo.toml");
}

/// Acceptance test: a crate directory named in the root workspace's `[workspace]
/// exclude` list, whose own manifest does not exist yet (so it cannot self-host a
/// `[workspace.package]` either), must keep every `[package]` field as a literal --
/// never `<field>.workspace = true` -- since it can reach no `[workspace.package]` at
/// all.
#[test]
fn excluded_crate_with_no_reachable_workspace_package_keeps_literal_fields() {
    let dir = tempfile::tempdir().expect("tempdir");
    let root = dir.path().to_path_buf();
    write_root_cargo_toml(
        &root,
        "[workspace]\n\
         members = [\"crates/*\"]\n\
         exclude = [\"packages/elixir/native/my_lib_nif\"]\n\n\
         [workspace.package]\n\
         version = \"9.9.9\"\n\
         license = \"Apache-2.0\"\n\
         keywords = [\"ignored\"]\n",
    );

    let mut config = test_config_from_toml("");
    config.workspace_root = Some(root.clone());
    let api = test_api();

    let all_files = scaffold(&api, &config, &[Language::Elixir]).unwrap();
    let cargo_toml = language_files(&all_files)
        .into_iter()
        .find(|f| f.path.ends_with("Cargo.toml"))
        .expect("Elixir NIF Cargo.toml must be generated");

    assert_eq!(
        cargo_toml.path,
        std::path::Path::new("packages/elixir/native/my_lib_nif/Cargo.toml"),
        "sanity: must be the excluded NIF crate's own manifest"
    );

    for literal in ["version = \"0.1.0\"", "license = \"MIT\""] {
        assert!(
            cargo_toml.content.contains(literal),
            "excluded crate with no reachable [workspace.package] must emit the literal `{literal}`, got:\n{}",
            cargo_toml.content
        );
    }
    for inherited in [
        "version.workspace = true",
        "license.workspace = true",
        "keywords.workspace = true",
    ] {
        assert!(
            !cargo_toml.content.contains(inherited),
            "excluded crate must never emit `{inherited}` -- it cannot reach the root's \
             [workspace.package] and never got the chance to be checked, got:\n{}",
            cargo_toml.content
        );
    }
}

/// Negative control: without this, a fix that never inherits (always literal) would
/// pass the acceptance test above while silently breaking every legitimate excluded
/// crate that deliberately self-hosts its own `[workspace.package]`. A crate directory
/// excluded from the root workspace, but whose own pre-existing manifest declares
/// `[workspace]` with a `[workspace.package]` defining `version`, must inherit that
/// field -- while a field the self-hosted `[workspace.package]` does NOT define
/// (`license`) still falls back to a literal, proving the check is per-field, not
/// per-crate.
#[test]
fn self_hosting_excluded_crate_inherits_only_the_fields_its_own_workspace_package_defines() {
    let dir = tempfile::tempdir().expect("tempdir");
    let root = dir.path().to_path_buf();
    write_root_cargo_toml(
        &root,
        "[workspace]\nmembers = [\"crates/*\"]\nexclude = [\"packages/elixir/native/my_lib_nif\"]\n",
    );

    let native_dir = root.join("packages/elixir/native/my_lib_nif");
    fs::create_dir_all(&native_dir).expect("create native crate dir");
    fs::write(
        native_dir.join("Cargo.toml"),
        "[package]\nname = \"my_lib_nif\"\nversion.workspace = true\n\n\
         [workspace]\n\n[workspace.package]\nversion = \"0.1.0\"\n",
    )
    .expect("write self-hosting native Cargo.toml");

    let mut config = test_config_from_toml("");
    config.workspace_root = Some(root.clone());
    let api = test_api();

    let all_files = scaffold(&api, &config, &[Language::Elixir]).unwrap();
    let cargo_toml = language_files(&all_files)
        .into_iter()
        .find(|f| f.path.ends_with("Cargo.toml"))
        .expect("Elixir NIF Cargo.toml must be generated");

    assert!(
        cargo_toml.content.contains("version.workspace = true"),
        "a crate excluded from the root workspace but self-hosting its own \
         [workspace.package].version must still inherit it, got:\n{}",
        cargo_toml.content
    );
    assert!(
        cargo_toml.content.contains("license = \"MIT\""),
        "the self-hosted [workspace.package] defines no `license`, so this field must still \
         fall back to a literal, got:\n{}",
        cargo_toml.content
    );
    assert!(
        !cargo_toml.content.contains("license.workspace = true"),
        "must not emit license.workspace = true when neither the root nor the self-hosted \
         workspace defines it, got:\n{}",
        cargo_toml.content
    );
}

/// A real workspace member (not named in the root's `[workspace] exclude`) must
/// continue to inherit from the root's `[workspace.package]` exactly as before this
/// membership check existed.
#[test]
fn real_workspace_member_still_inherits_from_the_root_workspace_package() {
    let dir = tempfile::tempdir().expect("tempdir");
    let root = dir.path().to_path_buf();
    write_root_cargo_toml(
        &root,
        "[workspace]\nmembers = [\"crates/*\"]\n\n[workspace.package]\nversion = \"4.2.0\"\nlicense = \"MIT\"\n",
    );

    let mut config = test_config_from_toml("");
    config.workspace_root = Some(root.clone());
    config.name = "my-lib".to_string();
    let api = test_api();

    let all_files = scaffold(&api, &config, &[Language::Ffi]).unwrap();
    let cargo_toml = language_files(&all_files)
        .into_iter()
        .find(|f| f.path.ends_with("Cargo.toml"))
        .expect("FFI Cargo.toml must be generated");

    assert_eq!(
        cargo_toml.path,
        std::path::Path::new("crates/my-lib-ffi/Cargo.toml"),
        "sanity: must be the member FFI crate's own manifest"
    );
    for inherited in ["version.workspace = true", "license.workspace = true"] {
        assert!(
            cargo_toml.content.contains(inherited),
            "a real workspace member must inherit `{inherited}` from the root's \
             [workspace.package], got:\n{}",
            cargo_toml.content
        );
    }
}