Skip to content

Commit

Permalink
dwf/rva: minor Jasmine cleanup
Browse files Browse the repository at this point in the history
pivotalops committed Dec 4, 2008

Verified

This commit was signed with the committer’s verified signature.
EtiennePelletier Étienne Pelletier
1 parent 10b613c commit 0f3685a
Showing 10 changed files with 381 additions and 388 deletions.
20 changes: 0 additions & 20 deletions README

This file was deleted.

163 changes: 140 additions & 23 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Jasmine
=======
**yet another JavaScript testing framework**
**YET ANOTHER JavaScript testing framework**

Why another frickin' JS tdd/bdd framework?
Why Another Frickin' JS TDD/BDD Framework?
-----------

There are some situations when you want to test-drive JavaScript, but you don't want to be bothered with or even have an explicit document. You have no DOM to work with and so don't have HTML elements on which to hang events handlers. You may need to make asynchronous calls (say, to an AJAX API) and cannot mock/stub them.
There are some situations when you want to test-drive JavaScript, but you don't want to be bothered with or even have an explicit document. You have no DOM to work with and thus lack HTML elements on which to hang event handlers. You may need to make asynchronous calls (say, to an AJAX API) and cannot mock/stub them.

But you still need to write tests.

@@ -14,56 +14,173 @@ What's an Agile Engineer to do?
Enter Jasmine
------------

Jasmine is yet another JavaScript testing framework. It's *heavily* influenced by JSSpec, ScrewUnit & [JSpec](http://github.com/visionmedia/jspec/tree/master), which are all influenced by RSpec. But each of those was lacking in some way: JSSpec & ScrewUnit required a DOM. JSpec's DOM-less assumption was a great start, but it needed asynchronous support.
Jasmine is yet another JavaScript testing framework. It's *heavily* influenced by JSSpec, ScrewUnit & [JSpec](http://github.com/visionmedia/jspec/tree/master), which are all influenced by RSpec. But each of those was lacking in some way: JSSpec & ScrewUnit require a DOM. JSpec's DOM-less assumption was a great start, but it needed asynchronous support.

So we started over. And TDD'd a whole new framework. Enjoy.

How To
------

### Runner
There is a nice example of how to use Jasmine in the /example directory. But here's more information.

Jasmine()
### Specs

You don't need a DOM, but you do need a page on which to load & execute your JS.
Each spec is, naturally, a JavaScript function. You tell Jasmine about this spec with a call to `it()` with a name and the function. The string is a description that will be helpful to you when reading a report.

### Suites
Your spec needs to call `runs()` with another function that is the actual spec. More on why in a moment. Here's an example:

Group your specs via describe
it('should be a test', function () {
runs(function () {
var foo = 0
foo++;
});
});

### Specs
### Expectations

call it() and provide a desc & a function
Within your spec you will want/need to make expectations. These are made like this:

call runs
it('should be a test', function () {
runs(function () {
var foo = 0
foo++;

this.expects_that(foo).should_equal(1);
});
});

alias of runs to then
Results of the expectations are logged for later for reporting.

#### Asynchronous support
### Multiple Calls to `runs()` & Scope in Your Spec

call waits
Your spec can call `runs()` multiple times if you need to break your spec up for any reason. Say, for async support (see next section). To allow you to share variables across your `runs()` functions, `this` is set to the spec itself. For example:

### Custom Matchers
it('should be a test', function () {
runs(function () {
this.foo = 0
this.foo++;

this.expects_that(this.foo).should_equal(1);
});

runs(function () {
this.foo++;
this.expects_that(this.foo).should_equal(2);
})
});

Functions defined with `runs()` are called in the order in which they are defined.

### Asynchronous Specs

You may be asking yourself, "Self, why would I ever need to break up my tests into pieces like this?" The answer is when dealing with asynchronous function calls.

Say you need to make a call that is asynchronous - an AJAX API, or some other JavaScript library. That is, the call returns immediately, yet you want to make expectations 'at some point in the future' after some magic happens in the background.

