Takusen-0.7: doc/html/Test-MiniUnit.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Test.MiniUnit</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock.js" TYPE="text/javascript"
></SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
></TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Test.MiniUnit</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Stability</TD
><TD CLASS="infoval"
>experimental</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>oleg@pobox.com, alistair@abayley.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>Primary API
</A
></DT
><DT
><A HREF="#2"
>Exposed for self-testing only; see <A HREF="Test-MiniUnitTest.html"
>Test.MiniUnitTest</A
>
</A
></DT
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
>This is just a simple one-module unit test framework, with the same
API as <A HREF="Test-HUnit.html"
>Test.HUnit</A
> (albeit with a lot of stuff missing).
We use it because it works in <TT
><A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
></TT
>
instead of IO
(and also because I couldn't convert <A HREF="Test-HUnit.html"
>Test.HUnit</A
>
to use <TT
><A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
></TT
>).
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunTestTT"
>runTestTT</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> [m ()] -> m <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Int.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AassertFailure"
>assertFailure</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AassertBool"
>assertBool</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Bool.html#t%3ABool"
>Bool</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AassertString"
>assertString</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AassertEqual"
>assertEqual</A
> :: (<A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Eq.html#t%3AEq"
>Eq</A
> a, <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Text-Show.html#t%3AShow"
>Show</A
> a, <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m) => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> a -> a -> m ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A HREF="#t%3ATestResult"
>TestResult</A
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
>= <A HREF="#v%3ATestSuccess"
>TestSuccess</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ATestFailure"
>TestFailure</A
> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
><TR
><TD CLASS="decl"
>| <A HREF="#v%3ATestException"
>TestException</A
> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
></TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AthrowUserError"
>throwUserError</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3ArunSingleTest"
>runSingleTest</A
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => m () -> m <A HREF="Test-MiniUnit.html#t%3ATestResult"
>TestResult</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="1"
>Primary API
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3ArunTestTT"
></A
><B
>runTestTT</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> [m ()] -> m <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Int.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="doc"
>Return 0 if everything is rosy,
1 if there were assertion failures (but no exceptions),
2 if there were any exceptions.
You could use this return code as the return code from
your program, if you're driving from the command line.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AassertFailure"
></A
><B
>assertFailure</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AassertBool"
></A
><B
>assertBool</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Bool.html#t%3ABool"
>Bool</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AassertString"
></A
><B
>assertString</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AassertEqual"
></A
><B
>assertEqual</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: (<A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Eq.html#t%3AEq"
>Eq</A
> a, <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Text-Show.html#t%3AShow"
>Show</A
> a, <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m)</TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>=> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
>message preface
</TD
></TR
><TR
><TD CLASS="arg"
>-> a</TD
><TD CLASS="rdoc"
>expected
</TD
></TR
><TR
><TD CLASS="arg"
>-> a</TD
><TD CLASS="rdoc"
>actual
</TD
></TR
><TR
><TD CLASS="arg"
>-> m ()</TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
>Exposed for self-testing only; see <A HREF="Test-MiniUnitTest.html"
>Test.MiniUnitTest</A
>
</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><SPAN CLASS="keyword"
>data</SPAN
> <A NAME="t%3ATestResult"
></A
><B
>TestResult</B
> </TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
>Constructors</TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="arg"
><A NAME="v%3ATestSuccess"
></A
><B
>TestSuccess</B
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ATestFailure"
></A
><B
>TestFailure</B
> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
><A NAME="v%3ATestException"
></A
><B
>TestException</B
> <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
></TD
><TD CLASS="rdoc"
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="section4"
><IMG SRC="minus.gif" CLASS="coll" ONCLICK="toggle(this,'i:TestResult')" ALT="show/hide"
> Instances</TD
></TR
><TR
><TD CLASS="body"
><DIV ID="i:TestResult" STYLE="display:block;"
><TABLE CLASS="vanilla" CELLSPACING="1" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Eq.html#t%3AEq"
>Eq</A
> <A HREF="Test-MiniUnit.html#t%3ATestResult"
>TestResult</A
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Text-Show.html#t%3AShow"
>Show</A
> <A HREF="Test-MiniUnit.html#t%3ATestResult"
>TestResult</A
></TD
></TR
></TABLE
></DIV
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3AthrowUserError"
></A
><B
>throwUserError</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => <A HREF="http://www.haskell.org/ghc/docs/latest/html/libraries/base/Data-Char.html#t%3AString"
>String</A
> -> m ()</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v%3ArunSingleTest"
></A
><B
>runSingleTest</B
> :: <A HREF="Control-Exception-MonadIO.html#t%3ACaughtMonadIO"
>CaughtMonadIO</A
> m => m () -> m <A HREF="Test-MiniUnit.html#t%3ATestResult"
>TestResult</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 0.8</TD
></TR
></TABLE
></BODY
></HTML
>