-- Hoogle documentation, generated by Haddock -- See Hoogle, http://www.haskell.org/hoogle/ -- | The Haskell Test Framework -- -- The Haskell Test Framework (HTF for short) lets you define unit -- tests (http://hunit.sourceforge.net), QuickCheck properties -- (http://www.cs.chalmers.se/~rjmh/QuickCheck/), and black box -- tests in an easy and convenient way. HTF uses a custom preprocessor -- that collects test definitions automatically. Furthermore, the -- preprocessor allows HTF to report failing test cases with exact file -- name and line number information. Additionally, HTF tries to produce -- highly readable output for failing tests: for example, it colors and -- pretty prints expected and actual results and provides a diff between -- the two values. -- -- The documentation of the Test.Framework.Tutorial module -- provides a tutorial for HTF. There is also a slightly out-dated blog -- article -- (http://factisresearch.blogspot.de/2011/10/new-version-of-htf-with-diffs-colors.html) -- demonstrating HTF's coloring, pretty-printing and diff functionality. -- -- HEADS UP, backwards incomatibility with prior versions: -- -- In version 0.10.0.0, the following changes could break code compiled -- against version 0.9.*: -- -- -- -- Starting with version 0.9.0.0, HTF uses a new strategy for collecting -- the testcases defined in your project (see -- Test.Framework.Tutorial for a description of this strategy). If -- you used version 0.8.* or earlier of HTF, this will break your -- build! However, it's rather easy to bring you project in line with -- the new HTF version. Here are the steps that will most likely resolve -- your backwards incompatibility problems: -- -- @package HTF @version 0.10.0.1 -- | This module defines the Pretty type class. The assert functions -- from HUnitWrapper use the pretty-printing functionality -- provided by this type class so as to provide nicely formatted error -- messages. -- -- Additionally, this module re-exports the standard Haskell -- pretty-printing module PrettyPrint module Test.Framework.Pretty -- | A type class for pretty-printable things. Minimal complete definition: -- pretty. class Pretty a where prettyList l = char '[' <> vcat (punctuate comma (map pretty l)) <> char ']' showPretty = render . pretty pretty :: Pretty a => a -> Doc prettyList :: Pretty a => [a] -> Doc showPretty :: Pretty a => a -> String -- | Utility function for inserting a = between two Doc -- values. (<=>) :: Doc -> Doc -> Doc instance Pretty Bool instance Pretty Int instance Pretty a => Pretty [a] instance Pretty Char -- | This module defines types and functions dealing with source code -- locations. module Test.Framework.Location -- | An abstract type representing locations in a file. data Location -- | The unknown location (file ? and line 0). unknownLocation :: Location -- | Extract the file name of a Location. fileName :: Location -> String -- | Extract the line number of a Location. lineNumber :: Location -> Int -- | Render a Location as a String. showLoc :: Location -> String -- | Create a new location. makeLoc :: String -> Int -> Location instance Eq Location instance Ord Location instance Show Location instance Read Location -- | This module defines types (and small auxiliary functions) for -- organizing tests, for configuring the execution of tests, and for -- representing and reporting their results. module Test.Framework.TestTypes -- | Type for naming tests. type TestID = String -- | An assertion is just an IO action. type Assertion = IO () -- | Abstract type for tests and their results. data Test BaseTest :: TestSort -> TestID -> (Maybe Location) -> Assertion -> Test CompoundTest :: TestSuite -> Test -- | Abstract type for test suites and their results. data TestSuite TestSuite :: TestID -> [Test] -> TestSuite AnonTestSuite :: [Test] -> TestSuite -- | Type for distinguishing different sorts of tests. data TestSort UnitTest :: TestSort QuickCheckTest :: TestSort BlackBoxTest :: TestSort -- | A type denoting the hierarchical name of a test. data TestPath TestPathBase :: TestID -> TestPath TestPathCompound :: (Maybe TestID) -> TestPath -> TestPath -- | Generic type for flattened tests and their results. data GenFlatTest a FlatTest :: TestSort -> TestPath -> Maybe Location -> a -> GenFlatTest a -- | The sort of the test. ft_sort :: GenFlatTest a -> TestSort -- | Hierarchival path. ft_path :: GenFlatTest a -> TestPath -- | Place of definition. ft_location :: GenFlatTest a -> Maybe Location -- | A generic payload. ft_payload :: GenFlatTest a -> a -- | Flattened representation of tests. type FlatTest = GenFlatTest Assertion -- | A filter is a predicate on FlatTest. If the predicate is -- True, the flat test is run. type TestFilter = FlatTest -> Bool -- | Splits a TestPath into a list of test identifiers. testPathToList :: TestPath -> [Maybe TestID] -- | Creates a string representation from a TestPath. flatName :: TestPath -> String -- | The TR (test runner) monad. type TR = RWST TestConfig () TestState IO -- | The state type for the TR monad. data TestState TestState :: [FlatTestResult] -> Int -> TestState -- | Results collected so far. ts_results :: TestState -> [FlatTestResult] -- | Current index for splitted output. ts_index :: TestState -> Int -- | The initial test state. initTestState :: TestState -- | Configuration of test execution. data TestConfig TestConfig :: Bool -> TestOutput -> TestFilter -> [TestReporter] -> TestConfig -- | If set, displays messages only for failed tests. tc_quiet :: TestConfig -> Bool -- | Output destination of progress and result messages. tc_output :: TestConfig -> TestOutput -- | Filter for the tests to run. tc_filter :: TestConfig -> TestFilter -- | Test reporters to use. tc_reporters :: TestConfig -> [TestReporter] -- | The destination of progress and result messages from HTF. data TestOutput -- | Output goes to Handle, boolean flag indicates whether the -- handle should be closed at the end. TestOutputHandle :: Handle -> Bool -> TestOutput -- | Output goes to files whose names are derived from FilePath by -- appending a number to it. Numbering starts at zero. TestOutputSplitted :: FilePath -> TestOutput -- | Reports the IDs of all tests available. type ReportAllTests = [FlatTest] -> TR () -- | Signals that test execution is about to start. type ReportGlobalStart = [FlatTest] -> TR () -- | Reports the start of a single test. type ReportTestStart = FlatTest -> TR () -- | Reports the result of a single test. type ReportTestResult = FlatTestResult -> TR () -- | Reports the overall results of all tests. type ReportGlobalResults = Milliseconds -> [FlatTestResult] -> [FlatTestResult] -> [FlatTestResult] -> [FlatTestResult] -> TR () -- | A TestReporter provides hooks to customize the output of HTF. data TestReporter TestReporter :: String -> ReportAllTests -> ReportGlobalStart -> ReportTestStart -> ReportTestResult -> ReportGlobalResults -> TestReporter tr_id :: TestReporter -> String -- | Called to report the IDs of all tests available. tr_reportAllTests :: TestReporter -> ReportAllTests -- | Called to report the start of test execution. tr_reportGlobalStart :: TestReporter -> ReportGlobalStart -- | Called to report the start of a single test. tr_reportTestStart :: TestReporter -> ReportTestStart -- | Called to report the result of a single test. tr_reportTestResult :: TestReporter -> ReportTestResult -- | Called to report the overall results of all tests. tr_reportGlobalResults :: TestReporter -> ReportGlobalResults -- | The summary result of a test. data TestResult Pass :: TestResult Pending :: TestResult Fail :: TestResult Error :: TestResult -- | The result of running a FlatTest type FlatTestResult = GenFlatTest RunResult -- | A type synonym for time in milliseconds. type Milliseconds = Int -- | The result of a test run. data RunResult RunResult :: TestResult -> Maybe Location -> [(Maybe String, Location)] -> String -> Milliseconds -> RunResult -- | The summary result of the test. rr_result :: RunResult -> TestResult -- | The location where the test failed (if applicable). rr_location :: RunResult -> Maybe Location -- | Information about the callers of the location where the test failed rr_callers :: RunResult -> [(Maybe String, Location)] -- | A message describing the result. rr_message :: RunResult -> String -- | Execution time in milliseconds. rr_wallTimeMs :: RunResult -> Milliseconds instance Eq TestSort instance Show TestSort instance Read TestSort instance Show TestResult instance Read TestResult instance Eq TestResult instance Show TestOutput instance Eq TestOutput instance Eq TestReporter instance Show TestReporter instance Show TestConfig -- | HTF's machine-readable output is a sequence of JSON messages. Each -- message is terminated by a newline followed by two semicolons followed -- again by a newline. -- -- There are four types of JSON messages. Each JSON object has a -- type attribute denoting this type. The types are: -- test-start, test-end, and test-list, -- test-results. Their haskell representations are -- TestStartEventObj, TestEndEventObj, TestListObj, -- and TestResultsObj. The corresponding JSON rendering is defined -- in this module. -- -- -- -- 
--   {"test": {"flatName": "Main:nonEmpty",
--             "location": {"file": "Tutorial.hs", "line": 17},
--             "path": ["Main","nonEmpty"],
--             "sort": "unit-test"},
--    "type":"test-start"}
--
-- -- -- -- 
--   {"result": "pass",
--    "message":"",
--    "test":{"flatName": "Main:nonEmpty",
--            "location": {"file": "Tutorial.hs", "line": 17},
--            "path": ["Main","nonEmpty"],
--            "sort": "unit-test"},
--    "wallTime": 0,  // in milliseconds
--    "type": "test-end",
--    "location":null}
--
-- -- -- -- 
--   {"failures": 0,
--    "passed": 4,
--    "pending": 0,
--    "wallTime": 39, // in milliseconds
--    "errors": 0,
--    "type":"test-results"}
--
-- -- -- -- 
--   {"tests": [{"flatName":"Main:nonEmpty","location":{"file":"Tutorial.hs","line":17},"path":["Main","nonEmpty"],"sort":"unit-test"},
--              {"flatName":"Main:empty","location":{"file":"Tutorial.hs","line":19},"path":["Main","empty"],"sort":"unit-test"},
--              {"flatName":"Main:reverse","location":{"file":"Tutorial.hs","line":22},"path":["Main","reverse"],"sort":"quickcheck-property"},
--              {"flatName":"Main:reverseReplay","location":{"file":"Tutorial.hs","line":24},"path":["Main","reverseReplay"],"sort":"quickcheck-property"}],
--    "type":"test-list"}
--
-- -- For an exact specification, please have a look at the code of this -- module. module Test.Framework.JsonOutput data TestStartEventObj data TestEndEventObj data TestListObj data TestObj data TestResultsObj mkTestStartEventObj :: FlatTest -> String -> TestStartEventObj mkTestEndEventObj :: FlatTestResult -> String -> TestEndEventObj mkTestListObj :: [(FlatTest, String)] -> TestListObj mkTestResultsObj :: Milliseconds -> Int -> Int -> Int -> Int -> TestResultsObj decodeObj :: HTFJsonObj a => a -> ByteString class ToJSON a => HTFJsonObj a instance ToJSON Location instance ToJSON TestSort instance ToJSON TestPath instance ToJSON TestObj instance HTFJsonObj TestResultsObj instance ToJSON TestResultsObj instance HTFJsonObj TestListObj instance ToJSON TestListObj instance ToJSON TestResult instance HTFJsonObj TestEndEventObj instance ToJSON TestEndEventObj instance HTFJsonObj TestStartEventObj instance ToJSON TestStartEventObj -- | This module defines functions for notifying all test reporters -- registered about particular events in the lifecycle of a test run. -- -- Further, it defines the standard test reporters for HTF's various -- output formats. module Test.Framework.TestReporter -- | Invokes tr_reportAllTests on all test reporters registered. reportAllTests :: ReportAllTests -- | Invokes tr_reportGlobalStart on all test reporters registered. reportGlobalStart :: ReportGlobalStart -- | Invokes tr_reportTestStart on all test reporters registered. reportTestStart :: ReportTestStart -- | Invokes tr_reportTestResult on all test reporters registered. reportTestResult :: ReportTestResult -- | Invokes tr_reportGlobalResults on all test reporters -- registered. reportGlobalResults :: ReportGlobalResults -- | The default test reporters for HTF. defaultTestReporters :: Bool -> Bool -> [TestReporter] instance Eq ReportLevel instance Ord ReportLevel -- | This module defines the commandline options of the test driver -- provided by HTF. module Test.Framework.CmdlineOptions -- | Commandline options for running tests. data CmdlineOptions CmdlineOptions :: Bool -> TestFilter -> Bool -> [String] -> Bool -> Maybe Bool -> Maybe FilePath -> Bool -> Bool -> CmdlineOptions -- | Be quiet or not. opts_quiet :: CmdlineOptions -> Bool -- | Run only tests matching this filter. opts_filter :: CmdlineOptions -> TestFilter -- | If True, display a help message and exit. opts_help :: CmdlineOptions -> Bool -- | Regular expressions matching test names which should not run. , -- opts_threads :: Maybe Int -- ^ Use Just i for parallel -- execution with i threads, Nothing for sequential -- execution (currently unused). opts_negated :: CmdlineOptions -> [String] -- | Format output for machines (JSON format) or humans. See -- JsonOutput for a definition of the JSON format. opts_machineOutput :: CmdlineOptions -> Bool -- | Use Just b to enable/disable use of colors, Nothing -- infers the use of colors. opts_useColors :: CmdlineOptions -> Maybe Bool -- | The output file, defaults to stdout opts_outputFile :: CmdlineOptions -> Maybe FilePath -- | If True, lists all tests available and exits. opts_listTests :: CmdlineOptions -> Bool -- | If True, each message is sent to a new ouput file (derived by -- appending an index to opts_outputFile). opts_split :: CmdlineOptions -> Bool -- | The default CmdlineOptions. defaultCmdlineOptions :: CmdlineOptions -- | Parse commandline arguments into CmdlineOptions. Here's a -- synopsis of the format of the commandline arguments: -- -- 
--   USAGE: COMMAND [OPTION ...] PATTERN ...
--   
--     where PATTERN is a posix regular expression matching
--     the names of the tests to run.
--   
--     -q          --quiet             only display errors
--     -n PATTERN  --not=PATTERN       tests to exclude
--     -l          --list              list all matching tests
--     -o FILE     --output-file=FILE  name of output file
--                 --json              output results in machine-readable JSON format
--                 --split             splits results in separate files to avoid file locking (requires -o/--output-file)
--                 --colors=BOOL       use colors or not
--     -h          --help              display this message
--
parseTestArgs :: [String] -> Either String CmdlineOptions -- | The string displayed for the --help option. helpString :: String -- | Turn the CmdlineOptions into a TestConfig. testConfigFromCmdlineOptions :: CmdlineOptions -> IO TestConfig -- | This module defines function for running a set of tests. Furthermore, -- it provides functionality for organzing tests into a hierarchical -- structure. This functionality is mainly used internally in the code -- generated by the hftpp pre-processor. module Test.Framework.TestManager -- | Runs something testable by parsing the commandline arguments as test -- options (using parseTestArgs). Exits with the exit code -- returned by runTestWithArgs. This function is the main entry -- point for running tests. htfMain :: TestableHTF t => t -> IO () -- | Run something testable using the defaultCmdlineOptions. runTest :: TestableHTF t => t -> IO ExitCode -- | Run something testable using the defaultCmdlineOptions. runTest' :: TestableHTF t => t -> IO (IO (), ExitCode) -- | Run something testable, parse the CmdlineOptions from the given -- commandline arguments. Does not print the overall test results but -- returns an IO action for doing so. runTestWithArgs :: TestableHTF t => [String] -> t -> IO ExitCode -- | Run something testable, parse the CmdlineOptions from the given -- commandline arguments. runTestWithArgs' :: TestableHTF t => [String] -> t -> IO (IO (), ExitCode) -- | Runs something testable with the given CmdlineOptions. See -- runTestWithConfig for a specification of the ExitCode -- result. runTestWithOptions :: TestableHTF t => CmdlineOptions -> t -> IO ExitCode -- | Runs something testable with the given CmdlineOptions. Does not -- print the overall test results but returns an IO action for -- doing so. See runTestWithConfig for a specification of the -- ExitCode result. runTestWithOptions' :: TestableHTF t => CmdlineOptions -> t -> IO (IO (), ExitCode) -- | Runs something testable with the given TestConfig. The result -- is ExitSuccess if all tests were executed successfully, -- ExitFailure otherwise. In the latter case, an error code of -- 1 indicates that failures but no errors occurred, otherwise -- the error code 2 is used. -- -- A test is successful if the test terminates and no assertion -- fails. A test is said to fail if an assertion fails but no -- other error occur. runTestWithConfig :: TestableHTF t => TestConfig -> t -> IO ExitCode -- | Runs something testable with the given TestConfig. Does not -- print the overall test results but returns an IO action for -- doing so. See runTestWithConfig for a specification of the -- ExitCode result. runTestWithConfig' :: TestableHTF t => TestConfig -> t -> IO (IO (), ExitCode) -- | A type class for things that can be run as tests. Mainly used -- internally. class TestableHTF t -- | Construct a test where the given Assertion checks a quick check -- property. Mainly used internally by the htfpp preprocessor. makeQuickCheckTest :: TestID -> Location -> Assertion -> Test -- | Construct a unit test from the given IO action. Mainly used -- internally by the htfpp preprocessor. makeUnitTest :: TestID -> Location -> IO a -> Test -- | Construct a black box test from the given Assertion. Mainly -- used internally. makeBlackBoxTest :: TestID -> Assertion -> Test -- | Create a named TestSuite from a list of Test values. makeTestSuite :: TestID -> [Test] -> TestSuite -- | Create an unnamed TestSuite from a list of Test values. makeAnonTestSuite :: [Test] -> TestSuite -- | Extend a TestSuite with a list of Test values addToTestSuite :: TestSuite -> [Test] -> TestSuite -- | Turn a TestSuite into a proper Test. testSuiteAsTest :: TestSuite -> Test instance TestableHTF (IO a) instance TestableHTF t => TestableHTF [t] instance TestableHTF TestSuite instance TestableHTF Test -- | A black box test in the terminology of the HTF consists of a -- driver program that is run in various input files. For each input -- file, the HTF checks that the driver program exits with the correct -- exit code and that it produces the expected output. The samples -- directory of the HTF source tree shows an example for a black box -- test, see https://github.com/skogsbaer/HTF/tree/master/sample. -- -- NOTE: If you use black box tests, you have to compile your -- program with the -threaded option. Otherwise, your program -- just blocks indefinitely! module Test.Framework.BlackBoxTest -- | Use a value of this datatype to customize various aspects of your -- black box tests. data BBTArgs BBTArgs :: String -> String -> String -> String -> Bool -> Diff -> Diff -> BBTArgs -- | File extension for the file used as stdin. bbtArgs_stdinSuffix :: BBTArgs -> String -- | File extension for the file specifying expected output on stdout. bbtArgs_stdoutSuffix :: BBTArgs -> String -- | File extension for the file specifying expected output on stderr. bbtArgs_stderrSuffix :: BBTArgs -> String -- | Name of a file defining various arguments for executing the tests -- contained in a subdirectory of the test hierarchy. If a directory -- contains a such-named file, the arguments apply to all testfiles -- directly contained in this directory. See the documentation of -- blackBoxTests for a specification of the argument file format. bbtArgs_dynArgsName :: BBTArgs -> String -- | Ge verbose or not. bbtArgs_verbose :: BBTArgs -> Bool -- | Diff program for comparing output on stdout with the expected value. bbtArgs_stdoutDiff :: BBTArgs -> Diff -- | Diff program for comparing output on stderr with the expected value. bbtArgs_stderrDiff :: BBTArgs -> Diff -- | Sensible default values for BBTArgs: -- -- 
--   defaultBBTArgs = BBTArgs { bbtArgs_stdinSuffix    = ".in"
--                            , bbtArgs_stdoutSuffix   = ".out"
--                            , bbtArgs_stderrSuffix   = ".err"
--                            , bbtArgs_dynArgsName    = BBTArgs
--                            , bbtArgs_stdoutDiff     = defaultDiff
--                            , bbtArgs_stderrDiff     = defaultDiff
--                            , bbtArgs_verbose        = False }
--
defaultBBTArgs :: BBTArgs -- | Collects all black box tests with the given file extension stored in a -- specific directory. For example, the invocation -- -- 
--   blackBoxTests "bbt-dir" "dist/build/sample/sample" ".num" defaultBBTArgs
--
-- -- returns a list of Test values, one Test for each -- .num file found in bbt-dir and its subdirectories. -- (The samples directory of the HTF source tree contains the example -- shown here, see -- https://github.com/skogsbaer/HTF/tree/master/sample.) -- -- Suppose that one of the .num files is -- bbt-dir/should-pass/x.num. Running the corresponding -- Test invokes dist/build/sample/sample (the program -- under test) with bbt-dir/should-pass/x.num as input file. If -- bbt-dir/should-pass/x.num existed, its content would be used -- as stdin. The tests succeeds if the exit code of the program is zero -- and the output on stdout and stderr matches the contents of -- bbt-dir/should-pass/x.out and -- bbt-dir/should-pass/x.err, respectively. -- -- The directory bbt-dir/should-fail contains the file -- BBTArgs. If this file exists, then its content specifies -- various arguments for the test run. The file defines the arguments -- separated by newlines. Supported arguments: -- -- blackBoxTests :: FilePath -> String -> String -> BBTArgs -> IO [Test] -- | The type of a function comparing the content of a file against a -- string, similar to the unix tool diff. The first parameter is -- the name of the file containing the expected output. If this parameter -- is Nothing, then no output is expected. The second parameter is -- the actual output produced. If the result is Nothing then no -- difference was found. Otherwise, a Just value contains a string -- explaining the different. type Diff = Maybe FilePath -> String -> IO (Maybe String) -- | A default value for the Diff datatype that simple resorts to -- the diff commandline utility. defaultDiff :: Diff -- | This module integrates the QuickCheck library into HTF. It -- re-exports all functionality of QuickCheck and defines some -- additional functions. module Test.Framework.QuickCheckWrapper -- | The Args used if not explicitly changed. defaultArgs :: Args -- | Retrieve the Args currently used per default when evaluating -- quick check properties. getCurrentArgs :: IO Args -- | Change the default Args used to evaluate quick check -- properties. setDefaultArgs :: Args -> IO () -- | Run a QuickCheck property with modified quick check arguments -- Args. withQCArgs :: (WithQCArgs a, Testable a) => (Args -> Args) -> a -> TestableWithQCArgs -- | Use qcPending msg prop to mark the given quick check property -- as pending without removing it from the test suite and without -- deleting or commenting out the property code. qcPending :: Testable t => String -> t -> t -- | Turns a QuickCheck property into an Assertion. This -- function is used internally in the code generated by htfpp, -- do not use it directly. testableAsAssertion :: (Testable t, WithQCArgs t) => t -> Assertion -- | Turns a QuickCheck property with custom Args into an -- Assertion. This function is used internally in the code -- generated by htfpp, do not use it directly. asTestableWithQCArgs :: (WithQCArgs a, Testable a) => a -> TestableWithQCArgs -- | Abstract type for representing quick check properties with custom -- Args. Used only internally. data TestableWithQCArgs -- | Type class providing access to the custom Args of a quick check -- property. Used only internally. class WithQCArgs a instance [overlap ok] Typeable QCPendingException instance [overlap ok] Show QCPendingException instance [overlap ok] Read QCPendingException instance [overlap ok] Eq QCPendingException instance [overlap ok] WithQCArgs TestableWithQCArgs instance [overlap ok] WithQCArgs a instance [overlap ok] Testable TestableWithQCArgs instance [overlap ok] Exception QCPendingException -- | This module provides assert-like functions for writing unit tests. -- -- Hint: Do not use the assertXXX_ functions directly. -- Instead, for each function assertXXX_, there exist a -- preprocessor macro assertXXX, which provides the -- Location parameter automatically. Use these macros, which are -- available automatically if you add -- -- 
--   {-# OPTIONS_GHC -F -pgmF htfpp #-}
--
-- -- at the top of your source file (see the Tutorial). module Test.Framework.HUnitWrapper assertBool_ :: Location -> Bool -> Assertion -- | Fail if the Bool value is False. The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use assertBool_ and -- assertBoolVerbose_ directly, use the macros -- assertBool and assertBoolVerbose instead. These -- macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertBoolVerbose_ :: Location -> String -> Bool -> Assertion assertEqual_ :: (Eq a, Show a) => Location -> a -> a -> Assertion -- | Fail if the two values of type a are not equal. The first -- parameter denotes the expected value. Use these two functions of -- a is an instance of Show but not of Pretty. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertEqual_ and assertEqualVerbose_ directly, use -- the macros assertEqual and assertEqualVerbose -- instead. These macros, provided by the htfpp preprocessor, -- insert the Location parameter automatically. assertEqualVerbose_ :: (Eq a, Show a) => Location -> String -> a -> a -> Assertion assertEqualPretty_ :: (Eq a, Pretty a) => Location -> a -> a -> Assertion -- | Fail if the two values of type a are not equal. The first -- parameter denotes the expected value. Use these two functions of -- a is an instance of Pretty. The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use assertEqualPretty_ -- and assertEqualPrettyVerbose_ directly, use the macros -- assertEqualPretty and assertEqualPrettyVerbose -- instead. These macros, provided by the htfpp preprocessor, -- insert the Location parameter automatically. assertEqualPrettyVerbose_ :: (Eq a, Pretty a) => Location -> String -> a -> a -> Assertion assertEqualNoShow_ :: Eq a => Location -> a -> a -> Assertion -- | Fail if the two values of type a are not equal. The first -- parameter denotes the expected value. Use these two functions of -- a is neither an instance of Show nor Pretty. Be -- aware that in this case the generated error message might not be very -- helpful. The String parameter in the Verbose variant -- can be used to provide extra information about the error. Do not use -- assertEqualNoShow_ and assertEqualNoShowVerbose_ -- directly, use the macros assertEqualNoShow and -- assertEqualNoShowVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertEqualNoShowVerbose_ :: Eq a => Location -> String -> a -> a -> Assertion assertNotEqual_ :: (Eq a, Show a) => Location -> a -> a -> Assertion -- | Fail if the two values of type a are equal. The first -- parameter denotes the expected value. Use these two functions of -- a is an instance of Show but not of Pretty. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertNotEqual_ and assertNotEqualVerbose_ directly, -- use the macros assertNotEqual and -- assertNotEqualVerbose instead. These macros, provided by the -- htfpp preprocessor, insert the Location parameter -- automatically. assertNotEqualVerbose_ :: (Eq a, Show a) => Location -> String -> a -> a -> Assertion assertNotEqualPretty_ :: (Eq a, Pretty a) => Location -> a -> a -> Assertion -- | Fail if the two values of type a are equal. The first -- parameter denotes the expected value. Use these two functions of -- a is an instance of Pretty. The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use assertNotEqualPretty_ -- and assertNotEqualPrettyVerbose_ directly, use the macros -- assertNotEqualPretty and assertNotEqualPrettyVerbose -- instead. These macros, provided by the htfpp preprocessor, -- insert the Location parameter automatically. assertNotEqualPrettyVerbose_ :: (Eq a, Pretty a) => Location -> String -> a -> a -> Assertion assertNotEqualNoShow_ :: Eq a => Location -> a -> a -> Assertion -- | Fail if the two values of type a are equal. The first -- parameter denotes the expected value. Use these two functions of -- a is neither an instance of Show nor Pretty. Be -- aware that in this case the generated error message might not be very -- helpful. The String parameter in the Verbose variant -- can be used to provide extra information about the error. Do not use -- assertNotEqualNoShow_ and -- assertNotEqualNoShowVerbose_ directly, use the macros -- assertNotEqualNoShow and assertNotEqualNoShowVerbose -- instead. These macros, provided by the htfpp preprocessor, -- insert the Location parameter automatically. assertNotEqualNoShowVerbose_ :: Eq a => Location -> String -> a -> a -> Assertion assertListsEqualAsSets_ :: (Eq a, Show a) => Location -> [a] -> [a] -> Assertion -- | Fail if the two given lists are not equal when considered as sets. The -- first list parameter denotes the expected value. The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use -- assertListsEqualAsSets_ and -- assertListsEqualAsSetsVerbose_ directly, use the macros -- assertListsEqualAsSets and -- assertListsEqualAsSetsVerbose instead. These macros, provided -- by the htfpp preprocessor, insert the Location -- parameter automatically. assertListsEqualAsSetsVerbose_ :: (Eq a, Show a) => Location -> String -> [a] -> [a] -> Assertion assertNotEmpty_ :: Location -> [a] -> Assertion -- | Fail if the given list is empty. The String parameter in the -- Verbose variant can be used to provide extra information -- about the error. Do not use assertNotEmpty_ and -- assertNotEmptyVerbose_ directly, use the macros -- assertNotEmpty and assertNotEmptyVerbose instead. -- These macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertNotEmptyVerbose_ :: Location -> String -> [a] -> Assertion assertEmpty_ :: Location -> [a] -> Assertion -- | Fail if the given list is a non-empty list. The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use assertEmpty_ and -- assertEmptyVerbose_ directly, use the macros -- assertEmpty and assertEmptyVerbose instead. These -- macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertEmptyVerbose_ :: Location -> String -> [a] -> Assertion assertThrows_ :: Exception e => Location -> a -> (e -> Bool) -> Assertion -- | Fail if evaluating the expression of type a does not throw an -- exception satisfying the given predicate (e -> Bool). The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertThrows_ and assertThrowsVerbose_ directly, use -- the macros assertThrows and assertThrowsVerbose -- instead. These macros, provided by the htfpp preprocessor, -- insert the Location parameter automatically. assertThrowsVerbose_ :: Exception e => Location -> String -> a -> (e -> Bool) -> Assertion assertThrowsSome_ :: Location -> a -> Assertion -- | Fail if evaluating the expression of type a does not throw an -- exception. The String parameter in the Verbose variant -- can be used to provide extra information about the error. Do not use -- assertThrowsSome_ and assertThrowsSomeVerbose_ -- directly, use the macros assertThrowsSome and -- assertThrowsSomeVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertThrowsSomeVerbose_ :: Location -> String -> a -> Assertion assertThrowsIO_ :: Exception e => Location -> IO a -> (e -> Bool) -> Assertion -- | Fail if executing the IO action does not throw an exception -- satisfying the given predicate (e -> Bool). The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertThrowsIO_ and assertThrowsIOVerbose_ directly, -- use the macros assertThrowsIO and -- assertThrowsIOVerbose instead. These macros, provided by the -- htfpp preprocessor, insert the Location parameter -- automatically. assertThrowsIOVerbose_ :: Exception e => Location -> String -> IO a -> (e -> Bool) -> Assertion assertThrowsSomeIO_ :: Location -> IO a -> Assertion -- | Fail if executing the IO action does not throw an exception. -- The String parameter in the Verbose variant can be -- used to provide extra information about the error. Do not use -- assertThrowsSomeIO_ and assertThrowsSomeIOVerbose_ -- directly, use the macros assertThrowsSomeIO and -- assertThrowsSomeIOVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertThrowsSomeIOVerbose_ :: Location -> String -> IO a -> Assertion assertLeft_ :: Show b => Location -> Either a b -> IO a -- | Fail if the given Either a b value is a Right. Use -- this function if b is an instance of Show The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertLeft_ and assertLeftVerbose_ directly, use the -- macros assertLeft and assertLeftVerbose instead. -- These macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertLeftVerbose_ :: Show b => Location -> String -> Either a b -> IO a assertLeftNoShow_ :: Location -> Either a b -> IO a -- | Fail if the given Either a b value is a Right. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertLeftNoShow_ and assertLeftNoShowVerbose_ -- directly, use the macros assertLeftNoShow and -- assertLeftNoShowVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertLeftNoShowVerbose_ :: Location -> String -> Either a b -> IO a assertRight_ :: Show a => Location -> Either a b -> IO b -- | Fail if the given Either a b value is a Left. Use this -- function if a is an instance of Show The String -- parameter in the Verbose variant can be used to provide extra -- information about the error. Do not use assertRight_ and -- assertRightVerbose_ directly, use the macros -- assertRight and assertRightVerbose instead. These -- macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertRightVerbose_ :: Show a => Location -> String -> Either a b -> IO b assertRightNoShow_ :: Location -> Either a b -> IO b -- | Fail if the given Either a b value is a Left. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertRightNoShow_ and assertRightNoShowVerbose_ -- directly, use the macros assertRightNoShow and -- assertRightNoShowVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertRightNoShowVerbose_ :: Location -> String -> Either a b -> IO b assertJust_ :: Location -> Maybe a -> IO a -- | Fail is the given Maybe a value is a Nothing. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertJust_ and assertJustVerbose_ directly, use the -- macros assertJust and assertJustVerbose instead. -- These macros, provided by the htfpp preprocessor, insert the -- Location parameter automatically. assertJustVerbose_ :: Location -> String -> Maybe a -> IO a assertNothing_ :: Show a => Location -> Maybe a -> Assertion -- | Fail is the given Maybe a value is a Just. Use this -- function if a is an instance of Show. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertNothing_ and assertNothingVerbose_ directly, -- use the macros assertNothing and -- assertNothingVerbose instead. These macros, provided by the -- htfpp preprocessor, insert the Location parameter -- automatically. assertNothingVerbose_ :: Show a => Location -> String -> Maybe a -> Assertion assertNothingNoShow_ :: Location -> Maybe a -> Assertion -- | Fail is the given Maybe a value is a Just. The -- String parameter in the Verbose variant can be used to -- provide extra information about the error. Do not use -- assertNothingNoShow_ and assertNothingNoShowVerbose_ -- directly, use the macros assertNothingNoShow and -- assertNothingNoShowVerbose instead. These macros, provided by -- the htfpp preprocessor, insert the Location parameter -- automatically. assertNothingNoShowVerbose_ :: Location -> String -> Maybe a -> Assertion -- | Fail with the given reason, supplying the error location and the error -- message. assertFailure_ :: Location -> String -> IO a unitTestPending :: String -> IO a -- | Use unitTestPending' msg test to mark the given test as -- pending without removing it from the test suite and without deleting -- or commenting out the test code. unitTestPending' :: String -> IO a -> IO a -- | Sub assertions are a poor man's way of abstracting over assertions -- while still propagating location information. Say you want to abstract -- over the assertion that an Int is positive. You would write -- -- 
--   assertIsPositive :: Int -> Assertion
--   assertIsPositive n = assertBool (n > 0)
--
-- -- You can now use assertIsPositive i for some integer -- i from your unit tests, but if you call it directly you will -- lose location information: if assertIsPositive i fails you -- will only get the location where assertIsPositive is defined -- but not from where it has been called. -- -- To recover the location information you simply use subAssert -- (assertIsPositive i). In this case, if i is not -- positive, you will get the location of the caller. -- -- Note: Don't use subAssert_ directly but use the preprocessor -- macro subAssert. subAssert_ :: MonadBaseControl IO m => Location -> m () -> m () -- | Same as subAssert_ but with an additional error message. subAssertVerbose_ :: MonadBaseControl IO m => Location -> String -> m () -> m () -- | Top-level module that re-exports functionality from sub-modules. -- Modules that only define unit tests and quickcheck properties -- typically only need to import this module. Your test driver should -- additionally import TestManager and, if needed, -- BlackBoxTest. module Test.Framework -- | Construct a unit test from the given IO action. Mainly used -- internally by the htfpp preprocessor. makeUnitTest :: TestID -> Location -> IO a -> Test -- | Construct a test where the given Assertion checks a quick check -- property. Mainly used internally by the htfpp preprocessor. makeQuickCheckTest :: TestID -> Location -> Assertion -> Test -- | Create a named TestSuite from a list of Test values. makeTestSuite :: TestID -> [Test] -> TestSuite -- | Abstract type for test suites and their results. data TestSuite -- | Runs something testable by parsing the commandline arguments as test -- options (using parseTestArgs). Exits with the exit code -- returned by runTestWithArgs. This function is the main entry -- point for running tests. htfMain :: TestableHTF t => t -> IO () -- | Create a new location. makeLoc :: String -> Int -> Location -- | This module provides a short tutorial on how to use the HTF. It -- assumes that you are using GHC for compiling your Haskell code. (It is -- possible to use the HTF with other Haskell environments, only the -- steps taken to invoke the custom preprocessor of the HTF may differ in -- this case.) -- -- We start with a simple example. Then we show how to use HTF to easily -- collect test definitions from multiple modules and discuss -- backwards-compatibility for projects already using HUnit. -- Finally, we give a brief cookbook-like summary on how to setup your -- tests with HTF. module Test.Framework.Tutorial