faucet-cli 1.11.0

//! `faucet new connector` — scaffold a ready-to-build connector crate (#209).

use crate::cli::{NewArgs, NewConnectorArgs, NewTarget};
use crate::error::{CliError, CliResult};
use crate::scaffold::{ConnectorKind, ConnectorScaffold};

/// Execute the `new` command.
pub async fn run(args: NewArgs) -> CliResult<()> {
    match args.target {
        NewTarget::Connector(a) => run_connector(a).await,
    }
}

/// Scaffold a connector crate.
async fn run_connector(args: NewConnectorArgs) -> CliResult<()> {
    let kind = ConnectorKind::parse(&args.kind).map_err(CliError::Config)?;
    let scaffold =
        ConnectorScaffold::new(&args.name, kind, args.common).map_err(CliError::Config)?;
    let files = scaffold.files();
    let root = &args.output;

    // Fail before writing anything if any target already exists (unless --force).
    if !args.force {
        for f in &files {
            let path = root.join(&f.path);
            if path.exists() {
                return Err(CliError::ScaffoldExists { path });
            }
        }
    }

    for f in &files {
        let path = root.join(&f.path);
        if let Some(parent) = path.parent() {
            std::fs::create_dir_all(parent)?;
        }
        std::fs::write(&path, &f.contents)?;
    }

    println!(
        "Scaffolded {} ({} files):",
        scaffold.crate_name(),
        files.len()
    );
    for f in &files {
        println!("  {}", root.join(&f.path).display());
    }
    println!(
        "\nNext:\n  cd {}\n  cargo test          # the generated passthrough compiles & tests green\n  # then implement the TODOs in src/config.rs and src/{}",
        root.join(scaffold.crate_name()).display(),
        match kind {
            ConnectorKind::Source => "stream.rs",
            ConnectorKind::Sink => "sink.rs",
        }
    );
    // Conformance tier: a fresh scaffold has a real config schema but is not yet
    // registered/documented, so it starts at ⚪ Draft. Show the path to Stable.
    let cap = match kind {
        ConnectorKind::Source => "native streaming (override stream_pages) + resumable bookmarks",
        ConnectorKind::Sink => "idempotent writes + upsert / schema evolution",
    };
    println!(
        "\nConformance tier: ⚪ Draft → reach 🟢 Stable by\n  \
         [ ] adding a verified entry to cli/connectors/registry.json\n  \
         [ ] a complete config_schema() (already scaffolded)\n  \
         [ ] a one-line description in the connector catalog\n  \
         [ ] {cap}\n  \
         [ ] unit + integration tests (run the faucet-conformance battery)\n\
         Check your score any time with `faucet conformance {}`.",
        scaffold.crate_name(),
    );
    Ok(())
}

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

    #[tokio::test]
    async fn scaffolds_a_source_crate_to_disk() {
        let dir = tempfile::tempdir().unwrap();
        let args = NewConnectorArgs {
            name: "acme".into(),
            kind: "source".into(),
            common: false,
            output: dir.path().to_path_buf(),
            force: false,
        };
        run_connector(args).await.expect("scaffold succeeds");
        let base = dir.path().join("faucet-source-acme");
        assert!(base.join("Cargo.toml").is_file());
        assert!(base.join("src/lib.rs").is_file());
        assert!(base.join("src/config.rs").is_file());
        assert!(base.join("src/stream.rs").is_file());
        assert!(base.join("README.md").is_file());
        let lib = std::fs::read_to_string(base.join("src/lib.rs")).unwrap();
        assert!(lib.contains("pub use stream::AcmeSource;"));
    }

    #[tokio::test]
    async fn refuses_to_overwrite_without_force() {
        let dir = tempfile::tempdir().unwrap();
        let mk = || NewConnectorArgs {
            name: "acme".into(),
            kind: "sink".into(),
            common: false,
            output: dir.path().to_path_buf(),
            force: false,
        };
        run_connector(mk()).await.expect("first scaffold");
        let err = run_connector(mk()).await.expect_err("second must refuse");
        assert!(matches!(err, CliError::ScaffoldExists { .. }));
    }

    #[tokio::test]
    async fn force_overwrites() {
        let dir = tempfile::tempdir().unwrap();
        let mk = |force| NewConnectorArgs {
            name: "acme".into(),
            kind: "sink".into(),
            common: true,
            output: dir.path().to_path_buf(),
            force,
        };
        run_connector(mk(false)).await.expect("first scaffold");
        run_connector(mk(true)).await.expect("force overwrite");
        assert!(dir.path().join("faucet-common-acme/Cargo.toml").is_file());
    }

    #[tokio::test]
    async fn rejects_bad_kind() {
        let dir = tempfile::tempdir().unwrap();
        let args = NewConnectorArgs {
            name: "acme".into(),
            kind: "middleware".into(),
            common: false,
            output: dir.path().to_path_buf(),
            force: false,
        };
        assert!(matches!(
            run_connector(args).await,
            Err(CliError::Config(_))
        ));
    }

    #[tokio::test]
    async fn rejects_bad_name() {
        let dir = tempfile::tempdir().unwrap();
        let args = NewConnectorArgs {
            name: "Acme_Bad".into(),
            kind: "source".into(),
            common: false,
            output: dir.path().to_path_buf(),
            force: false,
        };
        assert!(matches!(
            run_connector(args).await,
            Err(CliError::Config(_))
        ));
    }
}