Merge remote-tracking branch 'mrhania/testing-framework-improvements' into ghc-head

5 files changed, 57 insertions, 267 deletions

diff --git a/html-test/Main.hs b/html-test/Main.hs
new file mode 100755
index 00000000..3880fc3c
--- /dev/null
+++ b/html-test/Main.hs
@@ -0,0 +1,51 @@
+{-# LANGUAGE CPP #-}
+
+
+import Data.Char
+
+import System.Environment
+import System.FilePath
+
+import Test.Haddock
+import Test.Haddock.Xhtml
+
+
+checkConfig :: CheckConfig Xml
+checkConfig = CheckConfig
+    { ccfgRead = \mdl input -> stripIfRequired mdl <$> parseXml input
+    , ccfgDump = dumpXml
+    , ccfgEqual = (==)
+    }
+
+
+dirConfig :: DirConfig
+dirConfig = (defaultDirConfig $ takeDirectory __FILE__)
+    { dcfgCheckIgnore = checkIgnore
+    }
+
+
+main :: IO ()
+main = do
+    cfg <- parseArgs checkConfig dirConfig =<< getArgs
+    runAndCheck $ cfg
+        { cfgHaddockArgs = cfgHaddockArgs cfg ++ ["--pretty-html", "--html"]
+        }
+
+
+stripIfRequired :: String -> Xml -> Xml
+stripIfRequired mdl =
+    stripLinks' . stripFooter
+  where
+    stripLinks'
+        | mdl `elem` preserveLinksModules = id
+        | otherwise = stripLinks
+
+
+-- | List of modules in which we don't 'stripLinks'
+preserveLinksModules :: [String]
+preserveLinksModules = ["Bug253"]
+
+
+checkIgnore :: FilePath -> Bool
+checkIgnore file@(c:_) | takeExtension file == ".html" && isUpper c = False
+checkIgnore _ = True
diff --git a/html-test/README.markdown b/html-test/README.markdown
deleted file mode 100644
index 717bac5c..00000000
--- a/html-test/README.markdown
+++ /dev/null
@@ -1,27 +0,0 @@
-This is a testsuite for Haddock that uses the concept of "golden files". That
-is, it compares output files against a set of reference files.
-
-To add a new test:
-
- 1. Create a module in the `html-test/src` directory.
-
- 2. Run `cabal test`. You should now have `html-test/out/<modulename>.html`.
-    The test passes since there is no reference file to compare with.
-
- 3. To make a reference file from the output file, run
-
-        html-test/accept.lhs <modulename>
-
-Tips and tricks:
-
-To "accept" all output files (copy them to reference files), run
-
-    runhaskell accept.lhs
-
-You can run all tests despite failing tests, like so
-
-    cabal test --test-option=all
-
-You can pass extra options to haddock like so
-
-    cabal test --test-options='all --title="All Tests"'
diff --git a/html-test/accept.lhs b/html-test/accept.lhs
deleted file mode 100755
index f6dfc4cd..00000000
--- a/html-test/accept.lhs
+++ /dev/null
@@ -1,49 +0,0 @@
-#!/usr/bin/env runhaskell
-\begin{code}
-{-# LANGUAGE CPP #-}
-import System.Cmd
-import System.Environment
-import System.FilePath
-import System.Directory
-import Data.List
-import Control.Applicative
-
-baseDir = takeDirectory __FILE__
-
-main :: IO ()
-main = do
-  contents <- filter (not . ignore) <$> getDirectoryContents (baseDir </> "out")
-  args <- getArgs
-  if not $ null args then
-    mapM_ copy [ baseDir </> "out" </> file | file <- contents, ".html" `isSuffixOf` file, takeBaseName file `elem` args  ]
-  else
-    mapM_ copy [ baseDir </> "out" </> file | file <- contents]
-  where
-    ignore =
-      foldr (liftA2 (||)) (const False) [
-        (== ".")
-      , (== "..")
-      , (isPrefixOf "index")
-      , (isPrefixOf "doc-index")
-      ]
-
-copy :: FilePath -> IO ()
-copy file = do
-  let new = baseDir </> "ref" </> takeFileName file
-  if ".html" `isSuffixOf` file then do
-    putStrLn (file ++ " -> " ++ new)
-    stripLinks <$> readFile file >>= writeFile new
-  else do
-    -- copy css, images, etc.
-    copyFile file new
-
-stripLinks :: String -> String
-stripLinks str =
-  let prefix = "<a href=\"" in
-  case stripPrefix prefix str of
-    Just str' -> prefix ++ stripLinks (dropWhile (/= '"') str')
-    Nothing ->
-      case str of
-        [] -> []
-        x : xs -> x : stripLinks xs
-\end{code}
diff --git a/html-test/run b/html-test/run
new file mode 100755
index 00000000..3e72be80
--- /dev/null
+++ b/html-test/run
@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+
+export HADDOCK_PATH=$(which haddock)
+LIB_PATH="$(dirname "$BASH_SOURCE")/../haddock-test/src/"
+MAIN_PATH="$(dirname "$BASH_SOURCE")/Main.hs"
+runhaskell -i:"$LIB_PATH" $MAIN_PATH $@
diff --git a/html-test/run.lhs b/html-test/run.lhs
deleted file mode 100755
index 1f19b723..00000000
--- a/html-test/run.lhs
+++ /dev/null
@@ -1,191 +0,0 @@
-#!/usr/bin/env runhaskell
-\begin{code}
-{-# LANGUAGE CPP #-}
-import Prelude hiding (mod)
-import Control.Monad
-import Control.Applicative
-import Data.List
-import Data.Maybe
-import Distribution.InstalledPackageInfo
-import Distribution.Package (PackageName (..))
-import Distribution.Simple.Compiler
-import Distribution.Simple.GHC
-import Distribution.Simple.PackageIndex
-import Distribution.Simple.Program
-import Distribution.Simple.Utils
-import Distribution.Verbosity
-import System.IO
-import System.Directory
-import System.Environment
-import System.Exit
-import System.FilePath
-import System.Process (ProcessHandle, runProcess, waitForProcess, system)
-
-packageRoot, dataDir, haddockPath, baseDir, testDir, outDir :: FilePath
-baseDir = takeDirectory __FILE__
-testDir       = baseDir </> "src"
-refDir        = baseDir </> "ref"
-outDir        = baseDir </> "out"
-packageRoot   = baseDir </> ".."
-dataDir       = packageRoot </> "resources"
-haddockPath   = packageRoot </> "dist" </> "build" </> "haddock" </> "haddock"
-
-
-main :: IO ()
-main = do
-  test
-  putStrLn "All tests passed!"
-
-
-test :: IO ()
-test = do
-  x <- doesFileExist haddockPath
-  unless x $ System.Exit.die "you need to run 'cabal build' successfully first"
-
-  contents <- getDirectoryContents testDir
-  args <- getArgs
-  let (opts, spec) = span ("-" `isPrefixOf`) args
-  let mods =
-        case spec of
-          y:_ | y /= "all" -> [y ++ ".hs"]
-          _ -> filter ((==) ".hs" . takeExtension) contents
-
-  let mods' = map (testDir </>) mods
-
-  -- add haddock_datadir to environment for subprocesses
-  env <- Just . (:) ("haddock_datadir", Main.dataDir) <$> getEnvironment
-
-  putStrLn ""
-  putStrLn "Haddock version: "
-  h1 <- runProcess haddockPath ["--version"] Nothing
-                   env Nothing Nothing Nothing
-  wait h1 "*** Running `haddock --version' failed!"
-  putStrLn ""
-  putStrLn "GHC version: "
-  h2 <- runProcess haddockPath ["--ghc-version"] Nothing
-                   env Nothing Nothing Nothing
-  wait h2 "*** Running `haddock --ghc-version' failed!"
-  putStrLn ""
-
-  -- TODO: maybe do something more clever here using haddock.cabal
-  ghcPath <- fmap init $ rawSystemStdout normal haddockPath ["--print-ghc-path"]
-  (_, _, conf) <- configure normal (Just ghcPath) Nothing defaultProgramConfiguration
-  pkgIndex <- getInstalledPackages normal [GlobalPackageDB] conf
-  let mkDep pkgName =
-        fromMaybe (error "Couldn't find test dependencies") $ do
-          let pkgs = lookupPackageName pkgIndex (PackageName pkgName)
-          (_, pkgs') <- listToMaybe pkgs
-          pkg <- listToMaybe pkgs'
-          ifacePath <- listToMaybe (haddockInterfaces pkg)
-          htmlPath <- listToMaybe (haddockHTMLs pkg)
-          return ("-i " ++ htmlPath ++ "," ++ ifacePath)
-
-  let base    = mkDep "base"
-      process = mkDep "process"
-      ghcprim = mkDep "ghc-prim"
-
-  putStrLn "Running tests..."
-  handle <- runProcess haddockPath
-                       (["-w", "-o", outDir, "-h", "--pretty-html"
-                        , "--optghc=-w", base, process, ghcprim] ++ opts ++ mods')
-                       Nothing env Nothing
-                       Nothing Nothing
-
-  wait handle "*** Haddock run failed! Exiting."
-  check mods (if not (null args) && args !! 0 == "all" then False else True)
-  where
-    wait :: ProcessHandle -> String -> IO ()
-    wait h msg = do
-      r <- waitForProcess h
-      unless (r == ExitSuccess) $ do
-        hPutStrLn stderr msg
-        exitFailure
-
-check :: [FilePath] -> Bool -> IO ()
-check modules strict = do
-  forM_ modules $ \mod -> do
-    let outfile = outDir </> dropExtension mod ++ ".html"
-    let reffile = refDir </> dropExtension mod ++ ".html"
-    b <- doesFileExist reffile
-    if b
-      then do
-        out <- readFile outfile
-        ref <- readFile reffile
-        if not $ haddockEq (outfile, out) (reffile, ref)
-          then do
-            putStrLn $ "Output for " ++ mod ++ " has changed! Exiting with diff:"
-            let ref' = maybeStripLinks outfile ref
-                out' = maybeStripLinks reffile out
-            let reffile' = outDir </> takeFileName reffile ++ ".nolinks"
-                outfile' = outDir </> takeFileName outfile ++ ".ref.nolinks"
-            writeFile reffile' ref'
-            writeFile outfile' out'
-            r <- programOnPath "colordiff"
-            code <- if r
-              then system $ "colordiff " ++ reffile' ++ " " ++ outfile'
-              else system $ "diff " ++ reffile' ++ " " ++ outfile'
-            if strict then exitFailure else return ()
-            unless (code == ExitSuccess) $ do
-              hPutStrLn stderr "*** Running diff failed!"
-              exitFailure
-          else do
-            putStrLn $ "Pass: " ++ mod
-      else do
-        putStrLn $ "Pass: " ++ mod ++ " (no .ref file)"
-
--- | List of modules in which we don't 'stripLinks'
-preserveLinksModules :: [String]
-preserveLinksModules = map (++ ".html") ["Bug253"]
-
--- | A rather nasty way to drop the Haddock version string from the
--- end of the generated HTML files so that we don't have to change
--- every single test every time we change versions. We rely on the the
--- last paragraph of the document to be the version. We end up with
--- malformed HTML but we don't care as we never look at it ourselves.
-dropVersion :: String -> String
-dropVersion = reverse . dropTillP . reverse
-  where
-    dropTillP [] = []
-    dropTillP ('p':'<':xs) = xs
-    dropTillP (_:xs) = dropTillP xs
-
-haddockEq :: (FilePath, String) -> (FilePath, String) -> Bool
-haddockEq (fn1, file1) (fn2, file2) =
-  maybeStripLinks fn1 (dropVersion file1)
-  == maybeStripLinks fn2 (dropVersion file2)
-
-maybeStripLinks :: String -- ^ Module we're considering for stripping
-                -> String -> String
-maybeStripLinks m = if any (`isSuffixOf` m) preserveLinksModules
-                    then id
-                    else stripLinks
-
-stripLinks :: String -> String
-stripLinks str =
-  let prefix = "<a href=\"" in
-  case stripPrefix prefix str of
-    Just str' -> case dropWhile (/= '>') (dropWhile (/= '"') str') of
-      [] -> []
-      x:xs -> stripLinks (stripHrefEnd xs)
-    Nothing ->
-      case str of
-        [] -> []
-        x : xs -> x : stripLinks xs
-
-stripHrefEnd :: String -> String
-stripHrefEnd s =
-  let pref = "</a" in
-  case stripPrefix pref s of
-    Just str' -> case dropWhile (/= '>') str' of
-      [] -> []
-      x:xs -> xs
-    Nothing ->
-      case s of
-        [] -> []
-        x : xs -> x : stripHrefEnd xs
-
-programOnPath :: FilePath -> IO Bool
-programOnPath p = do
-  result <- findProgramLocation silent p
-  return (isJust result)
-\end{code}