mecha10_templates/services/

project_template_service.rs

//! Project template service for generating project files
//!
//! This service coordinates template generation across specialized modules:
//! - Rust templates (Cargo.toml, main.rs, build.rs)
//! - Infrastructure templates (docker-compose.yml, .env)
//! - Meta templates (README.md, .gitignore, package.json)
//!
//! # Architecture
//!
//! Templates are organized into focused modules under `crate::templates`:
//! - **RustTemplates**: Rust-specific files
//! - **InfraTemplates**: Infrastructure files
//! - **MetaTemplates**: Project metadata files
//!
//! Template content is stored in external files at `packages/mecha10-templates/templates/`
//! and embedded at compile time using `include_str!()`.

use crate::paths;
use crate::templates::{InfraTemplates, MetaTemplates, RlBundleTemplates, RustTemplates};
use anyhow::{Context, Result};
use std::path::Path;

const MODEL_JSON_TEMPLATE: &str = include_str!("../../templates/config/model.json.template");
const ENVIRONMENT_JSON_TEMPLATE: &str = include_str!("../../templates/config/environment.json.template");
const CAT_ENVIRONMENT_JSON_TEMPLATE: &str = include_str!("../../templates/config/cat_environment.json.template");

/// Generates a `pub async fn $name(&self, path: &Path[, project_name: &str]) -> Result<()>`
/// wrapper that forwards straight to `self.$field.$name(..)`.
///
/// `ProjectTemplateService` is a thin facade over the `rust`/`infra`/`meta` template modules -
/// every one of these wrappers has an identical `self.<field>.<method>(<args>).await` body, which
/// `cargo-dupes` (correctly) flagged as an exact-duplicate cluster (LAB-2467): the bodies really
/// are byte-for-byte the same shape, differing only in which field/method they name. A macro
/// collapses that to a single written definition instead of one copy per forwarded method.
macro_rules! delegate_create {
    ($(#[$meta:meta])* $name:ident($field:ident)) => {
        $(#[$meta])*
        pub async fn $name(&self, path: &Path) -> Result<()> {
            self.$field.$name(path).await
        }
    };
    ($(#[$meta:meta])* $name:ident($field:ident, project_name)) => {
        $(#[$meta])*
        pub async fn $name(&self, path: &Path, project_name: &str) -> Result<()> {
            self.$field.$name(path, project_name).await
        }
    };
}

/// Generates a `pub async fn $name(&self, path: &Path) -> Result<()>` that joins `path` with
/// `$rel_path`, then writes `$template` there via [`ProjectTemplateService::write_embedded_config`]
/// (LAB-2467: `create_simulation_model_json`/`create_simulation_environment_json` were previously
/// two hand-written copies of this join-then-write shape).
macro_rules! create_config_file {
    ($(#[$meta:meta])* $name:ident($rel_path:expr, $template:expr, $err_context:literal)) => {
        $(#[$meta])*
        pub async fn $name(&self, path: &Path) -> Result<()> {
            let dest = path.join($rel_path);
            Self::write_embedded_config(&dest, $template, $err_context).await
        }
    };
}

/// Service for generating project template files
///
/// # Examples
///
/// ```rust,ignore
/// use mecha10_cli::services::ProjectTemplateService;
///
/// let service = ProjectTemplateService::new();
///
/// // Generate all project files
/// service.create_readme(&project_path, "my-robot").await?;
/// service.create_cargo_toml(&project_path, "my-robot").await?;
/// ```
pub struct ProjectTemplateService {
    rust: RustTemplates,
    infra: InfraTemplates,
    meta: MetaTemplates,
    rl_bundle: RlBundleTemplates,
}

impl ProjectTemplateService {
    /// Create a new ProjectTemplateService
    pub fn new() -> Self {
        Self {
            rust: RustTemplates::new(),
            infra: InfraTemplates::new(),
            meta: MetaTemplates::new(),
            rl_bundle: RlBundleTemplates::new(),
        }
    }

    delegate_create!(
        /// Create README.md for the project
        create_readme(meta, project_name)
    );

    delegate_create!(
        /// Create .gitignore for the project
        create_gitignore(meta)
    );

    delegate_create!(
        /// Create Cargo.toml for the project
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        /// * `project_name` - Name of the project
        create_cargo_toml(rust, project_name)
    );

    delegate_create!(
        /// Create src/main.rs for the project
        create_main_rs(rust, project_name)
    );

    delegate_create!(
        /// Create build.rs for the project
        ///
        /// This build script generates:
        /// 1. node_registry.rs - Node dispatcher based on mecha10.json
        create_build_rs(rust)
    );

    delegate_create!(
        /// Create .env.example for the project
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        /// * `project_name` - Name of the project
        create_env_example(infra, project_name)
    );

    delegate_create!(
        /// Create rustfmt.toml for the project
        create_rustfmt_toml(rust)
    );

    delegate_create!(
        /// Create docker-compose.yml for the project
        ///
        /// Generates a Docker Compose file with Redis and optional PostgreSQL services
        /// for local development and deployment.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        /// * `project_name` - Name of the project (used for container naming)
        create_docker_compose(infra, project_name)
    );

    delegate_create!(
        /// Create remote node Docker files
        ///
        /// Creates docker-compose.remote.yml and Dockerfile.remote for running
        /// AI/ML nodes in containers. These are used when nodes are configured
        /// in targets.remote in mecha10.json.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        create_remote_docker_files(infra)
    );

    delegate_create!(
        /// Create rl target Docker files
        ///
        /// Creates docker-compose.rl.yml, Dockerfile.rl, and entrypoint-rl.sh for running a
        /// trained RL policy in production. Modeled on `create_remote_docker_files`, but
        /// deliberately excludes the simulator - see that method's doc comment.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        create_rl_docker_files(infra)
    );

    delegate_create!(
        /// Create package.json for npm dependencies
        ///
        /// Includes @mecha10/simulation-models and @mecha10/simulation-environments dependencies,
        /// resolved via node_modules/@mecha10/* (requires npm install).
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        /// * `project_name` - Name of the project
        create_package_json(meta, project_name)
    );

    delegate_create!(
        /// Create requirements.txt for Python dependencies
        ///
        /// Includes Python packages needed for AI nodes (onnx, onnxruntime).
        /// Install with: `mecha10 setup` or `pip install -r requirements.txt`
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        create_requirements_txt(meta)
    );

    delegate_create!(
        /// Create `.python-version`, pinning the exact Python version `mecha10 setup`
        /// should target for the RL/simulation venv.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root path
        create_python_version(meta)
    );

    /// Create the standard RL training bundle (LAB-1743) for a `rover` template project
    ///
    /// Bundles the Phase 2 `rover` env / `ppo` algorithm (`packages/rl-trainer`,
    /// `packages/rl-task-runner`, registered via the `mecha10_rl.envs`/`mecha10_rl.algorithms`
    /// entry-points registry, LAB-1732/1733) into two pieces:
    ///
    /// - `configs/rl/jobs/` - the standard job catalog; each job file is a complete training
    ///   config (job identity plus every `PPOConfig` hyperparameter, LAB-2970) - there's no more
    ///   separate `configs/rl/local.yml` sentinel-override config to layer onto.
    /// - `requirements.txt` - appended with the two packages' dependencies, since both already
    ///   register their entry points in their own `pyproject.toml` (nothing else to declare).
    ///
    /// A project no longer gets its own `kestra/` directory (LAB-2428) - a robot developer
    /// shouldn't need to know Kestra is involved; the canonical `train`/`tune`/`tune-then-train`/
    /// `train-from-tune`/`resume-run` flows live solely in `mecha10-rl`, deployed via its own CI.
    ///
    /// Callers should invoke `create_requirements_txt` first — this appends to that file rather
    /// than creating it.
    ///
    /// # Arguments
    ///
    /// * `path` - Project root path
    pub async fn create_rl_training_bundle(&self, path: &Path) -> Result<()> {
        self.rl_bundle.append_rl_requirements(path).await?;
        self.rl_bundle.create_rl_jobs(path).await?;
        Ok(())
    }

    create_config_file!(
        /// Create configs/simulation/models/model.json
        ///
        /// Generates the rover robot physical model configuration
        /// from embedded template.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root directory
        create_simulation_model_json(
            paths::project::model_config("rover"),
            MODEL_JSON_TEMPLATE,
            "Failed to write model.json"
        )
    );

    create_config_file!(
        /// Create configs/simulation/environments/basic_arena/environment.json
        ///
        /// Generates the basic arena environment configuration
        /// from embedded template.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root directory
        create_simulation_environment_json(
            paths::project::environment_config("basic_arena"),
            ENVIRONMENT_JSON_TEMPLATE,
            "Failed to write environment.json"
        )
    );

    create_config_file!(
        /// Create configs/simulation/environments/cat_environment/environment.json
        ///
        /// `mecha10.json`'s default `simulation.environment` (see `mecha10.json.template`) - a
        /// generic `basic_arena` plus two cat images, so `mecha10 dev`'s simulator preview has
        /// something to detect out of the box. RL training (`configs/rl/jobs/train.yml`) still
        /// targets plain `basic_arena` - the two environments are scaffolded independently.
        ///
        /// # Arguments
        ///
        /// * `path` - Project root directory
        create_simulation_cat_environment_json(
            paths::project::environment_config("cat_environment"),
            CAT_ENVIRONMENT_JSON_TEMPLATE,
            "Failed to write cat_environment environment.json"
        )
    );

    /// Write an embedded config template to `dest`, creating any missing parent
    /// directories first.
    ///
    /// Shared by `create_simulation_model_json`/`create_simulation_environment_json`,
    /// which were previously two copies of this exact create-parent-dir-then-write
    /// sequence (LAB-2467).
    ///
    /// # Arguments
    ///
    /// * `dest` - Full destination file path
    /// * `template` - Embedded template content to write verbatim
    /// * `error_context` - Static message attached if the write fails
    async fn write_embedded_config(dest: &Path, template: &str, error_context: &'static str) -> Result<()> {
        if let Some(parent) = dest.parent() {
            tokio::fs::create_dir_all(parent).await?;
        }

        tokio::fs::write(dest, template).await.context(error_context)?;

        Ok(())
    }
}

impl Default for ProjectTemplateService {
    fn default() -> Self {
        Self::new()
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use tempfile::TempDir;

    #[tokio::test]
    async fn create_readme_replaces_project_name_placeholder() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_readme(temp.path(), "my-robot").await.unwrap();

        let content = tokio::fs::read_to_string(temp.path().join("README.md")).await.unwrap();
        assert!(content.contains("my-robot"));
        assert!(!content.contains("{{project_name}}"));
    }

    #[tokio::test]
    async fn create_gitignore_writes_file() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_gitignore(temp.path()).await.unwrap();

        assert!(temp.path().join(".gitignore").exists());
    }

    #[tokio::test]
    async fn create_python_version_writes_a_pin_mecha10_setup_can_read() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_python_version(temp.path()).await.unwrap();

        let content = tokio::fs::read_to_string(temp.path().join(".python-version"))
            .await
            .unwrap();
        let mut parts = content.trim().split('.');
        assert!(parts.next().unwrap().parse::<u32>().is_ok());
        assert!(parts.next().unwrap().parse::<u32>().is_ok());
        assert!(parts.next().is_none());
    }

    #[tokio::test]
    async fn create_cargo_toml_includes_project_name() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_cargo_toml(temp.path(), "my-robot").await.unwrap();

        let content = tokio::fs::read_to_string(temp.path().join("Cargo.toml")).await.unwrap();
        assert!(content.contains("my-robot"));
    }

    #[tokio::test]
    async fn create_main_rs_writes_file() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_main_rs(temp.path(), "my-robot").await.unwrap();

        assert!(temp.path().join("src/main.rs").exists());
    }

    #[tokio::test]
    async fn create_simulation_model_json_writes_expected_path() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_simulation_model_json(temp.path()).await.unwrap();

        let dest = temp.path().join(paths::project::model_config("rover"));
        assert!(dest.exists());
        let content = tokio::fs::read_to_string(&dest).await.unwrap();
        assert_eq!(content, MODEL_JSON_TEMPLATE);
    }

    #[tokio::test]
    async fn create_simulation_environment_json_writes_expected_path() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_simulation_environment_json(temp.path()).await.unwrap();

        let dest = temp.path().join(paths::project::environment_config("basic_arena"));
        assert!(dest.exists());
        let content = tokio::fs::read_to_string(&dest).await.unwrap();
        assert_eq!(content, ENVIRONMENT_JSON_TEMPLATE);
    }

    #[tokio::test]
    async fn create_simulation_model_json_creates_missing_parent_dirs() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        assert!(!temp.path().join("configs/simulation").exists());

        service.create_simulation_model_json(temp.path()).await.unwrap();

        assert!(temp.path().join("configs/simulation/models").is_dir());
    }

    #[tokio::test]
    async fn create_rl_training_bundle_requires_requirements_txt_created_first() {
        let temp = TempDir::new().unwrap();
        let service = ProjectTemplateService::new();

        service.create_rl_training_bundle(temp.path()).await.unwrap();

        assert!(temp.path().join("configs/rl/jobs/train.yml").exists());
        assert!(temp.path().join("requirements.txt").exists());
        assert!(!temp.path().join("kestra").exists());
    }
}