Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Internal

Internal functionality exposed for debugging or for sibling libraries such as sandwich-webdriver to use. Should not be used otherwise.

13 types
2 classes
32 values

Packagesandwich-0.3.1.0
Exports47
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

typetype Spec context (m :: Type -> Type) = SpecFree context m ()

typetype SpecFree context (m :: Type -> Type) a = Free (SpecCommand context m) a

datadata SpecCommand context (m :: Type -> Type) next where

Instances5Functor, Foldable, Traversable, Show1, Show

Functor (SpecCommand context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Foldable (SpecCommand context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Traversable (SpecCommand context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show1 (SpecCommand context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show t => Show (SpecCommand context m t)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

classclass HasBaseContext a where

Has-* class for asserting a BaseContext is available.

Instances2HasBaseContext

HasBaseContext BaseContextDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
HasBaseContext context => HasBaseContext (intro :> context)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree

classclass HasLabel context (l :: Symbol) a where

Instances3HasLabel

HasLabel (LabelValue l a) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
HasLabel (LabelValue l a :> context) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
HasLabel context l a => HasLabel (intro :> context) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

newtypenewtype LabelValue (l :: Symbol) a

Constructors

LabelValue
- unLabelValue :: a

Instances2HasLabel

HasLabel (LabelValue l a) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
HasLabel (LabelValue l a :> context) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

datadata (:>) a b

Constructors

a :> binfixr 9

Instances4Show, HasBaseContext, HasLabel

(Show a, Show b) => Show (a :> b)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
HasBaseContext context => HasBaseContext (intro :> context)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
HasLabel (LabelValue l a :> context) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
HasLabel context l a => HasLabel (intro :> context) l aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

typetype ExampleM context = ExampleT context IO

newtypenewtype ExampleT context (m :: Type -> Type) a

Constructors

ExampleT
- unExampleT :: ReaderT context (LoggingT m) a

Instances19MonadReader, MonadBase, MonadBaseControl, MonadTrans, MonadTransControl, Monad, …

Monad m => MonadReader context (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadBase b m => MonadBase b (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadBaseControl b m => MonadBaseControl b (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadTrans (ExampleT context)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadTransControl (ExampleT context)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Monad m => Monad (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Functor m => Functor (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadIO m => MonadFail (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Applicative m => Applicative (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
(Applicative m, Alternative (LoggingT m)) => Alternative (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadIO m => MonadIO (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadCatch m => MonadCatch (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadMask m => MonadMask (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadThrow m => MonadThrow (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
(MonadIO m, MonadUnliftIO m) => MonadUnliftIO (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadIO m => MonadLogger (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
MonadIO m => MonadLoggerIO (ExampleT context m)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
type StM (ExampleT context m) a = ComposeSt (ExampleT context) m aDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
type StT (ExampleT context) a = StT LoggingT (StT (ReaderT context) a)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

For tests

13 declarations

datadata RunNodeWithStatus context s l t where

Constructors

RunNodeBefore :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus context s l t] -> ExampleT context IO () -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildren :: [RunNodeWithStatus context s l t]
- runNodeBefore :: ExampleT context IO ()
RunNodeAfter :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus context s l t] -> ExampleT context IO () -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildren :: [RunNodeWithStatus context s l t]
- runNodeAfter :: ExampleT context IO ()
RunNodeIntroduce :: Typeable intro => RunNodeCommonWithStatus s l t -> [RunNodeWithStatus (LabelValue lab intro :> context) s l t] -> ExampleT context IO intro -> (intro -> ExampleT context IO ()) -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildrenAugmented :: [RunNodeWithStatus (LabelValue lab intro :> context) s l t]
- runNodeAlloc :: ExampleT context IO intro
- runNodeCleanup :: intro -> ExampleT context IO ()
RunNodeIntroduceWith :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus (LabelValue lab intro :> context) s l t] -> ((intro -> ExampleT context IO [Result]) -> ExampleT context IO ()) -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildrenAugmented :: [RunNodeWithStatus (LabelValue lab intro :> context) s l t]
- runNodeIntroduceAction :: (intro -> ExampleT context IO [Result]) -> ExampleT context IO ()
RunNodeAround :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus context s l t] -> (ExampleT context IO [Result] -> ExampleT context IO ()) -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildren :: [RunNodeWithStatus context s l t]
- runNodeActionWith :: ExampleT context IO [Result] -> ExampleT context IO ()
RunNodeDescribe :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus context s l t] -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildren :: [RunNodeWithStatus context s l t]
RunNodeParallel :: RunNodeCommonWithStatus s l t -> [RunNodeWithStatus context s l t] -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeChildren :: [RunNodeWithStatus context s l t]
RunNodeIt :: RunNodeCommonWithStatus s l t -> ExampleT context IO () -> RunNodeWithStatus context s l t
- runNodeCommon :: RunNodeCommonWithStatus s l t
- runNodeExample :: ExampleT context IO ()

typetype RunNodeFixed context = RunNodeWithStatus context Status (Seq LogEntry) Bool

typetype RunNode context = RunNodeWithStatus context (Var Status) (Var (Seq LogEntry)) (Var Bool)

datadata RunNodeCommonWithStatus s l t

Constructors

RunNodeCommonWithStatus
- runTreeLabel :: String
- runTreeId :: Int
- runTreeAncestors :: Seq Int
- runTreeToggled :: t
- runTreeOpen :: t
- runTreeStatus :: s
- runTreeVisible :: Bool
- runTreeFolder :: Maybe FilePath
- runTreeVisibilityLevel :: Int
- runTreeRecordTime :: Bool
- runTreeLogs :: l
- runTreeLoc :: Maybe SrcLoc

Instances2Eq, Show

(Eq t, Eq s, Eq l) => Eq (RunNodeCommonWithStatus s l t)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
(Show t, Show s, Show l) => Show (RunNodeCommonWithStatus s l t)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree

valueextractValues

:: forall ctx. RunNodeWithStatus ctx s l t -> a
-> RunNodeWithStatus context s l t
-> [a]

valueextractValuesControlRecurse

:: forall ctx. RunNodeWithStatus ctx s l t -> (Bool, a)
-> RunNodeWithStatus context s l t
-> [a]

valuegetCommons

:: RunNodeWithStatus context s l t
-> [RunNodeCommonWithStatus s l t]

valuecancelNode :: RunNode context -> IO ()

datadata Status

Constructors

NotStarted
Running
- statusStartTime :: UTCTime
- statusSetupFinishTime :: Maybe UTCTime
- statusTeardownStartTime :: Maybe UTCTime
- statusAsync :: Async Result
Done
- statusStartTime :: UTCTime
- statusSetupFinishTime :: Maybe UTCTime
- statusTeardownStartTime :: Maybe UTCTime
- statusEndTime :: UTCTime
- statusResult :: Result

Instances3Eq, Show, ToBrickWidget

Eq StatusDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
Show StatusDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
ToBrickWidget StatusDefined in sandwich-0.3.1.0 · Test.Sandwich.Formatters.TerminalUI.Draw.ToBrickWidget

valuefixRunTree :: RunNode context -> STM (RunNodeFixed context)

valuewaitForTree :: RunNode context -> IO Result

Wait for a tree, catching any synchronous exceptions and returning them as a list

newtypenewtype SomeAsyncExceptionWithEq

Constructors

SomeAsyncExceptionWithEq SomeAsyncException

Instances2Eq, Show

Eq SomeAsyncExceptionWithEqDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show SomeAsyncExceptionWithEqDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec

valuelogEntryStr :: LogEntry -> ByteString

For debugging

25 declarations

valuegetRunTree :: Options -> CoreSpec -> IO [RunNodeFixed BaseContext]

valuegetRunTree'

valueprintRunTree :: [RunNodeFixed ctx] -> IO ()

valuecommandLineOptions :: Label "commandLineOptions" (CommandLineOptions a)

valuecountWhere

:: forall ctx. RunNodeWithStatus ctx s l t -> Bool
-> [RunNodeWithStatus context s l t]
-> Int

valueisDoneItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisFailedBlock :: RunNodeWithStatus context Status l t -> Bool

valueisFailedItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisFailedNonItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisItBlock :: RunNodeWithStatus context s l t -> Bool

valueisNotStartedItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisPendingItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisRunningItBlock :: RunNodeWithStatus context Status l t -> Bool

valueisSuccessItBlock :: RunNodeWithStatus context Status l t -> Bool

valueformatNominalDiffTime :: NominalDiffTime -> String

valuebaseContextFromOptions :: Options -> IO BaseContext

valuegatherMainFunctions :: Free (SpecCommand context m) r -> [NodeModuleInfo]

valuegatherNodeOptions :: Free (SpecCommand context m) r -> [NodeOptions]

Gather all node options from a spec

valuegatherShorthands :: [NodeModuleInfo] -> [(NodeModuleInfo, Text)]

valuerunSandwichTree :: Options -> CoreSpec -> IO [RunNode BaseContext]

valuerunWithRepeat :: Int -> Int -> (Int -> IO (ExitReason, Int, Int)) -> IO ()

For 0 repeats, repeat until a failure

valuestartSandwichTree :: Options -> CoreSpec -> IO [RunNode BaseContext]

valuestartSandwichTree'

valuetakenMainOptions :: [Text]

TODO: get these automatically from mainCommandLineOptions

valueunwrapTreeFilter :: Maybe TreeFilter -> [String]