Removes host_compat validation check, error, and config option

Signed-off-by: David Gilligan-Cook <[email protected]>

Author: dcookspi

crates/spk-config/src/config.rs

@@ -112,14 +112,6 @@ pub struct Statsd {
     pub format: String,
 }
 
-#[derive(Clone, Default, Debug, Deserialize, Serialize)]
-#[serde(default)]
-pub struct HostCompat {
-    /// Whether to turn on host compatibility validation of the option
-    /// names in a build spec.
-    pub validate: bool,
-}
-
 /// Configuration values for spk.
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
 #[serde(default)]
@@ -131,7 +123,6 @@ pub struct Config {
     pub solver: Solver,
     pub statsd: Statsd,
     pub metadata: Metadata,
-    pub host_compat: HostCompat,
 }
 
 impl Config {

crates/spk-schema/src/build_spec.rs

@@ -30,11 +30,11 @@ const ANY_ADDS: &[&OptName] = &[];
 
 // Each HostCompat value disallows certain var names when host_compat
 // validation is enabled in the config file.
-// TODO: move these to config
-const DISTRO_DISALLOWS: &[&OptName] = &[];
-const ARCH_DISALLOWS: &[&OptName] = &[OptName::distro()];
-const OS_DISALLOWS: &[&OptName] = &[OptName::distro(), OptName::arch()];
-const ANY_DISALLOWS: &[&OptName] = &[OptName::distro(), OptName::arch(), OptName::os()];
+// TODO: these will be used when the linting is added, so haven't removed them
+// const DISTRO_DISALLOWS: &[&OptName] = &[];
+// const ARCH_DISALLOWS: &[&OptName] = &[OptName::distro()];
+// const OS_DISALLOWS: &[&OptName] = &[OptName::distro(), OptName::arch()];
+// const ANY_DISALLOWS: &[&OptName] = &[OptName::distro(), OptName::arch(), OptName::os()];
 
 /// Set what level of cross-platform compatibility the built package
 /// should have.
@@ -106,35 +106,15 @@ impl HostCompat {
         Ok(settings)
     }
 
-    fn names_disallowed(&self) -> &[&OptName] {
-        match self {
-            HostCompat::Distro => DISTRO_DISALLOWS,
-            HostCompat::Arch => ARCH_DISALLOWS,
-            HostCompat::Os => OS_DISALLOWS,
-            HostCompat::Any => ANY_DISALLOWS,
-        }
-    }
-
-    /// Check the given options are compatible with the HostCompat
-    /// setting.
-    pub fn validate_host_opts(&self, options: &[Opt]) -> Result<()> {
-        let known = options.iter().map(Opt::full_name).collect::<HashSet<_>>();
-
-        let disallowed_names = self.names_disallowed();
-
-        for name in disallowed_names {
-            // If a name that this setting would add is already in the
-            // given options then flag it as an error.
-            if known.contains(name) {
-                return Err(Error::HostOptionNotAllowedInVariantError(
-                    name.to_string(),
-                    self.to_string(),
-                ));
-            }
-        }
-
-        Ok(())
-    }
+    // TODO: comment this back in when adding linting for host_compats
+    // fn names_disallowed(&self) -> &[&OptName] {
+    //     match self {
+    //         HostCompat::Distro => DISTRO_DISALLOWS,
+    //         HostCompat::Arch => ARCH_DISALLOWS,
+    //         HostCompat::Os => OS_DISALLOWS,
+    //         HostCompat::Any => ANY_DISALLOWS,
+    //     }
+    //}
 }
 
 /// A set of structured inputs used to build a package.
@@ -198,18 +178,9 @@ impl BuildSpec {
             }
         }
 
-        // Optionally, check the opts aren't setting an option
-        // controlled by the host compatibility setting.
-        let config = spk_config::get_config()?;
-        if config.host_compat.validate {
-            self.host_compat.validate_host_opts(&opts)?;
-        }
-
         // Add any host options that are not already present.
         let host_opts = self.host_compat.host_options()?;
         for opt in host_opts.iter() {
-            //let mut opt = Opt::Var(VarOpt::new(name)?);
-            //opt.set_value(value.to_string())?;
             if known.insert(opt.full_name().to_owned()) {
                 opts.push(opt.clone());
             }

crates/spk-schema/src/build_spec_test.rs

@@ -130,14 +130,7 @@ fn test_build_spec_with_host_opt_and_disallowed_name(#[case] value: &str) {
             // This return an error because of the "distro/centos" var
             // setting in the variant
             let result = build_spec.opts_for_variant(&build_spec.variants[0]);
-            let config = spk_config::get_config().unwrap();
-            if config.host_compat.validate {
-                // With the checks, this should fail validation
-                assert!(result.is_err())
-            } else {
-                // Without the checks, this should be ok
-                assert!(result.is_ok())
-            }
+            assert!(result.is_ok())
         }
         Err(err) => panic!("Fail: build spec didn't parse with host_compat {value}: {err:?}"),
     }

crates/spk-schema/src/error.rs

@@ -70,13 +70,6 @@ pub enum Error {
     #[error("{0}: {1}")]
     InvalidBuildChangeSetError(String, #[source] spk_schema_validators::Error),
 
-    #[error("'{0}' cannot be set in a variant. The host_compatibility value '{1}' will set it.")]
-    #[diagnostic(
-        help("Try removing that variable (var), or changing the 'host_compat' setting"),
-        code("spk_schema::host_option_not_allowed_in_variant")
-    )]
-    HostOptionNotAllowedInVariantError(String, String),
-
     #[error("'{0}' not a valid distro name for 'host_compat: distro' to use as a var name: {1}")]
     #[diagnostic(help("The distro name comes from the host's settings and contains a value spk cannot use. Please contact your Admin to address this."),
                  code("spk_schema::host_option_not_valid_distro_name"))]