alef 0.83.3

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
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
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
use std::path::PathBuf;

use super::extras::Language;
use super::output::{SetupConfig, StringOrVec};
use super::tools::{LangContext, require_ruby_bundler, require_tool, ruby_bundle};

/// Return the default working directory (relative to repo root) for a language's
/// setup commands. Languages whose manifest file lives outside the repo root
/// (Swift's `Package.swift`, Kotlin-Android's `gradlew`, Dart's `pubspec.yaml`,
/// Zig's `build.zig`) need install commands run from their package directory or
/// the underlying tool will not find the manifest.
pub fn default_setup_workdir(lang: Language) -> Option<PathBuf> {
    match lang {
        Language::Swift => Some(PathBuf::from("packages/swift")),
        Language::KotlinAndroid => Some(PathBuf::from("packages/kotlin-android")),
        Language::Dart => Some(PathBuf::from("packages/dart")),
        Language::Zig => Some(PathBuf::from("packages/zig")),
        _ => None,
    }
}

/// Stand-alone factory matching the spec's `setup_config_for_language(lang)`
/// signature: returns a setup config with only the `workdir` field populated
/// (per-language default). Used by tests and callers that only need the workdir
/// default without resolving the full command pipeline (which requires
/// `output_dir` and `LangContext`).
pub fn setup_config_for_language(lang: Language) -> SetupConfig {
    SetupConfig {
        precondition: None,
        before: None,
        install: None,
        timeout_seconds: 1800,
        workdir: default_setup_workdir(lang),
    }
}

