mirror of
https://github.com/XRPLF/rippled.git
synced 2025-11-21 11:35:53 +00:00
171 lines
19 KiB
HTML
171 lines
19 KiB
HTML
<!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">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.17"/>
|
|
<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 style="height: 56px;">
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">rippled
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.17 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
/* @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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */</script>
|
|
<div id="main-nav"></div>
|
|
<!-- 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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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 name="l00001"></a><span class="lineno"> 1</span> <span class="comment">//------------------------------------------------------------------------------</span></div>
|
|
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
|
|
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> This file is part of rippled: https://github.com/ripple/rippled</span></div>
|
|
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> Copyright (c) 2018 Ripple Labs Inc.</span></div>
|
|
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> Permission to use, copy, modify, and/or distribute this software for any</span></div>
|
|
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> purpose with or without fee is hereby granted, provided that the above</span></div>
|
|
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> copyright notice and this permission notice appear in all copies.</span></div>
|
|
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span> </div>
|
|
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES</span></div>
|
|
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF</span></div>
|
|
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR</span></div>
|
|
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES</span></div>
|
|
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN</span></div>
|
|
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF</span></div>
|
|
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</span></div>
|
|
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div>
|
|
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">//==============================================================================</span></div>
|
|
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>  </div>
|
|
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include <ripple/basics/ByteUtilities.h></span></div>
|
|
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include <ripple/basics/FileUtilities.h></span></div>
|
|
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <ripple/beast/unit_test.h></span></div>
|
|
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <test/unit_test/FileDirGuard.h></span></div>
|
|
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>  </div>
|
|
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">namespace </span><a class="code" href="namespaceripple.html">ripple</a> {</div>
|
|
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>  </div>
|
|
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="classripple_1_1FileUtilities__test.html"> 27</a></span> <span class="keyword">class </span><a class="code" href="classripple_1_1FileUtilities__test.html">FileUtilities_test</a> : <span class="keyword">public</span> beast::unit_test::suite</div>
|
|
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div>
|
|
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">public</span>:</div>
|
|
<div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="classripple_1_1FileUtilities__test.html#a0e6c0183f7372518229a8904ccf05c7b"> 30</a></span>  <span class="keywordtype">void</span> <a class="code" href="classripple_1_1FileUtilities__test.html#a0e6c0183f7372518229a8904ccf05c7b">testGetFileContents</a>()</div>
|
|
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>  {</div>
|
|
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">using namespace </span><a class="code" href="namespaceripple_1_1test_1_1detail.html">ripple::test::detail</a>;</div>
|
|
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="keyword">using namespace </span>boost::system;</div>
|
|
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  </div>
|
|
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  constexpr <span class="keyword">const</span> <span class="keywordtype">char</span>* expectedContents =</div>
|
|
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="stringliteral">"This file is very short. That's all we need."</span>;</div>
|
|
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  </div>
|
|
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <a class="code" href="classripple_1_1test_1_1detail_1_1FileDirGuard.html">FileDirGuard</a> file(*<span class="keyword">this</span>, <span class="stringliteral">"test_file"</span>, <span class="stringliteral">"test.txt"</span>,</div>
|
|
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="stringliteral">"This is temporary text that should get overwritten"</span>);</div>
|
|
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div>
|
|
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  error_code ec;</div>
|
|
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">auto</span> <span class="keyword">const</span> path = file.<a class="code" href="classripple_1_1test_1_1detail_1_1FileDirGuard.html#aa1aad19f81907987fee0d26cc0d4b8c1">file</a>();</div>
|
|
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  </div>
|
|
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <a class="code" href="namespaceripple.html#ae18870f8d8eaa17b582f609cc486aa04">writeFileContents</a>(ec, path, expectedContents);</div>
|
|
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  BEAST_EXPECT(!ec);</div>
|
|
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  </div>
|
|
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div>
|
|
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="comment">// Test with no max</span></div>
|
|
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">auto</span> <span class="keyword">const</span> good = <a class="code" href="namespaceripple.html#ab2a02635f3d304617a7b59a60d13cc3b">getFileContents</a>(ec, path);</div>
|
|
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  BEAST_EXPECT(!ec);</div>
|
|
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  BEAST_EXPECT(good == expectedContents);</div>
|
|
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  }</div>
|
|
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  </div>
|
|
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  {</div>
|
|
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="comment">// Test with large max</span></div>
|
|
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>  <span class="keyword">auto</span> <span class="keyword">const</span> good = <a class="code" href="namespaceripple.html#ab2a02635f3d304617a7b59a60d13cc3b">getFileContents</a>(ec, path, <a class="code" href="namespaceripple.html#a8f7c1dac6a768426c7fc2bf4b544254a">kilobytes</a>(1));</div>
|
|
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span>  BEAST_EXPECT(!ec);</div>
|
|
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  BEAST_EXPECT(good == expectedContents);</div>
|
|
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  }</div>
|
|
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  </div>
|
|
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  {</div>
|
|
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="comment">// Test with small max</span></div>
|
|
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <span class="keyword">auto</span> <span class="keyword">const</span> bad = <a class="code" href="namespaceripple.html#ab2a02635f3d304617a7b59a60d13cc3b">getFileContents</a>(ec, path, 16);</div>
|
|
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  BEAST_EXPECT(ec && ec.value() ==</div>
|
|
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  boost::system::errc::file_too_large);</div>
|
|
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span>  BEAST_EXPECT(bad.empty());</div>
|
|
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  }</div>
|
|
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span>  </div>
|
|
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span>  }</div>
|
|
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  </div>
|
|
<div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="classripple_1_1FileUtilities__test.html#aa1b2698cec02912b9a7286f12a758bcf"> 71</a></span>  <span class="keywordtype">void</span> <a class="code" href="classripple_1_1FileUtilities__test.html#aa1b2698cec02912b9a7286f12a758bcf">run</a> ()<span class="keyword"> override</span></div>
|
|
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="keyword"> </span>{</div>
|
|
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <a class="code" href="classripple_1_1FileUtilities__test.html#a0e6c0183f7372518229a8904ccf05c7b">testGetFileContents</a>();</div>
|
|
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  }</div>
|
|
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> };</div>
|
|
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  </div>
|
|
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <a class="code" href="namespaceripple.html#a2701412a11b118c19256a4c901db2938">BEAST_DEFINE_TESTSUITE</a>(FileUtilities, ripple_basics, <a class="code" href="namespaceripple.html">ripple</a>);</div>
|
|
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  </div>
|
|
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> } <span class="comment">// ripple</span></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<div class="ttc" id="aclassripple_1_1FileUtilities__test_html_aa1b2698cec02912b9a7286f12a758bcf"><div class="ttname"><a href="classripple_1_1FileUtilities__test.html#aa1b2698cec02912b9a7286f12a758bcf">ripple::FileUtilities_test::run</a></div><div class="ttdeci">void run() override</div><div class="ttdef"><b>Definition:</b> <a href="FileUtilities__test_8cpp_source.html#l00071">FileUtilities_test.cpp:71</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a2701412a11b118c19256a4c901db2938"><div class="ttname"><a href="namespaceripple.html#a2701412a11b118c19256a4c901db2938">ripple::BEAST_DEFINE_TESTSUITE</a></div><div class="ttdeci">BEAST_DEFINE_TESTSUITE(AccountTxPaging, app, ripple)</div></div>
|
|
<div class="ttc" id="anamespaceripple_html_a8f7c1dac6a768426c7fc2bf4b544254a"><div class="ttname"><a href="namespaceripple.html#a8f7c1dac6a768426c7fc2bf4b544254a">ripple::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#l00026">ByteUtilities.h:26</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_1_1test_1_1detail_html"><div class="ttname"><a href="namespaceripple_1_1test_1_1detail.html">ripple::test::detail</a></div><div class="ttdef"><b>Definition:</b> <a href="Path__test_8cpp_source.html#l00045">Path_test.cpp:45</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1detail_1_1FileDirGuard_html_aa1aad19f81907987fee0d26cc0d4b8c1"><div class="ttname"><a href="classripple_1_1test_1_1detail_1_1FileDirGuard.html#aa1aad19f81907987fee0d26cc0d4b8c1">ripple::test::detail::FileDirGuard::file</a></div><div class="ttdeci">path const & file() const</div><div class="ttdef"><b>Definition:</b> <a href="FileDirGuard_8h_source.html#l00164">FileDirGuard.h:164</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ae18870f8d8eaa17b582f609cc486aa04"><div class="ttname"><a href="namespaceripple.html#ae18870f8d8eaa17b582f609cc486aa04">ripple::writeFileContents</a></div><div class="ttdeci">void writeFileContents(boost::system::error_code &ec, boost::filesystem::path const &destPath, std::string const &contents)</div><div class="ttdef"><b>Definition:</b> <a href="FileUtilities_8cpp_source.html#l00063">FileUtilities.cpp:63</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html_ab2a02635f3d304617a7b59a60d13cc3b"><div class="ttname"><a href="namespaceripple.html#ab2a02635f3d304617a7b59a60d13cc3b">ripple::getFileContents</a></div><div class="ttdeci">std::string getFileContents(boost::system::error_code &ec, boost::filesystem::path const &sourcePath, boost::optional< std::size_t > maxSize=boost::none)</div><div class="ttdef"><b>Definition:</b> <a href="FileUtilities_8cpp_source.html#l00025">FileUtilities.cpp:25</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1FileUtilities__test_html"><div class="ttname"><a href="classripple_1_1FileUtilities__test.html">ripple::FileUtilities_test</a></div><div class="ttdef"><b>Definition:</b> <a href="FileUtilities__test_8cpp_source.html#l00027">FileUtilities_test.cpp:27</a></div></div>
|
|
<div class="ttc" id="anamespaceripple_html"><div class="ttname"><a href="namespaceripple.html">ripple</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="RCLCensorshipDetector_8h_source.html#l00029">RCLCensorshipDetector.h:29</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1test_1_1detail_1_1FileDirGuard_html"><div class="ttname"><a href="classripple_1_1test_1_1detail_1_1FileDirGuard.html">ripple::test::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#l00110">FileDirGuard.h:110</a></div></div>
|
|
<div class="ttc" id="aclassripple_1_1FileUtilities__test_html_a0e6c0183f7372518229a8904ccf05c7b"><div class="ttname"><a href="classripple_1_1FileUtilities__test.html#a0e6c0183f7372518229a8904ccf05c7b">ripple::FileUtilities_test::testGetFileContents</a></div><div class="ttdeci">void testGetFileContents()</div><div class="ttdef"><b>Definition:</b> <a href="FileUtilities__test_8cpp_source.html#l00030">FileUtilities_test.cpp:30</a></div></div>
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.17
|
|
</small></address>
|
|
</body>
|
|
</html>
|