Ember.Test (public)

Defined in:	packages/ember-testing/lib/test.js:27
Module:	ember

checkWaiters public

Defined in packages/ember-testing/lib/test/waiters.js:76

Iterates through each registered test waiter, and invokes its callback. If any waiter returns false, this method will return true indicating that the waiters have not settled yet.

This is generally used internally from the acceptance/integration test infrastructure.

click (selector, context) RSVP.Promise<undefined> public

Defined in packages/ember-testing/lib/helpers/click.js:7

selector

String

jQuery selector for finding element on the DOM

context

Object

A DOM Element, Document, or jQuery to use as context

returns

RSVP.Promise<undefined>

Clicks an element and triggers any actions triggered by the element's click event.

Example:

click('.some-jQuery-selector').then(function() {
  // assert something
});

currentPath Object public

Defined in packages/ember-testing/lib/helpers/current_path.js:7

returns

Object

The currently active path.

Returns the current path.

Example:

function validateURL() {
equal(currentPath(), 'some.path.index', "correct path was transitioned into.");
}

click('#some-link-id').then(validateURL);

currentRouteName Object public

Defined in packages/ember-testing/lib/helpers/current_route_name.js:6

returns

Object

The name of the currently active route.

Returns the currently active route name.

Example:

function validateRouteName() {
equal(currentRouteName(), 'some.path', "correct route was transitioned into.");
}
visit('/some/path').then(validateRouteName)

currentURL Object public

Defined in packages/ember-testing/lib/helpers/current_url.js:7

returns

Object

The currently active URL.

Returns the current URL.

Example:

function validateURL() {
equal(currentURL(), '/some/path', "correct URL was transitioned into.");
}

click('#some-link-id').then(validateURL);

fillIn (selector, text) RSVP.Promise<undefined> public

Defined in packages/ember-testing/lib/helpers/fill_in.js:7

selector

String

jQuery selector finding an input element on the DOM to fill text with

text

String

text to place inside the input element

returns

RSVP.Promise<undefined>

Fills in an input element with some text.

Example:

fillIn('#email', '[email protected]').then(function() {
  // assert something
});

find (selector, context) Object public

Defined in packages/ember-testing/lib/helpers/find.js:7

selector

String

jQuery string selector for element lookup

context

String

(optional) jQuery selector that will limit the selector argument to find only within the context's children

returns

Object

jQuery object representing the results of the query

Finds an element in the context of the app's container element. A simple alias for app.$(selector).

Example:

var $el = find('.my-selector');

With the context param:

var $el = find('.my-selector', '.parent-element-class');

findWithAssert (selector, context) Object public

Defined in packages/ember-testing/lib/helpers/find_with_assert.js:5

selector

String

jQuery selector string for finding an element within the DOM

context

String

(optional) jQuery selector that will limit the selector argument to find only within the context's children

returns

Object

jQuery object representing the results of the query

Like find, but throws an error if the element selector returns no results.

Example:

var $el = findWithAssert('.doesnt-exist'); // throws error

With the context param:

var $el = findWithAssert('.selector-id', '.parent-element-class'); // assert will pass

injectTestHelpers public

Defined in packages/ember-testing/lib/ext/application.js:97

This injects the test helpers into the helperContainer object. If an object is provided it will be used as the helperContainer. If helperContainer is not set it will default to window. If a function of the same name has already been defined it will be cached (so that it can be reset if the helper is removed with unregisterHelper or removeTestHelpers).

Any callbacks registered with onInjectHelpers will be called once the helpers have been injected.

Example:

App.injectTestHelpers();

keyEvent (selector, type, keyCode) RSVP.Promise<undefined> public

Defined in packages/ember-testing/lib/helpers/key_event.js:5

selector

String

jQuery selector for finding element on the DOM

type

String

the type of key event, e.g. `keypress`, `keydown`, `keyup`

keyCode

Number

the keyCode of the simulated key event

returns

RSVP.Promise<undefined>

Simulates a key event, e.g. keypress, keydown, keyup with the desired keyCode Example:

keyEvent('.some-jQuery-selector', 'keypress', 13).then(function() {
 // assert something
});

onInjectHelpers (callback) public

Defined in packages/ember-testing/lib/test/on_inject_helpers.js:3

callback

Function

The function to be called.

Used to register callbacks to be fired whenever App.injectTestHelpers is called.

The callback will receive the current application as an argument.

Example:

Ember.Test.onInjectHelpers(function() {
  Ember.$(document).ajaxSend(function() {
    Test.pendingRequests++;
  });

  Ember.$(document).ajaxComplete(function() {
    Test.pendingRequests--;
  });
});

pauseTest Object public

Defined in packages/ember-testing/lib/helpers/pause_test.js:24

returns

Object

A promise that will never resolve

Pauses the current test - this is useful for debugging while testing or for test-driving. It allows you to inspect the state of your application at any point. Example (The test will pause before clicking the button):

visit('/')
return pauseTest();
click('.btn');

promise (resolver, label) public

Defined in packages/ember-testing/lib/test/promise.js:19

resolver

Function

The function used to resolve the promise.

label

String

An optional string for identifying the promise.

This returns a thenable tailored for testing. It catches failed onSuccess callbacks and invokes the Ember.Test.adapter.exception callback in the last chained then.

This method should be returned by async helpers such as wait.

