sproutit-sproutcore 1.0.20090721145236 → 1.0.20090721145251

data/frameworks/sproutcore/frameworks/testing/system/runner.js

@@ -0,0 +1,209 @@
+// ==========================================================================
+// Project:   SproutCore Costello - Property Observing Library
+// Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
+//            Portions ©2008-2009 Apple, Inc. All rights reserved.
+// License:   Licened under MIT license (see license.js)
+// ==========================================================================
+
+/*globals CoreTest Q$ */
+
+sc_require('jquery');
+sc_require('system/plan');
+
+/** @static
+  The runner will automatically run the default CoreTest.plan when the 
+  document is fully loaded.  It will also act as a delegate on the plan, 
+  logging the output to the screen or console.
+
+  @since SproutCore 1.0
+*/
+
+
+CoreTest.Runner = {
+  
+  /**
+    The CoreTest plan.  If not set, a default plan will be created.
+  */
+  plan: null,
+  errors: null,
+  
+  create: function() {
+    var len = arguments.length,
+        ret = CoreTest.beget(this),
+        idx ;
+        
+    for(idx=0;idx<len;idx++) CoreTest.mixin(ret, arguments[len]);
+    if (!ret.plan) ret.plan = CoreTest.Plan.create({ delegate: ret });
+    Q$(window).load(function() { ret.begin(); });      
+    return ret ;
+  },
+  
+  begin: function() {
+    var plan = CoreTest.plan;
+    plan.delegate = this;
+    plan.run();
+  },
+  
+  planDidBegin: function(plan) {
+    // setup the report DOM element.
+    this.report = Q$(['<div class="core-test">',
+      '<div class="useragent">UserAgent</div>',
+      '<div class="testresult">',
+        '<label class="hide-passed">',
+          '<input type="checkbox" checked="checked" /> Hide passed tests',
+        '</label>',
+        '<span class="status">Running...</span>',
+      '</div>',
+      '<div class="detail">',
+        '<table>',
+          '<thead><tr>',
+            '<th class="desc">Test</th><th>Result</th>',
+          '</tr></thead>',
+          '<tbody><tr></tr></tbody>',
+        '</table>',
+      '</div>',
+    '</div>'].join(''));
+
+      
+    this.report.find('.useragent').html(navigator.userAgent);
+    this.logq = this.report.find('tbody');
+    this.testCount = 0 ;
+    
+    // listen to change event
+    var runner = this;
+    this.checkbox = this.report.find('.hide-passed input'); 
+    this.checkbox.change(function() {
+      runner.hidePassedTestsDidChange();
+    });
+    
+    Q$('body').append(this.report);
+  },
+  
+  hidePassedTestsDidChange: function() {
+    var checked = !!this.checkbox.val();
+        
+    if (checked) {
+      this.logq.addClass('hide-clean');
+    } else {
+      this.logq.removeClass('hide-clean');
+    }
+  },
+  
+  planDidFinish: function(plan, r) {
+    this.flush();
+    
+    var result = this.report.find('.testresult .status');
+    var str = CoreTest.fmt('<span>Completed %@ tests in %@ msec. </span>'
+              +'<span class="total">%@</span> total assertions: ', r.tests, 
+              r.runtime, r.total);
+    
+    if (r.passed > 0) {
+      str += CoreTest.fmt('&nbsp;<span class="passed">%@ passed</span>', r.passed);
+    }
+    
+    if (r.failed > 0) {
+      str += CoreTest.fmt('&nbsp;<span class="failed">%@ failed</span>', r.failed);
+    }
+
+    if (r.errors > 0) {
+      str += CoreTest.fmt('&nbsp;<span class="errors">%@ error%@</span>', 
+            r.errors, (r.errors !== 1 ? 's' : ''));
+    }
+
+    if (r.warnings > 0) {
+      str += CoreTest.fmt('&nbsp;<span class="warnings">%@ warnings%@</span>',
+            r.warnings, (r.warnings !== 1 ? 's' : ''));
+    }
+
+    // if all tests passed, disable hiding them.  if some tests failed, hide
+    // them by default.
+    if (this.errors) this.errors.push('</tr></tbody></table>');
+    if ((r.failed + r.errors + r.warnings) > 0) {
+      this.hidePassedTestsDidChange(); // should be checked by default
+    } else {
+      this.report.find('.hide-passed').addClass('disabled')
+        .find('input').attr('disabled', true);
+      if (this.errors) this.errors.length = 0;
+    }     
+    if(CoreTest.showUI) Q$('.core-test').css("right", "360px");
+    result.html(str);
+    
+    if (this.errors) CoreTest.errors=this.errors.join('');
+  },
+  
+  planDidRecord: function(plan, module, test, assertions, timings) {
+    var name = test, 
+        s    = { passed: 0, failed: 0, errors: 0, warnings: 0 }, 
+        len  = assertions.length, 
+        clean = '', 
+        idx, cur, q;
+    
+    for(idx=0;idx<len;idx++) s[assertions[idx].result]++;
+    if ((s.failed + s.errors + s.warnings) === 0) clean = "clean" ;
+    
+    if (module) name = module + " module: " + test ;
+    name = CoreTest.fmt('%@ - %@msec', name, timings.total_end - timings.total_begin);
+    // place results into a single string to append all at once.
+    var logstr = this.logstr ;
+    var errors =this.errors;
+    if (!logstr) logstr = this.logstr = [];
+    if (!this.errors) {
+      this.errors = ['<style type="text/css">* {font: 12px arial;}'+
+                    '.passed { background-color: #80D175; color: white;}'+
+                    '.failed { background-color: #ea4d4; color: black; }'+
+                    '.errors { background-color: red; color: black; }'+
+                    '.warnings { background-color: #E49723; color: black;}'+
+                    '.desc { text-align: left;}'+
+                    '</style><table style="border:1px solid"><thead>'+
+                    '<tr><th class="desc">'+navigator.userAgent+
+                    '</th><th>Result</th></tr>'+
+                    '</thead><tbody><tr>'];
+    }
+    logstr.push(CoreTest.fmt('<tr class="test %@"><th class="desc" colspan="2">'+
+          '%@ (<span class="passed">%@</span>, <span class="failed">%@</span>,'+
+          ' <span class="errors">%@</span>, <span class="warnings">%@</span>)'+
+          '</th></tr>', clean, name, s.passed, s.failed, s.errors, s.warnings));
+    if(s.failed>0 || s.errors>0){
+      this.errors.push(CoreTest.fmt('<tr class="test %@">'+
+          '<th style="background:grey; color:white" class="desc" colspan="2">'+
+          '%@ (<span class="passed">%@</span>, <span class="failed">%@</span>'+
+          ', <span class="errors">%@</span>, <span class="warnings">%@</span>'+
+          ')</th></tr>', clean, name, s.passed, s.failed, s.errors, s.warnings));  
+    }
+    
+    len = assertions.length;
+    for(idx=0;idx<len;idx++) {
+      cur = assertions[idx];
+      clean = cur.result === CoreTest.OK ? 'clean' : 'dirty';
+      logstr.push(CoreTest.fmt('<tr class="%@"><td class="desc">%@</td>'
+          +'<td class="action %@">%@</td></tr>', clean, cur.message, cur.result, 
+          (cur.result || '').toUpperCase()));
+      if(clean=='dirty'){
+        this.errors.push(CoreTest.fmt('<tr class="%@"><td class="desc">%@</td>'
+        +'<td class="action %@">%@</td></tr>', clean, cur.message, cur.result,
+        (cur.result || '').toUpperCase()));
+      }
+    }
+    
+    this.testCount++;
+    this.resultStr = CoreTest.fmt("Running – Completed %@ tests so far.", this.testCount);
+  },
+  
+  // called when the plan takes a break.  Good time to flush HTML output.
+  planDidPause: function(plan) {
+    if(navigator.userAgent.indexOf('MSIE')==-1) this.flush();  
+  },
+  
+  // flush any pending HTML changes...
+  flush: function() {
+    var logstr = this.logstr,
+        resultStr = this.resultStr,
+        result = this.report.find('.testresult .status');
+        
+    if (logstr) this.logq.append(this.logstr.join('')) ;
+    
+    if (resultStr) result.html(resultStr);
+    this.resultStr = this.logstr = null ;
+  }
+  
+};

