1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-09 02:24:21 +03:00
inform7/docs/building-test/1-ut.html
Graham Nelson 1268a0f40e Colonised
2020-04-14 17:56:54 +01:00

145 lines
16 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>Unit Tests</title>
<meta name="viewport" content="width=device-width initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta http-equiv="Content-Language" content="en-gb">
<link href="../inweb.css" rel="stylesheet" rev="stylesheet" type="text/css">
</head>
<body>
<nav role="navigation">
<h1><a href="../index.html">
<img src="../docs-src/Figures/Inform.png" height=72">
</a></h1>
<ul><li><a href="../compiler.html">compiler tools</a></li>
<li><a href="../other.html">other tools</a></li>
<li><a href="../extensions.html">extensions and kits</a></li>
<li><a href="../units.html">unit test tools</a></li>
</ul><h2>Unit Test Tools</h2><ul>
<li><a href="../arch-test/index.html">arch-test</a></li>
<li><a href="index.html"><span class="selectedlink">building-test</span></a></li>
<li><a href="../inflections-test/index.html">inflections-test</a></li>
<li><a href="../linguistics-test/index.html">linguistics-test</a></li>
<li><a href="../problems-test/index.html">problems-test</a></li>
<li><a href="../syntax-test/index.html">syntax-test</a></li>
<li><a href="../words-test/index.html">words-test</a></li>
</ul><h2>Foundation</h2><ul>
<li><a href="../../../inweb/docs/foundation-test/index.html">foundation-test</a></li>
</ul>
</nav>
<main role="main">
<!--Weave of 'Unit Tests' generated by 7-->
<ul class="crumbs"><li><a href="../index.html">Home</a></li><li><a href="../units.html">Unit Test Tools</a></li><li><a href="index.html">building-test</a></li><li><a href="index.html#1">Chapter 1: Scaffolding</a></li><li><b>Unit Tests</b></li></ul><p class="purpose">How we shall test it.</p>
<p class="inwebparagraph"><a id="SP1"></a><b>&#167;1. </b></p>
<pre class="display">
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Unit::run<button class="popup" onclick="togglePopup('usagePopup2')">...<span class="popuptext" id="usagePopup2">Usage of <b>Unit::run</b>:<br>Program Control - <a href="1-pc.html#SP3">&#167;3</a></span></button></span><span class="plain">(</span><span class="reserved">filename</span><span class="plain"> *</span><span class="identifier">F</span><span class="plain">) {</span>
<span class="reserved">inter_tree</span><span class="plain"> *</span><span class="identifier">dummy</span><span class="plain"> = </span><span class="functiontext"><a href="2-it.html#SP2">Inter::Tree::new</a></span><span class="plain">();</span>
<span class="reserved">inter_bookmark</span><span class="plain"> </span><span class="identifier">IBM</span><span class="plain"> = </span><span class="functiontext"><a href="2-bkm.html#SP1">Inter::Bookmarks::at_start_of_this_repository</a></span><span class="plain">(</span><span class="identifier">dummy</span><span class="plain">);</span>
<span class="functiontext"><a href="1-ip.html#SP1">Primitives::emit</a></span><span class="plain">(</span><span class="identifier">dummy</span><span class="plain">, &amp;</span><span class="identifier">IBM</span><span class="plain">);</span>
<span class="functiontext"><a href="2-str.html#SP20">Streams::enable_debugging</a></span><span class="plain">(</span><span class="constant">STDOUT</span><span class="plain">);</span>
<span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">FORMER_DL</span><span class="plain"> = </span><span class="identifier">DL</span><span class="plain">;</span>
<span class="identifier">DL</span><span class="plain"> = </span><span class="constant">STDOUT</span><span class="plain">;</span>
<span class="reserved">inter_unit_test</span><span class="plain"> </span><span class="identifier">iut</span><span class="plain">;</span>
<span class="identifier">iut</span><span class="plain">.</span><span class="element">to_perform</span><span class="plain"> = </span><span class="constant">NO_IUT</span><span class="plain">;</span>
<span class="identifier">iut</span><span class="plain">.</span><span class="element">test_input</span><span class="plain"> = </span><span class="functiontext"><a href="4-sm.html#SP2">Str::new</a></span><span class="plain">();</span>
<span class="functiontext"><a href="4-tf.html#SP5">TextFiles::read</a></span><span class="plain">(</span><span class="identifier">F</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="string">"unable to read tests file"</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">,</span>
<span class="plain">&amp;</span><span class="functiontext"><a href="#SP2">Unit::test_harvester</a></span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">, &amp;</span><span class="identifier">iut</span><span class="plain">);</span>
<span class="functiontext"><a href="2-str.html#SP20">Streams::disable_debugging</a></span><span class="plain">(</span><span class="constant">STDOUT</span><span class="plain">);</span>
<span class="identifier">DL</span><span class="plain"> = </span><span class="identifier">FORMER_DL</span><span class="plain">;</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="inwebparagraph"><a id="SP2"></a><b>&#167;2. </b></p>
<pre class="definitions">
<span class="definitionkeyword">enum</span> <span class="constant">NO_IUT</span><span class="definitionkeyword"> from </span><span class="constant">0</span>
<span class="definitionkeyword">enum</span> <span class="constant">SCHEMA_IUT</span>
<span class="definitionkeyword">enum</span> <span class="constant">SCHEMA_WORKINGS_IUT</span>
</pre>
<pre class="display">
<span class="reserved">typedef</span><span class="plain"> </span><span class="reserved">struct</span><span class="plain"> </span><span class="reserved">inter_unit_test</span><span class="plain"> {</span>
<span class="reserved">int</span><span class="plain"> </span><span class="identifier">to_perform</span><span class="plain">;</span>
<span class="reserved">struct</span><span class="plain"> </span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">test_input</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">inter_unit_test</span><span class="plain">;</span>
<span class="reserved">void</span><span class="plain"> </span><span class="functiontext">Unit::test_harvester<button class="popup" onclick="togglePopup('usagePopup3')">...<span class="popuptext" id="usagePopup3">Usage of <b>Unit::test_harvester</b>:<br><a href="#SP1">&#167;1</a></span></button></span><span class="plain">(</span><span class="reserved">text_stream</span><span class="plain"> *</span><span class="identifier">text</span><span class="plain">, </span><span class="reserved">text_file_position</span><span class="plain"> *</span><span class="identifier">tfp</span><span class="plain">, </span><span class="reserved">void</span><span class="plain"> *</span><span class="identifier">v_iut</span><span class="plain">) {</span>
<span class="reserved">inter_unit_test</span><span class="plain"> *</span><span class="identifier">iut</span><span class="plain"> = (</span><span class="reserved">inter_unit_test</span><span class="plain"> *) </span><span class="identifier">v_iut</span><span class="plain">;</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"schema"</span><span class="plain">)) {</span>
<span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">to_perform</span><span class="plain"> = </span><span class="constant">SCHEMA_IUT</span><span class="plain">;</span>
<span class="functiontext"><a href="4-sm.html#SP15">Str::clear</a></span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"schema-workings"</span><span class="plain">)) {</span>
<span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">to_perform</span><span class="plain"> = </span><span class="constant">SCHEMA_WORKINGS_IUT</span><span class="plain">;</span>
<span class="functiontext"><a href="4-sm.html#SP15">Str::clear</a></span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="4-sm.html#SP18">Str::eq</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">, </span><span class="identifier">I</span><span class="string">"end"</span><span class="plain">)) {</span>
<span class="reserved">switch</span><span class="plain"> (</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">to_perform</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SCHEMA_WORKINGS_IUT:</span>
<span class="functiontext"><a href="2-dl.html#SP7">Log::set_aspect</a></span><span class="plain">(</span><span class="constant">SCHEMA_COMPILATION_DETAILS_DA</span><span class="plain">, </span><span class="constant">TRUE</span><span class="plain">);</span>
&lt;<span class="cwebmacro">Perform the schema test</span> <span class="cwebmacronumber">2.1</span>&gt;<span class="plain">;</span>
<span class="functiontext"><a href="2-dl.html#SP7">Log::set_aspect</a></span><span class="plain">(</span><span class="constant">SCHEMA_COMPILATION_DETAILS_DA</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">);</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="reserved">case</span><span class="plain"> </span><span class="identifier">SCHEMA_IUT:</span>
&lt;<span class="cwebmacro">Perform the schema test</span> <span class="cwebmacronumber">2.1</span>&gt;<span class="plain">;</span>
<span class="reserved">break</span><span class="plain">;</span>
<span class="identifier">default:</span><span class="plain"> </span><span class="functiontext"><a href="3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"unimplemented test"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">); </span><span class="reserved">break</span><span class="plain">;</span>
<span class="plain">}</span>
<span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">to_perform</span><span class="plain"> = </span><span class="constant">NO_IUT</span><span class="plain">;</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">to_perform</span><span class="plain"> == </span><span class="constant">NO_IUT</span><span class="plain">) {</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="functiontext"><a href="4-sm.html#SP8">Str::len</a></span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == </span><span class="constant">0</span><span class="plain">) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="functiontext"><a href="3-em.html#SP5">Errors::in_text_file</a></span><span class="plain">(</span><span class="string">"content outside of test"</span><span class="plain">, </span><span class="identifier">tfp</span><span class="plain">);</span>
<span class="plain">} </span><span class="reserved">else</span><span class="plain"> {</span>
<span class="identifier">WRITE_TO</span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">, </span><span class="string">"%S\n"</span><span class="plain">, </span><span class="identifier">text</span><span class="plain">);</span>
<span class="plain">}</span>
<span class="plain">}</span>
<span class="plain">}</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">The structure inter_unit_test is private to this section.</p>
<p class="inwebparagraph"><a id="SP2_1"></a><b>&#167;2.1. </b><code class="display">
&lt;<span class="cwebmacrodefn">Perform the schema test</span> <span class="cwebmacronumber">2.1</span>&gt; =
</code></p>
<pre class="displaydefn">
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"Test: parse schema from:\n%S\n"</span><span class="plain">, </span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">);</span>
<span class="functiontext"><a href="4-sm.html#SP23">Str::trim_white_space</a></span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">);</span>
<span class="reserved">inter_schema</span><span class="plain"> *</span><span class="identifier">sch</span><span class="plain"> = </span><span class="functiontext"><a href="2-is.html#SP20">InterSchemas::from_text</a></span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-&gt;</span><span class="element">test_input</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, </span><span class="constant">0</span><span class="plain">, </span><span class="identifier">NULL</span><span class="plain">);</span>
<span class="reserved">if</span><span class="plain"> (</span><span class="identifier">sch</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">LOG</span><span class="plain">(</span><span class="string">"&lt;null schema&gt;\n"</span><span class="plain">);</span>
<span class="reserved">else</span><span class="plain"> </span><span class="reserved">if</span><span class="plain"> (</span><span class="identifier">sch</span><span class="plain">-&gt;</span><span class="element">node_tree</span><span class="plain"> == </span><span class="identifier">NULL</span><span class="plain">) </span><span class="identifier">LOG</span><span class="plain">(</span><span class="string">"&lt;nodeless scheme\n"</span><span class="plain">);</span>
<span class="reserved">else</span><span class="plain"> </span><span class="functiontext"><a href="2-is.html#SP16">InterSchemas::log</a></span><span class="plain">(</span><span class="identifier">DL</span><span class="plain">, </span><span class="identifier">sch</span><span class="plain">);</span>
<span class="identifier">LOG</span><span class="plain">(</span><span class="string">"=========\n"</span><span class="plain">);</span>
</pre>
<p class="inwebparagraph"></p>
<p class="endnote">This code is used in <a href="#SP2">&#167;2</a> (twice).</p>
<hr class="tocbar">
<ul class="toc"><li><a href="1-pc.html">Back to 'Program Control'</a></li><li><i>(This section ends Chapter 1: Scaffolding.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
<script>
function togglePopup(material_id) {
var popup = document.getElementById(material_id);
popup.classList.toggle("show");
}
</script>
<link href="Popups.css" rel="stylesheet" rev="stylesheet" type="text/css">
</main>
</body>
</html>