continuable/group___testing.html
2018-03-17 13:27:07 +01:00

312 lines
22 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-115514125-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-115514125-1');
</script>
<meta charset="UTF-8" />
<title>Testing module | Continuable</title>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,400i,600,600i%7CSource+Code+Pro:400,400i,600" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
<link rel="stylesheet" href="m-dark+doxygen.compiled.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
<link rel="stylesheet" href="base.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
<link rel="stylesheet" href="terminal.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
<link rel="stylesheet" href="atom-one-dark.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"/>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<meta name="theme-color" content="#23373B" />
</head>
<body>
<header><nav id="navigation">
<div class="m-container">
<div class="m-row">
<a href="index.html" id="m-navbar-brand" class="m-col-t-8 m-col-m-none m-left-m">Continuable <span class="m-thin">3.0.0</span></a>
<div class="m-col-t-4 m-hide-m m-text-right m-nopadr">
<a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg viewBox="0 0 16 16">
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
</svg></a>
<a id="m-navbar-show" href="#navigation" title="Show navigation"></a>
<a id="m-navbar-hide" href="#" title="Hide navigation"></a>
</div>
<div id="m-navbar-collapse" class="m-col-t-12 m-show-m m-col-m-none m-right-m">
<div class="m-row">
<ol class="m-col-t-6 m-col-m-none">
<li>
<a href="tutorial.html">Tutorial</a>
<ol>
<li><a href="tutorial-creating-continuables.html">Creating continuables</a></li>
<li><a href="tutorial-chaining-continuables.html">Chaining continuables</a></li>
<li><a href="tutorial-connecting-continuables.html">Connecting continuables</a></li>
<li><a href="tutorial-transforming-continuables.html">Transforming continuables</a></li>
<li><a href="tutorial-awaiting-continuables.html">Awaiting continuables</a></li>
<li><a href="tutorial-promisify-continuables.html">Promisify functions</a></li>
</ol>
</li>
<li>
<a href="pages.html">Pages</a>
<ol>
<li><a href="installation.html">Installation</a></li>
<li><a href="tutorial.html">Tutorial</a></li>
<li><a href="configuration.html">Configuration</a></li>
<li><a href="changelog.html">Changelog</a></li>
</ol>
</li>
<li>
<a href="modules.html">Modules</a>
<ol>
<li><a href="group___base.html">Base</a></li>
<li><a href="group___connections.html">Connections</a></li>
<li><a href="group___promisify.html">Promisify</a></li>
<li><a href="group___testing.html" id="m-navbar-current">Testing</a></li>
<li><a href="group___types.html">Types</a></li>
<li><a href="group___transforms.html">Transforms</a></li>
<li><a href="group___traversal.html">Traversal</a></li>
</ol>
</li>
</ol>
<ol class="m-col-t-6 m-col-m-none" start="4">
<li>
<a href="namespacecti.html">cti</a>
<ol>
<li><a href="namespacecti_1_1transforms.html">cti::transforms</a></li>
<li><a href="classcti_1_1continuable__base.html">cti::continuable_base</a></li>
<li><a href="classcti_1_1promise__base.html">cti::promise_base</a></li>
</ol>
</li>
<li class="m-show-m"><a href="#search" class="m-dox-search-icon" title="Search" onclick="return showSearch()"><svg viewBox="0 0 16 16">
<path d="m6 0c-3.3144 0-6 2.6856-6 6 0 3.3144 2.6856 6 6 6 1.4858 0 2.8463-0.54083 3.8945-1.4355-0.0164 0.33797 0.14734 0.75854 0.5 1.1504l3.2227 3.7891c0.55185 0.6139 1.4517 0.66544 2.002 0.11524 0.55022-0.55022 0.49866-1.4501-0.11524-2.002l-3.7891-3.2246c-0.39184-0.35266-0.81242-0.51469-1.1504-0.5 0.89472-1.0482 1.4355-2.4088 1.4355-3.8945 0-3.3128-2.6856-5.998-6-5.998zm0 1.5625a4.4375 4.4375 0 0 1 4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375 4.4375 4.4375 4.4375 0 0 1-4.4375-4.4375 4.4375 4.4375 0 0 1 4.4375-4.4375z"/>
</svg> Search</a></li>
</ol>
<ol class="m-col-t-6 m-col-m-none">
<li>
<a href="https://github.com/Naios/continuable" aria-label="View source on Github"><i class="fa fa-github"></i> Code</a>
</li>
</ol>
</div>
</div>
</div>
</div>
</nav></header>
<main><article>
<div class="m-container m-container-inflatable">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<h1>
Testing <span class="m-thin">module</span></h1>
<p>provides macro shortcuts for testing asynchronous continuations through GTest.</p>
<div class="m-block m-default">
<h3>Contents</h3>
<ul>
<li>
Reference
<ul>
<li><a href="#defines">Defines</a></li>
</ul>
</li>
</ul>
</div>
<section id="define-members">
<h2><a href="#define-members">Defines</a></h3>
<dl class="m-dox">
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga19705a633c93b9df4df17aa612138475" class="m-dox">ASSERT_ASYNC_COMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</dt>
<dd>Asserts that the final callback of the given continuable was called with any result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga83a8a6551404b672fed165166b0528c4" class="m-dox">ASSERT_ASYNC_EXCEPTION_COMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</dt>
<dd>Asserts that the final callback of the given continuable was called with any exceptional result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#gaa89eda3eb76b7604d75d1928e51e00b4" class="m-dox">ASSERT_ASYNC_INCOMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</dt>
<dd>Asserts that the final callback of the given continuable is never called with any result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#gadc19a4b21ca4f61f61c6c031dd57d822" class="m-dox-self" name="gadc19a4b21ca4f61f61c6c031dd57d822">ASSERT_ASYNC_VALIDATION</a>(</span><span class="m-dox-wrap">CONTINUABLE,
VALIDATOR)</span>
</dt>
<dd>Expects the continuation to be called and forwards it&#x27;s arguments to the given validator which can then do assertions on the result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#gaf8390b0c3997a58f77ec852c1121341e" class="m-dox">ASSERT_ASYNC_BINARY_VALIDATION</a>(</span><span class="m-dox-wrap">VALIDATOR,
...)</span>
</dt>
<dd>Asserts that the continuation was called and forwards it&#x27;s arguments to the given validator which can then do assertions on the result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#gaea321a35e497cff7f897482cb95f0d47" class="m-dox">ASSERT_ASYNC_BINARY_EXCEPTION_VALIDATION</a>(</span><span class="m-dox-wrap">VALIDATOR,
...)</span>
</dt>
<dd>Asserts that the continuation was resolved through an error and forwards it&#x27;s error result to the given validator which can then do assertions on the error result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga1c28bfaf6b8246a96ebe44020771c059" class="m-dox">EXPECT_ASYNC_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</dt>
<dd>Expects that the continuable is finished with the given result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga98e249af2f132d3f30c63ed4ca8d0452" class="m-dox">EXPECT_ASYNC_EXCEPTION_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</dt>
<dd>Asserts that the continuable is finished with the given exception.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga0e66f753c9c0a3ef7c4b2313d5feef90" class="m-dox">ASSERT_ASYNC_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</dt>
<dd>Asserts that the continuable is finished with the given result.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#gafb7fdd53d1d70f518386fdda37dce87b" class="m-dox">ASSERT_ASYNC_TYPES</a>(</span><span class="m-dox-wrap">CONTINUABLE,
...)</span>
</dt>
<dd>Asserts that the continuable is finished with the given type of arguments without validating it against equality.</dd>
<dt>
<span class="m-dox-wrap-bumper">#define <a href="#ga913e34a5390c17cf27eb34674e5c6417" class="m-dox">ASSERT_ASYNC_EXCEPTION_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</dt>
<dd>Asserts that the continuable is finished with the given exception.</dd>
</dl>
</section>
<section>
<h2>Define documentation</h2>
<section class="m-dox-details" id="ga19705a633c93b9df4df17aa612138475"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga19705a633c93b9df4df17aa612138475" class="m-dox-self">ASSERT_ASYNC_COMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</h3>
<p>Asserts that the final callback of the given continuable was called with any result.</p>
<aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="ga83a8a6551404b672fed165166b0528c4"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga83a8a6551404b672fed165166b0528c4" class="m-dox-self">ASSERT_ASYNC_EXCEPTION_COMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</h3>
<p>Asserts that the final callback of the given continuable was called with any exceptional result.</p>
<aside class="m-note m-default"><h4>Since</h4><p>2.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="gaa89eda3eb76b7604d75d1928e51e00b4"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#gaa89eda3eb76b7604d75d1928e51e00b4" class="m-dox-self">ASSERT_ASYNC_INCOMPLETION</a>(</span><span class="m-dox-wrap">CONTINUABLE)</span>
</h3>
<p>Asserts that the final callback of the given continuable is never called with any result.</p>
<aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="gaf8390b0c3997a58f77ec852c1121341e"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#gaf8390b0c3997a58f77ec852c1121341e" class="m-dox-self">ASSERT_ASYNC_BINARY_VALIDATION</a>(</span><span class="m-dox-wrap">VALIDATOR,
...)</span>
</h3>
<p>Asserts that the continuation was called and forwards it&#x27;s arguments to the given validator which can then do assertions on the result.</p>
<p>A validator consists of a binary consumer with a signature as in in the example shown below:</p><pre class="m-code"><span class="k">auto</span> <span class="n">validator</span> <span class="o">=</span> <span class="p">[](</span><span class="k">auto</span> <span class="n">expected</span><span class="p">,</span> <span class="k">auto</span> <span class="n">actual</span><span class="p">)</span> <span class="p">{</span>
<span class="n">EXPECT_EQ</span><span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="n">actual</span><span class="p">);</span>
<span class="p">};</span></pre><p>The macro is usable as shown in the following example:</p><pre class="m-code"><span class="n">continuable</span><span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span> <span class="n">async_get</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">);</span>
<span class="c1">// ...</span>
<span class="k">auto</span> <span class="n">validator</span> <span class="o">=</span> <span class="p">[](</span><span class="k">auto</span> <span class="n">expected</span><span class="p">,</span> <span class="k">auto</span> <span class="n">actual</span><span class="p">)</span> <span class="p">{</span>
<span class="n">EXPECT_EQ</span><span class="p">(</span><span class="n">expected</span><span class="p">,</span> <span class="n">actual</span><span class="p">);</span>
<span class="p">};</span>
<span class="n">ASSERT_ASYNC_BINARY_VALIDATION</span><span class="p">(</span><span class="n">validator</span><span class="p">,</span> <span class="n">async_get</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">),</span> <span class="s">&quot;hello&quot;</span><span class="p">)</span></pre><p>The validator is called for every expecting and actual result.</p><aside class="m-note m-info"><h4>Note</h4><p>This macro is mainly present for building other assertions relying on custom validation logic.</p></aside><aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="gaea321a35e497cff7f897482cb95f0d47"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#gaea321a35e497cff7f897482cb95f0d47" class="m-dox-self">ASSERT_ASYNC_BINARY_EXCEPTION_VALIDATION</a>(</span><span class="m-dox-wrap">VALIDATOR,
...)</span>
</h3>
<p>Asserts that the continuation was resolved through an error and forwards it&#x27;s error result to the given validator which can then do assertions on the error result.</p>
<aside class="m-note m-info"><h4>Note</h4><p>This macro is mainly present for building other assertions relying on custom validation logic.</p></aside><aside class="m-note m-default"><h4>Since</h4><p>2.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="ga1c28bfaf6b8246a96ebe44020771c059"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga1c28bfaf6b8246a96ebe44020771c059" class="m-dox-self">EXPECT_ASYNC_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</h3>
<p>Expects that the continuable is finished with the given result.</p>
<pre class="m-code"><span class="n">continuable</span><span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span> <span class="n">async_get</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">);</span>
<span class="c1">// ...</span>
<span class="n">EXPECT_ASYNC_RESULT</span><span class="p">(</span><span class="n">async_get</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">),</span> <span class="s">&quot;hello&quot;</span><span class="p">);</span></pre><aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="ga98e249af2f132d3f30c63ed4ca8d0452"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga98e249af2f132d3f30c63ed4ca8d0452" class="m-dox-self">EXPECT_ASYNC_EXCEPTION_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</h3>
<p>Asserts that the continuable is finished with the given exception.</p>
<aside class="m-note m-default"><h4>Since</h4><p>2.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="ga0e66f753c9c0a3ef7c4b2313d5feef90"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga0e66f753c9c0a3ef7c4b2313d5feef90" class="m-dox-self">ASSERT_ASYNC_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</h3>
<p>Asserts that the continuable is finished with the given result.</p>
<pre class="m-code"><span class="n">continuable</span><span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span> <span class="n">async_get</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">);</span>
<span class="c1">// ...</span>
<span class="n">ASSERT_ASYNC_RESULT</span><span class="p">(</span><span class="n">async_get</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">),</span> <span class="s">&quot;hello&quot;</span><span class="p">);</span></pre><aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="gafb7fdd53d1d70f518386fdda37dce87b"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#gafb7fdd53d1d70f518386fdda37dce87b" class="m-dox-self">ASSERT_ASYNC_TYPES</a>(</span><span class="m-dox-wrap">CONTINUABLE,
...)</span>
</h3>
<p>Asserts that the continuable is finished with the given type of arguments without validating it against equality.</p>
<pre class="m-code"><span class="n">continuable</span><span class="o">&lt;</span><span class="n">string</span><span class="o">&gt;</span> <span class="n">async_get</span><span class="p">(</span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">);</span>
<span class="c1">// ...</span>
<span class="n">ASSERT_ASYNC_TYPES</span><span class="p">(</span><span class="n">async_get</span><span class="p">(</span><span class="s">&quot;hello&quot;</span><span class="p">),</span> <span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="p">);</span></pre><aside class="m-note m-info"><h4>Note</h4><p>This is a compile-time assertion.</p></aside><aside class="m-note m-default"><h4>Since</h4><p>1.0.0</p></aside>
</div></section>
<section class="m-dox-details" id="ga913e34a5390c17cf27eb34674e5c6417"><div>
<h3>
<span class="m-dox-wrap-bumper">#define <a href="#ga913e34a5390c17cf27eb34674e5c6417" class="m-dox-self">ASSERT_ASYNC_EXCEPTION_RESULT</a>(</span><span class="m-dox-wrap">...)</span>
</h3>
<p>Asserts that the continuable is finished with the given exception.</p>
<aside class="m-note m-default"><h4>Since</h4><p>2.0.0</p></aside>
</div></section>
</section>
</div>
</div>
</div>
</article></main>
<div class="m-dox-search" id="search">
<a href="#!" onclick="return hideSearch()"></a>
<div class="m-container">
<div class="m-row">
<div class="m-col-m-8 m-push-m-2">
<div class="m-dox-search-header m-text m-small">
<div><span class="m-label m-default">Tab</span> / <span class="m-label m-default">T</span> to search, <span class="m-label m-default">Esc</span> to close</div>
<div id="search-symbolcount">&hellip;</div>
</div>
<div class="m-dox-search-content">
<input type="search" id="search-input" placeholder="Loading &hellip;" disabled="disabled" autofocus="autofocus" />
<noscript class="m-text m-danger m-text-center">Unlike everything else in the docs, the search functionality <em>requires</em> JavaScript.</noscript>
<div id="search-help" class="m-text m-dim m-text-center">
Search for symbols, directories, files, pages or modules. You can omit any
prefix from the symbol or file path; adding a <code>:</code> or <code>/</code>
suffix lists all members of given symbol or directory. Navigate through the
list using <span class="m-label m-dim">&darr;</span> and
<span class="m-label m-dim">&uarr;</span>, press
<span class="m-label m-dim">Enter</span> to go.
</div>
<div id="search-notfound" class="m-text m-warning m-text-center">Sorry, nothing was found.</div>
<ul id="search-results"></ul>
</div>
</div>
</div>
</div>
</div>
<script src="search.js"></script>
<script src="searchdata.js" async="async"></script>
<footer><nav>
<div class="m-container">
<div class="m-row">
<div class="m-col-l-10 m-push-l-1">
<b><a href="https://github.com/Naios/continuable">continuable</a></b> - C++14 allocation aware futures</br>Copyright 2015&ndash;2018 <a href="https://github.com/Naios">Denis Blank</a>. Contact the author via <a href="mailto:denis.blank@outlook.com">e-mail</a>.</br>Powered by <a href="http://doxygen.org/">Doxygen</a> and <a href="http://mcss.mosra.cz/">m.css</a>
</div>
</div>
</div>
</nav></footer>
</body>
</html>