This file is indexed.

/usr/share/doc/libghc-hspec-core-doc/html/src/Test-Hspec-Core-Runner.html is in libghc-hspec-core-doc 2.2.4-3.

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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
<?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>src/Test/Hspec/Core/Runner.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE CPP #-}</span>
<a name="line-2"></a>
<a name="line-3"></a><span class='hs-cpp'>#if MIN_VERSION_base(4,6,0)</span>
<a name="line-4"></a><span class='hs-comment'>-- Control.Concurrent.QSem is deprecated in base-4.6.0.*</span>
<a name="line-5"></a><span class='hs-comment'>{-# OPTIONS_GHC -fno-warn-deprecations #-}</span>
<a name="line-6"></a><span class='hs-cpp'>#endif</span>
<a name="line-7"></a>
<a name="line-8"></a><span class='hs-comment'>-- |</span>
<a name="line-9"></a><span class='hs-comment'>-- Stability: provisional</span>
<a name="line-10"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Runner</span> <span class='hs-layout'>(</span>
<a name="line-11"></a><span class='hs-comment'>-- * Running a spec</span>
<a name="line-12"></a>  <span class='hs-varid'>hspec</span>
<a name="line-13"></a><span class='hs-layout'>,</span> <span class='hs-varid'>hspecWith</span>
<a name="line-14"></a><span class='hs-layout'>,</span> <span class='hs-varid'>hspecResult</span>
<a name="line-15"></a><span class='hs-layout'>,</span> <span class='hs-varid'>hspecWithResult</span>
<a name="line-16"></a>
<a name="line-17"></a><span class='hs-comment'>-- * Types</span>
<a name="line-18"></a><span class='hs-layout'>,</span> <span class='hs-conid'>Summary</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-19"></a><span class='hs-layout'>,</span> <span class='hs-conid'>Config</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'>ColorMode</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-conid'>Path</span>
<a name="line-22"></a><span class='hs-layout'>,</span> <span class='hs-varid'>defaultConfig</span>
<a name="line-23"></a><span class='hs-layout'>,</span> <span class='hs-varid'>configAddFilter</span>
<a name="line-24"></a><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-25"></a>
<a name="line-26"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Prelude</span> <span class='hs-conid'>()</span>
<a name="line-27"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Compat</span>
<a name="line-28"></a>
<a name="line-29"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span>
<a name="line-30"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Maybe</span>
<a name="line-31"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span>
<a name="line-32"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Environment</span> <span class='hs-layout'>(</span><span class='hs-varid'>getProgName</span><span class='hs-layout'>,</span> <span class='hs-varid'>getArgs</span><span class='hs-layout'>,</span> <span class='hs-varid'>withArgs</span><span class='hs-layout'>)</span>
<a name="line-33"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Exit</span>
<a name="line-34"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>E</span>
<a name="line-35"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Concurrent</span>
<a name="line-36"></a>
<a name="line-37"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Console</span><span class='hs-varop'>.</span><span class='hs-conid'>ANSI</span> <span class='hs-layout'>(</span><span class='hs-varid'>hHideCursor</span><span class='hs-layout'>,</span> <span class='hs-varid'>hShowCursor</span><span class='hs-layout'>)</span>
<a name="line-38"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>QuickCheck</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>QC</span>
<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-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Class</span> <span class='hs-layout'>(</span><span class='hs-varid'>liftIO</span><span class='hs-layout'>)</span>
<a name="line-40"></a>
<a name="line-41"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Util</span> <span class='hs-layout'>(</span><span class='hs-conid'>Path</span><span class='hs-layout'>)</span>
<a name="line-42"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Spec</span>
<a name="line-43"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Config</span>
<a name="line-44"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Formatters</span>
<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'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Formatters</span><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span>
<a name="line-46"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>FailureReport</span>
<a name="line-47"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>QuickCheckUtil</span>
<a name="line-48"></a>
<a name="line-49"></a><span class='hs-keyword'>import</span>           <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Hspec</span><span class='hs-varop'>.</span><span class='hs-conid'>Core</span><span class='hs-varop'>.</span><span class='hs-conid'>Runner</span><span class='hs-varop'>.</span><span class='hs-conid'>Eval</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="filterSpecs"></a><span class='hs-comment'>-- | Filter specs by given predicate.</span>
<a name="line-52"></a><span class='hs-comment'>--</span>
<a name="line-53"></a><span class='hs-comment'>-- The predicate takes a list of "describe" labels and a "requirement".</span>
<a name="line-54"></a><span class='hs-definition'>filterSpecs</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-55"></a><span class='hs-definition'>filterSpecs</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span> <span class='hs-conid'>[]</span>
<a name="line-56"></a>  <span class='hs-keyword'>where</span>
<a name="line-57"></a>    <span class='hs-varid'>p</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Path</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Bool</span>
<a name="line-58"></a>    <span class='hs-varid'>p</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-conid'>True</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>configFilterPredicate</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>path</span><span class='hs-layout'>)</span> <span class='hs-varop'>&amp;&amp;</span>
<a name="line-59"></a>               <span class='hs-varid'>not</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromMaybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>const</span> <span class='hs-conid'>False</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>configSkipPredicate</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>path</span><span class='hs-layout'>)</span>
<a name="line-60"></a>
<a name="line-61"></a>    <span class='hs-varid'>go</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-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span>
<a name="line-62"></a>    <span class='hs-varid'>go</span> <span class='hs-varid'>groups</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>mapMaybe</span> <span class='hs-layout'>(</span><span class='hs-varid'>goSpec</span> <span class='hs-varid'>groups</span><span class='hs-layout'>)</span>
<a name="line-63"></a>
<a name="line-64"></a>    <span class='hs-varid'>goSpecs</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-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Maybe</span> <span class='hs-varid'>b</span>
<a name="line-65"></a>    <span class='hs-varid'>goSpecs</span> <span class='hs-varid'>groups</span> <span class='hs-varid'>specs</span> <span class='hs-varid'>ctor</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>go</span> <span class='hs-varid'>groups</span> <span class='hs-varid'>specs</span> <span class='hs-keyword'>of</span>
<a name="line-66"></a>      <span class='hs-conid'>[]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Nothing</span>
<a name="line-67"></a>      <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>ctor</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-68"></a>
<a name="line-69"></a>    <span class='hs-varid'>goSpec</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-keyglyph'>-&gt;</span> <span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Maybe</span> <span class='hs-layout'>(</span><span class='hs-conid'>SpecTree</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-70"></a>    <span class='hs-varid'>goSpec</span> <span class='hs-varid'>groups</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>spec</span> <span class='hs-keyword'>of</span>
<a name="line-71"></a>      <span class='hs-conid'>Leaf</span> <span class='hs-varid'>item</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>guard</span> <span class='hs-layout'>(</span><span class='hs-varid'>p</span> <span class='hs-layout'>(</span><span class='hs-varid'>groups</span><span class='hs-layout'>,</span> <span class='hs-varid'>itemRequirement</span> <span class='hs-varid'>item</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varop'>&gt;&gt;</span> <span class='hs-varid'>return</span> <span class='hs-varid'>spec</span>
<a name="line-72"></a>      <span class='hs-conid'>Node</span> <span class='hs-varid'>group</span> <span class='hs-varid'>specs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>goSpecs</span> <span class='hs-layout'>(</span><span class='hs-varid'>groups</span> <span class='hs-varop'>++</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>group</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span> <span class='hs-varid'>specs</span> <span class='hs-layout'>(</span><span class='hs-conid'>Node</span> <span class='hs-varid'>group</span><span class='hs-layout'>)</span>
<a name="line-73"></a>      <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>action</span> <span class='hs-varid'>specs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>goSpecs</span> <span class='hs-varid'>groups</span> <span class='hs-varid'>specs</span> <span class='hs-layout'>(</span><span class='hs-conid'>NodeWithCleanup</span> <span class='hs-varid'>action</span><span class='hs-layout'>)</span>
<a name="line-74"></a>
<a name="line-75"></a><a name="applyDryRun"></a><span class='hs-definition'>applyDryRun</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-conid'>()</span><span class='hs-keyglyph'>]</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>SpecTree</span> <span class='hs-conid'>()</span><span class='hs-keyglyph'>]</span>
<a name="line-76"></a><span class='hs-definition'>applyDryRun</span> <span class='hs-varid'>c</span>
<a name="line-77"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>configDryRun</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>map</span> <span class='hs-layout'>(</span><span class='hs-varid'>removeCleanup</span> <span class='hs-varop'>.</span> <span class='hs-varid'>fmap</span> <span class='hs-varid'>markSuccess</span><span class='hs-layout'>)</span>
<a name="line-78"></a>  <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span>
<a name="line-79"></a>  <span class='hs-keyword'>where</span>
<a name="line-80"></a>    <span class='hs-varid'>markSuccess</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Item</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Item</span> <span class='hs-conid'>()</span>
<a name="line-81"></a>    <span class='hs-varid'>markSuccess</span> <span class='hs-varid'>item</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>item</span> <span class='hs-layout'>{</span><span class='hs-varid'>itemExample</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>evaluateExample</span> <span class='hs-conid'>Success</span><span class='hs-layout'>}</span>
<a name="line-82"></a>
<a name="line-83"></a>    <span class='hs-varid'>removeCleanup</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SpecTree</span> <span class='hs-conid'>()</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>SpecTree</span> <span class='hs-conid'>()</span>
<a name="line-84"></a>    <span class='hs-varid'>removeCleanup</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>spec</span> <span class='hs-keyword'>of</span>
<a name="line-85"></a>      <span class='hs-conid'>Node</span> <span class='hs-varid'>x</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Node</span> <span class='hs-varid'>x</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>removeCleanup</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-86"></a>      <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>NodeWithCleanup</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-conid'>()</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>map</span> <span class='hs-varid'>removeCleanup</span> <span class='hs-varid'>xs</span><span class='hs-layout'>)</span>
<a name="line-87"></a>      <span class='hs-varid'>leaf</span><span class='hs-keyglyph'>@</span><span class='hs-layout'>(</span><span class='hs-conid'>Leaf</span> <span class='hs-keyword'>_</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>leaf</span>
<a name="line-88"></a>
<a name="line-89"></a><a name="hspec"></a><span class='hs-comment'>-- | Run given spec and write a report to `stdout`.</span>
<a name="line-90"></a><span class='hs-comment'>-- Exit with `exitFailure` if at least one spec item fails.</span>
<a name="line-91"></a><span class='hs-definition'>hspec</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Spec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-92"></a><span class='hs-definition'>hspec</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hspecWith</span> <span class='hs-varid'>defaultConfig</span>
<a name="line-93"></a>
<a name="line-94"></a><a name="ensureSeed"></a><span class='hs-comment'>-- Add a seed to given config if there is none.  That way the same seed is used</span>
<a name="line-95"></a><span class='hs-comment'>-- for all properties.  This helps with --seed and --rerun.</span>
<a name="line-96"></a><span class='hs-definition'>ensureSeed</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Config</span>
<a name="line-97"></a><span class='hs-definition'>ensureSeed</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>configQuickCheckSeed</span> <span class='hs-varid'>c</span> <span class='hs-keyword'>of</span>
<a name="line-98"></a>  <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-99"></a>    <span class='hs-varid'>seed</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>newSeed</span>
<a name="line-100"></a>    <span class='hs-varid'>return</span> <span class='hs-varid'>c</span> <span class='hs-layout'>{</span><span class='hs-varid'>configQuickCheckSeed</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromIntegral</span> <span class='hs-varid'>seed</span><span class='hs-layout'>)</span><span class='hs-layout'>}</span>
<a name="line-101"></a>  <span class='hs-keyword'>_</span>       <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-varid'>c</span>
<a name="line-102"></a>
<a name="line-103"></a><a name="hspecWith"></a><span class='hs-comment'>-- | Run given spec with custom options.</span>
<a name="line-104"></a><span class='hs-comment'>-- This is similar to `hspec`, but more flexible.</span>
<a name="line-105"></a><span class='hs-definition'>hspecWith</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Spec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-106"></a><span class='hs-definition'>hspecWith</span> <span class='hs-varid'>conf</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-107"></a>  <span class='hs-varid'>r</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>hspecWithResult</span> <span class='hs-varid'>conf</span> <span class='hs-varid'>spec</span>
<a name="line-108"></a>  <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>summaryFailures</span> <span class='hs-varid'>r</span> <span class='hs-varop'>==</span> <span class='hs-num'>0</span><span class='hs-layout'>)</span> <span class='hs-varid'>exitFailure</span>
<a name="line-109"></a>
<a name="line-110"></a><a name="hspecResult"></a><span class='hs-comment'>-- | Run given spec and returns a summary of the test run.</span>
<a name="line-111"></a><span class='hs-comment'>--</span>
<a name="line-112"></a><span class='hs-comment'>-- /Note/: `hspecResult` does not exit with `exitFailure` on failing spec</span>
<a name="line-113"></a><span class='hs-comment'>-- items.  If you need this, you have to check the `Summary` yourself and act</span>
<a name="line-114"></a><span class='hs-comment'>-- accordingly.</span>
<a name="line-115"></a><span class='hs-definition'>hspecResult</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Spec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Summary</span>
<a name="line-116"></a><span class='hs-definition'>hspecResult</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>hspecWithResult</span> <span class='hs-varid'>defaultConfig</span>
<a name="line-117"></a>
<a name="line-118"></a><a name="hspecWithResult"></a><span class='hs-comment'>-- | Run given spec with custom options and returns a summary of the test run.</span>
<a name="line-119"></a><span class='hs-comment'>--</span>
<a name="line-120"></a><span class='hs-comment'>-- /Note/: `hspecWithResult` does not exit with `exitFailure` on failing spec</span>
<a name="line-121"></a><span class='hs-comment'>-- items.  If you need this, you have to check the `Summary` yourself and act</span>
<a name="line-122"></a><span class='hs-comment'>-- accordingly.</span>
<a name="line-123"></a><span class='hs-definition'>hspecWithResult</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Spec</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Summary</span>
<a name="line-124"></a><span class='hs-definition'>hspecWithResult</span> <span class='hs-varid'>conf</span> <span class='hs-varid'>spec</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-125"></a>  <span class='hs-varid'>prog</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>getProgName</span>
<a name="line-126"></a>  <span class='hs-varid'>args</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>getArgs</span>
<a name="line-127"></a>  <span class='hs-varid'>c</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>getConfig</span> <span class='hs-varid'>conf</span> <span class='hs-varid'>prog</span> <span class='hs-varid'>args</span> <span class='hs-varop'>&gt;&gt;=</span> <span class='hs-varid'>ensureSeed</span>
<a name="line-128"></a>  <span class='hs-varid'>withArgs</span> <span class='hs-conid'>[]</span> <span class='hs-comment'>{- do not leak command-line arguments to examples -}</span> <span class='hs-varop'>$</span> <span class='hs-varid'>withHandle</span> <span class='hs-varid'>c</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>h</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-keyword'>do</span>
<a name="line-129"></a>    <span class='hs-keyword'>let</span> <span class='hs-varid'>formatter</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fromMaybe</span> <span class='hs-varid'>specdoc</span> <span class='hs-layout'>(</span><span class='hs-varid'>configFormatter</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span>
<a name="line-130"></a>        <span class='hs-varid'>seed</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varid'>fromJust</span> <span class='hs-varop'>.</span> <span class='hs-varid'>configQuickCheckSeed</span><span class='hs-layout'>)</span> <span class='hs-varid'>c</span>
<a name="line-131"></a>        <span class='hs-varid'>qcArgs</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>configQuickCheckArgs</span> <span class='hs-varid'>c</span>
<a name="line-132"></a>
<a name="line-133"></a>    <span class='hs-varid'>jobsSem</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>newQSem</span> <span class='hs-varop'>=&lt;&lt;</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>configConcurrentJobs</span> <span class='hs-varid'>c</span> <span class='hs-keyword'>of</span>
<a name="line-134"></a>      <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>getDefaultConcurrentJobs</span>
<a name="line-135"></a>      <span class='hs-conid'>Just</span> <span class='hs-varid'>maxJobs</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-varid'>maxJobs</span>
<a name="line-136"></a>
<a name="line-137"></a>    <span class='hs-varid'>useColor</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>doesUseColor</span> <span class='hs-varid'>h</span> <span class='hs-varid'>c</span>
<a name="line-138"></a>
<a name="line-139"></a>    <span class='hs-varid'>filteredSpec</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>filterSpecs</span> <span class='hs-varid'>c</span> <span class='hs-varop'>.</span> <span class='hs-varid'>applyDryRun</span> <span class='hs-varid'>c</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>runSpecM</span> <span class='hs-varid'>spec</span>
<a name="line-140"></a>
<a name="line-141"></a>    <span class='hs-varid'>withHiddenCursor</span> <span class='hs-varid'>useColor</span> <span class='hs-varid'>h</span> <span class='hs-varop'>$</span>
<a name="line-142"></a>      <span class='hs-varid'>runFormatM</span> <span class='hs-varid'>useColor</span> <span class='hs-layout'>(</span><span class='hs-varid'>configHtmlOutput</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>configPrintCpuTime</span> <span class='hs-varid'>c</span><span class='hs-layout'>)</span> <span class='hs-varid'>seed</span> <span class='hs-varid'>h</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>do</span>
<a name="line-143"></a>        <span class='hs-varid'>runFormatter</span> <span class='hs-varid'>jobsSem</span> <span class='hs-varid'>useColor</span> <span class='hs-varid'>h</span> <span class='hs-varid'>c</span> <span class='hs-varid'>formatter</span> <span class='hs-varid'>filteredSpec</span> <span class='hs-varop'>`finally_`</span> <span class='hs-keyword'>do</span>
<a name="line-144"></a>          <span class='hs-varid'>failedFormatter</span> <span class='hs-varid'>formatter</span>
<a name="line-145"></a>
<a name="line-146"></a>        <span class='hs-varid'>footerFormatter</span> <span class='hs-varid'>formatter</span>
<a name="line-147"></a>
<a name="line-148"></a>        <span class='hs-comment'>-- dump failure report</span>
<a name="line-149"></a>        <span class='hs-varid'>xs</span> <span class='hs-keyglyph'>&lt;-</span> <span class='hs-varid'>map</span> <span class='hs-varid'>failureRecordPath</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>getFailMessages</span>
<a name="line-150"></a>        <span class='hs-varid'>liftIO</span> <span class='hs-varop'>$</span> <span class='hs-varid'>writeFailureReport</span> <span class='hs-conid'>FailureReport</span> <span class='hs-layout'>{</span>
<a name="line-151"></a>            <span class='hs-varid'>failureReportSeed</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>seed</span>
<a name="line-152"></a>          <span class='hs-layout'>,</span> <span class='hs-varid'>failureReportMaxSuccess</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>QC</span><span class='hs-varop'>.</span><span class='hs-varid'>maxSuccess</span> <span class='hs-varid'>qcArgs</span>
<a name="line-153"></a>          <span class='hs-layout'>,</span> <span class='hs-varid'>failureReportMaxSize</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>QC</span><span class='hs-varop'>.</span><span class='hs-varid'>maxSize</span> <span class='hs-varid'>qcArgs</span>
<a name="line-154"></a>          <span class='hs-layout'>,</span> <span class='hs-varid'>failureReportMaxDiscardRatio</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>QC</span><span class='hs-varop'>.</span><span class='hs-varid'>maxDiscardRatio</span> <span class='hs-varid'>qcArgs</span>
<a name="line-155"></a>          <span class='hs-layout'>,</span> <span class='hs-varid'>failureReportPaths</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>xs</span>
<a name="line-156"></a>          <span class='hs-layout'>}</span>
<a name="line-157"></a>
<a name="line-158"></a>        <span class='hs-conid'>Summary</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>getTotalCount</span> <span class='hs-varop'>&lt;*&gt;</span> <span class='hs-varid'>getFailCount</span>
<a name="line-159"></a>  <span class='hs-keyword'>where</span>
<a name="line-160"></a>    <span class='hs-varid'>withHiddenCursor</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Bool</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-161"></a>    <span class='hs-varid'>withHiddenCursor</span> <span class='hs-varid'>useColor</span> <span class='hs-varid'>h</span>
<a name="line-162"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>useColor</span>  <span class='hs-keyglyph'>=</span> <span class='hs-conid'>E</span><span class='hs-varop'>.</span><span class='hs-varid'>bracket_</span> <span class='hs-layout'>(</span><span class='hs-varid'>hHideCursor</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>hShowCursor</span> <span class='hs-varid'>h</span><span class='hs-layout'>)</span>
<a name="line-163"></a>      <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>id</span>
<a name="line-164"></a>
<a name="line-165"></a>    <span class='hs-varid'>doesUseColor</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-166"></a>    <span class='hs-varid'>doesUseColor</span> <span class='hs-varid'>h</span> <span class='hs-varid'>c</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>configColorMode</span> <span class='hs-varid'>c</span> <span class='hs-keyword'>of</span>
<a name="line-167"></a>      <span class='hs-conid'>ColorAuto</span>  <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-varop'>&amp;&amp;</span><span class='hs-layout'>)</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>hIsTerminalDevice</span> <span class='hs-varid'>h</span> <span class='hs-varop'>&lt;*&gt;</span> <span class='hs-layout'>(</span><span class='hs-varid'>not</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>isDumb</span><span class='hs-layout'>)</span>
<a name="line-168"></a>      <span class='hs-conid'>ColorNever</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>False</span>
<a name="line-169"></a>      <span class='hs-conid'>ColorAlways</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>return</span> <span class='hs-conid'>True</span>
<a name="line-170"></a>
<a name="line-171"></a>    <span class='hs-varid'>withHandle</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Config</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-layout'>(</span><span class='hs-conid'>Handle</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-conid'>IO</span> <span class='hs-varid'>a</span>
<a name="line-172"></a>    <span class='hs-varid'>withHandle</span> <span class='hs-varid'>c</span> <span class='hs-varid'>action</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>configOutputFile</span> <span class='hs-varid'>c</span> <span class='hs-keyword'>of</span>
<a name="line-173"></a>      <span class='hs-conid'>Left</span> <span class='hs-varid'>h</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>action</span> <span class='hs-varid'>h</span>
<a name="line-174"></a>      <span class='hs-conid'>Right</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>-&gt;</span> <span class='hs-varid'>withFile</span> <span class='hs-varid'>path</span> <span class='hs-conid'>WriteMode</span> <span class='hs-varid'>action</span>
<a name="line-175"></a>
<a name="line-176"></a><a name="isDumb"></a><span class='hs-definition'>isDumb</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Bool</span>
<a name="line-177"></a><span class='hs-definition'>isDumb</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>maybe</span> <span class='hs-conid'>False</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span> <span class='hs-str'>"dumb"</span><span class='hs-layout'>)</span> <span class='hs-varop'>&lt;$&gt;</span> <span class='hs-varid'>lookupEnv</span> <span class='hs-str'>"TERM"</span>
<a name="line-178"></a>
<a name="line-179"></a><a name="Summary"></a><span class='hs-comment'>-- | Summary of a test run.</span>
<a name="line-180"></a><a name="Summary"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Summary</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Summary</span> <span class='hs-layout'>{</span>
<a name="line-181"></a>  <span class='hs-varid'>summaryExamples</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-182"></a><span class='hs-layout'>,</span> <span class='hs-varid'>summaryFailures</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Int</span>
<a name="line-183"></a><span class='hs-layout'>}</span> <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>
<a name="line-184"></a>
<a name="line-185"></a><a name="instance%20Monoid%20Summary"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>Monoid</span> <span class='hs-conid'>Summary</span> <span class='hs-keyword'>where</span>
<a name="line-186"></a>  <span class='hs-varid'>mempty</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Summary</span> <span class='hs-num'>0</span> <span class='hs-num'>0</span>
<a name="line-187"></a>  <span class='hs-layout'>(</span><span class='hs-conid'>Summary</span> <span class='hs-varid'>x1</span> <span class='hs-varid'>x2</span><span class='hs-layout'>)</span> <span class='hs-varop'>`mappend`</span> <span class='hs-layout'>(</span><span class='hs-conid'>Summary</span> <span class='hs-varid'>y1</span> <span class='hs-varid'>y2</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Summary</span> <span class='hs-layout'>(</span><span class='hs-varid'>x1</span> <span class='hs-varop'>+</span> <span class='hs-varid'>y1</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>x2</span> <span class='hs-varop'>+</span> <span class='hs-varid'>y2</span><span class='hs-layout'>)</span>
</pre></body>
</html>