@@ -1,9 +1,41 @@ -This fork adds asynchronous testing: +# 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: +Examples: it('tests something after 3 seconds', function(me){ var x = false; setTimeout(some_magic_function, 1000); @@ -19,13 +51,14 @@ This fork adds asynchronous testing: expect(x).to(be_true); setTimeout(some_other_magic_function, 1000); using(me).wait(3).and_then(function(){ - expect(x).to(be_true); + expect(x).to(be_false); }); }); }) -This fork adds mocking support for your javascript tests +# 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 @@ -33,7 +66,7 @@ This fork adds mocking support for your javascript tests Docs online at: [http://toppingdesign.com/mock_docs/](http://toppingdesign.com/mock_docs/) - examples: +Examples: // DOM mocking TH.insertDomMock("some_mock"); // will insert dom_mocks/some_mock.html into <div id="dom_test"></div> README.markdown @@ -6,7 +6,10 @@ Screw.Defaults.to_run = 'body > .describe > .describes > .describe'; $('.status').fn({ display: function() { $(this).text( - $('.passed').length + $('.failed').length + ' finished, ' + $('.failed').length + ' failure(s), ' + $('.async').length + ' running asynchronous test(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)' ); } }); @@ -47,6 +50,8 @@ Screw.Defaults.to_run = 'body > .describe > .describes > .describe'; }, run: function() { + if ($(this).hasClass('skipped')){return} + try { try { $(this).fn('parent').fn('run_befores'); @@ -76,11 +81,11 @@ Screw.Defaults.to_run = 'body > .describe > .describes > .describe'; }); $('.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'); lib/screw.behaviors.js @@ -2,23 +2,33 @@ var Screw = (function($) { var screw = { Unit: function(fn) { var contents = fn.toString().match(/^[^\{]*{((.*\n*)*)}/m)[1]; - var fn = new Function("matchers", "specifications", "asynchronous", - "with (specifications) { with (matchers) { with (asynchronous) {" + 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, Screw.Asynchronous); + fn.call(this, Screw.Matchers, Screw.Specifications, Screw.Utilities); Screw.Specifications.context.pop(); $(this).dequeue(); }); }, - Asynchronous: { + 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 ) { @@ -41,7 +51,7 @@ var Screw = (function($) { }; var async_count = me.data('async_waiting_count') || 0 - me.data('async_waiting_count', async_count+1) + me.data('async_waiting_count', async_count + 1) me.addClass('async'); 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 @@ -26,12 +26,14 @@ .removeClass('passed'); }) .bind('passed', function() { + 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') @@ -43,6 +45,25 @@ .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('Starting...'); lib/screw.events.js @@ -15,6 +15,7 @@ <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> spec/suite.html 0d30a5dce2007857d55b5140b9700346f8c6c684 Raymond Cohen ray@raymond-cohens-macbook-pro.local http://github.com/tobowers/screw-unit/commit/3ddafb86ece4bae7f5e111fa7cc38311fd21ffb4 3ddafb86ece4bae7f5e111fa7cc38311fd21ffb4 2008-08-12T13:55:47-07:00 2008-08-12T13:55:47-07:00 Adding test-skipping functionality, part 2 d2ee1e2bc7cfc2e36feec5367827c5e5c01f864a Raymond Cohen ray@raymond-cohens-macbook-pro.local