Use insta for snapshot testing

suaviloquence · Aug 4, 2024 · 302c382 · 302c382
1 parent f71627d
commit 302c382
Show file tree

Hide file tree

Showing 11 changed files with 114 additions and 8 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -21,3 +21,13 @@ url = "2.5"
 
 [workspace]
 members = [".", "filter-proc-macro"]
+
+[dev-dependencies]
+insta = { version = "1.39.0", features = ["json"] }
+
+# compile insta and similar in release mode to improve testing times
+[profile.dev.package.insta]
+opt-level = 3
+
+[profile.dev.package.similar]
+opt-level = 3
diff --git a/examples/inputs/recurser.html b/examples/inputs/recurser.html
@@ -0,0 +1,6 @@
+<!doctype html>
+<html>
+    <body>
+        <a href="https://example.com">Cool link!</a>
+    </body>
+</html>
diff --git a/examples/outputs/abc.json → examples/outputs/abc.snap b/examples/outputs/abc.json → examples/outputs/abc.snap
@@ -1,3 +1,7 @@
+---
+source: src/interpreter/mod.rs
+expression: result
+---
 {
   "header": {
     "link": {

diff --git a/examples/outputs/attr.json → examples/outputs/attr.snap b/examples/outputs/attr.json → examples/outputs/attr.snap
@@ -1,3 +1,7 @@
+---
+source: src/interpreter/mod.rs
+expression: result
+---
 {
   "link": [
     {

diff --git a/examples/outputs/qualifiers.json → examples/outputs/qualifiers.snap b/examples/outputs/qualifiers.json → examples/outputs/qualifiers.snap
@@ -1,3 +1,7 @@
+---
+source: src/interpreter/mod.rs
+expression: result
+---
 {
   "items": [
     {

diff --git a/examples/outputs/recurser.snap b/examples/outputs/recurser.snap
@@ -0,0 +1,10 @@
+---
+source: src/interpreter/mod.rs
+expression: result
+---
+{
+  "link": "https://example.com",
+  "new_page": {
+    "content": "Example Domain"
+  }
+}
diff --git a/examples/outputs/relative.json → examples/outputs/relative.snap b/examples/outputs/relative.json → examples/outputs/relative.snap
@@ -1,3 +1,7 @@
+---
+source: src/interpreter/mod.rs
+expression: result
+---
 {
   "href": "./relative2.html",
   "relative": "You found me!"

diff --git a/examples/scrps/recurser.scrp b/examples/scrps/recurser.scrp
@@ -0,0 +1,7 @@
+link: a {
+    href: $element | attrs() | take(key: "href");
+} | take(key: "href");
+
+new_page: <$link> h1 {
+    content: $text;
+};
diff --git a/filter-proc-macro/Cargo.toml b/filter-proc-macro/Cargo.toml
@@ -1,7 +1,11 @@
 [package]
-name = "filter-proc-macro"
+name = "scrapelect-filter-proc-macro"
 version = "0.2.0"
 edition = "2021"
+authors = ["Max Carr <[email protected]>"]
+license = "Apache-2.0 OR MIT"
+repository = "https://github.com/suaviloquence/scrapelect"
+description = "proc-macros for making scrapelect Filters"
 
 [lib]
 proc-macro = true

diff --git a/src/interpreter/mod.rs b/src/interpreter/mod.rs
@@ -346,9 +346,6 @@ mod tests {
     async fn integration_test(filename: &str) -> anyhow::Result<()> {
         let input = std::fs::read_to_string(format!("examples/inputs/{filename}.html"))?;
         let script = std::fs::read_to_string(format!("examples/scrps/{filename}.scrp"))?;
-        let output: serde_json::Value = serde_json::from_reader(std::fs::File::open(format!(
-            "examples/outputs/{filename}.json"
-        ))?)?;
 
         let (ast, head) = crate::frontend::Parser::new(&script)
             .parse()
@@ -369,9 +366,15 @@ mod tests {
                 .parse()
                 .expect("parse URL failed"),
             )
-            .await?;
-        let result = serde_json::to_value(result.0)?;
-        assert_eq!(output, result);
+            .await?.0;
+
+        let mut settings = insta::Settings::clone_current();
+        settings.set_snapshot_path("../../examples/outputs");
+        settings.set_prepend_module_to_snapshot(false);
+
+        settings.bind(|| {
+            insta::assert_json_snapshot!(filename, result);
+        });
 
         Ok(())
     }
@@ -454,5 +457,6 @@ mod tests {
         attr,
         qualifiers,
         relative,
+        recurser,
     }
 }