webgui/www/extras/yui/docs/TestCase.js.html
JT Smith 20f8df1291 upgrading to YUI 2.6
data tables are going to need some work yet, but the other stuff seems to be working 100%
2008-10-22 23:53:29 +00:00

310 lines
21 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<title>API: yuitest TestCase.js (YUI Library)</title>
<link rel="stylesheet" type="text/css" href="assets/api.css">
<script type="text/javascript" src="assets/api-js"></script>
<script type="text/javascript" src="assets/ac-js"></script>
</head>
<body id="yahoo-com">
<div id="doc3" class="yui-t2">
<div id="hd">
<a href="http://developer.yahoo.com/yui/"><h1>Yahoo! UI Library</h1></a>
<h3>yuitest&nbsp; <span class="subtitle">2.6.0</span></h3>
<p>
<a href="./index.html">Yahoo! UI Library</a>
&gt; <a href="./module_yuitest.html">yuitest</a>
&gt; TestCase.js (source view)
</p>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<form name="yui-classopts-form">
<span id="classopts"><input type="checkbox" name="showprivate" id="showprivate" /> <label for="showprivate">Show Private</label></span>
<span id="classopts"><input type="checkbox" name="showprotected" id="showprotected" /> <label for="showprotected">Show Protected</label></span>
<span id="classopts"><input type="checkbox" name="showdeprecated" id="showdeprecated" /> <label for="showdeprecated">Show Deprecated</label></span>
</form>
<div id="srcout">
<style>
#doc3 #classopts { display:none; }
</style>
<div class="highlight" ><pre><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">namespace</span><span class="o">(</span><span class="s2">&quot;tool&quot;</span><span class="o">);</span>
<span class="c">//-----------------------------------------------------------------------------</span>
<span class="c">// TestCase object</span>
<span class="c">//-----------------------------------------------------------------------------</span>
<span class="c"></span><span class="o">(</span><span class="k">function</span><span class="o">(){</span>
<span class="c">//used for autogenerating test case names</span>
<span class="c"></span> <span class="k">var</span> <span class="nx">tempId</span> <span class="o">=</span> <span class="m">0</span><span class="o">;</span>
<span class="c">/**</span>
<span class="c"> * Test case containing various tests to run.</span>
<span class="c"> * @param template An object containing any number of test methods, other methods,</span>
<span class="c"> * an optional name, and anything else the test case needs.</span>
<span class="c"> * @class TestCase</span>
<span class="c"> * @namespace YAHOO.tool</span>
<span class="c"> * @constructor</span>
<span class="c"> */</span>
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestCase</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">template</span> <span class="c">/*:Object*/</span><span class="o">)</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Special rules for the test case. Possible subobjects</span>
<span class="c"> * are fail, for tests that should fail, and error, for</span>
<span class="c"> * tests that should throw an error.</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">_should</span> <span class="c">/*:Object*/</span> <span class="o">=</span> <span class="o">{};</span>
<span class="c">//copy over all properties from the template to this object</span>
<span class="c"></span> <span class="k">for</span> <span class="o">(</span><span class="k">var</span> <span class="nx">prop</span> <span class="k">in</span> <span class="nx">template</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">[</span><span class="nx">prop</span><span class="o">]</span> <span class="o">=</span> <span class="nx">template</span><span class="o">[</span><span class="nx">prop</span><span class="o">];</span>
<span class="o">}</span>
<span class="c">//check for a valid name</span>
<span class="c"></span> <span class="k">if</span> <span class="o">(!</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">lang</span><span class="o">.</span><span class="nx">isString</span><span class="o">(</span><span class="k">this</span><span class="o">.</span><span class="nx">name</span><span class="o">)){</span>
<span class="c">/**</span>
<span class="c"> * Name for the test case.</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">name</span> <span class="c">/*:String*/</span> <span class="o">=</span> <span class="s2">&quot;testCase&quot;</span> <span class="o">+</span> <span class="o">(</span><span class="nx">tempId</span><span class="o">++);</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestCase</span><span class="o">.</span><span class="nx">prototype</span> <span class="o">=</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * Resumes a paused test and runs the given function.</span>
<span class="c"> * @param {Function} segment (Optional) The function to run.</span>
<span class="c"> * If omitted, the test automatically passes.</span>
<span class="c"> * @return {Void}</span>
<span class="c"> * @method resume</span>
<span class="c"> */</span>
<span class="nx">resume</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">segment</span> <span class="c">/*:Function*/</span><span class="o">)</span> <span class="c">/*:Void*/</span> <span class="o">{</span>
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestRunner</span><span class="o">.</span><span class="nx">resume</span><span class="o">(</span><span class="nx">segment</span><span class="o">);</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Causes the test case to wait a specified amount of time and then</span>
<span class="c"> * continue executing the given code.</span>
<span class="c"> * @param {Function} segment (Optional) The function to run after the delay.</span>
<span class="c"> * If omitted, the TestRunner will wait until resume() is called.</span>
<span class="c"> * @param {int} delay (Optional) The number of milliseconds to wait before running</span>
<span class="c"> * the function. If omitted, defaults to zero.</span>
<span class="c"> * @return {Void}</span>
<span class="c"> * @method wait</span>
<span class="c"> */</span>
<span class="nx">wait</span> <span class="o">:</span> <span class="k">function</span> <span class="o">(</span><span class="nx">segment</span> <span class="c">/*:Function*/</span><span class="o">,</span> <span class="nx">delay</span> <span class="c">/*:int*/</span><span class="o">)</span> <span class="c">/*:Void*/</span><span class="o">{</span>
<span class="k">var</span> <span class="nx">args</span> <span class="o">=</span> <span class="nx">arguments</span><span class="o">;</span>
<span class="k">if</span> <span class="o">(</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">lang</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">args</span><span class="o">[</span><span class="m">0</span><span class="o">])){</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestCase</span><span class="o">.</span><span class="nx">Wait</span><span class="o">(</span><span class="nx">args</span><span class="o">[</span><span class="m">0</span><span class="o">],</span> <span class="nx">args</span><span class="o">[</span><span class="m">1</span><span class="o">]);</span>
<span class="o">}</span> <span class="k">else</span> <span class="o">{</span>
<span class="k">throw</span> <span class="k">new</span> <span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestCase</span><span class="o">.</span><span class="nx">Wait</span><span class="o">(</span><span class="k">function</span><span class="o">(){</span>
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">util</span><span class="o">.</span><span class="nx">Assert</span><span class="o">.</span><span class="nx">fail</span><span class="o">(</span><span class="s2">&quot;Timeout: wait() called but resume() never called.&quot;</span><span class="o">);</span>
<span class="o">},</span> <span class="o">(</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">lang</span><span class="o">.</span><span class="nx">isNumber</span><span class="o">(</span><span class="nx">args</span><span class="o">[</span><span class="m">0</span><span class="o">])</span> <span class="o">?</span> <span class="nx">args</span><span class="o">[</span><span class="m">0</span><span class="o">]</span> <span class="o">:</span> <span class="m">10000</span><span class="o">));</span>
<span class="o">}</span>
<span class="o">},</span>
<span class="c">//-------------------------------------------------------------------------</span>
<span class="c"></span> <span class="c">// Stub Methods</span>
<span class="c"></span> <span class="c">//-------------------------------------------------------------------------</span>
<span class="c"></span>
<span class="c">/**</span>
<span class="c"> * Function to run before each test is executed.</span>
<span class="c"> * @return {Void}</span>
<span class="c"> * @method setUp</span>
<span class="c"> */</span>
<span class="nx">setUp</span> <span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="c">/*:Void*/</span> <span class="o">{</span>
<span class="o">},</span>
<span class="c">/**</span>
<span class="c"> * Function to run after each test is executed.</span>
<span class="c"> * @return {Void}</span>
<span class="c"> * @method tearDown</span>
<span class="c"> */</span>
<span class="nx">tearDown</span><span class="o">:</span> <span class="k">function</span> <span class="o">()</span> <span class="c">/*:Void*/</span> <span class="o">{</span>
<span class="o">}</span>
<span class="o">};</span>
<span class="c">/**</span>
<span class="c"> * Represents a stoppage in test execution to wait for an amount of time before</span>
<span class="c"> * continuing.</span>
<span class="c"> * @param {Function} segment A function to run when the wait is over.</span>
<span class="c"> * @param {int} delay The number of milliseconds to wait before running the code.</span>
<span class="c"> * @class Wait</span>
<span class="c"> * @namespace YAHOO.tool.TestCase</span>
<span class="c"> * @constructor</span>
<span class="c"> *</span>
<span class="c"> */</span>
<span class="nx">YAHOO</span><span class="o">.</span><span class="nx">tool</span><span class="o">.</span><span class="nx">TestCase</span><span class="o">.</span><span class="nx">Wait</span> <span class="o">=</span> <span class="k">function</span> <span class="o">(</span><span class="nx">segment</span> <span class="c">/*:Function*/</span><span class="o">,</span> <span class="nx">delay</span> <span class="c">/*:int*/</span><span class="o">)</span> <span class="o">{</span>
<span class="c">/**</span>
<span class="c"> * The segment of code to run when the wait is over.</span>
<span class="c"> * @type Function</span>
<span class="c"> * @property segment</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">segment</span> <span class="c">/*:Function*/</span> <span class="o">=</span> <span class="o">(</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">lang</span><span class="o">.</span><span class="nx">isFunction</span><span class="o">(</span><span class="nx">segment</span><span class="o">)</span> <span class="o">?</span> <span class="nx">segment</span> <span class="o">:</span> <span class="kc">null</span><span class="o">);</span>
<span class="c">/**</span>
<span class="c"> * The delay before running the segment of code.</span>
<span class="c"> * @type int</span>
<span class="c"> * @property delay</span>
<span class="c"> */</span>
<span class="k">this</span><span class="o">.</span><span class="nx">delay</span> <span class="c">/*:int*/</span> <span class="o">=</span> <span class="o">(</span><span class="nx">YAHOO</span><span class="o">.</span><span class="nx">lang</span><span class="o">.</span><span class="nx">isNumber</span><span class="o">(</span><span class="nx">delay</span><span class="o">)</span> <span class="o">?</span> <span class="nx">delay</span> <span class="o">:</span> <span class="m">0</span><span class="o">);</span>
<span class="o">};</span>
<span class="o">})();</span>
</pre></div>
</div>
</div>
</div>
<div class="yui-b">
<div class="nav">
<div class="module">
<h4>Modules</h4>
<ul class="content">
<li class=""><a href="module_animation.html">animation</a></li>
<li class=""><a href="module_autocomplete.html">autocomplete</a></li>
<li class=""><a href="module_button.html">button</a></li>
<li class=""><a href="module_calendar.html">calendar</a></li>
<li class=""><a href="module_carousel.html">carousel</a></li>
<li class=""><a href="module_charts.html">charts</a></li>
<li class=""><a href="module_colorpicker.html">colorpicker</a></li>
<li class=""><a href="module_connection.html">connection</a></li>
<li class=""><a href="module_container.html">container</a></li>
<li class=""><a href="module_cookie.html">cookie</a></li>
<li class=""><a href="module_datasource.html">datasource</a></li>
<li class=""><a href="module_datatable.html">datatable</a></li>
<li class=""><a href="module_dom.html">dom</a></li>
<li class=""><a href="module_dragdrop.html">dragdrop</a></li>
<li class=""><a href="module_editor.html">editor</a></li>
<li class=""><a href="module_element.html">element</a></li>
<li class=""><a href="module_event.html">event</a></li>
<li class=""><a href="module_get.html">get</a></li>
<li class=""><a href="module_history.html">history</a></li>
<li class=""><a href="module_imagecropper.html">imagecropper</a></li>
<li class=""><a href="module_imageloader.html">imageloader</a></li>
<li class=""><a href="module_json.html">json</a></li>
<li class=""><a href="module_layout.html">layout</a></li>
<li class=""><a href="module_logger.html">logger</a></li>
<li class=""><a href="module_menu.html">menu</a></li>
<li class=""><a href="module_paginator.html">paginator</a></li>
<li class=""><a href="module_profiler.html">profiler</a></li>
<li class=""><a href="module_profilerviewer.html">profilerviewer</a></li>
<li class=""><a href="module_resize.html">resize</a></li>
<li class=""><a href="module_selector.html">selector</a></li>
<li class=""><a href="module_slider.html">slider</a></li>
<li class=""><a href="module_tabview.html">tabview</a></li>
<li class=""><a href="module_treeview.html">treeview</a></li>
<li class=""><a href="module_uploader.html">uploader</a></li>
<li class=""><a href="module_yahoo.html">yahoo</a></li>
<li class=""><a href="module_yuiloader.html">yuiloader</a></li>
<li class="selected"><a href="module_yuitest.html">yuitest</a></li>
</ul>
</div>
<div class="module">
<h4>Classes</h4>
<ul class="content">
<li class=""><a href="YAHOO.tool.TestCase.html">YAHOO.tool.TestCase</a></li>
<li class=""><a href="YAHOO.tool.TestCase.Wait.html">YAHOO.tool.TestCase.Wait</a></li>
<li class=""><a href="YAHOO.tool.TestLogger.html">YAHOO.tool.TestLogger</a></li>
<li class=""><a href="YAHOO.tool.TestManager.html">YAHOO.tool.TestManager</a></li>
<li class=""><a href="YAHOO.tool.TestNode.html">YAHOO.tool.TestNode</a></li>
<li class=""><a href="YAHOO.tool.TestReporter.html">YAHOO.tool.TestReporter</a></li>
<li class=""><a href="YAHOO.tool.TestRunner.html">YAHOO.tool.TestRunner</a></li>
<li class=""><a href="YAHOO.tool.TestSuite.html">YAHOO.tool.TestSuite</a></li>
<li class=""><a href="YAHOO.util.ArrayAssert.html">YAHOO.util.ArrayAssert</a></li>
<li class=""><a href="YAHOO.util.Assert.html">YAHOO.util.Assert</a></li>
<li class=""><a href="YAHOO.util.AssertionError.html">YAHOO.util.AssertionError</a></li>
<li class=""><a href="YAHOO.util.ComparisonFailure.html">YAHOO.util.ComparisonFailure</a></li>
<li class=""><a href="YAHOO.util.DateAssert.html">YAHOO.util.DateAssert</a></li>
<li class=""><a href="YAHOO.util.ObjectAssert.html">YAHOO.util.ObjectAssert</a></li>
<li class=""><a href="YAHOO.util.ShouldError.html">YAHOO.util.ShouldError</a></li>
<li class=""><a href="YAHOO.util.ShouldFail.html">YAHOO.util.ShouldFail</a></li>
<li class=""><a href="YAHOO.util.UnexpectedError.html">YAHOO.util.UnexpectedError</a></li>
<li class=""><a href="YAHOO.util.UnexpectedValue.html">YAHOO.util.UnexpectedValue</a></li>
<li class=""><a href="YAHOO.util.UserAction.html">YAHOO.util.UserAction</a></li>
</ul>
</div>
<div class="module">
<h4>Files</h4>
<ul class="content">
<li class=""><a href="ArrayAssert.js.html">ArrayAssert.js</a></li>
<li class=""><a href="Assert.js.html">Assert.js</a></li>
<li class=""><a href="DateAssert.js.html">DateAssert.js</a></li>
<li class=""><a href="ObjectAssert.js.html">ObjectAssert.js</a></li>
<li class="selected"><a href="TestCase.js.html">TestCase.js</a></li>
<li class=""><a href="TestFormat.js.html">TestFormat.js</a></li>
<li class=""><a href="TestLogger.js.html">TestLogger.js</a></li>
<li class=""><a href="TestManager.js.html">TestManager.js</a></li>
<li class=""><a href="TestReporter.js.html">TestReporter.js</a></li>
<li class=""><a href="TestRunner.js.html">TestRunner.js</a></li>
<li class=""><a href="TestSuite.js.html">TestSuite.js</a></li>
<li class=""><a href="UserAction.js.html">UserAction.js</a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="ft">
<hr />
Copyright &copy; 2008 Yahoo! Inc. All rights reserved.
</div>
</div>
</body>
</html>