/usr/share/doc/libghc-tasty-golden-doc/html/src/Test-Tasty-Golden.html is in libghc-tasty-golden-doc 2.3.1-1build2.
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 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | <?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/Tasty/Golden.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{- |
<a name="line-2"></a>This module provides a simplified interface. If you want more, see
<a name="line-3"></a>"Test.Tasty.Golden.Advanced".
<a name="line-4"></a>
<a name="line-5"></a>Note about filenames. They are looked up in the usual way, thus relative
<a name="line-6"></a>names are relative to the processes current working directory.
<a name="line-7"></a>It is common to run tests from the package's root directory (via @cabal
<a name="line-8"></a>test@ or @cabal install --enable-tests@), so if your test files are under
<a name="line-9"></a>the @tests\/@ subdirectory, your relative file names should start with
<a name="line-10"></a>@tests\/@ (even if your @test.hs@ is itself under @tests\/@, too).
<a name="line-11"></a>
<a name="line-12"></a>Note about line endings. The best way to avoid headaches with line endings
<a name="line-13"></a>(when running tests both on UNIX and Windows) is to treat your golden files
<a name="line-14"></a>as binary, even when they are actually textual.
<a name="line-15"></a>
<a name="line-16"></a>This means:
<a name="line-17"></a>
<a name="line-18"></a>* When writing output files from Haskell code, open them in binary mode
<a name="line-19"></a>(see 'openBinaryFile', 'withBinaryFile' and 'hSetBinaryMode'). This will
<a name="line-20"></a>disable automatic @\\n -> \\r\\n@ conversion on Windows. For convenience, this
<a name="line-21"></a>module exports 'writeBinaryFile' which is just like `writeFile` but opens
<a name="line-22"></a>the file in binary mode. When using 'ByteString's note that
<a name="line-23"></a>"Data.ByteString" and "Data.ByteString.Lazy" use binary mode for
<a name="line-24"></a>@writeFile@, while "Data.ByteString.Char8" and "Data.ByteString.Lazy.Char8"
<a name="line-25"></a>use text mode.
<a name="line-26"></a>
<a name="line-27"></a>* Tell your VCS not to do any newline conversion for golden files. For
<a name="line-28"></a> git check in a @.gitattributes@ file with the following contents (assuming
<a name="line-29"></a> your golden files have @.golden@ extension):
<a name="line-30"></a>
<a name="line-31"></a>>*.golden -text
<a name="line-32"></a>
<a name="line-33"></a>On its side, tasty-golden reads and writes files in binary mode, too.
<a name="line-34"></a>
<a name="line-35"></a>Why not let Haskell/git do automatic conversion on Windows? Well, for
<a name="line-36"></a>instance, @tar@ will not do the conversion for you when unpacking a release
<a name="line-37"></a>tarball, so when you run @cabal install your-package --enable-tests@, the
<a name="line-38"></a>tests will be broken.
<a name="line-39"></a>
<a name="line-40"></a>As a last resort, you can strip all @\\r@s from both arguments in your
<a name="line-41"></a>comparison function when necessary. But most of the time treating the files
<a name="line-42"></a>as binary does the job.
<a name="line-43"></a>-}</span>
<a name="line-44"></a>
<a name="line-45"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Tasty</span><span class='hs-varop'>.</span><span class='hs-conid'>Golden</span>
<a name="line-46"></a> <span class='hs-layout'>(</span> <span class='hs-varid'>goldenVsFile</span>
<a name="line-47"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>goldenVsString</span>
<a name="line-48"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>goldenVsFileDiff</span>
<a name="line-49"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>goldenVsStringDiff</span>
<a name="line-50"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>writeBinaryFile</span>
<a name="line-51"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>findByExtension</span>
<a name="line-52"></a> <span class='hs-layout'>)</span>
<a name="line-53"></a> <span class='hs-keyword'>where</span>
<a name="line-54"></a>
<a name="line-55"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Tasty</span><span class='hs-varop'>.</span><span class='hs-conid'>Providers</span>
<a name="line-56"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Test</span><span class='hs-varop'>.</span><span class='hs-conid'>Tasty</span><span class='hs-varop'>.</span><span class='hs-conid'>Golden</span><span class='hs-varop'>.</span><span class='hs-conid'>Advanced</span>
<a name="line-57"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Text</span><span class='hs-varop'>.</span><span class='hs-conid'>Printf</span>
<a name="line-58"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>BS</span>
<a name="line-59"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Lazy</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>LBS</span>
<a name="line-60"></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-61"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>IO</span><span class='hs-varop'>.</span><span class='hs-conid'>Temp</span>
<a name="line-62"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Process</span>
<a name="line-63"></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-64"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span>
<a name="line-65"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>Directory</span>
<a name="line-66"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Exception</span>
<a name="line-67"></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-68"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</span>
<a name="line-69"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>DeepSeq</span>
<a name="line-70"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Set</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>Set</span>
<a name="line-71"></a>
<a name="line-72"></a><a name="goldenVsFile"></a><span class='hs-comment'>-- | Compare a given file contents against the golden file contents</span>
<a name="line-73"></a><span class='hs-definition'>goldenVsFile</span>
<a name="line-74"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestName</span> <span class='hs-comment'>-- ^ test name</span>
<a name="line-75"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the «golden» file (the file that contains correct output)</span>
<a name="line-76"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the output file</span>
<a name="line-77"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <span class='hs-comment'>-- ^ action that creates the output file</span>
<a name="line-78"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestTree</span> <span class='hs-comment'>-- ^ the test verifies that the output file contents is the same as the golden file contents</span>
<a name="line-79"></a><span class='hs-definition'>goldenVsFile</span> <span class='hs-varid'>name</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>new</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span>
<a name="line-80"></a> <span class='hs-varid'>goldenTest</span>
<a name="line-81"></a> <span class='hs-varid'>name</span>
<a name="line-82"></a> <span class='hs-layout'>(</span><span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>readFile</span> <span class='hs-varid'>ref</span><span class='hs-layout'>)</span>
<a name="line-83"></a> <span class='hs-layout'>(</span><span class='hs-varid'>act</span> <span class='hs-varop'>>></span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>readFile</span> <span class='hs-varid'>new</span><span class='hs-layout'>)</span>
<a name="line-84"></a> <span class='hs-varid'>cmp</span>
<a name="line-85"></a> <span class='hs-varid'>upd</span>
<a name="line-86"></a> <span class='hs-keyword'>where</span>
<a name="line-87"></a> <span class='hs-varid'>cmp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>simpleCmp</span> <span class='hs-varop'>$</span> <span class='hs-varid'>printf</span> <span class='hs-str'>"Files '%s' and '%s' differ"</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>new</span>
<a name="line-88"></a> <span class='hs-varid'>upd</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>writeFile</span> <span class='hs-varid'>ref</span>
<a name="line-89"></a>
<a name="line-90"></a><a name="goldenVsString"></a><span class='hs-comment'>-- | Compare a given string against the golden file contents</span>
<a name="line-91"></a><span class='hs-definition'>goldenVsString</span>
<a name="line-92"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestName</span> <span class='hs-comment'>-- ^ test name</span>
<a name="line-93"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the «golden» file (the file that contains correct output)</span>
<a name="line-94"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>LBS</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ action that returns a string</span>
<a name="line-95"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestTree</span> <span class='hs-comment'>-- ^ the test verifies that the returned string is the same as the golden file contents</span>
<a name="line-96"></a><span class='hs-definition'>goldenVsString</span> <span class='hs-varid'>name</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span>
<a name="line-97"></a> <span class='hs-varid'>goldenTest</span>
<a name="line-98"></a> <span class='hs-varid'>name</span>
<a name="line-99"></a> <span class='hs-layout'>(</span><span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>readFile</span> <span class='hs-varid'>ref</span><span class='hs-layout'>)</span>
<a name="line-100"></a> <span class='hs-layout'>(</span><span class='hs-conid'>LBS</span><span class='hs-varop'>.</span><span class='hs-varid'>toStrict</span> <span class='hs-varop'><$></span> <span class='hs-varid'>act</span><span class='hs-layout'>)</span>
<a name="line-101"></a> <span class='hs-varid'>cmp</span>
<a name="line-102"></a> <span class='hs-varid'>upd</span>
<a name="line-103"></a> <span class='hs-keyword'>where</span>
<a name="line-104"></a> <span class='hs-varid'>cmp</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>simpleCmp</span> <span class='hs-varid'>msg</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span>
<a name="line-105"></a> <span class='hs-keyword'>where</span>
<a name="line-106"></a> <span class='hs-varid'>msg</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>printf</span> <span class='hs-str'>"Test output was different from '%s'. It was: %s"</span> <span class='hs-varid'>ref</span> <span class='hs-layout'>(</span><span class='hs-varid'>show</span> <span class='hs-varid'>y</span><span class='hs-layout'>)</span>
<a name="line-107"></a> <span class='hs-varid'>upd</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>writeFile</span> <span class='hs-varid'>ref</span>
<a name="line-108"></a>
<a name="line-109"></a><a name="simpleCmp"></a><span class='hs-definition'>simpleCmp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Eq</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</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-110"></a><span class='hs-definition'>simpleCmp</span> <span class='hs-varid'>e</span> <span class='hs-varid'>x</span> <span class='hs-varid'>y</span> <span class='hs-keyglyph'>=</span>
<a name="line-111"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>if</span> <span class='hs-varid'>x</span> <span class='hs-varop'>==</span> <span class='hs-varid'>y</span> <span class='hs-keyword'>then</span> <span class='hs-conid'>Nothing</span> <span class='hs-keyword'>else</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>e</span>
<a name="line-112"></a>
<a name="line-113"></a><a name="goldenVsFileDiff"></a><span class='hs-comment'>-- | Same as 'goldenVsFile', but invokes an external diff command.</span>
<a name="line-114"></a><span class='hs-definition'>goldenVsFileDiff</span>
<a name="line-115"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestName</span> <span class='hs-comment'>-- ^ test name</span>
<a name="line-116"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</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-layout'>)</span>
<a name="line-117"></a> <span class='hs-comment'>-- ^ function that constructs the command line to invoke the diff</span>
<a name="line-118"></a> <span class='hs-comment'>-- command.</span>
<a name="line-119"></a> <span class='hs-comment'>--</span>
<a name="line-120"></a> <span class='hs-comment'>-- E.g.</span>
<a name="line-121"></a> <span class='hs-comment'>--</span>
<a name="line-122"></a> <span class='hs-comment'>-- >\ref new -> ["diff", "-u", ref, new]</span>
<a name="line-123"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the golden file</span>
<a name="line-124"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the output file</span>
<a name="line-125"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span> <span class='hs-comment'>-- ^ action that produces the output file</span>
<a name="line-126"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestTree</span>
<a name="line-127"></a><span class='hs-definition'>goldenVsFileDiff</span> <span class='hs-varid'>name</span> <span class='hs-varid'>cmdf</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>new</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span>
<a name="line-128"></a> <span class='hs-varid'>goldenTest</span>
<a name="line-129"></a> <span class='hs-varid'>name</span>
<a name="line-130"></a> <span class='hs-layout'>(</span><span class='hs-varid'>return</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-131"></a> <span class='hs-varid'>act</span>
<a name="line-132"></a> <span class='hs-varid'>cmp</span>
<a name="line-133"></a> <span class='hs-varid'>upd</span>
<a name="line-134"></a> <span class='hs-keyword'>where</span>
<a name="line-135"></a> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>cmdf</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>new</span>
<a name="line-136"></a> <span class='hs-varid'>cmp</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>null</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>error</span> <span class='hs-str'>"goldenVsFileDiff: empty command line"</span>
<a name="line-137"></a> <span class='hs-varid'>cmp</span> <span class='hs-keyword'>_</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-138"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>sout</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>pid</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>createProcess</span> <span class='hs-layout'>(</span><span class='hs-varid'>proc</span> <span class='hs-layout'>(</span><span class='hs-varid'>head</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>tail</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>{</span> <span class='hs-varid'>std_out</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CreatePipe</span> <span class='hs-layout'>}</span>
<a name="line-139"></a> <span class='hs-comment'>-- strictly read the whole output, so that the process can terminate</span>
<a name="line-140"></a> <span class='hs-varid'>out</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>hGetContents</span> <span class='hs-varid'>sout</span>
<a name="line-141"></a> <span class='hs-varid'>evaluate</span> <span class='hs-varop'>.</span> <span class='hs-varid'>rnf</span> <span class='hs-varop'>$</span> <span class='hs-varid'>out</span>
<a name="line-142"></a>
<a name="line-143"></a> <span class='hs-varid'>r</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>waitForProcess</span> <span class='hs-varid'>pid</span>
<a name="line-144"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>r</span> <span class='hs-keyword'>of</span>
<a name="line-145"></a> <span class='hs-conid'>ExitSuccess</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Nothing</span>
<a name="line-146"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-varid'>out</span>
<a name="line-147"></a>
<a name="line-148"></a> <span class='hs-varid'>upd</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>readFile</span> <span class='hs-varid'>new</span> <span class='hs-varop'>>>=</span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>writeFile</span> <span class='hs-varid'>ref</span>
<a name="line-149"></a>
<a name="line-150"></a><a name="goldenVsStringDiff"></a><span class='hs-comment'>-- | Same as 'goldenVsString', but invokes an external diff command.</span>
<a name="line-151"></a><span class='hs-definition'>goldenVsStringDiff</span>
<a name="line-152"></a> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>TestName</span> <span class='hs-comment'>-- ^ test name</span>
<a name="line-153"></a> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</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-layout'>)</span>
<a name="line-154"></a> <span class='hs-comment'>-- ^ function that constructs the command line to invoke the diff</span>
<a name="line-155"></a> <span class='hs-comment'>-- command.</span>
<a name="line-156"></a> <span class='hs-comment'>--</span>
<a name="line-157"></a> <span class='hs-comment'>-- E.g.</span>
<a name="line-158"></a> <span class='hs-comment'>--</span>
<a name="line-159"></a> <span class='hs-comment'>-- >\ref new -> ["diff", "-u", ref, new]</span>
<a name="line-160"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ path to the golden file</span>
<a name="line-161"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>LBS</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span> <span class='hs-comment'>-- ^ action that returns a string</span>
<a name="line-162"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>TestTree</span>
<a name="line-163"></a><span class='hs-definition'>goldenVsStringDiff</span> <span class='hs-varid'>name</span> <span class='hs-varid'>cmdf</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>act</span> <span class='hs-keyglyph'>=</span>
<a name="line-164"></a> <span class='hs-varid'>goldenTest</span>
<a name="line-165"></a> <span class='hs-varid'>name</span>
<a name="line-166"></a> <span class='hs-layout'>(</span><span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>readFile</span> <span class='hs-varid'>ref</span><span class='hs-layout'>)</span>
<a name="line-167"></a> <span class='hs-layout'>(</span><span class='hs-conid'>LBS</span><span class='hs-varop'>.</span><span class='hs-varid'>toStrict</span> <span class='hs-varop'><$></span> <span class='hs-varid'>act</span><span class='hs-layout'>)</span>
<a name="line-168"></a> <span class='hs-varid'>cmp</span>
<a name="line-169"></a> <span class='hs-varid'>upd</span>
<a name="line-170"></a> <span class='hs-keyword'>where</span>
<a name="line-171"></a> <span class='hs-varid'>template</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>takeFileName</span> <span class='hs-varid'>ref</span> <span class='hs-varop'><.></span> <span class='hs-str'>"actual"</span>
<a name="line-172"></a> <span class='hs-varid'>cmp</span> <span class='hs-keyword'>_</span> <span class='hs-varid'>actBS</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withSystemTempFile</span> <span class='hs-varid'>template</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>tmpFile</span> <span class='hs-varid'>tmpHandle</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-173"></a>
<a name="line-174"></a> <span class='hs-comment'>-- Write act output to temporary ("new") file</span>
<a name="line-175"></a> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>hPut</span> <span class='hs-varid'>tmpHandle</span> <span class='hs-varid'>actBS</span> <span class='hs-varop'>>></span> <span class='hs-varid'>hFlush</span> <span class='hs-varid'>tmpHandle</span>
<a name="line-176"></a>
<a name="line-177"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>cmd</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>cmdf</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>tmpFile</span>
<a name="line-178"></a>
<a name="line-179"></a> <span class='hs-varid'>when</span> <span class='hs-layout'>(</span><span class='hs-varid'>null</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span> <span class='hs-varop'>$</span> <span class='hs-varid'>error</span> <span class='hs-str'>"goldenVsFileDiff: empty command line"</span>
<a name="line-180"></a>
<a name="line-181"></a> <span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>sout</span><span class='hs-layout'>,</span> <span class='hs-keyword'>_</span><span class='hs-layout'>,</span> <span class='hs-varid'>pid</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>createProcess</span> <span class='hs-layout'>(</span><span class='hs-varid'>proc</span> <span class='hs-layout'>(</span><span class='hs-varid'>head</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>tail</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-layout'>{</span> <span class='hs-varid'>std_out</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>CreatePipe</span> <span class='hs-layout'>}</span>
<a name="line-182"></a> <span class='hs-comment'>-- strictly read the whole output, so that the process can terminate</span>
<a name="line-183"></a> <span class='hs-varid'>out</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>hGetContents</span> <span class='hs-varid'>sout</span>
<a name="line-184"></a> <span class='hs-varid'>evaluate</span> <span class='hs-varop'>.</span> <span class='hs-varid'>rnf</span> <span class='hs-varop'>$</span> <span class='hs-varid'>out</span>
<a name="line-185"></a>
<a name="line-186"></a> <span class='hs-varid'>r</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>waitForProcess</span> <span class='hs-varid'>pid</span>
<a name="line-187"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-keyword'>case</span> <span class='hs-varid'>r</span> <span class='hs-keyword'>of</span>
<a name="line-188"></a> <span class='hs-conid'>ExitSuccess</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Nothing</span>
<a name="line-189"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Just</span> <span class='hs-layout'>(</span><span class='hs-varid'>printf</span> <span class='hs-str'>"Test output was different from '%s'. Output of %s:\n%s"</span> <span class='hs-varid'>ref</span> <span class='hs-layout'>(</span><span class='hs-varid'>show</span> <span class='hs-varid'>cmd</span><span class='hs-layout'>)</span> <span class='hs-varid'>out</span><span class='hs-layout'>)</span>
<a name="line-190"></a>
<a name="line-191"></a> <span class='hs-varid'>upd</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>BS</span><span class='hs-varop'>.</span><span class='hs-varid'>writeFile</span> <span class='hs-varid'>ref</span>
<a name="line-192"></a>
<a name="line-193"></a><a name="writeBinaryFile"></a><span class='hs-comment'>-- | Like 'writeFile', but uses binary mode</span>
<a name="line-194"></a><span class='hs-definition'>writeBinaryFile</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span>
<a name="line-195"></a><span class='hs-definition'>writeBinaryFile</span> <span class='hs-varid'>f</span> <span class='hs-varid'>txt</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>withBinaryFile</span> <span class='hs-varid'>f</span> <span class='hs-conid'>WriteMode</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>hdl</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>hPutStr</span> <span class='hs-varid'>hdl</span> <span class='hs-varid'>txt</span><span class='hs-layout'>)</span>
<a name="line-196"></a>
<a name="line-197"></a><a name="findByExtension"></a><span class='hs-comment'>-- | Find all files in the given directory and its subdirectories that have</span>
<a name="line-198"></a><span class='hs-comment'>-- the given extensions.</span>
<a name="line-199"></a><span class='hs-comment'>--</span>
<a name="line-200"></a><span class='hs-comment'>-- It is typically used to find all test files and produce a golden test</span>
<a name="line-201"></a><span class='hs-comment'>-- per test file.</span>
<a name="line-202"></a><span class='hs-comment'>--</span>
<a name="line-203"></a><span class='hs-comment'>-- The returned paths use forward slashes to separate path components,</span>
<a name="line-204"></a><span class='hs-comment'>-- even on Windows. Thus if the file name ends up in a golden file, it</span>
<a name="line-205"></a><span class='hs-comment'>-- will not differ when run on another platform.</span>
<a name="line-206"></a><span class='hs-comment'>--</span>
<a name="line-207"></a><span class='hs-comment'>-- The semantics of extensions is the same as in 'takeExtension'. In</span>
<a name="line-208"></a><span class='hs-comment'>-- particular, non-empty extensions should have the form @".ext"@.</span>
<a name="line-209"></a><span class='hs-comment'>--</span>
<a name="line-210"></a><span class='hs-comment'>-- This function may throw any exception that 'getDirectoryContents' may</span>
<a name="line-211"></a><span class='hs-comment'>-- throw.</span>
<a name="line-212"></a><span class='hs-comment'>--</span>
<a name="line-213"></a><span class='hs-comment'>-- It doesn't do anything special to handle symlinks (in particular, it</span>
<a name="line-214"></a><span class='hs-comment'>-- probably won't work on symlink loops).</span>
<a name="line-215"></a><span class='hs-comment'>--</span>
<a name="line-216"></a><span class='hs-comment'>-- Nor is it optimized to work with huge directory trees (you'd probably</span>
<a name="line-217"></a><span class='hs-comment'>-- want to use some form of coroutines for that).</span>
<a name="line-218"></a><span class='hs-definition'>findByExtension</span>
<a name="line-219"></a> <span class='hs-keyglyph'>::</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FilePath</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ extensions</span>
<a name="line-220"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>FilePath</span> <span class='hs-comment'>-- ^ directory</span>
<a name="line-221"></a> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>FilePath</span><span class='hs-keyglyph'>]</span> <span class='hs-comment'>-- ^ paths</span>
<a name="line-222"></a><span class='hs-definition'>findByExtension</span> <span class='hs-varid'>extsList</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>go</span> <span class='hs-keyword'>where</span>
<a name="line-223"></a> <span class='hs-varid'>exts</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>fromList</span> <span class='hs-varid'>extsList</span>
<a name="line-224"></a> <span class='hs-varid'>go</span> <span class='hs-varid'>dir</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-225"></a> <span class='hs-varid'>allEntries</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>getDirectoryContents</span> <span class='hs-varid'>dir</span>
<a name="line-226"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>entries</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>filter</span> <span class='hs-layout'>(</span><span class='hs-varid'>not</span> <span class='hs-varop'>.</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-keyglyph'>[</span><span class='hs-str'>"."</span><span class='hs-layout'>,</span> <span class='hs-str'>".."</span><span class='hs-keyglyph'>]</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varid'>allEntries</span>
<a name="line-227"></a> <span class='hs-varid'>liftM</span> <span class='hs-varid'>concat</span> <span class='hs-varop'>$</span> <span class='hs-varid'>forM</span> <span class='hs-varid'>entries</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-228"></a> <span class='hs-keyword'>let</span> <span class='hs-varid'>path</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>dir</span> <span class='hs-varop'>++</span> <span class='hs-str'>"/"</span> <span class='hs-varop'>++</span> <span class='hs-varid'>e</span>
<a name="line-229"></a> <span class='hs-varid'>isDir</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>doesDirectoryExist</span> <span class='hs-varid'>path</span>
<a name="line-230"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>isDir</span>
<a name="line-231"></a> <span class='hs-keyword'>then</span> <span class='hs-varid'>go</span> <span class='hs-varid'>path</span>
<a name="line-232"></a> <span class='hs-keyword'>else</span>
<a name="line-233"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span>
<a name="line-234"></a> <span class='hs-keyword'>if</span> <span class='hs-varid'>takeExtension</span> <span class='hs-varid'>path</span> <span class='hs-varop'>`</span><span class='hs-conid'>Set</span><span class='hs-varop'>.</span><span class='hs-varid'>member</span><span class='hs-varop'>`</span> <span class='hs-varid'>exts</span>
<a name="line-235"></a> <span class='hs-keyword'>then</span> <span class='hs-keyglyph'>[</span><span class='hs-varid'>path</span><span class='hs-keyglyph'>]</span>
<a name="line-236"></a> <span class='hs-keyword'>else</span> <span class='hs-conid'>[]</span>
</pre></body>
</html>
|