Refactor TUI tests significantly

Add two new types, TestHarness and TestComponent, that make it much easier to test components. This should make TUI test code much simpler and more consistent, and it's much easier to right *correct* test code now.
LucasPickering · May 25, 2024 · fbfd576 · fbfd576
1 parent c578998
commit fbfd576
Show file tree

Hide file tree

Showing 30 changed files with 856 additions and 788 deletions.
diff --git a/src/collection.rs b/src/collection.rs
@@ -177,7 +177,7 @@ async fn load_collection(path: PathBuf) -> anyhow::Result<Collection> {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::{assert_err, temp_dir, TempDir};
     use rstest::rstest;
     use std::fs::File;
 

diff --git a/src/collection/insomnia.rs b/src/collection/insomnia.rs
@@ -461,7 +461,7 @@ where
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::{collection::CollectionFile, test_util::*};
+    use crate::{collection::CollectionFile, test_util::test_data_dir};
     use indexmap::indexmap;
     use pretty_assertions::assert_eq;
     use rstest::rstest;

diff --git a/src/collection/models.rs b/src/collection/models.rs
@@ -327,27 +327,92 @@ impl Collection {
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for Collection {
+    fn factory(_: ()) -> Self {
+        let recipe = Recipe::factory(());
+        let profile = Profile::factory(());
+        Collection {
+            recipes: indexmap::indexmap! {recipe.id.clone() => recipe}.into(),
+            profiles: indexmap::indexmap! {profile.id.clone() => profile},
+            ..Collection::default()
+        }
+    }
+}
+
+#[cfg(test)]
+impl crate::test_util::Factory for ProfileId {
+    fn factory(_: ()) -> Self {
+        uuid::Uuid::new_v4().to_string().into()
+    }
+}
+
+#[cfg(test)]
+impl crate::test_util::Factory for RecipeId {
+    fn factory(_: ()) -> Self {
+        uuid::Uuid::new_v4().to_string().into()
+    }
+}
+
 impl Profile {
     /// Get a presentable name for this profile
     pub fn name(&self) -> &str {
         self.name.as_deref().unwrap_or(&self.id)
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for Profile {
+    fn factory(_: ()) -> Self {
+        Self {
+            id: "profile1".into(),
+            name: None,
+            data: IndexMap::new(),
+        }
+    }
+}
+
 impl Folder {
     /// Get a presentable name for this folder
     pub fn name(&self) -> &str {
         self.name.as_deref().unwrap_or(&self.id)
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for Folder {
+    fn factory(_: ()) -> Self {
+        Self {
+            id: "folder1".into(),
+            name: None,
+            children: IndexMap::new(),
+        }
+    }
+}
+
 impl Recipe {
     /// Get a presentable name for this recipe
     pub fn name(&self) -> &str {
         self.name.as_deref().unwrap_or(&self.id)
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for Recipe {
+    fn factory(_: ()) -> Self {
+        Self {
+            id: "recipe1".into(),
+            name: None,
+            method: Method::Get,
+            url: "http://localhost/url".into(),
+            body: None,
+            authentication: None,
+            query: IndexMap::new(),
+            headers: IndexMap::new(),
+        }
+    }
+}
+
 /// For deserialization
 impl TryFrom<String> for Method {
     type Error = anyhow::Error;
@@ -369,3 +434,21 @@ impl From<Method> for String {
         method.to_string()
     }
 }
+
+#[cfg(test)]
+impl crate::test_util::Factory for Chain {
+    fn factory(_: ()) -> Self {
+        Self {
+            id: "chain1".into(),
+            source: ChainSource::Request {
+                recipe: "recipe1".into(),
+                trigger: Default::default(),
+                section: Default::default(),
+            },
+            sensitive: false,
+            selector: None,
+            content_type: None,
+            trim: ChainOutputTrim::default(),
+        }
+    }
+}
diff --git a/src/collection/recipe_tree.rs b/src/collection/recipe_tree.rs
@@ -230,7 +230,7 @@ impl From<&Vec<&RecipeId>> for RecipeLookupKey {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::{assert_err, Factory};
     use indexmap::indexmap;
     use itertools::Itertools;
     use rstest::{fixture, rstest};

diff --git a/src/db.rs b/src/db.rs
@@ -665,7 +665,7 @@ impl<'a, 'b> TryFrom<&'a Row<'b>> for RequestRecordSummary {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::Factory;
     use itertools::Itertools;
     use std::collections::HashMap;
 

diff --git a/src/http.rs b/src/http.rs
@@ -568,7 +568,7 @@ mod tests {
     use super::*;
     use crate::{
         collection::{Authentication, Collection, Profile},
-        test_util::*,
+        test_util::{header_map, Factory},
     };
     use indexmap::indexmap;
     use pretty_assertions::assert_eq;

diff --git a/src/http/content_type.rs b/src/http/content_type.rs
@@ -172,7 +172,7 @@ impl ContentType {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::{assert_err, Factory};
     use reqwest::header::{
         HeaderMap, HeaderValue, InvalidHeaderValue, CONTENT_TYPE,
     };

diff --git a/src/http/query.rs b/src/http/query.rs
@@ -75,7 +75,7 @@ impl Query {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::{http::Json, test_util::*};
+    use crate::{http::Json, test_util::assert_err};
     use rstest::rstest;
     use serde_json::json;
 

diff --git a/src/http/record.rs b/src/http/record.rs
@@ -157,6 +157,81 @@ impl Request {
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for Request {
+    fn factory(_: ()) -> Self {
+        Self {
+            id: RequestId::new(),
+            profile_id: None,
+            recipe_id: "recipe1".into(),
+            method: reqwest::Method::GET,
+            url: "http://localhost/url".parse().unwrap(),
+            headers: HeaderMap::new(),
+            body: None,
+        }
+    }
+}
+
+/// Customize profile and recipe ID
+#[cfg(test)]
+impl crate::test_util::Factory<(Option<ProfileId>, RecipeId)> for Request {
+    fn factory((profile_id, recipe_id): (Option<ProfileId>, RecipeId)) -> Self {
+        Self {
+            id: RequestId::new(),
+            profile_id,
+            recipe_id,
+            method: reqwest::Method::GET,
+            url: "http://localhost/url".parse().unwrap(),
+            headers: HeaderMap::new(),
+            body: None,
+        }
+    }
+}
+
+#[cfg(test)]
+impl crate::test_util::Factory for Response {
+    fn factory(_: ()) -> Self {
+        Self {
+            status: StatusCode::OK,
+            headers: HeaderMap::new(),
+            body: Body::default(),
+        }
+    }
+}
+
+#[cfg(test)]
+impl crate::test_util::Factory for RequestRecord {
+    fn factory(_: ()) -> Self {
+        let request = Request::factory(());
+        let response = Response::factory(());
+        Self {
+            id: request.id,
+            request: request.into(),
+            response: response.into(),
+            start_time: Utc::now(),
+            end_time: Utc::now(),
+        }
+    }
+}
+
+/// Customize profile and recipe ID
+#[cfg(test)]
+impl crate::test_util::Factory<(Option<ProfileId>, RecipeId)>
+    for RequestRecord
+{
+    fn factory(params: (Option<ProfileId>, RecipeId)) -> Self {
+        let request = Request::factory(params);
+        let response = Response::factory(());
+        Self {
+            id: request.id,
+            request: request.into(),
+            response: response.into(),
+            start_time: Utc::now(),
+            end_time: Utc::now(),
+        }
+    }
+}
+
 /// A resolved HTTP response, with all content loaded and ready to be displayed
 /// to the user. A simpler alternative to [reqwest::Response], because there's
 /// no way to access all resolved data on that type at once. Resolving the
@@ -395,7 +470,7 @@ impl PartialEq for RequestError {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::{header_map, Factory};
     use indexmap::indexmap;
     use rstest::rstest;
     use serde_json::json;

diff --git a/src/template.rs b/src/template.rs
@@ -175,6 +175,22 @@ impl<T> TemplateKey<T> {
     }
 }
 
+#[cfg(test)]
+impl crate::test_util::Factory for TemplateContext {
+    fn factory(_: ()) -> Self {
+        use crate::test_util::TestPrompter;
+        Self {
+            collection: Collection::default(),
+            selected_profile: None,
+            http_engine: None,
+            database: CollectionDatabase::factory(()),
+            overrides: IndexMap::new(),
+            prompter: Box::<TestPrompter>::default(),
+            recursion_count: 0.into(),
+        }
+    }
+}
+
 #[cfg(test)]
 mod tests {
     use super::*;
@@ -185,7 +201,9 @@ mod tests {
         },
         config::Config,
         http::{ContentType, Request, RequestRecord, Response},
-        test_util::*,
+        test_util::{
+            assert_err, header_map, temp_dir, Factory, TempDir, TestPrompter,
+        },
     };
     use chrono::Utc;
     use indexmap::indexmap;

diff --git a/src/template/parse.rs b/src/template/parse.rs
@@ -151,7 +151,7 @@ fn take_until_or_eof<'a>(
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::test_util::*;
+    use crate::test_util::assert_err;
     use itertools::Itertools;
     use rstest::rstest;