Language.Haskell.TH.TestUtils

This module defines utilites for testing Template Haskell code.

Configuring TestQ

data QState (mode :: MockedMode)

State information for mocking Q functionality.

Constructors

QState

Fields

• mode :: QMode mode
• knownNames :: [(String, Name)]

  Names that can be looked up with lookupTypeName or lookupValueName

• reifyInfo :: [(Name, ReifyInfo)]

  Reification information for Names to return when reify is called.

Instances

Show (QState mode)

Defined in Language.Haskell.TH.TestUtils.QState

Methods

showsPrec :: Int -> QState mode -> ShowS

show :: QState mode -> String

showList :: [QState mode] -> ShowS

Lift (QState mode)

Defined in Language.Haskell.TH.TestUtils.QState

Methods

lift :: QState mode -> Q Exp

data MockedMode

Constructors

FullyMocked

FullyMockedWithIO

NotMocked

data QMode (mode :: MockedMode) where

Constructors

MockQ :: QMode FullyMocked

All Q actions are mocked and IO actions are disallowed.

MockQAllowIO :: QMode FullyMockedWithIO

Same as MockQ, except IO actions are passed through. Useful if your TH code, for example, reads files with runIO.

AllowQ :: QMode NotMocked

No mocking is done. Useful for running Q as normal, but you need to get error messages.

Instances

Show (QMode mode)

Defined in Language.Haskell.TH.TestUtils.QMode

Methods

showsPrec :: Int -> QMode mode -> ShowS

show :: QMode mode -> String

showList :: [QMode mode] -> ShowS

Lift (QMode mode)

Defined in Language.Haskell.TH.TestUtils.QMode

Methods

lift :: QMode mode -> Q Exp

data ReifyInfo

Constructors

ReifyInfo

Fields

• reifyInfoInfo :: Info
• reifyInfoFixity :: Maybe Fixity
• reifyInfoRoles :: Maybe [Role]
• reifyInfoType :: Type

Instances

Show ReifyInfo

Defined in Language.Haskell.TH.TestUtils.QState

Methods

showsPrec :: Int -> ReifyInfo -> ShowS

show :: ReifyInfo -> String

showList :: [ReifyInfo] -> ShowS

Lift ReifyInfo

Defined in Language.Haskell.TH.TestUtils.QState

Methods

lift :: ReifyInfo -> Q Exp

loadNames :: [Name] -> ExpQ

A helper for loading names for reifyInfo

Usage:

QState
  { reifyInfo = $(loadNames [''Int, ''Maybe])
  , ...
  }

unmockedState :: QState NotMocked

A shortcut for defining an unmocked Q.

Running TestQ

runTestQ :: forall mode a. IsMockedMode mode => QState mode -> Q a -> TestQResult mode a

runTestQErr :: forall mode a. (IsMockedMode mode, Show a) => QState mode -> Q a -> TestQResult mode String

tryTestQ :: forall mode a. IsMockedMode mode => QState mode -> Q a -> TestQResult mode (Either String a)