Safe Haskell	None
Language	GHC2021

Hledger.Utils.Test

Synopsis

data Timeout
- = Timeout Integer String
- | NoTimeout
after :: DependencyType -> String -> TestTree -> TestTree
askOption :: IsOption v => (v -> TestTree) -> TestTree
localOption :: IsOption v => v -> TestTree -> TestTree
defaultIngredients :: [Ingredient]
mkTimeout :: Integer -> Timeout
data TestTree
data DependencyType
- = AllSucceed
- | AllFinish
type TestName = String
testGroup :: TestName -> [TestTree] -> TestTree
sequentialTestGroup :: TestName -> DependencyType -> [TestTree] -> TestTree
after_ :: DependencyType -> Expr -> TestTree -> TestTree
includingOptions :: [OptionDescription] -> Ingredient
defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO ()
adjustOption :: IsOption v => (v -> v) -> TestTree -> TestTree
withResource :: IO a -> (a -> IO ()) -> (IO a -> TestTree) -> TestTree
class Assertable t where
- assert :: t -> Assertion
type HasCallStack = ?callStack :: CallStack
type AssertionPredicate = IO Bool
data HUnitFailure = HUnitFailure (Maybe SrcLoc) String
class AssertionPredicable t where
- assertionPredicate :: t -> IO Bool
type Assertion = IO ()
assertFailure :: HasCallStack => String -> IO a
assertBool :: HasCallStack => String -> Bool -> Assertion
assertEqual :: (Eq a, Show a, HasCallStack) => String -> a -> a -> Assertion
(@=?) :: (Eq a, Show a, HasCallStack) => a -> a -> Assertion
(@?=) :: (Eq a, Show a, HasCallStack) => a -> a -> Assertion
(@?) :: (AssertionPredicable t, HasCallStack) => t -> String -> Assertion
assertString :: HasCallStack => String -> Assertion
testCaseSteps :: TestName -> ((String -> IO ()) -> Assertion) -> TestTree
testCase :: TestName -> Assertion -> TestTree
testCaseInfo :: TestName -> IO String -> TestTree
assertLeft :: (HasCallStack, Eq b, Show b) => Either a b -> Assertion
assertRight :: (HasCallStack, Eq a, Show a) => Either a b -> Assertion
assertParse :: (HasCallStack, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> Assertion
assertParseEq :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> a -> Assertion
assertParseEqOn :: (HasCallStack, Eq b, Show b, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> (a -> b) -> b -> Assertion
assertParseError :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> String -> Assertion
assertParseE :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> Assertion
assertParseEqE :: (Default st, Eq a, Show a, HasCallStack) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> a -> Assertion
assertParseErrorE :: (Default st, Eq a, Show a, HasCallStack) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> String -> Assertion
assertParseStateOn :: (HasCallStack, Eq b, Show b, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> (st -> b) -> b -> Assertion

Documentation

data Timeout #

Constructors

Timeout Integer String
NoTimeout

Instances

Instances details

Show Timeout
Instance details Defined in Test.Tasty.Options.Core Methods showsPrec :: Int -> Timeout -> ShowS Source # show :: Timeout -> String Source # showList :: [Timeout] -> ShowS Source #
Eq Timeout
Instance details Defined in Test.Tasty.Options.Core Methods (==) :: Timeout -> Timeout -> Bool Source # (/=) :: Timeout -> Timeout -> Bool Source #
Ord Timeout
Instance details Defined in Test.Tasty.Options.Core Methods compare :: Timeout -> Timeout -> Ordering Source # (<) :: Timeout -> Timeout -> Bool Source # (<=) :: Timeout -> Timeout -> Bool Source # (>) :: Timeout -> Timeout -> Bool Source # (>=) :: Timeout -> Timeout -> Bool Source # max :: Timeout -> Timeout -> Timeout Source # min :: Timeout -> Timeout -> Timeout Source #
IsOption Timeout
Instance details Defined in Test.Tasty.Options.Core Methods defaultValue :: Timeout parseValue :: String -> Maybe Timeout optionName :: Tagged Timeout String optionHelp :: Tagged Timeout String showDefaultValue :: Timeout -> Maybe String optionCLParser :: Parser Timeout

after :: DependencyType -> String -> TestTree -> TestTree #

askOption :: IsOption v => (v -> TestTree) -> TestTree #

localOption :: IsOption v => v -> TestTree -> TestTree #

defaultIngredients :: [Ingredient] #

mkTimeout :: Integer -> Timeout #

data TestTree #

data DependencyType #

Constructors

AllSucceed
AllFinish

Instances

Instances details

Read DependencyType
Instance details Defined in Test.Tasty.Core Methods readsPrec :: Int -> ReadS DependencyType Source # readList :: ReadS [DependencyType] Source # readPrec :: ReadPrec DependencyType Source # readListPrec :: ReadPrec [DependencyType] Source #
Show DependencyType
Instance details Defined in Test.Tasty.Core Methods showsPrec :: Int -> DependencyType -> ShowS Source # show :: DependencyType -> String Source # showList :: [DependencyType] -> ShowS Source #
Eq DependencyType
Instance details Defined in Test.Tasty.Core Methods (==) :: DependencyType -> DependencyType -> Bool Source # (/=) :: DependencyType -> DependencyType -> Bool Source #

type TestName = String #

testGroup :: TestName -> [TestTree] -> TestTree #

sequentialTestGroup :: TestName -> DependencyType -> [TestTree] -> TestTree #

after_ :: DependencyType -> Expr -> TestTree -> TestTree #

includingOptions :: [OptionDescription] -> Ingredient #

defaultMainWithIngredients :: [Ingredient] -> TestTree -> IO () #

adjustOption :: IsOption v => (v -> v) -> TestTree -> TestTree #

withResource :: IO a -> (a -> IO ()) -> (IO a -> TestTree) -> TestTree #

class Assertable t where #

Methods

assert :: t -> Assertion #

Instances

Instances details

Assertable String
Instance details Defined in Test.Tasty.HUnit.Orig Methods assert :: String -> Assertion #
Assertable ()
Instance details Defined in Test.Tasty.HUnit.Orig Methods assert :: () -> Assertion #
Assertable Bool
Instance details Defined in Test.Tasty.HUnit.Orig Methods assert :: Bool -> Assertion #
Assertable t => Assertable (IO t)
Instance details Defined in Test.Tasty.HUnit.Orig Methods assert :: IO t -> Assertion #

type HasCallStack = ?callStack :: CallStack Source #

Request a CallStack.

NOTE: The implicit parameter ?callStack :: CallStack is an implementation detail and should not be considered part of the CallStack API, we may decide to change the implementation in the future.

Since: base-4.9.0.0

type AssertionPredicate = IO Bool #

data HUnitFailure #

Constructors

HUnitFailure (Maybe SrcLoc) String

Instances

Instances details

Exception HUnitFailure
Instance details Defined in Test.Tasty.HUnit.Orig Methods toException :: HUnitFailure -> SomeException Source # fromException :: SomeException -> Maybe HUnitFailure Source # displayException :: HUnitFailure -> String Source # backtraceDesired :: HUnitFailure -> Bool Source #
Show HUnitFailure
Instance details Defined in Test.Tasty.HUnit.Orig Methods showsPrec :: Int -> HUnitFailure -> ShowS Source # show :: HUnitFailure -> String Source # showList :: [HUnitFailure] -> ShowS Source #
Eq HUnitFailure
Instance details Defined in Test.Tasty.HUnit.Orig Methods (==) :: HUnitFailure -> HUnitFailure -> Bool Source # (/=) :: HUnitFailure -> HUnitFailure -> Bool Source #

class AssertionPredicable t where #

Methods

assertionPredicate :: t -> IO Bool #

Instances

Instances details

AssertionPredicable Bool
Instance details Defined in Test.Tasty.HUnit.Orig Methods assertionPredicate :: Bool -> IO Bool #
AssertionPredicable t => AssertionPredicable (IO t)
Instance details Defined in Test.Tasty.HUnit.Orig Methods assertionPredicate :: IO t -> IO Bool #

type Assertion = IO () #

assertFailure :: HasCallStack => String -> IO a #

assertBool :: HasCallStack => String -> Bool -> Assertion #

assertEqual :: (Eq a, Show a, HasCallStack) => String -> a -> a -> Assertion #

(@=?) :: (Eq a, Show a, HasCallStack) => a -> a -> Assertion #

(@?=) :: (Eq a, Show a, HasCallStack) => a -> a -> Assertion #

(@?) :: (AssertionPredicable t, HasCallStack) => t -> String -> Assertion #

assertString :: HasCallStack => String -> Assertion #

testCaseSteps :: TestName -> ((String -> IO ()) -> Assertion) -> TestTree #

testCase :: TestName -> Assertion -> TestTree #

testCaseInfo :: TestName -> IO String -> TestTree #

assertLeft :: (HasCallStack, Eq b, Show b) => Either a b -> Assertion Source #

Assert any Left value.

assertRight :: (HasCallStack, Eq a, Show a) => Either a b -> Assertion Source #

Assert any Right value.

assertParse :: (HasCallStack, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> Assertion Source #

Assert that this stateful parser runnable in IO successfully parses all of the given input text, showing the parse error if it fails. Suitable for hledger's JournalParser parsers.

assertParseEq :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> a -> Assertion Source #

Assert a parser produces an expected value.

assertParseEqOn :: (HasCallStack, Eq b, Show b, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> (a -> b) -> b -> Assertion Source #

Like assertParseEq, but transform the parse result with the given function before comparing it.

assertParseError :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> String -> Assertion Source #

Assert that this stateful parser runnable in IO fails to parse the given input text, with a parse error containing the given string.

assertParseE :: (HasCallStack, Eq a, Show a, Default st) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> Assertion Source #

assertParseEqE :: (Default st, Eq a, Show a, HasCallStack) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> a -> Assertion Source #

assertParseErrorE :: (Default st, Eq a, Show a, HasCallStack) => StateT st (ParsecT HledgerParseErrorData Text (ExceptT FinalParseError IO)) a -> Text -> String -> Assertion Source #

assertParseStateOn :: (HasCallStack, Eq b, Show b, Default st) => StateT st (ParsecT HledgerParseErrorData Text IO) a -> Text -> (st -> b) -> b -> Assertion Source #

Run a stateful parser in IO like assertParse, then assert that the final state (the wrapped state, not megaparsec's internal state), transformed by the given function, matches the given expected value.