Revert "Remove --actual"

This reverts commit 531c67f.

Author: schoettl

src/Print.hs

@@ -4,40 +4,61 @@ where
 import Import
 import Types
 
--- | Print a shell test. See CLI documentation for details.
+-- TODO Print output depending on --print=FORMAT (currently only v3)
+-- | Print a shell test considering the @--actual=mode@ option. See CLI
+-- documentation for details on.
 printShellTest
   :: String               -- ^ Shelltest format. Value of option @--print[=FORMAT]@.
+  -> Maybe String         -- ^ Value of option @--actual[=MODE]@. @Nothing@ if option is not given.
   -> ShellTest            -- ^ Test to print
+  -> Either String String -- ^ Non-matching or matching exit status
+  -> Either String String -- ^ Non-matching or matching exit status
+  -> Either Int Int       -- ^ Non-matching or matching exit status
   -> IO ()
-printShellTest format ShellTest{command=c,stdin=i,comments=comments,trailingComments=trailingComments,
+printShellTest format actualMode ShellTest{command=c,stdin=i,comments=comments,trailingComments=trailingComments,
                stdoutExpected=o_expected,stderrExpected=e_expected,exitCodeExpected=x_expected}
-               = do
+               o_actual e_actual x_actual = do
+          (o,e,x) <- computeResults actualMode
           case format of
             "v1" -> do
               printComments comments
               printCommand "" c
               printStdin "<<<" i
-              printStdouterr ">>>" o_expected
-              printStdouterr ">>>2" e_expected
-              printExitStatus True ">>>=" x_expected
+              printStdouterr ">>>" $ justMatcherOutErr o
+              printStdouterr ">>>2" $ justMatcherOutErr e
+              printExitStatus True ">>>=" x
               printComments trailingComments
             "v2" -> do
               printComments comments
-              printCommand "$$$ " c
+              printCommand "$ " c
               printStdin "<<<" i
-              printStdouterr ">>>" o_expected
-              printStdouterr ">>>2" e_expected
-              printExitStatus False ">>>=" x_expected
+              printStdouterr ">>>" o
+              printStdouterr ">>>2" e
+              printExitStatus False ">>>=" x
               printComments trailingComments
             "v3" -> do
               printComments comments
               printCommand "$ "  c
               printStdin "<" i
-              printStdouterr ">" o_expected
-              printStdouterr ">2" e_expected
-              printExitStatus False ">=" x_expected
+              printStdouterr ">" o
+              printStdouterr ">2" e
+              printExitStatus False ">=" x
               printComments trailingComments
             _ -> fail $ "Unsupported --print format: " ++ format
+  where
+    computeResults :: Maybe String -> IO (Maybe Matcher, Maybe Matcher, Matcher)
+    computeResults Nothing = do
+          return (o_expected, e_expected, x_expected)
+    computeResults (Just mode)
+     | mode `isPrefixOf` "all" = return
+         (Just $ Lines 0 $ fromEither o_actual -- TODO what about 0? how is it in parser?
+         ,Just $ Lines 0 $ fromEither e_actual
+         ,Numeric $ show $ fromEither x_actual)
+     | mode `isPrefixOf` "update" = return
+         (either (Just . Lines 0) (const o_expected) o_actual
+         ,either (Just . Lines 0) (const e_expected) e_actual
+         ,either (Numeric . show) (const x_expected) x_actual)
+     | otherwise = fail "Unsupported argument for --actual option. Allowed: all, update, or a prefix thereof."
 
 printComments :: [String] -> IO ()
 printComments = mapM_ putStrLn
@@ -56,7 +77,7 @@ printStdouterr _ Nothing                    = return ()
 printStdouterr _ (Just (Lines _ ""))        = return ()
 printStdouterr _ (Just (Numeric _))         = fail "FATAL: Cannot handle Matcher (Numeric) for stdout/stderr."
 printStdouterr _ (Just (NegativeNumeric _)) = fail "FATAL: Cannot handle Matcher (NegativeNumeric) for stdout/stderr."
-printStdouterr prefix (Just (Lines _ s))    = printf "%s\n%s" prefix s
+printStdouterr prefix (Just (Lines _ s))    = printf "%s\n%s\n" prefix s -- TODO trailing \n ?
 printStdouterr prefix (Just regex)          = printf "%s %s\n" prefix (show regex)
 
 -- | Print exit status. First arg says 'alwaysPrintEvenIfZero'.
@@ -65,3 +86,14 @@ printExitStatus _ _ (Lines _ _) = fail "FATAL: Cannot handle Matcher (Lines) for
 printExitStatus False _     (Numeric "0") = return ()
 printExitStatus True prefix (Numeric "0") = printf "%s 0\n" prefix
 printExitStatus _ prefix s = printf "%s %s\n" prefix (show s)
+
+mkEither :: Bool -> a -> Either a a
+mkEither True = Right
+mkEither False = Left
+
+fromEither :: Either a a -> a
+fromEither = either id id
+
+-- | Make a Matcher out of Nothing.
+justMatcherOutErr :: Maybe Matcher -> Maybe Matcher
+justMatcherOutErr = Just . fromMaybe (Lines 0 "")

src/shelltest.hs

@@ -68,6 +68,7 @@ data Args = Args {
     ,debug_parse :: Bool
     ,testpaths   :: [FilePath]
     ,print_      :: Maybe String
+    ,actual      :: Maybe String
     } deriving (Show, Data, Typeable)
 
 argdefs = Args {
@@ -91,6 +92,7 @@ argdefs = Args {
     ,debug_parse = def     &= help "Show test file parsing results and stop"
     ,testpaths   = def     &= args &= typ "TESTFILES|TESTDIRS"
     ,print_      = def     &= typ "FORMAT" &= opt "v3" &= groupname "Print test file" &= help "Print test files in specified format (default: v3)."
+    ,actual      = def     &= typ "MODE"   &= opt "all" &= help "Combined with --print, print test files with actual results (stdout, stderr, exit status). This can be used to generate or update tests. Mode 'all' prints all actual results (default). Mode 'update' prints actual results only for non-matching results, i.e. regular expressions in tests are retained."
     }
     &= helpArg [explicit, name "help", name "h"]
     &= program progname
@@ -153,6 +155,8 @@ checkArgs :: Args -> IO Args
 checkArgs args = do
   when (null $ testpaths args) $
        warn $ printf "Please specify at least one test file or directory, eg: %s tests" progname
+  when (isJust (actual args) && not (isJust (print_ args))) $
+       warn "Option --actual can only be used with --print."
   return args
 
 -- running tests
@@ -184,7 +188,7 @@ prepareShellTest args st@ShellTest{testname=n,command=c,stdin=i,stdoutExpected=o
   let errorMatch = maybe True (e_actual `matches`) e_expected
   let exitCodeMatch = show x_actual `matches` x_expected
   case print_ args of
-    Just format -> printShellTest format st
+    Just format -> printShellTest format (actual args) st (mkEither outputMatch o_actual) (mkEither errorMatch e_actual) (mkEither exitCodeMatch x_actual)
     Nothing -> if (x_actual == 127) -- catch bad executable - should work on posix systems at least
            then ioError $ userError $ unwords $ filter (not . null) [e_actual, printf "Command: '%s' Exit code: %i" cmd x_actual] -- XXX still a test failure; should be an error
            else assertString $ concat $ filter (not . null) [