| <!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>iceberg-cpp: iceberg::TempFileTestBase Class Reference</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">iceberg-cpp |
| </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&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&dn=expat.txt MIT */ |
| $(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"> |
| <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"><b>iceberg</b></li><li class="navelem"><a class="el" href="classiceberg_1_1TempFileTestBase.html">TempFileTestBase</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pro-methods">Protected Member Functions</a> | |
| <a href="#pro-attribs">Protected Attributes</a> | |
| <a href="classiceberg_1_1TempFileTestBase-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::TempFileTestBase Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p><code>#include <<a class="el" href="temp__file__test__base_8h_source.html">temp_file_test_base.h</a>></code></p> |
| <div class="dynheader"> |
| Inheritance diagram for iceberg::TempFileTestBase:</div> |
| <div class="dyncontent"> |
| <div class="center"> |
| <img src="classiceberg_1_1TempFileTestBase.png" usemap="#iceberg::TempFileTestBase_map" alt=""/> |
| <map id="iceberg::TempFileTestBase_map" name="iceberg::TempFileTestBase_map"> |
| <area href="classiceberg_1_1FileScanTaskTest.html" alt="iceberg::FileScanTaskTest" shape="rect" coords="0,112,191,136"/> |
| <area href="classiceberg_1_1GZipTest.html" alt="iceberg::GZipTest" shape="rect" coords="201,112,392,136"/> |
| <area href="classiceberg_1_1LocalFileIOTest.html" alt="iceberg::LocalFileIOTest" shape="rect" coords="402,112,593,136"/> |
| <area href="classiceberg_1_1MetadataIOTest.html" alt="iceberg::MetadataIOTest" shape="rect" coords="603,112,794,136"/> |
| <area href="classiceberg_1_1avro_1_1AVROStreamTest.html" alt="iceberg::avro::AVROStreamTest" shape="rect" coords="804,112,995,136"/> |
| </map> |
| </div></div> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a> |
| Protected Member Functions</h2></td></tr> |
| <tr class="memitem:a7f0c73d82ad005a93c34fc4712db5120" id="r_a7f0c73d82ad005a93c34fc4712db5120"><td class="memItemLeft" align="right" valign="top"><a id="a7f0c73d82ad005a93c34fc4712db5120" name="a7f0c73d82ad005a93c34fc4712db5120"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>SetUp</b> () override</td></tr> |
| <tr class="separator:a7f0c73d82ad005a93c34fc4712db5120"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad0259e7197a5f7c88a6cd9688efe6b53" id="r_ad0259e7197a5f7c88a6cd9688efe6b53"><td class="memItemLeft" align="right" valign="top"><a id="ad0259e7197a5f7c88a6cd9688efe6b53" name="ad0259e7197a5f7c88a6cd9688efe6b53"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>TearDown</b> () override</td></tr> |
| <tr class="separator:ad0259e7197a5f7c88a6cd9688efe6b53"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac4a5a13677373ca5e40f5251f2fc16d5" id="r_ac4a5a13677373ca5e40f5251f2fc16d5"><td class="memItemLeft" align="right" valign="top"><a id="ac4a5a13677373ca5e40f5251f2fc16d5" name="ac4a5a13677373ca5e40f5251f2fc16d5"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>GenerateUniqueTempFilePath</b> () const</td></tr> |
| <tr class="memdesc:ac4a5a13677373ca5e40f5251f2fc16d5"><td class="mdescLeft"> </td><td class="mdescRight">Generates a unique temporary filepath that works across platforms. <br /></td></tr> |
| <tr class="separator:ac4a5a13677373ca5e40f5251f2fc16d5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a25203f87d8d23209c611949d95749559" id="r_a25203f87d8d23209c611949d95749559"><td class="memItemLeft" align="right" valign="top"><a id="a25203f87d8d23209c611949d95749559" name="a25203f87d8d23209c611949d95749559"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>GenerateUniqueTempFilePathWithSuffix</b> (const std::string &suffix)</td></tr> |
| <tr class="memdesc:a25203f87d8d23209c611949d95749559"><td class="mdescLeft"> </td><td class="mdescRight">Create a temporary filepath with the specified suffix/extension. <br /></td></tr> |
| <tr class="separator:a25203f87d8d23209c611949d95749559"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab8c455679ca860cf68d867b134fd6dbc" id="r_ab8c455679ca860cf68d867b134fd6dbc"><td class="memItemLeft" align="right" valign="top"><a id="ab8c455679ca860cf68d867b134fd6dbc" name="ab8c455679ca860cf68d867b134fd6dbc"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>GenerateRandomString</b> (size_t length) const</td></tr> |
| <tr class="memdesc:ab8c455679ca860cf68d867b134fd6dbc"><td class="mdescLeft"> </td><td class="mdescRight">Helper to generate a random alphanumeric string for unique filenames. <br /></td></tr> |
| <tr class="separator:ab8c455679ca860cf68d867b134fd6dbc"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac5dbf7b55b849f990733840057bd450f" id="r_ac5dbf7b55b849f990733840057bd450f"><td class="memItemLeft" align="right" valign="top"><a id="ac5dbf7b55b849f990733840057bd450f" name="ac5dbf7b55b849f990733840057bd450f"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>TestInfo</b> () const</td></tr> |
| <tr class="memdesc:ac5dbf7b55b849f990733840057bd450f"><td class="mdescLeft"> </td><td class="mdescRight">Get the test name for inclusion in the filename. <br /></td></tr> |
| <tr class="separator:ac5dbf7b55b849f990733840057bd450f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a469206ba6bfaea7b40483a594c819d8f" id="r_a469206ba6bfaea7b40483a594c819d8f"><td class="memItemLeft" align="right" valign="top"><a id="a469206ba6bfaea7b40483a594c819d8f" name="a469206ba6bfaea7b40483a594c819d8f"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>CreateNewTempFilePath</b> ()</td></tr> |
| <tr class="memdesc:a469206ba6bfaea7b40483a594c819d8f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new temporary filepath and registers it for cleanup. <br /></td></tr> |
| <tr class="separator:a469206ba6bfaea7b40483a594c819d8f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a79c5ec372d23b44b3b25f90faadafcdf" id="r_a79c5ec372d23b44b3b25f90faadafcdf"><td class="memItemLeft" align="right" valign="top"><a id="a79c5ec372d23b44b3b25f90faadafcdf" name="a79c5ec372d23b44b3b25f90faadafcdf"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>CreateNewTempFilePathWithSuffix</b> (const std::string &suffix)</td></tr> |
| <tr class="memdesc:a79c5ec372d23b44b3b25f90faadafcdf"><td class="mdescLeft"> </td><td class="mdescRight">Create a temporary filepath with the specified suffix and registers it for cleanup. <br /></td></tr> |
| <tr class="separator:a79c5ec372d23b44b3b25f90faadafcdf"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a78b1aeba8972a7b7a1efe8250fc275b9" id="r_a78b1aeba8972a7b7a1efe8250fc275b9"><td class="memItemLeft" align="right" valign="top"><a id="a78b1aeba8972a7b7a1efe8250fc275b9" name="a78b1aeba8972a7b7a1efe8250fc275b9"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>CreateTempDirectory</b> ()</td></tr> |
| <tr class="memdesc:a78b1aeba8972a7b7a1efe8250fc275b9"><td class="mdescLeft"> </td><td class="mdescRight">Creates a temporary directory and registers it for cleanup. <br /></td></tr> |
| <tr class="separator:a78b1aeba8972a7b7a1efe8250fc275b9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3ba86e7547c2ea06ac70f76e61040af5" id="r_a3ba86e7547c2ea06ac70f76e61040af5"><td class="memItemLeft" align="right" valign="top"><a id="a3ba86e7547c2ea06ac70f76e61040af5" name="a3ba86e7547c2ea06ac70f76e61040af5"></a> |
| void </td><td class="memItemRight" valign="bottom"><b>WriteContentToFile</b> (const std::string &path, const std::string &content)</td></tr> |
| <tr class="memdesc:a3ba86e7547c2ea06ac70f76e61040af5"><td class="mdescLeft"> </td><td class="mdescRight">Creates a file with the given content at the specified path. <br /></td></tr> |
| <tr class="separator:a3ba86e7547c2ea06ac70f76e61040af5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a0f94d0c787eed57fca2687c77f0873dd" id="r_a0f94d0c787eed57fca2687c77f0873dd"><td class="memItemLeft" align="right" valign="top"><a id="a0f94d0c787eed57fca2687c77f0873dd" name="a0f94d0c787eed57fca2687c77f0873dd"></a> |
| std::string </td><td class="memItemRight" valign="bottom"><b>CreateTempFileWithContent</b> (const std::string &content)</td></tr> |
| <tr class="memdesc:a0f94d0c787eed57fca2687c77f0873dd"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new temporary file with the given content. <br /></td></tr> |
| <tr class="separator:a0f94d0c787eed57fca2687c77f0873dd"><td class="memSeparator" colspan="2"> </td></tr> |
| </table><table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a> |
| Protected Attributes</h2></td></tr> |
| <tr class="memitem:a81e8f787019341a0f6e808b06944692c" id="r_a81e8f787019341a0f6e808b06944692c"><td class="memItemLeft" align="right" valign="top"><a id="a81e8f787019341a0f6e808b06944692c" name="a81e8f787019341a0f6e808b06944692c"></a> |
| std::vector< std::string > </td><td class="memItemRight" valign="bottom"><b>created_temp_files_</b></td></tr> |
| <tr class="separator:a81e8f787019341a0f6e808b06944692c"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>A base class for tests that need to create and manage temporary files. Provides utilities for creating platform-independent temporary files and ensures proper cleanup after tests run.</p> |
| <p>Usage Example: </p><div class="fragment"><div class="line"><span class="keyword">class </span>MyTest : <span class="keyword">public</span> test::TempFileTestBase {</div> |
| <div class="line"> <span class="keyword">protected</span>:</div> |
| <div class="line"> <span class="keywordtype">void</span> SetUp()<span class="keyword"> override </span>{</div> |
| <div class="line"> <span class="comment">// Always call base class SetUp first</span></div> |
| <div class="line"> TempFileTestBase::SetUp();</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// Create test resources</span></div> |
| <div class="line"> my_temp_file_ = CreateNewTempFilePath();</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// Additional setup...</span></div> |
| <div class="line"> }</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// Your test-specific members</span></div> |
| <div class="line"> std::string my_temp_file_;</div> |
| <div class="line">};</div> |
| <div class="line"> </div> |
| <div class="line">TEST_F(MyTest, ExampleTest) {</div> |
| <div class="line"> <span class="comment">// Use temporary files in your test</span></div> |
| <div class="line"> <a class="code hl_function" href="classiceberg_1_1TempFileTestBase.html#a3ba86e7547c2ea06ac70f76e61040af5">WriteContentToFile</a>(my_temp_file_, <span class="stringliteral">"test content"</span>);</div> |
| <div class="line"> </div> |
| <div class="line"> <span class="comment">// Files will be automatically cleaned up in TearDown</span></div> |
| <div class="line">}</div> |
| <div class="ttc" id="aclassiceberg_1_1TempFileTestBase_html_a3ba86e7547c2ea06ac70f76e61040af5"><div class="ttname"><a href="classiceberg_1_1TempFileTestBase.html#a3ba86e7547c2ea06ac70f76e61040af5">iceberg::TempFileTestBase::WriteContentToFile</a></div><div class="ttdeci">void WriteContentToFile(const std::string &path, const std::string &content)</div><div class="ttdoc">Creates a file with the given content at the specified path.</div><div class="ttdef"><b>Definition</b> temp_file_test_base.h:167</div></div> |
| </div><!-- fragment --><p>Notes:</p><ul> |
| <li>Always call TempFileTestBase::SetUp() in your derived class's SetUp()</li> |
| <li>All files created using the provided methods will be automatically cleaned up</li> |
| <li>You don't need to implement TearDown() unless you need additional cleanup </li> |
| </ul> |
| </div><hr/>The documentation for this class was generated from the following file:<ul> |
| <li>iceberg/test/<a class="el" href="temp__file__test__base_8h_source.html">temp_file_test_base.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by <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> |
