Test.DocTest.Internal.Runner

Documentation

data FromSetup

Whether an "example" is part of setup block

Constructors

FromSetup

NotFromSetup

data Summary

Summary of a test run.

Constructors

Summary

Fields

• sExamples :: Int

  Total number of lines of examples (excluding setup)

• sTried :: Int

  Executed sTried lines so far

• sErrors :: Int

  Couldn't execute sErrors examples

• sFailures :: Int

  Got unexpected output for sFailures examples

Instances

Eq Summary

Defined in Test.DocTest.Internal.Runner

Methods

(==) :: Summary -> Summary -> Bool

(/=) :: Summary -> Summary -> Bool

Show Summary

Format a summary.

Defined in Test.DocTest.Internal.Runner

Methods

showsPrec :: Int -> Summary -> ShowS

show :: Summary -> String

showList :: [Summary] -> ShowS

Semigroup Summary

Defined in Test.DocTest.Internal.Runner

Methods

(<>) :: Summary -> Summary -> Summary

sconcat :: NonEmpty Summary -> Summary

stimes :: Integral b => b -> Summary -> Summary

Monoid Summary

Sum up summaries.

Defined in Test.DocTest.Internal.Runner

Methods

mempty :: Summary

mappend :: Summary -> Summary -> Summary

mconcat :: [Summary] -> Summary

emptySummary :: Summary

runModules

Arguments

:: ModuleConfig

Configuration options specific to module

-> Maybe Int

Number of threads to use. Defaults to getNumProcessors.

-> Bool

Verbose

-> Bool

Implicit Prelude

-> [String]

Arguments passed to the GHCi process.

-> Bool

Quiet mode activated

-> [Module [Located DocTest]]

Modules under test

-> IO Summary

Run all examples from a list of modules.

count :: Module [Located DocTest] -> Int

Count number of expressions in given module.

type Report = StateT ReportState IO

A monad for generating test reports.

data ReportState

Constructors

ReportState

Fields

• reportStateCount :: Int

  characters on the current line

• reportStateInteractive :: Bool

  should intermediate results be printed?

• reportStateVerbose :: Bool
• reportStateQuiet :: Bool
• reportStateSummary :: Summary

  test summary

report :: String -> Report ()

Add output to the report.

report_ :: String -> Report ()

Add intermediate output to the report.

This will be overwritten by subsequent calls to report/report_. Intermediate out may not contain any newlines.

overwrite :: String -> Report ()

Add output to the report, overwrite any intermediate out.

shuffle :: Int -> [a] -> [a]

Shuffle a list given a seed for an RNG

runModule :: ModuleConfig -> Bool -> [String] -> Chan ReportUpdate -> Module [Located DocTest] -> IO ()

Run all examples from given module.

data ReportUpdate

Constructors

UpdateSuccess FromSetup Location

Test succeeded

UpdateFailure FromSetup Location Expression [String]

Test failed with unexpected result

UpdateError FromSetup Location Expression String

Test failed with an error

UpdateVerbose String

Message to send when verbose output is activated

UpdateModuleDone

All examples tested in module

UpdateStart Location Expression String

Indicate test has started executing (verbose output)

UpdateInternalError FromSetup (Module [Located DocTest]) SomeException

Exception caught while executing internal code

UpdateImportError ModuleName (Either String String)

Could not import module

UpdateOptionError Location String

Unrecognized flag in module specific option

makeThreadPool :: Int -> (Chan ReportUpdate -> Module [Located DocTest] -> IO ()) -> IO (Chan (Module [Located DocTest]), Chan ReportUpdate)

reportStart :: Location -> Expression -> String -> Report ()

reportFailure :: FromSetup -> Location -> Expression -> [String] -> Report ()

reportError :: FromSetup -> Location -> Expression -> String -> Report ()

reportOptionError :: Location -> String -> Report ()

reportInternalError :: FromSetup -> Module a -> SomeException -> Report ()

reportImportError :: ModuleName -> Either String String -> Report ()

reportSuccess :: FromSetup -> Location -> Report ()

verboseReport :: String -> Report ()

updateSummary :: FromSetup -> Summary -> Report ()

reportProgress :: Report ()

runTestGroup :: FromSetup -> Bool -> Interpreter -> IO () -> Chan ReportUpdate -> [Located DocTest] -> IO Bool

Run given test group.

The interpreter state is zeroed with :reload first. This means that you can reuse the same Interpreter for several test groups.

runExampleGroup :: FromSetup -> Bool -> Interpreter -> Chan ReportUpdate -> [Located Interaction] -> IO Bool

Execute all expressions from given example in given Interpreter and verify the output.

safeEvalWith :: Bool -> Interpreter -> String -> IO (Either String String)