refactor: move recipe generation into it's own crate (#1912)

Author: wolfv

Cargo.lock

@@ -1,5 +1,41 @@
 [workspace]
-members = ["rust-tests"]
+members = ["rust-tests", "crates/rattler_build_recipe_generator"]
+
+[workspace.package]
+authors = ["rattler-build contributors <[email protected]>"]
+edition = "2024"
+license = "BSD-3-Clause"
+readme = "README.md"
+repository = "https://github.com/prefix-dev/rattler-build"
+
+[workspace.dependencies]
+async-once-cell = "0.5.4"
+async-recursion = "1.1.1"
+clap = { version = "4.5.45", features = ["derive"] }
+flate2 = "1.1.2"
+fs-err = "3.1.1"
+indexmap = "2.11.4"
+insta = "1.41.1"
+itertools = "0.14.0"
+miette = "7.6.0"
+rattler_conda_types = { version = "0.40.0", default-features = false }
+rattler_digest = { version = "1.1.5", default-features = false, features = [
+  "serde",
+] }
+regex = "1.11.1"
+reqwest = { version = "0.12.23", default-features = false, features = ["json"] }
+serde = { version = "1.0.219", features = ["derive"] }
+serde_json = "1.0.142"
+serde_with = "3.14.0"
+serde_yaml = "0.9.34"
+sha2 = "0.10.9"
+tar = "0.4.44"
+tempfile = "3.21.0"
+tokio = { version = "1.47.1", features = ["rt", "macros"] }
+toml = "0.9.5"
+tracing = "0.1.41"
+url = "2.5.4"
+zip = { version = "5.1.1", default-features = false, features = ["deflate"] }
 
 [package]
 name = "rattler-build"
@@ -39,7 +75,7 @@ tui = [
   'throbber-widgets-tui',
   'tui-input',
 ]
-recipe-generation = []
+recipe-generation = ["rattler_build_recipe_generator"]
 # This feature needs to add a dependency on
 # clap-markdown = { git = "https://github.com/ruben-arts/clap-markdown", branch = "main" }
 # but in order to be able to publish to crates we remove this feature
@@ -193,6 +229,10 @@ http-range-client = { git = "https://github.com/pka/http-range-client.git", defa
 sevenz-rust2 = "0.18.0"
 dialoguer = "0.12.0"
 
+rattler_build_recipe_generator = { path = "crates/rattler_build_recipe_generator", optional = true, features = [
+  "cli",
+] }
+
 [target.'cfg(not(target_os = "windows"))'.dependencies]
 sha2 = { version = "0.10.9", features = ["asm"] }
 

Cargo.toml

@@ -0,0 +1,41 @@
+[package]
+name = "rattler_build_recipe_generator"
+version = "0.1.0"
+authors.workspace = true
+edition.workspace = true
+license.workspace = true
+repository.workspace = true
+description = "Recipe generation for PyPI, CRAN, CPAN, and LuaRocks packages"
+
+[features]
+default = []
+cli = ["dep:clap"]
+
+[dependencies]
+clap = { workspace = true, optional = true }
+async-once-cell = { workspace = true }
+async-recursion = { workspace = true }
+flate2 = { workspace = true }
+fs-err = { workspace = true }
+indexmap = { workspace = true }
+itertools = { workspace = true }
+miette = { workspace = true }
+rattler_conda_types = { workspace = true }
+rattler_digest = { workspace = true }
+regex = { workspace = true }
+reqwest = { workspace = true }
+serde = { workspace = true }
+serde_json = { workspace = true }
+serde_with = { workspace = true }
+serde_yaml = { workspace = true }
+sha2 = { workspace = true }
+tar = { workspace = true }
+tempfile = { workspace = true }
+toml = { workspace = true }
+tracing = { workspace = true }
+url = { workspace = true }
+zip = { workspace = true }
+
+[dev-dependencies]
+insta = { workspace = true }
+tokio = { workspace = true }

crates/rattler_build_recipe_generator/Cargo.toml

@@ -1,3 +1,4 @@
+#[cfg(feature = "cli")]
 use clap::Parser;
 use miette::{IntoDiagnostic, WrapErr};
 use serde::Deserialize;
@@ -9,24 +10,25 @@ use std::{
 };
 
 use super::write_recipe;
-use crate::recipe_generator::serialize::{self, ScriptTest, Test, UrlSourceElement};
+use crate::serialize::{self, ScriptTest, Test, UrlSourceElement};
 
 /// Options to control CPAN recipe generation.
-#[derive(Debug, Clone, Parser)]
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "cli", derive(Parser))]
 pub struct CpanOpts {
     /// Name of the package to generate
     pub package: String,
 
     /// Select a version of the package to generate (defaults to latest)
-    #[arg(long)]
+    #[cfg_attr(feature = "cli", arg(long))]
     pub version: Option<String>,
 
     /// Whether to write the recipe to a folder
-    #[arg(short, long)]
+    #[cfg_attr(feature = "cli", arg(short, long))]
     pub write: bool,
 
     /// Whether to generate recipes for all dependencies
-    #[arg(short, long)]
+    #[cfg_attr(feature = "cli", arg(short, long))]
     pub tree: bool,
 }
 

