Update unit tests

Author: brandonchinn178

kdl-hs.cabal

@@ -15,6 +15,8 @@ build-type: Simple
 extra-source-files:
   README.md
   CHANGELOG.md
+  test/KDL/__snapshots__/DecoderSpec.snap.md
+  test/KDL/__snapshots__/ParserSpec.snap.md
 
 source-repository head
   type: git
@@ -75,13 +77,15 @@ test-suite kdl-tests
     KDL.Decoder.ArrowSpec
     KDL.Decoder.MonadSpec
     KDL.ParserSpec
+    KDL.TestUtils.AST
     KDL.TestUtils.Error
   build-depends:
       base
     , containers
     , directory
     , filepath
     , kdl-hs
+    , pretty-show
     , process
     , scientific
     , skeletest

test/KDL/Decoder/ArrowSpec.hs

@@ -13,6 +13,7 @@ import Data.Text (Text)
 import Data.Text qualified as Text
 import Data.Typeable (typeRep)
 import KDL.Arrow qualified as KDL
+import KDL.TestUtils.AST (scrubFormat)
 import KDL.TestUtils.Error (decodeErrorMsg)
 import KDL.Types (
   Entry (..),
@@ -38,7 +39,7 @@ apiSpec = do
       it "decodes a node" $ do
         let config = "foo 1.0"
             decoder = KDL.document $ proc () -> do
-              KDL.node "foo" -< ()
+              scrubFormat <$> KDL.node "foo" -< ()
             expected =
               Node
                 { ann = Nothing
@@ -50,48 +51,48 @@ apiSpec = do
                         , format = Nothing
                         }
                     ]
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
         KDL.decodeWith decoder config `shouldBe` Right expected
 
       it "decodes multiple nodes" $ do
         let config = "foo; foo"
             decoder = KDL.document $ proc () -> do
-              KDL.many $ KDL.node "foo" -< ()
+              fmap (map scrubFormat) . KDL.many $ KDL.node "foo" -< ()
             expected = [fooNode, fooNode]
             fooNode =
               Node
                 { ann = Nothing
                 , name = Identifier{value = "foo", format = Nothing}
                 , entries = []
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
         KDL.decodeWith decoder config `shouldBe` Right expected
 
       it "decodes nodes in any order" $ do
         let config = "foo; bar"
             decoder = KDL.document $ proc () -> do
-              bar <- KDL.node "bar" -< ()
-              foo <- KDL.node "foo" -< ()
+              bar <- scrubFormat <$> KDL.node "bar" -< ()
+              foo <- scrubFormat <$> KDL.node "foo" -< ()
               returnA -< (bar, foo)
             expected = (node "bar", node "foo")
             node name =
               Node
                 { ann = Nothing
                 , name = Identifier{value = name, format = Nothing}
                 , entries = []
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
         KDL.decodeWith decoder config `shouldBe` Right expected
 
       it "fails when not enough nodes" $ do
         let config = "foo"
             decoder = KDL.document $ proc () -> do
-              foo1 <- KDL.node @Node "foo" -< ()
-              foo2 <- KDL.node @Node "foo" -< ()
+              foo1 <- scrubFormat <$> KDL.node @Node "foo" -< ()
+              foo2 <- scrubFormat <$> KDL.node @Node "foo" -< ()
               returnA -< (foo1, foo2)
         KDL.decodeWith decoder config
           `shouldSatisfy` decodeErrorMsg
@@ -102,7 +103,7 @@ apiSpec = do
     -- Most behaviors tested with `node`
     describe "nodeWith" $ do
       it "decodes a node" $ do
-        let config = "foo 1.0 { hello \"world\"; }"
+        let config = "foo 1.0 { hello world; }"
             decodeFoo = proc () -> do
               arg <- KDL.arg @Int -< ()
               child <- KDL.children $ KDL.argAt @Text "hello" -< ()
@@ -164,7 +165,7 @@ apiSpec = do
         let config = "foo 1.0; foo 2.0; bar"
             decoder = KDL.document $ proc () -> do
               _ <- KDL.node @Node "foo" -< ()
-              KDL.remainingNodes -< ()
+              fmap (map scrubFormat) <$> KDL.remainingNodes -< ()
             expected =
               Map.fromList
                 [ ("foo", [fooNode2])
@@ -181,15 +182,15 @@ apiSpec = do
                         , format = Nothing
                         }
                     ]
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
             barNode =
               Node
                 { ann = Nothing
                 , name = Identifier{value = "bar", format = Nothing}
                 , entries = []
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
         KDL.decodeWith decoder config `shouldBe` Right expected
@@ -211,7 +212,7 @@ apiSpec = do
         KDL.decodeWith decoder config `shouldBe` Right expected
 
       it "fails when node fails to parse" $ do
-        let config = "foo 1; bar 1; bar \"hello\""
+        let config = "foo 1; bar 1; bar hello"
             decodeNode = proc () -> do
               KDL.arg @Int -< ()
             decoder = KDL.document $ proc () -> do
@@ -262,7 +263,7 @@ apiSpec = do
 
     describe "argAt" $ do
       it "gets argument at a node" $ do
-        let config = "foo \"bar\"; hello \"world\""
+        let config = "foo bar; hello world"
             decoder = KDL.document $ proc () -> do
               hello <- KDL.argAt @Text "hello" -< ()
               foo <- KDL.argAt @Text "foo" -< ()
@@ -363,7 +364,7 @@ apiSpec = do
         KDL.decodeWith decoder config `shouldBe` Right []
 
       it "fails if any arg fails to parse" $ do
-        let config = "foo 1 \"asdf\""
+        let config = "foo 1 asdf"
             decoder = KDL.document $ proc () -> do
               KDL.argsAt @Int "foo" -< ()
         KDL.decodeWith decoder config
@@ -456,7 +457,7 @@ apiSpec = do
             ]
 
       it "fails if any child fails to parse" $ do
-        let config = "foo { - 1; - \"asdf\"; }"
+        let config = "foo { - 1; - asdf; }"
             decoder = KDL.document $ proc () -> do
               KDL.dashChildrenAt @Int "foo" -< ()
         KDL.decodeWith decoder config
@@ -513,14 +514,17 @@ apiSpec = do
       it "gets dash nodes at a node" $ do
         let config = "foo { - { bar; }; - { baz; }; }"
             decoder = KDL.document $ proc () -> do
-              KDL.dashNodesAt "foo" -< ()
+              map scrubFormat <$> KDL.dashNodesAt "foo" -< ()
             expected = [node "-" [node "bar" []], node "-" [node "baz" []]]
             node name children =
               Node
                 { ann = Nothing
                 , name = Identifier{value = name, format = Nothing}
                 , entries = []
-                , children = Just NodeList{nodes = children, format = Nothing}
+                , children =
+                    if null children
+                      then Nothing
+                      else Just NodeList{nodes = children, format = Nothing}
                 , format = Nothing
                 }
         KDL.decodeWith decoder config `shouldBe` Right expected
@@ -550,7 +554,7 @@ apiSpec = do
     -- Most behaviors tested with `dashNodesAt`
     describe "dashNodesAtWith" $ do
       it "gets dash nodes at a node" $ do
-        let config = "foo { - 1 { bar \"hello\"; }; - 2 { bar \"world\"; }; }"
+        let config = "foo { - 1 { bar hello; }; - 2 { bar world; }; }"
             decodeChild = proc () -> do
               arg <- KDL.arg @Int -< ()
               child <- KDL.children $ KDL.nodeWith "bar" $ KDL.arg @Text -< ()
@@ -560,7 +564,7 @@ apiSpec = do
         KDL.decodeWith decoder config `shouldBe` Right [(1, "hello"), (2, "world")]
 
       it "fails if any child fails to parse" $ do
-        let config = "foo { - { bar 1; }; - { bar \"test\"; }; }"
+        let config = "foo { - { bar 1; }; - { bar test; }; }"
             decoder = KDL.document $ proc () -> do
               KDL.dashNodesAtWith "foo" $ KDL.children $ KDL.argAt @Int "bar" -< ()
         KDL.decodeWith decoder config
@@ -579,7 +583,7 @@ apiSpec = do
 
     describe "arg" $ do
       it "decodes an argument" $ do
-        let config = "foo 1 \"bar\""
+        let config = "foo 1 bar"
             decoder = proc () -> do
               arg1 <- KDL.arg @Int -< ()
               arg2 <- KDL.arg @Text -< ()
@@ -603,7 +607,7 @@ apiSpec = do
             ]
 
       it "fails if argument fails to parse" $ do
