@ember/test-helpers

What is @ember/test-helpers?

@ember/test-helpers is a package that provides a set of utilities to facilitate testing in Ember.js applications. It offers a variety of helpers to interact with the DOM, handle asynchronous operations, and manage application state during tests.

What are @ember/test-helpers's main functionalities?

Rendering Helpers

Rendering helpers allow you to render components or templates in the test environment. This is useful for testing the output and behavior of your UI components.

import { render } from '@ember/test-helpers';
import { hbs } from 'ember-cli-htmlbars';

await render(hbs`<MyComponent />`);

DOM Interaction

DOM interaction helpers enable you to simulate user interactions such as clicking buttons or filling in input fields. This helps in testing how your application responds to user actions.

import { click, fillIn } from '@ember/test-helpers';

await click('.my-button');
await fillIn('.my-input', 'new value');

Asynchronous Helpers

Asynchronous helpers like `settled` ensure that all asynchronous operations have completed before proceeding with the test. This is crucial for testing asynchronous behavior in your application.

import { settled } from '@ember/test-helpers';

await settled();

Routing Helpers

Routing helpers allow you to navigate to different routes within your application during tests. This is useful for testing the behavior of your application in different states and routes.

import { visit } from '@ember/test-helpers';

await visit('/my-route');

Other packages similar to @ember/test-helpers

ember-qunit

ember-qunit provides QUnit-specific helpers for testing Ember.js applications. It integrates seamlessly with @ember/test-helpers and offers additional utilities for setting up and tearing down tests.

ember-mocha

ember-mocha offers Mocha-specific helpers for testing Ember.js applications. Similar to ember-qunit, it works well with @ember/test-helpers and provides a Mocha-based testing environment.

ember-cli-page-object

ember-cli-page-object is a library for creating page objects in Ember.js tests. It provides a higher-level API for interacting with your application's UI, making tests more readable and maintainable.

README

@ember/test-helpers

A test-framework-agnostic set of helpers for testing Ember.js applications

Compatibility

• Ember.js v4 or above
• Ember CLI v4 or above
• Node.js v16 or above
• TypeScript 5.0, 5.1, 5.2, 5.3, 5.4, and 5.5
  • SemVer policy: simple majors
  • the public API is defined by API.md.

Installation

For ember-qunit v5 and above

pnpm

pnpm add --dev @ember/test-helpers

npm

npm install --save-dev @ember/test-helpers

For ember-qunit v4 and below

If you are writing a regular Ember app or addon there is not much for you to do as ember-qunit (and ember-mocha) already include this package as a dependency. You only need to make sure that you are using a recent enough version of either one of these packages.

If you are working on ember-qunit or ember-mocha themselves you can install this package like any other regular Ember addon.

Usage

This package exports several helper functions that can be used to improve the testing experience when developing Ember.js apps or addons.

These helper functions include DOM interaction helpers (click(), fillIn(), ...), routing and rendering helpers (visit(), render(), ...) and some other things that make it easy to write good tests.

The full documentation can be found in the API reference.

Contributing

Installation

• git clone https://github.com/emberjs/ember-test-helpers.git
• cd ember-test-helpers
• pnpm install

Running tests

• cd test-app
• Multiple ways of running the tests
  • pnpm test
  • ember serve + visit /tests in the browser
  • ember test
  • ember test --server

Running the dummy application

• ember serve
• Visit the dummy application at http://localhost:4200.

For more information on using ember-cli, visit https://ember-cli.com/.

Attribution

Much of ember-test-helpers was extracted from the original ember-qunit, which was written by Stefan Penner, Robert Jackson, and Ryan Florence.

Copyright and License

Copyright 2015 Switchfly and contributors.

Dual-licensed under the Apache License, Version 2.0 and the MIT License.