provisioning: Report expected error for invalid type

Signed-off-by: Ikey Doherty <[email protected]>

Author: ikeycode

crates/provisioning/src/commands/find_disk.rs

@@ -24,12 +24,13 @@ pub(crate) fn parse(context: Context<'_>) -> Result<super::Command, crate::Error
         0 => {
             return Err(crate::InvalidArguments {
                 at: context.node.span(),
-                advice: Some("find-disk <name> - provide a name for the storage device".into()),
+                advice: Some("find-disk <name> - you must provide a name to store the object".into()),
             }
             .into())
         }
         1 => arguments[0].value().as_string().ok_or(crate::InvalidType {
             at: arguments[0].span(),
+            expected_type: crate::KdlType::String,
         })?,
         _ => {
             return Err(crate::InvalidArguments {

crates/provisioning/src/errors.rs

@@ -7,6 +7,8 @@ use std::{io, sync::Arc};
 use miette::{Diagnostic, NamedSource, SourceSpan};
 use thiserror::Error;
 
+use crate::KdlType;
+
 /// Error type for the provisioning crate
 #[derive(Diagnostic, Debug, Error)]
 pub enum Error {
@@ -58,11 +60,14 @@ pub struct ParseError {
 
 /// Error for invalid types
 #[derive(Debug, Diagnostic, Error)]
-#[error("invalid type")]
+#[error("invalid type, expected {expected_type}")]
 #[diagnostic(severity(error))]
 pub struct InvalidType {
     #[label]
     pub at: SourceSpan,
+
+    /// The expected type
+    pub expected_type: KdlType,
 }
 
 /// Error for missing mandatory properties

crates/provisioning/src/helpers.rs

@@ -4,7 +4,7 @@
 
 use kdl::{KdlEntry, KdlNode};
 
-use crate::{Error, InvalidType, MissingProperty};
+use crate::{Error, InvalidType, KdlType, MissingProperty};
 
 // Get a property from a node
 pub(crate) fn get_kdl_property<'a>(node: &'a KdlNode, name: &'static str) -> Result<&'a KdlEntry, Error> {
@@ -19,7 +19,10 @@ pub(crate) fn get_kdl_property<'a>(node: &'a KdlNode, name: &'static str) -> Res
 
 // Get a string property from a value
 pub(crate) fn kdl_value_to_string(entry: &kdl::KdlEntry) -> Result<String, Error> {
-    let value = entry.value().as_string().ok_or(InvalidType { at: entry.span() })?;
+    let value = entry.value().as_string().ok_or(InvalidType {
+        at: entry.span(),
+        expected_type: KdlType::String,
+    })?;
 
     Ok(value.to_owned())
 }