-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | A simple and intuitive library for automated testing.
--   
--   Chell is a simple and intuitive library for automated testing. It
--   natively supports assertion-based testing, and can use companion
--   libraries such as <tt>chell-quickcheck</tt> to support more complex
--   testing strategies.
--   
--   An example test suite, which verifies the behavior of artithmetic
--   operators.
--   
--   <pre>
--   {-# LANGUAGE TemplateHaskell #-}
--   
--   import Test.Chell
--   
--   tests_Math :: Suite
--   tests_Math = suite "math"
--       test_Addition
--       test_Subtraction
--   
--   test_Addition :: Test
--   test_Addition = assertions "addition" $ do
--       $expect (equal (2 + 1) 3)
--       $expect (equal (1 + 2) 3)
--   
--   test_Subtraction :: Test
--   test_Subtraction = assertions "subtraction" $ do
--       $expect (equal (2 - 1) 1)
--       $expect (equal (1 - 2) (-1))
--   
--   main :: IO ()
--   main = defaultMain [tests_Math]
--   </pre>
--   
--   <pre>
--   $ ghc --make chell-example.hs
--   $ ./chell-example
--   PASS: 2 tests run, 2 tests passed
--   </pre>
@package chell
@version 0.3


-- | Chell is a simple and intuitive library for automated testing. It
--   natively supports assertion-based testing, and can use companion
--   libraries such as <tt>chell-quickcheck</tt> to support more complex
--   testing strategies.
--   
--   An example test suite, which verifies the behavior of artithmetic
--   operators.
--   
--   <pre>
--   {-# LANGUAGE TemplateHaskell #-}
--   
--   import Test.Chell
--   
--   tests_Math :: Suite
--   tests_Math = <a>suite</a> "math"
--       test_Addition
--       test_Subtraction
--   
--   test_Addition :: Test
--   test_Addition = <a>assertions</a> "addition" $ do
--       $<a>expect</a> (<a>equal</a> (2 + 1) 3)
--       $<a>expect</a> (<a>equal</a> (1 + 2) 3)
--   
--   test_Subtraction :: Test
--   test_Subtraction = <a>assertions</a> "subtraction" $ do
--       $<a>expect</a> (<a>equal</a> (2 - 1) 1)
--       $<a>expect</a> (<a>equal</a> (1 - 2) (-1))
--   
--   main :: IO ()
--   main = <a>defaultMain</a> [tests_Math]
--   </pre>
--   
--   <pre>
--   $ ghc --make chell-example.hs
--   $ ./chell-example
--   PASS: 2 tests run, 2 tests passed
--   </pre>
module Test.Chell

-- | A simple default main function, which runs a list of tests and logs
--   statistics to stdout.
defaultMain :: [Suite] -> IO ()

-- | A suite is a node in a hierarchy of tests, similar to a directory in
--   the filesystem. Each suite has a name and a list of children, which
--   are either suites or tests.
data Suite

-- | Get a suite's name. Suite names may be any string, but are typically
--   plain ASCII so users can easily type them on the command line.
--   
--   <pre>
--   $ ghci chell-example.hs
--   Ok, modules loaded: Main.
--   
--   *Main&gt; suiteName tests_Math
--   "math"
--   </pre>
suiteName :: Suite -> String

-- | Get the full list of tests contained within this <a>Suite</a>. Each
--   test is given its full name within the test hierarchy, where names are
--   separated by periods.
--   
--   <pre>
--   $ ghci chell-example.hs
--   Ok, modules loaded: Main.
--   
--   *Main&gt; suiteTests tests_Math
--   [Test "math.addition",Test "math.subtraction"]
--   </pre>
suiteTests :: Suite -> [Test]

-- | See <a>suite</a>.
class BuildSuite a

-- | See <a>suite</a>.
class SuiteOrTest a

-- | Define a new <a>Suite</a>, with the given name and children.
--   
--   The type of this function allows any number of children to be added,
--   without requiring them to be homogenous types.
--   
--   <pre>
--   test_Addition :: Test
--   test_Subtraction :: Test
--   test_Show :: Test
--   
--   tests_Math :: Suite
--   tests_Math = <a>suite</a> "math"
--       test_Addition
--       test_Subtraction
--   
--   tests_Prelude :: Suite
--   tests_Prelude = <a>suite</a> "prelude"
--       tests_Math
--       test_Show
--   </pre>
suite :: BuildSuite a => String -> a

-- | Conditionally skip tests. Use this to avoid commenting out tests which
--   are currently broken, or do not work on the current platform.
--   
--   <pre>
--   tests :: Suite
--   tests = <a>suite</a> "tests"
--       test_Foo
--       (<a>skipIf</a> builtOnUnix test_WindowsSpecific)
--       test_Bar
--   </pre>
skipIf :: SuiteOrTest a => Bool -> a -> a

-- | Conditionally skip tests, depending on the result of a runtime check.
--   The predicate is checked before each test is started.
--   
--   <pre>
--   tests :: Suite
--   tests = <a>suite</a> "tests"
--       test_Foo
--       (<a>skipWhen</a> noNetwork test_PingGoogle)
--       test_Bar
--   </pre>
skipWhen :: SuiteOrTest a => IO Bool -> a -> a

-- | See <a>assertions</a>.
data Assertions a

-- | Convert a sequence of pass/fail assertions into a runnable test.
--   
--   <pre>
--   test_Equality :: Test
--   test_Equality = assertions "equality" $ do
--       $assert (1 == 1)
--       $assert (equal 1 1)
--   </pre>
assertions :: String -> Assertions a -> Test

-- | See <a>assert</a> and <a>expect</a>.
class IsAssertion a

-- | A single pass/fail assertion. Failed assertions include an explanatory
--   message.
data Assertion

-- | See <a>Assertion</a>.
assertionPassed :: Assertion

-- | See <a>Assertion</a>.
assertionFailed :: String -> Assertion

-- | Check an assertion. If the assertion fails, the test will immediately
--   fail.
--   
--   The assertion to check can be a boolean value, an <a>Assertion</a>, or
--   an IO action returning one of the above.
--   
--   <a>assert</a> is a Template Haskell macro, to retain the source-file
--   location from which it was used. Its effective type is:
--   
--   <pre>
--   $assert :: <a>IsAssertion</a> assertion =&gt; assertion -&gt; <a>Assertions</a> ()
--   </pre>
assert :: Q Exp

-- | Check an assertion. If the assertion fails, the test will continue to
--   run until it finishes, a call to <a>assert</a> fails, or the test runs
--   <a>die</a>.
--   
--   The assertion to check can be a boolean value, an <a>Assertion</a>, or
--   an IO action returning one of the above.
--   
--   <a>expect</a> is a Template Haskell macro, to retain the source-file
--   location from which it was used. Its effective type is:
--   
--   <pre>
--   $expect :: <a>IsAssertion</a> assertion =&gt; assertion -&gt; <a>Assertions</a> ()
--   </pre>
expect :: Q Exp

-- | Cause a test to immediately fail, with a message.
--   
--   <a>die</a> is a Template Haskell macro, to retain the source-file
--   location from which it was used. Its effective type is:
--   
--   <pre>
--   $die :: <a>String</a> -&gt; <a>Assertions</a> a
--   </pre>
die :: Q Exp

-- | Print a message from within a test. This is just a helper for
--   debugging, so you don't have to import <tt>Debug.Trace</tt>. Messages
--   will be prefixed with the filename and line number where
--   <tt>$trace</tt> was called.
--   
--   <a>trace</a> is a Template Haskell macro, to retain the source-file
--   location from which it was used. Its effective type is:
--   
--   <pre>
--   $trace :: <a>String</a> -&gt; <a>Assertions</a> ()
--   </pre>
trace :: Q Exp

-- | Attach a note to a test run. Notes will be printed to stdout and
--   included in reports, even if the test fails or aborts. Notes are
--   useful for debugging failing tests.
note :: String -> String -> Assertions ()

-- | Register an IO action to be run after the test completes. This action
--   will run even if the test failed or aborted.
afterTest :: IO () -> Assertions ()

-- | Require an <a>Either</a> value to be <a>Left</a>, and return its
--   contents. If the value is <a>Right</a>, fail the test.
--   
--   <a>requireLeft</a> is a Template Haskell macro, to retain the
--   source-file location from which it was used. Its effective type is:
--   
--   <pre>
--   $requireLeft :: <a>Show</a> b =&gt; <a>Either</a> a b -&gt; <a>Assertions</a> a
--   </pre>
requireLeft :: Q Exp

-- | Require an <a>Either</a> value to be <a>Right</a>, and return its
--   contents. If the value is <a>Left</a>, fail the test.
--   
--   <a>requireRight</a> is a Template Haskell macro, to retain the
--   source-file location from which it was used. Its effective type is:
--   
--   <pre>
--   $requireRight :: <a>Show</a> a =&gt; <a>Either</a> a b -&gt; <a>Assertions</a> b
--   </pre>
requireRight :: Q Exp

-- | Assert that two values are equal.
equal :: (Show a, Eq a) => a -> a -> Assertion

-- | Assert that two values are not equal.
notEqual :: (Eq a, Show a) => a -> a -> Assertion

-- | Assert that two values are within some delta of each other.
equalWithin :: (Real a, Show a) => a -> a -> a -> Assertion

-- | Assert that some value is <tt>Just</tt>.
just :: Maybe a -> Assertion

-- | Assert that some value is <tt>Nothing</tt>.
nothing :: Show a => Maybe a -> Assertion

-- | Assert that some value is <tt>Left</tt>.
left :: Show b => Either a b -> Assertion

-- | Assert that some value is <tt>Right</tt>.
right :: Show a => Either a b -> Assertion

-- | Assert that some computation throws an exception matching the provided
--   predicate. This is mostly useful for exception types which do not have
--   an instance for <tt>Eq</tt>, such as <tt><a>ErrorCall</a></tt>.
throws :: Exception err => (err -> Bool) -> IO a -> IO Assertion

-- | Assert that some computation throws an exception equal to the given
--   exception. This is better than just checking that the correct type was
--   thrown, because the test can also verify the exception contains the
--   correct information.
throwsEq :: (Eq err, Exception err, Show err) => err -> IO a -> IO Assertion

-- | Assert a value is greater than another.
greater :: (Ord a, Show a) => a -> a -> Assertion

-- | Assert a value is greater than or equal to another.
greaterEqual :: (Ord a, Show a) => a -> a -> Assertion

-- | Assert a value is less than another.
lesser :: (Ord a, Show a) => a -> a -> Assertion

-- | Assert a value is less than or equal to another.
lesserEqual :: (Ord a, Show a) => a -> a -> Assertion

-- | Assert that two containers have the same items, in any order.
sameItems :: (Foldable container, Show item, Ord item) => container item -> container item -> Assertion

-- | Assert that two containers have the same items, in the same order.
equalItems :: (Foldable container, Show item, Ord item) => container item -> container item -> Assertion

-- | Class for types which can be treated as text; see <a>equalLines</a>.
class IsText a

-- | Assert that two pieces of text are equal. This uses a diff algorithm
--   to check line-by-line, so the error message will be easier to read on
--   large inputs.
equalLines :: (Ord a, IsText a) => a -> a -> Assertion

-- | Variant of <a>equalLines</a> which allows a user-specified
--   line-splitting predicate.
equalLinesWith :: Ord a => (a -> [String]) -> a -> a -> Assertion

-- | A <a>Test</a> is, essentially, an IO action that returns a
--   <a>TestResult</a>. Tests are aggregated into suites (see
--   <a>Suite</a>).
data Test

-- | Define a test, with the given name and implementation.
test :: String -> (TestOptions -> IO TestResult) -> Test

-- | Get the name a test was given when it was defined; see <a>test</a>.
testName :: Test -> String

-- | Run a test, wrapped in error handlers. This will return
--   <a>TestAborted</a> if the test throws an exception or times out.
runTest :: Test -> TestOptions -> IO TestResult

-- | The result of running a test.
--   
--   To support future extensions to the testing API, any users of this
--   module who pattern-match against the <a>TestResult</a> constructors
--   should include a default case. If no default case is provided, a
--   warning will be issued.
data TestResult

-- | The test passed, and generated the given notes.
TestPassed :: [(String, String)] -> TestResult

-- | The test did not run, because it was skipped with <a>skipIf</a> or
--   <a>skipWhen</a>.
TestSkipped :: TestResult

-- | The test failed, generating the given notes and failures.
TestFailed :: [(String, String)] -> [Failure] -> TestResult

-- | The test aborted with an error message, and generated the given notes.
TestAborted :: [(String, String)] -> String -> TestResult

-- | Contains details about a test failure.
data Failure

-- | An empty <a>Failure</a>; use the field accessors to populate this
--   value.
failure :: Failure

-- | If given, the location of the failing assertion, expectation, etc.
--   
--   <a>failureLocation</a> is a field accessor, and can be used to update
--   a <a>Failure</a> value.
failureLocation :: Failure -> Maybe Location

-- | If given, a message which explains why the test failed.
--   
--   <a>failureMessage</a> is a field accessor, and can be used to update a
--   <a>Failure</a> value.
failureMessage :: Failure -> String

-- | Contains details about a location in the test source file.
data Location

-- | An empty <a>Location</a>; use the field accessors to populate this
--   value.
location :: Location

-- | A path to a source file, or empty if not provided.
--   
--   <a>locationFile</a> is a field accessor, and can be used to update a
--   <a>Location</a> value.
locationFile :: Location -> String

-- | A Haskell module name, or empty if not provided.
--   
--   <a>locationModule</a> is a field accessor, and can be used to update a
--   <a>Location</a> value.
locationModule :: Location -> String

-- | A line number, or Nothing if not provided.
--   
--   <a>locationLine</a> is a field accessor, and can be used to update a
--   <a>Location</a> value.
locationLine :: Location -> Maybe Integer

-- | Test options are passed to each test, and control details about how
--   the test should be run.
data TestOptions

-- | Default test options.
--   
--   <pre>
--   $ ghci
--   Prelude&gt; import Test.Chell
--   
--   Test.Chell&gt; testOptionSeed defaultTestOptions
--   0
--   
--   Test.Chell&gt; testOptionTimeout defaultTestOptions
--   Nothing
--   </pre>
defaultTestOptions :: TestOptions

-- | Get the RNG seed for this test run. The seed is generated once, in
--   <tt>defaultMain</tt>, and used for all tests. It is also logged to
--   reports using a note.
--   
--   When using <tt>defaultMain</tt>, users may specify a seed using the
--   <tt>--seed</tt> command-line option.
--   
--   <a>testOptionSeed</a> is a field accessor, and can be used to update a
--   <a>TestOptions</a> value.
testOptionSeed :: TestOptions -> Int

-- | An optional timeout, in millseconds. Tests which run longer than this
--   timeout will be aborted.
--   
--   When using <tt>defaultMain</tt>, users may specify a timeout using the
--   <tt>--timeout</tt> command-line option.
--   
--   <a>testOptionTimeout</a> is a field accessor, and can be used to
--   update a <a>TestOptions</a> value.
testOptionTimeout :: TestOptions -> Maybe Int
instance Eq Assertion
instance Show Assertion
instance IsText ByteString
instance IsText ByteString
instance IsText Text
instance IsText Text
instance IsText String
instance MonadIO Assertions
instance Monad Assertions
instance Applicative Assertions
instance Functor Assertions
instance IsAssertion a => IsAssertion (IO a)
instance IsAssertion Bool
instance IsAssertion Assertion