aprender-contracts 0.72.3

//! End-to-end codegen — generates all artifacts to disk.
//!
//! Combines scaffold, kani, and probar generators into a single
//! operation that writes files to a target directory.

use std::path::{Path, PathBuf};

use crate::binding::BindingRegistry;
use crate::book_gen::generate_contract_page;
use crate::coq_gen::generate_coq_spec;
use crate::graph::{dependency_graph, DependencyGraph};
use crate::invariant_gen::generate_invariants;
use crate::kani_gen::generate_kani_harnesses;
use crate::probar_gen::{generate_probar_tests, generate_wired_probar_tests};
use crate::scaffold::generate_trait;
use crate::schema::Contract;

/// Manifest of generated files.
#[derive(Debug, Clone)]
pub struct GeneratedFiles {
    /// Files that were generated.
    pub files: Vec<GeneratedFile>,
}

/// A single generated file.
#[derive(Debug, Clone)]
pub struct GeneratedFile {
    /// Path relative to the output directory.
    pub relative_path: PathBuf,
    /// Absolute path where the file was written.
    pub absolute_path: PathBuf,
    /// What kind of artifact this is.
    pub kind: ArtifactKind,
    /// Number of bytes written.
    pub bytes: usize,
}

/// The kind of generated artifact.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ArtifactKind {
    Scaffold,
    KaniHarness,
    ProbarTest,
    WiredProbarTest,
    BookPage,
    Invariants,
    CoqSpec,
}

impl std::fmt::Display for ArtifactKind {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Scaffold => write!(f, "scaffold"),
            Self::KaniHarness => write!(f, "kani"),
            Self::ProbarTest => write!(f, "probar"),
            Self::WiredProbarTest => write!(f, "wired-probar"),
            Self::BookPage => write!(f, "book-page"),
            Self::Invariants => write!(f, "invariants"),
            Self::CoqSpec => write!(f, "coq"),
        }
    }
}

/// Generate all artifacts from a contract and write to `output_dir`.
///
/// Creates the output directory if it doesn't exist. Generates:
/// - `scaffold.rs` — trait + test stubs
/// - `kani.rs` — `#[kani::proof]` harnesses
/// - `probar.rs` — property-based tests
/// - `wired_probar.rs` — wired tests (only if binding provided)
///
/// # Errors
///
/// Returns `io::Error` if directory creation or file writes fail.
pub fn generate_all(
    contract: &Contract,
    stem: &str,
    output_dir: &Path,
    binding: Option<&BindingRegistry>,
) -> Result<GeneratedFiles, std::io::Error> {
    let rendered = render_all(contract, stem, binding);
    std::fs::create_dir_all(output_dir)?;
    let mut files = Vec::with_capacity(rendered.len());
    for (relative_path, kind, content) in rendered {
        let absolute_path = output_dir.join(&relative_path);
        std::fs::write(&absolute_path, &content)?;
        files.push(GeneratedFile {
            relative_path,
            absolute_path,
            kind,
            bytes: content.len(),
        });
    }
    Ok(GeneratedFiles { files })
}

/// The files `generate_all` writes, rendered in memory: no directory is created and no file is
/// written (`pv generate --dry-run`, #6395). `output_dir` only prefixes `absolute_path`.
#[must_use]
pub fn plan_all(
    contract: &Contract,
    stem: &str,
    output_dir: &Path,
    binding: Option<&BindingRegistry>,
) -> GeneratedFiles {
    let files = render_all(contract, stem, binding)
        .into_iter()
        .map(|(relative_path, kind, content)| GeneratedFile {
            absolute_path: output_dir.join(&relative_path),
            relative_path,
            kind,
            bytes: content.len(),
        })
        .collect();
    GeneratedFiles { files }
}

/// Render every artifact `generate_all` emits, in emission order. Pure: touches no filesystem.
fn render_all(
    contract: &Contract,
    stem: &str,
    binding: Option<&BindingRegistry>,
) -> Vec<(PathBuf, ArtifactKind, String)> {
    let mut out = vec![
        (
            PathBuf::from(format!("{stem}_scaffold.rs")),
            ArtifactKind::Scaffold,
            generate_trait(contract),
        ),
        (
            PathBuf::from(format!("{stem}_kani.rs")),
            ArtifactKind::KaniHarness,
            generate_kani_harnesses(contract),
        ),
        (
            PathBuf::from(format!("{stem}_probar.rs")),
            ArtifactKind::ProbarTest,
            generate_probar_tests(contract),
        ),
    ];
    if let Some(reg) = binding {
        let contract_file = format!("{stem}.yaml");
        out.push((
            PathBuf::from(format!("{stem}_wired_probar.rs")),
            ArtifactKind::WiredProbarTest,
            generate_wired_probar_tests(contract, &contract_file, reg),
        ));
    }
    let invariant_content = generate_invariants(contract);
    if !invariant_content.is_empty() {
        out.push((
            PathBuf::from(format!("{stem}_invariants.rs")),
            ArtifactKind::Invariants,
            invariant_content,
        ));
    }
    out.push((
        PathBuf::from(format!("{stem}.v")),
        ArtifactKind::CoqSpec,
        generate_coq_spec(contract, stem),
    ));
    let single_graph = build_single_contract_graph(contract, stem);
    out.push((
        PathBuf::from(format!("{stem}_book.md")),
        ArtifactKind::BookPage,
        generate_contract_page(contract, stem, &single_graph),
    ));
    out
}

