{-# OPTIONS_GHC -fno-warn-deprecations #-}
{-# LANGUAGE CPP #-}
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE ScopedTypeVariables #-}
module Test.Hspec.Core.Runner (
hspec
, hspecWith
, hspecResult
, hspecWithResult
, Summary (..)
, isSuccess
, evaluateSummary
, evalSpec
, runSpecForest
, evaluateResult
, Test.Hspec.Core.Runner.Result.SpecResult
, Test.Hspec.Core.Runner.Result.specResultItems
, Test.Hspec.Core.Runner.Result.specResultSuccess
, toSummary
, Test.Hspec.Core.Runner.Result.ResultItem
, Test.Hspec.Core.Runner.Result.resultItemPath
, Test.Hspec.Core.Runner.Result.resultItemStatus
, Test.Hspec.Core.Runner.Result.resultItemIsFailure
, Test.Hspec.Core.Runner.Result.ResultItemStatus(..)
, Config (..)
, ColorMode (..)
, UnicodeMode(..)
, Path
, defaultConfig
, registerFormatter
, registerDefaultFormatter
, configAddFilter
, readConfig
, runSpec
, Spec
, SpecWith
#ifdef TEST
, UseColor(..)
, ProgressReporting(..)
, rerunAll
, specToEvalForest
, colorOutputSupported
, unicodeOutputSupported
#endif
) where
import Prelude ()
import Test.Hspec.Core.Compat
import NonEmpty (nonEmpty)
import System.IO
import System.Environment (getArgs, withArgs)
import System.Exit (exitFailure)
import System.Random
import Control.Monad.ST
import Data.STRef
import System.Console.ANSI (hSupportsANSI, hHideCursor, hShowCursor)
import qualified Test.QuickCheck as QC
import Test.Hspec.Core.Util (Path)
import Test.Hspec.Core.Clock
import Test.Hspec.Core.Spec hiding (pruneTree, pruneForest)
import Test.Hspec.Core.Tree (formatDefaultDescription)
import Test.Hspec.Core.Config
import Test.Hspec.Core.Format (Format, FormatConfig(..))
import qualified Test.Hspec.Core.Formatters.V1 as V1
import qualified Test.Hspec.Core.Formatters.V2 as V2
import Test.Hspec.Core.FailureReport
import Test.Hspec.Core.QuickCheckUtil
import Test.Hspec.Core.Shuffle
import Test.Hspec.Core.Runner.PrintSlowSpecItems
import Test.Hspec.Core.Runner.Eval hiding (ColorMode(..), Tree(..))
import qualified Test.Hspec.Core.Runner.Eval as Eval
import Test.Hspec.Core.Runner.Result
registerFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config
{-# DEPRECATED registerFormatter "Use [@registerFormatter@](https://hackage.haskell.org/package/hspec-api/docs/Test-Hspec-Api-Format-V2.html#v:registerFormatter) instead." #-}
registerFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config
registerFormatter (String, FormatConfig -> IO Format)
formatter Config
config = Config
config { configAvailableFormatters :: [(String, FormatConfig -> IO Format)]
configAvailableFormatters = (String, FormatConfig -> IO Format)
formatter forall a. a -> [a] -> [a]
: Config -> [(String, FormatConfig -> IO Format)]
configAvailableFormatters Config
config }
registerDefaultFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config
{-# DEPRECATED registerDefaultFormatter "Use [@useFormatter@](https://hackage.haskell.org/package/hspec-api/docs/Test-Hspec-Api-Format-V2.html#v:useFormatter) instead." #-}
registerDefaultFormatter :: (String, FormatConfig -> IO Format) -> Config -> Config
registerDefaultFormatter formatter :: (String, FormatConfig -> IO Format)
formatter@(String
_, FormatConfig -> IO Format
format) Config
config = ((String, FormatConfig -> IO Format) -> Config -> Config
registerFormatter (String, FormatConfig -> IO Format)
formatter Config
config) { configFormat :: Maybe (FormatConfig -> IO Format)
configFormat = forall a. a -> Maybe a
Just FormatConfig -> IO Format
format }
applyFilterPredicates :: Config -> [Tree c EvalItem] -> [Tree c EvalItem]
applyFilterPredicates :: forall c. Config -> [Tree c EvalItem] -> [Tree c EvalItem]
applyFilterPredicates Config
c = forall a c. ([String] -> a -> Bool) -> [Tree c a] -> [Tree c a]
filterForestWithLabels [String] -> EvalItem -> Bool
p
where
include :: Path -> Bool
include :: Path -> Bool
include = forall a. a -> Maybe a -> a
fromMaybe (forall a b. a -> b -> a
const Bool
True) (Config -> Maybe (Path -> Bool)
configFilterPredicate Config
c)
skip :: Path -> Bool
skip :: Path -> Bool
skip = forall a. a -> Maybe a -> a
fromMaybe (forall a b. a -> b -> a
const Bool
False) (Config -> Maybe (Path -> Bool)
configSkipPredicate Config
c)
p :: [String] -> EvalItem -> Bool
p :: [String] -> EvalItem -> Bool
p [String]
groups EvalItem
item = Path -> Bool
include Path
path Bool -> Bool -> Bool
&& Bool -> Bool
not (Path -> Bool
skip Path
path)
where
path :: Path
path = ([String]
groups, EvalItem -> String
evalItemDescription EvalItem
item)
applyDryRun :: Config -> [EvalItemTree] -> [EvalItemTree]
applyDryRun :: Config -> [EvalItemTree] -> [EvalItemTree]
applyDryRun Config
c
| Config -> Bool
configDryRun Config
c = forall a b c d. (a -> b) -> (c -> d) -> [Tree a c] -> [Tree b d]
bimapForest IO () -> IO ()
removeCleanup EvalItem -> EvalItem
markSuccess
| Bool
otherwise = forall a. a -> a
id
where
removeCleanup :: IO () -> IO ()
removeCleanup :: IO () -> IO ()
removeCleanup IO ()
_ = forall (m :: * -> *). Applicative m => m ()
pass
markSuccess :: EvalItem -> EvalItem
markSuccess :: EvalItem -> EvalItem
markSuccess EvalItem
item = EvalItem
item {evalItemAction :: ProgressCallback -> IO (Seconds, Result)
evalItemAction = \ ProgressCallback
_ -> forall (m :: * -> *) a. Monad m => a -> m a
return (Seconds
0, String -> ResultStatus -> Result
Result String
"" ResultStatus
Success)}
hspec :: Spec -> IO ()
hspec :: Spec -> IO ()
hspec = Config -> Spec -> IO ()
hspecWith Config
defaultConfig
evalSpec :: Config -> SpecWith a -> IO (Config, [SpecTree a])
evalSpec :: forall a. Config -> SpecWith a -> IO (Config, [SpecTree a])
evalSpec Config
config SpecWith a
spec = do
(Endo Config -> Config
f, [SpecTree a]
forest) <- forall a. SpecWith a -> IO (Endo Config, [SpecTree a])
runSpecM SpecWith a
spec
forall (m :: * -> *) a. Monad m => a -> m a
return (Config -> Config
f Config
config, [SpecTree a]
forest)
ensureSeed :: Config -> IO Config
ensureSeed :: Config -> IO Config
ensureSeed Config
c = case Config -> Maybe Integer
configQuickCheckSeed Config
c of
Maybe Integer
Nothing -> do
Int
seed <- IO Int
newSeed
forall (m :: * -> *) a. Monad m => a -> m a
return Config
c {configQuickCheckSeed :: Maybe Integer
configQuickCheckSeed = forall a. a -> Maybe a
Just (forall a b. (Integral a, Num b) => a -> b
fromIntegral Int
seed)}
Maybe Integer
_ -> forall (m :: * -> *) a. Monad m => a -> m a
return Config
c
hspecWith :: Config -> Spec -> IO ()
hspecWith :: Config -> Spec -> IO ()
hspecWith Config
defaults = Config -> Spec -> IO SpecResult
hspecWithSpecResult Config
defaults forall (m :: * -> *) a b c.
Monad m =>
(a -> m b) -> (b -> m c) -> a -> m c
>=> SpecResult -> IO ()
evaluateResult
evaluateSummary :: Summary -> IO ()
evaluateSummary :: Summary -> IO ()
evaluateSummary Summary
summary = forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (Summary -> Bool
isSuccess Summary
summary) forall a. IO a
exitFailure
evaluateResult :: SpecResult -> IO ()
evaluateResult :: SpecResult -> IO ()
evaluateResult SpecResult
result = forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless (SpecResult -> Bool
specResultSuccess SpecResult
result) forall a. IO a
exitFailure
hspecResult :: Spec -> IO Summary
hspecResult :: Spec -> IO Summary
hspecResult = Config -> Spec -> IO Summary
hspecWithResult Config
defaultConfig
hspecWithResult :: Config -> Spec -> IO Summary
hspecWithResult :: Config -> Spec -> IO Summary
hspecWithResult Config
config = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap SpecResult -> Summary
toSummary forall b c a. (b -> c) -> (a -> b) -> a -> c
. Config -> Spec -> IO SpecResult
hspecWithSpecResult Config
config
hspecWithSpecResult :: Config -> Spec -> IO SpecResult
hspecWithSpecResult :: Config -> Spec -> IO SpecResult
hspecWithSpecResult Config
defaults Spec
spec = do
(Config
c, [SpecTree ()]
forest) <- forall a. Config -> SpecWith a -> IO (Config, [SpecTree a])
evalSpec Config
defaults Spec
spec
Config
config <- IO [String]
getArgs forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= Config -> [String] -> IO Config
readConfig Config
c
Maybe FailureReport
oldFailureReport <- Config -> IO (Maybe FailureReport)
readFailureReportOnRerun Config
config
let
normalMode :: IO SpecResult
normalMode :: IO SpecResult
normalMode = forall a. IO a -> IO a
doNotLeakCommandLineArgumentsToExamples forall a b. (a -> b) -> a -> b
$ Maybe FailureReport -> [SpecTree ()] -> Config -> IO SpecResult
runSpecForest_ Maybe FailureReport
oldFailureReport [SpecTree ()]
forest Config
config
rerunAllMode :: IO SpecResult
rerunAllMode :: IO SpecResult
rerunAllMode = do
SpecResult
result <- IO SpecResult
normalMode
if Config -> Maybe FailureReport -> SpecResult -> Bool
rerunAll Config
config Maybe FailureReport
oldFailureReport SpecResult
result then
Config -> Spec -> IO SpecResult
hspecWithSpecResult Config
defaults Spec
spec
else
forall (m :: * -> *) a. Monad m => a -> m a
return SpecResult
result
if Config -> Bool
configRerunAllOnSuccess Config
config then do
IO SpecResult
rerunAllMode
else do
IO SpecResult
normalMode
runSpec :: Spec -> Config -> IO Summary
runSpec :: Spec -> Config -> IO Summary
runSpec Spec
spec Config
config = forall a. Config -> SpecWith a -> IO (Config, [SpecTree a])
evalSpec Config
defaultConfig Spec
spec forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap SpecResult -> Summary
toSummary forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b c. (a -> b -> c) -> b -> a -> c
flip [SpecTree ()] -> Config -> IO SpecResult
runSpecForest Config
config forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. (a, b) -> b
snd
runSpecForest :: [SpecTree ()] -> Config -> IO SpecResult
runSpecForest :: [SpecTree ()] -> Config -> IO SpecResult
runSpecForest [SpecTree ()]
spec Config
config = do
Maybe FailureReport
oldFailureReport <- Config -> IO (Maybe FailureReport)
readFailureReportOnRerun Config
config
Maybe FailureReport -> [SpecTree ()] -> Config -> IO SpecResult
runSpecForest_ Maybe FailureReport
oldFailureReport [SpecTree ()]
spec Config
config
mapItem :: (Item a -> Item b) -> [SpecTree a] -> [SpecTree b]
mapItem :: forall a b. (Item a -> Item b) -> [SpecTree a] -> [SpecTree b]
mapItem Item a -> Item b
f = forall a b. (a -> b) -> [a] -> [b]
map (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap Item a -> Item b
f)
mapItemIf :: (Item a -> Bool) -> (Item a -> Item a) -> [SpecTree a] -> [SpecTree a]
mapItemIf :: forall a.
(Item a -> Bool)
-> (Item a -> Item a) -> [SpecTree a] -> [SpecTree a]
mapItemIf Item a -> Bool
p Item a -> Item a
f = forall a b. (Item a -> Item b) -> [SpecTree a] -> [SpecTree b]
mapItem forall a b. (a -> b) -> a -> b
$ \ Item a
item -> if Item a -> Bool
p Item a
item then Item a -> Item a
f Item a
item else Item a
item
addDefaultDescriptions :: [SpecTree a] -> [SpecTree a]
addDefaultDescriptions :: forall a. [SpecTree a] -> [SpecTree a]
addDefaultDescriptions = forall a b. (Item a -> Item b) -> [SpecTree a] -> [SpecTree b]
mapItem forall a. Item a -> Item a
addDefaultDescription
where
addDefaultDescription :: Item a -> Item a
addDefaultDescription :: forall a. Item a -> Item a
addDefaultDescription Item a
item
| forall (t :: * -> *) a. Foldable t => t a -> Bool
null (forall a. Item a -> String
itemRequirement Item a
item) = Item a
item { itemRequirement :: String
itemRequirement = String
defaultRequirement }
| Bool
otherwise = Item a
item
where
defaultRequirement :: String
defaultRequirement = forall b a. b -> (a -> b) -> Maybe a -> b
maybe String
"(unspecified behavior)" Location -> String
formatDefaultDescription (forall a. Item a -> Maybe Location
itemLocation Item a
item)
failItemsWithEmptyDescription :: Config -> [SpecTree a] -> [SpecTree a]
failItemsWithEmptyDescription :: forall a. Config -> [SpecTree a] -> [SpecTree a]
failItemsWithEmptyDescription Config
config
| Config -> Bool
configFailOnEmptyDescription Config
config = forall a.
(Item a -> Bool)
-> (Item a -> Item a) -> [SpecTree a] -> [SpecTree a]
mapItemIf forall {a}. Item a -> Bool
condition (forall a. String -> Item a -> Item a
failWith String
failure)
| Bool
otherwise = forall a. a -> a
id
where
condition :: Item a -> Bool
condition = forall (t :: * -> *) a. Foldable t => t a -> Bool
null forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Item a -> String
itemRequirement
failure :: String
failure = String
"item has no description; failing due to --fail-on=empty-description"
failFocusedItems :: Config -> [SpecTree a] -> [SpecTree a]
failFocusedItems :: forall a. Config -> [SpecTree a] -> [SpecTree a]
failFocusedItems Config
config
| Config -> Bool
configFailOnFocused Config
config = forall a.
(Item a -> Bool)
-> (Item a -> Item a) -> [SpecTree a] -> [SpecTree a]
mapItemIf forall {a}. Item a -> Bool
condition (forall a. String -> Item a -> Item a
failWith String
failure)
| Bool
otherwise = forall a. a -> a
id
where
condition :: Item a -> Bool
condition = forall {a}. Item a -> Bool
itemIsFocused
failure :: String
failure = String
"item is focused; failing due to --fail-on=focused"
failWith :: forall a. String -> Item a -> Item a
failWith :: forall a. String -> Item a -> Item a
failWith String
reason Item a
item = Item a
item {itemExample :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
itemExample = Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example}
where
failure :: ResultStatus
failure :: ResultStatus
failure = Maybe Location -> FailureReason -> ResultStatus
Failure forall a. Maybe a
Nothing (String -> FailureReason
Reason String
reason)
example :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example Params
params ActionWith a -> IO ()
hook ProgressCallback
p = do
Result String
info ResultStatus
status <- forall a.
Item a
-> Params
-> (ActionWith a -> IO ())
-> ProgressCallback
-> IO Result
itemExample Item a
item Params
params ActionWith a -> IO ()
hook ProgressCallback
p
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ String -> ResultStatus -> Result
Result String
info forall a b. (a -> b) -> a -> b
$ case ResultStatus
status of
ResultStatus
Success -> ResultStatus
failure
Pending Maybe Location
_ Maybe String
_ -> ResultStatus
failure
Failure{} -> ResultStatus
status
failPendingItems :: Config -> [SpecTree a] -> [SpecTree a]
failPendingItems :: forall a. Config -> [SpecTree a] -> [SpecTree a]
failPendingItems Config
config
| Config -> Bool
configFailOnPending Config
config = forall a b. (Item a -> Item b) -> [SpecTree a] -> [SpecTree b]
mapItem forall a. Item a -> Item a
failPending
| Bool
otherwise = forall a. a -> a
id
failPending :: forall a. Item a -> Item a
failPending :: forall a. Item a -> Item a
failPending Item a
item = Item a
item {itemExample :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
itemExample = Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example}
where
example :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example :: Params -> (ActionWith a -> IO ()) -> ProgressCallback -> IO Result
example Params
params ActionWith a -> IO ()
hook ProgressCallback
p = do
Result String
info ResultStatus
status <- forall a.
Item a
-> Params
-> (ActionWith a -> IO ())
-> ProgressCallback
-> IO Result
itemExample Item a
item Params
params ActionWith a -> IO ()
hook ProgressCallback
p
forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ String -> ResultStatus -> Result
Result String
info forall a b. (a -> b) -> a -> b
$ case ResultStatus
status of
Pending Maybe Location
loc Maybe String
_ -> Maybe Location -> FailureReason -> ResultStatus
Failure Maybe Location
loc (String -> FailureReason
Reason String
"item is pending; failing due to --fail-on=pending")
ResultStatus
_ -> ResultStatus
status
focusSpec :: Config -> [SpecTree a] -> [SpecTree a]
focusSpec :: forall a. Config -> [SpecTree a] -> [SpecTree a]
focusSpec Config
config [SpecTree a]
spec
| Config -> Bool
configFocusedOnly Config
config = [SpecTree a]
spec
| Bool
otherwise = forall a. [SpecTree a] -> [SpecTree a]
focusForest [SpecTree a]
spec
runSpecForest_ :: Maybe FailureReport -> [SpecTree ()] -> Config -> IO SpecResult
runSpecForest_ :: Maybe FailureReport -> [SpecTree ()] -> Config -> IO SpecResult
runSpecForest_ Maybe FailureReport
oldFailureReport [SpecTree ()]
spec Config
c_ = do
Config
config <- Config -> IO Config
ensureSeed (Maybe FailureReport -> Config -> Config
applyFailureReport Maybe FailureReport
oldFailureReport Config
c_)
UseColor
colorMode <- ColorMode -> IO Bool -> IO UseColor
colorOutputSupported (Config -> ColorMode
configColorMode Config
config) (Handle -> IO Bool
hSupportsANSI Handle
stdout)
Bool
outputUnicode <- UnicodeMode -> Handle -> IO Bool
unicodeOutputSupported (Config -> UnicodeMode
configUnicodeMode Config
config) Handle
stdout
let
filteredSpec :: [EvalTree]
filteredSpec = Config -> [SpecTree ()] -> [EvalTree]
specToEvalForest Config
config [SpecTree ()]
spec
seed :: Integer
seed = (forall a. HasCallStack => Maybe a -> a
fromJust forall b c a. (b -> c) -> (a -> b) -> a -> c
. Config -> Maybe Integer
configQuickCheckSeed) Config
config
qcArgs :: Args
qcArgs = Config -> Args
configQuickCheckArgs Config
config
!numberOfItems :: Int
numberOfItems = forall c a. [Tree c a] -> Int
countEvalItems [EvalTree]
filteredSpec
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (Config -> Bool
configFailOnEmpty Config
config Bool -> Bool -> Bool
&& Int
numberOfItems forall a. Eq a => a -> a -> Bool
== Int
0) forall a b. (a -> b) -> a -> b
$ do
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
when (forall c a. [Tree c a] -> Int
countSpecItems [SpecTree ()]
spec forall a. Eq a => a -> a -> Bool
/= Int
0) forall a b. (a -> b) -> a -> b
$ do
forall a. String -> IO a
die String
"all spec items have been filtered; failing due to --fail-on=empty"
Int
concurrentJobs <- forall b a. b -> (a -> b) -> Maybe a -> b
maybe IO Int
getDefaultConcurrentJobs forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ Config -> Maybe Int
configConcurrentJobs Config
config
SpecResult
results <- forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap [(Path, Item)] -> SpecResult
toSpecResult forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. ProgressReporting -> Handle -> IO a -> IO a
withHiddenCursor (UseColor -> ProgressReporting
progressReporting UseColor
colorMode) Handle
stdout forall a b. (a -> b) -> a -> b
$ do
let
formatConfig :: FormatConfig
formatConfig = FormatConfig {
formatConfigUseColor :: Bool
formatConfigUseColor = UseColor -> Bool
shouldUseColor UseColor
colorMode
, formatConfigReportProgress :: Bool
formatConfigReportProgress = UseColor -> ProgressReporting
progressReporting UseColor
colorMode forall a. Eq a => a -> a -> Bool
== ProgressReporting
ProgressReportingEnabled
, formatConfigOutputUnicode :: Bool
formatConfigOutputUnicode = Bool
outputUnicode
, formatConfigUseDiff :: Bool
formatConfigUseDiff = Config -> Bool
configDiff Config
config
, formatConfigDiffContext :: Maybe Int
formatConfigDiffContext = Config -> Maybe Int
configDiffContext Config
config
, formatConfigExternalDiff :: Maybe (String -> String -> IO ())
formatConfigExternalDiff = if Config -> Bool
configDiff Config
config then (forall a b. (a -> b) -> a -> b
$ Config -> Maybe Int
configDiffContext Config
config) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Config -> Maybe (Maybe Int -> String -> String -> IO ())
configExternalDiff Config
config else forall a. Maybe a
Nothing
, formatConfigPrettyPrint :: Bool
formatConfigPrettyPrint = Config -> Bool
configPrettyPrint Config
config
, formatConfigPrettyPrintFunction :: Maybe (String -> String -> (String, String))
formatConfigPrettyPrintFunction = if Config -> Bool
configPrettyPrint Config
config then forall a. a -> Maybe a
Just (Config -> Bool -> String -> String -> (String, String)
configPrettyPrintFunction Config
config Bool
outputUnicode) else forall a. Maybe a
Nothing
, formatConfigFormatException :: SomeException -> String
formatConfigFormatException = Config -> SomeException -> String
configFormatException Config
config
, formatConfigPrintTimes :: Bool
formatConfigPrintTimes = Config -> Bool
configTimes Config
config
, formatConfigHtmlOutput :: Bool
formatConfigHtmlOutput = Config -> Bool
configHtmlOutput Config
config
, formatConfigPrintCpuTime :: Bool
formatConfigPrintCpuTime = Config -> Bool
configPrintCpuTime Config
config
, formatConfigUsedSeed :: Integer
formatConfigUsedSeed = Integer
seed
, formatConfigExpectedTotalCount :: Int
formatConfigExpectedTotalCount = Int
numberOfItems
, formatConfigExpertMode :: Bool
formatConfigExpertMode = Config -> Bool
configExpertMode Config
config
}
formatter :: FormatConfig -> IO Format
formatter = forall a. a -> Maybe a -> a
fromMaybe (Formatter -> FormatConfig -> IO Format
V2.formatterToFormat Formatter
V2.checks) (Config -> Maybe (FormatConfig -> IO Format)
configFormat Config
config forall (f :: * -> *) a. Alternative f => f a -> f a -> f a
<|> Formatter -> FormatConfig -> IO Format
V1.formatterToFormat forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Config -> Maybe Formatter
configFormatter Config
config)
Format
format <- forall b a. b -> (a -> b) -> Maybe a -> b
maybe forall a. a -> a
id Int -> Format -> Format
printSlowSpecItems (Config -> Maybe Int
configPrintSlowItems Config
config) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> FormatConfig -> IO Format
formatter FormatConfig
formatConfig
let
evalConfig :: EvalConfig
evalConfig = EvalConfig {
evalConfigFormat :: Format
evalConfigFormat = Format
format
, evalConfigConcurrentJobs :: Int
evalConfigConcurrentJobs = Int
concurrentJobs
, evalConfigFailFast :: Bool
evalConfigFailFast = Config -> Bool
configFailFast Config
config
, evalConfigColorMode :: ColorMode
evalConfigColorMode = forall a. a -> a -> Bool -> a
bool ColorMode
Eval.ColorDisabled ColorMode
Eval.ColorEnabled (UseColor -> Bool
shouldUseColor UseColor
colorMode)
}
EvalConfig -> [EvalTree] -> IO [(Path, Item)]
runFormatter EvalConfig
evalConfig [EvalTree]
filteredSpec
let
failures :: [Path]
failures :: [Path]
failures = forall a b. (a -> b) -> [a] -> [b]
map ResultItem -> Path
resultItemPath forall a b. (a -> b) -> a -> b
$ forall a. (a -> Bool) -> [a] -> [a]
filter ResultItem -> Bool
resultItemIsFailure forall a b. (a -> b) -> a -> b
$ SpecResult -> [ResultItem]
specResultItems SpecResult
results
Config -> Integer -> Args -> [Path] -> IO ()
dumpFailureReport Config
config Integer
seed Args
qcArgs [Path]
failures
forall (m :: * -> *) a. Monad m => a -> m a
return SpecResult
results
specToEvalForest :: Config -> [SpecTree ()] -> [EvalTree]
specToEvalForest :: Config -> [SpecTree ()] -> [EvalTree]
specToEvalForest Config
config =
forall a. Config -> [SpecTree a] -> [SpecTree a]
failItemsWithEmptyDescription Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall a. [SpecTree a] -> [SpecTree a]
addDefaultDescriptions
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall a. Config -> [SpecTree a] -> [SpecTree a]
failFocusedItems Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall a. Config -> [SpecTree a] -> [SpecTree a]
failPendingItems Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall a. Config -> [SpecTree a] -> [SpecTree a]
focusSpec Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> Params -> [SpecTree ()] -> [EvalItemTree]
toEvalItemForest Params
params
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> Config -> [EvalItemTree] -> [EvalItemTree]
applyDryRun Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall c. Config -> [Tree c EvalItem] -> [Tree c EvalItem]
applyFilterPredicates Config
config
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall c a. [Tree c a] -> [Tree c a]
randomize
forall {k} (cat :: k -> k -> *) (a :: k) (b :: k) (c :: k).
Category cat =>
cat a b -> cat b c -> cat a c
>>> forall c a. [Tree c a] -> [Tree c a]
pruneForest
where
seed :: Integer
seed :: Integer
seed = (forall a. HasCallStack => Maybe a -> a
fromJust forall b c a. (b -> c) -> (a -> b) -> a -> c
. Config -> Maybe Integer
configQuickCheckSeed) Config
config
params :: Params
params :: Params
params = Args -> Maybe Int -> Params
Params (Config -> Args
configQuickCheckArgs Config
config) (Config -> Maybe Int
configSmallCheckDepth Config
config)
randomize :: [Tree c a] -> [Tree c a]
randomize :: forall c a. [Tree c a] -> [Tree c a]
randomize
| Config -> Bool
configRandomize Config
config = forall c a. Integer -> [Tree c a] -> [Tree c a]
randomizeForest Integer
seed
| Bool
otherwise = forall a. a -> a
id
pruneForest :: [Tree c a] -> [Eval.Tree c a]
pruneForest :: forall c a. [Tree c a] -> [Tree c a]
pruneForest = forall a b. (a -> Maybe b) -> [a] -> [b]
mapMaybe forall c a. Tree c a -> Maybe (Tree c a)
pruneTree
pruneTree :: Tree c a -> Maybe (Eval.Tree c a)
pruneTree :: forall c a. Tree c a -> Maybe (Tree c a)
pruneTree Tree c a
node = case Tree c a
node of
Node String
group [Tree c a]
xs -> forall c a. String -> NonEmpty (Tree c a) -> Tree c a
Eval.Node String
group forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall {c} {a}. [Tree c a] -> Maybe (NonEmpty (Tree c a))
prune [Tree c a]
xs
NodeWithCleanup Maybe (String, Location)
loc c
action [Tree c a]
xs -> forall c a.
Maybe (String, Location) -> c -> NonEmpty (Tree c a) -> Tree c a
Eval.NodeWithCleanup Maybe (String, Location)
loc c
action forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> forall {c} {a}. [Tree c a] -> Maybe (NonEmpty (Tree c a))
prune [Tree c a]
xs
Leaf a
item -> forall a. a -> Maybe a
Just (forall c a. a -> Tree c a
Eval.Leaf a
item)
where
prune :: [Tree c a] -> Maybe (NonEmpty (Tree c a))
prune = forall a. [a] -> Maybe (NonEmpty a)
nonEmpty forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall c a. [Tree c a] -> [Tree c a]
pruneForest
type EvalItemTree = Tree (IO ()) EvalItem
toEvalItemForest :: Params -> [SpecTree ()] -> [EvalItemTree]
toEvalItemForest :: Params -> [SpecTree ()] -> [EvalItemTree]
toEvalItemForest Params
params = forall a b c d. (a -> b) -> (c -> d) -> [Tree a c] -> [Tree b d]
bimapForest forall a. a -> a
id Item () -> EvalItem
toEvalItem forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a c. (a -> Bool) -> [Tree c a] -> [Tree c a]
filterForest forall {a}. Item a -> Bool
itemIsFocused
where
toEvalItem :: Item () -> EvalItem
toEvalItem :: Item () -> EvalItem
toEvalItem (Item String
requirement Maybe Location
loc Maybe Bool
isParallelizable Bool
_isFocused Params -> (ActionWith () -> IO ()) -> ProgressCallback -> IO Result
e) = EvalItem {
evalItemDescription :: String
evalItemDescription = String
requirement
, evalItemLocation :: Maybe Location
evalItemLocation = Maybe Location
loc
, evalItemConcurrency :: Concurrency
evalItemConcurrency = if Maybe Bool
isParallelizable forall a. Eq a => a -> a -> Bool
== forall a. a -> Maybe a
Just Bool
True then Concurrency
Concurrent else Concurrency
Sequential
, evalItemAction :: ProgressCallback -> IO (Seconds, Result)
evalItemAction = \ ProgressCallback
progress -> forall a. IO a -> IO (Seconds, a)
measure forall a b. (a -> b) -> a -> b
$ Params -> (ActionWith () -> IO ()) -> ProgressCallback -> IO Result
e Params
params ActionWith () -> IO ()
withUnit ProgressCallback
progress
}
withUnit :: ActionWith () -> IO ()
withUnit :: ActionWith () -> IO ()
withUnit ActionWith ()
action = ActionWith ()
action ()
dumpFailureReport :: Config -> Integer -> QC.Args -> [Path] -> IO ()
dumpFailureReport :: Config -> Integer -> Args -> [Path] -> IO ()
dumpFailureReport Config
config Integer
seed Args
qcArgs [Path]
xs = do
Config -> FailureReport -> IO ()
writeFailureReport Config
config FailureReport {
failureReportSeed :: Integer
failureReportSeed = Integer
seed
, failureReportMaxSuccess :: Int
failureReportMaxSuccess = Args -> Int
QC.maxSuccess Args
qcArgs
, failureReportMaxSize :: Int
failureReportMaxSize = Args -> Int
QC.maxSize Args
qcArgs
, failureReportMaxDiscardRatio :: Int
failureReportMaxDiscardRatio = Args -> Int
QC.maxDiscardRatio Args
qcArgs
, failureReportPaths :: [Path]
failureReportPaths = [Path]
xs
}
doNotLeakCommandLineArgumentsToExamples :: IO a -> IO a
doNotLeakCommandLineArgumentsToExamples :: forall a. IO a -> IO a
doNotLeakCommandLineArgumentsToExamples = forall a. [String] -> IO a -> IO a
withArgs []
withHiddenCursor :: ProgressReporting -> Handle -> IO a -> IO a
withHiddenCursor :: forall a. ProgressReporting -> Handle -> IO a -> IO a
withHiddenCursor ProgressReporting
progress Handle
h = case ProgressReporting
progress of
ProgressReporting
ProgressReportingDisabled -> forall a. a -> a
id
ProgressReporting
ProgressReportingEnabled -> forall a b c. IO a -> IO b -> IO c -> IO c
bracket_ (Handle -> IO ()
hHideCursor Handle
h) (Handle -> IO ()
hShowCursor Handle
h)
data UseColor = ColorDisabled | ColorEnabled ProgressReporting
deriving (UseColor -> UseColor -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: UseColor -> UseColor -> Bool
$c/= :: UseColor -> UseColor -> Bool
== :: UseColor -> UseColor -> Bool
$c== :: UseColor -> UseColor -> Bool
Eq, Int -> UseColor -> ShowS
[UseColor] -> ShowS
UseColor -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [UseColor] -> ShowS
$cshowList :: [UseColor] -> ShowS
show :: UseColor -> String
$cshow :: UseColor -> String
showsPrec :: Int -> UseColor -> ShowS
$cshowsPrec :: Int -> UseColor -> ShowS
Show)
data ProgressReporting = ProgressReportingDisabled | ProgressReportingEnabled
deriving (ProgressReporting -> ProgressReporting -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ProgressReporting -> ProgressReporting -> Bool
$c/= :: ProgressReporting -> ProgressReporting -> Bool
== :: ProgressReporting -> ProgressReporting -> Bool
$c== :: ProgressReporting -> ProgressReporting -> Bool
Eq, Int -> ProgressReporting -> ShowS
[ProgressReporting] -> ShowS
ProgressReporting -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ProgressReporting] -> ShowS
$cshowList :: [ProgressReporting] -> ShowS
show :: ProgressReporting -> String
$cshow :: ProgressReporting -> String
showsPrec :: Int -> ProgressReporting -> ShowS
$cshowsPrec :: Int -> ProgressReporting -> ShowS
Show)
shouldUseColor :: UseColor -> Bool
shouldUseColor :: UseColor -> Bool
shouldUseColor UseColor
c = case UseColor
c of
UseColor
ColorDisabled -> Bool
False
ColorEnabled ProgressReporting
_ -> Bool
True
progressReporting :: UseColor -> ProgressReporting
progressReporting :: UseColor -> ProgressReporting
progressReporting UseColor
c = case UseColor
c of
UseColor
ColorDisabled -> ProgressReporting
ProgressReportingDisabled
ColorEnabled ProgressReporting
r -> ProgressReporting
r
colorOutputSupported :: ColorMode -> IO Bool -> IO UseColor
colorOutputSupported :: ColorMode -> IO Bool -> IO UseColor
colorOutputSupported ColorMode
mode IO Bool
isTerminalDevice = do
Bool
github <- IO Bool
githubActions
Bool
buildkite <- String -> IO (Maybe String)
lookupEnv String
"BUILDKITE" forall (f :: * -> *) a b. Functor f => f a -> (a -> b) -> f b
<&> (forall a. Eq a => a -> a -> Bool
== forall a. a -> Maybe a
Just String
"true")
let
progress :: ProgressReporting
progress :: ProgressReporting
progress
| Bool
github Bool -> Bool -> Bool
|| Bool
buildkite = ProgressReporting
ProgressReportingDisabled
| Bool
otherwise = ProgressReporting
ProgressReportingEnabled
colorEnabled :: UseColor
colorEnabled :: UseColor
colorEnabled = ProgressReporting -> UseColor
ColorEnabled ProgressReporting
progress
case ColorMode
mode of
ColorMode
ColorAuto -> forall a. a -> a -> Bool -> a
bool UseColor
ColorDisabled UseColor
colorEnabled forall b c a. (b -> c) -> (a -> b) -> a -> c
. (Bool
github Bool -> Bool -> Bool
||) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> IO Bool
colorTerminal
ColorMode
ColorNever -> forall (m :: * -> *) a. Monad m => a -> m a
return UseColor
ColorDisabled
ColorMode
ColorAlways -> forall (m :: * -> *) a. Monad m => a -> m a
return UseColor
colorEnabled
where
githubActions :: IO Bool
githubActions :: IO Bool
githubActions = String -> IO (Maybe String)
lookupEnv String
"GITHUB_ACTIONS" forall (f :: * -> *) a b. Functor f => f a -> (a -> b) -> f b
<&> (forall a. Eq a => a -> a -> Bool
== forall a. a -> Maybe a
Just String
"true")
colorTerminal :: IO Bool
colorTerminal :: IO Bool
colorTerminal = Bool -> Bool -> Bool
(&&) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (Bool -> Bool
not forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> IO Bool
noColor) forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
<*> IO Bool
isTerminalDevice
noColor :: IO Bool
noColor :: IO Bool
noColor = String -> IO (Maybe String)
lookupEnv String
"NO_COLOR" forall (f :: * -> *) a b. Functor f => f a -> (a -> b) -> f b
<&> (forall a. Eq a => a -> a -> Bool
/= forall a. Maybe a
Nothing)
unicodeOutputSupported :: UnicodeMode -> Handle -> IO Bool
unicodeOutputSupported :: UnicodeMode -> Handle -> IO Bool
unicodeOutputSupported UnicodeMode
mode Handle
h = case UnicodeMode
mode of
UnicodeMode
UnicodeAuto -> (forall a. Eq a => a -> a -> Bool
== forall a. a -> Maybe a
Just String
"UTF-8") forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall a. Show a => a -> String
show forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Handle -> IO (Maybe TextEncoding)
hGetEncoding Handle
h
UnicodeMode
UnicodeNever -> forall (m :: * -> *) a. Monad m => a -> m a
return Bool
False
UnicodeMode
UnicodeAlways -> forall (m :: * -> *) a. Monad m => a -> m a
return Bool
True
rerunAll :: Config -> Maybe FailureReport -> SpecResult -> Bool
rerunAll :: Config -> Maybe FailureReport -> SpecResult -> Bool
rerunAll Config
config Maybe FailureReport
mOldFailureReport SpecResult
result = case Maybe FailureReport
mOldFailureReport of
Maybe FailureReport
Nothing -> Bool
False
Just FailureReport
oldFailureReport ->
Config -> Bool
configRerunAllOnSuccess Config
config
Bool -> Bool -> Bool
&& Config -> Bool
configRerun Config
config
Bool -> Bool -> Bool
&& SpecResult -> Bool
specResultSuccess SpecResult
result
Bool -> Bool -> Bool
&& (Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) a. Foldable t => t a -> Bool
null) (FailureReport -> [Path]
failureReportPaths FailureReport
oldFailureReport)
randomizeForest :: Integer -> [Tree c a] -> [Tree c a]
randomizeForest :: forall c a. Integer -> [Tree c a] -> [Tree c a]
randomizeForest Integer
seed [Tree c a]
t = forall a. (forall s. ST s a) -> a
runST forall a b. (a -> b) -> a -> b
$ do
STRef s StdGen
ref <- forall a s. a -> ST s (STRef s a)
newSTRef (Int -> StdGen
mkStdGen forall a b. (a -> b) -> a -> b
$ forall a b. (Integral a, Num b) => a -> b
fromIntegral Integer
seed)
forall st c a. STRef st StdGen -> [Tree c a] -> ST st [Tree c a]
shuffleForest STRef s StdGen
ref [Tree c a]
t
countEvalItems :: [Eval.Tree c a] -> Int
countEvalItems :: forall c a. [Tree c a] -> Int
countEvalItems = forall a. Sum a -> a
getSum forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) m a.
(Foldable t, Monoid m) =>
(a -> m) -> t a -> m
foldMap (forall (t :: * -> *) m a.
(Foldable t, Monoid m) =>
(a -> m) -> t a -> m
foldMap forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. a -> b -> a
const forall a b. (a -> b) -> a -> b
$ forall a. a -> Sum a
Sum Int
1)
countSpecItems :: [Tree c a] -> Int
countSpecItems :: forall c a. [Tree c a] -> Int
countSpecItems = forall a. Sum a -> a
getSum forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) m a.
(Foldable t, Monoid m) =>
(a -> m) -> t a -> m
foldMap (forall (t :: * -> *) m a.
(Foldable t, Monoid m) =>
(a -> m) -> t a -> m
foldMap forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a b. a -> b -> a
const forall a b. (a -> b) -> a -> b
$ forall a. a -> Sum a
Sum Int
1)