Safe Haskell	None
Language	Haskell2010

Test.Sandwich.Misc

Contents

The example monad
Spec types
Command line options
Labels
Context classes
Result types

Description

Miscellaneous exports that need to be exposed, but aren't super interesting. Gathered here to avoid cluttering other files.

Synopsis

data ExampleT context m a
type ExampleM context = ExampleT context IO
type Spec context m = SpecFree context m ()
type SpecFree context m a = Free (SpecCommand context m) a
type CoreSpec = Spec BaseContext IO
type TopSpec = forall context. HasBaseContext context => SpecFree context IO ()
type TopSpecWithOptions = forall context. (HasBaseContext context, HasCommandLineOptions context ()) => SpecFree context IO ()
type TopSpecWithOptions' a = forall context. (HasBaseContext context, HasCommandLineOptions context a) => SpecFree context IO ()
isEmptySpec :: forall context. Free (SpecCommand context IO) () -> Bool
data CommandLineOptions a = CommandLineOptions {
- optFormatter :: FormatterType
- optLogLevel :: Maybe LogLevel
- optVisibilityThreshold :: Maybe Int
- optTreeFilter :: Maybe String
- optRepeatCount :: Int
- optFixedRoot :: Maybe String
- optDryRun :: Maybe Bool
- optListAvailableTests :: Maybe Bool
- optPrintQuickCheckFlags :: Maybe Bool
- optPrintSlackFlags :: Maybe Bool
- optPrintWebDriverFlags :: Maybe Bool
- optIndividualTestModule :: Maybe IndividualTestModule
- optQuickCheckOptions :: CommandLineQuickCheckOptions
- optSlackOptions :: CommandLineSlackOptions
- optWebdriverOptions :: CommandLineWebdriverOptions
- optUserOptions :: a
}
data CommandLineQuickCheckOptions = CommandLineQuickCheckOptions {
- optQuickCheckSeed :: Maybe Integer
- optQuickCheckMaxDiscardRatio :: Maybe Int
- optQuickCheckMaxSize :: Maybe Int
- optQuickCheckMaxSuccess :: Maybe Int
- optQuickCheckMaxShrinks :: Maybe Int
}
data CommandLineSlackOptions = CommandLineSlackOptions {
- optSlackToken :: Maybe String
- optSlackChannel :: Maybe String
- optSlackTopMessage :: Maybe String
- optSlackMaxFailures :: Maybe Int
- optSlackMaxFailureReasonLines :: Maybe Int
- optSlackMaxCallStackLines :: Maybe Int
- optSlackVisibilityThreshold :: Maybe Int
- optSlackMaxMessageSize :: Maybe Int64
}
data CommandLineWebdriverOptions = CommandLineWebdriverOptions {
- optFirefox :: Maybe BrowserToUse
- optDisplay :: Maybe DisplayType
- optFluxbox :: Bool
- optIndividualVideos :: Bool
- optErrorVideos :: Bool
}
data BrowserToUse
- = UseChrome
- | UseFirefox
data DisplayType
- = Current
- | Headless
- | Xvfb
commandLineOptionsWithInfo :: Parser a -> Parser (Maybe IndividualTestModule) -> ParserInfo (CommandLineOptions a)
data Label (l :: Symbol) a = Label
data LabelValue (l :: Symbol) a = LabelValue a
class HasLabel context (l :: Symbol) a
data (a :: *) :> (b :: *)
data BaseContext
class HasBaseContext a
type HasCommandLineOptions context a = HasLabel context "commandLineOptions" (CommandLineOptions a)
data Result
- = Success
- | Failure FailureReason
- | DryRun
- | Cancelled
data FailureReason
- = Reason {
  - failureCallStack :: Maybe CallStack
  - failureReason :: String
  }
- | ExpectedButGot {
  - failureCallStack :: Maybe CallStack
  - failureValue1 :: ShowEqBox
  - failureValue2 :: ShowEqBox
  }
