blob: 7a59ca6d25e839d525c6dedca899b4f25bccb8c6 [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/ring-0.16.20/src/test.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>test.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../ring/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../ring/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
<span id="359">359</span>
<span id="360">360</span>
<span id="361">361</span>
<span id="362">362</span>
<span id="363">363</span>
<span id="364">364</span>
<span id="365">365</span>
<span id="366">366</span>
<span id="367">367</span>
<span id="368">368</span>
<span id="369">369</span>
<span id="370">370</span>
<span id="371">371</span>
<span id="372">372</span>
<span id="373">373</span>
<span id="374">374</span>
<span id="375">375</span>
<span id="376">376</span>
<span id="377">377</span>
<span id="378">378</span>
<span id="379">379</span>
<span id="380">380</span>
<span id="381">381</span>
<span id="382">382</span>
<span id="383">383</span>
<span id="384">384</span>
<span id="385">385</span>
<span id="386">386</span>
<span id="387">387</span>
<span id="388">388</span>
<span id="389">389</span>
<span id="390">390</span>
<span id="391">391</span>
<span id="392">392</span>
<span id="393">393</span>
<span id="394">394</span>
<span id="395">395</span>
<span id="396">396</span>
<span id="397">397</span>
<span id="398">398</span>
<span id="399">399</span>
<span id="400">400</span>
<span id="401">401</span>
<span id="402">402</span>
<span id="403">403</span>
<span id="404">404</span>
<span id="405">405</span>
<span id="406">406</span>
<span id="407">407</span>
<span id="408">408</span>
<span id="409">409</span>
<span id="410">410</span>
<span id="411">411</span>
<span id="412">412</span>
<span id="413">413</span>
<span id="414">414</span>
<span id="415">415</span>
<span id="416">416</span>
<span id="417">417</span>
<span id="418">418</span>
<span id="419">419</span>
<span id="420">420</span>
<span id="421">421</span>
<span id="422">422</span>
<span id="423">423</span>
<span id="424">424</span>
<span id="425">425</span>
<span id="426">426</span>
<span id="427">427</span>
<span id="428">428</span>
<span id="429">429</span>
<span id="430">430</span>
<span id="431">431</span>
<span id="432">432</span>
<span id="433">433</span>
<span id="434">434</span>
<span id="435">435</span>
<span id="436">436</span>
<span id="437">437</span>
<span id="438">438</span>
<span id="439">439</span>
<span id="440">440</span>
<span id="441">441</span>
<span id="442">442</span>
<span id="443">443</span>
<span id="444">444</span>
<span id="445">445</span>
<span id="446">446</span>
<span id="447">447</span>
<span id="448">448</span>
<span id="449">449</span>
<span id="450">450</span>
<span id="451">451</span>
<span id="452">452</span>
<span id="453">453</span>
<span id="454">454</span>
<span id="455">455</span>
<span id="456">456</span>
<span id="457">457</span>
<span id="458">458</span>
<span id="459">459</span>
<span id="460">460</span>
<span id="461">461</span>
<span id="462">462</span>
<span id="463">463</span>
<span id="464">464</span>
<span id="465">465</span>
<span id="466">466</span>
<span id="467">467</span>
<span id="468">468</span>
<span id="469">469</span>
<span id="470">470</span>
<span id="471">471</span>
<span id="472">472</span>
<span id="473">473</span>
<span id="474">474</span>
<span id="475">475</span>
<span id="476">476</span>
<span id="477">477</span>
<span id="478">478</span>
<span id="479">479</span>
<span id="480">480</span>
<span id="481">481</span>
<span id="482">482</span>
<span id="483">483</span>
<span id="484">484</span>
<span id="485">485</span>
<span id="486">486</span>
<span id="487">487</span>
<span id="488">488</span>
<span id="489">489</span>
<span id="490">490</span>
<span id="491">491</span>
<span id="492">492</span>
<span id="493">493</span>
<span id="494">494</span>
<span id="495">495</span>
<span id="496">496</span>
<span id="497">497</span>
<span id="498">498</span>
<span id="499">499</span>
<span id="500">500</span>
<span id="501">501</span>
<span id="502">502</span>
<span id="503">503</span>
<span id="504">504</span>
<span id="505">505</span>
<span id="506">506</span>
<span id="507">507</span>
<span id="508">508</span>
<span id="509">509</span>
<span id="510">510</span>
<span id="511">511</span>
<span id="512">512</span>
<span id="513">513</span>
<span id="514">514</span>
<span id="515">515</span>
<span id="516">516</span>
<span id="517">517</span>
<span id="518">518</span>
<span id="519">519</span>
<span id="520">520</span>
<span id="521">521</span>
<span id="522">522</span>
<span id="523">523</span>
<span id="524">524</span>
<span id="525">525</span>
<span id="526">526</span>
<span id="527">527</span>
<span id="528">528</span>
<span id="529">529</span>
<span id="530">530</span>
<span id="531">531</span>
<span id="532">532</span>
<span id="533">533</span>
<span id="534">534</span>
<span id="535">535</span>
<span id="536">536</span>
<span id="537">537</span>
<span id="538">538</span>
<span id="539">539</span>
<span id="540">540</span>
<span id="541">541</span>
<span id="542">542</span>
<span id="543">543</span>
<span id="544">544</span>
<span id="545">545</span>
<span id="546">546</span>
<span id="547">547</span>
<span id="548">548</span>
<span id="549">549</span>
<span id="550">550</span>
<span id="551">551</span>
<span id="552">552</span>
<span id="553">553</span>
<span id="554">554</span>
<span id="555">555</span>
<span id="556">556</span>
<span id="557">557</span>
<span id="558">558</span>
<span id="559">559</span>
<span id="560">560</span>
<span id="561">561</span>
<span id="562">562</span>
<span id="563">563</span>
<span id="564">564</span>
<span id="565">565</span>
<span id="566">566</span>
<span id="567">567</span>
<span id="568">568</span>
<span id="569">569</span>
<span id="570">570</span>
<span id="571">571</span>
<span id="572">572</span>
<span id="573">573</span>
<span id="574">574</span>
<span id="575">575</span>
<span id="576">576</span>
<span id="577">577</span>
<span id="578">578</span>
<span id="579">579</span>
<span id="580">580</span>
<span id="581">581</span>
<span id="582">582</span>
<span id="583">583</span>
<span id="584">584</span>
<span id="585">585</span>
<span id="586">586</span>
<span id="587">587</span>
<span id="588">588</span>
<span id="589">589</span>
<span id="590">590</span>
<span id="591">591</span>
<span id="592">592</span>
<span id="593">593</span>
<span id="594">594</span>
<span id="595">595</span>
<span id="596">596</span>
<span id="597">597</span>
<span id="598">598</span>
<span id="599">599</span>
<span id="600">600</span>
<span id="601">601</span>
<span id="602">602</span>
<span id="603">603</span>
<span id="604">604</span>
<span id="605">605</span>
<span id="606">606</span>
<span id="607">607</span>
<span id="608">608</span>
<span id="609">609</span>
<span id="610">610</span>
<span id="611">611</span>
<span id="612">612</span>
<span id="613">613</span>
<span id="614">614</span>
<span id="615">615</span>
<span id="616">616</span>
<span id="617">617</span>
<span id="618">618</span>
<span id="619">619</span>
<span id="620">620</span>
<span id="621">621</span>
<span id="622">622</span>
<span id="623">623</span>
<span id="624">624</span>
<span id="625">625</span>
<span id="626">626</span>
<span id="627">627</span>
<span id="628">628</span>
<span id="629">629</span>
<span id="630">630</span>
<span id="631">631</span>
<span id="632">632</span>
<span id="633">633</span>
<span id="634">634</span>
<span id="635">635</span>
<span id="636">636</span>
<span id="637">637</span>
<span id="638">638</span>
<span id="639">639</span>
<span id="640">640</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2015-2016 Brian Smith.
//
// Permission to use, copy, modify, and/or distribute this software for any
// purpose with or without fee is hereby granted, provided that the above
// copyright notice and this permission notice appear in all copies.
//
// THE SOFTWARE IS PROVIDED &quot;AS IS&quot; AND THE AUTHORS DISCLAIM ALL WARRANTIES
// WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
// SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
// WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
// OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
</span><span class="doccomment">//! Testing framework.
//!
//! Unlike the rest of *ring*, this testing framework uses panics pretty
//! liberally. It was originally designed for internal use--it drives most of
//! *ring*&#39;s internal tests, and so it is optimized for getting *ring*&#39;s tests
//! written quickly at the expense of some usability. The documentation is
//! lacking. The best way to learn it is to look at some examples. The digest
//! tests are the most complicated because they use named sections. Other tests
//! avoid named sections and so are easier to understand.
//!
//! # Examples
//!
//! ## Writing Tests
//!
//! Input files look like this:
//!
//! ```text
//! # This is a comment.
//!
//! HMAC = SHA1
//! Input = &quot;My test data&quot;
//! Key = &quot;&quot;
//! Output = 61afdecb95429ef494d61fdee15990cabf0826fc
//!
//! HMAC = SHA256
//! Input = &quot;Sample message for keylen&lt;blocklen&quot;
//! Key = 000102030405060708090A0B0C0D0E0F101112131415161718191A1B1C1D1E1F
//! Output = A28CF43130EE696A98F14A37678B56BCFCBDD9E5CF69717FECF5480F0EBDF790
//! ```
//!
//! Test cases are separated with blank lines. Note how the bytes of the `Key`
//! attribute are specified as a quoted string in the first test case and as
//! hex in the second test case; you can use whichever form is more convenient
//! and you can mix and match within the same file. The empty sequence of bytes
//! can only be represented with the quoted string form (`&quot;&quot;`).
//!
//! Here&#39;s how you would consume the test data:
//!
//! ```ignore
//! use ring::test;
//!
//! test::run(test::test_file!(&quot;hmac_tests.txt&quot;), |section, test_case| {
//! assert_eq!(section, &quot;&quot;); // This test doesn&#39;t use named sections.
//!
//! let digest_alg = test_case.consume_digest_alg(&quot;HMAC&quot;);
//! let input = test_case.consume_bytes(&quot;Input&quot;);
//! let key = test_case.consume_bytes(&quot;Key&quot;);
//! let output = test_case.consume_bytes(&quot;Output&quot;);
//!
//! // Do the actual testing here
//! });
//! ```
//!
//! Note that `consume_digest_alg` automatically maps the string &quot;SHA1&quot; to a
//! reference to `digest::SHA1_FOR_LEGACY_USE_ONLY`, &quot;SHA256&quot; to
//! `digest::SHA256`, etc.
//!
//! ## Output When a Test Fails
//!
//! When a test case fails, the framework automatically prints out the test
//! case. If the test case failed with a panic, then the backtrace of the panic
//! will be printed too. For example, let&#39;s say the failing test case looks
//! like this:
//!
//! ```text
//! Curve = P-256
//! a = 2b11cb945c8cf152ffa4c9c2b1c965b019b35d0b7626919ef0ae6cb9d232f8af
//! b = 18905f76a53755c679fb732b7762251075ba95fc5fedb60179e730d418a9143c
//! r = 18905f76a53755c679fb732b7762251075ba95fc5fedb60179e730d418a9143c
//! ```
//! If the test fails, this will be printed (if `$RUST_BACKTRACE` is `1`):
//!
//! ```text
//! src/example_tests.txt: Test panicked.
//! Curve = P-256
//! a = 2b11cb945c8cf152ffa4c9c2b1c965b019b35d0b7626919ef0ae6cb9d232f8af
//! b = 18905f76a53755c679fb732b7762251075ba95fc5fedb60179e730d418a9143c
//! r = 18905f76a53755c679fb732b7762251075ba95fc5fedb60179e730d418a9143c
//! thread &#39;example_test&#39; panicked at &#39;Test failed.&#39;, src\test.rs:206
//! stack backtrace:
//! 0: 0x7ff654a05c7c - std::rt::lang_start::h61f4934e780b4dfc
//! 1: 0x7ff654a04f32 - std::rt::lang_start::h61f4934e780b4dfc
//! 2: 0x7ff6549f505d - std::panicking::rust_panic_with_hook::hfe203e3083c2b544
//! 3: 0x7ff654a0825b - rust_begin_unwind
//! 4: 0x7ff6549f63af - std::panicking::begin_panic_fmt::h484cd47786497f03
//! 5: 0x7ff654a07e9b - rust_begin_unwind
//! 6: 0x7ff654a0ae95 - core::panicking::panic_fmt::h257ceb0aa351d801
//! 7: 0x7ff654a0b190 - core::panicking::panic::h4bb1497076d04ab9
//! 8: 0x7ff65496dc41 - from_file&lt;closure&gt;
//! at C:\Users\Example\example\&lt;core macros&gt;:4
//! 9: 0x7ff65496d49c - example_test
//! at C:\Users\Example\example\src\example.rs:652
//! 10: 0x7ff6549d192a - test::stats::Summary::new::ha139494ed2e4e01f
//! 11: 0x7ff6549d51a2 - test::stats::Summary::new::ha139494ed2e4e01f
//! 12: 0x7ff654a0a911 - _rust_maybe_catch_panic
//! 13: 0x7ff6549d56dd - test::stats::Summary::new::ha139494ed2e4e01f
//! 14: 0x7ff654a03783 - std::sys::thread::Thread::new::h2b08da6cd2517f79
//! 15: 0x7ff968518101 - BaseThreadInitThunk
//! ```
//!
//! Notice that the output shows the name of the data file
//! (`src/example_tests.txt`), the test inputs that led to the failure, and the
//! stack trace to the line in the test code that panicked: entry 9 in the
//! stack trace pointing to line 652 of the file `example.rs`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">use </span>alloc::{format, string::String, vec::Vec};
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">use crate</span>::{bits, digest, error};
<span class="attribute">#[cfg(any(feature = <span class="string">&quot;std&quot;</span>, feature = <span class="string">&quot;test_logging&quot;</span>))]
</span><span class="kw">extern crate </span>std;
<span class="doccomment">/// `compile_time_assert_clone::&lt;T&gt;();` fails to compile if `T` doesn&#39;t
/// implement `Clone`.
</span><span class="kw">pub fn </span>compile_time_assert_clone&lt;T: Clone&gt;() {}
<span class="doccomment">/// `compile_time_assert_copy::&lt;T&gt;();` fails to compile if `T` doesn&#39;t
/// implement `Copy`.
</span><span class="kw">pub fn </span>compile_time_assert_copy&lt;T: Copy&gt;() {}
<span class="doccomment">/// `compile_time_assert_send::&lt;T&gt;();` fails to compile if `T` doesn&#39;t
/// implement `Send`.
</span><span class="kw">pub fn </span>compile_time_assert_send&lt;T: Send&gt;() {}
<span class="doccomment">/// `compile_time_assert_sync::&lt;T&gt;();` fails to compile if `T` doesn&#39;t
/// implement `Sync`.
</span><span class="kw">pub fn </span>compile_time_assert_sync&lt;T: Sync&gt;() {}
<span class="doccomment">/// `compile_time_assert_std_error_error::&lt;T&gt;();` fails to compile if `T`
/// doesn&#39;t implement `std::error::Error`.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">pub fn </span>compile_time_assert_std_error_error&lt;T: std::error::Error&gt;() {}
<span class="doccomment">/// A test case. A test case consists of a set of named attributes. Every
/// attribute in the test case must be consumed exactly once; this helps catch
/// typos and omissions.
///
/// Requires the `alloc` default feature to be enabled.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
#[derive(Debug)]
</span><span class="kw">pub struct </span>TestCase {
attributes: Vec&lt;(String, String, bool)&gt;,
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">impl </span>TestCase {
<span class="doccomment">/// Maps the string &quot;true&quot; to true and the string &quot;false&quot; to false.
</span><span class="kw">pub fn </span>consume_bool(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; bool {
<span class="kw">match </span><span class="self">self</span>.consume_string(key).as_ref() {
<span class="string">&quot;true&quot; </span>=&gt; <span class="bool-val">true</span>,
<span class="string">&quot;false&quot; </span>=&gt; <span class="bool-val">false</span>,
s =&gt; <span class="macro">panic!</span>(<span class="string">&quot;Invalid bool value: {}&quot;</span>, s),
}
}
<span class="doccomment">/// Maps the strings &quot;SHA1&quot;, &quot;SHA256&quot;, &quot;SHA384&quot;, and &quot;SHA512&quot; to digest
/// algorithms, maps &quot;SHA224&quot; to `None`, and panics on other (erroneous)
/// inputs. &quot;SHA224&quot; is mapped to None because *ring* intentionally does
/// not support SHA224, but we need to consume test vectors from NIST that
/// have SHA224 vectors in them.
</span><span class="kw">pub fn </span>consume_digest_alg(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>digest::Algorithm&gt; {
<span class="kw">let </span>name = <span class="self">self</span>.consume_string(key);
<span class="kw">match </span>name.as_ref() {
<span class="string">&quot;SHA1&quot; </span>=&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>digest::SHA1_FOR_LEGACY_USE_ONLY),
<span class="string">&quot;SHA224&quot; </span>=&gt; <span class="prelude-val">None</span>, <span class="comment">// We actively skip SHA-224 support.
</span><span class="string">&quot;SHA256&quot; </span>=&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>digest::SHA256),
<span class="string">&quot;SHA384&quot; </span>=&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>digest::SHA384),
<span class="string">&quot;SHA512&quot; </span>=&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>digest::SHA512),
<span class="string">&quot;SHA512_256&quot; </span>=&gt; <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span>digest::SHA512_256),
<span class="kw">_ </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Unsupported digest algorithm: {}&quot;</span>, name),
}
}
<span class="doccomment">/// Returns the value of an attribute that is encoded as a sequence of an
/// even number of hex digits, or as a double-quoted UTF-8 string. The
/// empty (zero-length) value is represented as &quot;&quot;.
</span><span class="kw">pub fn </span>consume_bytes(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; Vec&lt;u8&gt; {
<span class="kw">let </span>s = <span class="self">self</span>.consume_string(key);
<span class="kw">if </span>s.starts_with(<span class="string">&#39;\&quot;&#39;</span>) {
<span class="comment">// The value is a quoted UTF-8 string.
</span><span class="kw">let </span><span class="kw-2">mut </span>bytes = Vec::with_capacity(s.as_bytes().len() - <span class="number">2</span>);
<span class="kw">let </span><span class="kw-2">mut </span>s = s.as_bytes().iter().skip(<span class="number">1</span>);
<span class="kw">loop </span>{
<span class="kw">let </span>b = <span class="kw">match </span>s.next() {
<span class="prelude-val">Some</span>(<span class="string">b&#39;\\&#39;</span>) =&gt; {
<span class="kw">match </span>s.next() {
<span class="comment">// We don&#39;t allow all octal escape sequences, only &quot;\0&quot; for null.
</span><span class="prelude-val">Some</span>(<span class="string">b&#39;0&#39;</span>) =&gt; <span class="number">0u8</span>,
<span class="prelude-val">Some</span>(<span class="string">b&#39;t&#39;</span>) =&gt; <span class="string">b&#39;\t&#39;</span>,
<span class="prelude-val">Some</span>(<span class="string">b&#39;n&#39;</span>) =&gt; <span class="string">b&#39;\n&#39;</span>,
<span class="comment">// &quot;\xHH&quot;
</span><span class="prelude-val">Some</span>(<span class="string">b&#39;x&#39;</span>) =&gt; {
<span class="kw">let </span>hi = s.next().expect(<span class="string">&quot;Invalid hex escape sequence in string.&quot;</span>);
<span class="kw">let </span>lo = s.next().expect(<span class="string">&quot;Invalid hex escape sequence in string.&quot;</span>);
<span class="kw">if let </span>(<span class="prelude-val">Ok</span>(hi), <span class="prelude-val">Ok</span>(lo)) = (from_hex_digit(<span class="kw-2">*</span>hi), from_hex_digit(<span class="kw-2">*</span>lo))
{
(hi &lt;&lt; <span class="number">4</span>) | lo
} <span class="kw">else </span>{
<span class="macro">panic!</span>(<span class="string">&quot;Invalid hex escape sequence in string.&quot;</span>);
}
}
<span class="kw">_ </span>=&gt; {
<span class="macro">panic!</span>(<span class="string">&quot;Invalid hex escape sequence in string.&quot;</span>);
}
}
}
<span class="prelude-val">Some</span>(<span class="string">b&#39;&quot;&#39;</span>) =&gt; {
<span class="kw">if </span>s.next().is_some() {
<span class="macro">panic!</span>(<span class="string">&quot;characters after the closing quote of a quoted string.&quot;</span>);
}
<span class="kw">break</span>;
}
<span class="prelude-val">Some</span>(b) =&gt; <span class="kw-2">*</span>b,
<span class="prelude-val">None </span>=&gt; <span class="macro">panic!</span>(<span class="string">&quot;Missing terminating &#39;\&quot;&#39; in string literal.&quot;</span>),
};
bytes.push(b);
}
bytes
} <span class="kw">else </span>{
<span class="comment">// The value is hex encoded.
</span><span class="kw">match </span>from_hex(<span class="kw-2">&amp;</span>s) {
<span class="prelude-val">Ok</span>(s) =&gt; s,
<span class="prelude-val">Err</span>(err_str) =&gt; {
<span class="macro">panic!</span>(<span class="string">&quot;{} in {}&quot;</span>, err_str, s);
}
}
}
}
<span class="doccomment">/// Returns the value of an attribute that is an integer, in decimal
/// notation.
</span><span class="kw">pub fn </span>consume_usize(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; usize {
<span class="kw">let </span>s = <span class="self">self</span>.consume_string(key);
s.parse::&lt;usize&gt;().unwrap()
}
<span class="doccomment">/// Returns the value of an attribute that is an integer, in decimal
/// notation, as a bit length.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub fn </span>consume_usize_bits(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; bits::BitLength {
<span class="kw">let </span>s = <span class="self">self</span>.consume_string(key);
<span class="kw">let </span>bits = s.parse::&lt;usize&gt;().unwrap();
bits::BitLength::from_usize_bits(bits)
}
<span class="doccomment">/// Returns the raw value of an attribute, without any unquoting or
/// other interpretation.
</span><span class="kw">pub fn </span>consume_string(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; String {
<span class="self">self</span>.consume_optional_string(key)
.unwrap_or_else(|| <span class="macro">panic!</span>(<span class="string">&quot;No attribute named \&quot;{}\&quot;&quot;</span>, key))
}
<span class="doccomment">/// Like `consume_string()` except it returns `None` if the test case
/// doesn&#39;t have the attribute.
</span><span class="kw">pub fn </span>consume_optional_string(<span class="kw-2">&amp;mut </span><span class="self">self</span>, key: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Option</span>&lt;String&gt; {
<span class="kw">for </span>(name, value, consumed) <span class="kw">in </span><span class="kw-2">&amp;mut </span><span class="self">self</span>.attributes {
<span class="kw">if </span>key == name {
<span class="kw">if </span><span class="kw-2">*</span>consumed {
<span class="macro">panic!</span>(<span class="string">&quot;Attribute {} was already consumed&quot;</span>, key);
}
<span class="kw-2">*</span>consumed = <span class="bool-val">true</span>;
<span class="kw">return </span><span class="prelude-val">Some</span>(value.clone());
}
}
<span class="prelude-val">None
</span>}
}
<span class="doccomment">/// References a test input file.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
#[macro_export]
</span><span class="macro">macro_rules! </span>test_file {
(<span class="macro-nonterminal">$file_name</span>:expr) =&gt; {
<span class="kw">crate</span>::test::File {
file_name: <span class="macro-nonterminal">$file_name</span>,
contents: <span class="macro">include_str!</span>(<span class="macro-nonterminal">$file_name</span>),
}
};
}
<span class="doccomment">/// A test input file.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub struct </span>File&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// The name (path) of the file.
</span><span class="kw">pub </span>file_name: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
<span class="doccomment">/// The contents of the file.
</span><span class="kw">pub </span>contents: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>str,
}
<span class="doccomment">/// Parses test cases out of the given file, calling `f` on each vector until
/// `f` fails or until all the test vectors have been read. `f` can indicate
/// failure either by returning `Err()` or by panicking.
///
/// Requires the `alloc` default feature to be enabled
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub fn </span>run&lt;F&gt;(test_file: File, <span class="kw-2">mut </span>f: F)
<span class="kw">where
</span>F: FnMut(<span class="kw-2">&amp;</span>str, <span class="kw-2">&amp;mut </span>TestCase) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt;,
{
<span class="kw">let </span>lines = <span class="kw-2">&amp;mut </span>test_file.contents.lines();
<span class="kw">let </span><span class="kw-2">mut </span>current_section = String::from(<span class="string">&quot;&quot;</span>);
<span class="kw">let </span><span class="kw-2">mut </span>failed = <span class="bool-val">false</span>;
<span class="kw">while let </span><span class="prelude-val">Some</span>(<span class="kw-2">mut </span>test_case) = parse_test_case(<span class="kw-2">&amp;mut </span>current_section, lines) {
<span class="kw">let </span>result = <span class="kw">match </span>f(<span class="kw-2">&amp;</span>current_section, <span class="kw-2">&amp;mut </span>test_case) {
<span class="prelude-val">Ok</span>(()) =&gt; {
<span class="kw">if </span>!test_case
.attributes
.iter()
.any(|<span class="kw-2">&amp;</span>(<span class="kw">_</span>, <span class="kw">_</span>, consumed)| !consumed)
{
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
failed = <span class="bool-val">true</span>;
<span class="prelude-val">Err</span>(<span class="string">&quot;Test didn&#39;t consume all attributes.&quot;</span>)
}
}
<span class="prelude-val">Err</span>(error::Unspecified) =&gt; <span class="prelude-val">Err</span>(<span class="string">&quot;Test returned Err(error::Unspecified).&quot;</span>),
};
<span class="kw">if </span>result.is_err() {
failed = <span class="bool-val">true</span>;
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;test_logging&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Err</span>(msg) = result {
<span class="macro">std::println!</span>(<span class="string">&quot;{}: {}&quot;</span>, test_file.file_name, msg);
<span class="kw">for </span>(name, value, consumed) <span class="kw">in </span>test_case.attributes {
<span class="kw">let </span>consumed_str = <span class="kw">if </span>consumed { <span class="string">&quot;&quot; </span>} <span class="kw">else </span>{ <span class="string">&quot; (unconsumed)&quot; </span>};
<span class="macro">std::println!</span>(<span class="string">&quot;{}{} = {}&quot;</span>, name, consumed_str, value);
}
};
}
}
<span class="kw">if </span>failed {
<span class="macro">panic!</span>(<span class="string">&quot;Test failed.&quot;</span>)
}
}
<span class="doccomment">/// Decode an string of hex digits into a sequence of bytes. The input must
/// have an even number of digits.
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">pub fn </span>from_hex(hex_str: <span class="kw-2">&amp;</span>str) -&gt; <span class="prelude-ty">Result</span>&lt;Vec&lt;u8&gt;, String&gt; {
<span class="kw">if </span>hex_str.len() % <span class="number">2 </span>!= <span class="number">0 </span>{
<span class="kw">return </span><span class="prelude-val">Err</span>(String::from(
<span class="string">&quot;Hex string does not have an even number of digits&quot;</span>,
));
}
<span class="kw">let </span><span class="kw-2">mut </span>result = Vec::with_capacity(hex_str.len() / <span class="number">2</span>);
<span class="kw">for </span>digits <span class="kw">in </span>hex_str.as_bytes().chunks(<span class="number">2</span>) {
<span class="kw">let </span>hi = from_hex_digit(digits[<span class="number">0</span>])<span class="question-mark">?</span>;
<span class="kw">let </span>lo = from_hex_digit(digits[<span class="number">1</span>])<span class="question-mark">?</span>;
result.push((hi * <span class="number">0x10</span>) | lo);
}
<span class="prelude-val">Ok</span>(result)
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">fn </span>from_hex_digit(d: u8) -&gt; <span class="prelude-ty">Result</span>&lt;u8, String&gt; {
<span class="kw">use </span>core::ops::RangeInclusive;
<span class="kw">const </span>DECIMAL: (u8, RangeInclusive&lt;u8&gt;) = (<span class="number">0</span>, <span class="string">b&#39;0&#39;</span>..=<span class="string">b&#39;9&#39;</span>);
<span class="kw">const </span>HEX_LOWER: (u8, RangeInclusive&lt;u8&gt;) = (<span class="number">10</span>, <span class="string">b&#39;a&#39;</span>..=<span class="string">b&#39;f&#39;</span>);
<span class="kw">const </span>HEX_UPPER: (u8, RangeInclusive&lt;u8&gt;) = (<span class="number">10</span>, <span class="string">b&#39;A&#39;</span>..=<span class="string">b&#39;F&#39;</span>);
<span class="kw">for </span>(offset, range) <span class="kw">in </span><span class="kw-2">&amp;</span>[DECIMAL, HEX_LOWER, HEX_UPPER] {
<span class="kw">if </span>range.contains(<span class="kw-2">&amp;</span>d) {
<span class="kw">return </span><span class="prelude-val">Ok</span>(d - range.start() + offset);
}
}
<span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">&quot;Invalid hex digit &#39;{}&#39;&quot;</span>, d <span class="kw">as </span>char))
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;alloc&quot;</span>)]
</span><span class="kw">fn </span>parse_test_case(
current_section: <span class="kw-2">&amp;mut </span>String,
lines: <span class="kw-2">&amp;mut </span><span class="kw">dyn </span>Iterator&lt;Item = <span class="kw-2">&amp;</span>str&gt;,
) -&gt; <span class="prelude-ty">Option</span>&lt;TestCase&gt; {
<span class="kw">let </span><span class="kw-2">mut </span>attributes = Vec::new();
<span class="kw">let </span><span class="kw-2">mut </span>is_first_line = <span class="bool-val">true</span>;
<span class="kw">loop </span>{
<span class="kw">let </span>line = lines.next();
<span class="attribute">#[cfg(feature = <span class="string">&quot;test_logging&quot;</span>)]
</span>{
<span class="kw">if let </span><span class="prelude-val">Some</span>(text) = <span class="kw-2">&amp;</span>line {
<span class="macro">std::println!</span>(<span class="string">&quot;Line: {}&quot;</span>, text);
}
}
<span class="kw">match </span>line {
<span class="comment">// If we get to EOF when we&#39;re not in the middle of a test case,
// then we&#39;re done.
</span><span class="prelude-val">None </span><span class="kw">if </span>is_first_line =&gt; {
<span class="kw">return </span><span class="prelude-val">None</span>;
}
<span class="comment">// End of the file on a non-empty test cases ends the test case.
</span><span class="prelude-val">None </span>=&gt; {
<span class="kw">return </span><span class="prelude-val">Some</span>(TestCase { attributes });
}
<span class="comment">// A blank line ends a test case if the test case isn&#39;t empty.
</span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>line) <span class="kw">if </span>line.is_empty() =&gt; {
<span class="kw">if </span>!is_first_line {
<span class="kw">return </span><span class="prelude-val">Some</span>(TestCase { attributes });
}
<span class="comment">// Ignore leading blank lines.
</span>}
<span class="comment">// Comments start with &#39;#&#39;; ignore them.
</span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>line) <span class="kw">if </span>line.starts_with(<span class="string">&#39;#&#39;</span>) =&gt; (),
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>line) <span class="kw">if </span>line.starts_with(<span class="string">&#39;[&#39;</span>) =&gt; {
<span class="macro">assert!</span>(is_first_line);
<span class="macro">assert!</span>(line.ends_with(<span class="string">&#39;]&#39;</span>));
current_section.truncate(<span class="number">0</span>);
current_section.push_str(line);
<span class="kw">let _ </span>= current_section.pop();
<span class="kw">let _ </span>= current_section.remove(<span class="number">0</span>);
}
<span class="prelude-val">Some</span>(<span class="kw-2">ref </span>line) =&gt; {
is_first_line = <span class="bool-val">false</span>;
<span class="kw">let </span>parts: Vec&lt;<span class="kw-2">&amp;</span>str&gt; = line.splitn(<span class="number">2</span>, <span class="string">&quot; = &quot;</span>).collect();
<span class="kw">if </span>parts.len() != <span class="number">2 </span>{
<span class="macro">panic!</span>(<span class="string">&quot;Syntax error: Expected Key = Value.&quot;</span>);
};
<span class="kw">let </span>key = parts[<span class="number">0</span>].trim();
<span class="kw">let </span>value = parts[<span class="number">1</span>].trim();
<span class="comment">// Don&#39;t allow the value to be ommitted. An empty value can be
// represented as an empty quoted string.
</span><span class="macro">assert_ne!</span>(value.len(), <span class="number">0</span>);
<span class="comment">// Checking is_none() ensures we don&#39;t accept duplicate keys.
</span>attributes.push((String::from(key), String::from(value), <span class="bool-val">false</span>));
}
}
}
}
<span class="doccomment">/// Deterministic implementations of `ring::rand::SecureRandom`.
///
/// These implementations are particularly useful for testing implementations
/// of randomized algorithms &amp; protocols using known-answer-tests where the
/// test vectors contain the random seed to use. They are also especially
/// useful for some types of fuzzing.
</span><span class="attribute">#[doc(hidden)]
</span><span class="kw">pub mod </span>rand {
<span class="kw">use crate</span>::{error, polyfill, rand};
<span class="doccomment">/// An implementation of `SecureRandom` that always fills the output slice
/// with the given byte.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>FixedByteRandom {
<span class="kw">pub </span>byte: u8,
}
<span class="kw">impl </span>rand::sealed::SecureRandom <span class="kw">for </span>FixedByteRandom {
<span class="kw">fn </span>fill_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
polyfill::slice::fill(dest, <span class="self">self</span>.byte);
<span class="prelude-val">Ok</span>(())
}
}
<span class="doccomment">/// An implementation of `SecureRandom` that always fills the output slice
/// with the slice in `bytes`. The length of the slice given to `slice`
/// must match exactly.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>FixedSliceRandom&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="kw">pub </span>bytes: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8],
}
<span class="kw">impl </span>rand::sealed::SecureRandom <span class="kw">for </span>FixedSliceRandom&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>fill_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
dest.copy_from_slice(<span class="self">self</span>.bytes);
<span class="prelude-val">Ok</span>(())
}
}
<span class="doccomment">/// An implementation of `SecureRandom` where each slice in `bytes` is a
/// test vector for one call to `fill()`. *Not thread-safe.*
///
/// The first slice in `bytes` is the output for the first call to
/// `fill()`, the second slice is the output for the second call to
/// `fill()`, etc. The output slice passed to `fill()` must have exactly
/// the length of the corresponding entry in `bytes`. `current` must be
/// initialized to zero. `fill()` must be called exactly once for each
/// entry in `bytes`.
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>FixedSliceSequenceRandom&lt;<span class="lifetime">&#39;a</span>&gt; {
<span class="doccomment">/// The value.
</span><span class="kw">pub </span>bytes: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>[u8]],
<span class="kw">pub </span>current: core::cell::UnsafeCell&lt;usize&gt;,
}
<span class="kw">impl </span>rand::sealed::SecureRandom <span class="kw">for </span>FixedSliceSequenceRandom&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>fill_impl(<span class="kw-2">&amp;</span><span class="self">self</span>, dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; <span class="prelude-ty">Result</span>&lt;(), error::Unspecified&gt; {
<span class="kw">let </span>current = <span class="kw">unsafe </span>{ <span class="kw-2">*</span><span class="self">self</span>.current.get() };
<span class="kw">let </span>bytes = <span class="self">self</span>.bytes[current];
dest.copy_from_slice(bytes);
<span class="comment">// Remember that we returned this slice and prepare to return
// the next one, if any.
</span><span class="kw">unsafe </span>{ <span class="kw-2">*</span><span class="self">self</span>.current.get() += <span class="number">1 </span>};
<span class="prelude-val">Ok</span>(())
}
}
<span class="kw">impl </span>Drop <span class="kw">for </span>FixedSliceSequenceRandom&lt;<span class="lifetime">&#39;_</span>&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="comment">// Ensure that `fill()` was called exactly the right number of
// times.
</span><span class="macro">assert_eq!</span>(<span class="kw">unsafe </span>{ <span class="kw-2">*</span><span class="self">self</span>.current.get() }, <span class="self">self</span>.bytes.len());
}
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>tests {
<span class="kw">use crate</span>::{error, test};
<span class="attribute">#[test]
</span><span class="kw">fn </span>one_ok() {
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_1_tests.txt&quot;</span>), |<span class="kw">_</span>, test_case| {
<span class="kw">let _ </span>= test_case.consume_string(<span class="string">&quot;Key&quot;</span>);
<span class="prelude-val">Ok</span>(())
});
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Test failed.&quot;</span>)]
</span><span class="kw">fn </span>one_err() {
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_1_tests.txt&quot;</span>), |<span class="kw">_</span>, test_case| {
<span class="kw">let _ </span>= test_case.consume_string(<span class="string">&quot;Key&quot;</span>);
<span class="prelude-val">Err</span>(error::Unspecified)
});
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Oh noes!&quot;</span>)]
</span><span class="kw">fn </span>one_panics() {
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_1_tests.txt&quot;</span>), |<span class="kw">_</span>, test_case| {
<span class="kw">let _ </span>= test_case.consume_string(<span class="string">&quot;Key&quot;</span>);
<span class="macro">panic!</span>(<span class="string">&quot;Oh noes!&quot;</span>);
});
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Test failed.&quot;</span>)]
</span><span class="kw">fn </span>first_err() {
err_one(<span class="number">0</span>)
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Test failed.&quot;</span>)]
</span><span class="kw">fn </span>middle_err() {
err_one(<span class="number">1</span>)
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Test failed.&quot;</span>)]
</span><span class="kw">fn </span>last_err() {
err_one(<span class="number">2</span>)
}
<span class="kw">fn </span>err_one(test_to_fail: usize) {
<span class="kw">let </span><span class="kw-2">mut </span>n = <span class="number">0</span>;
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_3_tests.txt&quot;</span>), |<span class="kw">_</span>, test_case| {
<span class="kw">let _ </span>= test_case.consume_string(<span class="string">&quot;Key&quot;</span>);
<span class="kw">let </span>result = <span class="kw">if </span>n != test_to_fail {
<span class="prelude-val">Ok</span>(())
} <span class="kw">else </span>{
<span class="prelude-val">Err</span>(error::Unspecified)
};
n += <span class="number">1</span>;
result
});
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Oh Noes!&quot;</span>)]
</span><span class="kw">fn </span>first_panic() {
panic_one(<span class="number">0</span>)
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Oh Noes!&quot;</span>)]
</span><span class="kw">fn </span>middle_panic() {
panic_one(<span class="number">1</span>)
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Oh Noes!&quot;</span>)]
</span><span class="kw">fn </span>last_panic() {
panic_one(<span class="number">2</span>)
}
<span class="kw">fn </span>panic_one(test_to_fail: usize) {
<span class="kw">let </span><span class="kw-2">mut </span>n = <span class="number">0</span>;
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_3_tests.txt&quot;</span>), |<span class="kw">_</span>, test_case| {
<span class="kw">let _ </span>= test_case.consume_string(<span class="string">&quot;Key&quot;</span>);
<span class="kw">if </span>n == test_to_fail {
<span class="macro">panic!</span>(<span class="string">&quot;Oh Noes!&quot;</span>);
};
n += <span class="number">1</span>;
<span class="prelude-val">Ok</span>(())
});
}
<span class="attribute">#[test]
#[should_panic(expected = <span class="string">&quot;Syntax error: Expected Key = Value.&quot;</span>)]
</span><span class="kw">fn </span>syntax_error() {
test::run(<span class="macro">test_file!</span>(<span class="string">&quot;test_1_syntax_error_tests.txt&quot;</span>), |<span class="kw">_</span>, <span class="kw">_</span>| <span class="prelude-val">Ok</span>(()));
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ring" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>