add some basic tests for the parser

2024-08-16 10:20:30 +03:00 · 2014-06-16 16:38:29 +02:00 · 2014-06-16 16:38:29 +02:00 · f70ec4a0be
commit f70ec4a0be
parent 22bec0911a
3 changed files with 138 additions and 0 deletions
--- a/taggy.cabal
+++ b/taggy.cabal
@ -54,3 +54,23 @@ benchmark taggytagsoup
                     criterion,
                     vector
  default-language:  Haskell2010
+
+test-suite spec
+  type:
+      exitcode-stdio-1.0
+  ghc-options:
+      -Wall -O -fno-warn-unused-do-bind
+  hs-source-dirs:
+      src, tests
+  main-is:
+      Spec.hs
+  build-depends:
+      base    == 4.*
+    , text
+    , hspec
+    , hspec-expectations
+    , vector
+    , attoparsec
+    , unordered-containers
+  default-language:
+      Haskell2010
--- a/tests/Spec.hs
+++ b/tests/Spec.hs
@ -0,0 +1 @@
+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
--- a/tests/Text/Taggy/ParserSpec.hs
+++ b/tests/Text/Taggy/ParserSpec.hs
@ -0,0 +1,117 @@
+{-# LANGUAGE OverloadedStrings #-}
+
+module Text.Taggy.ParserSpec where
+
+import Control.Monad
+import Data.Attoparsec.Text.Lazy
+import Data.Text.Lazy
+import Test.Hspec
+import Text.Taggy.Parser
+import Text.Taggy.Types
+
+main :: IO ()
+main = hspec spec
+
+spec :: Spec
+spec = do
+  describe "tagopen parser" $ do
+    it "successfully parses <b>" $
+      "<b>" ~> tagopen False
+        `shouldParse` TagOpen "b" [] False
+
+    it "successfully parses <a href=\"/home\">" $
+      "<a href=\"/home\">" ~> tagopen False
+        `shouldParse` TagOpen "a" [Attribute "href" "/home"] False
+
+    it "successfully parses <button data-foo=\"bar\">" $ 
+      "<a data-foo=\"bar\">" ~> tagopen False
+        `shouldParse` TagOpen "a" [Attribute "data-foo" "bar"] False
+
+    it "successfully (and forgivingly) parses <<br>" $
+      "<<br>" ~> tagopen False
+        `shouldParse` TagOpen "br" [] False
+
+    it "successfully detects self-closing tags: <br/>" $
+      "<br/>" ~> tagopen False
+        `shouldParse` TagOpen "br" [] True
+
+    it "successfully detects self-closing tags: <br />" $
+      "<br />" ~> tagopen False
+        `shouldParse` TagOpen "br" [] True
+
+    it "successfully detects self-closing tags: <br / >" $
+      "<br / >" ~> tagopen False
+        `shouldParse` TagOpen "br" [] True
+
+    it "can successfully convert entities in attribute values: <a title=\"&nbsp;Hello!\">" $
+      "<a title=\"&nbsp;Hello!\">" ~> tagopen True
+        `shouldParse` TagOpen "a" [Attribute "title" "\160Hello!"] False
+
+  describe "text parser" $ do
+    it "can successfully convert entities inside the content: foo &nbsp; hi &eacute; &me bar" $
+      "foo &nbsp; hi &eacute; &me bar" ~> tagtext True
+        `shouldParse` TagText "foo \160 hi \233 &me bar"
+
+  describe "comment parser" $ do
+    it "successfully parses <!-- foo -->" $
+      "<!-- foo -->" ~> tagcomment
+        `shouldParse` TagComment " foo "
+
+    it "successfully parses <!--foo-->" $ 
+      "<!--foo-->" ~> tagcomment
+        `shouldParse` TagComment "foo"
+
+  describe "script parser" $ do
+    it "successfully parses a script section" $ 
+      "<script type=\"text/javascript\">var x = 5;</script>" ~> tagscript False
+        `shouldParse` TagScript (TagOpen "script" [Attribute "type" "text/javascript"] False)
+                                "var x = 5;"
+                                (TagClose "script")
+
+    it "is not too dumb" $ 
+      "<script>var str = '</script';</script>" ~> tagscript False
+        `shouldParse` TagScript (TagOpen "script" [] False)
+                                "var str = '</script';"
+                                (TagClose "script")
+
+  describe "style parser" $ do
+    it "successfully parses a style section" $ 
+      "<style type=\"text/css\">div { color: blue; }</style>" ~> tagstyle False
+        `shouldParse` TagStyle (TagOpen "style" [Attribute "type" "text/css"] False)
+                               "div { color: blue; }"
+                               (TagClose "style")
+
+  describe "(global) html parser" $ do
+    it "successfull parses: <html><head><title>Hello</title></head><body><p>Hi there!</p><br /></body></html>" $
+      "<html><head><title>Hello</title></head><body><p>Hi there!</p><br /></body></html>" ~> htmlWith False
+        `shouldParse` [ TagOpen "html" [] False 
+                      , TagOpen "head" [] False 
+                      , TagOpen "title" [] False
+                      , TagText "Hello"
+                      , TagClose "title"
+                      , TagClose "head"
+                      , TagOpen "body" [] False
+                      , TagOpen "p" [] False
+                      , TagText "Hi there!"
+                      , TagClose "p"
+                      , TagOpen "br" [] True
+                      , TagClose "body"
+                      , TagClose "html"
+                      ]
+
+(~>) :: Text -> Parser a -> Either String a
+t ~> p = eitherResult $ parse p t
+
+shouldParse :: (Eq a, Show a) => Either String a -> a -> Expectation
+res `shouldParse` expectedVal =
+  either (expectationFailure . errmsg)
+         checkEquality
+         res
+
+  where errmsg err = "  expected: " ++ show expectedVal
+                  ++ "\n  but parse failed with error: " ++ err
+
+        checkEquality parsedVal =
+          when (parsedVal /= expectedVal) $
+            expectationFailure $ "  expected: " ++ show expectedVal
+                              ++ "\n  but got: " ++ show parsedVal