-
Notifications
You must be signed in to change notification settings - Fork 0
/
unit_test_framework.html
339 lines (271 loc) · 15 KB
/
unit_test_framework.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title></title>
<!-- plugin styles -->
<link rel="stylesheet" type="text/css" href="stylesheets/highlight-github.css" />
<!-- guides styles -->
<link rel="stylesheet" type="text/css" href="stylesheets/reset.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/main.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/print.css" media="print" />
<link rel="stylesheet" type="text/css" href="stylesheets/guides.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/overrides.style.css" />
<link rel="stylesheet" type="text/css" href="stylesheets/overrides.print.css" media="print" />
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link href="//netdna.bootstrapcdn.com/font-awesome/3.2.1/css/font-awesome.css" rel="stylesheet">
<meta name="generator" content="DocPad v6.79.0" />
</head>
<body class="guide">
<header role="banner">
<div class="container">
<h1 id="logo">
<a href="http://www.sproutcore.com"><img src="images/header/logo.png" alt="SproutCore" /></a>
</h1>
<nav role="navigation">
<ul>
<li><a href="http://sproutcore.com/about/">About</a></li>
<li><a href="http://showcase.sproutcore.com">Showcase</a></li>
<li class="active"><a href="http://guides.sproutcore.com">Guides</a></li>
<li><a href="http://docs.sproutcore.com">Docs</a></li>
<li><a href="http://sproutcore.com/community/">Community</a></li>
<li><a href="http://blog.sproutcore.com">Blog</a></li>
</ul>
</nav>
</div>
</header>
<div id="feature">
<div class="wrapper">
<div class="feature_header">
<a href="/"><img src="images/graphics/guides.png"></a>
<h2><a href="/">SproutCore Guides</a></h2>
<p>These guides are designed to help you write and perfect your code.</p>
</div>
<div class="feature_sidebar">
<a href="index.html" id="guidesMenu">
Guides Index <span id="guidesArrow">▸</span>
</a>
<div id="guides" class="clearfix" style="display: none;">
<a href="index.html" class="guidesMenu">
Guides Index <span class="guidesArrow">▾</span>
</a>
<hr style="clear:both;">
<dl class='L'><dt>Start Here</dt>
<dd><a href='/getting_started.html'>Getting Started: Part 1</a></dd>
<dd><a href='/getting_started_2.html'>Getting Started: Part 2</a></dd>
<dd><a href='/getting_started_3.html'>Getting Started: Part 3</a></dd>
<dd><a href='/core_concepts_sc_object.html'>Classes and SC.Object</a></dd>
<dd><a href='/core_concepts_kvo.html'>Computed Properties, Observers and Bindings</a></dd><dt>Views</dt>
<dd><a href='/views.html'>Core View Concepts</a></dd><dt>Models</dt>
<dd><a href='/records.html'>SproutCore Records</a></dd>
<dd><a href='/fixtures.html'>Using Fixtures</a></dd><dt>Theming</dt>
<dd><a href='/chance.html'>Using Chance, SproutCore's CSS Framework</a></dd>
<dd><a href='/theming_app.html'>Theming Your App</a></dd></dl><dl class='R'><dt>Testing</dt>
<dd><a href='/adding_unit_test.html'>Adding a Unit Test</a></dd>
<dd><a href='/unit_test_framework.html'>Unit Testing</a></dd>
<dd><a href='/writing_unit_tests.html'>Writing Unit Tests</a></dd>
<dd><a href='/running_unit_tests.html'>Running Unit Tests</a></dd>
<dd><a href='/todos_tdd.html'>SproutCore Development Using TDD</a></dd><dt>Extras</dt>
<dd><a href='/build_tools.html'>SproutCore's Build Tools</a></dd>
<dd><a href='/run_loop.html'>The Run Loop</a></dd>
<dd><a href='/enumerables.html'>Enumerables</a></dd><dt>Contributing to SproutCore</dt>
<dd><a href='/style_guide.html'>Javascript Guidelines</a></dd>
<dd><a href='/commit_code.html'>Committer Guidelines</a></dd>
<dd><a href='/documentation_guidelines.html'>Documentation Guidelines</a></dd>
<dd><a href='/contribute.html'>Contributing Guides</a></dd><dt>Thanks</dt>
<dd><a href='/credits.html'>Credits</a></dd></dl>
</div>
</div>
</div>
</div>
<div id="container">
<div class="wrapper">
<div id="mainCol">
<div class='headerSection'>
<h2>Unit Testing - About Unit Testing</h2>
<p>This guide covers the SproutCore unit test API and some ideas on how to use it. After reading this guide, you will:</p>
<ul>
<li>Know how to create your unit tests and where to locate them.</li>
<li>How to run your tests.</li>
<li>How to get the most out of unit testing in SproutCore.</li>
</ul>
</div>
<h3 id='-Overview-'>1 - Overview
</h3>
<p>Rigorous unit testing is a key principle to modern agile development. Unit tests not only make it easier for other developers to understand and work
with your code, it makes it easier for you to maintain your own code as well.</p>
<p>In the past, unit testing JavaScript has been a difficult process, primarily because the infrastructure needed to run unit tests required a lot of
manual setup.</p>
<p>SproutCore makes unit testing far easier by bundling an integrated testing framework as well as a test runner right into the build tools. The testing
framework is based on <a href="http://docs.jquery.com/QUnit">jQuery's QUint</a>.</p>
<h3 id='-How-it-Works-'>2 - How it Works
</h3>
<h4 id='-Where-Unit-Test-Files-Are-Stored-'>2.1 - Where Unit Test Files Are Stored
</h4>
<p>Unit test files are stored in a directory, <tt>tests</tt>, under your SproutCore application subfolder. For example, if your application is
named <tt>hello_world</tt>, then the <tt>tests</tt> folder will have this project path: <tt>hello_world/apps/hello_world/tests</tt>.</p>
<p>If this folder doesn't already exist for you, then add it at this time.</p>
<h4 id='-Adding-Unit-Test-Files-'>2.2 - Adding Unit Test Files
</h4>
<p>When you create a code file using <tt>sc-gen</tt>, it will automatically generate the skeleton for a unit test that you can enhance to test your code file.
Then simply open the test file and write some tests.</p>
<p>To add a unit test file manually, simply create it inside the <tt>tests</tt> directory.</p>
<p>See <a href="/adding_unit_test.html">Adding a Unit Test</a> for more information on this process.</p>
<h4 id='-Writing-Unit-Test-Cases-'>2.3 - Writing Unit Test Cases
</h4>
<p>Once you've added a unit test file, write your unit test cases using the QUnit testing API. A simple unit test looks like this:</p>
<pre class="highlighted"><div class="code_container"><code class="hljs undefined">module("HelloWorld") ;
test("value of 'string' is 'Hello World', function() {
ok(HelloWorld.get('string'), 'Hello World', "has preset string");
});</code></div></pre>
<p>See <a href="/writing_unit_tests.html">Writing a Unit Test Case</a> for more information on this process.</p>
<h4 id='-Running-Unit-Test-Cases-'>2.4 - Running Unit Test Cases
</h4>
<p>The test runner is activated when you launch <tt>sc_server</tt>.</p>
<p>You run all the tests by simply browsing to <a href="http://localhost:4020/sproutcore/tests">http://localhost:4020/sproutcore/tests</a>.</p>
<p>You can also test a subset of unit tests; see <a href="/running_unit_test.html">Running Unit Test Cases</a> for more information.</p>
<h3 id='-Getting-the-Most-Out-of-Unit-Testing-'>3 - Getting the Most Out of Unit Testing
</h3>
<p>To get the best results out of your test running, you should get into the habit of adding unit tests for every major function in your application. It
is not necessary to add unit tests for every single method you write, but you should make sure your unit tests cover the major pieces of your app that
are stitched together with bindings. This is especially important for any complicated engines or for components with a large number of moving parts
since they tend to break easily.</p>
<p>Assuming you have good unit tests, you should also make sure everyone in your team runs all of the unit tests at least once before committing any
changes to your source repository. Try to never commit source changes that leave tests failing. This way unit tests will remain a useful check for
every developer on the project to ensure they have not broken another piece of the code.</p>
<p>In order to achieve the best test coverage, you need to run your unit tests in every target web browser you intend to run your application in. For
example, when we write SproutCore code, we will load the test runner in IE6, IE7, IE8, Safari, Chrome, and Firefox. Since running unit tests this
many times can become very labor intensive if you try to do it before every checkin, usually the best thing to do is to run your unit tests before
every checkin in only one or two browsers such as Firefox and Safari. Periodically you should set milestones in your project development where you
will run through the unit tests on all browsers and fix anything that breaks unit tests for continuing with your development.</p>
<p>Above all, the most important thing about unit testing is to write and run your unit tests regularly. Unit tests are only useful if you maintain
them. If you write too much code that is not covered by unit tests, they will not prevent enough errors for people on your team to use them
regularly. Likewise, if you let your unit tests failing for too long, developers will look at test failures as "noise" and tend to ignore them.</p>
<h3 id='-Moving-On-'>4 - Moving On
</h3>
<p>Now that you know the basics of how to use unit tests, it's time to start adding unit tests to your project.</p>
<p>See <a href="/adding_unit_test.html">Adding Unit Test Files »</a></p>
<h3 id='-Changelog-'>5 - Changelog
</h3>
<ul>
<li>February 15, 2011: initial version by <a href="credits.html#oldfartdeveloper">Scott Smith</a> and <a href="credits.html#veebs">Vibul Imtarnasan</a></li>
<li>March 2, 2011: paragraph formamtting by <a href="credits.html#topherfangio">Topher Fangio</a></li>
<li>August 7, 2013: converted to Markdown format for DocPad guides by <a href="credits.html#topherfangio">Topher Fangio</a></li>
</ul>
</div>
<!-- TODO: re-add index_items //-->
<div id="subCol">
<h3 class="chapter"><img src="images/graphics/chapters.png" alt="">Chapters</h3>
<ol class='chapters'>
<li>
<a href='#-Overview-'><p> Overview
</p></a>
<ul>
</ul>
</li>
<li>
<a href='#-How-it-Works-'><p> How it Works
</p></a>
<ul>
<li><a href='#-Where-Unit-Test-Files-Are-Stored-'><p> Where Unit Test Files Are Stored
</p></a></li>
<li><a href='#-Adding-Unit-Test-Files-'><p> Adding Unit Test Files
</p></a></li>
<li><a href='#-Writing-Unit-Test-Cases-'><p> Writing Unit Test Cases
</p></a></li>
<li><a href='#-Running-Unit-Test-Cases-'><p> Running Unit Test Cases
</p></a></li>
</ul>
</li>
<li>
<a href='#-Getting-the-Most-Out-of-Unit-Testing-'><p> Getting the Most Out of Unit Testing
</p></a>
<ul>
</ul>
</li>
<li>
<a href='#-Moving-On-'><p> Moving On
</p></a>
<ul>
</ul>
</li>
<li>
<a href='#-Changelog-'><p> Changelog
</p></a>
<ul>
</ul>
</li>
</ol>
</div>
</div>
</div>
<hr class="hide" />
<footer>
<div class="container">
<div class="col">
<a href="index.html"><img src="images/footer/sc_logo_medium.png" alt="SproutCore" /></a>
<p id="license">
SproutCore framework is under MIT License.
</p>
</div>
<nav class="col">
<h1>Site Navigation</h1>
<ul>
<li><a href="http://www.sproutcore.com/about/">About</a></li>
<li><a href="http://docs.sproutcore.com">Docs</a></li>
<li><a href="http://blog.sproutcore.com">Blog</a></li>
<li><a href="http://www.sproutcore.com/install/?redirect=1">Download</a></li>
<li><a href="http://www.sproutcore.com/community/">Community</a></li>
<li><a href="https://github.com/sproutcore/sproutcore">GitHub</a></li>
<li><a href="mailto:community@sproutcore.com">Contact Us</a></li>
<li><a href="http://guides.sproutcore.com">Guides</a></li>
</ul>
<a href="http://www.w3.org/html/logo/"><img src="images/footer/html5_tech.png" alt="HTML5 Powered" /></a>
</nav>
<div class="col">
<h1>Get in Touch, Stay Informed</h1>
<ul class="social">
<li><a href="http://twitter.com/sproutcore"><img src="images/footer/twitter.png" alt="Twitter" /></a></li>
<li><a href="http://www.facebook.com/sproutcore"><img src="images/footer/facebook.png" alt="Facebook" /></a></li>
<li><a href="http://groups.google.com/group/sproutcore"><img src="images/footer/google.png" alt="Google Groups" /></a></li>
<li><a href="http://groups.google.com/group/sproutcore">Subscribe To Mailing List</a></li>
</ul>
<a href="http://eepurl.com/dK1-Y" target="_blank" id="newsletter" class="button secondary">Sign Up For Our Newsletter!</a>
<!-- Commented out until we have mailchimp API integration.
<h2>Subscribe To Newsletter</h2>
<div id="subscribe">
<form>
<input type="text" name="email" />
<button name="subscribe">Sign-Up</button>
<div class="processing"><img src="/img/spinner.gif"></div>
<div class="error"></div>
</form>
</div>
-->
</div>
<a href="#feature" class="top">Back To Top</a>
</div>
</footer>
<script type='text/javascript' src='/javascripts/jquery.min.js'></script>
<script type='text/javascript'>
/*
* Make the guides link clickable
*/
function guideMenu(e){
if (document.getElementById('guides').style.display == "none") {
document.getElementById('guides').style.display = "block";
document.getElementById('guidesArrow').innerHTML = "▾";
$('body').click(function(e){ guideMenu(e); });
} else {
document.getElementById('guides').style.display = "none";
document.getElementById('guidesArrow').innerHTML = "▸";
$('body').unbind('click');
}
return false;
}
$('#guidesMenu, .guidesMenu').click(guideMenu);
</script>
</body>
</html>