src/recipe_generator/cpan.rs renamed to crates/rattler_build_recipe_generator/src/cpan.rs

@@ -1,14 +1,15 @@
-use clap::Parser;
 use std::{collections::HashMap, collections::HashSet, path::PathBuf};
 
+#[cfg(feature = "cli")]
+use clap::Parser;
 use itertools::Itertools;
 use miette::IntoDiagnostic;
 use rattler_digest::{Sha256Hash, compute_bytes_digest};
 use serde::{Deserialize, Serialize};
 use sha2::Sha256;
 use url::Url;
 
-use crate::recipe_generator::{
+use crate::{
     serialize::{self, ScriptTest, Test, UrlSourceElement},
     write_recipe,
 };
@@ -62,21 +63,22 @@ pub struct Packaged {
 }
 
 /// Options to control CRAN/R recipe generation.
-#[derive(Debug, Clone, Parser)]
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "cli", derive(Parser))]
 pub struct CranOpts {
     /// The R Universe to fetch the package from (defaults to `cran`)
-    #[arg(short, long)]
-    universe: Option<String>,
+    #[cfg_attr(feature = "cli", arg(short, long))]
+    pub universe: Option<String>,
 
     /// Whether to create recipes for the whole dependency tree or not
-    #[arg(short, long)]
-    tree: bool,
+    #[cfg_attr(feature = "cli", arg(short, long))]
+    pub tree: bool,
 
     /// Name of the package to generate
     pub package: String,
 
     /// Whether to write the recipe to a folder
-    #[arg(short, long)]
+    #[cfg_attr(feature = "cli", arg(short, long))]
     pub write: bool,
 }
 

src/recipe_generator/cran.rs renamed to crates/rattler_build_recipe_generator/src/cran.rs

@@ -0,0 +1,55 @@
+//! Recipe generation for Python (PyPI), R (CRAN), Perl (CPAN), and Lua (LuaRocks) packages
+
+#[cfg(feature = "cli")]
+use clap::Parser;
+
+mod cpan;
+mod cran;
+mod luarocks;
+mod pypi;
+mod serialize;
+
+pub use self::cpan::{CpanOpts, generate_cpan_recipe, generate_cpan_recipe_string};
+pub use self::cran::{CranOpts, generate_r_recipe, generate_r_recipe_string};
+pub use self::luarocks::{LuarocksOpts, generate_luarocks_recipe, generate_luarocks_recipe_string};
+pub use self::pypi::{PyPIOpts, generate_pypi_recipe, generate_pypi_recipe_string};
+pub use serialize::write_recipe;
+
+/// The source of the package to generate a recipe for
+#[cfg(feature = "cli")]
+#[derive(Debug, Clone, Parser)]
+pub enum Source {
+    /// Generate a recipe for a Python package from PyPI
+    Pypi(PyPIOpts),
+
+    /// Generate a recipe for an R package from CRAN
+    Cran(CranOpts),
+
+    /// Generate a recipe for a Perl package from CPAN
+    Cpan(CpanOpts),
+
+    /// Generate a recipe for a Lua package from LuaRocks
+    Luarocks(LuarocksOpts),
+}
+
+/// Options for generating a recipe
+#[cfg(feature = "cli")]
+#[derive(Parser)]
+pub struct GenerateRecipeOpts {
+    /// Type of package to generate a recipe for
+    #[clap(subcommand)]
+    pub source: Source,
+}
+
+/// Generate a recipe for a package
+#[cfg(feature = "cli")]
+pub async fn generate_recipe(args: GenerateRecipeOpts) -> miette::Result<()> {
+    match args.source {
+        Source::Pypi(opts) => generate_pypi_recipe(&opts).await?,
+        Source::Cran(opts) => generate_r_recipe(&opts).await?,
+        Source::Cpan(opts) => generate_cpan_recipe(&opts).await?,
+        Source::Luarocks(opts) => generate_luarocks_recipe(&opts).await?,
+    }
+
+    Ok(())
+}

