example/spec/dom_mocks/simple.html lib/screw.mock.js mock_docs/files.html mock_docs/index.html mock_docs/symbols/TH.Ajax.html mock_docs/symbols/TH.Mock.html mock_docs/symbols/TH.html mock_docs/symbols/_global_.html mock_docs/symbols/src/_Users_Topper_screw-unit-mock_lib_screw.mock.js.html spec/asynchronous_spec.js spec/dom_mocks/click_test.html spec/dom_mocks/dom_mock_test.html spec/mock_spec.js spec/skipping_spec.js @@ -1,3 +1,93 @@ +# Skipping Tests: + +* Skipped has a separate status counter at the top of the page, a new display color, and a reason can be printed to the page. +* At any time within an test, you can make it show as skipped. The test will cease to run at that point. It can no longer pass or fail. +* If you want to skip multiple tests, the before can do the skip. + +Examples: + + it('should be skipped if the browser is IE', function(me){ + if(this_browser_is_IE){ + skip(me).because('IE doesn't have some function I am testing, and failed tests make me curl up on the floor and cry'); + } + }) + + describe('', function(){ + before(function(me){ + if(this_browser_is_IE){ + skip(me).because('IE doesn't have some function I am testing, and failed tests make me curl up on the floor and cry'); + } + }); + + it('will never run at all', function(){ + alert('you won't see this'); + }); + + it('will never _ever_ run at all', function(){ + alert('you won't see this... ever!'); + }); + + }) + + +# Asynchronous testing: + +* A jQuery object representing the current test's dom element is now passed to "it" functions +* Asynchronous testing functions are tracked and displayed with overall status, which updates as tests complete +* Nested asynchronous testing + +Examples: + it('tests something after 3 seconds', function(me){ + var x = false; + setTimeout(some_magic_function, 1000); + using(me).wait(3).and_then(function(){ + expect(x).to(be_true); + }); + }) + + it('tests something after 3 seconds, and something else 3 seconds after that', function(me){ + var x = false; + setTimeout(some_magic_function, 1000); + using(me).wait(3).and_then(function(){ + expect(x).to(be_true); + setTimeout(some_other_magic_function, 1000); + using(me).wait(3).and_then(function(){ + expect(x).to(be_false); + }); + }); + }) + + +# Mocking + +* Mock out objects (and have them restored at the next test) +* insert DOM mocks for each test +* Mock out Prototype.js AJAX calls using a simple interface +* JSDoc Toolkit docs (in /mock_docs/index.html) + +Docs online at: [http://toppingdesign.com/mock_docs/](http://toppingdesign.com/mock_docs/) + +Examples: + // DOM mocking + TH.insertDomMock("some_mock"); // will insert dom_mocks/some_mock.html into <div id="dom_test"></div> + + // Object mocking + var someObj = { + foo: function () { return 'bar' } + }; + someObj.foo() == 'bar'; + TH.Mock.Obj("someObj", { + foo: function () { return 'somethingElse' } + }); + someObj.foo() == 'somethingElse'; // BUT! Only for this test the next test will have a normal someObj; + + // Ajax mocking (Prototype.js only) + TH.Ajax.mock("/a_url", "someText", 200); + var ajx = new Ajax.Request("/a_url", { + onComplete: function (resp) { response = resp } + }); + expect(response.responseText).to(equal, "someText"); + Screw.Unit is a Behavior-Driven Testing Framework for Javascript. It features nested describes. Its goals are to provide: * a DSL for elegant, readable, organized specs; README.markdown @@ -8,8 +8,8 @@ function Man(options) { return luck; }; this.render = function() { - return $('<ul class="man">') - .append('<li class="hair">') + return $('<ul class="man"></ul>') + .append('<li class="hair"></li>') .click(function() { $(this).children('.hair').remove(); }); example/models/man.js @@ -1,9 +1,15 @@ +Screw.Defaults = Screw.Defaults || {}; +Screw.Defaults.to_run = 'body > .describe > .describes > .describe'; + (function($) { $(Screw).bind('loaded', function() { $('.status').fn({ display: function() { $(this).text( - $('.passed').length + $('.failed').length + ' example(s), ' + $('.failed').length + ' failure(s)' + $('.it.passed' ).length + $('.failed').length + $('.skipped').length + ' finished, ' + + $('.it.failed' ).length + ' failure(s), ' + + $('.it.skipped').length + ' skipped, ' + + $('.it.async' ).length + ' running asynchronous test(s)' ); } }); @@ -44,10 +50,12 @@ }, run: function() { + if ($(this).hasClass('skipped')){return} + try { try { $(this).fn('parent').fn('run_befores'); - $(this).data('screwunit.run')(); + $(this).data('screwunit.run')($(this)); } finally { $(this).fn('parent').fn('run_afters'); } @@ -73,15 +81,15 @@ }); $('.before').fn({ - run: function() { $(this).data('screwunit.run')() } + run: function() { $(this).data('screwunit.run')($(this)) } }); $('.after').fn({ - run: function() { $(this).data('screwunit.run')() } + run: function() { $(this).data('screwunit.run')($(this)) } }); $(Screw).trigger('before'); - var to_run = unescape(location.search.slice(1)) || 'body > .describe > .describes > .describe'; + var to_run = unescape(location.search.slice(1)) || Screw.Defaults.to_run; $(to_run) .focus() .eq(0).trigger('scroll').end() lib/screw.behaviors.js @@ -2,28 +2,80 @@ var Screw = (function($) { var screw = { Unit: function(fn) { var contents = fn.toString().match(/^[^\{]*{((.*\n*)*)}/m)[1]; - var fn = new Function("matchers", "specifications", - "with (specifications) { with (matchers) { " + contents + " } }" + var fn = new Function("matchers", "specifications", "utilities", + "with (specifications) { with (matchers) { with (utilities) {" + contents + " } } }" ); $(Screw).queue(function() { Screw.Specifications.context.push($('body > .describe')); - fn.call(this, Screw.Matchers, Screw.Specifications); + fn.call(this, Screw.Matchers, Screw.Specifications, Screw.Utilities); Screw.Specifications.context.pop(); $(this).dequeue(); }); }, + Utilities: { + /* + * 'me' is $(this) being passed to the screwunit.run function (see screw.behaviors.js) + * $(this).data('screwunit.run')($(this)); + */ + + skip: function(me){ + return { + because: function(reason) { + me.trigger('skipped', [reason]); + throw ''; + } + } + }, + + using: function( me ) { + return { + wait : function( seconds ) { + return { + and_then: function( fn ) { + var f = function() { + var async_count = me.data('async_waiting_count') - 1; + me.data('async_waiting_count', async_count); + if (async_count < 1) { + me.removeClass('async'); + } + + try { + fn(me); + } catch (e) { + me.trigger('failed', [e]); + return; + } + me.trigger('passed'); + }; + + var async_count = me.data('async_waiting_count') || 0 + me.data('async_waiting_count', async_count + 1) + + me.addClass('async'); + + // allow the "it" we are called from to finish, which will add class "passed", which we want to remove. + setTimeout(function(){ me.trigger('running'); }, 2); + + setTimeout(f, 1000 * parseInt(seconds,10)); + } + } + } + } + } + }, + Specifications: { context: [], describe: function(name, fn) { - var describe = $('<li class="describe">') - .append($('<h1>').text(name)) - .append('<ol class="befores">') - .append('<ul class="its">') - .append('<ul class="describes">') - .append('<ol class="afters">'); + var describe = $('<li class="describe"></li>') + .append($('<h1></h1>').text(name)) + .append('<ol class="befores"></ol>') + .append('<ul class="its"></ul>') + .append('<ul class="describes"></ul>') + .append('<ol class="afters"></ol>'); this.context.push(describe); fn.call(); @@ -35,8 +87,8 @@ var Screw = (function($) { }, it: function(name, fn) { - var it = $('<li class="it">') - .append($('<h2>').text(name)) + var it = $('<li class="it"></li>') + .append($('<h2></h2>').text(name)) .data('screwunit.run', fn); this.context[this.context.length-1] @@ -45,7 +97,7 @@ var Screw = (function($) { }, before: function(fn) { - var before = $('<li class="before">') + var before = $('<li class="before"></li>') .data('screwunit.run', fn); this.context[this.context.length-1] @@ -54,7 +106,7 @@ var Screw = (function($) { }, after: function(fn) { - var after = $('<li class="after">') + var after = $('<li class="after"></li>') .data('screwunit.run', fn); this.context[this.context.length-1] @@ -66,11 +118,11 @@ var Screw = (function($) { $(screw).queue(function() { $(screw).trigger('loading') }); $(function() { - $('<div class="describe">') - .append('<h3 class="status">') - .append('<ol class="befores">') - .append('<ul class="describes">') - .append('<ol class="afters">') + $('<div class="describe"></div>') + .append('<h3 class="status"></h3>') + .append('<ol class="befores"></ol>') + .append('<ul class="describes"></ul>') + .append('<ol class="afters"></ol>') .appendTo('body'); $(screw).dequeue(); lib/screw.builder.js @@ -87,4 +87,16 @@ html { cursor: pointer; color: #000 !important; border-bottom: 1px solid #9A8E51; - } \ No newline at end of file + } + + + .describes .describe .its .it.skipped h2 { + background-color: #8DEEEE; + color: #000000 !important; + } + + .describes .describe .its .it.skipped p { + margin-left: 1em; + color: #000000; + } + \ No newline at end of file lib/screw.css @@ -10,7 +10,9 @@ return $(this).addClass('focused'); }) .bind('scroll', function() { - document.body.scrollTop = $(this).offset().top; + var sel = $(this).fn('selector'); + var use_browser_top = $.inArray(sel, [ Screw.Defaults.to_run + ':eq(0)', 'body > .describe']) >= 0; + document.body.scrollTop = use_browser_top ? 0 : $(this).offset().top; }); $('.it') @@ -18,25 +20,52 @@ $(this).addClass('enqueued'); }) .bind('running', function() { - $(this).addClass('running'); + $(this) + .addClass('running') + .removeClass('failed') + .removeClass('passed'); }) .bind('passed', function() { - $(this).addClass('passed'); + if ($(this).hasClass('skipped')){return} + $(this) + .addClass('passed') + .removeClass('failed'); + $('.status').fn('display'); }) .bind('failed', function(e, reason) { + if ($(this).hasClass('skipped')){return} + reason = reason || ''; $(this) .addClass('failed') - .append($('<p class="error">').text(reason.toString())); + .removeClass('passed') + .append($('<p class="error"></p>').text(reason.toString())); + $('.status').fn('display'); if (reason.fileName || reason.lineNumber) { $(this) - .append($('<p class="error">').text(reason.fileName + " : " + reason.lineNumber)); + .append($('<p class="error"></p>').text(reason.fileName + " : " + reason.lineNumber)); } }) + .bind('skipped', function(e, reason) { + $(this) + .removeClass('failed') + .removeClass('passed') + .addClass('skipped') + .append($('<p class="skip_reason"></p>').text("Skipped because: " + reason.toString())); + $('.status').fn('display'); + }); + + $('.before') + .bind('skipped', function(e, reason){ + if ($(this).hasClass('skipped')){ return } + $(this) + .addClass('skipped') + .append($('<p class="skip_reason"></p>').text("Group Skipped because: " + reason.toString())); + $('.it', $(this).parent().parent().get(0)) + .addClass('skipped'); + $('.status').fn('display'); + }); }) .bind('before', function() { - $('.status').text('Running...'); - }) - .bind('after', function() { - $('.status').fn('display') + $('.status').text('Starting...'); }) })(jQuery); \ No newline at end of file lib/screw.events.js @@ -5,6 +5,23 @@ Screw.Unit(function() { describe('Behaviors', function() { describe('#run', function() { + describe("A describe block with exceptions", function() { + var after_invoked = false; + after(function() { + after_invoked = true; + }); + + describe("an exception in a test", function() { + it("fails because it throws an exception. This is the only test that should fail", function() { + throw('an exception'); + }); + + it("invokes [after]s even if the previous [it] raised an exception", function() { + expect(after_invoked).to(equal, true); + }); + }); + }); + describe("a simple [describe]", function() { it("invokes the global [before] before an [it]", function() { expect(global_before_invoked).to(equal, true); spec/behaviors_spec.js @@ -48,16 +48,16 @@ Screw.Unit(function() { describe('when given a function', function() { it("returns the function's signature", function() { - expect($.print(function() {})).to(equal, 'function ()'); - expect($.print(function foo() {})).to(equal, 'function foo()'); - expect($.print(function foo(bar) {})).to(equal, 'function foo(bar)'); + expect($.print(function() {})).to(match, /function\s*\(\)/); + expect($.print(function foo() {})).to(match, /function\s*foo\(\)/); + expect($.print(function foo(bar) {})).to(match, /function\s*foo\(bar\)/); }); }); describe('when given an element', function() { it("returns the string representation of the element", function() { - expect($.print($('<div>').get(0))).to(equal, '<div>'); - expect($.print($('<div foo="bar">').get(0))).to(equal, '<div>'); + expect($.print($('<div></div>').get(0))).to(equal, '<div>'); + expect($.print($('<div foo="bar"></div>').get(0))).to(equal, '<div>'); }); }); @@ -91,7 +91,7 @@ Screw.Unit(function() { describe('when given a jQuery', function() { it("returns the printed array of elements engirthed in '$()' ", function() { - expect($.print($('<div>'))).to(equal, '$([ <div> ])'); + expect($.print($('<div></div>'))).to(equal, '$([ <div> ])'); }); }); spec/print_spec.js @@ -7,12 +7,19 @@ <script src="../lib/screw.matchers.js"></script> <script src="../lib/screw.events.js"></script> <script src="../lib/screw.behaviors.js"></script> + <script src="../lib/screw.mock.js"></script> + <script src="spec_helper.js"></script> <script src="behaviors_spec.js"></script> <script src="matchers_spec.js"></script> <script src="print_spec.js"></script> + <script src="mock_spec.js"></script> + <script src="asynchronous_spec.js"></script> + <script src="skipping_spec.js"></script> <link rel="stylesheet" href="../lib/screw.css"> </head> - <body></body> + <body> + <div id="dom_test" style="position: absolute; left: -9999"></div> + </body> </html> \ No newline at end of file spec/suite.html 8cf1662de3b44262251f82508f294e6b2865db25 babc38c574eac0ad4b4919d930187412237774e8 David Chelimsky dchelimsky@gmail.com http://github.com/dchelimsky/screw-unit/commit/fb1695e2f63ef98859ed65c15a98a29572dee3a9 fb1695e2f63ef98859ed65c15a98a29572dee3a9 2008-09-24T11:42:28-07:00 2008-09-24T11:42:28-07:00 merged in remote branch tobowers 99734158ce3ca9ea09f0d8af651b2924b5b29b9b David Chelimsky dchelimsky@gmail.com