1
0
Fork 0
mirror of https://github.com/ganelson/inform.git synced 2024-07-08 18:14:21 +03:00
inform7/docs/inter/1-ut.html
2019-07-24 20:29:29 +01:00

117 lines
14 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>1/mn</title>
<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>
<!--Weave of '1/ut' generated by 7-->
<ul class="crumbs"><li><a href="../webs.html">&#9733;</a></li><li><a href="index.html">inter 1</a></li><li><a href="index.html#1">Chapter 1: Everything</a></li><li><b>Unit Tests</b></li></ul><p class="purpose">Scaffolding code to run unit tests not otherwise represented as inter stages.</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">UnitTests::run</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">Inter::Tree::new</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">Inter::Bookmarks::at_start_of_this_repository</span><span class="plain">(</span><span class="identifier">dummy</span><span class="plain">);</span>
<span class="functiontext">Primitives::emit</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">Streams::enable_debugging</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="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="element">.test_input</span><span class="plain"> = </span><span class="functiontext">Str::new</span><span class="plain">();</span>
<span class="functiontext">TextFiles::read</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">UnitTests::test_harvester</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">Streams::disable_debugging</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="endnote">The function UnitTests::run is used in 1/mn (<a href="1-mn.html#SP4">&#167;4</a>).</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">UnitTests::test_harvester</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">Str::eq</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">-</span><span class="element">&gt;to_perform</span><span class="plain"> = </span><span class="constant">SCHEMA_IUT</span><span class="plain">;</span>
<span class="functiontext">Str::clear</span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-</span><span class="element">&gt;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">Str::eq</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">-</span><span class="element">&gt;to_perform</span><span class="plain"> = </span><span class="constant">SCHEMA_WORKINGS_IUT</span><span class="plain">;</span>
<span class="functiontext">Str::clear</span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-</span><span class="element">&gt;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">Str::eq</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">-</span><span class="element">&gt;to_perform</span><span class="plain">) {</span>
<span class="reserved">case</span><span class="plain"> </span><span class="constant">SCHEMA_WORKINGS_IUT</span><span class="plain">:</span>
<span class="functiontext">Log::set_aspect</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">Log::set_aspect</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="constant">SCHEMA_IUT</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="reserved">break</span><span class="plain">;</span>
<span class="reserved">default</span><span class="plain">: </span><span class="functiontext">Errors::in_text_file</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">-</span><span class="element">&gt;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">-</span><span class="element">&gt;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">Str::len</span><span class="plain">(</span><span class="identifier">text</span><span class="plain">) == 0) </span><span class="reserved">return</span><span class="plain">;</span>
<span class="functiontext">Errors::in_text_file</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">-</span><span class="element">&gt;test_input</span><span class="plain">, </span><span class="string">"%S\</span><span class="plain">n</span><span class="string">"</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 function UnitTests::test_harvester is used in <a href="#SP1">&#167;1</a>.</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:\</span><span class="plain">n</span><span class="string">%S\</span><span class="plain">n</span><span class="string">"</span><span class="plain">, </span><span class="identifier">iut</span><span class="plain">-</span><span class="element">&gt;test_input</span><span class="plain">);</span>
<span class="functiontext">Str::trim_white_space</span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-</span><span class="element">&gt;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">InterSchemas::from_text</span><span class="plain">(</span><span class="identifier">iut</span><span class="plain">-</span><span class="element">&gt;test_input</span><span class="plain">, </span><span class="constant">FALSE</span><span class="plain">, 0, </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;\</span><span class="plain">n</span><span class="string">"</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">-</span><span class="element">&gt;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\</span><span class="plain">n</span><span class="string">"</span><span class="plain">);</span>
<span class="reserved">else</span><span class="plain"> </span><span class="functiontext">InterSchemas::log</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">"=========\</span><span class="plain">n</span><span class="string">"</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-mn.html">Back to 'Main'</a></li><li><i>(This section ends Chapter 1: Everything.)</i></li></ul><hr class="tocbar">
<!--End of weave-->
</body>
</html>