- | DidNotExpectButGot {
  - failureCallStack :: Maybe CallStack
  - failureValue1 :: ShowEqBox
  }
- | GotException {
  - failureCallStack :: Maybe CallStack
  - failureMessage :: Maybe String
  - failureException :: SomeExceptionWithEq
  }
- | Pending {
  - failureCallStack :: Maybe CallStack
  - failurePendingMessage :: Maybe String
  }
- | GetContextException {
  - failureCallStack :: Maybe CallStack
  - failureException :: SomeExceptionWithEq
  }
- | GotAsyncException {
  }
- | ChildrenFailed {
  - failureCallStack :: Maybe CallStack
  - failureNumChildren :: Int
  }
data SomeExceptionWithCallStack = forall e.Exception e => SomeExceptionWithCallStack e CallStack
newtype SomeExceptionWithEq = SomeExceptionWithEq SomeException
data ExitReason
- = NormalExit
- | InterruptExit

The example monad

data ExampleT context m a Source #

Instances

Instances details

Monad m => MonadReader context (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods ask :: ExampleT context m context # local :: (context -> context) -> ExampleT context m a -> ExampleT context m a # reader :: (context -> a) -> ExampleT context m a #
MonadBase b m => MonadBase b (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods liftBase :: b α -> ExampleT context m α #
MonadBaseControl b m => MonadBaseControl b (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Associated Types type StM (ExampleT context m) a # Methods liftBaseWith :: (RunInBase (ExampleT context m) b -> b a) -> ExampleT context m a # restoreM :: StM (ExampleT context m) a -> ExampleT context m a #
MonadTrans (ExampleT context) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods lift :: Monad m => m a -> ExampleT context m a #
MonadTransControl (ExampleT context) Source #
Instance details Defined in Test.Sandwich.Types.Spec Associated Types type StT (ExampleT context) a # Methods liftWith :: Monad m => (Run (ExampleT context) -> m a) -> ExampleT context m a # restoreT :: Monad m => m (StT (ExampleT context) a) -> ExampleT context m a #
Monad m => Monad (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods (>>=) :: ExampleT context m a -> (a -> ExampleT context m b) -> ExampleT context m b # (>>) :: ExampleT context m a -> ExampleT context m b -> ExampleT context m b # return :: a -> ExampleT context m a #
Functor m => Functor (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods fmap :: (a -> b) -> ExampleT context m a -> ExampleT context m b # (<$) :: a -> ExampleT context m b -> ExampleT context m a #
(Monad m, MonadThrow m) => MonadFail (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods fail :: String -> ExampleT context m a #
Applicative m => Applicative (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods pure :: a -> ExampleT context m a # (<>) :: ExampleT context m (a -> b) -> ExampleT context m a -> ExampleT context m b # liftA2 :: (a -> b -> c) -> ExampleT context m a -> ExampleT context m b -> ExampleT context m c # (>) :: ExampleT context m a -> ExampleT context m b -> ExampleT context m b # (<*) :: ExampleT context m a -> ExampleT context m b -> ExampleT context m a #
MonadIO m => MonadIO (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods liftIO :: IO a -> ExampleT context m a #
(MonadIO m, MonadUnliftIO m) => MonadUnliftIO (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods withRunInIO :: ((forall a. ExampleT context m a -> IO a) -> IO b) -> ExampleT context m b #
MonadThrow m => MonadThrow (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods throwM :: Exception e => e -> ExampleT context m a #
MonadCatch m => MonadCatch (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods catch :: Exception e => ExampleT context m a -> (e -> ExampleT context m a) -> ExampleT context m a #
MonadMask m => MonadMask (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods mask :: ((forall a. ExampleT context m a -> ExampleT context m a) -> ExampleT context m b) -> ExampleT context m b # uninterruptibleMask :: ((forall a. ExampleT context m a -> ExampleT context m a) -> ExampleT context m b) -> ExampleT context m b # generalBracket :: ExampleT context m a -> (a -> ExitCase b -> ExampleT context m c) -> (a -> ExampleT context m b) -> ExampleT context m (b, c) #
MonadIO m => MonadLogger (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> ExampleT context m () #
MonadIO m => MonadLoggerIO (ExampleT context m) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods askLoggerIO :: ExampleT context m (Loc -> LogSource -> LogLevel -> LogStr -> IO ()) #
type StT (ExampleT context) a Source #
Instance details Defined in Test.Sandwich.Types.Spec type StT (ExampleT context) a = StT LoggingT (StT (ReaderT context) a)
type StM (ExampleT context m) a Source #
Instance details Defined in Test.Sandwich.Types.Spec type StM (ExampleT context m) a = ComposeSt (ExampleT context) m a

type ExampleM context = ExampleT context IO Source #

Spec types

type Spec context m = SpecFree context m () Source #

type SpecFree context m a = Free (SpecCommand context m) a Source #

type CoreSpec = Spec BaseContext IO Source #

type TopSpec = forall context. HasBaseContext context => SpecFree context IO () Source #

type TopSpecWithOptions = forall context. (HasBaseContext context, HasCommandLineOptions context ()) => SpecFree context IO () Source #

type TopSpecWithOptions' a = forall context. (HasBaseContext context, HasCommandLineOptions context a) => SpecFree context IO () Source #

isEmptySpec :: forall context. Free (SpecCommand context IO) () -> Bool Source #

Command line options

data CommandLineOptions a Source #

Constructors

CommandLineOptions

Fields

optFormatter :: FormatterType
optLogLevel :: Maybe LogLevel
optVisibilityThreshold :: Maybe Int
optTreeFilter :: Maybe String
optRepeatCount :: Int
optFixedRoot :: Maybe String
optDryRun :: Maybe Bool
optListAvailableTests :: Maybe Bool
optPrintQuickCheckFlags :: Maybe Bool
optPrintSlackFlags :: Maybe Bool
optPrintWebDriverFlags :: Maybe Bool
optIndividualTestModule :: Maybe IndividualTestModule
optQuickCheckOptions :: CommandLineQuickCheckOptions
optSlackOptions :: CommandLineSlackOptions
optWebdriverOptions :: CommandLineWebdriverOptions
optUserOptions :: a

Instances

Instances details

Show a => Show (CommandLineOptions a) Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> CommandLineOptions a -> ShowS # show :: CommandLineOptions a -> String # showList :: [CommandLineOptions a] -> ShowS #

data CommandLineQuickCheckOptions Source #

Constructors

CommandLineQuickCheckOptions
Fields optQuickCheckSeed :: Maybe Integer optQuickCheckMaxDiscardRatio :: Maybe Int optQuickCheckMaxSize :: Maybe Int optQuickCheckMaxSuccess :: Maybe Int optQuickCheckMaxShrinks :: Maybe Int

Instances

Instances details

Show CommandLineQuickCheckOptions Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> CommandLineQuickCheckOptions -> ShowS # show :: CommandLineQuickCheckOptions -> String # showList :: [CommandLineQuickCheckOptions] -> ShowS #

data CommandLineSlackOptions Source #

Constructors

CommandLineSlackOptions
Fields optSlackToken :: Maybe String optSlackChannel :: Maybe String optSlackTopMessage :: Maybe String optSlackMaxFailures :: Maybe Int optSlackMaxFailureReasonLines :: Maybe Int optSlackMaxCallStackLines :: Maybe Int optSlackVisibilityThreshold :: Maybe Int optSlackMaxMessageSize :: Maybe Int64

Instances

Instances details

Show CommandLineSlackOptions Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> CommandLineSlackOptions -> ShowS # show :: CommandLineSlackOptions -> String # showList :: [CommandLineSlackOptions] -> ShowS #

data CommandLineWebdriverOptions Source #

Constructors

CommandLineWebdriverOptions
Fields optFirefox :: Maybe BrowserToUse optDisplay :: Maybe DisplayType optFluxbox :: Bool optIndividualVideos :: Bool optErrorVideos :: Bool

Instances

Instances details

Show CommandLineWebdriverOptions Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> CommandLineWebdriverOptions -> ShowS # show :: CommandLineWebdriverOptions -> String # showList :: [CommandLineWebdriverOptions] -> ShowS #

data BrowserToUse Source #

Constructors

UseChrome
UseFirefox

Instances

Instances details

Show BrowserToUse Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> BrowserToUse -> ShowS # show :: BrowserToUse -> String # showList :: [BrowserToUse] -> ShowS #

data DisplayType Source #

Constructors

Current
Headless
Xvfb

Instances

Instances details

Read DisplayType Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods readsPrec :: Int -> ReadS DisplayType # readList :: ReadS [DisplayType] # readPrec :: ReadPrec DisplayType # readListPrec :: ReadPrec [DisplayType] #
Show DisplayType Source #
Instance details Defined in Test.Sandwich.Types.ArgParsing Methods showsPrec :: Int -> DisplayType -> ShowS # show :: DisplayType -> String # showList :: [DisplayType] -> ShowS #

commandLineOptionsWithInfo :: Parser a -> Parser (Maybe IndividualTestModule) -> ParserInfo (CommandLineOptions a) Source #

Labels

data Label (l :: Symbol) a Source #

Constructors

Label

data LabelValue (l :: Symbol) a Source #

Constructors

LabelValue a

Instances

Instances details

HasLabel (LabelValue l a :> context) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> (LabelValue l a :> context) -> a
HasLabel (LabelValue l a) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> LabelValue l a -> a

class HasLabel context (l :: Symbol) a Source #

Minimal complete definition

getLabelValue

Instances

Instances details

HasLabel context l a => HasLabel (intro :> context) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> (intro :> context) -> a
HasLabel (LabelValue l a :> context) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> (LabelValue l a :> context) -> a
HasLabel (LabelValue l a) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> LabelValue l a -> a

data (a :: *) :> (b :: *) infixr 9 Source #

Instances

Instances details

(Show a, Show b) => Show (a :> b) Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods showsPrec :: Int -> (a :> b) -> ShowS # show :: (a :> b) -> String # showList :: [a :> b] -> ShowS #
HasBaseContext context => HasBaseContext (intro :> context) Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods getBaseContext :: (intro :> context) -> BaseContext modifyBaseContext :: (intro :> context) -> (BaseContext -> BaseContext) -> intro :> context
HasLabel context l a => HasLabel (intro :> context) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> (intro :> context) -> a
HasLabel (LabelValue l a :> context) l a Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods getLabelValue :: Label l a -> (LabelValue l a :> context) -> a

Context classes

data BaseContext Source #

The base context available to every test node. Contains various paths and timing information.

Instances

Instances details

HasBaseContext BaseContext Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods getBaseContext :: BaseContext -> BaseContext modifyBaseContext :: BaseContext -> (BaseContext -> BaseContext) -> BaseContext

class HasBaseContext a Source #

Has-* class for asserting a BaseContext is available.

Minimal complete definition

getBaseContext, modifyBaseContext

Instances

Instances details

HasBaseContext BaseContext Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods getBaseContext :: BaseContext -> BaseContext modifyBaseContext :: BaseContext -> (BaseContext -> BaseContext) -> BaseContext
HasBaseContext context => HasBaseContext (intro :> context) Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods getBaseContext :: (intro :> context) -> BaseContext modifyBaseContext :: (intro :> context) -> (BaseContext -> BaseContext) -> intro :> context

type HasCommandLineOptions context a = HasLabel context "commandLineOptions" (CommandLineOptions a) Source #

Has-* class for asserting a 'CommandLineOptions a' is available.

Result types

data Result Source #

Constructors

Success
Failure FailureReason
DryRun
Cancelled

Instances

Instances details

Eq Result Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods (==) :: Result -> Result -> Bool # (/=) :: Result -> Result -> Bool #
Show Result Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods showsPrec :: Int -> Result -> ShowS # show :: Result -> String # showList :: [Result] -> ShowS #
Show (Async Result) Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods showsPrec :: Int -> Async Result -> ShowS # show :: Async Result -> String # showList :: [Async Result] -> ShowS #

data FailureReason Source #

Constructors

Reason
Fields failureCallStack :: Maybe CallStack failureReason :: String
ExpectedButGot
Fields failureCallStack :: Maybe CallStack failureValue1 :: ShowEqBox failureValue2 :: ShowEqBox
DidNotExpectButGot
Fields failureCallStack :: Maybe CallStack failureValue1 :: ShowEqBox
GotException
Fields failureCallStack :: Maybe CallStack failureMessage :: Maybe String failureException :: SomeExceptionWithEq
Pending
Fields failureCallStack :: Maybe CallStack failurePendingMessage :: Maybe String
GetContextException
Fields failureCallStack :: Maybe CallStack failureException :: SomeExceptionWithEq
GotAsyncException
Fields failureCallStack :: Maybe CallStack failureMessage :: Maybe String failureAsyncException :: SomeAsyncExceptionWithEq
ChildrenFailed
Fields failureCallStack :: Maybe CallStack failureNumChildren :: Int

Instances

Instances details

Eq FailureReason Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods (==) :: FailureReason -> FailureReason -> Bool # (/=) :: FailureReason -> FailureReason -> Bool #
Show FailureReason Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods showsPrec :: Int -> FailureReason -> ShowS # show :: FailureReason -> String # showList :: [FailureReason] -> ShowS #
Exception FailureReason Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods toException :: FailureReason -> SomeException # fromException :: SomeException -> Maybe FailureReason # displayException :: FailureReason -> String #

data SomeExceptionWithCallStack Source #

A wrapper type for exceptions with attached callstacks. Haskell doesn't currently offer a way to reliably get a callstack from an exception, but if you can throw (or catch+rethrow) this type then we'll unwrap it and present the callstack nicely.

Constructors

forall e.Exception e => SomeExceptionWithCallStack e CallStack

Instances

Instances details

Show SomeExceptionWithCallStack Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods showsPrec :: Int -> SomeExceptionWithCallStack -> ShowS # show :: SomeExceptionWithCallStack -> String # showList :: [SomeExceptionWithCallStack] -> ShowS #
Exception SomeExceptionWithCallStack Source #
Instance details Defined in Test.Sandwich.Types.RunTree Methods toException :: SomeExceptionWithCallStack -> SomeException # fromException :: SomeException -> Maybe SomeExceptionWithCallStack # displayException :: SomeExceptionWithCallStack -> String #

newtype SomeExceptionWithEq Source #

Constructors

SomeExceptionWithEq SomeException

Instances

Instances details

Eq SomeExceptionWithEq Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods (==) :: SomeExceptionWithEq -> SomeExceptionWithEq -> Bool # (/=) :: SomeExceptionWithEq -> SomeExceptionWithEq -> Bool #
Show SomeExceptionWithEq Source #
Instance details Defined in Test.Sandwich.Types.Spec Methods showsPrec :: Int -> SomeExceptionWithEq -> ShowS # show :: SomeExceptionWithEq -> String # showList :: [SomeExceptionWithEq] -> ShowS #

data ExitReason Source #

Constructors

NormalExit
InterruptExit

Instances

Instances details

Eq ExitReason Source #
Instance details Defined in Test.Sandwich.Types.General Methods (==) :: ExitReason -> ExitReason -> Bool # (/=) :: ExitReason -> ExitReason -> Bool #
Show ExitReason Source #
Instance details Defined in Test.Sandwich.Types.General Methods showsPrec :: Int -> ExitReason -> ShowS # show :: ExitReason -> String # showList :: [ExitReason] -> ShowS #