registerAsyncHelper (name, helperMethod) public

Defined in packages/ember-testing/lib/test/helpers.js:43

name

String

The name of the helper method to add.

helperMethod

Function

registerAsyncHelper is used to register an async test helper that will be injected when App.injectTestHelpers is called.

The helper method will always be called with the current Application as the first parameter.

For example:

Ember.Test.registerAsyncHelper('boot', function(app) {
  Ember.run(app, app.advanceReadiness);
});

The advantage of an async helper is that it will not run until the last async helper has completed. All async helpers after it will wait for it complete before running.

For example:

Ember.Test.registerAsyncHelper('deletePost', function(app, postId) {
  click('.delete-' + postId);
});

// ... in your test
visit('/post/2');
deletePost(2);
visit('/post/3');
deletePost(3);

registerHelper (name, helperMethod, options) public

Defined in packages/ember-testing/lib/test/helpers.js:5

name

String

The name of the helper method to add.

helperMethod

Function

options

Object

registerHelper is used to register a test helper that will be injected when App.injectTestHelpers is called.

The helper method will always be called with the current Application as the first parameter.

For example:

Ember.Test.registerHelper('boot', function(app) {
  Ember.run(app, app.advanceReadiness);
});

This helper can later be called without arguments because it will be called with app as the first parameter.

App = Ember.Application.create();
App.injectTestHelpers();
boot();

registerWaiter (context, callback) public

Defined in packages/ember-testing/lib/test/waiters.js:6

context

Object

(optional)

callback

Function

This allows ember-testing to play nicely with other asynchronous events, such as an application that is waiting for a CSS3 transition or an IndexDB transaction. The waiter runs periodically after each async helper (i.e. click, andThen, visit, etc) has executed, until the returning result is truthy. After the waiters finish, the next async helper is executed and the process repeats.

For example:

Ember.Test.registerWaiter(function() {
  return myPendingTransactions() == 0;
});

The context argument allows you to optionally specify the this with which your callback will be invoked.

For example:

Ember.Test.registerWaiter(MyDB, MyDB.hasPendingTransactions);

removeTestHelpers public

Defined in packages/ember-testing/lib/ext/application.js:139

This removes all helpers that have been registered, and resets and functions that were overridden by the helpers.

Example:

App.removeTestHelpers();

resolve (The) public

Defined in packages/ember-testing/lib/test/promise.js:37

The

Mixed

value to resolve

Replacement for Ember.RSVP.resolve The only difference is this uses an instance of Ember.Test.Promise

resumeTest Void public

Defined in packages/ember-testing/lib/helpers/pause_test.js:11

returns

Void

Resumes a test paused by pauseTest.

setupForTesting public

Defined in packages/ember-testing/lib/ext/application.js:58

This hook defers the readiness of the application, so that you can start the app when your tests are ready to run. It also sets the router's location to 'none', so that the window's location will not be modified (preventing both accidental leaking of state between tests and interference with your testing framework). setupForTesting should only be called after setting a custom router class (for example App.Router = Router.extend().

Example:

App.setupForTesting();

triggerEvent (selector, context, type, options) RSVP.Promise<undefined> public

Defined in packages/ember-testing/lib/helpers/trigger_event.js:6

selector

String

jQuery selector for finding element on the DOM

context

String

jQuery selector that will limit the selector argument to find only within the context's children

type

String

The event type to be triggered.

options

Object

The options to be passed to jQuery.Event.

returns

RSVP.Promise<undefined>

Triggers the given DOM event on the element identified by the provided selector. Example:

triggerEvent('#some-elem-id', 'blur');

This is actually used internally by the keyEvent helper like so:

triggerEvent('#some-elem-id', 'keypress', { keyCode: 13 });

unregisterHelper (name) public

Defined in packages/ember-testing/lib/test/helpers.js:91

name

String

The helper to remove.

Remove a previously added helper method.

Example:

Ember.Test.unregisterHelper('wait');

unregisterWaiter (context, callback) public

Defined in packages/ember-testing/lib/test/waiters.js:49

context

Object

(optional)

callback

Function

unregisterWaiter is used to unregister a callback that was registered with registerWaiter.

visit (url) RSVP.Promise<undefined> public

Defined in packages/ember-testing/lib/helpers/visit.js:7

url

String

the name of the route

returns

RSVP.Promise<undefined>

Loads a route, sets up any controllers, and renders any templates associated with the route as though a real user had triggered the route change while using your app.

Example:

visit('posts/index').then(function() {
  // assert something
});

wait (value) RSVP.Promise<any> public

Defined in packages/ember-testing/lib/helpers/wait.js:10

value

Object

The value to be returned.

returns

RSVP.Promise<any>

Promise that resolves to the passed value.

Causes the run loop to process any pending events. This is used to ensure that any async operations from other helpers (or your assertions) have been processed.

This is most often used as the return value for the helper functions (see 'click', 'fillIn','visit',etc). However, there is a method to register a test helper which utilizes this method without the need to actually call wait() in your helpers.

The wait helper is built into registerAsyncHelper by default. You will not need to return app.testHelpers.wait(); - the wait behavior is provided for you.

Example:

Ember.Test.registerAsyncHelper('loginUser', function(app, username, password) {
  visit('secured/path/here')
    .fillIn('#username', username)
    .fillIn('#password', password)
    .click('.submit');
});