/usr/share/doc/libghc-tasty-golden-doc/html/src/Test-Tasty-Golden-Internal.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 | <?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/Internal.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE RankNTypes, ExistentialQuantification, DeriveDataTypeable,
<a name="line-2"></a> MultiParamTypeClasses, GeneralizedNewtypeDeriving #-}</span>
<a name="line-3"></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><span class='hs-varop'>.</span><span class='hs-conid'>Internal</span> <span class='hs-keyword'>where</span>
<a name="line-4"></a>
<a name="line-5"></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-6"></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-7"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Typeable</span> <span class='hs-layout'>(</span><span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-8"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Options</span><span class='hs-varop'>.</span><span class='hs-conid'>Applicative</span>
<a name="line-9"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Tagged</span>
<a name="line-10"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>Proxy</span>
<a name="line-11"></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'>Error</span> <span class='hs-layout'>(</span><span class='hs-varid'>isDoesNotExistError</span><span class='hs-layout'>)</span>
<a name="line-12"></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-13"></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'>Options</span>
<a name="line-14"></a>
<a name="line-15"></a><a name="Golden"></a><span class='hs-comment'>-- | See 'goldenTest' for explanation of the fields</span>
<a name="line-16"></a><a name="Golden"></a><span class='hs-keyword'>data</span> <span class='hs-conid'>Golden</span> <span class='hs-keyglyph'>=</span>
<a name="line-17"></a> <span class='hs-keyword'>forall</span> <span class='hs-varid'>a</span> <span class='hs-varop'>.</span>
<a name="line-18"></a> <span class='hs-conid'>Golden</span>
<a name="line-19"></a> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-20"></a> <span class='hs-layout'>(</span><span class='hs-conid'>IO</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-21"></a> <span class='hs-layout'>(</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><span class='hs-layout'>)</span>
<a name="line-22"></a> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>()</span><span class='hs-layout'>)</span>
<a name="line-23"></a> <span class='hs-keyword'>deriving</span> <span class='hs-conid'>Typeable</span>
<a name="line-24"></a>
<a name="line-25"></a><a name="AcceptTests"></a><span class='hs-comment'>-- | This option, when set to 'True', specifies that we should run in the</span>
<a name="line-26"></a><a name="AcceptTests"></a><span class='hs-comment'>-- «accept tests» mode</span>
<a name="line-27"></a><a name="AcceptTests"></a><span class='hs-keyword'>newtype</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-conid'>Bool</span>
<a name="line-28"></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'>Ord</span><span class='hs-layout'>,</span> <span class='hs-conid'>Typeable</span><span class='hs-layout'>)</span>
<a name="line-29"></a><a name="instance%20IsOption%20AcceptTests"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>IsOption</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-keyword'>where</span>
<a name="line-30"></a> <span class='hs-varid'>defaultValue</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-conid'>False</span>
<a name="line-31"></a> <span class='hs-varid'>parseValue</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>fmap</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-varop'>.</span> <span class='hs-varid'>safeRead</span>
<a name="line-32"></a> <span class='hs-varid'>optionName</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-str'>"accept"</span>
<a name="line-33"></a> <span class='hs-varid'>optionHelp</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-str'>"Accept current results of golden tests"</span>
<a name="line-34"></a> <span class='hs-varid'>optionCLParser</span> <span class='hs-keyglyph'>=</span>
<a name="line-35"></a> <span class='hs-varid'>fmap</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-varop'>$</span>
<a name="line-36"></a> <span class='hs-varid'>switch</span>
<a name="line-37"></a> <span class='hs-layout'>(</span> <span class='hs-varid'>long</span> <span class='hs-layout'>(</span><span class='hs-varid'>untag</span> <span class='hs-layout'>(</span><span class='hs-varid'>optionName</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Tagged</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-38"></a> <span class='hs-varop'><></span> <span class='hs-varid'>help</span> <span class='hs-layout'>(</span><span class='hs-varid'>untag</span> <span class='hs-layout'>(</span><span class='hs-varid'>optionHelp</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Tagged</span> <span class='hs-conid'>AcceptTests</span> <span class='hs-conid'>String</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-39"></a> <span class='hs-layout'>)</span>
<a name="line-40"></a>
<a name="line-41"></a><a name="instance%20IsTest%20Golden"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>IsTest</span> <span class='hs-conid'>Golden</span> <span class='hs-keyword'>where</span>
<a name="line-42"></a> <span class='hs-varid'>run</span> <span class='hs-varid'>opts</span> <span class='hs-varid'>golden</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>runGolden</span> <span class='hs-varid'>golden</span> <span class='hs-layout'>(</span><span class='hs-varid'>lookupOption</span> <span class='hs-varid'>opts</span><span class='hs-layout'>)</span>
<a name="line-43"></a> <span class='hs-varid'>testOptions</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>return</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Option</span> <span class='hs-layout'>(</span><span class='hs-conid'>Proxy</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Proxy</span> <span class='hs-conid'>AcceptTests</span><span class='hs-layout'>)</span><span class='hs-keyglyph'>]</span>
<a name="line-44"></a>
<a name="line-45"></a><a name="runGolden"></a><span class='hs-definition'>runGolden</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>Golden</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>AcceptTests</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>IO</span> <span class='hs-conid'>Result</span>
<a name="line-46"></a><span class='hs-definition'>runGolden</span> <span class='hs-layout'>(</span><span class='hs-conid'>Golden</span> <span class='hs-varid'>getGolden</span> <span class='hs-varid'>getTested</span> <span class='hs-varid'>cmp</span> <span class='hs-varid'>update</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-conid'>AcceptTests</span> <span class='hs-varid'>accept</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-47"></a> <span class='hs-keyword'>do</span>
<a name="line-48"></a> <span class='hs-varid'>mbNew</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>try</span> <span class='hs-varid'>getTested</span>
<a name="line-49"></a>
<a name="line-50"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbNew</span> <span class='hs-keyword'>of</span>
<a name="line-51"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-52"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>testFailed</span> <span class='hs-varop'>$</span> <span class='hs-varid'>show</span> <span class='hs-layout'>(</span><span class='hs-varid'>e</span> <span class='hs-keyglyph'>::</span> <span class='hs-conid'>SomeException</span><span class='hs-layout'>)</span>
<a name="line-53"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>new</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-54"></a>
<a name="line-55"></a> <span class='hs-varid'>mbRef</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>try</span> <span class='hs-varid'>getGolden</span>
<a name="line-56"></a>
<a name="line-57"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>mbRef</span> <span class='hs-keyword'>of</span>
<a name="line-58"></a> <span class='hs-conid'>Left</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>isDoesNotExistError</span> <span class='hs-varid'>e</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-59"></a> <span class='hs-varid'>update</span> <span class='hs-varid'>new</span>
<a name="line-60"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>testPassed</span> <span class='hs-str'>"Golden file did not exist; created"</span>
<a name="line-61"></a>
<a name="line-62"></a> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>otherwise</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>throwIO</span> <span class='hs-varid'>e</span>
<a name="line-63"></a>
<a name="line-64"></a> <span class='hs-conid'>Right</span> <span class='hs-varid'>ref</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-65"></a>
<a name="line-66"></a> <span class='hs-varid'>result</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>cmp</span> <span class='hs-varid'>ref</span> <span class='hs-varid'>new</span>
<a name="line-67"></a>
<a name="line-68"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>result</span> <span class='hs-keyword'>of</span>
<a name="line-69"></a> <span class='hs-conid'>Just</span> <span class='hs-sel'>_reason</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>accept</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-70"></a> <span class='hs-comment'>-- test failed; accept the new version</span>
<a name="line-71"></a> <span class='hs-varid'>update</span> <span class='hs-varid'>new</span>
<a name="line-72"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>testPassed</span> <span class='hs-str'>"Accepted the new version"</span>
<a name="line-73"></a>
<a name="line-74"></a> <span class='hs-conid'>Just</span> <span class='hs-varid'>reason</span> <span class='hs-keyglyph'>-></span> <span class='hs-keyword'>do</span>
<a name="line-75"></a> <span class='hs-comment'>-- Make sure that the result is fully evaluated and doesn't depend</span>
<a name="line-76"></a> <span class='hs-comment'>-- on yet un-read lazy input</span>
<a name="line-77"></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'>reason</span>
<a name="line-78"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>testFailed</span> <span class='hs-varid'>reason</span>
<a name="line-79"></a>
<a name="line-80"></a> <span class='hs-conid'>Nothing</span> <span class='hs-keyglyph'>-></span>
<a name="line-81"></a> <span class='hs-varid'>return</span> <span class='hs-varop'>$</span> <span class='hs-varid'>testPassed</span> <span class='hs-str'>""</span>
</pre></body>
</html>
|