ember-addon-tests

Ember Addon Tests

Ember Addon Tests provides declarative test helpers for testing ember addons.

Motivation

Ember addons provide a great developer experience for most integration test cases out of the box. The dummy app allows to test components and services provided by the addon in the context of a consuming application. Ember-try helps to test the addon against different versions of dependencies.

But Ember addons do not provide a great test story for some less common cases:

• Addon installation (ember install addon) and blueprints run by it.
• Customization of the build process of a consuming application (e.g. AST transforms registered, pre- or postprocessors for JavaScript and CSS).
• CLI commands provided by the addon.
• Middleware added to the development server (ember serve).

Ember Addon Tests tries to fill that gap. It's inspired by Ember CLI Addon Tests. It could be seen as a rewrite of Ember CLI Addon Tests using a modernized architecture utilizing yarn workspaces.

Installation

• Ensure that ember-cli is installed globally.
• Install ember-addon-tests in your project.

If using NPM:

npm install --global ember-cli
npm install --save-dev ember-addon-tests

If using Yarn:

yarn global add ember-cli
yarn add --dev ember-addon-tests

Usage

const TestProject = require('ember-addon-tests');
const { expect } = require('chai');
const axios = require('axios');

// Create a new test project
let testProject = new TestProject({
  projectRoot: '/path-to/npm-package/or/yarn-workspace-root',
});

// Create a new ember application within your test project
await testProject.createEmberApp();

// Install addon under test in the test project
await testProject.addOwnPackageAsDevDependency(
  'name-of-a-npm-package-within-project-root'
);

// Build the application
await testProject.runEmberCommand('build', '--prod');

// Do some assertions against build
expect(
  await fs.stat(path.join(testProject.path, 'dist', 'vendor.js')).size
).to.be.lessThan(1 * 1024 * 1024);

// Start Ember's development server
await testProject.startEmberServer();

// Do some assertions against the running development server
let response = await axios.get('http://localhost:4200');
expect(response.headers).to.include({
  'content-security-policy': "default-src: 'none';"
});

// Stop Ember's development server again
await testProject.stopEmberServer();

TestProject.createEmberApp() and TestProject.createEmberAddon() methods use globally installed Ember CLI to create a new Ember project. They will use whatever Ember version is installed globally. Upgrade or downgrade globally installed Ember CLI to test your addon against different Ember CLI versions.

API

Please refer to source code as API documentation for now.

License

This project is licensed under the MIT License.

Changelog

v0.0.2 (2020-11-18)

:boom: Breaking Change

• #6 Always use globally installed Ember CLI to create new Ember projects (@jelhan)

:bug: Bug Fix

• #6 Always use globally installed Ember CLI to create new Ember projects (@jelhan)

Committers: 1

• Jeldrik Hanschke (@jelhan)