/usr/share/doc/libghc-test-framework-doc/html/src/Test-Framework-Core.html is in libghc-test-framework-doc 0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 | <?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://code.haskell.org/~malcolm/hscolour/ -->
<title>Test/Framework/Core.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE UndecidableInstances #-}</span>
<a name="line-2"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Framework</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span> <span class='hs-keyword'>where</span>
<a name="line-3"></a>
<a name="line-4"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Framework</span><span class='hs-varop'>.</span><span class='hs-conid'>Improving</span>
<a name="line-5"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Framework</span><span class='hs-varop'>.</span><span class='hs-conid'>Options</span>
<a name="line-6"></a>
<a name="line-7"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Concurrent</span><span class='hs-varop'>.</span><span class='hs-conid'>MVar</span>
<a name="line-8"></a>
<a name="line-9"></a>
<a name="line-10"></a><a name="TestResultlike"></a><span class='hs-comment'>-- | Something like the result of a test: works in concert with 'Testlike'.</span>
<a name="line-11"></a><a name="TestResultlike"></a><span class='hs-comment'>-- The type parameters are the type that is used for progress reports and the</span>
<a name="line-12"></a><a name="TestResultlike"></a><span class='hs-comment'>-- type of the final output of the test respectively.</span>
<a name="line-13"></a><a name="TestResultlike"></a><span class='hs-keyword'>class</span> <span class='hs-layout'>(</span><span class='hs-conid'>Show</span> <span class='hs-varid'>i</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span> <span class='hs-varid'>r</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>TestResultlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span> <span class='hs-keyword'>where</span>
<a name="line-14"></a> <span class='hs-varid'>testSucceeded</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-15"></a>
<a name="line-16"></a><a name="Testlike"></a><span class='hs-comment'>-- | Something test-like in its behaviour. The type parameters are the type that</span>
<a name="line-17"></a><a name="Testlike"></a><span class='hs-comment'>-- is used for progress reports, the type of the final output of the test and the</span>
<a name="line-18"></a><a name="Testlike"></a><span class='hs-comment'>-- data type encapsulating the whole potential to do a test respectively.</span>
<a name="line-19"></a><a name="Testlike"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>TestResultlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Testlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span><span class='hs-layout'>,</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>i</span> <span class='hs-keyword'>where</span>
<a name="line-20"></a> <span class='hs-varid'>runTest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>CompleteTestOptions</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-layout'>(</span><span class='hs-varid'>i</span> <span class='hs-conop'>:~></span> <span class='hs-varid'>r</span><span class='hs-layout'>,</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-21"></a> <span class='hs-varid'>testTypeName</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestTypeName</span>
<a name="line-22"></a>
<a name="line-23"></a>
<a name="line-24"></a><a name="TestName"></a><span class='hs-comment'>-- | Test names or descriptions. These are shown to the user</span>
<a name="line-25"></a><a name="TestName"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>TestName</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-26"></a>
<a name="line-27"></a><a name="TestTypeName"></a><span class='hs-comment'>-- | The name of a type of test, such as "Properties" or "Test Cases". Tests of</span>
<a name="line-28"></a><a name="TestTypeName"></a><span class='hs-comment'>-- types of the same names will be grouped together in the test run summary.</span>
<a name="line-29"></a><a name="TestTypeName"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>TestTypeName</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>String</span>
<a name="line-30"></a>
<a name="line-31"></a><a name="Test"></a><span class='hs-comment'>-- | Main test data type: builds up a list of tests to be run. Users should use the</span>
<a name="line-32"></a><a name="Test"></a><span class='hs-comment'>-- utility functions in e.g. the test-framework-hunit and test-framework-quickcheck</span>
<a name="line-33"></a><a name="Test"></a><span class='hs-comment'>-- packages to create instances of 'Test', and then build them up into testsuites</span>
<a name="line-34"></a><a name="Test"></a><span class='hs-comment'>-- by using 'testGroup' and lists.</span>
<a name="line-35"></a><a name="Test"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><a name="Test"></a><span class='hs-comment'>-- For an example of how to use test-framework, please see</span>
<a name="line-37"></a><a name="Test"></a><span class='hs-comment'>-- <<a href="http://github.com/batterseapower/test-framework/raw/master/example/Test/Framework/Example.lhs">http://github.com/batterseapower/test-framework/raw/master/example/Test/Framework/Example.lhs</a>></span>
<a name="line-38"></a><a name="Test"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>forall</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-varid'>t</span><span class='hs-varop'>.</span> <span class='hs-conid'>Testlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Test</span> <span class='hs-conid'>TestName</span> <span class='hs-varid'>t</span> <span class='hs-comment'>-- ^ A single test of some particular type</span>
<a name="line-39"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>TestGroup</span> <span class='hs-conid'>TestName</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Test</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Assemble a number of tests into a cohesive group</span>
<a name="line-40"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>PlusTestOptions</span> <span class='hs-conid'>TestOptions</span> <span class='hs-conid'>Test</span> <span class='hs-comment'>-- ^ Add some options to child tests</span>
<a name="line-41"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>BuildTest</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>Test</span><span class='hs-layout'>)</span> <span class='hs-comment'>-- ^ Convenience for creating tests from an 'IO' action</span>
<a name="line-42"></a>
<a name="line-43"></a><a name="testGroup"></a><span class='hs-comment'>-- | Assemble a number of tests into a cohesive group</span>
<a name="line-44"></a><span class='hs-definition'>testGroup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestName</span> <span class='hs-keyglyph'>-></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'>Test</span>
<a name="line-45"></a><span class='hs-definition'>testGroup</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestGroup</span>
<a name="line-46"></a>
<a name="line-47"></a><a name="plusTestOptions"></a><span class='hs-comment'>-- | Add some options to child tests</span>
<a name="line-48"></a><span class='hs-definition'>plusTestOptions</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestOptions</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-49"></a><span class='hs-definition'>plusTestOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PlusTestOptions</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="buildTest"></a><span class='hs-comment'>-- | Convenience for creating tests from an 'IO' action</span>
<a name="line-52"></a><span class='hs-definition'>buildTest</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-53"></a><span class='hs-definition'>buildTest</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BuildTest</span>
<a name="line-54"></a>
<a name="line-55"></a>
<a name="line-56"></a><a name="MutuallyExcluded"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>MutuallyExcluded</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>ME</span> <span class='hs-layout'>(</span><span class='hs-conid'>MVar</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-varid'>t</span>
<a name="line-57"></a>
<a name="line-58"></a><span class='hs-comment'>-- This requires UndecidableInstances, but I think it can't be made inconsistent?</span>
<a name="line-59"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Testlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-varid'>t</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>Testlike</span> <span class='hs-varid'>i</span> <span class='hs-varid'>r</span> <span class='hs-layout'>(</span><span class='hs-conid'>MutuallyExcluded</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-60"></a> <span class='hs-varid'>runTest</span> <span class='hs-varid'>cto</span> <span class='hs-layout'>(</span><span class='hs-conid'>ME</span> <span class='hs-varid'>mvar</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withMVar</span> <span class='hs-varid'>mvar</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-conid'>()</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>runTest</span> <span class='hs-varid'>cto</span> <span class='hs-varid'>x</span>
<a name="line-61"></a> <span class='hs-varid'>testTypeName</span> <span class='hs-keyglyph'>~</span><span class='hs-layout'>(</span><span class='hs-conid'>ME</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>testTypeName</span> <span class='hs-varid'>x</span>
<a name="line-62"></a>
<a name="line-63"></a><a name="mutuallyExclusive"></a><span class='hs-comment'>-- | Mark all tests in this portion of the tree as mutually exclusive, so only one runs at a time</span>
<a name="line-64"></a><span class='hs-comment'>{-# NOINLINE mutuallyExclusive #-}</span>
<a name="line-65"></a><span class='hs-definition'>mutuallyExclusive</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Test</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Test</span>
<a name="line-66"></a><span class='hs-definition'>mutuallyExclusive</span> <span class='hs-varid'>init_t</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BuildTest</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-67"></a> <span class='hs-varid'>mvar</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>newMVar</span> <span class='hs-conid'>()</span>
<a name="line-68"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>go</span> <span class='hs-layout'>(</span><span class='hs-conid'>Test</span> <span class='hs-varid'>tn</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Test</span> <span class='hs-varid'>tn</span> <span class='hs-layout'>(</span><span class='hs-conid'>ME</span> <span class='hs-varid'>mvar</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-69"></a> <span class='hs-varid'>go</span> <span class='hs-layout'>(</span><span class='hs-conid'>TestGroup</span> <span class='hs-varid'>tn</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestGroup</span> <span class='hs-varid'>tn</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>go</span> <span class='hs-varid'>ts</span><span class='hs-layout'>)</span>
<a name="line-70"></a> <span class='hs-varid'>go</span> <span class='hs-layout'>(</span><span class='hs-conid'>PlusTestOptions</span> <span class='hs-varid'>to</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>PlusTestOptions</span> <span class='hs-varid'>to</span> <span class='hs-layout'>(</span><span class='hs-varid'>go</span> <span class='hs-varid'>t</span><span class='hs-layout'>)</span>
<a name="line-71"></a> <span class='hs-varid'>go</span> <span class='hs-layout'>(</span><span class='hs-conid'>BuildTest</span> <span class='hs-varid'>build</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BuildTest</span> <span class='hs-layout'>(</span><span class='hs-varid'>fmap</span> <span class='hs-varid'>go</span> <span class='hs-varid'>build</span><span class='hs-layout'>)</span>
<a name="line-72"></a> <span class='hs-varid'>return</span> <span class='hs-layout'>(</span><span class='hs-varid'>go</span> <span class='hs-varid'>init_t</span><span class='hs-layout'>)</span>
</pre></body>
</html>
|