<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://www.cs.york.ac.uk/fp/darcs/hscolour/ -->
<title>Test/HUnit/Base.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-- | Basic definitions for the HUnit library.</span>
<a name="line-2"></a><span class='hs-comment'>--</span>
<a name="line-3"></a><span class='hs-comment'>-- This module contains what you need to create assertions and test cases and</span>
<a name="line-4"></a><span class='hs-comment'>-- combine them into test suites. </span>
<a name="line-5"></a><span class='hs-comment'>--</span>
<a name="line-6"></a><span class='hs-comment'>-- This module also provides infrastructure for </span>
<a name="line-7"></a><span class='hs-comment'>-- implementing test controllers (which are used to execute tests). </span>
<a name="line-8"></a><span class='hs-comment'>-- See "Test.HUnit.Text" for a great example of how to implement a test </span>
<a name="line-9"></a><span class='hs-comment'>-- controller.</span>
<a name="line-10"></a>
<a name="line-11"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>HUnit</span><span class='hs-varop'>.</span><span class='hs-conid'>Base</span>
<a name="line-12"></a><span class='hs-layout'>(</span>
<a name="line-13"></a> <span class='hs-comment'>-- ** Declaring tests</span>
<a name="line-14"></a> <span class='hs-conid'>Test</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-15"></a> <span class='hs-layout'>(</span><span class='hs-varop'>~=?</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>~?=</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>~:</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>~?</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-16"></a>
<a name="line-17"></a> <span class='hs-comment'>-- ** Making assertions</span>
<a name="line-18"></a> <span class='hs-varid'>assertFailure</span><span class='hs-layout'>,</span> <span class='hs-comment'>{- from Test.HUnit.Lang: -}</span>
<a name="line-19"></a> <span class='hs-varid'>assertBool</span><span class='hs-layout'>,</span> <span class='hs-varid'>assertEqual</span><span class='hs-layout'>,</span> <span class='hs-varid'>assertString</span><span class='hs-layout'>,</span>
<a name="line-20"></a> <span class='hs-conid'>Assertion</span><span class='hs-layout'>,</span> <span class='hs-comment'>{- from Test.HUnit.Lang: -}</span>
<a name="line-21"></a> <span class='hs-layout'>(</span><span class='hs-varop'>@=?</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>@?=</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-layout'>(</span><span class='hs-varop'>@?</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-22"></a>
<a name="line-23"></a> <span class='hs-comment'>-- ** Extending the assertion functionality</span>
<a name="line-24"></a> <span class='hs-conid'>Assertable</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>ListAssertable</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-25"></a> <span class='hs-conid'>AssertionPredicate</span><span class='hs-layout'>,</span> <span class='hs-conid'>AssertionPredicable</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-26"></a> <span class='hs-conid'>Testable</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-27"></a>
<a name="line-28"></a> <span class='hs-comment'>-- ** Test execution</span>
<a name="line-29"></a> <span class='hs-comment'>-- $testExecutionNote</span>
<a name="line-30"></a> <span class='hs-conid'>State</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Counts</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-31"></a> <span class='hs-conid'>Path</span><span class='hs-layout'>,</span> <span class='hs-conid'>Node</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span>
<a name="line-32"></a> <span class='hs-varid'>testCasePaths</span><span class='hs-layout'>,</span>
<a name="line-33"></a> <span class='hs-varid'>testCaseCount</span><span class='hs-layout'>,</span>
<a name="line-34"></a> <span class='hs-conid'>ReportStart</span><span class='hs-layout'>,</span> <span class='hs-conid'>ReportProblem</span><span class='hs-layout'>,</span>
<a name="line-35"></a> <span class='hs-varid'>performTest</span>
<a name="line-36"></a><span class='hs-layout'>)</span>
<a name="line-37"></a><span class='hs-keyword'>where</span>
<a name="line-38"></a>
<a name="line-39"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-varid'>unless</span><span class='hs-layout'>,</span> <span class='hs-varid'>foldM</span><span class='hs-layout'>)</span>
<a name="line-40"></a>
<a name="line-41"></a>
<a name="line-42"></a><span class='hs-comment'>-- Assertion Definition</span>
<a name="line-43"></a><span class='hs-comment'>-- ====================</span>
<a name="line-44"></a>
<a name="line-45"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>HUnit</span><span class='hs-varop'>.</span><span class='hs-conid'>Lang</span>
<a name="line-46"></a>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-comment'>-- Conditional Assertion Functions</span>
<a name="line-49"></a><span class='hs-comment'>-- -------------------------------</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="assertBool"></a><span class='hs-comment'>-- | Asserts that the specified condition holds.</span>
<a name="line-52"></a><span class='hs-definition'>assertBool</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The message that is displayed if the assertion fails</span>
<a name="line-53"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span> <span class='hs-comment'>-- ^ The condition</span>
<a name="line-54"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-55"></a><span class='hs-definition'>assertBool</span> <span class='hs-varid'>msg</span> <span class='hs-varid'>b</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unless</span> <span class='hs-varid'>b</span> <span class='hs-layout'>(</span><span class='hs-varid'>assertFailure</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span>
<a name="line-56"></a>
<a name="line-57"></a><a name="assertString"></a><span class='hs-comment'>-- | Signals an assertion failure if a non-empty message (i.e., a message</span>
<a name="line-58"></a><span class='hs-comment'>-- other than @\"\"@) is passed.</span>
<a name="line-59"></a><span class='hs-definition'>assertString</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The message that is displayed with the assertion failure </span>
<a name="line-60"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-61"></a><span class='hs-definition'>assertString</span> <span class='hs-varid'>s</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>assertFailure</span> <span class='hs-varid'>s</span><span class='hs-layout'>)</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="assertEqual"></a><span class='hs-comment'>-- | Asserts that the specified actual value is equal to the expected value.</span>
<a name="line-64"></a><span class='hs-comment'>-- The output message will contain the prefix, the expected value, and the </span>
<a name="line-65"></a><span class='hs-comment'>-- actual value.</span>
<a name="line-66"></a><span class='hs-comment'>-- </span>
<a name="line-67"></a><span class='hs-comment'>-- If the prefix is the empty string (i.e., @\"\"@), then the prefix is omitted</span>
<a name="line-68"></a><span class='hs-comment'>-- and only the expected and actual values are output.</span>
<a name="line-69"></a><span class='hs-definition'>assertEqual</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ The message prefix </span>
<a name="line-70"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The expected value </span>
<a name="line-71"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The actual value</span>
<a name="line-72"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-73"></a><span class='hs-definition'>assertEqual</span> <span class='hs-varid'>preface</span> <span class='hs-varid'>expected</span> <span class='hs-varid'>actual</span> <span class='hs-keyglyph'>=</span>
<a name="line-74"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>actual</span> <span class='hs-varop'>==</span> <span class='hs-varid'>expected</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>assertFailure</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span>
<a name="line-75"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-keyword'>if</span> <span class='hs-varid'>null</span> <span class='hs-varid'>preface</span> <span class='hs-keyword'>then</span> <span class='hs-str'>""</span> <span class='hs-keyword'>else</span> <span class='hs-varid'>preface</span> <span class='hs-varop'>++</span> <span class='hs-str'>"\n"</span><span class='hs-layout'>)</span> <span class='hs-varop'>++</span>
<a name="line-76"></a> <span class='hs-str'>"expected: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>expected</span> <span class='hs-varop'>++</span> <span class='hs-str'>"\n but got: "</span> <span class='hs-varop'>++</span> <span class='hs-varid'>show</span> <span class='hs-varid'>actual</span>
<a name="line-77"></a>
<a name="line-78"></a>
<a name="line-79"></a><span class='hs-comment'>-- Overloaded `assert` Function</span>
<a name="line-80"></a><span class='hs-comment'>-- ----------------------------</span>
<a name="line-81"></a>
<a name="line-82"></a><a name="Assertable"></a><span class='hs-comment'>-- | Allows the extension of the assertion mechanism.</span>
<a name="line-83"></a><a name="Assertable"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><a name="Assertable"></a><span class='hs-comment'>-- Since an 'Assertion' can be a sequence of @Assertion@s and @IO@ actions, </span>
<a name="line-85"></a><a name="Assertable"></a><span class='hs-comment'>-- there is a fair amount of flexibility of what can be achieved. As a rule,</span>
<a name="line-86"></a><a name="Assertable"></a><span class='hs-comment'>-- the resulting @Assertion@ should be the body of a 'TestCase' or part of</span>
<a name="line-87"></a><a name="Assertable"></a><span class='hs-comment'>-- a @TestCase@; it should not be used to assert multiple, independent </span>
<a name="line-88"></a><a name="Assertable"></a><span class='hs-comment'>-- conditions.</span>
<a name="line-89"></a><a name="Assertable"></a><span class='hs-comment'>--</span>
<a name="line-90"></a><a name="Assertable"></a><span class='hs-comment'>-- If more complex arrangements of assertions are needed, 'Test's and</span>
<a name="line-91"></a><a name="Assertable"></a><span class='hs-comment'>-- 'Testable' should be used.</span>
<a name="line-92"></a><a name="Assertable"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Assertable</span> <span class='hs-varid'>t</span>
<a name="line-93"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assert</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-94"></a>
<a name="line-95"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Assertable</span> <span class='hs-conid'>()</span>
<a name="line-96"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assert</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span>
<a name="line-97"></a>
<a name="line-98"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Assertable</span> <span class='hs-conid'>Bool</span>
<a name="line-99"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assert</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>assertBool</span> <span class='hs-str'>""</span>
<a name="line-100"></a>
<a name="line-101"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>ListAssertable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Assertable</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>t</span><span class='hs-keyglyph'>]</span>
<a name="line-102"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assert</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>listAssert</span>
<a name="line-103"></a>
<a name="line-104"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>Assertable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Assertable</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-105"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assert</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>>>=</span> <span class='hs-varid'>assert</span><span class='hs-layout'>)</span>
<a name="line-106"></a>
<a name="line-107"></a><a name="ListAssertable"></a><span class='hs-comment'>-- | A specialized form of 'Assertable' to handle lists.</span>
<a name="line-108"></a><a name="ListAssertable"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>ListAssertable</span> <span class='hs-varid'>t</span>
<a name="line-109"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>listAssert</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>t</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-110"></a>
<a name="line-111"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>ListAssertable</span> <span class='hs-conid'>Char</span>
<a name="line-112"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>listAssert</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>assertString</span>
<a name="line-113"></a>
<a name="line-114"></a>
<a name="line-115"></a><span class='hs-comment'>-- Overloaded `assertionPredicate` Function</span>
<a name="line-116"></a><span class='hs-comment'>-- ----------------------------------------</span>
<a name="line-117"></a>
<a name="line-118"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- | The result of an assertion that hasn't been evaluated yet.</span>
<a name="line-119"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- Most test cases follow the following steps:</span>
<a name="line-121"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-122"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 1. Do some processing or an action.</span>
<a name="line-123"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-124"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 2. Assert certain conditions.</span>
<a name="line-125"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-126"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- However, this flow is not always suitable. @AssertionPredicate@ allows for</span>
<a name="line-127"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- additional steps to be inserted without the initial action to be affected</span>
<a name="line-128"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- by side effects. Additionally, clean-up can be done before the test case</span>
<a name="line-129"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- has a chance to end. A potential work flow is:</span>
<a name="line-130"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-131"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 1. Write data to a file.</span>
<a name="line-132"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-133"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 2. Read data from a file, evaluate conditions.</span>
<a name="line-134"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-135"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 3. Clean up the file.</span>
<a name="line-136"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- </span>
<a name="line-137"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 4. Assert that the side effects of the read operation meet certain conditions.</span>
<a name="line-138"></a><a name="AssertionPredicate"></a><span class='hs-comment'>--</span>
<a name="line-139"></a><a name="AssertionPredicate"></a><span class='hs-comment'>-- 5. Assert that the conditions evaluated in step 2 are met.</span>
<a name="line-140"></a><a name="AssertionPredicate"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>AssertionPredicate</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-141"></a>
<a name="line-142"></a><a name="AssertionPredicable"></a><span class='hs-comment'>-- | Used to signify that a data type can be converted to an assertion </span>
<a name="line-143"></a><a name="AssertionPredicable"></a><span class='hs-comment'>-- predicate.</span>
<a name="line-144"></a><a name="AssertionPredicable"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>AssertionPredicable</span> <span class='hs-varid'>t</span>
<a name="line-145"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assertionPredicate</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>AssertionPredicate</span>
<a name="line-146"></a>
<a name="line-147"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>AssertionPredicable</span> <span class='hs-conid'>Bool</span>
<a name="line-148"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assertionPredicate</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span>
<a name="line-149"></a>
<a name="line-150"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>AssertionPredicable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>AssertionPredicable</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-151"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>assertionPredicate</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>>>=</span> <span class='hs-varid'>assertionPredicate</span><span class='hs-layout'>)</span>
<a name="line-152"></a>
<a name="line-153"></a>
<a name="line-154"></a><span class='hs-comment'>-- Assertion Construction Operators</span>
<a name="line-155"></a><span class='hs-comment'>-- --------------------------------</span>
<a name="line-156"></a>
<a name="line-157"></a><span class='hs-keyword'>infix</span> <span class='hs-num'>1</span> <span class='hs-varop'>@?</span><span class='hs-layout'>,</span> <span class='hs-varop'>@=?</span><span class='hs-layout'>,</span> <span class='hs-varop'>@?=</span>
<a name="line-158"></a>
<a name="line-159"></a><a name="@?"></a><span class='hs-comment'>-- | Asserts that the condition obtained from the specified</span>
<a name="line-160"></a><span class='hs-comment'>-- 'AssertionPredicable' holds.</span>
<a name="line-161"></a><span class='hs-layout'>(</span><span class='hs-varop'>@?</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>AssertionPredicable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>t</span> <span class='hs-comment'>-- ^ A value of which the asserted condition is predicated</span>
<a name="line-162"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ A message that is displayed if the assertion fails</span>
<a name="line-163"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-164"></a><a name="pred"></a><span class='hs-definition'>pred</span> <span class='hs-varop'>@?</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>assertionPredicate</span> <span class='hs-varid'>pred</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>assertBool</span> <span class='hs-varid'>msg</span>
<a name="line-165"></a>
<a name="line-166"></a><a name="@=?"></a><span class='hs-comment'>-- | Asserts that the specified actual value is equal to the expected value</span>
<a name="line-167"></a><span class='hs-comment'>-- (with the expected value on the left-hand side).</span>
<a name="line-168"></a><span class='hs-layout'>(</span><span class='hs-varop'>@=?</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The expected value</span>
<a name="line-169"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The actual value</span>
<a name="line-170"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-171"></a><a name="expected"></a><span class='hs-definition'>expected</span> <span class='hs-varop'>@=?</span> <span class='hs-varid'>actual</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>assertEqual</span> <span class='hs-str'>""</span> <span class='hs-varid'>expected</span> <span class='hs-varid'>actual</span>
<a name="line-172"></a>
<a name="line-173"></a><a name="@?="></a><span class='hs-comment'>-- | Asserts that the specified actual value is equal to the expected value</span>
<a name="line-174"></a><span class='hs-comment'>-- (with the actual value on the left-hand side).</span>
<a name="line-175"></a><span class='hs-layout'>(</span><span class='hs-varop'>@?=</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The actual value</span>
<a name="line-176"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The expected value</span>
<a name="line-177"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Assertion</span>
<a name="line-178"></a><a name="actual"></a><span class='hs-definition'>actual</span> <span class='hs-varop'>@?=</span> <span class='hs-varid'>expected</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>assertEqual</span> <span class='hs-str'>""</span> <span class='hs-varid'>expected</span> <span class='hs-varid'>actual</span>
<a name="line-179"></a>
<a name="line-180"></a>
<a name="line-181"></a>
<a name="line-182"></a><span class='hs-comment'>-- Test Definition</span>
<a name="line-183"></a><span class='hs-comment'>-- ===============</span>
<a name="line-184"></a>
<a name="line-185"></a><a name="Test"></a><span class='hs-comment'>-- | The basic structure used to create an annotated tree of test cases.</span>
<a name="line-186"></a><a name="Test"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Test</span>
<a name="line-187"></a> <span class='hs-comment'>-- | A single, independent test case composed.</span>
<a name="line-188"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestCase</span> <span class='hs-conid'>Assertion</span>
<a name="line-189"></a> <span class='hs-comment'>-- | A set of @Test@s sharing the same level in the hierarchy. </span>
<a name="line-190"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>TestList</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Test</span><span class='hs-keyglyph'>]</span>
<a name="line-191"></a> <span class='hs-comment'>-- | A name or description for a subtree of the @Test@s.</span>
<a name="line-192"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>TestLabel</span> <span class='hs-conid'>String</span> <span class='hs-conid'>Test</span>
<a name="line-193"></a>
<a name="line-194"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Show</span> <span class='hs-conid'>Test</span> <span class='hs-keyword'>where</span>
<a name="line-195"></a> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>p</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestCase</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>showString</span> <span class='hs-str'>"TestCase _"</span>
<a name="line-196"></a> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>p</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestList</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>showString</span> <span class='hs-str'>"TestList "</span> <span class='hs-varop'>.</span> <span class='hs-varid'>showList</span> <span class='hs-varid'>ts</span>
<a name="line-197"></a> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>p</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestLabel</span> <span class='hs-varid'>l</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>showString</span> <span class='hs-str'>"TestLabel "</span> <span class='hs-varop'>.</span> <span class='hs-varid'>showString</span> <span class='hs-varid'>l</span>
<a name="line-198"></a> <span class='hs-varop'>.</span> <span class='hs-varid'>showChar</span> <span class='hs-chr'>' '</span> <span class='hs-varop'>.</span> <span class='hs-varid'>showsPrec</span> <span class='hs-varid'>p</span> <span class='hs-varid'>t</span>
<a name="line-199"></a>
<a name="line-200"></a><span class='hs-comment'>-- Overloaded `test` Function</span>
<a name="line-201"></a><span class='hs-comment'>-- --------------------------</span>
<a name="line-202"></a>
<a name="line-203"></a><a name="Testable"></a><span class='hs-comment'>-- | Provides a way to convert data into a @Test@ or set of @Test@.</span>
<a name="line-204"></a><a name="Testable"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>Testable</span> <span class='hs-varid'>t</span>
<a name="line-205"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>test</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-206"></a>
<a name="line-207"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Testable</span> <span class='hs-conid'>Test</span>
<a name="line-208"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>test</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span>
<a name="line-209"></a>
<a name="line-210"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>Assertable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Testable</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-211"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>test</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestCase</span> <span class='hs-varop'>.</span> <span class='hs-varid'>assert</span>
<a name="line-212"></a>
<a name="line-213"></a><span class='hs-keyword'>instance</span> <span class='hs-layout'>(</span><span class='hs-conid'>Testable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Testable</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>t</span><span class='hs-keyglyph'>]</span>
<a name="line-214"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>test</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestList</span> <span class='hs-varop'>.</span> <span class='hs-varid'>map</span> <span class='hs-varid'>test</span>
<a name="line-215"></a>
<a name="line-216"></a>
<a name="line-217"></a><span class='hs-comment'>-- Test Construction Operators</span>
<a name="line-218"></a><span class='hs-comment'>-- ---------------------------</span>
<a name="line-219"></a>
<a name="line-220"></a><span class='hs-keyword'>infix</span> <span class='hs-num'>1</span> <span class='hs-varop'>~?</span><span class='hs-layout'>,</span> <span class='hs-varop'>~=?</span><span class='hs-layout'>,</span> <span class='hs-varop'>~?=</span>
<a name="line-221"></a><span class='hs-keyword'>infixr</span> <span class='hs-num'>0</span> <span class='hs-varop'>~:</span>
<a name="line-222"></a>
<a name="line-223"></a><a name="~?"></a><span class='hs-comment'>-- | Creates a test case resulting from asserting the condition obtained </span>
<a name="line-224"></a><span class='hs-comment'>-- from the specified 'AssertionPredicable'.</span>
<a name="line-225"></a><span class='hs-layout'>(</span><span class='hs-varop'>~?</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>AssertionPredicable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>t</span> <span class='hs-comment'>-- ^ A value of which the asserted condition is predicated</span>
<a name="line-226"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ A message that is displayed on test failure</span>
<a name="line-227"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-228"></a><span class='hs-definition'>pred</span> <span class='hs-varop'>~?</span> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestCase</span> <span class='hs-layout'>(</span><span class='hs-varid'>pred</span> <span class='hs-varop'>@?</span> <span class='hs-varid'>msg</span><span class='hs-layout'>)</span>
<a name="line-229"></a>
<a name="line-230"></a><a name="~=?"></a><span class='hs-comment'>-- | Shorthand for a test case that asserts equality (with the expected </span>
<a name="line-231"></a><span class='hs-comment'>-- value on the left-hand side, and the actual value on the right-hand</span>
<a name="line-232"></a><span class='hs-comment'>-- side).</span>
<a name="line-233"></a><span class='hs-layout'>(</span><span class='hs-varop'>~=?</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The expected value </span>
<a name="line-234"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The actual value</span>
<a name="line-235"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-236"></a><span class='hs-definition'>expected</span> <span class='hs-varop'>~=?</span> <span class='hs-varid'>actual</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestCase</span> <span class='hs-layout'>(</span><span class='hs-varid'>expected</span> <span class='hs-varop'>@=?</span> <span class='hs-varid'>actual</span><span class='hs-layout'>)</span>
<a name="line-237"></a>
<a name="line-238"></a><a name="~?="></a><span class='hs-comment'>-- | Shorthand for a test case that asserts equality (with the actual </span>
<a name="line-239"></a><span class='hs-comment'>-- value on the left-hand side, and the expected value on the right-hand</span>
<a name="line-240"></a><span class='hs-comment'>-- side).</span>
<a name="line-241"></a><span class='hs-layout'>(</span><span class='hs-varop'>~?=</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The actual value</span>
<a name="line-242"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-comment'>-- ^ The expected value </span>
<a name="line-243"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-244"></a><span class='hs-definition'>actual</span> <span class='hs-varop'>~?=</span> <span class='hs-varid'>expected</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestCase</span> <span class='hs-layout'>(</span><span class='hs-varid'>actual</span> <span class='hs-varop'>@?=</span> <span class='hs-varid'>expected</span><span class='hs-layout'>)</span>
<a name="line-245"></a>
<a name="line-246"></a><a name="~:"></a><span class='hs-comment'>-- | Creates a test from the specified 'Testable', with the specified </span>
<a name="line-247"></a><span class='hs-comment'>-- label attached to it.</span>
<a name="line-248"></a><span class='hs-comment'>--</span>
<a name="line-249"></a><span class='hs-comment'>-- Since 'Test' is @Testable@, this can be used as a shorthand way of attaching</span>
<a name="line-250"></a><span class='hs-comment'>-- a 'TestLabel' to one or more tests. </span>
<a name="line-251"></a><span class='hs-layout'>(</span><span class='hs-varop'>~:</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Testable</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-252"></a><a name="label"></a><span class='hs-definition'>label</span> <span class='hs-varop'>~:</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestLabel</span> <span class='hs-varid'>label</span> <span class='hs-layout'>(</span><span class='hs-varid'>test</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-253"></a>
<a name="line-254"></a>
<a name="line-255"></a>
<a name="line-256"></a><span class='hs-comment'>-- Test Execution</span>
<a name="line-257"></a><span class='hs-comment'>-- ==============</span>
<a name="line-258"></a>
<a name="line-259"></a><span class='hs-comment'>-- $testExecutionNote</span>
<a name="line-260"></a><span class='hs-comment'>-- Note: the rest of the functionality in this module is intended for </span>
<a name="line-261"></a><span class='hs-comment'>-- implementors of test controllers. If you just want to run your tests cases,</span>
<a name="line-262"></a><span class='hs-comment'>-- simply use a test controller, such as the text-based controller in </span>
<a name="line-263"></a><span class='hs-comment'>-- "Test.HUnit.Text".</span>
<a name="line-264"></a>
<a name="line-265"></a><a name="Counts"></a><span class='hs-comment'>-- | A data structure that hold the results of tests that have been performed</span>
<a name="line-266"></a><a name="Counts"></a><span class='hs-comment'>-- up until this point.</span>
<a name="line-267"></a><a name="Counts"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Counts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Counts</span> <span class='hs-layout'>{</span> <span class='hs-varid'>cases</span><span class='hs-layout'>,</span> <span class='hs-varid'>tried</span><span class='hs-layout'>,</span> <span class='hs-varid'>errors</span><span class='hs-layout'>,</span> <span class='hs-varid'>failures</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span> <span class='hs-layout'>}</span>
<a name="line-268"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-269"></a>
<a name="line-270"></a><a name="State"></a><span class='hs-comment'>-- | Keeps track of the remaining tests and the results of the performed tests.</span>
<a name="line-271"></a><a name="State"></a><span class='hs-comment'>-- As each test is performed, the path is removed and the counts are</span>
<a name="line-272"></a><a name="State"></a><span class='hs-comment'>-- updated as appropriate.</span>
<a name="line-273"></a><a name="State"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>State</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>State</span> <span class='hs-layout'>{</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Path</span><span class='hs-layout'>,</span> <span class='hs-varid'>counts</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Counts</span> <span class='hs-layout'>}</span>
<a name="line-274"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-275"></a>
<a name="line-276"></a><a name="ReportStart"></a><span class='hs-comment'>-- | Report generator for reporting the start of a test run.</span>
<a name="line-277"></a><a name="ReportStart"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ReportStart</span> <span class='hs-varid'>us</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>State</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>us</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>us</span>
<a name="line-278"></a>
<a name="line-279"></a><a name="ReportProblem"></a><span class='hs-comment'>-- | Report generator for reporting problems that have occurred during</span>
<a name="line-280"></a><a name="ReportProblem"></a><span class='hs-comment'>-- a test run. Problems may be errors or assertion failures.</span>
<a name="line-281"></a><a name="ReportProblem"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>ReportProblem</span> <span class='hs-varid'>us</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>State</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>us</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-varid'>us</span>
<a name="line-282"></a>
<a name="line-283"></a><a name="Path"></a><span class='hs-comment'>-- | Uniquely describes the location of a test within a test hierarchy.</span>
<a name="line-284"></a><a name="Path"></a><span class='hs-comment'>-- Node order is from test case to root.</span>
<a name="line-285"></a><a name="Path"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Path</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Node</span><span class='hs-keyglyph'>]</span>
<a name="line-286"></a>
<a name="line-287"></a><a name="Node"></a><span class='hs-comment'>-- | Composed into 'Path's.</span>
<a name="line-288"></a><a name="Node"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Node</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ListItem</span> <span class='hs-conid'>Int</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Label</span> <span class='hs-conid'>String</span>
<a name="line-289"></a> <span class='hs-keyword'>deriving</span> <span class='hs-layout'>(</span><span class='hs-conid'>Eq</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>,</span> <span class='hs-conid'>Read</span><span class='hs-layout'>)</span>
<a name="line-290"></a>
<a name="line-291"></a><a name="testCasePaths"></a><span class='hs-comment'>-- | Determines the paths for all 'TestCase's in a tree of @Test@s.</span>
<a name="line-292"></a><span class='hs-definition'>testCasePaths</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Path</span><span class='hs-keyglyph'>]</span>
<a name="line-293"></a><span class='hs-definition'>testCasePaths</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tcp</span> <span class='hs-varid'>t</span> <span class='hs-conid'>[]</span>
<a name="line-294"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>tcp</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestCase</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>p</span><span class='hs-keyglyph'>]</span>
<a name="line-295"></a> <span class='hs-varid'>tcp</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestList</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span>
<a name="line-296"></a> <span class='hs-varid'>concat</span> <span class='hs-keyglyph'>[</span> <span class='hs-varid'>tcp</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-conid'>ListItem</span> <span class='hs-varid'>n</span> <span class='hs-conop'>:</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span><span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>zip</span> <span class='hs-varid'>ts</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>]</span>
<a name="line-297"></a> <span class='hs-varid'>tcp</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestLabel</span> <span class='hs-varid'>l</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-varid'>p</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>tcp</span> <span class='hs-varid'>t</span> <span class='hs-layout'>(</span><span class='hs-conid'>Label</span> <span class='hs-varid'>l</span> <span class='hs-conop'>:</span> <span class='hs-varid'>p</span><span class='hs-layout'>)</span>
<a name="line-298"></a>
<a name="line-299"></a><a name="testCaseCount"></a><span class='hs-comment'>-- | Counts the number of 'TestCase's in a tree of @Test@s.</span>
<a name="line-300"></a><span class='hs-definition'>testCaseCount</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Int</span>
<a name="line-301"></a><span class='hs-definition'>testCaseCount</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestCase</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>1</span>
<a name="line-302"></a><span class='hs-definition'>testCaseCount</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestList</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>sum</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>testCaseCount</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span>
<a name="line-303"></a><span class='hs-definition'>testCaseCount</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestLabel</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>testCaseCount</span> <span class='hs-varid'>t</span>
<a name="line-304"></a>
<a name="line-305"></a><a name="performTest"></a><span class='hs-comment'>-- | Performs a test run with the specified report generators. </span>
<a name="line-306"></a><span class='hs-comment'>--</span>
<a name="line-307"></a><span class='hs-comment'>-- This handles the actual running of the tests. Most developers will want </span>
<a name="line-308"></a><span class='hs-comment'>-- to use @HUnit.Text.runTestTT@ instead. A developer could use this function </span>
<a name="line-309"></a><span class='hs-comment'>-- to execute tests via another IO system, such as a GUI, or to output the </span>
<a name="line-310"></a><span class='hs-comment'>-- results in a different manner (e.g., upload XML-formatted results to a </span>
<a name="line-311"></a><span class='hs-comment'>-- webservice). </span>
<a name="line-312"></a><span class='hs-comment'>--</span>
<a name="line-313"></a><span class='hs-comment'>-- Note that the counts in a start report do not include the test case</span>
<a name="line-314"></a><span class='hs-comment'>-- being started, whereas the counts in a problem report do include the</span>
<a name="line-315"></a><span class='hs-comment'>-- test case just finished. The principle is that the counts are sampled</span>
<a name="line-316"></a><span class='hs-comment'>-- only between test case executions. As a result, the number of test</span>
<a name="line-317"></a><span class='hs-comment'>-- case successes always equals the difference of test cases tried and</span>
<a name="line-318"></a><span class='hs-comment'>-- the sum of test case errors and failures.</span>
<a name="line-319"></a><span class='hs-definition'>performTest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>ReportStart</span> <span class='hs-varid'>us</span> <span class='hs-comment'>-- ^ report generator for the test run start </span>
<a name="line-320"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ReportProblem</span> <span class='hs-varid'>us</span> <span class='hs-comment'>-- ^ report generator for errors during the test run</span>
<a name="line-321"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>ReportProblem</span> <span class='hs-varid'>us</span> <span class='hs-comment'>-- ^ report generator for assertion failures during the test run</span>
<a name="line-322"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>us</span>
<a name="line-323"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span> <span class='hs-comment'>-- ^ the test to be executed </span>
<a name="line-324"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-conid'>Counts</span><span class='hs-layout'>,</span> <span class='hs-varid'>us</span><span class='hs-layout'>)</span>
<a name="line-325"></a><span class='hs-definition'>performTest</span> <span class='hs-varid'>reportStart</span> <span class='hs-varid'>reportError</span> <span class='hs-varid'>reportFailure</span> <span class='hs-varid'>us</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-326"></a> <span class='hs-layout'>(</span><span class='hs-varid'>ss'</span><span class='hs-layout'>,</span> <span class='hs-varid'>us'</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>pt</span> <span class='hs-varid'>initState</span> <span class='hs-varid'>us</span> <span class='hs-varid'>t</span>
<a name="line-327"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-layout'>(</span><span class='hs-varid'>path</span> <span class='hs-varid'>ss'</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>error</span> <span class='hs-str'>"performTest: Final path is nonnull"</span>
<a name="line-328"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>counts</span> <span class='hs-varid'>ss'</span><span class='hs-layout'>,</span> <span class='hs-varid'>us'</span><span class='hs-layout'>)</span>
<a name="line-329"></a> <span class='hs-keyword'>where</span>
<a name="line-330"></a> <span class='hs-varid'>initState</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>State</span><span class='hs-layout'>{</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>[]</span><span class='hs-layout'>,</span> <span class='hs-varid'>counts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>initCounts</span> <span class='hs-layout'>}</span>
<a name="line-331"></a> <span class='hs-varid'>initCounts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Counts</span><span class='hs-layout'>{</span> <span class='hs-varid'>cases</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>testCaseCount</span> <span class='hs-varid'>t</span><span class='hs-layout'>,</span> <span class='hs-varid'>tried</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span><span class='hs-layout'>,</span>
<a name="line-332"></a> <span class='hs-varid'>errors</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span><span class='hs-layout'>,</span> <span class='hs-varid'>failures</span> <span class='hs-keyglyph'>=</span> <span class='hs-num'>0</span><span class='hs-layout'>}</span>
<a name="line-333"></a>
<a name="line-334"></a> <span class='hs-varid'>pt</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestCase</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-335"></a> <span class='hs-varid'>us'</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>reportStart</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span>
<a name="line-336"></a> <span class='hs-varid'>r</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>performTestCase</span> <span class='hs-varid'>a</span>
<a name="line-337"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>r</span> <span class='hs-keyword'>of</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss'</span><span class='hs-layout'>,</span> <span class='hs-varid'>us'</span><span class='hs-layout'>)</span>
<a name="line-338"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>True</span><span class='hs-layout'>,</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>usF</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>reportFailure</span> <span class='hs-varid'>m</span> <span class='hs-varid'>ssF</span> <span class='hs-varid'>us'</span>
<a name="line-339"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ssF</span><span class='hs-layout'>,</span> <span class='hs-varid'>usF</span><span class='hs-layout'>)</span>
<a name="line-340"></a> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-conid'>False</span><span class='hs-layout'>,</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span> <span class='hs-varid'>usE</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>reportError</span> <span class='hs-varid'>m</span> <span class='hs-varid'>ssE</span> <span class='hs-varid'>us'</span>
<a name="line-341"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ssE</span><span class='hs-layout'>,</span> <span class='hs-varid'>usE</span><span class='hs-layout'>)</span>
<a name="line-342"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>c</span><span class='hs-keyglyph'>@</span><span class='hs-conid'>Counts</span><span class='hs-layout'>{</span> <span class='hs-varid'>tried</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span> <span class='hs-layout'>}</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>counts</span> <span class='hs-varid'>ss</span>
<a name="line-343"></a> <span class='hs-varid'>ss'</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ss</span><span class='hs-layout'>{</span> <span class='hs-varid'>counts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>c</span><span class='hs-layout'>{</span> <span class='hs-varid'>tried</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span> <span class='hs-layout'>}</span> <span class='hs-layout'>}</span>
<a name="line-344"></a> <span class='hs-varid'>ssF</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ss</span><span class='hs-layout'>{</span> <span class='hs-varid'>counts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>c</span><span class='hs-layout'>{</span> <span class='hs-varid'>tried</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span><span class='hs-layout'>,</span> <span class='hs-varid'>failures</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>failures</span> <span class='hs-varid'>c</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span> <span class='hs-layout'>}</span> <span class='hs-layout'>}</span>
<a name="line-345"></a> <span class='hs-varid'>ssE</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ss</span><span class='hs-layout'>{</span> <span class='hs-varid'>counts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>c</span><span class='hs-layout'>{</span> <span class='hs-varid'>tried</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>t</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span><span class='hs-layout'>,</span> <span class='hs-varid'>errors</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>errors</span> <span class='hs-varid'>c</span> <span class='hs-varop'>+</span> <span class='hs-num'>1</span> <span class='hs-layout'>}</span> <span class='hs-layout'>}</span>
<a name="line-346"></a>
<a name="line-347"></a> <span class='hs-varid'>pt</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestList</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>foldM</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss</span><span class='hs-layout'>,</span> <span class='hs-varid'>us</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>zip</span> <span class='hs-varid'>ts</span> <span class='hs-keyglyph'>[</span><span class='hs-num'>0</span><span class='hs-keyglyph'>..</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span>
<a name="line-348"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>f</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss</span><span class='hs-layout'>,</span> <span class='hs-varid'>us</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>t</span><span class='hs-layout'>,</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withNode</span> <span class='hs-layout'>(</span><span class='hs-conid'>ListItem</span> <span class='hs-varid'>n</span><span class='hs-layout'>)</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span> <span class='hs-varid'>t</span>
<a name="line-349"></a>
<a name="line-350"></a> <span class='hs-varid'>pt</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestLabel</span> <span class='hs-varid'>label</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withNode</span> <span class='hs-layout'>(</span><span class='hs-conid'>Label</span> <span class='hs-varid'>label</span><span class='hs-layout'>)</span> <span class='hs-varid'>ss</span> <span class='hs-varid'>us</span> <span class='hs-varid'>t</span>
<a name="line-351"></a>
<a name="line-352"></a> <span class='hs-varid'>withNode</span> <span class='hs-varid'>node</span> <span class='hs-varid'>ss0</span> <span class='hs-varid'>us0</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss2</span><span class='hs-layout'>,</span> <span class='hs-varid'>us1</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>pt</span> <span class='hs-varid'>ss1</span> <span class='hs-varid'>us0</span> <span class='hs-varid'>t</span>
<a name="line-353"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>ss2</span><span class='hs-layout'>{</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>path0</span> <span class='hs-layout'>}</span><span class='hs-layout'>,</span> <span class='hs-varid'>us1</span><span class='hs-layout'>)</span>
<a name="line-354"></a> <span class='hs-keyword'>where</span> <span class='hs-varid'>path0</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>path</span> <span class='hs-varid'>ss0</span>
<a name="line-355"></a> <span class='hs-varid'>ss1</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ss0</span><span class='hs-layout'>{</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>node</span> <span class='hs-conop'>:</span> <span class='hs-varid'>path0</span> <span class='hs-layout'>}</span>
</pre></body>
</html>