Jasmine allows you to do this by chaining calls to `runs()` with calls to `waits()`. You supply a time to wait before the next `runs()` function is executed. Such as:

it('should be a test', function () {
runs(function () {
this.foo = 0;
var that = this;
setTimeout(function () {}
that.foo++;
}, 250);
});

runs(function () {
this.expects_that(this.foo).should_equal(0);
});

waits(500);

runs(function () {
this.expects_that(this.foo).should_equal(1);
});
});

What's happening here?

* The first call to `runs()` sets call for 1/4 of a second in the future that increments `this.foo`.
* The second `runs()` is executed immediately and then verifies that `this.foo` was indeed initialized to zero in the previous `runs()`.
* Then we wait for half a second.
* Then the last call to `runs()` expects that `this.foo` was incremented by the `setTimeout`.

### Suites

Specs are grouped in Suites. Suites are defined using the global `describe()` function:

describe('One suite', function () {
it('has a test', function () {
...
});

it('has another test', function () {
...
});
});

use Matchers.method('name', function ()). Write TESTS!
The name is so that reporting is more descriptive.

Suites are executed in the order in which `describe()` calls are made, usually in the order in which their script files are included.

### Runner

You don't need a DOM to run your tests, but you do need a page on which to load & execute your JS. Include the `jasmine.js` file in a script tag as well as the JS file with your specs. You can also use this page for reporting. More on that in a moment.

// include example.html

### Reports

no reporting yet other than Runner.results, which is walkable

### Tests
#### JSON Reporter
Coming soon.

There is a VERY simple test reporter - it's not even a framework at all - that allows you to write tests.
#### HTML Reporter
Coming soon.

Contributing
-----------
#### In-line HTML Reporter
Coming soon.

### Custom Matchers

Jasmine has a simple set of matchers - currently just should\_equal and should\_not\_equal. But Matchers can be extended simply to add new expectations. We use Douglas Crockford's Function.method() helper to define new Matchers.

A Matcher has a method name, takes an expected value as it's only parameter, has access to the actual value in this, and then makes a call to this.report with true/false with a failure message. Here's the definition of should\_equal():

Matchers.method('should_equal', function (expected) {
return this.report((this.actual === expected),
'Expected ' + expected + ' but got ' + this.actual + '.');
});

Feel free to define your own matcher as needed in your code. If you'd like to add Matchers to Jasmine, please write tests.

Contributing and Tests
----------------------

Sometimes it's hard to test a framework with the framework itself. Either the framework isn't mature enough or it just hurts your head. Jasmine is affected by both.

So we made a little bootstrappy test reporter that lets us test Jasmine's pieces in isolation. See test/bootstrap.js. Feel free to use the bootstrap test suite to test your custom Matchers or extensions/changes to Jasmine.

Your contributions are welcome. Please submit tests with your pull request.

## Maintainers

* [Davis W. Frank]([email protected]), Pivotal Labs
* [Rajan Akasgar]([email protected]), Pivotal Labs

## TODO List

Contributions are welcome. Please submit tests with your pull request.
In no particular order:

### TODO
* protect the global-ness of some variables & functions
* Suite beforeAll and afterAll functions
* add a description to runs()
* suite.beforeAll and suite.afterAll
* JSON reporter
* HTML reporter
* HTML reporter (callback driven)


File renamed without changes
217 changes: 122 additions & 95 deletions jasmine.iws

Large diffs are not rendered by default.

1 change: 0 additions & 1 deletion jspec
Submodule jspec deleted from d1c67d
81 changes: 44 additions & 37 deletions lib/jasmine.js
Original file line number Diff line number Diff line change
@@ -18,6 +18,45 @@ if (typeof Function.method !== 'function') {
}
}

/*
* object for holding results; allows for the results array to hold another nestedResults()
*
*/

var nestedResults = function() {
var that = {
totalCount: 0,
passedCount: 0,
failedCount: 0,
results: [],

rollupCounts: function (result) {
that.totalCount += result.totalCount;
that.passedCount += result.passedCount;
that.failedCount += result.failedCount;
},

push: function (result) {
if (result.results) {
that.rollupCounts(result);
} else {
that.totalCount++;
result.passed ? that.passedCount++ : that.failedCount++;
}
that.results.push(result);
}
}

return that;
}


