ember-try

An ember-cli addon to test against multiple bower and npm dependencies, such as ember and ember-data.

Installation

ember install ember-try

Limitations

Can only change versions for Ember 1.10+ due to template compiler changes that this addon does not attempt to handle.

Usage

This addon provides a few commands:

ember try:testall

This command will run ember test with each scenario's specified in the config and exit appropriately.

This command is especially useful to use on CI to test against multiple ember versions.

In order to use an alternate config path or to group various scenarios together in a single try:testall run, you can use the --config-path option.

  ember try:testall --config-path="config/legacy-scenarios.js"

If you need to know the scenario that is being ran (i.e. to customize a test output file name) you can use the EMBER_TRY_CURRENT_SCENARIO environment variable.

ember try <scenario> <command (Default: test)>

This command will run any ember-cli command with the specified scenario. The command will default to ember test.

For example:

  ember try ember-1.11-with-ember-data-beta-16 test

or

  ember try ember-1.11-with-ember-data-beta-16 serve

When running in a CI environment where changes are discarded you can skip reseting your environment back to its original state by specifying --skip-cleanup=true as an option to ember try. Warning: If you use this option and, without cleaning up, build and deploy as the result of a passing test suite, it will build with the last set of dependencies ember try was run with.

  ember try ember-1.11 test --skip-cleanup=true

In order to use an alternate config path or to group various scenarios, you can use the --config-path option.

  ember try ember-1.13 test --config-path="config/legacy-scenarios.js"

ember try:reset

This command restores the original bower.json from bower.json.ember-try, rm -rfs bower_components and runs bower install. For use if any of the other commands fail to clean up after (they run this by default on completion).

Config

Configuration will be read from a file in your ember app in config/ember-try.js. It should look like:

module.exports = {
  scenarios: [
    {
      name: 'Ember 1.10 with ember-data',
      bower: {
        dependencies: {
          'ember': '1.10.0',
          'ember-data': '1.0.0-beta.15'
        }
      }
    },
    {
      name: 'Ember 1.11.0-beta.5',
      bower: {
        dependencies: {
          'ember': '1.11.0-beta.5'
        }
      }
    },
    {
      name: 'Ember canary with Ember-Data 2.3.0',
      npm: {
        devDependencies: {
          'ember-data': '2.3.0'
        }
      },
      bower: {
        dependencies: {
          'ember': 'components/ember#canary'
        },
        resolutions: {
          'ember': 'canary'
        }
      }
    },
    {
      name: 'Ember beta',
      bower: {
        dependencies: {
          'ember': 'components/ember#beta'
        },
        resolutions: { // Resolutions are only necessary when they do not match the version specified in `dependencies`
          'ember': 'beta'
        }
      }
    }
  ]
};

Scenarios are sets of dependencies (bower and npm only). They can be specified exactly as in the bower.json or package.json The name can be used to try just one scenario using the ember try command.

If no config/ember-try.js file is present, the default config will be used. This is the current default config:

{
  scenarios: [
    {
      name: 'default',
      bower: {
        dependencies: { } /* No dependencies needed as the
                             default is already specified in
                             the consuming app's bower.json */
      }
    },
    {
      name: 'ember-release',
      bower: {
        dependencies: {
          ember: 'release'
        }
      }
    },
    {
      name: 'ember-beta',
      bower: {
        dependencies: {
          ember: 'beta'
        }
      }
    },
    {
      name: 'ember-canary',
      bower: {
        dependencies: {
          ember: 'canary'
        }
      }
    }
  ]
}

See an example of using ember-try for CI here, and the resulting build output.

Special Thanks

• Much credit is due to Edward Faulkner The scripts in liquid-fire that test against multiple ember versions were the inspriation for this project.