Consolidated some common functions in Tests.Helper.

test/Tests/Command.hs

@@ -1,10 +1,10 @@
 module Tests.Command (findPandoc, runTest, tests)
 where
 
+import Tests.Helpers
 import Test.Framework
 import Test.Framework.Providers.HUnit
 import Test.HUnit ( assertBool )
-import System.Environment.Executable (getExecutablePath)
 import System.FilePath ( (</>), takeDirectory, splitDirectories,
                          joinPath )
 import System.Process
@@ -14,47 +14,9 @@ import Text.Pandoc
 import Data.Algorithm.Diff
 import Prelude hiding ( readFile )
 import qualified Text.Pandoc.UTF8 as UTF8
-import Text.Printf
 import Data.List (isSuffixOf)
 import Text.Pandoc.Shared (trimr)
 
-data TestResult = TestPassed
-                | TestError ExitCode
-                | TestFailed String FilePath [Diff String]
-     deriving (Eq)
-
-instance Show TestResult where
-  show TestPassed     = "PASSED"
-  show (TestError ec) = "ERROR " ++ show ec
-  show (TestFailed cmd file d) = '\n' : dash ++
-                                 "\n--- " ++ file ++
-                                 "\n+++ " ++ cmd ++ "\n" ++ showDiff (1,1) d ++
-                                 dash
-    where dash = replicate 72 '-'
-
-showDiff :: (Int,Int) -> [Diff String] -> String
-showDiff _ []             = ""
-showDiff (l,r) (First ln : ds) =
-  printf "+%4d " l ++ ln ++ "\n" ++ showDiff (l+1,r) ds
-showDiff (l,r) (Second ln : ds) =
-  printf "-%4d " r ++ ln ++ "\n" ++ showDiff (l,r+1) ds
-showDiff (l,r) (Both _ _ : ds) =
-  showDiff (l+1,r+1) ds
-
--- | Find pandoc executable relative to test-pandoc
--- First, try in same directory (e.g. if both in ~/.cabal/bin)
--- Second, try ../pandoc (e.g. if in dist/XXX/build/test-pandoc)
-findPandoc :: IO FilePath
-findPandoc = do
-  testExePath <- getExecutablePath
-  let testExeDir = takeDirectory testExePath
-  found <- doesFileExist (testExeDir </> "pandoc")
-  return $ if found
-              then testExeDir </> "pandoc"
-              else case splitDirectories testExeDir of
-                         [] -> error "test-pandoc: empty testExeDir"
-                         xs -> joinPath (init xs) </> "pandoc" </> "pandoc"
-
 -- | Run a test with normalize function, return True if test passed.
 runTest :: String    -- ^ Title of test
         -> String    -- ^ Shell command

test/Tests/Helpers.hs

