Validate against target environments during build

Signed-off-by: itowlson <[email protected]>

Author: itowlson

Cargo.lock

@@ -47,6 +47,7 @@ spin-app = { path = "crates/app" }
 spin-build = { path = "crates/build" }
 spin-common = { path = "crates/common" }
 spin-doctor = { path = "crates/doctor" }
+spin-environments = { path = "crates/environments" }
 spin-expressions = { path = "crates/expressions" }
 spin-http = { path = "crates/http" }
 spin-loader = { path = "crates/loader" }

Cargo.toml

@@ -9,6 +9,7 @@ anyhow = "1.0.57"
 futures = "0.3.21"
 serde = { version = "1.0", features = ["derive"] }
 spin-common = { path = "../common" }
+spin-environments = { path = "../environments" }  # TODO: it would be good to break this dependency because not everything should have to drag this dep around
 spin-manifest = { path = "../manifest" }
 subprocess = "0.2.8"
 terminal = { path = "../terminal" }

crates/build/Cargo.toml

@@ -0,0 +1,17 @@
+#[derive(Default)]
+pub struct DeploymentTargets {
+    target_environments: Vec<DeploymentTarget>,
+}
+pub type DeploymentTarget = String;
+
+impl DeploymentTargets {
+    pub fn new(envs: Vec<String>) -> Self {
+        Self {
+            target_environments: envs,
+        }
+    }
+
+    pub fn iter(&self) -> impl Iterator<Item = &str> {
+        self.target_environments.iter().map(|s| s.as_str())
+    }
+}

crates/build/src/deployment.rs

@@ -2,6 +2,7 @@
 
 //! A library for building Spin components.
 
+mod deployment;
 mod manifest;
 
 use anyhow::{anyhow, bail, Context, Result};
