semtest
Version:
NodeJs Unit test framework combining Tape, Proxyquire and Sinon
371 lines (108 loc) • 4.62 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: Library/Test-Helpers</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: Library/Test-Helpers</h1>
<section>
<header>
</header>
<article>
<div class="container-overview">
<div class="description"><h3>Test helpers</h3><p>This module hosts everything needed for tests.
Abstraction over the expection engine, abstraction over the basic functions,
this module is the Test toolbelt.
Little to no test framework logic should be in unit tests to keep them
focused on code documentation.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".executeTestsInternal"><span class="type-signature">(static) </span>executeTestsInternal<span class="signature">(testEngine, moduleName, functionBlocks)</span><span class="type-signature"> → {Void}</span></h4>
<div class="description">
<p>Execute all given tests, each with a concatenated description.
Descriptions will be concatenated to form an assertion statement that will
have this structure:
"Module - Function(): [When XXXXXXXXX,] it should YYYYYYYYY"
("When" can be omitted for assertions that are always true, thus the
brackets notation)</p>
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>testEngine</code></td>
<td class="type">
<span class="param-type">function</span>
</td>
<td class="description last"><p>Test engine</p></td>
</tr>
<tr>
<td class="name"><code>moduleName</code></td>
<td class="type">
<span class="param-type">String</span>
</td>
<td class="description last"><p>Tested module description</p></td>
</tr>
<tr>
<td class="name"><code>functionBlocks</code></td>
<td class="type">
<span class="param-type">Array.<Object></span>
</td>
<td class="description last"><p>Function blocks</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="main.js.html">main.js</a>, <a href="main.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<div class="param-desc">
<p>Nothing</p>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Void</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Library_Test-Helpers.html">Library/Test-Helpers</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Tue Jan 03 2017 10:34:18 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>