ARCHIVE/rippled
1
0
Fork 0
mirror of https://github.com/XRPLF/rippled.git synced 2026-01-30 11:35:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
rippled/FileUtilities__test_8cpp_source.html
bthomee 9368c0d563 deploy: 5f638f5553
2026-01-28 10:13:01 -08:00

167 lines
17 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>rippled: FileUtilities_test.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">rippled
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function() { init_codefold(0); });
/* @license-end */
</script>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_120ed4da3e3217b1e7fc0b4f48568e79.html">test</a></li><li class="navelem"><a class="el" href="dir_354330c8aa73f5a2ebe2c490e5cf38ef.html">basics</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">FileUtilities_test.cpp</div></div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#include &lt;test/unit_test/FileDirGuard.h&gt;</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#include &lt;xrpl/basics/ByteUtilities.h&gt;</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="preprocessor">#include &lt;xrpl/basics/FileUtilities.h&gt;</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &lt;xrpl/beast/unit_test.h&gt;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespacexrpl.html">xrpl</a> {</div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span> </div>
<div class="foldopen" id="foldopen00009" data-start="{" data-end="};">
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"><a class="line" href="classxrpl_1_1FileUtilities__test.html"> 9</a></span><span class="keyword">class </span><a class="code hl_class" href="classxrpl_1_1FileUtilities__test.html">FileUtilities_test</a> : <span class="keyword">public</span> <a class="code hl_class" href="classbeast_1_1unit__test_1_1suite.html">beast::unit_test::suite</a></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span>{</div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00013" data-start="{" data-end="}">
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="classxrpl_1_1FileUtilities__test.html#a062613a6dd72ce7ee8bd9be2d894cb71"> 13</a></span> <a class="code hl_function" href="classxrpl_1_1FileUtilities__test.html#a062613a6dd72ce7ee8bd9be2d894cb71">testGetFileContents</a>()</div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span> <span class="keyword">using namespace </span><a class="code hl_namespace" href="namespacexrpl_1_1detail.html">xrpl::detail</a>;</div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> <span class="keyword">using namespace </span>boost::system;</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">constexpr</span> <span class="keywordtype">char</span> <span class="keyword">const</span>* expectedContents = <span class="stringliteral">&quot;This file is very short. That&#39;s all we need.&quot;</span>;</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> <a class="code hl_class" href="classxrpl_1_1detail_1_1FileDirGuard.html">FileDirGuard</a> file(*<span class="keyword">this</span>, <span class="stringliteral">&quot;test_file&quot;</span>, <span class="stringliteral">&quot;test.txt&quot;</span>, <span class="stringliteral">&quot;This is temporary text that should get overwritten&quot;</span>);</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> </div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> error_code ec;</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <span class="keyword">auto</span> <span class="keyword">const</span> path = file.<a class="code hl_function" href="classxrpl_1_1detail_1_1FileDirGuard.html#a37e2e642bdeb9ab5d6ad25f1ede8ef8c">file</a>();</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> </div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_function" href="namespacexrpl.html#a9ecabaeaf4ef40da63886bf612a17c2a">writeFileContents</a>(ec, path, expectedContents);</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> BEAST_EXPECT(!ec);</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Test with no max</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <span class="keyword">auto</span> <span class="keyword">const</span> good = <a class="code hl_function" href="namespacexrpl.html#a1549b0e65e0106b13e81b0cd33468ee9">getFileContents</a>(ec, path);</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> BEAST_EXPECT(!ec);</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> BEAST_EXPECT(good == expectedContents);</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> <span class="comment">// Test with large max</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> <span class="keyword">auto</span> <span class="keyword">const</span> good = <a class="code hl_function" href="namespacexrpl.html#a1549b0e65e0106b13e81b0cd33468ee9">getFileContents</a>(ec, path, <a class="code hl_function" href="namespacexrpl.html#aab108af9fcb88b7d9e3a38c78e74a950">kilobytes</a>(1));</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> BEAST_EXPECT(!ec);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> BEAST_EXPECT(good == expectedContents);</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> }</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> </div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> <span class="comment">// Test with small max</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">auto</span> <span class="keyword">const</span> bad = <a class="code hl_function" href="namespacexrpl.html#a1549b0e65e0106b13e81b0cd33468ee9">getFileContents</a>(ec, path, 16);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> BEAST_EXPECT(ec &amp;&amp; ec.value() == boost::system::errc::file_too_large);</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> BEAST_EXPECT(bad.empty());</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> }</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> }</div>
</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> <span class="keywordtype">void</span></div>
<div class="foldopen" id="foldopen00051" data-start="{" data-end="}">
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="classxrpl_1_1FileUtilities__test.html#ae20f5bd62c4725f6d6f3d21555fdb6ff"> 51</a></span> <a class="code hl_function" href="classxrpl_1_1FileUtilities__test.html#ae20f5bd62c4725f6d6f3d21555fdb6ff">run</a>()<span class="keyword"> override</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="keyword"> </span>{</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <a class="code hl_function" href="classxrpl_1_1FileUtilities__test.html#a062613a6dd72ce7ee8bd9be2d894cb71">testGetFileContents</a>();</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> }</div>
</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span>};</div>
</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="namespacexrpl.html#a578c986f88038f94937289d37e16be5a"> 57</a></span>BEAST_DEFINE_TESTSUITE(FileUtilities, basics, <a class="code hl_namespace" href="namespacexrpl.html">xrpl</a>);</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span>} <span class="comment">// namespace xrpl</span></div>
<div class="ttc" id="aclassbeast_1_1unit__test_1_1suite_html"><div class="ttname"><a href="classbeast_1_1unit__test_1_1suite.html">beast::unit_test::suite</a></div><div class="ttdoc">A testsuite class.</div><div class="ttdef"><b>Definition</b> <a href="suite_8h_source.html#l00051">suite.h:52</a></div></div>
<div class="ttc" id="aclassxrpl_1_1FileUtilities__test_html"><div class="ttname"><a href="classxrpl_1_1FileUtilities__test.html">xrpl::FileUtilities_test</a></div><div class="ttdef"><b>Definition</b> <a href="FileUtilities__test_8cpp_source.html#l00009">FileUtilities_test.cpp:10</a></div></div>
<div class="ttc" id="aclassxrpl_1_1FileUtilities__test_html_a062613a6dd72ce7ee8bd9be2d894cb71"><div class="ttname"><a href="classxrpl_1_1FileUtilities__test.html#a062613a6dd72ce7ee8bd9be2d894cb71">xrpl::FileUtilities_test::testGetFileContents</a></div><div class="ttdeci">void testGetFileContents()</div><div class="ttdef"><b>Definition</b> <a href="FileUtilities__test_8cpp_source.html#l00013">FileUtilities_test.cpp:13</a></div></div>
<div class="ttc" id="aclassxrpl_1_1FileUtilities__test_html_ae20f5bd62c4725f6d6f3d21555fdb6ff"><div class="ttname"><a href="classxrpl_1_1FileUtilities__test.html#ae20f5bd62c4725f6d6f3d21555fdb6ff">xrpl::FileUtilities_test::run</a></div><div class="ttdeci">void run() override</div><div class="ttdoc">Runs the suite.</div><div class="ttdef"><b>Definition</b> <a href="FileUtilities__test_8cpp_source.html#l00051">FileUtilities_test.cpp:51</a></div></div>
<div class="ttc" id="aclassxrpl_1_1detail_1_1FileDirGuard_html"><div class="ttname"><a href="classxrpl_1_1detail_1_1FileDirGuard.html">xrpl::detail::FileDirGuard</a></div><div class="ttdoc">Write a file in a directory and remove when done.</div><div class="ttdef"><b>Definition</b> <a href="FileDirGuard_8h_source.html#l00089">FileDirGuard.h:90</a></div></div>
<div class="ttc" id="aclassxrpl_1_1detail_1_1FileDirGuard_html_a37e2e642bdeb9ab5d6ad25f1ede8ef8c"><div class="ttname"><a href="classxrpl_1_1detail_1_1FileDirGuard.html#a37e2e642bdeb9ab5d6ad25f1ede8ef8c">xrpl::detail::FileDirGuard::file</a></div><div class="ttdeci">path const &amp; file() const</div><div class="ttdef"><b>Definition</b> <a href="FileDirGuard_8h_source.html#l00143">FileDirGuard.h:143</a></div></div>
<div class="ttc" id="anamespacexrpl_1_1detail_html"><div class="ttname"><a href="namespacexrpl_1_1detail.html">xrpl::detail</a></div><div class="ttdef"><b>Definition</b> <a href="base__uint_8h_source.html#l00028">base_uint.h:28</a></div></div>
<div class="ttc" id="anamespacexrpl_html"><div class="ttname"><a href="namespacexrpl.html">xrpl</a></div><div class="ttdoc">Use hash_* containers for keys that do not need a cryptographically secure hashing algorithm.</div><div class="ttdef"><b>Definition</b> <a href="algorithm_8h_source.html#l00006">algorithm.h:6</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a1549b0e65e0106b13e81b0cd33468ee9"><div class="ttname"><a href="namespacexrpl.html#a1549b0e65e0106b13e81b0cd33468ee9">xrpl::getFileContents</a></div><div class="ttdeci">std::string getFileContents(boost::system::error_code &amp;ec, boost::filesystem::path const &amp;sourcePath, std::optional&lt; std::size_t &gt; maxSize=std::nullopt)</div><div class="ttdef"><b>Definition</b> <a href="FileUtilities_8cpp_source.html#l00021">FileUtilities.cpp:21</a></div></div>
<div class="ttc" id="anamespacexrpl_html_a9ecabaeaf4ef40da63886bf612a17c2a"><div class="ttname"><a href="namespacexrpl.html#a9ecabaeaf4ef40da63886bf612a17c2a">xrpl::writeFileContents</a></div><div class="ttdeci">void writeFileContents(boost::system::error_code &amp;ec, boost::filesystem::path const &amp;destPath, std::string const &amp;contents)</div><div class="ttdef"><b>Definition</b> <a href="FileUtilities_8cpp_source.html#l00060">FileUtilities.cpp:60</a></div></div>
<div class="ttc" id="anamespacexrpl_html_aab108af9fcb88b7d9e3a38c78e74a950"><div class="ttname"><a href="namespacexrpl.html#aab108af9fcb88b7d9e3a38c78e74a950">xrpl::kilobytes</a></div><div class="ttdeci">constexpr auto kilobytes(T value) noexcept</div><div class="ttdef"><b>Definition</b> <a href="ByteUtilities_8h_source.html#l00008">ByteUtilities.h:8</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink