ember-mocha2

ember-mocha2 simplifies testing of Ember applications with Mocha by providing Mocha-specific wrappers around the helpers contained in @ember/test-helpers.

IMPORTANT!!!

I've found it increasingly more difficult to updgrade this plugin past Ember 3.28. For people who are looking to potentially migrate away from ember-mocha, I've created a codemod to help with the transition. As such I will not be making updates to this repo and consider this package deprecated.

Compatibility

• Ember.js v3.16 or above
• Ember CLI v3.16 or above
• Node.js 10 or above

Installation

ember-mocha2 is an Ember CLI addon, so install it as you would any other addon:

$ ember install ember-mocha2

or

$ yarn add ember-mocha2 --dev

if you want to keep ember-mocha you can point it at the ember-mocha-compat branch in your package.json.

"devDependencies": {
  "ember-mocha": "yads/ember-mocha#ember-mocha-compat"
}

Usage

The following section describes the use of Ember Mocha with the latest modern Ember testing APIs, as laid out in the RFCs 232 and 268.

Setting the Application

Your tests/test-helper.js file should look similar to the following, to correctly setup the application required by @ember/test-helpers:

import Application from '../app';
import config from '../config/environment';
import { setApplication } from '@ember/test-helpers';
import { start } from 'ember-mocha';
import chai from 'chai';
import chaiDom from 'chai-dom';
chai.use(chaiDom)

setApplication(Application.create(config.APP));
start();

Also make sure that you have set ENV.APP.autoboot = false; for the test environment in your config/environment.js.

Setup Tests

The setupTest() function can be used to setup a unit test for any kind of "module/unit" of your application that can be looked up in a container.

It will setup your test context with:

• this.owner to interact with Ember's Dependency Injection system
• this.set(), this.setProperties(), this.get(), and this.getProperties()
• this.pauseTest() method to allow easy pausing/resuming of tests

For example, the following is a unit test for the SidebarController:

import { expect } from 'chai';
import { describe, it } from 'mocha';
import { setupTest } from 'ember-mocha';

describe('SidebarController', function() {
  setupTest();

  // Replace this with your real tests.
  it('exists', function() {
    let controller = this.owner.lookup('controller:sidebar');
    expect(controller).to.be.ok;
  });
});

If you find that test helpers from other addons want you to pass a hooks object you can do so like this:

let hooks = setupTest();
setupMirage(hooks);

This will make sure that in functions passed to hooks.afterEach() the this.owner and other things that setupTest() sets up are still available. Mocha itself runs afterEach hooks in a different order than QUnit, which is why this "workaround" is sometimes needed.

Sometimess you will need to specify that tests should not wait for settled state. If you see timeout errors in an afterEach hook for your tests update your setupTest cal:

describe('SidebarController', function() {
  setupTest({ waitForSettled: false });

Setup Rendering Tests

The setupRenderingTest() function is specifically designed for tests that render arbitrary templates, including components and helpers.

It will setup your test context the same way as setupTest(), and additionally:

• Initializes Ember's renderer to be used with the Rendering helpers, specifically render()
• Adds this.element to your test context which returns the DOM element representing the wrapper around the elements that were rendered via render()
• sets up the DOM Interaction Helpers from @ember/test-helpers (click(), fillIn(), ...)

import { expect } from 'chai';
import { describe, it } from 'mocha';
import { setupRenderingTest } from 'ember-mocha';
import { render } from '@ember/test-helpers';
import hbs from 'htmlbars-inline-precompile';

describe('GravatarImageComponent', function() {
  setupRenderingTest();

  it('renders', async function() {
    await render(hbs`{{gravatar-image}}`);
    expect(this.element.querySelector('img')).to.exist;
  });
});

Setup Application Tests

The setupApplicationTest() function can be used to run tests that interact with the whole application, so in most cases acceptance tests.

On top of setupTest() it will:

• Boot your application instance
• Set up all the DOM Interaction Helpers (click(), fillIn(), ...) as well as the Routing Helpers (visit(), currentURL(), ...) from @ember/test-helpers

import { expect } from 'chai';
import { describe, it } from 'mocha';
import { setupApplicationTest } from 'ember-mocha';
import { visit, currentURL } from '@ember/test-helpers';

describe('basic acceptance test', function() {
  setupApplicationTest();

  it('can visit /', async function() {
    await visit('/');
    expect(currentURL()).to.equal('/');
  });
});

Upgrading

For instructions how to upgrade your test suite please read our Migration Guide.

Contributing

Contributions are welcome. Please follow the instructions below to install and test this library.

Installation

yarn

Testing

In order to test in the browser:

yarn test --server

In order to perform a CI test:

yarn test

Copyright and License

Copyright 2014 Switchfly

This product includes software developed at Switchfly (http://www.switchfly.com).

NOTICE: Only our own original work is licensed under the terms of the Apache License Version 2.0. The licenses of some libraries might impose different redistribution or general licensing terms than those stated in the Apache License. Users and redistributors are hereby requested to verify these conditions and agree upon them.