data/frameworks/sproutcore/frameworks/testing/system/suite.js

@@ -0,0 +1,228 @@
+// ==========================================================================
+// Project:   SproutCore Costello - Property Observing Library
+// Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
+//            Portions ©2008-2009 Apple, Inc. All rights reserved.
+// License:   Licened under MIT license (see license.js)
+// ==========================================================================
+
+/*globals CoreTest module */
+
+/** @class
+
+  A test Suite defines a group of reusable unit tests that can be added to a 
+  test plan at any time by calling the generate() method.  Suites are most
+  useful for defining groups of tests that validate compliance with a mixin.
+  You can then generate customized versions of the test suite for different
+  types of objects to ensure that both the mixin and the object implementing
+  the mixin use the API properly.
+  
+  h1. Using a Suite
+  
+  To use a Suite, call the generate() method on the suite inside on of your
+  unit test files.  This will generate new modules and tests in the suite
+  and add them to your test plan.
+  
+  Usually you will need to customize the suite to apply to a specific object.
+  You can supply these customizations through an attribute hash passed to the
+  generate() method.  See the documentation on the specific test suite for
+  information on the kind of customizations you may need to provide.
+  
+  h2. Example
+  
+  {{{
+    // generates the SC.ArrayTestSuite tests for a built-in array.
+    SC.ArrayTests.generate('Array', {
+      newObject: function() { return []; }
+    });
+  }}}
+  
+  h1. Defining a Suite
+  
+  To define a test suite, simply call the extend() method, passing any 
+  attributs you want to define on the stuie along with this method.  You can
+  then add functions that will define the test suite with the define() method.
+  
+  Functions you pass to define will have an instance of the test suite passed
+  as their first parameter when invoked.
+
+  h2. Example 
+  
+  {{{
+    SC.ArrayTests = CoreTest.Suite.create("Verify SC.Array compliance", {
+      
+      // override to generate a new object that implements SC.Array
+      newObject: function() { return null; }
+    });
+    
+    SC.ArrayTests.define(function(T) {
+      T.module("length tests");
+      
+      test("new length", function() {
+        equals(T.object.get('length'), 0, 'array length');
+      });
+      
+    });
+  }}}
+  
+  @since SproutCore 1.0
+  
+*/
+CoreTest.Suite = /** @scope CoreTest.Suite.prototype */ {
+
+  /**
+    Call this method to define a new test suite.  Pass one or more hashes of
+    properties you want added to the new suite.  
+    
+    @param {Hash} attrs one or more attribute hashes
+    @returns {CoreTest.Suite} subclass of suite.
+  */
+  create: function(desc, attrs) {
+    var len = arguments.length,
+        ret = CoreTest.beget(this),
+        idx;
+        
+    // copy any attributes
+    for(idx=1;idx<len;idx++) CoreTest.mixin(ret, arguments[idx]);
+    
+    if (desc) ret.basedesc = desc;
+    
+    // clone so that new definitions will be kept separate
+    ret.definitions = ret.definitions.slice();
+    
+    return ret ;
+  },
+
+  /**
+    Generate a new test suite instance, adding the suite definitions to the 
+    current test plan.  Pass a description of the test suite as well as one or
+    more attribute hashes to apply to the test plan.
+    
+    The description you add will be prefixed in front of the 'desc' property
+    on the test plan itself.
+    
+    @param {String} desc suite description
+    @param {Hash} attrs one or more attribute hashes
+    @returns {CoreTest.Suite} suite instance
+  */
+  generate: function(desc, attrs) {
+    var len = arguments.length,
+        ret = CoreTest.beget(this),
+        idx, defs;
+        
+    // apply attributes - skip first argument b/c it is a string
+    for(idx=1;idx<len;idx++) CoreTest.mixin(ret, arguments[idx]);    
+    ret.subdesc = desc ;
+    
+    // invoke definitions
+    defs = ret.definitions ;
+    len = defs.length;
+    for(idx=0;idx<len;idx++) defs[idx].call(ret, ret);
+    
+    return ret ;
+  },
+  
+  /**
+    Adds the passed function to the array of definitions that will be invoked
+    when the suite is generated.
+    
+    The passed function should expect to have the TestSuite instance passed
+    as the first and only parameter.  The function should actually define 
+    a module and tests, which will be added to the test suite.
+    
+    @param {Function} func definition function
+    @returns {CoreTest.Suite} receiver
+  */
+  define: function(func) {
+    this.definitions.push(func);
+    return this ;
+  },
+  
+  /** 
+    Definition functions.  These are invoked in order when  you generate a 
+    suite to add unit tests and modules to the test plan.
+  */
+  definitions: [],
+  
+  /**
+    Generates a module description by merging the based description, sub 
+    description and the passed description.  This is usually used inside of 
+    a suite definition function.
+    
+    @param {String} str detailed description for this module
+    @returns {String} generated description
+  */
+  desc: function(str) {
+    return this.basedesc.fmt(this.subdesc, str);
+  },
+  
+  /**
+    The base description string.  This should accept two formatting options,
+    a sub description and a detailed description.  This is the description
+    set when you call extend()
+  */
+  basedesc: "%@ > %@",
+  
+  /**
+    Default setup method for use with modules.  This method will call the
+    newObject() method and set its return value on the object property of 
+    the receiver.
+  */
+  setup: function() {
+    this.object = this.newObject();
+  },
+  
+  /**
+    Default teardown method for use with modules.  This method will call the
+    destroyObejct() method, passing the current object property on the 
+    receiver.  It will also clear the object property.
+  */
+  teardown: function() {
+    if (this.object) this.destroyObject(this.object);
+    this.object = null;
+  },
+  
+  /**
+    Default method to create a new object instance.  You will probably want
+    to override this method when you generate() a suite with a function that
+    can generate the type of object you want to test.
+    
+    @returns {Object} generated object
+  */
+  newObject: function() { return null; },
+  
+  /**
+    Default method to destroy a generated object instance after a test has 
+    completed.  If you override newObject() you can also overried this method
+    to cleanup the object you just created.
+    
+    Default method does nothing.
+  */
+  destroyObject: function(obj) { 
+    // do nothing.
+  },
+  
+  /**
+    Generates a default module with the description you provide.  This is 
+    a convenience function for use inside of a definition function.  You could
+    do the same thing by calling:
+    
+    {{{
+      var T = this ;
+      module(T.desc(description), {
+        setup: function() { T.setup(); },
+        teardown: function() { T.teardown(); }
+      }
+    }}}
+    
+    @param {String} desc detailed descrition
+    @returns {CoreTest.Suite} receiver
+  */
+  module: function(desc) {
+    var T = this ;
+    module(T.desc(desc), {
+      setup: function() { T.setup(); },
+      teardown: function() { T.teardown(); }
+    });
+  }
+  
+};

