| <!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::DockerCompose 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_1DockerCompose.html">DockerCompose</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classiceberg_1_1DockerCompose-members.html">List of all members</a> </div> |
| <div class="headertitle"><div class="title">iceberg::DockerCompose Class Reference</div></div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Docker Compose orchestration utilities for integration testing. |
| <a href="classiceberg_1_1DockerCompose.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="docker__compose__util_8h_source.html">docker_compose_util.h</a>></code></p> |
| <table class="memberdecls"> |
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a> |
| Public Member Functions</h2></td></tr> |
| <tr class="memitem:a38d19fb8f11d6064dd98c233c7b93762" id="r_a38d19fb8f11d6064dd98c233c7b93762"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DockerCompose.html#a38d19fb8f11d6064dd98c233c7b93762">DockerCompose</a> (std::string <a class="el" href="classiceberg_1_1DockerCompose.html#aed38fc903de979c38e505223dafc01a0">project_name</a>, std::filesystem::path docker_compose_dir)</td></tr> |
| <tr class="memdesc:a38d19fb8f11d6064dd98c233c7b93762"><td class="mdescLeft"> </td><td class="mdescRight">Initializes the Docker Compose manager context. <br /></td></tr> |
| <tr class="separator:a38d19fb8f11d6064dd98c233c7b93762"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab31bec9f7106d1644a2274836eb42f0a" id="r_ab31bec9f7106d1644a2274836eb42f0a"><td class="memItemLeft" align="right" valign="top"><a id="ab31bec9f7106d1644a2274836eb42f0a" name="ab31bec9f7106d1644a2274836eb42f0a"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>DockerCompose</b> (const <a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> &)=delete</td></tr> |
| <tr class="separator:ab31bec9f7106d1644a2274836eb42f0a"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a10847a40a9264b8e644d68799bb80492" id="r_a10847a40a9264b8e644d68799bb80492"><td class="memItemLeft" align="right" valign="top"><a id="a10847a40a9264b8e644d68799bb80492" name="a10847a40a9264b8e644d68799bb80492"></a> |
| <a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> &)=delete</td></tr> |
| <tr class="separator:a10847a40a9264b8e644d68799bb80492"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab0db1a2ba72dea3b92a26c338be7e4eb" id="r_ab0db1a2ba72dea3b92a26c338be7e4eb"><td class="memItemLeft" align="right" valign="top"><a id="ab0db1a2ba72dea3b92a26c338be7e4eb" name="ab0db1a2ba72dea3b92a26c338be7e4eb"></a> |
|  </td><td class="memItemRight" valign="bottom"><b>DockerCompose</b> (<a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> &&)=default</td></tr> |
| <tr class="separator:ab0db1a2ba72dea3b92a26c338be7e4eb"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4bdb9cd3751ccf56fa19b58770f9039e" id="r_a4bdb9cd3751ccf56fa19b58770f9039e"><td class="memItemLeft" align="right" valign="top"><a id="a4bdb9cd3751ccf56fa19b58770f9039e" name="a4bdb9cd3751ccf56fa19b58770f9039e"></a> |
| <a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classiceberg_1_1DockerCompose.html">DockerCompose</a> &&)=default</td></tr> |
| <tr class="separator:a4bdb9cd3751ccf56fa19b58770f9039e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aed38fc903de979c38e505223dafc01a0" id="r_aed38fc903de979c38e505223dafc01a0"><td class="memItemLeft" align="right" valign="top"><a id="aed38fc903de979c38e505223dafc01a0" name="aed38fc903de979c38e505223dafc01a0"></a> |
| const std::string & </td><td class="memItemRight" valign="bottom"><b>project_name</b> () const</td></tr> |
| <tr class="memdesc:aed38fc903de979c38e505223dafc01a0"><td class="mdescLeft"> </td><td class="mdescRight">Get the docker project name. <br /></td></tr> |
| <tr class="separator:aed38fc903de979c38e505223dafc01a0"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:aa262dff63ebf0cb34cb3bb06d8719c58" id="r_aa262dff63ebf0cb34cb3bb06d8719c58"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DockerCompose.html#aa262dff63ebf0cb34cb3bb06d8719c58">Up</a> ()</td></tr> |
| <tr class="memdesc:aa262dff63ebf0cb34cb3bb06d8719c58"><td class="mdescLeft"> </td><td class="mdescRight">Executes 'docker-compose up' to start services. <br /></td></tr> |
| <tr class="separator:aa262dff63ebf0cb34cb3bb06d8719c58"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a31eac8071a558accac7ca8589b3c18e1" id="r_a31eac8071a558accac7ca8589b3c18e1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classiceberg_1_1DockerCompose.html#a31eac8071a558accac7ca8589b3c18e1">Down</a> ()</td></tr> |
| <tr class="memdesc:a31eac8071a558accac7ca8589b3c18e1"><td class="mdescLeft"> </td><td class="mdescRight">Executes 'docker-compose down' to stop and remove services. <br /></td></tr> |
| <tr class="separator:a31eac8071a558accac7ca8589b3c18e1"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Docker Compose orchestration utilities for integration testing. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a38d19fb8f11d6064dd98c233c7b93762" name="a38d19fb8f11d6064dd98c233c7b93762"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a38d19fb8f11d6064dd98c233c7b93762">◆ </a></span>DockerCompose()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">iceberg::DockerCompose::DockerCompose </td> |
| <td>(</td> |
| <td class="paramtype">std::string </td> |
| <td class="paramname"><em>project_name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">std::filesystem::path </td> |
| <td class="paramname"><em>docker_compose_dir</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</td> |
| <td></td><td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Initializes the Docker Compose manager context. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">project_name</td><td>A unique identifier for this project to ensure test isolation. </td></tr> |
| <tr><td class="paramname">docker_compose_dir</td><td>The directory path containing the target docker-compose.yml. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="a31eac8071a558accac7ca8589b3c18e1" name="a31eac8071a558accac7ca8589b3c18e1"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a31eac8071a558accac7ca8589b3c18e1">◆ </a></span>Down()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void iceberg::DockerCompose::Down </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Executes 'docker-compose down' to stop and remove services. </p> |
| <dl class="section note"><dt>Note</dt><dd>May throw an exception if the services fail to stop. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="aa262dff63ebf0cb34cb3bb06d8719c58" name="aa262dff63ebf0cb34cb3bb06d8719c58"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#aa262dff63ebf0cb34cb3bb06d8719c58">◆ </a></span>Up()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void iceberg::DockerCompose::Up </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Executes 'docker-compose up' to start services. </p> |
| <dl class="section note"><dt>Note</dt><dd>May throw an exception if the services fail to start. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li>iceberg/test/util/<a class="el" href="docker__compose__util_8h_source.html">docker_compose_util.h</a></li> |
| <li>iceberg/test/util/<b>docker_compose_util.cc</b></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> |
