blob: db9875c9b41c0e9d60f4deb36a79d6e155e90012 [file] [log] [blame]
<!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/test/util/cmd_util.h 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">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&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_f51fe74ea6bc2b1b900619895eaa63be.html">iceberg</a></li><li class="navelem"><a class="el" href="dir_0154c816bded9243a1feaa2fbd30be18.html">test</a></li><li class="navelem"><a class="el" href="dir_09bdfe9e42f60af879c56fb7d3d12e52.html">util</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle"><div class="title">cmd_util.h</div></div>
</div><!--header-->
<div class="contents">
<a href="cmd__util_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/*</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * distributed with this work for additional information</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> * &quot;License&quot;); you may not use this file except in compliance</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"> * with the License. You may obtain a copy of the License at</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> *</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> *</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> * Unless required by applicable law or agreed to in writing,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"> * software distributed under the License is distributed on an</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> * &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> * KIND, either express or implied. See the License for the</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment"> * specific language governing permissions and limitations</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="comment"> * under the License.</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="comment"> */</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><span class="preprocessor">#pragma once</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><span class="preprocessor">#include &lt;filesystem&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#include &lt;map&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include &lt;string&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#include &lt;vector&gt;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> </div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span><span class="keyword">namespace </span>iceberg {</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> </div>
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="classiceberg_1_1Command.html"> 33</a></span><span class="keyword">class </span><a class="code hl_class" href="classiceberg_1_1Command.html">Command</a> {</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">public</span>:</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">explicit</span> <a class="code hl_class" href="classiceberg_1_1Command.html">Command</a>(std::string program);</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> </div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> <a class="code hl_class" href="classiceberg_1_1Command.html">Command</a>&amp; <a class="code hl_function" href="classiceberg_1_1Command.html#a3cf5de84ee7f3247db5401cf9f3040de">Arg</a>(std::string arg);</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> <a class="code hl_class" href="classiceberg_1_1Command.html">Command</a>&amp; <a class="code hl_function" href="classiceberg_1_1Command.html#a3ce3c9edf5ef6f03acfe4920c4895aab">Args</a>(<span class="keyword">const</span> std::vector&lt;std::string&gt;&amp; args);</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> </div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> <a class="code hl_class" href="classiceberg_1_1Command.html">Command</a>&amp; <a class="code hl_function" href="classiceberg_1_1Command.html#ae3e1ec5384671a0bcfb0cf2cb3596056">CurrentDir</a>(<span class="keyword">const</span> std::filesystem::path&amp; path);</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> <a class="code hl_class" href="classiceberg_1_1Command.html">Command</a>&amp; <a class="code hl_function" href="classiceberg_1_1Command.html#a4f7da9f4b7a0a2d7c4e30b0fcc0510fc">Env</a>(<span class="keyword">const</span> std::string&amp; key, <span class="keyword">const</span> std::string&amp; val);</div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">void</span> <a class="code hl_function" href="classiceberg_1_1Command.html#a852fb0a2dc8e3b040d2edd5490cbf5f6">RunCommand</a>(<span class="keyword">const</span> std::string&amp; desc) <span class="keyword">const</span>;</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span> <span class="keyword">private</span>:</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> std::string program_;</div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> std::vector&lt;std::string&gt; args_;</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> std::filesystem::path cwd_;</div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span> std::map&lt;std::string, std::string&gt; env_vars_;</div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span> std::string FormatArgs() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"> 61</span>};</div>
</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span>} <span class="comment">// namespace iceberg</span></div>
<div class="ttc" id="aclassiceberg_1_1Command_html"><div class="ttname"><a href="classiceberg_1_1Command.html">iceberg::Command</a></div><div class="ttdoc">A shell command builder and executor for tests.</div><div class="ttdef"><b>Definition</b> cmd_util.h:33</div></div>
<div class="ttc" id="aclassiceberg_1_1Command_html_a3ce3c9edf5ef6f03acfe4920c4895aab"><div class="ttname"><a href="classiceberg_1_1Command.html#a3ce3c9edf5ef6f03acfe4920c4895aab">iceberg::Command::Args</a></div><div class="ttdeci">Command &amp; Args(const std::vector&lt; std::string &gt; &amp;args)</div><div class="ttdoc">Add multiple arguments at once.</div><div class="ttdef"><b>Definition</b> cmd_util.cc:42</div></div>
<div class="ttc" id="aclassiceberg_1_1Command_html_a3cf5de84ee7f3247db5401cf9f3040de"><div class="ttname"><a href="classiceberg_1_1Command.html#a3cf5de84ee7f3247db5401cf9f3040de">iceberg::Command::Arg</a></div><div class="ttdeci">Command &amp; Arg(std::string arg)</div><div class="ttdoc">Add a single argument.</div><div class="ttdef"><b>Definition</b> cmd_util.cc:37</div></div>
<div class="ttc" id="aclassiceberg_1_1Command_html_a4f7da9f4b7a0a2d7c4e30b0fcc0510fc"><div class="ttname"><a href="classiceberg_1_1Command.html#a4f7da9f4b7a0a2d7c4e30b0fcc0510fc">iceberg::Command::Env</a></div><div class="ttdeci">Command &amp; Env(const std::string &amp;key, const std::string &amp;val)</div><div class="ttdoc">Set an environment variable for the command.</div><div class="ttdef"><b>Definition</b> cmd_util.cc:52</div></div>
<div class="ttc" id="aclassiceberg_1_1Command_html_a852fb0a2dc8e3b040d2edd5490cbf5f6"><div class="ttname"><a href="classiceberg_1_1Command.html#a852fb0a2dc8e3b040d2edd5490cbf5f6">iceberg::Command::RunCommand</a></div><div class="ttdeci">void RunCommand(const std::string &amp;desc) const</div><div class="ttdoc">Execute the command and print logs.</div><div class="ttdef"><b>Definition</b> cmd_util.cc:57</div></div>
<div class="ttc" id="aclassiceberg_1_1Command_html_ae3e1ec5384671a0bcfb0cf2cb3596056"><div class="ttname"><a href="classiceberg_1_1Command.html#ae3e1ec5384671a0bcfb0cf2cb3596056">iceberg::Command::CurrentDir</a></div><div class="ttdeci">Command &amp; CurrentDir(const std::filesystem::path &amp;path)</div><div class="ttdoc">Set the current working directory for the command.</div><div class="ttdef"><b>Definition</b> cmd_util.cc:47</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>