@@ -17,24 +18,37 @@ use crate::manifest::component_build_configs;
 
 /// If present, run the build command of each component.
 pub async fn build(manifest_file: &Path, component_ids: &[String]) -> Result<()> {
-    let (components, manifest_err) =
-        component_build_configs(manifest_file)
-            .await
-            .with_context(|| {
-                format!(
-                    "Cannot read manifest file from {}",
-                    quoted_path(manifest_file)
-                )
-            })?;
+    let (components, deployment_targets, manifest) = component_build_configs(manifest_file)
+        .await
+        .with_context(|| {
+        format!(
+            "Cannot read manifest file from {}",
+            quoted_path(manifest_file)
+        )
+    })?;
     let app_dir = parent_dir(manifest_file)?;
 
     let build_result = build_components(component_ids, components, app_dir);
 
-    if let Some(e) = manifest_err {
+    if let Err(e) = &manifest {
         terminal::warn!("The manifest has errors not related to the Wasm component build. Error details:\n{e:#}");
     }
 
-    build_result
+    build_result?;
+
+    if let Ok(manifest) = &manifest {
+        let resolution_context = spin_environments::ResolutionContext {
+            base_dir: manifest_file.parent().unwrap().to_owned(),
+        };
+        spin_environments::validate_application_against_environment_ids(
+            deployment_targets.iter(),
+            manifest,
+            &resolution_context,
+        )
+        .await?;
+    }
+
+    Ok(())
 }
 
 fn build_components(

crates/build/src/lib.rs

@@ -4,37 +4,60 @@ use std::{collections::BTreeMap, path::Path};
 
 use spin_manifest::{schema::v2, ManifestVersion};
 
+use crate::deployment::DeploymentTargets;
+
 /// Returns a map of component IDs to [`v2::ComponentBuildConfig`]s for the
 /// given (v1 or v2) manifest path. If the manifest cannot be loaded, the
 /// function attempts fallback: if fallback succeeds, result is Ok but the load error
 /// is also returned via the second part of the return value tuple.
 pub async fn component_build_configs(
     manifest_file: impl AsRef<Path>,
-) -> Result<(Vec<ComponentBuildInfo>, Option<spin_manifest::Error>)> {
+) -> Result<(
+    Vec<ComponentBuildInfo>,
+    DeploymentTargets,
+    Result<spin_manifest::schema::v2::AppManifest, spin_manifest::Error>,
+)> {
     let manifest = spin_manifest::manifest_from_file(&manifest_file);
     match manifest {
-        Ok(manifest) => Ok((build_configs_from_manifest(manifest), None)),
-        Err(e) => fallback_load_build_configs(&manifest_file)
-            .await
-            .map(|bc| (bc, Some(e))),
+        Ok(mut manifest) => {
+            spin_manifest::normalize::normalize_manifest(&mut manifest);
+            let bc = build_configs_from_manifest(&manifest);
+            let dt = deployment_targets_from_manifest(&manifest);
+            Ok((bc, dt, Ok(manifest)))
+        }
+        Err(e) => {
+            let bc = fallback_load_build_configs(&manifest_file).await?;
+            let dt = fallback_load_deployment_targets(&manifest_file).await?;
+            Ok((bc, dt, Err(e)))
+        }
     }
 }
 
 fn build_configs_from_manifest(
-    mut manifest: spin_manifest::schema::v2::AppManifest,
+    manifest: &spin_manifest::schema::v2::AppManifest,
 ) -> Vec<ComponentBuildInfo> {
-    spin_manifest::normalize::normalize_manifest(&mut manifest);
-
     manifest
         .components
-        .into_iter()
+        .iter()
         .map(|(id, c)| ComponentBuildInfo {
             id: id.to_string(),
-            build: c.build,
+            build: c.build.clone(),
         })
         .collect()
 }
 
+fn deployment_targets_from_manifest(
+    manifest: &spin_manifest::schema::v2::AppManifest,
+) -> DeploymentTargets {
+    let target_environments = manifest.application.targets.clone();
+    // let components = manifest
+    //     .components
+    //     .iter()
+    //     .map(|(id, c)| (id.to_string(), c.source.clone()))
+    //     .collect();
+    DeploymentTargets::new(target_environments)
+}
+
 async fn fallback_load_build_configs(
     manifest_file: impl AsRef<Path>,
 ) -> Result<Vec<ComponentBuildInfo>> {
@@ -57,6 +80,42 @@ async fn fallback_load_build_configs(
     })
 }
 
+async fn fallback_load_deployment_targets(
+    manifest_file: impl AsRef<Path>,
+) -> Result<DeploymentTargets> {
+    // fn try_parse_component_source(c: (&String, &toml::Value)) -> Option<(String, spin_manifest::schema::v2::ComponentSource)> {
+    //     let (id, ctab) = c;
+    //     let cs = ctab.as_table()
+    //         .and_then(|c| c.get("source"))
+    //         .and_then(|cs| spin_manifest::schema::v2::ComponentSource::deserialize(cs.clone()).ok());
+    //     cs.map(|cs| (id.to_string(), cs))
+    // }
+    let manifest_text = tokio::fs::read_to_string(manifest_file).await?;
+    Ok(match ManifestVersion::detect(&manifest_text)? {
+        ManifestVersion::V1 => Default::default(),
+        ManifestVersion::V2 => {
+            let table: toml::value::Table = toml::from_str(&manifest_text)?;
+            let target_environments = table
+                .get("application")
+                .and_then(|a| a.as_table())
+                .and_then(|t| t.get("targets"))
+                .and_then(|arr| arr.as_array())
+                .map(|v| v.as_slice())
+                .unwrap_or_default()
+                .iter()
+                .filter_map(|t| t.as_str())
+                .map(|s| s.to_owned())
+                .collect();
+            // let components = table
+            //     .get("component")
+            //     .and_then(|cs| cs.as_table())
+            //     .map(|table| table.iter().filter_map(try_parse_component_source).collect())
+            //     .unwrap_or_default();
+            DeploymentTargets::new(target_environments)
+        }
+    })
+}
+
 #[derive(Deserialize)]
 pub struct ComponentBuildInfo {
     #[serde(default)]

crates/build/src/manifest.rs

@@ -0,0 +1,26 @@
+[package]
+name = "spin-environments"
+version = { workspace = true }
+authors = { workspace = true }
+edition = { workspace = true }
+
+[dependencies]
+anyhow = { workspace = true }
+futures = "0.3"
+indexmap = "2.2.6"
+miette = "7.2.0"
+oci-distribution = { git = "https://github.com/fermyon/oci-distribution", rev = "7e4ce9be9bcd22e78a28f06204931f10c44402ba" }
+semver = "1.0"
+serde = { version = "1.0", features = ["derive"] }
+serde_json = "1.0"
+spin-common = { path = "../common" }
+spin-componentize = { path = "../componentize" }
+spin-manifest = { path = "../manifest" }
+tracing = { workspace = true }
+wac-parser = "0.5.0"
+wac-resolver = "0.5.0"
+wac-types = "0.5.0"
+wasm-pkg-loader = "0.4.1"
+
+[lints]
+workspace = true