slumber_core 5.3.0

//! A request collection defines recipes, profiles, etc. that make requests
//! possible

mod cereal;
mod models;
mod recipe_tree;
#[cfg(feature = "schema")]
mod schema;
mod value_template;

pub use cereal::HasId;
pub use models::*;
pub use recipe_tree::*;
pub use value_template::{RenderedValue, ValueTemplate};

use itertools::Itertools;
use std::{
    env,
    fmt::{self, Debug, Display},
    fs,
    path::{Path, PathBuf},
};
use tracing::{trace, warn};

/// The support file names to be automatically loaded as a config. We only
/// support loading from one file at a time, so if more than one of these is
/// defined, we'll take the earliest and print a warning.
const CONFIG_FILES: &[&str] = &[
    "slumber.yml",
    "slumber.yaml",
    ".slumber.yml",
    ".slumber.yaml",
];

/// A handle for a collection file. This makes it easy to load and reload
/// the collection in the file.
///
/// Invariants:
/// - The path exists
/// - The path points to a file
#[derive(Clone, Debug)]
pub struct CollectionFile(PathBuf);

impl CollectionFile {
    /// Get a handle to the collection file, returning an error if none is
    /// available. This will use the override if given, otherwise it will fall
    /// back to searching the given directory for a collection.
    pub fn new(
        override_path: Option<PathBuf>,
    ) -> Result<Self, CollectionError> {
        Self::with_dir(
            env::current_dir().map_err(CollectionError::CurrentDir)?,
            override_path,
        )
    }

    /// Get a handle to the collection file, searching a specific directory.
    /// This is only useful for testing. Typically you just want [Self::new].
    pub fn with_dir(
        mut dir: PathBuf,
        override_path: Option<PathBuf>,
    ) -> Result<Self, CollectionError> {
        // If the override is a dir, search that dir instead. If it's a file,
        // just return it
        if let Some(override_path) = override_path {
            let joined = dir.join(override_path);
            if fs::metadata(&joined)
                .map_err(|error| CollectionError::Io {
                    path: joined.clone(),
                    error,
                })?
                .is_dir()
            {
                dir = joined;
            } else {
                return Ok(Self(joined));
            }
        }

        detect_path(&dir)
            .ok_or_else(|| CollectionError::NoFile { path: dir })
            .map(Self)
    }

    /// Load collection from this file. Use [Self::new] to get a handle to the
    /// file. This pattern enables the TUI to start up and watch the collection
    /// file, even if it's invalid.
    pub fn load(&self) -> Result<Collection, CollectionError> {
        Collection::load(&self.0)
    }

    /// Get the path of the file that this collection was loaded from
    pub fn path(&self) -> &Path {
        &self.0
    }

    /// Get the directory that contains this file
    pub fn parent(&self) -> &Path {
        // This is safe because of the invariants: the path always points to a
        // file
        self.0.parent().expect("Collection file does not exist")
    }
}

impl Display for CollectionFile {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "{}", self.0.display())
    }
}