/*
* base for Runner & Suite: allows for a queue of functions to get executed, allowing for
* any one action to complete, including asynchronous calls, before going to the next
* action.
*
**/
var actionCollection = function () {
var that = {
actions: [],
@@ -82,6 +121,7 @@ var actionCollection = function () {
/*
* Matchers methods; add your own with Matchers.method()
*/

Matchers = function (actual, results) {
this.actual = actual;
this.passing_message = 'Passed.'
@@ -101,7 +141,6 @@ Matchers.method('report', function (result, failing_message) {
Matchers.method('should_equal', function (expected) {
return this.report((this.actual === expected),
'Expected ' + expected + ' but got ' + this.actual + '.');

});

Matchers.method('should_not_equal', function (expected) {
@@ -134,34 +173,6 @@ var queuedFunction = function(func, timeout, spec) {
return that;
}

var nestedResults = function() {
var that = {
totalCount: 0,
passedCount: 0,
failedCount: 0,
results: [],

push: function(result) {
if (result.results) {
that.totalCount += result.totalCount;
that.passedCount += result.passedCount;
that.failedCount += result.failedCount;

} else {
that.totalCount++;
if (result.passed) {
that.passedCount++;
} else {
that.failedCount++;
}
}
that.results.push(result);
}
}

return that;
}

var it = function (description, func) {
var that = {
description: description,
@@ -211,7 +222,6 @@ var it = function (description, func) {
}

that.runs = addToQueue;
that.then = addToQueue;

currentSuite.specs.push(that);
currentSpec = that;
@@ -228,8 +238,6 @@ var runs = function (func) {
currentSpec.runs(func);
}

var then = runs;

var waits = function (timeout) {
currentSpec.waits(timeout);
}
@@ -249,7 +257,7 @@ var describe = function (description, spec_definitions) {
that.specs = that.actions;

currentSuite = that;
currentRunner.suites.push(that);
Jasmine.suites.push(that);

spec_definitions();

@@ -258,19 +266,18 @@ var describe = function (description, spec_definitions) {
return that;
}

var Jasmine = function () {
var Runner = function () {
var that = actionCollection();

that.suites = that.actions;
that.results.description = 'All Jasmine Suites';

currentRunner = that;
Jasmine = that;
return that;
}

var currentRunner = Jasmine();
var Jasmine = Runner();
var currentSuite = describe('default current suite', function() {});

var currentSpec;

/*
2 changes: 1 addition & 1 deletion test/bootstrap.html
Original file line number Diff line number Diff line change
@@ -14,7 +14,7 @@ <h1>
</h1>
<div id="icon_wrapper">
<span id="icons"></span>
<img id="spinner" src="spinner.gif" alt="" />
<img id="spinner" src="../images/spinner.gif" alt="" />
</div>
<div id="report">
<div id="results_summary" style="display:none;">
136 changes: 74 additions & 62 deletions test/bootstrap.js
Original file line number Diff line number Diff line change
@@ -136,22 +136,26 @@ var testSpecs = function () {
var testAsyncSpecs = function () {
var foo = 0;

var a_spec = it('simple queue test').
runs(function () {
foo++;
}).then(function() {
this.expects_that(foo).should_equal(1)
var a_spec = it('simple queue test', function () {
runs(function () {
foo++;
});
runs(function () {
this.expects_that(foo).should_equal(1)
});
});

reporter.test(a_spec.queue.length === 2,
'Spec queue length is not 2');

foo = 0;
a_spec = it('spec w/ queued statments').
runs(function () {
foo++;
}).then(function() {
this.expects_that(foo).should_equal(1);
a_spec = it('spec w/ queued statments', function () {
runs(function () {
foo++;
});
runs(function () {
this.expects_that(foo).should_equal(1);
});
});

a_spec.execute();
@@ -162,14 +166,16 @@ var testAsyncSpecs = function () {
'No call to waits(): Queued expectation failed');

foo = 0;
a_spec = it('spec w/ queued statments').
runs(function () {
setTimeout(function() {
foo++
}, 500);
}).waits(1000).
then(function() {
this.expects_that(foo).should_equal(1);
a_spec = it('spec w/ queued statments', function () {
runs(function () {
setTimeout(function() {
foo++
}, 500);
});
waits(1000);
runs(function() {
this.expects_that(foo).should_equal(1);
});
});

var mockSuite = {
@@ -185,22 +191,25 @@ var testAsyncSpecs = function () {
waitForDone(a_spec, mockSuite);

var bar = 0;
var another_spec = it('spec w/ queued statments').
runs(function () {
setTimeout(function() {
bar++;
}, 250);
}).
waits(500).
then(function () {
setTimeout(function() {
bar++;
}, 250);
}).
waits(1500).
then(function() {
this.expects_that(bar).should_equal(2);
var another_spec = it('spec w/ queued statments', function () {
runs(function () {
setTimeout(function() {
bar++;
}, 250);

});
waits(500);
runs(function () {
setTimeout(function() {
bar++;
}, 250);
});
waits(500);
runs(function () {
this.expects_that(bar).should_equal(2);
});
});

mockSuite = {
next: function() {
reporter.test((another_spec.queue.length === 3),
@@ -215,17 +224,19 @@ var testAsyncSpecs = function () {
waitForDone(another_spec, mockSuite);

var baz = 0;
var yet_another_spec = it('spec w/ async fail').
runs(function () {
setTimeout(function() {
baz++;
}, 250);
}).
waits(100).
then(function() {
this.expects_that(baz).should_equal(1);
var yet_another_spec = it('spec w/ async fail', function () {
runs(function () {
setTimeout(function() {
baz++;
}, 250);
});
waits(100);
runs(function() {
this.expects_that(baz).should_equal(1);
});
});


mockSuite = {
next: function() {

@@ -244,21 +255,22 @@ var testAsyncSpecs = function () {

var testAsyncSpecsWithMockSuite = function () {
var bar = 0;
var another_spec = it('spec w/ queued statments').
runs(function () {
setTimeout(function() {
bar++;
}, 250);
}).
waits(500).
then(function () {
setTimeout(function() {
bar++;
}, 250);
}).
waits(1500).
then(function() {
this.expects_that(bar).should_equal(2);
var another_spec = it('spec w/ queued statments', function () {
runs(function () {
setTimeout(function() {
bar++;
}, 250);
});
waits(500);
runs(function () {
setTimeout(function() {
bar++;
}, 250);
});
waits(1500)
runs(function() {
this.expects_that(bar).should_equal(2);
});
});

var mockSuite = {
@@ -481,14 +493,14 @@ var testSpecScope = function () {

var testRunner = function() {

var runner = Jasmine();
var runner = Runner();
describe('one suite description', function () {
it('should be a test');
});
reporter.test((runner.suites.length === 1),
"Runner expected one suite");

runner = Jasmine();
runner = Runner();
describe('one suite description', function () {
it('should be a test');
});
@@ -498,7 +510,7 @@ var testRunner = function() {
reporter.test((runner.suites.length === 2),
"Runner expected two suites");

runner = Jasmine();
runner = Runner();
describe('one suite description', function () {
it('should be a test', function() {
runs(function () {
@@ -578,7 +590,7 @@ var testNestedResults = function () {
}

var testReporting = function () {
var runner = Jasmine();
var runner = Runner();
describe('one suite description', function () {
it('should be a test', function() {
runs(function () {
@@ -628,7 +640,7 @@ var runTests = function () {
setTimeout(function() {
$('spinner').hide();
reporter.summary();
}, 4500);
}, 3500);
}


23 changes: 0 additions & 23 deletions test/test.html

This file was deleted.

126 changes: 0 additions & 126 deletions test/test.js

This file was deleted.

0 comments on commit 0f3685a

Please sign in to comment.