Class: CoreTest.Suite

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.

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.

Example

// generates the SC.ArrayTestSuite tests for a built-in array.
SC.ArrayTests.generate('Array', {
  newObject: function() { return []; }
});

Defining a Suite

To define a test suite, simply call the extend() method, passing any attributes you want to define on the suite 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.

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');
  });

});

Defined in: suite.js

Since:

SproutCore 1.0

Field Summary

Instance Methods

• create(attrs, attrs)
• define(func)
• desc(str)
• destroyObject(obj)
• generate(desc, attrs)
• module(desc)
• newObject()
• setup()
• teardown()

var T = this ;
module(T.desc(description), {
  setup: function() { T.setup(); },
  teardown: function() { T.teardown(); }
}