Add tests for TSN.XML.GameInfo.

[dead/htsn-import.git] / src / TSN / XML / GameInfo.hs

diff --git a/src/TSN/XML/GameInfo.hs b/src/TSN/XML/GameInfo.hs
index e9c1899a71d044d96907423d1c42fa2d03d2db69..f5b64e3cd4b0cd510f27f605d914953329a26b25 100644 (file)
--- a/src/TSN/XML/GameInfo.hs
+++ b/src/TSN/XML/GameInfo.hs
@@ -13,23 +13,36 @@
 --
 module TSN.XML.GameInfo (
   dtds,
+  gameinfo_tests,
   parse_xml,
   -- * WARNING: these are private but exported to silence warnings
   GameInfoConstructor(..) )
 where
 
 -- System imports.
+import Data.Either ( rights )
 import Data.Time.Clock ( UTCTime )
-import Database.Groundhog ( migrate )
+import Database.Groundhog (
+  countAll,
+  migrate,
+  runMigration,
+  silentMigrationLogger )
+import Database.Groundhog.Generic ( runDbConn )
+import Database.Groundhog.Sqlite ( withSqliteConn )
 import Database.Groundhog.TH (
   groundhog,
   mkPersist )
+import Test.Tasty ( TestTree, testGroup )
+import Test.Tasty.HUnit ( (@?=), testCase )
 import Text.XML.HXT.Core ( XmlTree )
 import Text.XML.HXT.DOM.ShowXml ( xshow )
 
 -- Local imports.
 import TSN.Codegen ( tsn_codegen_config )
-import TSN.DbImport ( DbImport(..), ImportResult(..), run_dbmigrate )
+import TSN.DbImport (
+  DbImport(..),
+  ImportResult(..),
+  run_dbmigrate )
 import TSN.Parse (
   parse_message,
   parse_xmlfid,
@@ -37,7 +50,9 @@ import TSN.Parse (
 import TSN.XmlImport ( XmlImport(..) )
 import Xml (
   FromXml(..),
-  ToDb(..) )
+  ToDb(..),
+  unsafe_read_document )
+
 
 -- | The DTDs for everything that we consider "Game Info."
 --
@@ -137,6 +152,10 @@ instance DbImport Message where
     insert_xml_ msg
     return ImportSucceeded
 
+
+-- | The database schema for GameInfo is trivial; all we need is for
+--   the XML_File_ID to be unique.
+--
 mkPersist tsn_codegen_config [groundhog|
 - entity: GameInfo
   constructors:
@@ -147,3 +166,70 @@ mkPersist tsn_codegen_config [groundhog|
           # Prevent multiple imports of the same message.
           fields: [db_xml_file_id]
 |]
+
+
+--
+-- Tasty Tests
+--
+
+-- | A list of all tests for this module.
+--
+gameinfo_tests :: TestTree
+gameinfo_tests =
+  testGroup
+    "GameInfo tests"
+    [ test_parse_xml_succeeds,
+      test_dbimport_succeeds ]
+
+
+-- | Sample XML documents for GameInfo types.
+--
+gameinfo_test_files :: [FilePath]
+gameinfo_test_files =
+  [ "test/xml/gameinfo/MLB_Gaming_Matchup_XML.xml",
+    "test/xml/gameinfo/MLB_Lineup_XML.xml",
+    "test/xml/gameinfo/MLB_Matchup_XML.xml",
+    "test/xml/gameinfo/mlbpreviewxml.xml",
+    "test/xml/gameinfo/MLS_Preview_XML.xml",
+    "test/xml/gameinfo/NBA_Gaming_Matchup_XML.xml",
+    "test/xml/gameinfo/NBALineupXML.xml",
+    "test/xml/gameinfo/NBA_Playoff_Matchup_XML.xml",
+    "test/xml/gameinfo/nbapreviewxml.xml",
+    "test/xml/gameinfo/nhlpreviewxml.xml",
+    "test/xml/gameinfo/recapxml.xml" ]
+
+
+-- | Make sure we can parse every element of 'gameinfo_test_files'.
+--
+test_parse_xml_succeeds :: TestTree
+test_parse_xml_succeeds =
+  testGroup "parse_xml" $ map check gameinfo_test_files
+  where
+    check t = testCase t $ do
+      x <- unsafe_read_document t
+      let result = parse_xml "dummy" x
+      let actual = case result of -- isRight appears in base-4.7
+                     Left _  -> False
+                     Right _ -> True
+      let expected = True
+      actual @?= expected
+
+
+-- | Ensure that each element of 'gameinfo_test_files' can be imported
+--   by counting the total number of database records (after
+--   importing) and comparing it against the length of
+--   'gameinfo_test_files'.
+--
+test_dbimport_succeeds :: TestTree
+test_dbimport_succeeds = testCase "dbimport succeeds" $ do
+  xmltrees <- mapM unsafe_read_document gameinfo_test_files
+  let msgs = rights $ map (parse_xml "dummy") xmltrees
+  actual <- withSqliteConn ":memory:" $ runDbConn $ do
+                runMigration silentMigrationLogger $ do
+                  migrate (undefined :: GameInfo)
+                mapM_ dbimport msgs
+                countAll (undefined :: GameInfo)
+
+  actual @?= expected
+  where
+    expected = length gameinfo_test_files