crates/rattler_build_recipe_generator/src/lib.rs

@@ -3,20 +3,22 @@
 
 use std::{collections::BTreeMap, io::Write, path::PathBuf};
 
+#[cfg(feature = "cli")]
 use clap::Parser;
 use indexmap::IndexMap;
 use miette::{Context, IntoDiagnostic};
 use rattler_conda_types::PackageName;
 use serde::Deserialize;
 use tempfile::NamedTempFile;
 
-use crate::recipe_generator::serialize::{
+use crate::serialize::{
     About, Build, GitSourceElement, Python, Recipe, Requirements, ScriptTest, SourceElement, Test,
     UrlSourceElement, write_recipe,
 };
 
 /// Options to control LuaRocks recipe generation.
-#[derive(Debug, Clone, Parser)]
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "cli", derive(Parser))]
 pub struct LuarocksOpts {
     /// Luarocks package to generate recipe for.
     /// Can be specified as:
@@ -27,7 +29,7 @@ pub struct LuarocksOpts {
     pub rock: String,
 
     /// Where to write the recipe to
-    #[arg(short, long, default_value = ".")]
+    #[cfg_attr(feature = "cli", arg(short, long, default_value = "."))]
     pub write_to: PathBuf,
 }
 
@@ -395,7 +397,7 @@ fn rockspec_to_recipe(rockspec: &LuarocksRockspec) -> miette::Result<Recipe> {
 
     let mut recipe = Recipe {
         context,
-        package: crate::recipe_generator::serialize::Package {
+        package: crate::serialize::Package {
             name: package_name.as_normalized().to_string(),
             version: "${{ version }}".to_string(),
         },

src/recipe_generator/luarocks/json.lua renamed to crates/rattler_build_recipe_generator/src/luarocks/json.lua

@@ -1,4 +1,5 @@
 use async_once_cell::OnceCell;
+#[cfg(feature = "cli")]
 use clap::Parser;
 use miette::{IntoDiagnostic, WrapErr};
 use serde::Deserialize;
@@ -8,9 +9,7 @@ use std::path::PathBuf;
 use zip::ZipArchive;
 
 use super::write_recipe;
-use crate::recipe_generator::serialize::{
-    self, PythonTest, PythonTestInner, Test, UrlSourceElement,
-};
+use crate::serialize::{self, PythonTest, PythonTestInner, Test, UrlSourceElement};
 
 #[derive(Deserialize)]
 struct CondaPyPiNameMapping {
@@ -19,25 +18,26 @@ struct CondaPyPiNameMapping {
 }
 
 /// Options for generating a Python (PyPI) recipe.
-#[derive(Debug, Clone, Parser)]
+#[derive(Debug, Clone)]
+#[cfg_attr(feature = "cli", derive(Parser))]
 pub struct PyPIOpts {
     /// Name of the package to generate
     pub package: String,
 
     /// Select a version of the package to generate (defaults to latest)
-    #[arg(long)]
+    #[cfg_attr(feature = "cli", arg(long))]
     pub version: Option<String>,
 
     /// Whether to write the recipe to a folder
-    #[arg(short, long)]
+    #[cfg_attr(feature = "cli", arg(short, long))]
     pub write: bool,
 
     /// Whether to use the conda-forge PyPI name mapping
-    #[arg(short, long, default_value = "true")]
+    #[cfg_attr(feature = "cli", arg(short, long, default_value = "true"))]
     pub use_mapping: bool,
 
     /// Whether to generate recipes for all dependencies
-    #[arg(short, long)]
+    #[cfg_attr(feature = "cli", arg(short, long))]
     pub tree: bool,
 }