/// Search the current directory for a config file matching one of the known
/// file names, and return it if found
fn detect_path(dir: &Path) -> Option<PathBuf> {
    /// Search a directory and its parents for the collection file. Return None
    /// only if we got through the whole tree and couldn't find it
    fn search_all(dir: &Path) -> Option<PathBuf> {
        search(dir).or_else(|| {
            let parent = dir.parent()?;
            search_all(parent)
        })
    }

    /// Search a single directory for a collection file
    fn search(dir: &Path) -> Option<PathBuf> {
        trace!("Scanning for collection file in {dir:?}");

        let paths = CONFIG_FILES
            .iter()
            .map(|file| dir.join(file))
            // This could be async but I'm being lazy and skipping it for now,
            // since we only do this at startup anyway (mid-process reloading
            // reuses the detected path so we don't re-detect)
            .filter(|p| p.exists())
            .collect_vec();
        match paths.as_slice() {
            [] => None,
            [first, rest @ ..] => {
                if !rest.is_empty() {
                    warn!(
                        "Multiple collection files detected. {first:?} will be \
                            used and the following will be ignored: {rest:?}"
                    );
                }

                trace!("Found collection file at {first:?}");
                Some(first.clone())
            }
        }
    }

    // Walk *up* the tree until we've hit the root
    search_all(dir)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{http::HttpMethod, test_util::by_id};
    use indexmap::indexmap;
    use pretty_assertions::assert_eq;
    use rstest::rstest;
    use serde_json::json;
    use slumber_util::{
        Factory, TempDir, assert_err, temp_dir, test_data_dir,
        yaml::SourceLocation,
    };
    use std::{fs, fs::File};

    /// Test various cases of [CollectionFile::with_dir]
    #[rstest]
    #[case::parent_only(None, true, false, "slumber.yml")]
    #[case::child_only(None, false, true, "child/slumber.yml")]
    #[case::parent_and_child(None, true, true, "child/slumber.yml")]
    #[case::directory(
        Some("grandchild"),
        true,
        true,
        "child/grandchild/slumber.yml"
    )]
    #[case::overriden(Some("override.yml"), true, true, "child/override.yml")]
    fn test_with_dir(
        temp_dir: TempDir,
        #[case] override_path: Option<&str>,
        #[case] has_parent: bool,
        #[case] has_child: bool,
        #[case] expected: &str,
    ) {
        let child_dir = temp_dir.join("child");
        fs::create_dir(&child_dir).unwrap();
        let file = "slumber.yml";
        if has_parent {
            File::create(temp_dir.join(file)).unwrap();
        }
        if has_child {
            File::create(child_dir.join(file)).unwrap();
            let grandchild_dir = child_dir.join("grandchild");
            fs::create_dir(&grandchild_dir).unwrap();
            File::create(grandchild_dir.join(file)).unwrap();
        }
        File::create(child_dir.join("override.yml")).unwrap();
        let expected: PathBuf = temp_dir.join(expected);

        let actual = CollectionFile::with_dir(
            child_dir,
            override_path.map(PathBuf::from),
        )
        .unwrap();
        assert_eq!(actual.path(), expected);
    }

    /// Test that with_dir fails when no collection file is found and no
    /// override is given
    #[rstest]
    #[case::no_file(None, "No collection file found")]
    #[case::override_doesnt_exist(
        Some("./bogus/"),
        if cfg!(unix) {
            "No such file or directory"
        } else {
            "The system cannot find the file specified"
        }
    )]
    fn test_with_dir_error(
        temp_dir: TempDir,
        #[case] override_path: Option<&str>,
        #[case] expected_err: &str,
    ) {
        assert_err(
            CollectionFile::with_dir(
                temp_dir.to_path_buf(),
                override_path.map(PathBuf::from),
            ),
            expected_err,
        );
    }

    /// Test various error cases when deserializing a collection. Make sure
    /// we get a useful error message for each one
    #[rstest]
    #[case::unknown_node(
        // If we have no known fields to key on, we get a helpful error
        r"
        requests:
          r1:
            unknown: field
        ",
        "Error at :4:12: Requests must have a `method` and `url` field; \
        folders must have a `requests` field"
    )]
    #[case::recipe_missing_url(
        // If the method field is present, deserializer assumes it's a recipe
        // so we get a recipe error
        r"
        requests:
          r1:
            method: GET
        ",
        "Error at :4:12: Expected field `url` with one of string, boolean, number"
    )]
    #[case::query(
        r"
        requests:
          r1:
            method: GET
            url: http://localhost
            query: 3
        ",
        "Error at :6:19: Expected mapping, received `3`"
    )]
    #[case::headers(
        r"
        requests:
          r1:
            method: GET
            url: http://localhost
            headers: 3
        ",
        "Error at :6:21: Expected mapping, received `3`"
    )]
    fn test_deserialize_collection_error(
        #[case] yaml: &str,
        #[case] expected_error: &str,
    ) {
        assert_err(Collection::parse(yaml), expected_error);
    }

    /// Should detect various indicators that the collection is v3 collection
    /// and provide a helpful error message about migration
    #[rstest]
    #[case::chain_template(
        r#"
profiles:
    profile1:
        data:
            key: "{{chains.value}}"
"#
    )]
    #[case::chains_field("chains: {}")]
    #[case::merge_key(
        "
.profile_data: &profile_data {}
profiles:
    profile1:
        data:
            <<: *profile_data
"
    )]
    #[case::request_tag(
        "
requests:
    r1: !request
        method: GET
        url: http://localhost
