Modulesandwich-0.3.1.0Haskell2010

Test.Sandwich.Misc

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

28 types
2 classes
2 values

Packagesandwich-0.3.1.0
Exports32
LanguageHaskell2010
LicenceBSD-3-Clause
SourceMisc.hs

The example monad

2 declarations

newtypenewtype ExampleT context (m :: Type -> Type) 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

typetype ExampleM context = ExampleT context IO

Spec types

7 declarations

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

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

typetype CoreSpec = Spec BaseContext IO

typetype TopSpec = forall context. (HasBaseContext context, Typeable context) => SpecFree context IO ()

type

type TopSpecWithOptions = forall context. (Typeable context, HasBaseContext context, HasCommandLineOptions context (), HasSomeCommandLineOptions context) => SpecFree context IO ()

type

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

valueisEmptySpec :: Free (SpecCommand context IO) () -> Bool

Command line options

8 declarations

datadata CommandLineOptions a

Constructors

CommandLineOptions
- optFormatter :: FormatterType
- optLogLevel :: Maybe LogLevel
- optVisibilityThreshold :: Maybe Int
- optTreePrune :: [String]
- optTreeFilter :: [String]
- optRepeatCount :: Int
- optFixedRoot :: Maybe String
- optDryRun :: Maybe Bool
- optWarnOnLongExecutionMs :: Maybe Int
- optCancelOnLongExecutionMs :: Maybe Int
- optMarkdownSummaryPath :: Maybe FilePath
- optTuiDebugSocket :: Bool
- optSocketFormatter :: Bool
- optLogLogs :: Bool
- optLogEvents :: Bool
- optLogRtsStats :: Bool
- optLogAsyncs :: Bool
- optListAvailableTests :: Maybe Bool
- optListAvailableTestsJson :: Maybe Bool
- optPrintGoldenFlags :: Maybe Bool
- optPrintQuickCheckFlags :: Maybe Bool
- optPrintHedgehogFlags :: Maybe Bool
- optPrintSlackFlags :: Maybe Bool
- optPrintWebDriverFlags :: Maybe Bool
- optIndividualTestModule :: Maybe IndividualTestModule
- optGoldenOptions :: CommandLineGoldenOptions
- optQuickCheckOptions :: CommandLineQuickCheckOptions
- optHedgehogOptions :: CommandLineHedgehogOptions
- optSlackOptions :: CommandLineSlackOptions
- optWebdriverOptions :: CommandLineWebdriverOptions
- optUserOptions :: a

Instances1Show

Show a => Show (CommandLineOptions a)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata CommandLineQuickCheckOptions

Constructors

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

Instances1Show

Show CommandLineQuickCheckOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata CommandLineHedgehogOptions

Constructors

CommandLineHedgehogOptions
- optHedgehogSeed :: Maybe String
- optHedgehogSize :: Maybe Int
- optHedgehogDiscardLimit :: Maybe Integer
- optHedgehogShrinkLimit :: Maybe Integer
- optHedgehogShrinkRetries :: Maybe Integer

Instances1Show

Show CommandLineHedgehogOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata CommandLineSlackOptions

Constructors

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

Instances1Show

Show CommandLineSlackOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata CommandLineWebdriverOptions

Constructors

CommandLineWebdriverOptions
- optBrowserToUse :: Maybe BrowserToUse
- optChromeNoSandbox :: Bool
- optDisplay :: Maybe DisplayType
- optFluxbox :: Bool
- optIndividualVideos :: Bool
- optErrorVideos :: Bool
- optSeleniumJar :: Maybe FilePath
- optChromeBinary :: Maybe FilePath
- optChromeDriver :: Maybe FilePath
- optFirefoxBinary :: Maybe FilePath
- optGeckoDriver :: Maybe FilePath

Instances1Show

Show CommandLineWebdriverOptionsDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata BrowserToUse

UseChrome UseFirefox

Instances1Show

Show BrowserToUseDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

datadata DisplayType

Current Headless Xvfb

Instances2Read, Show

Read DisplayTypeDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing
Show DisplayTypeDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.ArgParsing

valuecommandLineOptionsWithInfo

:: Parser a
-> Parser (Maybe IndividualTestModule)
-> ParserInfo (CommandLineOptions a)

Labels

4 declarations

datadata Label (l :: Symbol) (a :: k)

Label

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

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

datadata (:>) a b

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

Context classes

6 declarations

datadata BaseContext

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

Instances1HasBaseContext

HasBaseContext BaseContextDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree

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

typetype HasBaseContextMonad context (m :: Type -> Type) = (HasBaseContext context, MonadReader context m)

typetype HasCommandLineOptions context a = HasLabel context "commandLineOptions" (CommandLineOptions a)

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

datadata SomeCommandLineOptions where

Constructors

SomeCommandLineOptions :: CommandLineOptions a -> SomeCommandLineOptions

typetype HasSomeCommandLineOptions context = HasLabel context "someCommandLineOptions" SomeCommandLineOptions

Result types

5 declarations

datadata Result

Instances3Eq, Show

Eq ResultDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show ResultDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show (Async Result)Defined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree · orphan

datadata FailureReason

Constructors

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
- failureCallStack :: Maybe CallStack
- failureMessage :: Maybe String
- failureAsyncException :: SomeAsyncExceptionWithEq
ChildrenFailed
- failureCallStack :: Maybe CallStack
- failureNumChildren :: Int
RawImage
- failureCallStack :: Maybe CallStack
- failureFallback :: String
- failureRawImage :: Image

Instances4Eq, Show, Exception, ToBrickWidget

Eq FailureReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Show FailureReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
Exception FailureReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.Spec
ToBrickWidget FailureReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Formatters.TerminalUI.Draw.ToBrickWidget

datadata SomeExceptionWithCallStack

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

Instances2Show, Exception

Show SomeExceptionWithCallStackDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree
Exception SomeExceptionWithCallStackDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.RunTree

newtypenewtype SomeExceptionWithEq

Constructors

SomeExceptionWithEq SomeException

Instances2Eq, Show

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

datadata ExitReason

NormalExit SignalExit

Instances2Eq, Show

Eq ExitReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.General
Show ExitReasonDefined in sandwich-0.3.1.0 · Test.Sandwich.Types.General