<html>
<head>
<base href="https://wiki.asterisk.org/wiki">
<link rel="stylesheet" href="/wiki/s/en/2172/18/9/_/styles/combined.css?spaceKey=AST&forWysiwyg=true" type="text/css">
</head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
<h2><a href="https://wiki.asterisk.org/wiki/display/AST/Test+Configuration+2">Test Configuration 2</a></h2>
<h4>Page <b>added</b> by <a href="https://wiki.asterisk.org/wiki/display/~mjordan">Matt Jordan</a>
</h4>
<br/>
<div class="notificationGreySide">
<p>Every test has a <em>test-config.yaml</em> file that serves four purposes:</p>
<ul>
<li>It describes and documents the test</li>
<li>It determines what necessary attributes an installation of Asterisk must have in order to run the test</li>
<li>It determines what software must exist on a test system to run the test</li>
<li>It configures attributes of the test</li>
</ul>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/wiki/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>Some modules are configured via a test's <em>test-config.yaml</em> file. As those modules determine their own configuration, those configuration options are documented elsewhere.</td></tr></table></div>
<h2><a name="TestConfiguration2-Specification"></a>Specification</h2>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'>Keyword</th>
<th class='confluenceTh'>Description</th>
<th class='confluenceTh'>Required</th>
</tr>
<tr>
<td class='confluenceTd'> test-info </td>
<td class='confluenceTd'> Section that describes basic information about the test </td>
<td class='confluenceTd'> Yes </td>
</tr>
<tr>
<td class='confluenceTd'> properties </td>
<td class='confluenceTd'> Contains properties that define how the test executes </td>
<td class='confluenceTd'> Yes </td>
</tr>
<tr>
<td class='confluenceTd'> test-modules </td>
<td class='confluenceTd'> Modules to load for tests that use the Test Suite's pluggable framework </td>
<td class='confluenceTd'> No </td>
</tr>
</tbody></table>
</div>
<div class='panelMacro'><table class='noteMacro'><colgroup><col width='24'><col></colgroup><tr><td valign='top'><img src="/wiki/images/icons/emoticons/warning.gif" width="16" height="16" align="absmiddle" alt="" border="0"></td><td>If using the Test Suite's pluggable framework, the test-modules block is required.</td></tr></table></div>
<h3><a name="TestConfiguration2-testinfo"></a>test-info </h3>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'>Keyword</th>
<th class='confluenceTh'>Description</th>
<th class='confluenceTh'>Required</th>
</tr>
<tr>
<td class='confluenceTd'>summary</td>
<td class='confluenceTd'>A summary of what the test does</td>
<td class='confluenceTd'> Yes </td>
</tr>
<tr>
<td class='confluenceTd'>description</td>
<td class='confluenceTd'>A detailed description of what functionality is covered by the test </td>
<td class='confluenceTd'> Yes </td>
</tr>
<tr>
<td class='confluenceTd'>skip</td>
<td class='confluenceTd'>If true, skip execution of this test</td>
<td class='confluenceTd'>No</td>
</tr>
<tr>
<td class='confluenceTd'>issues</td>
<td class='confluenceTd'>A sequence of key/value pairs specifying issues in an issue tracker related to this test</td>
<td class='confluenceTd'>No</td>
</tr>
</tbody></table>
</div>
<h4><a name="TestConfiguration2-issues"></a>issues</h4>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'>Keyword</th>
<th class='confluenceTh'>Description</th>
<th class='confluenceTh'>Required</th>
</tr>
<tr>
<td class='confluenceTd'>mantis</td>
<td class='confluenceTd'>A mantis issue identifier</td>
<td class='confluenceTd'>No</td>
</tr>
<tr>
<td class='confluenceTd'>jira</td>
<td class='confluenceTd'>A JIRA issue identifier</td>
<td class='confluenceTd'>No</td>
</tr>
</tbody></table>
</div>
<h3><a name="TestConfiguration2-properties"></a>properties</h3>
<div class='table-wrap'>
<table class='confluenceTable'><tbody>
<tr>
<th class='confluenceTh'>Keyword</th>
<th class='confluenceTh'>Description</th>
<th class='confluenceTh'>Required</th>
</tr>
<tr>
<td class='confluenceTd'>minversion</td>
</tr>
<tr>
<td class='confluenceTd'>maxversion</td>
</tr>
<tr>
<td class='confluenceTd'>dependencies</td>
</tr>
<tr>
<td class='confluenceTd'>tags</td>
</tr>
</tbody></table>
</div>
<h3><a name="TestConfiguration2-testmodules"></a>test-modules</h3>
<h2><a name="TestConfiguration2-Examples"></a>Examples</h2>
</div>
<div id="commentsSection" class="wiki-content pageSection">
<div style="float: right;" class="grey">
<a href="https://wiki.asterisk.org/wiki/users/removespacenotification.action?spaceKey=AST">Stop watching space</a>
<span style="padding: 0px 5px;">|</span>
<a href="https://wiki.asterisk.org/wiki/users/editmyemailsettings.action">Change email notification preferences</a>
</div>
<a href="https://wiki.asterisk.org/wiki/display/AST/Test+Configuration+2">View Online</a>
|
<a href="https://wiki.asterisk.org/wiki/display/AST/Test+Configuration+2?showComments=true&showCommentArea=true#addcomment">Add Comment</a>
</div>
</div>
</div>
</div>
</div>
</body>
</html>