"
    )]
    fn test_v3_detect(temp_dir: TempDir, #[case] input: &str) {
        let path = temp_dir.join("v3.yml");
        fs::write(&path, input).unwrap();
        assert_err!(
            Collection::load(&path),
            "This looks like a collection from Slumber v3. Migrate to v4 or \
            downgrade your installation to 3.x"
        );
    }

    /// A catch-all regression test, to make sure we don't break anything in the
    /// collection format. This lives at the bottom because it's huge.
    #[rstest]
    fn test_regression(test_data_dir: PathBuf) {
        let loaded =
            Collection::load(&test_data_dir.join("regression.yml")).unwrap();
        let expected = Collection {
            name: Some("Regression Test".to_owned()),
            profiles: by_id([
                Profile {
                    id: "profile1".into(),
                    name: Some("Profile 1".into()),
                    default: false,
                    data: indexmap! {
                        "host".into() => "https://httpbin.org".into(),
                        "user_guid".into() => "abc123".into(),
                        "username".into() =>
                            "xX{{ command(['whoami']) | trim() }}Xx".into(),
                        "null".into() => ValueTemplate::Null,
                        "bool".into() => true.into(),
                        "int".into() => 4.into(),
                        "float".into() => 123.45.into(),
                        "array".into() => ValueTemplate::Array(
                            vec![1.into(), 2.into(), "test".into()]
                        ),
                        "object".into() => ValueTemplate::Object(vec![
                            ("a".into(), 1.into()),
                            ("b".into(), vec![1, 2, 7].into()),
                        ]),
                    },
                    ..Profile::factory(())
                },
                Profile {
                    id: "profile2".into(),
                    name: Some("Profile 2".into()),
                    default: true,
                    data: indexmap! {
                        "host".into() => "https://httpbin.org".into(),
                    },
                    ..Profile::factory(())
                },
            ]),
            recipes: by_id([
                RecipeNode::Recipe(Recipe {
                    id: "text_body".into(),
                    method: HttpMethod::Post,
                    url: "{{ host }}/anything/login".into(),
                    body: Some(RecipeBody::Raw(
                        // This body is a string, NOT a JSON object. We use the
                        // json! macro just to construct the string easily
                        json!({
                            "username": "{{ username }}",
                            "password":
                                "{{ prompt('Password', sensitive=true) }}",
                        })
                        .to_string()
                        .parse()
                        .unwrap(),
                    )),
                    query: indexmap! {
                        "sudo".into() => "yes_please".into(),
                        "fast".into() => "no_thanks".into(),
                    },
                    headers: indexmap! {
                        "accept".into() => "application/json".into(),
                    },
                    ..Recipe::factory(())
                }),
                RecipeNode::Folder(Folder {
                    id: "users".into(),
                    location: SourceLocation::default(),
                    name: Some("Users".into()),
                    children: by_id([
                        RecipeNode::Recipe(Recipe {
                            id: "simple".into(),
                            name: Some("Simple".into()),
                            method: HttpMethod::Get,
                            url: "{{ host }}/anything/{{ user_guid }}".into(),
                            query: indexmap! {
                                "one".into() => "{{ field1 }}".into(),
                                "many".into() =>
                                    ["{{ field1 }}", "{{ field2 }}"].into(),
                            },
                            ..Recipe::factory(())
                        }),
                        RecipeNode::Recipe(Recipe {
                            id: "json_body".into(),
                            name: None,
                            method: HttpMethod::Put,
                            url: "{{ host }}/anything/{{ user_guid }}".into(),
                            body: Some(
                                RecipeBody::json(
                                    json!({
                                        "username": "new username",
                                        "{{ dynamic_key }}": "{{ dynamic_value }}",
                                    }),
                                )
                                .unwrap(),
                            ),
                            authentication: Some(Authentication::Bearer {
                                token: "{{ response('login') | jsonpath('$.token') }}"
                                    .into(),
                            }),
                            headers: indexmap! {
                                "accept".into() => "application/json".into(),
                            },
                            ..Recipe::factory(())
                        }),
                        RecipeNode::Recipe(Recipe {
                            id: "json_body_but_not".into(),
                            name: None,
                            method: HttpMethod::Put,
                            url: "{{ host }}/anything/{{ user_guid }}".into(),
                            body: Some(
                                RecipeBody::json(json!(
                                    r#"{"warning": "NOT an object"}"#
                                ))
                                .unwrap(),
                            ),
                            authentication: Some(Authentication::Basic {
                                username: "{{ username }}".into(),
                                password: Some("{{ password }}".into()),
                            }),
                            headers: indexmap! {
                                "accept".into() => "application/json".into(),
                            },
                            ..Recipe::factory(())
                        }),
                        RecipeNode::Recipe(Recipe {
                            id: "form_urlencoded_body".into(),
                            name: None,
                            method: HttpMethod::Put,
                            url: "{{ host }}/anything/{{ user_guid }}".into(),
                            body: Some(RecipeBody::FormUrlencoded(indexmap! {
                                "username".into() => "new username".into()
                            })),
                            headers: indexmap! {
                                "accept".into() => "application/json".into(),
                            },
                            ..Recipe::factory(())
                        }),
                    ]),
                }),
            ])
            .into(),
        };
        assert_eq!(loaded, expected, "Deserialization incorrect");

        // Now that we know deserailization works, let's test serialization.
        // We'll serialize then deserialize again and expect the same thing
        let serialized = serde_yaml::to_string(&loaded).unwrap();
        let loaded: Collection = Collection::parse(&serialized).unwrap();
        assert_eq!(
            loaded, expected,
            "Serialized & re-deserialization incorrect"
        );
    }
}