@@ -2,6 +2,9 @@
 -- Utility functions for the test suite.
 
 module Tests.Helpers ( test
+                     , TestResult(..)
+                     , showDiff
+                     , findPandoc
                      , (=?>)
                      , purely
                      , property
@@ -20,9 +23,14 @@ import Test.HUnit (assertBool)
 import Text.Pandoc.Shared (trimr)
 import Text.Pandoc.Options
 import Text.Pandoc.Writers.Native (writeNative)
+import Text.Printf
+import System.Environment.Executable (getExecutablePath)
 import qualified Test.QuickCheck.Property as QP
 import Data.Algorithm.Diff
 import qualified Data.Map as M
+import System.Exit
+import System.Directory
+import System.FilePath
 
 test :: (ToString a, ToString b, ToString c)
      => (a -> b)  -- ^ function to test
@@ -43,6 +51,44 @@ test fn name (input, expected) =
            dashes "" = replicate 72 '-'
            dashes x  = replicate (72 - length x - 5) '-' ++ " " ++ x ++ " ---"
 
+data TestResult = TestPassed
+                | TestError ExitCode
+                | TestFailed String FilePath [Diff String]
+     deriving (Eq)
+
+instance Show TestResult where
+  show TestPassed     = "PASSED"
+  show (TestError ec) = "ERROR " ++ show ec
+  show (TestFailed cmd file d) = '\n' : dash ++
+                                 "\n--- " ++ file ++
+                                 "\n+++ " ++ cmd ++ "\n" ++ showDiff (1,1) d ++
+                                 dash
+    where dash = replicate 72 '-'
+
+showDiff :: (Int,Int) -> [Diff String] -> String
+showDiff _ []             = ""
+showDiff (l,r) (First ln : ds) =
+  printf "+%4d " l ++ ln ++ "\n" ++ showDiff (l+1,r) ds
+showDiff (l,r) (Second ln : ds) =
+  printf "-%4d " r ++ ln ++ "\n" ++ showDiff (l,r+1) ds
+showDiff (l,r) (Both _ _ : ds) =
+  showDiff (l+1,r+1) ds
+
+-- | Find pandoc executable relative to test-pandoc
+-- First, try in same directory (e.g. if both in ~/.cabal/bin)
+-- Second, try ../pandoc (e.g. if in dist/XXX/build/test-pandoc)
+findPandoc :: IO FilePath
+findPandoc = do
+  testExePath <- getExecutablePath
+  let testExeDir = takeDirectory testExePath
+  found <- doesFileExist (testExeDir </> "pandoc")
+  return $ if found
+              then testExeDir </> "pandoc"
+              else case splitDirectories testExeDir of
+                         [] -> error "test-pandoc: empty testExeDir"
+                         xs -> joinPath (init xs) </> "pandoc" </> "pandoc"
+
+
 vividize :: Diff String -> String
 vividize (Both s _) = "  " ++ s
 vividize (First s)  = "- " ++ s

test/Tests/Old.hs

@@ -1,46 +1,17 @@
 module Tests.Old (tests) where
 
+import Tests.Helpers hiding (test)
 import Test.Framework (testGroup, Test )
 import Test.Framework.Providers.HUnit
 import Test.HUnit ( assertBool )
-import System.Environment.Executable (getExecutablePath)
 import System.IO ( openTempFile, stderr )
 import System.Process ( runProcess, waitForProcess )
-import System.FilePath ( (</>), (<.>), takeDirectory, splitDirectories,
-                         joinPath )
+import System.FilePath ( (</>), (<.>), splitDirectories, joinPath )
 import System.Directory
 import System.Exit
 import Data.Algorithm.Diff
 import Prelude hiding ( readFile )
-import qualified Data.ByteString.Lazy as B
-import Text.Pandoc.UTF8 (toStringLazy)
-import Text.Printf
-
-readFileUTF8 :: FilePath -> IO String
-readFileUTF8 f = B.readFile f >>= return . toStringLazy
-
-data TestResult = TestPassed
-                | TestError ExitCode
-                | TestFailed String FilePath [Diff String]
-     deriving (Eq)
-
-instance Show TestResult where
-  show TestPassed     = "PASSED"
-  show (TestError ec) = "ERROR " ++ show ec
-  show (TestFailed cmd file d) = '\n' : dash ++
-                                 "\n--- " ++ file ++
-                                 "\n+++ " ++ cmd ++ "\n" ++ showDiff (1,1) d ++
-                                 dash
-    where dash = replicate 72 '-'
-
-showDiff :: (Int,Int) -> [Diff String] -> String
-showDiff _ []             = ""
-showDiff (l,r) (First ln : ds) =
-  printf "+%4d " l ++ ln ++ "\n" ++ showDiff (l+1,r) ds
-showDiff (l,r) (Second ln : ds) =
-  printf "-%4d " r ++ ln ++ "\n" ++ showDiff (l,r+1) ds
-showDiff (l,r) (Both _ _ : ds) =
-  showDiff (l+1,r+1) ds
+import qualified Text.Pandoc.UTF8 as UTF8
 
 tests :: [Test]
 tests = [ testGroup "markdown"
@@ -175,7 +146,7 @@ tests = [ testGroup "markdown"
 
 -- makes sure file is fully closed after reading
 readFile' :: FilePath -> IO String
-readFile' f = do s <- readFileUTF8 f
+readFile' f = do s <- UTF8.readFile f
                  return $! (length s `seq` s)
 
 lhsWriterTests :: String -> [Test]
@@ -242,15 +213,7 @@ testWithNormalize normalizer testname opts inp norm = testCase testname $ do
   -- find pandoc executable relative to test-pandoc
   -- First, try in same directory (e.g. if both in ~/.cabal/bin)
   -- Second, try ../pandoc (e.g. if in dist/XXX/build/test-pandoc)
-  pandocPath <- do
-    testExePath <- getExecutablePath
-    let testExeDir = takeDirectory testExePath
-    found <- doesFileExist (testExeDir </> "pandoc")
-    return $ if found
-                then testExeDir </> "pandoc"
-                else case splitDirectories testExeDir of
-                           [] -> error "test-pandoc: empty testExeDir"
-                           xs -> joinPath (init xs) </> "pandoc" </> "pandoc"
+  pandocPath <- findPandoc
   (outputPath, hOut) <- openTempFile "" "pandoc-test"
   let inpPath = inp
   let normPath = norm