/usr/share/doc/libghc-cabal-doc/html/src/Distribution-TestSuite.html is in libghc-cabal-doc 1.20.0.2-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 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 | <?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>Distribution/TestSuite.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>-----------------------------------------------------------------------------</span>
<a name="line-2"></a><span class='hs-comment'>-- |</span>
<a name="line-3"></a><span class='hs-comment'>-- Module : Distribution.TestSuite</span>
<a name="line-4"></a><span class='hs-comment'>-- Copyright : Thomas Tuegel 2010</span>
<a name="line-5"></a><span class='hs-comment'>-- License : BSD3</span>
<a name="line-6"></a><span class='hs-comment'>--</span>
<a name="line-7"></a><span class='hs-comment'>-- Maintainer : cabal-devel@haskell.org</span>
<a name="line-8"></a><span class='hs-comment'>-- Portability : portable</span>
<a name="line-9"></a><span class='hs-comment'>--</span>
<a name="line-10"></a><span class='hs-comment'>-- This module defines the detailed test suite interface which makes it</span>
<a name="line-11"></a><span class='hs-comment'>-- possible to expose individual tests to Cabal or other test agents.</span>
<a name="line-12"></a>
<a name="line-13"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Distribution</span><span class='hs-varop'>.</span><span class='hs-conid'>TestSuite</span>
<a name="line-14"></a> <span class='hs-layout'>(</span> <span class='hs-conid'>TestInstance</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>OptionDescr</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-16"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>OptionType</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Test</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Options</span>
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Progress</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>Result</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-21"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>testGroup</span>
<a name="line-22"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-23"></a>
<a name="line-24"></a><a name="TestInstance"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>TestInstance</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>TestInstance</span>
<a name="line-25"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>run</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Progress</span> <span class='hs-comment'>-- ^ Perform the test.</span>
<a name="line-26"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>name</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ A name for the test, unique within a</span>
<a name="line-27"></a> <span class='hs-comment'>-- test suite.</span>
<a name="line-28"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>tags</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Users can select groups of tests by</span>
<a name="line-29"></a> <span class='hs-comment'>-- their tags.</span>
<a name="line-30"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>options</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptionDescr</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ Descriptions of the options recognized</span>
<a name="line-31"></a> <span class='hs-comment'>-- by this test.</span>
<a name="line-32"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>setOption</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Either</span> <span class='hs-conid'>String</span> <span class='hs-conid'>TestInstance</span>
<a name="line-33"></a> <span class='hs-comment'>-- ^ Try to set the named option to the given value. Returns an error</span>
<a name="line-34"></a> <span class='hs-comment'>-- message if the option is not supported or the value could not be</span>
<a name="line-35"></a> <span class='hs-comment'>-- correctly parsed; otherwise, a 'TestInstance' with the option set to</span>
<a name="line-36"></a> <span class='hs-comment'>-- the given value is returned.</span>
<a name="line-37"></a> <span class='hs-layout'>}</span>
<a name="line-38"></a>
<a name="line-39"></a><a name="OptionDescr"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>OptionDescr</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>OptionDescr</span>
<a name="line-40"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>optionName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-41"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionDescription</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span> <span class='hs-comment'>-- ^ A human-readable description of the</span>
<a name="line-42"></a> <span class='hs-comment'>-- option to guide the user setting it.</span>
<a name="line-43"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionType</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>OptionType</span>
<a name="line-44"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionDefault</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span>
<a name="line-45"></a> <span class='hs-layout'>}</span>
<a name="line-46"></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'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-47"></a>
<a name="line-48"></a><a name="OptionType"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>OptionType</span>
<a name="line-49"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>OptionFile</span>
<a name="line-50"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>optionFileMustExist</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-51"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionFileIsDir</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-52"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionFileExtensions</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-53"></a> <span class='hs-layout'>}</span>
<a name="line-54"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionString</span>
<a name="line-55"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>optionStringMultiline</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-56"></a> <span class='hs-layout'>}</span>
<a name="line-57"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionNumber</span>
<a name="line-58"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>optionNumberIsInt</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-59"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>optionNumberBounds</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>Maybe</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span>
<a name="line-60"></a> <span class='hs-layout'>}</span>
<a name="line-61"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionBool</span>
<a name="line-62"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionEnum</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-63"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionSet</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>String</span><span class='hs-keyglyph'>]</span>
<a name="line-64"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>OptionRngSeed</span>
<a name="line-65"></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'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-66"></a>
<a name="line-67"></a><a name="Test"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Test</span>
<a name="line-68"></a> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Test</span> <span class='hs-conid'>TestInstance</span>
<a name="line-69"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Group</span>
<a name="line-70"></a> <span class='hs-layout'>{</span> <span class='hs-varid'>groupName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</span>
<a name="line-71"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>concurrently</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span>
<a name="line-72"></a> <span class='hs-comment'>-- ^ If true, then children of this group may be run in parallel.</span>
<a name="line-73"></a> <span class='hs-comment'>-- Note that this setting is not inherited by children. In</span>
<a name="line-74"></a> <span class='hs-comment'>-- particular, consider a group F with "concurrently = False" that</span>
<a name="line-75"></a> <span class='hs-comment'>-- has some children, including a group T with "concurrently =</span>
<a name="line-76"></a> <span class='hs-comment'>-- True". The children of group T may be run concurrently with each</span>
<a name="line-77"></a> <span class='hs-comment'>-- other, as long as none are run at the same time as any of the</span>
<a name="line-78"></a> <span class='hs-comment'>-- direct children of group F.</span>
<a name="line-79"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>groupTests</span> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Test</span><span class='hs-keyglyph'>]</span>
<a name="line-80"></a> <span class='hs-layout'>}</span>
<a name="line-81"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>ExtraOptions</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>OptionDescr</span><span class='hs-keyglyph'>]</span> <span class='hs-conid'>Test</span>
<a name="line-82"></a>
<a name="line-83"></a><a name="Options"></a><span class='hs-keyword'>type</span> <span class='hs-conid'>Options</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyglyph'>[</span><span class='hs-layout'>(</span><span class='hs-conid'>String</span><span class='hs-layout'>,</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-84"></a>
<a name="line-85"></a><a name="Progress"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Progress</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Finished</span> <span class='hs-conid'>Result</span>
<a name="line-86"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Progress</span> <span class='hs-conid'>String</span> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-conid'>Progress</span><span class='hs-layout'>)</span>
<a name="line-87"></a>
<a name="line-88"></a><a name="Result"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Result</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Pass</span>
<a name="line-89"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Fail</span> <span class='hs-conid'>String</span>
<a name="line-90"></a> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Error</span> <span class='hs-conid'>String</span>
<a name="line-91"></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'>Read</span><span class='hs-layout'>,</span> <span class='hs-conid'>Show</span><span class='hs-layout'>)</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="testGroup"></a><span class='hs-comment'>-- | Create a named group of tests, which are assumed to be safe to run in</span>
<a name="line-94"></a><span class='hs-comment'>-- parallel.</span>
<a name="line-95"></a><span class='hs-definition'>testGroup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>String</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-96"></a><span class='hs-definition'>testGroup</span> <span class='hs-varid'>n</span> <span class='hs-varid'>ts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Group</span> <span class='hs-layout'>{</span> <span class='hs-varid'>groupName</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>n</span><span class='hs-layout'>,</span> <span class='hs-varid'>concurrently</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span><span class='hs-layout'>,</span> <span class='hs-varid'>groupTests</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>ts</span> <span class='hs-layout'>}</span>
</pre></body>
</html>
|