-        let config = "foo \"test\""
+        let config = "foo test"
             decoder = proc () -> do
               KDL.arg @Int -< ()
         decodeNode "foo" decoder config
@@ -625,7 +629,7 @@ apiSpec = do
     -- Most behaviors tested with `arg`
     describe "argWith" $ do
       it "decodes an argument" $ do
-        let config = "foo \"bar\""
+        let config = "foo bar"
             decoder = proc () -> do
               KDL.argWith KDL.text -< ()
         decodeNode "foo" decoder config `shouldBe` Right "bar"
@@ -668,7 +672,7 @@ apiSpec = do
 
     describe "prop" $ do
       it "decodes a prop" $ do
-        let config = "foo test1=1 test2=\"hello\""
+        let config = "foo test1=1 test2=hello"
             decoder = proc () -> do
               prop1 <- KDL.prop @Text "test2" -< ()
               prop2 <- KDL.prop @Int "test1" -< ()
@@ -842,7 +846,7 @@ apiSpec = do
       it "decodes children" $ do
         let config = "foo { bar test; }"
             decoder = proc () -> do
-              KDL.children $ KDL.node @Node "bar" -< ()
+              fmap scrubFormat . KDL.children $ KDL.node @Node "bar" -< ()
             expected =
               Node
                 { ann = Nothing
@@ -854,7 +858,7 @@ apiSpec = do
                         , format = Nothing
                         }
                     ]
-                , children = Just NodeList{nodes = [], format = Nothing}
+                , children = Nothing
                 , format = Nothing
                 }
         decodeNode "foo" decoder config `shouldBe` Right expected
@@ -882,7 +886,7 @@ apiSpec = do
       it "decodes any value" $ do
         let config = "foo 1.0 asdf #true"
             decoder = KDL.document $ proc () -> do
-              KDL.argsAtWith "foo" KDL.any -< ()
+              map scrubFormat <$> KDL.argsAtWith "foo" KDL.any -< ()
             val data_ =
               Value
                 { ann = Nothing