data/frameworks/sproutcore/frameworks/testing/utils.js

@@ -0,0 +1,62 @@
+// ==========================================================================
+// Project:   SproutCore Unit Testing Library
+// Copyright: ©2006-2009 Sprout Systems, Inc. and contributors.
+//            Portions ©2008-2009 Apple, Inc. All rights reserved.
+// License:   Licened under MIT license (see license.js)
+// ==========================================================================
+
+// These utility methods are included from the SproutCore's foundation to 
+// make it easier write unit tests.  They only install themselves if a method
+// has not already been defined.
+
+if (!String.prototype.camelize) {
+  String.prototype.camelize = function camelize() {
+    var ret = this.replace(SC.STRING_TITLEIZE_REGEXP, 
+      function(str,separater,character) { 
+        return (character) ? character.toUpperCase() : '' ;
+      }) ;
+    var first = ret.charAt(0), lower = first.toLowerCase() ;
+    return (first !== lower) ? (lower + ret.slice(1)) : ret ;
+  };
+}
+
+if (!String.prototype.trim) {
+  String.prototype.trim = function trim() {
+    return this.replace(/^\s+|\s+$/g,"");
+  } ;
+}
+
+if (!String.prototype.fmt) {
+  String.prototype.fmt = function fmt() {
+    // first, replace any ORDERED replacements.
+    var args = arguments;
+    var idx  = 0; // the current index for non-numerical replacements
+    return this.replace(/%@([0-9]+)?/g, function(s, argIndex) {
+      argIndex = (argIndex) ? parseInt(argIndex,0)-1 : idx++ ;
+      s =args[argIndex];
+      return ((s===null) ? '(null)' : (s===undefined) ? '' : s).toString(); 
+    }) ;
+  } ;
+}
+
+if (!Array.prototype.uniq) {
+  Array.prototype.uniq = function uniq() {
+    var ret = [], len = this.length, item, idx ;
+    for(idx=0;idx<len;idx++) {
+      item = this[idx];
+      if (ret.indexOf(item) < 0) ret.push(item);
+    }
+    return ret ;
+  };
+}
+
+if (!String.prototype.w) {
+  String.prototype.w = function w() { 
+    var ary = [], ary2 = this.split(' '), len = ary2.length ;
+    for (var idx=0; idx<len; ++idx) {
+      var str = ary2[idx] ;
+      if (str.length !== 0) ary.push(str) ; // skip empty strings
+    }
+    return ary ;
+  };
+}