isothrum-compiler 0.11.0

//! [`compile`]: the drawing's spec, written and read back by Isoloom, with the lab's own files.

use isoloom_spec::Spec;

use crate::document::{ProvisionDoc, SpecDoc};
use crate::draft::Draft;
use crate::{Error, LabFile, Result, Topology, cables, lans, machines, project, routers, starters, vlans};

/// A compiled lab: the `isoloom.yml` text, the spec Isoloom reads from it, and the lab's own files
/// where the spec points (the appliances' configurations, a starter for each provisioning step).
#[derive(Debug, Clone, PartialEq)]
pub struct Compiled {
    yaml: String,
    spec: Spec,
    files: Vec<LabFile>,
}

impl Compiled {
    /// The spec's text, ready to write to `isoloom.yml`.
    #[must_use]
    pub fn yaml(&self) -> &str {
        &self.yaml
    }

    /// The spec as Isoloom reads it (with where each field is written, for its problems).
    #[must_use]
    pub fn spec(&self) -> &Spec {
        &self.spec
    }

    /// The lab's own files, next to `isoloom.yml` where its paths point: the appliances'
    /// configurations, then a starter for each provisioning step (each path once, inside the
    /// project).
    #[must_use]
    pub fn files(&self) -> &[LabFile] {
        &self.files
    }

    /// The text, the spec and the lab's own files.
    #[must_use]
    pub fn into_parts(self) -> (String, Spec, Vec<LabFile>) {
        (self.yaml, self.spec, self.files)
    }
}

/// Compiles a drawing into an Isoloom spec and the lab's own files.
///
/// # Errors
///
/// [`Error`]: what the drawing can't say (a cable to an unknown node, a LAN that's full, two
/// machines asking for one address...). [`Error::Unreadable`] would mean the compiler wrote
/// something Isoloom's format doesn't hold: a bug.
pub fn compile(topo: &Topology) -> Result<Compiled> {
    cables::check_count(topo)?;
    vlans::check_switch_names(topo)?;
    let mut draft = Draft::default();
    machines::add(topo, &mut draft)?;
    lans::address(topo, &mut draft)?;
    cables::allocate(topo, &mut draft)?;
    routers::add_reach_rules(&mut draft);
    routers::cisco_gateways(topo, &mut draft);
    vlans::nest(topo, &mut draft);
    let doc = SpecDoc {
        version: 1,
        name: topo.name.clone(),
        networks: draft.networks,
        reach: draft.reach,
        machines: draft.machines,
        provision: draft.controller.iter().map(ProvisionDoc::from).collect(),
    };
    let yaml = serde_yaml_ng::to_string(&doc).map_err(Error::Yaml)?;
    let spec = isoloom_spec::syntax::parse(&yaml).map_err(Error::Unreadable)?;
    let mut files = project::config_files(topo);
    starters::add_starters(&mut files, &spec, &draft.controller);
    Ok(Compiled { yaml, spec, files })
}