/// Return the default setup configuration for a language.
///
/// The `output_dir` is the package directory where scaffolded files live
/// (e.g. `packages/python`). It is substituted into command templates.
/// `ctx` provides the package manager selection.
pub(crate) fn default_setup_config(lang: Language, output_dir: &str, ctx: &LangContext) -> SetupConfig {
    let output_dir = super::shell::quote_word(output_dir);
    match lang {
        Language::Rust => {
            let mut commands: Vec<String> = vec!["rustup update stable".to_string()];
            commands.extend(
                ctx.tools
                    .rust_tools()
                    .iter()
                    .map(|t| format!("cargo install {t} --locked")),
            );
            commands.push("rustup component add rustfmt clippy".to_string());
            SetupConfig {
                precondition: Some(require_tool("cargo")),
                before: None,
                install: Some(StringOrVec::Multiple(commands)),
                timeout_seconds: 1800,
                workdir: default_setup_workdir(lang),
            }
        }
        Language::Python => {
            let pm = ctx.tools.python_pm();
            let install_cmd = match pm {
                "pip" => format!("cd {output_dir} && pip install -e ."),
                "poetry" => format!("cd {output_dir} && poetry install"),
                _ => format!("cd {output_dir} && uv sync --no-install-project --no-install-workspace"),
            };
            SetupConfig {
                precondition: Some(require_tool(pm)),
                before: None,
                install: Some(StringOrVec::Single(install_cmd)),
                timeout_seconds: 1800,
                workdir: default_setup_workdir(lang),
            }
        }
        Language::Node | Language::Wasm => {
            let pm = ctx.tools.node_pm();
            let install_cmd = match pm {
                "npm" => format!("cd {output_dir} && npm install"),
                "yarn" => format!("cd {output_dir} && yarn install"),
                _ => format!("cd {output_dir} && pnpm install --config.minimumReleaseAge=0"),
            };
            SetupConfig {
                precondition: Some(require_tool(pm)),
                before: None,
                install: Some(StringOrVec::Single(install_cmd)),
                timeout_seconds: 1800,
                workdir: default_setup_workdir(lang),
            }
        }
        Language::Go => SetupConfig {
            precondition: Some(require_tool("go")),
            before: None,
            install: Some(StringOrVec::Single(format!(
                "cd {output_dir} && GOWORK=off go mod download"
            ))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Ruby => SetupConfig {
            precondition: Some(require_ruby_bundler()),
            before: None,
            install: Some(StringOrVec::Multiple(vec![
                format!("cd {output_dir} && {}", ruby_bundle("install")),
                format!(
                    "cd {output_dir} && {} 2>/dev/null || true",
                    ruby_bundle("lock --add-checksums")
                ),
            ])),
            // 1800s is the ceiling for every other language's setup step, but `bundle install`
            // has to compile native extensions for any gem that ships one (nokogiri, grpc, ffi-
            // backed gems, ...), and 0.82.0 removed `[setup.ruby].timeout_seconds` as an escape
            // hatch a consumer could raise for a slow CI runner or a cold gem cache -- a real
            // consumer repo's Ruby setup genuinely needed 3000s once that escape hatch was the
            // only thing keeping it from timing out at 1800s. This is a fact about `bundle
            // install` under those conditions, not a per-repo preference, so it belongs in the
            // default rather than requiring every Ruby-targeting repo to still know to raise it.
            // ~keep
            timeout_seconds: 3000,
            workdir: default_setup_workdir(lang),
        },
        Language::Php => SetupConfig {
            precondition: Some(require_tool("composer")),
            before: None,
            install: Some(StringOrVec::Single(format!("cd {output_dir} && composer install"))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Java => SetupConfig {
            precondition: Some(require_tool("mvn")),
            before: None,
            install: Some(StringOrVec::Single(format!(
                "mvn -f {output_dir}/pom.xml dependency:resolve --batch-mode --no-transfer-progress"
            ))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Csharp => SetupConfig {
            precondition: Some(format!(
                "command -v dotnet >/dev/null 2>&1 && [ -n \"$(find {output_dir} -maxdepth 3 \\( -name '*.sln' -o -name '*.csproj' \\) 2>/dev/null | head -1)\" ]"
            )),
            before: None,
            install: Some(StringOrVec::Single(format!(
                "dotnet restore $(find {output_dir} -maxdepth 3 \\( -name '*.sln' -o -name '*.csproj' \\) 2>/dev/null | head -1)"
            ))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Elixir => SetupConfig {
            precondition: Some(require_tool("mix")),
            before: None,
            install: Some(StringOrVec::Single(format!("cd {output_dir} && mix deps.get"))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::R => SetupConfig {
            precondition: Some(require_tool("Rscript")),
            before: None,
            install: Some(StringOrVec::Single(format!(
                "cd {output_dir} && Rscript -e \"remotes::install_deps()\""
            ))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Ffi => SetupConfig {
            precondition: None,
            before: None,
            install: None,
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::C => SetupConfig {
            precondition: None,
            before: None,
            install: None,
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Kotlin | Language::KotlinAndroid => SetupConfig {
            precondition: Some(require_tool("gradle")),
            before: None,
            install: Some(StringOrVec::Single("gradle --no-daemon tasks --all".to_string())),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Swift => SetupConfig {
            precondition: Some(require_tool("swift")),
            before: None,
            install: Some(StringOrVec::Single("swift package resolve".to_string())),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Dart => SetupConfig {
            precondition: Some(require_tool("dart")),
            before: None,
            install: Some(StringOrVec::Single("dart pub get".to_string())),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Zig => SetupConfig {
            precondition: Some(require_tool("zig")),
            before: None,
            install: Some(StringOrVec::Single("zig build --fetch".to_string())),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Gleam => SetupConfig {
            precondition: Some(require_tool("gleam")),
            before: None,
            install: Some(StringOrVec::Single(format!("cd {output_dir} && gleam deps download"))),
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
        Language::Jni => SetupConfig {
            precondition: None,
            before: None,
            install: None,
            timeout_seconds: 1800,
            workdir: default_setup_workdir(lang),
        },
    }
}

#[cfg(test)]
mod tests {
    use super::super::tools::ToolsConfig;
    use super::*;

    fn all_languages() -> Vec<Language> {
        vec![
            Language::Python,
            Language::Node,
            Language::Wasm,
            Language::Ruby,
            Language::Php,
            Language::Go,
            Language::Java,
            Language::Csharp,
            Language::Elixir,
            Language::R,
            Language::Ffi,
            Language::Rust,
            Language::Kotlin,
            Language::Swift,
            Language::Dart,
            Language::Gleam,
            Language::Zig,
        ]
    }

    fn cfg(lang: Language, dir: &str) -> SetupConfig {
        let tools = ToolsConfig::default();
        let ctx = LangContext::default(&tools);
        default_setup_config(lang, dir, &ctx)
    }

    #[test]
    fn generated_setup_quotes_configured_output_directory() {
        let malicious = "packages/python; touch /tmp/alef-setup; #";
        let commands = cfg(Language::Python, malicious)
            .install
            .expect("python setup command")
            .commands()
            .join(" ");
        assert!(commands.contains(&format!("cd {}", super::super::shell::quote_word(malicious))));
    }

    #[test]
    fn ffi_has_no_install_command() {
        let c = cfg(Language::Ffi, "packages/ffi");
        assert!(c.install.is_none());
    }

    #[test]
    fn non_ffi_languages_have_install_command() {
        for lang in all_languages() {
            if matches!(lang, Language::Ffi) {
                continue;
            }
            let c = cfg(lang, "packages/test");
            assert!(c.install.is_some(), "{lang} should have a default install command");
        }
    }

    #[test]
    fn non_ffi_languages_have_default_precondition() {
        for lang in all_languages() {
            if matches!(lang, Language::Ffi) {
                continue;
            }
            let c = cfg(lang, "packages/test");
            let pre = c
                .precondition
                .unwrap_or_else(|| panic!("{lang} should have a precondition"));
            assert!(pre.starts_with("command -v "));
        }
    }

    #[test]
    fn rust_install_lists_full_tool_set() {
        let c = cfg(Language::Rust, "packages/rust");
        let install = c.install.unwrap();
        let cmds = install.commands();
        let joined = cmds.join(" || ");
        assert!(joined.contains("rustup update stable"));
        for tool in super::super::tools::DEFAULT_RUST_DEV_TOOLS {
            assert!(
                joined.contains(&format!("cargo install {tool} --locked")),
                "Rust setup should install {tool}, got: {joined}"
            );
        }
        assert!(joined.contains("rustup component add rustfmt clippy"));
    }

    #[test]
    fn rust_install_respects_user_tool_list() {
        let tools = ToolsConfig {
            rust_dev_tools: Some(vec!["cargo-edit".to_string(), "cargo-foo".to_string()]),
            ..Default::default()
        };
        let ctx = LangContext::default(&tools);
        let c = default_setup_config(Language::Rust, "packages/rust", &ctx);
        let cmds = c.install.unwrap().commands().join(" || ");
        assert!(cmds.contains("cargo install cargo-edit --locked"));
        assert!(cmds.contains("cargo install cargo-foo --locked"));
        assert!(!cmds.contains("cargo install cargo-deny"));
    }

    fn python_tools(pm: &str) -> ToolsConfig {
        ToolsConfig {
            python_package_manager: Some(pm.to_string()),
            ..Default::default()
        }
    }

    fn node_tools(pm: &str) -> ToolsConfig {
        ToolsConfig {
            node_package_manager: Some(pm.to_string()),
            ..Default::default()
        }
    }

    #[test]
    fn python_setup_dispatches_on_package_manager() {
        for (pm, expected_install, expected_pre) in [
            (
                "uv",
                "uv sync --no-install-project --no-install-workspace",
                "command -v uv >/dev/null 2>&1",
            ),
            ("pip", "pip install -e", "command -v pip >/dev/null 2>&1"),
            ("poetry", "poetry install", "command -v poetry >/dev/null 2>&1"),
        ] {
            let tools = python_tools(pm);
            let ctx = LangContext::default(&tools);
            let c = default_setup_config(Language::Python, "packages/python", &ctx);
            assert!(c.install.unwrap().commands().join(" ").contains(expected_install));
            assert_eq!(c.precondition.as_deref(), Some(expected_pre));
        }
    }

    #[test]
    fn node_setup_dispatches_on_package_manager() {
        for (pm, expected_install) in [
            ("pnpm", "pnpm install"),
            ("npm", "npm install"),
            ("yarn", "yarn install"),
        ] {
            let tools = node_tools(pm);
            let ctx = LangContext::default(&tools);
            let c = default_setup_config(Language::Node, "packages/node", &ctx);
            assert!(c.install.unwrap().commands().join(" ").contains(expected_install));
        }
    }

    #[test]
    fn python_uses_uv_sync_by_default() {
        let c = cfg(Language::Python, "packages/python");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("uv sync"));
        assert!(install.contains("packages/python"));
    }

    #[test]
    fn node_uses_pnpm_install_by_default() {
        let c = cfg(Language::Node, "packages/node");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("pnpm install"));
    }

    #[test]
    fn wasm_matches_node() {
        let node = cfg(Language::Node, "packages/foo");
        let wasm = cfg(Language::Wasm, "packages/foo");
        assert_eq!(
            node.install.unwrap().commands().join(" "),
            wasm.install.unwrap().commands().join(" "),
            "WASM and Node should share install command"
        );
    }

    #[test]
    fn go_uses_go_mod_download() {
        let c = cfg(Language::Go, "packages/go");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("go mod download"));
    }

    #[test]
    fn ruby_uses_bundle_install() {
        let c = cfg(Language::Ruby, "packages/ruby");
        assert_eq!(
            c.precondition.as_deref(),
            Some(
                "command -v ruby >/dev/null 2>&1 && BUNDLE_PATH=vendor/bundle ruby -S bundle --version >/dev/null 2>&1"
            )
        );
        let install = c.install.unwrap().commands().join(" ");
        assert!(
            install.contains("BUNDLE_PATH=vendor/bundle ruby -S bundle install"),
            "got: {install}"
        );
        assert!(
            install.contains("BUNDLE_PATH=vendor/bundle ruby -S bundle lock --add-checksums"),
            "got: {install}"
        );
    }

    #[test]
    fn java_uses_maven_dependency_resolve() {
        let c = cfg(Language::Java, "packages/java");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("mvn"));
        assert!(install.contains("dependency:resolve"));
    }

    #[test]
    fn csharp_uses_dotnet_restore() {
        let c = cfg(Language::Csharp, "packages/csharp");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("dotnet restore"));
    }

    #[test]
    fn elixir_uses_mix_deps_get() {
        let c = cfg(Language::Elixir, "packages/elixir");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("mix deps.get"));
    }

    #[test]
    fn r_uses_remotes_install_deps() {
        let c = cfg(Language::R, "packages/r");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("remotes::install_deps()"));
    }

    #[test]
    fn gleam_uses_gleam_deps_download() {
        let c = cfg(Language::Gleam, "packages/gleam");
        let install = c.install.unwrap().commands().join(" ");
        assert!(
            install.contains("gleam deps download"),
            "Gleam setup should use gleam deps download, got: {install}"
        );
        assert_eq!(c.precondition.as_deref(), Some("command -v gleam >/dev/null 2>&1"));
    }

    #[test]
    fn output_dir_substituted_in_commands() {
        let c = cfg(Language::Go, "my/custom/path");
        let install = c.install.unwrap().commands().join(" ");
        assert!(install.contains("my/custom/path"));
    }

    /// 0.82.0 removed `[setup.<lang>].timeout_seconds` as an `alef.toml` escape hatch, so a
    /// language whose `bundle install`/equivalent genuinely needs longer than the 1800s every
    /// other language gets must have that need encoded in the built-in default itself -- a real
    /// consumer repo's Ruby setup timed out at 1800s once the override was the only way to raise
    /// it. Only Ruby gets a raised ceiling: every other language's install step has no comparable
    /// native-extension-compilation cost, so 1800s stays the default for all of them. ~keep
    #[test]
    fn ruby_gets_a_longer_timeout_than_every_other_language_for_native_extension_builds() {
        let ruby = cfg(Language::Ruby, "packages/ruby");
        assert_eq!(
            ruby.timeout_seconds, 3000,
            "ruby's bundle install must get the raised ceiling"
        );
        for lang in all_languages() {
            if lang == Language::Ruby {
                continue;
            }
            let c = cfg(lang, "packages/test");
            assert_eq!(
                c.timeout_seconds, 1800,
                "{lang} has no known reason to need more than the default 1800s ceiling"
            );
        }
    }
}