- The file name should be Matching for the top level test suite name.
- There should be one top level test suite per file.
- Give a meaningful name or title for the test suite.
- Either use
varorthisto define variables that needs to use across tests.varvariables should be placed just below the top describe (test suite) - Use setup and teardown methods to perform common variable initializations and functionalities.
- A spec (test case) should test only “ONE” expectation.
- Group the main test suite with sub test suites to group sections.
Good Test Suite
Following is a structure of a good looking Jasmine test suite.
|
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 |
<span class="pl-c">// GoodTestSpec.js</span> <span class="pl-c">/**</span> <span class="pl-c"> * Describe the purpose of this test suite here.</span> <span class="pl-c"> */</span> <span class="pl-c">// give a meaningful name for the test suite.</span> <span class="pl-c">// only "ONE" top level test suite per file.</span> <span class="pl-en">describe</span>(<span class="pl-s"><span class="pl-pds">'</span>Good test suite<span class="pl-pds">'</span></span>, <span class="pl-k">function</span> () { <span class="pl-c">// define "ALL" the values that needs to be accessed across test cases</span> <span class="pl-c">// Else use `this` keyword. But follow one approach. If `this` is used, don't define values here.</span> <span class="pl-k">var</span> foo <span class="pl-k">=</span> <span class="pl-c1">null</span>, bar <span class="pl-k">=</span> <span class="pl-c1">null</span>, numberOne <span class="pl-k">=</span> <span class="pl-c1">null</span>; <span class="pl-c">// initialize "ALL" values above to their desired default value, in this block "beforeEach"</span> <span class="pl-en">beforeEach</span>(<span class="pl-k">function</span> () { foo <span class="pl-k">=</span> <span class="pl-c1">null</span>; bar <span class="pl-k">=</span> <span class="pl-c1">null</span>; numberOne <span class="pl-k">=</span> <span class="pl-c1">1</span>; <span class="pl-c">// Using `this` approach. Pick one that suits the Test Suite.</span> <span class="pl-v">this</span>.<span class="pl-smi">moo</span> <span class="pl-k">=</span> <span class="pl-c1">null</span>; }); <span class="pl-c">// a spec (test case) should test only "ONE" expectation</span> <span class="pl-en">it</span>(<span class="pl-s"><span class="pl-pds">'</span>should check foo to be null<span class="pl-pds">'</span></span>, <span class="pl-k">function</span> () { <span class="pl-c">// ....</span> <span class="pl-en">expect</span>(foo).<span class="pl-en">toBe</span>(<span class="pl-c1">null</span>); }); <span class="pl-c">// another spec</span> <span class="pl-en">it</span>(<span class="pl-s"><span class="pl-pds">'</span>should check numberOne to equal 1<span class="pl-pds">'</span></span>, <span class="pl-k">function</span> () { <span class="pl-c">// call fail() if something is not right and want to fail the test</span> <span class="pl-c">// fail('woops! not correct state.');</span> <span class="pl-en">expect</span>(numberOne).<span class="pl-en">toEqual</span>(<span class="pl-c1">1</span>); }); <span class="pl-c">// Group the main test suite with sub test suites to group sections.</span> <span class="pl-c">// The title should be descriptive.</span> <span class="pl-en">describe</span>(<span class="pl-s"><span class="pl-pds">'</span>that is magnificent<span class="pl-pds">'</span></span>, <span class="pl-k">function</span> () { <span class="pl-c">// Test name will read as "Good test suite that is magnificent should check 42 to is 42"</span> <span class="pl-en">it</span>(<span class="pl-s"><span class="pl-pds">'</span>should check 42 is 42<span class="pl-pds">'</span></span>, <span class="pl-k">function</span> () { <span class="pl-en">expect</span>(<span class="pl-c1">42</span>).<span class="pl-en">toEqual</span>(<span class="pl-c1">42</span>); }); }); }); |