Skip to main content

alef_e2e/codegen/python/
mod.rs

1//! Python e2e test code generator.
2//!
3//! Generates `e2e/python/conftest.py` and `tests/test_{category}.py` files from
4//! JSON fixtures, driven entirely by `E2eConfig` and `CallConfig`.
5
6mod assertions;
7mod config;
8mod helpers;
9mod http;
10mod json;
11mod test_file;
12mod test_function;
13mod visitors;
14
15use std::path::PathBuf;
16
17use crate::config::E2eConfig;
18use crate::escape::sanitize_filename;
19use crate::fixture::{Fixture, FixtureGroup};
20use alef_core::backend::GeneratedFile;
21use alef_core::config::ResolvedCrateConfig;
22use anyhow::Result;
23
24use self::config::{render_conftest, render_pyproject};
25use self::helpers::is_skipped;
26use self::test_file::render_test_file;
27
28/// Python e2e test code generator.
29pub struct PythonE2eCodegen;
30
31impl super::E2eCodegen for PythonE2eCodegen {
32    fn generate(
33        &self,
34        groups: &[FixtureGroup],
35        e2e_config: &E2eConfig,
36        config: &ResolvedCrateConfig,
37    ) -> Result<Vec<GeneratedFile>> {
38        let mut files = Vec::new();
39        let output_base = PathBuf::from(e2e_config.effective_output()).join("python");
40
41        files.push(GeneratedFile {
42            path: output_base.join("conftest.py"),
43            content: render_conftest(e2e_config, groups),
44            generated_header: true,
45        });
46
47        files.push(GeneratedFile {
48            path: output_base.join("__init__.py"),
49            content: "\n".to_string(),
50            generated_header: false,
51        });
52
53        files.push(GeneratedFile {
54            path: output_base.join("tests").join("__init__.py"),
55            content: "\n".to_string(),
56            generated_header: false,
57        });
58
59        let python_pkg = e2e_config.resolve_package("python");
60        let default_pkg_name = e2e_config.call.module.replace('_', "-");
61        let pkg_name = python_pkg
62            .as_ref()
63            .and_then(|p| p.name.as_deref())
64            .unwrap_or(default_pkg_name.as_str());
65        let pkg_path = python_pkg
66            .as_ref()
67            .and_then(|p| p.path.as_deref())
68            .unwrap_or("../../packages/python");
69        // Resolve registry pin: explicit per-package override → workspace
70        // version → 0.1.0 fallback. The render_pyproject template builds the
71        // dep string as `"{pkg_name}{pkg_version}"`, so the version must
72        // include a comparator (`==1.2.3`, `>=1.2.0`, etc.) — bare `1.2.3`
73        // produces an invalid PEP 508 specifier like `pkg1.2.3` that pip and
74        // uv both reject. Default to `==<resolved>` for registry mode so
75        // generated test_apps pin exactly to the just-published version.
76        let resolved = config.resolved_version();
77        let owned_version: String = python_pkg
78            .as_ref()
79            .and_then(|p| p.version.as_deref())
80            .map(str::to_owned)
81            .or_else(|| resolved.as_ref().map(|v| format!("=={v}")))
82            .unwrap_or_else(|| "==0.1.0".to_string());
83        files.push(GeneratedFile {
84            path: output_base.join("pyproject.toml"),
85            content: render_pyproject(pkg_name, pkg_path, &owned_version, e2e_config.dep_mode),
86            generated_header: true,
87        });
88
89        for group in groups {
90            let fixtures: Vec<&Fixture> = group.fixtures.iter().collect();
91            if fixtures.is_empty() {
92                continue;
93            }
94            if fixtures.iter().all(|f| is_skipped(f, "python")) {
95                continue;
96            }
97
98            let filename = format!("test_{}.py", sanitize_filename(&group.category));
99            let content = render_test_file(&group.category, &fixtures, e2e_config);
100            files.push(GeneratedFile {
101                path: output_base.join("tests").join(filename),
102                content,
103                generated_header: true,
104            });
105        }
106
107        Ok(files)
108    }
109
110    fn language_name(&self) -> &'static str {
111        "python"
112    }
113}
114
115// ---------------------------------------------------------------------------
116// Tests
117// ---------------------------------------------------------------------------
118
119#[cfg(test)]
120mod tests {
121    use super::*;
122    use crate::codegen::E2eCodegen;
123
124    #[test]
125    fn language_name_is_python() {
126        let codegen = PythonE2eCodegen;
127        assert_eq!(codegen.language_name(), "python");
128    }
129
130    #[test]
131    fn generate_empty_groups_produces_config_files_only() {
132        use alef_core::config::NewAlefConfig;
133        let cfg: NewAlefConfig = toml::from_str(
134            r#"
135[workspace]
136languages = ["python"]
137
138[[crates]]
139name = "my-lib"
140sources = ["src/lib.rs"]
141
142[crates.e2e]
143fixtures = "fixtures"
144output = "e2e"
145[crates.e2e.call]
146function = "process"
147module = "my-lib"
148result_var = "result"
149"#,
150        )
151        .unwrap();
152        let e2e = cfg.crates[0].e2e.clone().unwrap();
153        let resolved = cfg.resolve().unwrap().remove(0);
154        let codegen = PythonE2eCodegen;
155        let files = codegen.generate(&[], &e2e, &resolved).unwrap();
156        // conftest.py, __init__.py (root), tests/__init__.py, pyproject.toml
157        assert_eq!(files.len(), 4, "expected 4 config files, got: {}", files.len());
158        let paths: Vec<_> = files.iter().map(|f| f.path.to_string_lossy().to_string()).collect();
159        assert!(paths.iter().any(|p| p.ends_with("conftest.py")));
160        assert!(paths.iter().any(|p| p.ends_with("pyproject.toml")));
161    }
162}