|
1 |
|
2 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd"> |
|
3 <html> |
|
4 <head> |
|
5 <title>YUI Library Examples: Test: Asynchronous Testing</title> |
|
6 <meta http-equiv="content-type" content="text/html; charset=utf-8"> |
|
7 <link rel="stylesheet" type="text/css" href="../../assets/yui.css" > |
|
8 |
|
9 <style> |
|
10 /*Supplemental CSS for the YUI distribution*/ |
|
11 #custom-doc { width: 95%; min-width: 950px; } |
|
12 #pagetitle {background-image: url(../../assets/bg_hd.gif);} |
|
13 /* #pagetitle h1 {background-image: url(../../assets/title_h_bg.gif);}*/ |
|
14 </style> |
|
15 |
|
16 <link rel="stylesheet" type="text/css" href="../../assets/dpSyntaxHighlighter.css"> |
|
17 |
|
18 <!--there is no custom header content for this example--> |
|
19 |
|
20 <link type="text/css" rel="stylesheet" href="../../build/cssfonts/fonts-min.css" /> |
|
21 <script type="text/javascript" src="../../build/yui/yui-min.js"></script> |
|
22 |
|
23 </head> |
|
24 <body id="yahoo-com" class=" yui-skin-sam"> |
|
25 <div id="custom-doc" class="yui-t2"> |
|
26 <div id="hd"> |
|
27 <div id="ygunav"> |
|
28 <p> |
|
29 <em> |
|
30 <a href="http://developer.yahoo.com/yui/3/">YUI 3.x Home</a> <i> - </i> |
|
31 </em> |
|
32 </p> |
|
33 <form action="http://search.yahoo.com/search" id="sitesearchform"> |
|
34 <input name="vs" type="hidden" value="developer.yahoo.com"> |
|
35 <input name="vs" type="hidden" value="yuiblog.com"> |
|
36 <div id="sitesearch"> |
|
37 <label for="searchinput">Site Search (YDN & YUIBlog): </label> |
|
38 <input type="text" id="searchinput" name="p"> |
|
39 <input type="submit" value="Search" id="searchsubmit" class="ygbt"> |
|
40 </div> |
|
41 </form> |
|
42 </div> |
|
43 <div id="ygma"><a href="../../"><img src="../../assets/logo.gif" border="0" width="200" height="93"></a></div> |
|
44 <div id="pagetitle"><h1>YUI Library Examples: Test: Asynchronous Testing</h1></div> |
|
45 </div> |
|
46 <div id="bd"> |
|
47 |
|
48 <div id="bar-note"><p><strong>Note:</strong> This is YUI 3.x. Looking for <a href="http://developer.yahoo.com/yui/">YUI 2.x</a>?</p></div> |
|
49 |
|
50 <div id="yui-main"> |
|
51 <div class="yui-b"> |
|
52 <div class="yui-ge"> |
|
53 <div class="yui-u first example" id="main"> |
|
54 |
|
55 <h2>Test: Asynchronous Testing</h2> |
|
56 |
|
57 <div id="example" class="promo"> |
|
58 <p> |
|
59 <p>This example shows how to create an asynchronous test with the YUI Test framework for testing browser-based JavaScript code. |
|
60 A <code>Y.Test.Case</code> object is created with a test that waits for a |
|
61 few seconds before continuing. The <code>Y.Test.Runner</code> |
|
62 is then used to run the tests once the page has loaded.</p> </p> |
|
63 |
|
64 <div class="module example-container "> |
|
65 <div class="hd exampleHd"> |
|
66 <p class="newWindowButton yui-skin-sam"> |
|
67 <a href="test-async-test_clean.html" target="_blank">View example in new window.</a> |
|
68 </p> |
|
69 </div> <div id="example-canvas" class="bd"> |
|
70 |
|
71 |
|
72 <!--BEGIN SOURCE CODE FOR EXAMPLE =============================== --> |
|
73 |
|
74 <div id="testLogger"></div> |
|
75 <script type="text/javascript"> |
|
76 YUI({base:"../../build/", timeout: 10000}).use("node", "console", "test",function (Y) { |
|
77 |
|
78 Y.namespace("example.test"); |
|
79 |
|
80 Y.example.test.AsyncTestCase = new Y.Test.Case({ |
|
81 |
|
82 //name of the test case - if not provided, one is auto-generated |
|
83 name : "Asynchronous Tests", |
|
84 |
|
85 //--------------------------------------------------------------------- |
|
86 // setUp and tearDown methods - optional |
|
87 //--------------------------------------------------------------------- |
|
88 |
|
89 /* |
|
90 * Sets up data that is needed by each test. |
|
91 */ |
|
92 setUp : function () { |
|
93 this.data = { |
|
94 name: "test", |
|
95 year: 2007, |
|
96 beta: true |
|
97 }; |
|
98 }, |
|
99 |
|
100 /* |
|
101 * Cleans up everything that was created by setUp(). |
|
102 */ |
|
103 tearDown : function () { |
|
104 delete this.data; |
|
105 }, |
|
106 |
|
107 //--------------------------------------------------------------------- |
|
108 // Test methods - names must begin with "test" |
|
109 //--------------------------------------------------------------------- |
|
110 |
|
111 testWait : function (){ |
|
112 var Assert = Y.Assert; |
|
113 |
|
114 //do some assertions now |
|
115 Assert.isTrue(this.data.beta); |
|
116 Assert.isNumber(this.data.year); |
|
117 |
|
118 //wait five seconds and do some more |
|
119 this.wait(function(){ |
|
120 |
|
121 Assert.isString(this.data.name); |
|
122 |
|
123 }, 5000); |
|
124 |
|
125 } |
|
126 |
|
127 }); |
|
128 |
|
129 //create the console |
|
130 var r = new Y.Console({ |
|
131 verbose : true, |
|
132 newestOnTop : false |
|
133 }); |
|
134 |
|
135 r.render('#testLogger'); |
|
136 |
|
137 Y.Test.Runner.add(Y.example.test.AsyncTestCase); |
|
138 |
|
139 //run the tests |
|
140 Y.Test.Runner.run(); |
|
141 }); |
|
142 |
|
143 </script> |
|
144 <!--END SOURCE CODE FOR EXAMPLE =============================== --> |
|
145 |
|
146 |
|
147 </div> |
|
148 </div> |
|
149 </div> |
|
150 |
|
151 <h2 class="first">Asynchronous Test Example</h2> |
|
152 |
|
153 <p>This example begins by creating a namespace:</p> |
|
154 <textarea name="code" class="JScript" cols="60" rows="1"> |
|
155 Y.namespace("example.test"); |
|
156 </textarea> |
|
157 <p>This namespace serves as the core object upon which others will be added (to prevent creating global objects).</p> |
|
158 |
|
159 <h3>Creating the TestCase</h3> |
|
160 |
|
161 <p>The first step is to create a new <code>Y.Test.Case</code> object called <code>AsyncTestCase</code>. |
|
162 To do so, using the <code>Y.Test.Case</code> constructor and pass in an object literal containing information about the tests to be run:</p> |
|
163 <textarea name="code" class="JScript" cols="60" rows="1"> |
|
164 Y.example.test.AsyncTestCase = new Y.Test.Case({ |
|
165 |
|
166 //name of the test case - if not provided, one is auto-generated |
|
167 name : "Asynchronous Tests", |
|
168 |
|
169 //--------------------------------------------------------------------- |
|
170 // setUp and tearDown methods - optional |
|
171 //--------------------------------------------------------------------- |
|
172 |
|
173 /* |
|
174 * Sets up data that is needed by each test. |
|
175 */ |
|
176 setUp : function () { |
|
177 this.data = { |
|
178 name: "test", |
|
179 year: 2007, |
|
180 beta: true |
|
181 }; |
|
182 }, |
|
183 |
|
184 /* |
|
185 * Cleans up everything that was created by setUp(). |
|
186 */ |
|
187 tearDown : function () { |
|
188 delete this.data; |
|
189 }, |
|
190 |
|
191 //--------------------------------------------------------------------- |
|
192 // Test methods - names must begin with "test" |
|
193 //--------------------------------------------------------------------- |
|
194 |
|
195 testWait : function (){ |
|
196 var Assert = Y.Assert; |
|
197 |
|
198 //do some assertions now |
|
199 Assert.isTrue(this.data.beta); |
|
200 Assert.isNumber(this.data.year); |
|
201 |
|
202 //wait five seconds and do some more |
|
203 this.wait(function(){ |
|
204 |
|
205 Assert.isString(this.data.name); |
|
206 |
|
207 }, 5000); |
|
208 |
|
209 } |
|
210 |
|
211 }); |
|
212 </textarea> |
|
213 <p>The object literal passed into the constructor contains two different sections. The first section contains the <code>name</code> property, |
|
214 which is used to determine which <code>Y.Test.Case</code> is being executed. A name is necessary, so one is generated if it isn't specified.</p> |
|
215 <p>Next, the <code>setUp()</code> and <code>tearDown()</code> methods are included. The <code>setUp()</code> method is used in a <code>Y.Test.Case</code> |
|
216 to set up data that may be needed for tests to be completed. This method is called immediately before each test is executed. For this example, |
|
217 <code>setUp()</code> creates a data object. The <code>tearDown()</code> is responsible for undoing what was done in <code>setUp()</code>. It is |
|
218 run immediately after each test is run and, in this case, deletes the data object that was created by <code>setUp</code>. These methods are optional.</p> |
|
219 <p>The second section contains the actual tests to be run. The only test is <code>testWait()</code>, which demonstrates using |
|
220 the <code>wait()</code> method to delay test execution. There are two arguments passed in: a function to run once the test resumes |
|
221 and the number of milliseconds to wait before running this function (same basic format as <code>setTimeout()</code>). When |
|
222 the test resumes, the function is executed in the context of the <code>Y.Test.Case</code> object, meaning that it still has |
|
223 access to all of the same data as the test that called <code>wait()</code>, including properties and methods on the <code>Y.Test.Case</code> |
|
224 itself. This example shows the anonymous function using both the <code>Y.Assert</code> object and the <code>data</code> property |
|
225 of the <code>Y.Test.Case</code>.</p> |
|
226 |
|
227 <h3>Running the tests</h3> |
|
228 |
|
229 <p>With all of the tests defined, the last step is to run them:</p> |
|
230 |
|
231 <textarea name="code" class="JScript" cols="60" rows="1"> |
|
232 //create the console |
|
233 var r = new Y.Console({ |
|
234 verbose : true, |
|
235 newestOnTop : false |
|
236 }); |
|
237 |
|
238 r.render('#testLogger'); |
|
239 |
|
240 //add the test suite to the runner's queue |
|
241 Y.Test.Runner.add(Y.example.test.AsyncTestCase); |
|
242 |
|
243 //run the tests |
|
244 Y.Test.Runner.run(); |
|
245 </textarea> |
|
246 |
|
247 <p>Before running the tests, it's necessary to create a <code>Y.Console</code> object to display the results (otherwise the tests would run |
|
248 but you wouldn't see the results). After that, the <code>Y.Test.Runner</code> is loaded with the <code>Y.Test.Case</code> object by calling |
|
249 <code>add()</code> (any number of <code>Y.Test.Case</code> and <code>TestSuite</code> objects can be added to a <code>TestRunner</code>, |
|
250 this example only adds one for simplicity). The very last step is to call <code>run()</code>, which begins executing the tests in its |
|
251 queue and displays the results in the <code>Y.Console</code>.</p> </div> |
|
252 <div class="yui-u sidebar"> |
|
253 |
|
254 |
|
255 <div id="examples" class="mod box4"> |
|
256 <div class="hd"> |
|
257 <h4> |
|
258 Test Examples:</h4> |
|
259 </div> |
|
260 <div class="bd"> |
|
261 <ul> |
|
262 <li><a href='../test/test-simple-example.html'>Simple Testing Example</a></li><li><a href='../test/test-advanced-test-options.html'>Advanced Test Options</a></li><li><a href='../test/test-array-tests.html'>Array Processing</a></li><li class='selected'><a href='../test/test-async-test.html'>Asynchronous Testing</a></li><li><a href='../test/test-async-event-tests.html'>Asynchronous Event Testing</a></li> </ul> |
|
263 </div> |
|
264 </div> |
|
265 |
|
266 <div class="mod box4"> |
|
267 <div class="hd"> |
|
268 <h4>More Test Resources:</h4> |
|
269 </div> |
|
270 <div class="bd"> |
|
271 <ul> |
|
272 <!-- <li><a href="http://developer.yahoo.com/yui/test/">User's Guide</a> (external)</li> --> |
|
273 <li><a href="../../api/module_test.html">API Documentation</a></li> |
|
274 </ul> |
|
275 </div> |
|
276 </div> |
|
277 </div> |
|
278 </div> |
|
279 |
|
280 </div> |
|
281 </div> |
|
282 |
|
283 |
|
284 <div class="yui-b toc3" id="tocWrapper"> |
|
285 <!-- TABLE OF CONTENTS --> |
|
286 <div id="toc"> |
|
287 |
|
288 <ul> |
|
289 <li class="sect first">YUI 3.x Project</li><li class="item"><a title="The Yahoo! User Interface (YUI) Library, 3.x Branch, " href="http://developer.yahoo.com/yui/3/">YUI 3 Web Site (external)</a></li><li class="item"><a title="Examples of every YUI utility and control in action" href="../../examples/">YUI 3 Examples</a></li><li class="item"><a title="Instantly searchable API documentation for the entire YUI library." href="../../api/">YUI 3 API Docs</a></li><li class="item"><a title="The YUI Library can be downloaded from SourceForge" href="http://sourceforge.net/projects/yui/">YUI 3 on Sourceforge (external)</a></li><li class="item"><a title="YUI is free and open, offered under a BSD license." href="http://developer.yahoo.com/yui/3/license.html">YUI License (external)</a></li><li class="sect">YUI 3 Core - Examples</li><li class="item"><a title="YUI (Global Prerequisite) - Functional Examples" href="../../examples/yui/index.html">YUI (Global Prerequisite)</a></li><li class="item"><a title="Event - Functional Examples" href="../../examples/event/index.html">Event</a></li><li class="item"><a title="Node - Functional Examples" href="../../examples/node/index.html">Node</a></li><li class="sect">YUI 3 Component Infrastructure - Examples</li><li class="item"><a title="Attribute - Functional Examples" href="../../examples/attribute/index.html">Attribute</a></li><li class="item"><a title="Plugin - Functional Examples" href="../../examples/plugin/index.html">Plugin</a></li><li class="item"><a title="Widget - Functional Examples" href="../../examples/widget/index.html">Widget</a></li><li class="sect">YUI 3 Utilities - Examples</li><li class="item"><a title="Animation - Functional Examples" href="../../examples/anim/index.html">Animation</a></li><li class="item"><a title="Cache - Functional Examples" href="../../examples/cache/index.html">Cache</a></li><li class="item"><a title="Cookie - Functional Examples" href="../../examples/cookie/index.html">Cookie</a></li><li class="item"><a title="DataSchema - Functional Examples" href="../../examples/dataschema/index.html">DataSchema</a></li><li class="item"><a title="DataSource - Functional Examples" href="../../examples/datasource/index.html">DataSource</a></li><li class="item"><a title="DataType - Functional Examples" href="../../examples/datatype/index.html">DataType</a></li><li class="item"><a title="Drag & Drop - Functional Examples" href="../../examples/dd/index.html">Drag & Drop</a></li><li class="item"><a title="Get - Functional Examples" href="../../examples/get/index.html">Get</a></li><li class="item"><a title="History - Functional Examples" href="../../examples/history/index.html">History</a></li><li class="item"><a title="ImageLoader - Functional Examples" href="../../examples/imageloader/index.html">ImageLoader</a></li><li class="item"><a title="IO - Functional Examples" href="../../examples/io/index.html">IO</a></li><li class="item"><a title="JSON (JavaScript Object Notation) - Functional Examples" href="../../examples/json/index.html">JSON</a></li><li class="item"><a title="Queue - Functional Examples" href="../../examples/queue/index.html">Queue</a></li><li class="item"><a title="Stylesheet - Functional Examples" href="../../examples/stylesheet/index.html">Stylesheet</a></li><li class="sect">YUI 3 Widgets - Examples</li><li class="item"><a title="Overlay - Functional Examples" href="../../examples/overlay/index.html">Overlay</a></li><li class="item"><a title="Slider - Functional Examples" href="../../examples/slider/index.html">Slider</a></li><li class="sect">YUI 3 Node Plugins - Examples</li><li class="item"><a title="FocusManager Node Plugin - Functional Examples" href="../../examples/node-focusmanager/index.html">FocusManager Node Plugin</a></li><li class="item"><a title="MenuNav Node Plugin - Functional Examples" href="../../examples/node-menunav/index.html">MenuNav Node Plugin</a></li><li class="sect">YUI 3 CSS - Examples</li><li class="item"><a title="YUI CSS Reset - Functional Examples" href="../../examples/cssreset/index.html">CSS Reset</a></li><li class="item"><a title="YUI Fonts - Functional Examples" href="../../examples/cssfonts/index.html">CSS Fonts</a></li><li class="item"><a title="YUI Base - Functional Examples" href="../../examples/cssbase/index.html">CSS Base</a></li><li class="sect">YUI 3 Developer Tools - Examples</li><li class="item"><a title="Console - Functional Examples" href="../../examples/console/index.html">Console</a></li><li class="item"><a title="Profiler - Functional Examples" href="../../examples/profiler/index.html">Profiler</a></li><li class="selected "><a title="Test - Functional Examples" href="../../examples/test/index.html">Test</a></li><li class="sect">The YUI Community</li><li class="item"><a title="The Yahoo! User Interface Blog" href="http://yuiblog.com">YUI Blog (external)</a></li><li class="item"><a title="The Yahoo! Group YDN-JavaScript hosts the YUI community forum" href="http://tech.groups.yahoo.com/group/ydn-javascript/">YUI Forum (external)</a></li><li class="item"><a title="The Yahoo! Group yui3 is dedicated to the 3.x branch of the Yahoo! User Interface (YUI) Library." href="http://tech.groups.yahoo.com/group/yui3/">YUI 3 Forum (external)</a></li><li class="item"><a title="YUI is used by Yahoo! and by hundreds of other sites, including many you know and love." href="/yui/poweredby/">YUI Sightings (external)</a></li><li class="item"><a title="Videos and podcasts from the YUI Team and from the Yahoo! frontend engineering community." href="http://developer.yahoo.com/yui/theater/">YUI Theater (external)</a></li><li class="sect">YUI Articles on the YUI Website</li><li class="item"><a title="Answers to Frequently Asked Questions about the YUI Library" href="http://developer.yahoo.com/yui/articles/faq/">YUI FAQ (external)</a></li><li class="item"><a title="Yahoo!'s philosophy of Graded Browser Support" href="http://developer.yahoo.com/yui/articles/gbs/">Graded Browser Support (external)</a></li><li class="item"><a title="Reporting Bugs and Making Feature Requests for YUI Components" href="http://developer.yahoo.com/yui/articles/reportingbugs/">Bug Reports/Feature Requests (external)</a></li><li class="item"><a title="Serve YUI source files from Yahoo! -- free, fast, and simple" href="http://developer.yahoo.com/yui/3/articles/hosting/">Serving YUI Files from Yahoo! (external)</a></li></ul> |
|
290 </div> |
|
291 </div> |
|
292 </div><!--closes bd--> |
|
293 |
|
294 <div id="ft"> |
|
295 <p class="first">Copyright © 2009 Yahoo! Inc. All rights reserved.</p> |
|
296 <p><a href="http://privacy.yahoo.com/privacy/us/devel/index.html">Privacy Policy</a> - |
|
297 <a href="http://docs.yahoo.com/info/terms/">Terms of Service</a> - |
|
298 <a href="http://docs.yahoo.com/info/copyright/copyright.html">Copyright Policy</a> - |
|
299 <a href="http://careers.yahoo.com/">Job Openings</a></p> |
|
300 </div> |
|
301 </div> |
|
302 <script src="../../assets/dpSyntaxHighlighter.js"></script> |
|
303 <script language="javascript"> |
|
304 dp.SyntaxHighlighter.HighlightAll('code'); |
|
305 </script> |
|
306 </body> |
|
307 </html> |