/// Build a minimal dependency graph for a single contract.
/// Used by `generate_all` when the full graph isn't available.
fn build_single_contract_graph(contract: &Contract, stem: &str) -> DependencyGraph {
    let refs = vec![(stem.to_string(), contract)];
    dependency_graph(&refs)
}

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

    fn minimal_contract() -> Contract {
        parse_contract_str(
            r#"
metadata:
  version: "1.0.0"
  description: "Test"
  references: ["Paper"]
equations:
  f:
    formula: "f(x) = x"
proof_obligations:
  - type: invariant
    property: "output finite"
falsification_tests:
  - id: FALSIFY-001
    rule: "finiteness"
    prediction: "output is always finite"
    if_fails: "overflow"
kani_harnesses:
  - id: KANI-001
    obligation: OBL-001
    bound: 16
"#,
        )
        .unwrap()
    }

    #[test]
    fn generate_all_without_binding() {
        let c = minimal_contract();
        let dir = tempfile::tempdir().unwrap();
        let result = generate_all(&c, "test-kernel-v1", dir.path(), None).unwrap();
        assert_eq!(result.files.len(), 5); // scaffold + kani + probar + coq + book
        assert!(result
            .files
            .iter()
            .any(|f| f.kind == ArtifactKind::Scaffold));
        assert!(result
            .files
            .iter()
            .any(|f| f.kind == ArtifactKind::KaniHarness));
        assert!(result
            .files
            .iter()
            .any(|f| f.kind == ArtifactKind::ProbarTest));
        assert!(result
            .files
            .iter()
            .any(|f| f.kind == ArtifactKind::BookPage));
        for f in &result.files {
            assert!(f.absolute_path.exists());
            assert!(f.bytes > 0);
        }
    }

    #[test]
    fn generate_all_with_binding() {
        let c = minimal_contract();
        let binding = crate::binding::parse_binding_str(
            r#"
version: "1.0.0"
target_crate: test
bindings:
  - contract: test-kernel-v1.yaml
    equation: f
    module_path: "test::f"
    function: f
    signature: "fn f(x: &[f32]) -> Vec<f32>"
    status: implemented
"#,
        )
        .unwrap();
        let dir = tempfile::tempdir().unwrap();
        let result = generate_all(&c, "test-kernel-v1", dir.path(), Some(&binding)).unwrap();
        assert_eq!(result.files.len(), 6); // scaffold + kani + probar + wired + coq + book
        assert!(result
            .files
            .iter()
            .any(|f| f.kind == ArtifactKind::WiredProbarTest));
    }

    #[test]
    fn generates_into_subdir() {
        let c = minimal_contract();
        let dir = tempfile::tempdir().unwrap();
        let sub = dir.path().join("deep").join("nested");
        let result = generate_all(&c, "test-kernel-v1", &sub, None).unwrap();
        assert_eq!(result.files.len(), 5); // scaffold + kani + probar + coq + book
        assert!(sub.exists());
    }

    #[test]
    fn artifact_kind_display() {
        assert_eq!(ArtifactKind::Scaffold.to_string(), "scaffold");
        assert_eq!(ArtifactKind::KaniHarness.to_string(), "kani");
        assert_eq!(ArtifactKind::ProbarTest.to_string(), "probar");
        assert_eq!(ArtifactKind::WiredProbarTest.to_string(), "wired-probar");
        assert_eq!(ArtifactKind::BookPage.to_string(), "book-page");
    }

    #[test]
    fn file_names_use_stem() {
        let c = minimal_contract();
        let dir = tempfile::tempdir().unwrap();
        let result = generate_all(&c, "softmax-kernel-v1", dir.path(), None).unwrap();
        let names: Vec<String> = result
            .files
            .iter()
            .map(|f| f.relative_path.to_string_lossy().to_string())
            .collect();
        assert!(names.contains(&"softmax-kernel-v1_scaffold.rs".to_string()));
        assert!(names.contains(&"softmax-kernel-v1_kani.rs".to_string()));
        assert!(names.contains(&"softmax-kernel-v1_probar.rs".to_string()));
    }
}