Dummy

Welcome to Ember.js

Date: Sun, 11 Jan 2015 22:35:12 +0100 Subject: [PATCH 011/300] Update README with adapter-addons. --- README.md | 72 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index a8cf7d07..f1170972 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,6 @@ You can also have a look on how to use this ember-cli-addon in the following vid ![ember-deploy talk](http://img.youtube.com/vi/Ro2_I5vtTIg/0.jpg) -## Lightning-Approach Workflow (default) - -__Please watch Luke's Talk before using this project!__ - -The TL;DR of the talk is that you want to serve your bootstrap index.html that Ember-CLI builds for you from a Key-Value store via your Backend and serve the rest of your assets from a static file hoster like for example [S3](https://aws.amazon.com/de/s3/). This is a sketch of what this Addon gives you out of the box: - -![Workflow](https://dl.dropboxusercontent.com/s/tun9kbr4eyrcama/ember-deploy.png?dl=0) - -A deployment consists of multiple steps: - -1. Build your assets for production via `ember build --environment production` -2. Upload assets to S3. -3. Upload your bootstrap index.html to a key-value store. -4. Activate the uploaded index.html as the default revision your users will get served from your backend. - ## Installation Simply run @@ -49,6 +34,31 @@ This Ember-CLI Addon adds multiple deployment related tasks to your Ember-CLI Ap You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-deploy` will use the `development`-environment. +## Lightning-Approach Workflow + +`ember-deploy` is built around the idea of adapters for custom deployment strategies but for most people the approach Luke suggest in his talk will be a perfect fit. + +To use the Lightning-Approach workflow from Luke's talk you will also need to install the redis- and s3-adapters for `ember-deploy`: + +``` +npm install ember-deploy-redis ember-deploy-s3 --save-dev +``` + +__Please watch Luke's Talk before using this project!__ + +The TL;DR of the talk is that you want to serve your bootstrap index.html that Ember-CLI builds for you from a Key-Value store via your Backend and serve the rest of your assets from a static file hoster like for example [S3](https://aws.amazon.com/de/s3/). This is a sketch of what this Addon gives you out of the box: + +![Workflow](https://dl.dropboxusercontent.com/s/tun9kbr4eyrcama/ember-deploy.png?dl=0) + +A deployment consists of multiple steps: + +1. Build your assets for production via `ember build --environment production` +2. Upload assets to S3. +3. Upload your bootstrap index.html to a key-value store. +4. Activate the uploaded index.html as the default revision your users will get served from your backend. + +If you don't install the redis- and s3-adapters you will need to use a custom adapter you or the community have written. Please have a look at the Custom-Adapters section of this README for further information. In essence your custom adapters will implement the same steps as for the Lightning-Approach but you can customize the different steps as you see fit. + ## Config file `ember-deploy` expects a `deploy.json` file in the root of your Ember-CLI app directory. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An Example could look like this: @@ -107,11 +117,11 @@ This is an example of how one would use this addon to deploy an ember-cli app: ## S3-Asset uploads -`ember-deploy` sets the correct cache headers for you. Currently these are hard coded to a two year cache period. Assets are also gzipped before uploading to S3. This should be enough to cache aggressively and you should not run into problems due to ember-cli's fingerprinting support. I will try to add more configuration options for caching in the near future. +`ember-deploy-s3` sets the correct cache headers for you. Currently these are hard coded to a two year cache period. Assets are also gzipped before uploading to S3. This should be enough to cache aggressively and you should not run into problems due to ember-cli's fingerprinting support. I will try to add more configuration options for caching in the near future. ### Example Sinatra app -This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-deploy`. +This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-deploy` and `ember-deploy-redis`. ```ruby require 'sinatra' @@ -133,11 +143,15 @@ The nice thing about this is that you can deploy your app to production, test it ## Custom Adapters -`ember-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. `ember-deploy` comes bundled with the `redis`- and the `s3`-adapters that give you the deployment approach Luke talks about in his talk out of the box. +`ember-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. For `ember-deploy` to give you the deployment approach Luke talks about in his talk you will for example need to install the `ember-deploy-redis` and `ember-deploy-s3` adapters via npm. Because `ember-deploy` is built with adapters in mind you can write your own adapters for your project specific use cases. -Custom Adapters can be integrated via custom [Ember-CLI-Addons](http://www.ember-cli.com/#developing-addons-and-blueprints). For `ember-deploy` to integrate your custom adapter addons you have to define your addon-type as `ember-deploy-addon`. Here's a quick example of how you could structure your addon to add custom adapters. +Custom Adapters can be integrated via custom [Ember-CLI-Addons](http://www.ember-cli.com/#developing-addons-and-blueprints). For `ember-deploy` to integrate your custom adapter addons you have to define your addon-type as an `ember-deploy-addon`. + +You can have a look at [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3) and [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis) to get an idea how one would implement 'real-world'-adapters. + +For the sake of clarity here's a quick example of how you will structure your addon to add custom adapters. ```js //index.js in your custom addon @@ -155,6 +169,10 @@ function EmberDeploySuperAwesome() { }, assets: { // you can add multiple adapters in one ember-deploy-addon + }, + + tagging: { + // you can add multiple adapters in one ember-deploy-addon } }; } @@ -217,13 +235,23 @@ This method has to return a `RSVP.Promise`. ### Asset-Adapters -`asset-adapters` take care of publishing your project assets. In the default use case (Luke Melia's lightning approach) your assets will be published to a static asset server like AWS S3. If you want to use some other static asset server service or you want to do something entirely different you can write your own `asset-adapter`. Asset-Adapters have to implement the following method for ember-deploy know what to do: +`asset-adapters` take care of publishing your project assets. In the default use case (Luke Melia's lightning approach) your assets will be published to a static asset server like AWS S3. If you want to use some other static asset server service or you want to do something entirely different you can write your own `asset-adapter`. Asset-Adapters have to implement the following method for ember-deploy to know what to do: -####upload +####`upload` Ember deploy will gzip your `js` and `css` assets and copy these gzipped assets and all other assets from ember-cli's `dist`-folder to the `tmp/assets-sync`-directory. You can do whatever you want in an `asset-adapter`'s `upload`-method but most likely you will upload these assets to some kind of static-asset server with the `upload`-method. -This method has to return a `RSVP.Promise` +This method has to return a `RSVP.Promise`. + +### Tagging-Adapters + +`tagging-adapters` take care of tagging revisions when uploading revisions via the `deploy-index`-command. `ember-deploy` comes bundled with the `sha`-tagging-adapter that will tag your revisions according to the current git-sha. + +Tagging Adapters need to implement the following method for ember-deploy to know what to do: + +####`createTag` + +This method has to return a `String`. ### Contributing From 06f5d3cd4eddaae972b2e567352c7f4362c2cb7f Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 11 Jan 2015 22:47:45 +0100 Subject: [PATCH 012/300] 0.2.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00effa9d..4f86e6f5 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.1.0", + "version": "0.2.0", "directories": { "doc": "doc", "test": "tests" From b7959cd116d10ea0ac7da3c391ea46c26368adfa Mon Sep 17 00:00:00 2001 From: Philip Heinser Date: Wed, 14 Jan 2015 13:15:06 +0100 Subject: [PATCH 013/300] use redis with secret --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f1170972..00ef15cf 100644 --- a/README.md +++ b/README.md @@ -94,7 +94,8 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad "production": { "store": { "host": "production-redis.example.com", - "port": 6379 + "port": 6379, + "password": "" }, "assets": { "accessKeyId": "", From f20dba25b403042228740b1dbff96f85a82de1d8 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Thu, 15 Jan 2015 14:54:26 +0100 Subject: [PATCH 014/300] Compilable / usable on Windows: removed gitty dependency, added in execSync for getting a git HEAD hash, including tests. --- node-tests/unit/utilities/tagging/sha-test.js | 6 +++--- package.json | 2 +- utilities/tagging/sha.js | 9 ++++----- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 8ee53e05..513ee72d 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -1,5 +1,5 @@ var expect = require('chai').expect; -var git = require('gitty'); +var execSync = require('execSync'); var sinon = require('sinon'); var ShaTaggingAdapter = require('../../../../utilities/tagging/sha'); @@ -16,8 +16,8 @@ describe('ShaTaggingAdapter', function() { beforeEach(function() { sandbox = sinon.sandbox.create(); sandbox - .stub(git.Command.prototype, 'exec') - .yields('error', GIT_SHA, 'stderr'); + .stub(execSync, 'exec') + .returns({stdout: GIT_SHA}); }); afterEach(function() { diff --git a/package.json b/package.json index 4f86e6f5..00ac0231 100644 --- a/package.json +++ b/package.json @@ -47,7 +47,7 @@ "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", "core-object": "0.0.2", - "gitty": "^2.1.7", + "execSync": "^1.0.2", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", "ncp": "^1.0.1", diff --git a/utilities/tagging/sha.js b/utilities/tagging/sha.js index c9eb827f..0de1235d 100644 --- a/utilities/tagging/sha.js +++ b/utilities/tagging/sha.js @@ -1,17 +1,16 @@ var CoreObject = require('core-object'); -var git = require('gitty'); +var execSync = require('execSync'); module.exports = CoreObject.extend({ createTag: function() { - var command = new git.Command('./', 'rev-parse', [], 'HEAD'); - var executeSynchronously = true; + var commandResult = execSync.exec("git rev-parse HEAD").stdout; - command.exec(this._generateKey.bind(this), executeSynchronously); + this._generateKey(commandResult); return this.revisionKey; }, - _generateKey: function(_error, sha, _stderr) { + _generateKey: function(sha) { this.revisionKey = this.manifest+':'+sha.slice(0,7); } }); From dd88dd7890a98c9408ad4c608f99d27dfe0ca1be Mon Sep 17 00:00:00 2001 From: Philip Heinser Date: Mon, 19 Jan 2015 18:04:13 +0100 Subject: [PATCH 015/300] added nodes example --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 00ef15cf..3eec8e09 100644 --- a/README.md +++ b/README.md @@ -142,6 +142,10 @@ end The nice thing about this is that you can deploy your app to production, test it out by passing an index_key parameter with the revision you want to test and activate when you feel confident that everything is working as expected. +### Example nodejs app + +[Nodejs example with one click deploy!](https://github.com/philipheinser/ember-lightning) + ## Custom Adapters `ember-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. For `ember-deploy` to give you the deployment approach Luke talks about in his talk you will for example need to install the `ember-deploy-redis` and `ember-deploy-s3` adapters via npm. From aa2535ceedfbae84505b5a5ce1f003fbbdc9db02 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Tue, 20 Jan 2015 14:53:19 +0100 Subject: [PATCH 016/300] Updated README.md to feature existing adapters --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 00ef15cf..7709f717 100644 --- a/README.md +++ b/README.md @@ -202,6 +202,12 @@ After adding your custom ember-deploy-addon to your project as an ember-cli-addo } ``` +### Existing Custom Adapters +The following adapters have already been developed: +* [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis), index-adapter for [Redis](http://redis.io) +* [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3), assets-adapter for AWS [s3](aws.amazon.com/s3/) +* [ember-deploy-azure](https://github.com/duizendnegen/ember-deploy-azure), index-adapter and assets-adapter for Azure Tables & Blob Storage respectively + ### Index-Adapters `index-adapters` take care of publishing bootstrap-index html that ember-cli builds for you. If you don't want to use `redis` as a key-value store for your index.html files if you are using the Lightning approach from Luke Melia's talk you could for example create a `cassandra`-adapter to use [Apacha Cassandra](http://cassandra.apache.org/) instead. From f495c6f2c0f8981416081f560f4e9e0f825acd54 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Wed, 21 Jan 2015 19:23:22 +0100 Subject: [PATCH 017/300] Don't GZIP when specified it is not required (not all deployments like GZIP content) --- README.md | 3 ++- lib/tasks/assets.js | 21 ++++++++++++++++----- 2 files changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 7709f717..41051141 100644 --- a/README.md +++ b/README.md @@ -73,12 +73,13 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad }, "assets": { "type": "s3", // default asset-adapter is 's3' + "gzip": false, // if undefined or set to true, files are gziped "accessKeyId": "", "secretAccessKey": "", "bucket": "" } }, - + "staging": { "store": { "host": "staging-redis.example.com", diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 8d8112ac..9320b689 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -18,13 +18,24 @@ var TWO_YEAR_CACHE_PERIOD_IN_SEC = 60 * 60 * 24 * 365 * 2; module.exports = Task.extend({ run: function(options) { var broccoli = require('broccoli'); - var gzipFiles = require('broccoli-gzip'); - var gzipTree = gzipFiles('dist', { - extensions: ['js', 'css'], - appendSuffix: false + var config = new ConfigurationReader({ + environment: options.environment }); - var builder = new broccoli.Builder(gzipTree); + + var fileTreeOrPath; + if(config.assets.gzip === false) { + fileTreeOrPath = 'dist'; + } else { + var gzipFiles = require('broccoli-gzip'); + + fileTreeOrPath = gzipFiles('dist', { + extensions: ['js', 'css'], + appendSuffix: false + }); + } + + var builder = new broccoli.Builder(fileTreeOrPath); return builder.build() .then(this.processBuildResult.bind(this)) From 21c45b5a3a7cbe095d9359c2ac0298082e8e2ac5 Mon Sep 17 00:00:00 2001 From: Philip Heinser Date: Thu, 22 Jan 2015 02:34:29 +0100 Subject: [PATCH 018/300] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 3eec8e09..4d69b95c 100644 --- a/README.md +++ b/README.md @@ -144,6 +144,8 @@ The nice thing about this is that you can deploy your app to production, test it ### Example nodejs app +This app does the same as the *Sinatra app* from before, it supports the same index_key query param. It should help you to get up and running in seconds and dont worry about server code. You also need to deploy your ember app with `ember-deploy` and `ember-deploy-redis`. + [Nodejs example with one click deploy!](https://github.com/philipheinser/ember-lightning) ## Custom Adapters From c99539a45c111061a07bc9425d3a2dffd1737f4a Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Thu, 22 Jan 2015 16:51:23 +0100 Subject: [PATCH 019/300] 0.3.0 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 00ac0231..28aaf9fb 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.2.0", + "version": "0.3.0", "directories": { "doc": "doc", "test": "tests" From 2dc13f4403b0a3991452d30fdaa64a34c388a493 Mon Sep 17 00:00:00 2001 From: Tyler Love Date: Thu, 22 Jan 2015 11:40:28 -0500 Subject: [PATCH 020/300] Add support for `buildEnv` configuration option that allows you to specify what environment gets passed to the build process and override the default of `production`. Add readme for buildEnv --- README.md | 1 + deploy.json | 1 + lib/commands/deploy.js | 7 ++++++- utilities/configuration-reader.js | 1 + 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a3e99fcf..51f84891 100644 --- a/README.md +++ b/README.md @@ -81,6 +81,7 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad }, "staging": { + "buildEnv": "staging", // Override the environment passed to the ember asset build. Defaults to 'production' "store": { "host": "staging-redis.example.com", "port": 6379 diff --git a/deploy.json b/deploy.json index 094ea358..7c4b265f 100644 --- a/deploy.json +++ b/deploy.json @@ -12,6 +12,7 @@ }, "staging": { + "buildEnv": "staging", "store": { "host": "staging-redis.firstiwaslike.com", "port": 6379 diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index a773f771..e16e6157 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,3 +1,5 @@ +var ConfigurationReader = require('../../utilities/configuration-reader'); + module.exports = { name: 'deploy', description: 'Deploys an ember-cli app', @@ -12,6 +14,9 @@ module.exports = { var AssetsTask = require('../tasks/assets'); var BuildTask = this.tasks.Build; + var config = new ConfigurationReader({ + environment: commandOptions.environment + }); var buildTask = new BuildTask({ ui: this.ui, analytics: this.analytics, @@ -19,7 +24,7 @@ module.exports = { }); var buildOptions = { - environment: "production", + environment: config.buildEnv || 'production', outputPath: "dist/", watch: false, disableAnalytics: false diff --git a/utilities/configuration-reader.js b/utilities/configuration-reader.js index 737637da..7789232a 100644 --- a/utilities/configuration-reader.js +++ b/utilities/configuration-reader.js @@ -16,6 +16,7 @@ function ConfigurationReader(options) { this.store = this._config[this._environment].store; this.assets = this._config[this._environment].assets; + this.buildEnv = this._config[this._environment].buildEnv || 'production'; } module.exports = ConfigurationReader; From 7794a05feffaddad7100a3d2ef1373c065e517e3 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Thu, 29 Jan 2015 10:31:41 +0100 Subject: [PATCH 021/300] configure which files to gzip, defaulting to js, css & svg --- README.md | 1 + lib/tasks/assets.js | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 51f84891..f461670e 100644 --- a/README.md +++ b/README.md @@ -74,6 +74,7 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad "assets": { "type": "s3", // default asset-adapter is 's3' "gzip": false, // if undefined or set to true, files are gziped + "gzipExtensions": ["js", "css", "svg"], // if undefined, js, css & svg files are gziped "accessKeyId": "", "secretAccessKey": "", "bucket": "" diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 9320b689..91336439 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -22,15 +22,15 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment }); - + var fileTreeOrPath; if(config.assets.gzip === false) { fileTreeOrPath = 'dist'; } else { var gzipFiles = require('broccoli-gzip'); - + fileTreeOrPath = gzipFiles('dist', { - extensions: ['js', 'css'], + extensions: config.assets.gzipExtensions ? config.assets.gzipExtensions : ['js', 'css', 'svg'], appendSuffix: false }); } From 3b6682335a136f8fb61a1602102a7d7440f14c80 Mon Sep 17 00:00:00 2001 From: Kris Williams Date: Mon, 2 Feb 2015 21:17:47 -0800 Subject: [PATCH 022/300] add support for execSync in node >= 0.11 --- node-tests/unit/utilities/tagging/sha-test.js | 4 ++-- utilities/tagging/sha.js | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 513ee72d..35fdef1c 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -1,5 +1,5 @@ var expect = require('chai').expect; -var execSync = require('execSync'); +var exec = require('child_process').execSync || require('execSync').exec; var sinon = require('sinon'); var ShaTaggingAdapter = require('../../../../utilities/tagging/sha'); @@ -16,7 +16,7 @@ describe('ShaTaggingAdapter', function() { beforeEach(function() { sandbox = sinon.sandbox.create(); sandbox - .stub(execSync, 'exec') + .stub(exec, 'exec') .returns({stdout: GIT_SHA}); }); diff --git a/utilities/tagging/sha.js b/utilities/tagging/sha.js index 0de1235d..ae0b8d16 100644 --- a/utilities/tagging/sha.js +++ b/utilities/tagging/sha.js @@ -1,9 +1,9 @@ var CoreObject = require('core-object'); -var execSync = require('execSync'); +var exec = require('child_process').execSync || require('execSync').exec; module.exports = CoreObject.extend({ createTag: function() { - var commandResult = execSync.exec("git rev-parse HEAD").stdout; + var commandResult = exec("git rev-parse HEAD").stdout; this._generateKey(commandResult); From 3d9d2e45dd4d3ceed7439ef20d020a08daaaaa61 Mon Sep 17 00:00:00 2001 From: Kris Williams Date: Mon, 2 Feb 2015 21:56:46 -0800 Subject: [PATCH 023/300] fix sha unit test for execSync --- node-tests/unit/utilities/tagging/sha-test.js | 14 ++++++++++---- utilities/tagging/sha.js | 9 ++++++--- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 35fdef1c..1af2268c 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -1,5 +1,4 @@ var expect = require('chai').expect; -var exec = require('child_process').execSync || require('execSync').exec; var sinon = require('sinon'); var ShaTaggingAdapter = require('../../../../utilities/tagging/sha'); @@ -15,9 +14,16 @@ describe('ShaTaggingAdapter', function() { beforeEach(function() { sandbox = sinon.sandbox.create(); - sandbox - .stub(exec, 'exec') - .returns({stdout: GIT_SHA}); + if (require('child_process').execSync) { + sandbox + .stub(require('child_process'), 'execSync') + .returns(GIT_SHA); + } else { + // Node 0.10 + sandbox + .stub(require('execSync'), 'exec') + .returns({stdout: GIT_SHA}); + } }); afterEach(function() { diff --git a/utilities/tagging/sha.js b/utilities/tagging/sha.js index ae0b8d16..f3faf358 100644 --- a/utilities/tagging/sha.js +++ b/utilities/tagging/sha.js @@ -1,10 +1,13 @@ var CoreObject = require('core-object'); -var exec = require('child_process').execSync || require('execSync').exec; module.exports = CoreObject.extend({ createTag: function() { - var commandResult = exec("git rev-parse HEAD").stdout; - + var commandResult; + if (require('child_process').execSync) { + commandResult = require('child_process').execSync("git rev-parse HEAD"); + } else { + commandResult = require('execSync').exec("git rev-parse HEAD").stdout; + } this._generateKey(commandResult); return this.revisionKey; From 41ed6c5e299cd251f10c0dd9257b07a60a5af00a Mon Sep 17 00:00:00 2001 From: Kris Williams Date: Mon, 2 Feb 2015 22:13:26 -0800 Subject: [PATCH 024/300] add node 0.11 to travis config --- .travis.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.travis.yml b/.travis.yml index c5a01254..f2a202f4 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,10 @@ language: node_js sudo: false +node_js: + - "0.10.36" + - "0.11" + cache: directories: - node_modules From d24a76f8db82f92bb70495e58432b2e240a32150 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 8 Feb 2015 13:36:16 +0100 Subject: [PATCH 025/300] Add changelog. --- CHANGELOG.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..7a051405 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,5 @@ +# Ember-Deploy Changelog + +### 0.3.1 (February 08, 2015) + +- support node version >= 0.11 #36 (thx @kriswill) From ce72e094b35642bb78b2cecbdc2599ec88742991 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 8 Feb 2015 13:36:24 +0100 Subject: [PATCH 026/300] 0.3.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 28aaf9fb..6d47498f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.3.0", + "version": "0.3.1", "directories": { "doc": "doc", "test": "tests" From 70031523ce30b3601b2ff709d357392bf73a08fc Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 8 Feb 2015 13:48:43 +0100 Subject: [PATCH 027/300] Match changelog format with ember.js format. --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a051405..070d0c53 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,4 +2,4 @@ ### 0.3.1 (February 08, 2015) -- support node version >= 0.11 #36 (thx @kriswill) +- [#32](https://github.com/LevelbossMike/ember-deploy/pull/32) add support for execSync in node >= 0.11 [@kriswill](https://github.com/kriswill) From 283491a884497473ce7c78329fe18c334ae5d190 Mon Sep 17 00:00:00 2001 From: Philip Poots Date: Fri, 20 Feb 2015 15:09:51 +0100 Subject: [PATCH 028/300] Link to new S3 Index --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f461670e..7d20ff0b 100644 --- a/README.md +++ b/README.md @@ -214,7 +214,8 @@ After adding your custom ember-deploy-addon to your project as an ember-cli-addo ### Existing Custom Adapters The following adapters have already been developed: * [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis), index-adapter for [Redis](http://redis.io) -* [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3), assets-adapter for AWS [s3](aws.amazon.com/s3/) +* [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3), assets-adapter for AWS [S3](http://aws.amazon.com/s3/) +* [ember-deploy-s3-index](https://github.com/Kerry350/ember-deploy-s3-index), index-adapter for AWS [S3](http://aws.amazon.com/s3/) * [ember-deploy-azure](https://github.com/duizendnegen/ember-deploy-azure), index-adapter and assets-adapter for Azure Tables & Blob Storage respectively ### Index-Adapters From 35be7f55c5d3af0983d015788e32d402cd598728 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Escoyez Date: Mon, 19 Jan 2015 22:30:30 +0100 Subject: [PATCH 029/300] Allow custom config file via --deploy-config-file and support .js. Based on work from jbescoyez --- README.md | 42 ++++++++++++------- lib/commands/activate.js | 3 +- lib/commands/assets.js | 3 +- lib/commands/deploy-index.js | 3 +- lib/commands/deploy.js | 6 ++- lib/commands/list.js | 3 +- lib/tasks/activate.js | 3 +- lib/tasks/assets.js | 12 +++--- lib/tasks/deploy-index.js | 3 +- lib/tasks/list.js | 3 +- node-tests/fixtures/deploy.js | 26 ++++++++++++ .../utilities/configuration-reader-test.js | 15 ++++++- 12 files changed, 93 insertions(+), 29 deletions(-) create mode 100644 node-tests/fixtures/deploy.js diff --git a/README.md b/README.md index 7d20ff0b..0667ed94 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,8 @@ This Ember-CLI Addon adds multiple deployment related tasks to your Ember-CLI Ap You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-deploy` will use the `development`-environment. +You can pass `--deploy-config-file ` to every command. If you don't pass a deploy-config-file explicitly `deploy.json` will be read. + ## Lightning-Approach Workflow `ember-deploy` is built around the idea of adapters for custom deployment strategies but for most people the approach Luke suggest in his talk will be a perfect fit. @@ -61,7 +63,7 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad ## Config file -`ember-deploy` expects a `deploy.json` file in the root of your Ember-CLI app directory. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An Example could look like this: +By default, `ember-deploy` expects a `deploy.json` file in the root of your Ember-CLI app directory. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: ```js { @@ -111,6 +113,18 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad You have to have an entry for every environment you want to use in this file. +If you would prefer to use a .js file for your configuration, that is also supported. +Specify the path to the file using `--deploy-config-file=path/to/deploy.js`. You may want to +do this so that you can access secrets from environment variables. For example: + +```js +module.exports = { + //... + "secretAccessKey": process.env['AWS_ACCESS_KEY'], + //... +}; +``` + ## How to use This is an example of how one would use this addon to deploy an ember-cli app: @@ -125,22 +139,22 @@ This is an example of how one would use this addon to deploy an ember-cli app: ### Example Sinatra app -This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-deploy` and `ember-deploy-redis`. +This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-deploy` and `ember-deploy-redis`. ```ruby -require 'sinatra' +require 'sinatra' require 'redis' -def bootstrap_index(index_key) +def bootstrap_index(index_key) redis = Redis.new index_key ||= redis.get(':current') redis.get(index_key) end -get '/' do +get '/' do content_type 'text/html' bootstrap_index(params[:index_key]) -end +end ``` The nice thing about this is that you can deploy your app to production, test it out by passing an index_key parameter with the revision you want to test and activate when you feel confident that everything is working as expected. @@ -171,7 +185,7 @@ var SuperAwesomeCustomIndexAdapter = require('./lib/index-adapter'); function EmberDeploySuperAwesome() { this.name = 'ember-deploy-super-awesome'; this.type = 'ember-deploy-addon'; - + // ember-deploy will merge ember-deploy-addon's adapters property this.adapters = { index: { @@ -180,7 +194,7 @@ function EmberDeploySuperAwesome() { assets: { // you can add multiple adapters in one ember-deploy-addon }, - + tagging: { // you can add multiple adapters in one ember-deploy-addon } @@ -190,7 +204,7 @@ function EmberDeploySuperAwesome() { module.exports = EmberDeploySuperAwesome; ``` -Because `ember-deploy` will simply merge an `ember-deploy-addon`'s adapters property into its own bundled adapter-registry you could in theory bundle a complete new approach for deploying in one addon (just add an index- and an asset-adapter). +Because `ember-deploy` will simply merge an `ember-deploy-addon`'s adapters property into its own bundled adapter-registry you could in theory bundle a complete new approach for deploying in one addon (just add an index- and an asset-adapter). After adding your custom ember-deploy-addon to your project as an ember-cli-addon you can then use your custom adapters in ember-deploy's deploy.json: @@ -227,13 +241,13 @@ Index adapters have to implement the following methods for `ember-deploy` to be ####`upload([bootstrapIndexHTML])` __Parameters__ - + _bootstrapIndexHTML_ - - `upload` will get passed the content of `dist/index.html` that gets build from ember-cli. Feel free to do whatever you need to do with its file content. - + + `upload` will get passed the content of `dist/index.html` that gets build from ember-cli. Feel free to do whatever you need to do with its file content. + This method has to return a `RSVP.Promise`. - + ####`activate([revisionToActivate])` __Parameters__ diff --git a/lib/commands/activate.js b/lib/commands/activate.js index d378dfca..b05c8692 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -5,7 +5,8 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development' }, - { name: 'revision', type: String } + { name: 'revision', type: String }, + { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/assets.js b/lib/commands/assets.js index e068e12b..13ec5f5d 100644 --- a/lib/commands/assets.js +++ b/lib/commands/assets.js @@ -4,7 +4,8 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' } + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/deploy-index.js b/lib/commands/deploy-index.js index 3e7b1ee9..63a71076 100644 --- a/lib/commands/deploy-index.js +++ b/lib/commands/deploy-index.js @@ -4,7 +4,8 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' } + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index e16e6157..d3e68b59 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -6,7 +6,8 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' } + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], run: function(commandOptions, rawArgs) { @@ -15,7 +16,8 @@ module.exports = { var BuildTask = this.tasks.Build; var config = new ConfigurationReader({ - environment: commandOptions.environment + environment: commandOptions.environment, + configFile: commandOptions.deployConfigFile }); var buildTask = new BuildTask({ ui: this.ui, diff --git a/lib/commands/list.js b/lib/commands/list.js index edeee4ec..b20fbfda 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -4,7 +4,8 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' } + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index 0bfe9c8c..a509f94b 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -13,7 +13,8 @@ module.exports = Task.extend({ var ui = this.ui; var revision = options.revision; var config = new ConfigurationReader({ - environment: options.environment + environment: options.environment, + configFile: options.deployConfigFile }); var adapterType = config.store.type || 'redis'; var Adapter = new AdapterRegistry({ project: this.project }) diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 91336439..3948d5fa 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -20,7 +20,8 @@ module.exports = Task.extend({ var broccoli = require('broccoli'); var config = new ConfigurationReader({ - environment: options.environment + environment: options.environment, + configFile: options.deployConfigFile }); var fileTreeOrPath; @@ -28,7 +29,7 @@ module.exports = Task.extend({ fileTreeOrPath = 'dist'; } else { var gzipFiles = require('broccoli-gzip'); - + fileTreeOrPath = gzipFiles('dist', { extensions: config.assets.gzipExtensions ? config.assets.gzipExtensions : ['js', 'css', 'svg'], appendSuffix: false @@ -39,15 +40,16 @@ module.exports = Task.extend({ return builder.build() .then(this.processBuildResult.bind(this)) - .then(this.uploadAssets.bind(this, options.environment)) + .then(this.uploadAssets.bind(this, options.environment, options.deployConfigFile)) .then(function() { builder.cleanup(); }); }, - uploadAssets: function(environment) { + uploadAssets: function(environment, configFile) { var config = new ConfigurationReader({ - environment: environment + environment: environment, + configFile: configFile }); var assetsUploader = new AssetsUploader({ ui: this.ui, diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 3266f886..b06ff89e 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -11,7 +11,8 @@ module.exports = Task.extend({ run: function(options) { var ui = this.ui; var config = new ConfigurationReader({ - environment: options.environment + environment: options.environment, + configFile: options.deployConfigFile }); var adapterType = config.store.type || 'redis'; diff --git a/lib/tasks/list.js b/lib/tasks/list.js index 6cbdf1fd..4686e813 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -7,7 +7,8 @@ module.exports = Task.extend({ run: function(options) { var ui = this.ui; var config = new ConfigurationReader({ - environment: options.environment + environment: options.environment, + configFile: options.deployConfigFile }); var adapterType = config.store.type || 'redis'; var Adapter = new AdapterRegistry({ project: this.project }) diff --git a/node-tests/fixtures/deploy.js b/node-tests/fixtures/deploy.js new file mode 100644 index 00000000..19988188 --- /dev/null +++ b/node-tests/fixtures/deploy.js @@ -0,0 +1,26 @@ +module.exports = { + "development": { + "store": { + "host": "localhost", + "port": 6379 + }, + "assets": { + "accessKeyId": "", + "secretAccessKey": "", + "bucket": "" + } + }, + + "staging": { + "store": { + "host": "staging-redis.firstiwaslike.com", + "port": 6379 + }, + "assets": { + "accessKeyId": "", + "secretAccessKey": "", + "bucket": "", + "prefix": "" + } + } +} diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 1c64fcea..04df8aa9 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -20,7 +20,7 @@ describe('ConfigurationReader', function() { }); describe('configuration settings', function() { - it('reads a passed config-file if one is passed', function() { + it('reads a passed json deploy-config-file if one is passed', function() { var configPath = './node-tests/fixtures/deploy.json'; var root = process.cwd(); var fixtureConfigPath = path.join(root, configPath); @@ -33,6 +33,19 @@ describe('ConfigurationReader', function() { expect(config._config).to.equal(expectedConfig); }); + it('reads a passed js deploy-config-file if one is passed', function() { + var configPath = './node-tests/fixtures/deploy.js'; + var root = process.cwd(); + var fixtureConfigPath = path.join(root, configPath); + var expectedConfig = require(fixtureConfigPath); + + var config = new ConfigurationReader({ + configFile: configPath + }); + + expect(config._config).to.equal(expectedConfig); + }); + it('uses `./deploy.json` as default when no config is passed', function() { var root = process.cwd(); var expectedConfig = require(path.join(root, './deploy.json')); From 0741d368c0f30c89cbc3c03585de057afecfe89d Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Tue, 24 Feb 2015 02:18:44 -0500 Subject: [PATCH 030/300] Add npm command for running mocha tests autotest-style --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 6d47498f..ca67cc46 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,8 @@ "scripts": { "start": "ember server", "build": "ember build", - "test": "./node_modules/mocha/bin/mocha node-tests/**/*-test.js" + "test": "./node_modules/mocha/bin/mocha node-tests/**/*-test.js", + "autotest": "./node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" }, "repository": "https://github.com/LevelbossMike/ember-deploy", "engines": { From d838cd750c274f25d041c8ef7b3315f1cac7bf9c Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Tue, 24 Feb 2015 02:16:58 -0500 Subject: [PATCH 031/300] Encapsulate defaults in a config model --- lib/commands/deploy.js | 4 +- lib/models/config.js | 56 ++++++++++ lib/tasks/activate.js | 8 +- lib/tasks/assets.js | 13 ++- lib/tasks/deploy-index.js | 10 +- lib/tasks/list.js | 8 +- node-tests/unit/models/config-test.js | 100 ++++++++++++++++++ .../utilities/configuration-reader-test.js | 8 +- utilities/configuration-reader.js | 13 +-- 9 files changed, 189 insertions(+), 31 deletions(-) create mode 100644 lib/models/config.js create mode 100644 node-tests/unit/models/config-test.js diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index d3e68b59..fa1a4340 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -18,7 +18,7 @@ module.exports = { var config = new ConfigurationReader({ environment: commandOptions.environment, configFile: commandOptions.deployConfigFile - }); + }).config; var buildTask = new BuildTask({ ui: this.ui, analytics: this.analytics, @@ -26,7 +26,7 @@ module.exports = { }); var buildOptions = { - environment: config.buildEnv || 'production', + environment: config.get('buildEnv'), outputPath: "dist/", watch: false, disableAnalytics: false diff --git a/lib/models/config.js b/lib/models/config.js new file mode 100644 index 00000000..53422744 --- /dev/null +++ b/lib/models/config.js @@ -0,0 +1,56 @@ +var CoreObject = require('core-object'); + +function getPath(config, propertyPath) { + var parts = propertyPath.split('.'); + function read(node, part){ + if (node) { + return node[part]; + } else { + return undefined; + } + } + var node = config; + var part = parts.shift() + while (part !== undefined && part !== null) { + node = read(node, part); + part = parts.shift(); + } + return node; +} + + +module.exports = CoreObject.extend({ + init: function() { + this._config = this.rawConfig; + }, + get: function(propertyPath) { + var configValue = getPath(this._config, propertyPath); + if (configValue === undefined) { + return this.defaultFor(propertyPath); + } else { + return configValue; + } + }, + defaultFor: function(propertyPath) { + switch(propertyPath) { + case 'buildEnv': + return 'production'; + case 'manifestPrefix': + return this.project.name(); + case 'assets.gzip': + return true; + case 'assets.type': + return 's3'; + case 'assets.gzipExtensions': + return ['js', 'css', 'svg']; + case 'store.type': + return 'redis'; + case 'store.manifestSize': + return 10; + case 'tagging': + return 'sha'; + default: + return undefined; + } + } +}); diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index a509f94b..bfc0fb80 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -15,15 +15,15 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile - }); - var adapterType = config.store.type || 'redis'; + }).config; + var adapterType = config.get('store.type'); var Adapter = new AdapterRegistry({ project: this.project }) .lookup('index', adapterType); var deploy = new Adapter({ - config: config.store, + config: config.get('store'), manifest: this.project.name(), - manifestSize: config.store.manifestSize, + manifestSize: config.get('store.manifestSize'), ui: ui }); diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 3948d5fa..192d91a9 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -22,16 +22,16 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile - }); + }).config; var fileTreeOrPath; - if(config.assets.gzip === false) { + if(config.get('assets.gzip') === false) { fileTreeOrPath = 'dist'; } else { var gzipFiles = require('broccoli-gzip'); fileTreeOrPath = gzipFiles('dist', { - extensions: config.assets.gzipExtensions ? config.assets.gzipExtensions : ['js', 'css', 'svg'], + extensions: config.get('assets.gzipExtensions'), appendSuffix: false }); } @@ -48,13 +48,18 @@ module.exports = Task.extend({ uploadAssets: function(environment, configFile) { var config = new ConfigurationReader({ +<<<<<<< HEAD environment: environment, configFile: configFile }); +======= + environment: environment + }).config; +>>>>>>> Encapsulate defaults in a config model var assetsUploader = new AssetsUploader({ ui: this.ui, config: config, - type: config.assets.type, + type: config.get('assets.type'), project: this.project }); diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index b06ff89e..86a63643 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -13,10 +13,10 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile - }); + }).config; - var adapterType = config.store.type || 'redis'; - var taggingAdapterType = config.tagging || 'sha'; + var adapterType = config.get('store.type'); + var taggingAdapterType = config.get('tagging'); var manifest = this.project.name(); var adapterRegistry = new AdapterRegistry({ project: this.project }); @@ -32,9 +32,9 @@ module.exports = Task.extend({ }); var deploy = new Adapter({ - config: config.store, + config: config.get('store'), manifest: manifest, - manifestSize: config.store.manifestSize, + manifestSize: config.get('store.manifestSize'), taggingAdapter: taggingAdapter, ui: ui }); diff --git a/lib/tasks/list.js b/lib/tasks/list.js index 4686e813..93bf0a06 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -9,15 +9,15 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile - }); - var adapterType = config.store.type || 'redis'; + }).config; + var adapterType = config.get('store.type'); var Adapter = new AdapterRegistry({ project: this.project }) .lookup('index', adapterType); var deploy = new Adapter({ - config: config.store, + config: config.get('store'), manifest: this.project.name(), - manifestSize: config.store.manifestSize, + manifestSize: config.get('store.manifestSize'), ui: ui }); diff --git a/node-tests/unit/models/config-test.js b/node-tests/unit/models/config-test.js new file mode 100644 index 00000000..57cb7aa8 --- /dev/null +++ b/node-tests/unit/models/config-test.js @@ -0,0 +1,100 @@ +var Config = require('../../../lib/models/config'); +var expect = require('chai').expect; + +describe('Config', function() { + function createConfig(projectName, configJson) { + return new Config({ + project: { name: function(){ return projectName; } }, + rawConfig: configJson + }); + } + + describe('manifestPrefix', function(){ + it('defaults to project name', function() { + var config = createConfig('tomster', {}); + expect(config.get('manifestPrefix')).to.eq('tomster'); + }); + + it('allows configuration', function() { + var config = createConfig('tomster', { manifestPrefix: 'seldenator' }); + expect(config.get('manifestPrefix')).to.eq('seldenator'); + }); + }); + + describe('buildEnv', function(){ + it('defaults to production', function() { + var config = createConfig('tomster', {}); + expect(config.get('buildEnv')).to.eq('production'); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { buildEnv: 'chocula' }); + expect(config.get('buildEnv')).to.eq('chocula'); + }); + }); + + describe('store.type', function(){ + it('defaults to redis', function() { + var config = createConfig('tomster', {}); + expect(config.get('store.type')).to.eq('redis'); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { store: { type: 'cassandra' } }); + expect(config.get('store.type')).to.eq('cassandra'); + }); + }); + + describe('store.manifestSize', function(){ + it('defaults to 10', function() { + var config = createConfig('tomster', {}); + expect(config.get('store.manifestSize')).to.eq(10); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { store: { manifestSize: 42 } }); + expect(config.get('store.manifestSize')).to.eq(42); + }); + }); + + describe('assets.type', function(){ + it('defaults to s3', function() { + var config = createConfig('tomster', {}); + expect(config.get('assets.type')).to.eq('s3'); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { assets: { type: 'akamai' } }); + expect(config.get('assets.type')).to.eq('akamai'); + }); + }); + + describe('assets.gzip', function(){ + it('defaults to true', function() { + var config = createConfig('tomster', {}); + expect(config.get('assets.gzip')).to.eq(true); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { assets: { gzip: false } }); + expect(config.get('assets.gzip')).to.eq(false); + }); + }); + + describe('assets.gzipExtensions', function(){ + it('defaults to js,css,svg', function() { + var config = createConfig('tomster', {}); + expect(config.get('assets.gzipExtensions')).to.deep.equal(['js', 'css', 'svg']); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { assets: { gzipExtensions: ['js', 'css'] } }); + expect(config.get('assets.gzipExtensions')).to.deep.equal(['js', 'css']); + }); + }); + + describe('tagging', function(){ + it('defaults to sha', function() { + var config = createConfig('tomster', {}); + expect(config.get('tagging')).to.equal('sha'); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { tagging: 'yapp-custom' }); + expect(config.get('tagging')).to.equal('yapp-custom'); + }); + }); +}); diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 04df8aa9..0c64942f 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -67,9 +67,9 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ environment: ENV - }); + }).config; - expect(config.store).to.deep.equal(expected); + expect(config.get('store')).to.deep.equal(expected); }); }); }); @@ -85,9 +85,9 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ environment: ENV - }); + }).config; - expect(config.assets).to.deep.equal(expected); + expect(config.get('assets')).to.deep.equal(expected); }); }); }) diff --git a/utilities/configuration-reader.js b/utilities/configuration-reader.js index 7789232a..af959a0a 100644 --- a/utilities/configuration-reader.js +++ b/utilities/configuration-reader.js @@ -1,8 +1,5 @@ -// reader = new EnvironmentReader(environment) -// reader.store.host -// reader.store.port - var path = require('path'); +var Config = require('../lib/models/config'); function ConfigurationReader(options) { var root = process.cwd(); @@ -13,10 +10,10 @@ function ConfigurationReader(options) { this._deployConfig = this._options.configFile || defaultConfigPath; this._config = require(path.join(root, this._deployConfig)); - - this.store = this._config[this._environment].store; - this.assets = this._config[this._environment].assets; - this.buildEnv = this._config[this._environment].buildEnv || 'production'; + this.config = new Config({ + project: this.project, + rawConfig: this._config[this._environment] + }); } module.exports = ConfigurationReader; From 60ce110b6a81f99e883119eefef676fe63152bc0 Mon Sep 17 00:00:00 2001 From: James Fiderlick Date: Mon, 23 Feb 2015 10:27:59 -0600 Subject: [PATCH 032/300] Allow for --prod and --dev, as well as --e for running commands to match ember-cli. --- lib/commands/activate.js | 2 +- lib/commands/assets.js | 2 +- lib/commands/deploy-index.js | 2 +- lib/commands/deploy.js | 2 +- lib/commands/list.js | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index b05c8692..67953a64 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -4,7 +4,7 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' }, + { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'revision', type: String }, { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], diff --git a/lib/commands/assets.js b/lib/commands/assets.js index 13ec5f5d..c17c1d30 100644 --- a/lib/commands/assets.js +++ b/lib/commands/assets.js @@ -4,7 +4,7 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' }, + { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], diff --git a/lib/commands/deploy-index.js b/lib/commands/deploy-index.js index 63a71076..4ea29e9f 100644 --- a/lib/commands/deploy-index.js +++ b/lib/commands/deploy-index.js @@ -4,7 +4,7 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' }, + { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index fa1a4340..8652d0ed 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -6,7 +6,7 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' }, + { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], diff --git a/lib/commands/list.js b/lib/commands/list.js index b20fbfda..05c709d0 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -4,7 +4,7 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' }, + { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'deploy.json' } ], From 46e63b52f10e6aecf3aeb095fb9714ff410001a3 Mon Sep 17 00:00:00 2001 From: James Fiderlick Date: Tue, 24 Feb 2015 11:22:23 -0600 Subject: [PATCH 033/300] Removed erroneous conflict markers. --- lib/tasks/assets.js | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 192d91a9..89748098 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -48,14 +48,10 @@ module.exports = Task.extend({ uploadAssets: function(environment, configFile) { var config = new ConfigurationReader({ -<<<<<<< HEAD environment: environment, configFile: configFile - }); -======= - environment: environment }).config; ->>>>>>> Encapsulate defaults in a config model + var assetsUploader = new AssetsUploader({ ui: this.ui, config: config, From 6cd4c3af0e5e364a90ef37c4e03ab4f6ba01ce12 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 27 Feb 2015 08:48:33 +0000 Subject: [PATCH 034/300] Update package.json to reflect move to ember-cli org --- package.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index ca67cc46..67b2a177 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "ember-deploy", + "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", "version": "0.3.1", "directories": { @@ -12,7 +12,7 @@ "test": "./node_modules/mocha/bin/mocha node-tests/**/*-test.js", "autotest": "./node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" }, - "repository": "https://github.com/LevelbossMike/ember-deploy", + "repository": "https://github.com/ember-cli/ember-deploy", "engines": { "node": ">= 0.10.0" }, @@ -38,7 +38,8 @@ "sinon": "^1.12.1" }, "keywords": [ - "ember-addon" + "ember-addon", + "ember-cli-deploy" ], "ember-addon": { "configPath": "tests/dummy/config" From b685f4de3368fdc77b1f487bc4bcab893f22d861 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 27 Feb 2015 18:01:02 +0000 Subject: [PATCH 035/300] Updated travis badge in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0667ed94..9cc782d1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Ember-deploy [![Build Status](https://travis-ci.org/LevelbossMike/ember-deploy.svg?branch=master)](https://travis-ci.org/LevelbossMike/ember-deploy) [![Code Climate](https://codeclimate.com/github/LevelbossMike/ember-deploy/badges/gpa.svg)](https://codeclimate.com/github/LevelbossMike/ember-deploy) +# ember-cli-deploy [![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/LevelbossMike/ember-deploy/badges/gpa.svg)](https://codeclimate.com/github/LevelbossMike/ember-deploy) An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps` From 167177307a13521784db2e848ec2617413c8a269 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 28 Feb 2015 14:38:01 +0000 Subject: [PATCH 036/300] Deprecated commands no longer needed. Also added deprecated commands for those that could be used by users of the project formerly known as `ember-cli-deploy` --- lib/commands/deprecated/activate.js | 15 +++++++++++++++ lib/commands/{ => deprecated}/assets.js | 6 ++++-- lib/commands/{ => deprecated}/deploy-index.js | 8 +++++--- lib/commands/deprecated/deprecated-command.js | 12 ++++++++++++ lib/commands/deprecated/versions.js | 11 +++++++++++ lib/commands/index.js | 9 ++++++--- 6 files changed, 53 insertions(+), 8 deletions(-) create mode 100644 lib/commands/deprecated/activate.js rename lib/commands/{ => deprecated}/assets.js (86%) rename lib/commands/{ => deprecated}/deploy-index.js (77%) create mode 100644 lib/commands/deprecated/deprecated-command.js create mode 100644 lib/commands/deprecated/versions.js diff --git a/lib/commands/deprecated/activate.js b/lib/commands/deprecated/activate.js new file mode 100644 index 00000000..4938864e --- /dev/null +++ b/lib/commands/deprecated/activate.js @@ -0,0 +1,15 @@ +var DeprecatedCommand = require('./deprecated-command'); + +module.exports = DeprecatedCommand({ + name: 'activate', + description: 'Activate a deployed version of index.html', + works: 'insideProject', + + anonymousOptions: [ + '' + ], + + availableOptions: [ + { name: 'environment', type: String, default: 'development' } + ] +}); diff --git a/lib/commands/assets.js b/lib/commands/deprecated/assets.js similarity index 86% rename from lib/commands/assets.js rename to lib/commands/deprecated/assets.js index c17c1d30..ad2e459f 100644 --- a/lib/commands/assets.js +++ b/lib/commands/deprecated/assets.js @@ -1,4 +1,6 @@ -module.exports = { +var DeprecatedCommand = require('./deprecated-command'); + +module.exports = DeprecatedCommand({ name: 'deploy:assets', description: 'Deploys assets to an asset-host (default: aws:s3)', works: 'insideProject', @@ -18,4 +20,4 @@ module.exports = { return assetsTask.run(commandOptions); } -}; +}); diff --git a/lib/commands/deploy-index.js b/lib/commands/deprecated/deploy-index.js similarity index 77% rename from lib/commands/deploy-index.js rename to lib/commands/deprecated/deploy-index.js index 4ea29e9f..53821850 100644 --- a/lib/commands/deploy-index.js +++ b/lib/commands/deprecated/deploy-index.js @@ -1,6 +1,8 @@ -module.exports = { +var DeprecatedCommand = require('./deprecated-command'); + +module.exports = DeprecatedCommand({ name: 'deploy:index', - description: 'Deploys index to key-value store (default: redis)', + description: 'Deploys index to key-value store (default: redis)', works: 'insideProject', availableOptions: [ @@ -18,4 +20,4 @@ module.exports = { return deployIndexTask.run(commandOptions); } -}; +}); diff --git a/lib/commands/deprecated/deprecated-command.js b/lib/commands/deprecated/deprecated-command.js new file mode 100644 index 00000000..d8a4a7b8 --- /dev/null +++ b/lib/commands/deprecated/deprecated-command.js @@ -0,0 +1,12 @@ +var chalk = require('chalk'); +var SilentError = require('ember-cli/lib/errors/silent'); + +module.exports = function(command) { + var description = command.description || ''; + command.description = chalk.red('[DEPRECATED] ') + description; + command.run = function() { + throw new SilentError('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); + } + + return command; +}; diff --git a/lib/commands/deprecated/versions.js b/lib/commands/deprecated/versions.js new file mode 100644 index 00000000..5adbc71c --- /dev/null +++ b/lib/commands/deprecated/versions.js @@ -0,0 +1,11 @@ +var DeprecatedCommand = require('./deprecated-command'); + +module.exports = DeprecatedCommand({ + name: 'deploy:versions', + description: 'Lists all versions of the app have been deployed', + works: 'insideProject', + + availableOptions: [ + { name: 'environment', type: String, default: 'development' } + ] +}); diff --git a/lib/commands/index.js b/lib/commands/index.js index ec6b1db7..707d12a6 100644 --- a/lib/commands/index.js +++ b/lib/commands/index.js @@ -1,7 +1,10 @@ module.exports = { "deploy": require('./deploy'), "deploy:activate": require('./activate'), - "deploy:assets": require('./assets'), - "deploy:index": require('./deploy-index'), - "deploy:list": require('./list') + "deploy:list": require('./list'), + + "deploy:assets": require('./deprecated/assets'), + "deploy:index": require('./deprecated/deploy-index'), + "activate": require('./deprecated/activate'), + "deploy:versions": require('./deprecated/versions') }; From e4e6e2a27274b381948bac3ea3d10faa7c617366 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 28 Feb 2015 15:01:06 +0000 Subject: [PATCH 037/300] Commands are now `No Longer Supported` as opposed to deprecated` --- lib/commands/index.js | 8 ++++---- lib/commands/{deprecated => unsupported}/activate.js | 4 ++-- lib/commands/{deprecated => unsupported}/assets.js | 4 ++-- lib/commands/{deprecated => unsupported}/deploy-index.js | 4 ++-- .../unsupported-command.js} | 4 ++-- lib/commands/{deprecated => unsupported}/versions.js | 4 ++-- 6 files changed, 14 insertions(+), 14 deletions(-) rename lib/commands/{deprecated => unsupported}/activate.js (71%) rename lib/commands/{deprecated => unsupported}/assets.js (86%) rename lib/commands/{deprecated => unsupported}/deploy-index.js (87%) rename lib/commands/{deprecated/deprecated-command.js => unsupported/unsupported-command.js} (52%) rename lib/commands/{deprecated => unsupported}/versions.js (69%) diff --git a/lib/commands/index.js b/lib/commands/index.js index 707d12a6..d8b281be 100644 --- a/lib/commands/index.js +++ b/lib/commands/index.js @@ -3,8 +3,8 @@ module.exports = { "deploy:activate": require('./activate'), "deploy:list": require('./list'), - "deploy:assets": require('./deprecated/assets'), - "deploy:index": require('./deprecated/deploy-index'), - "activate": require('./deprecated/activate'), - "deploy:versions": require('./deprecated/versions') + "deploy:assets": require('./unsupported/assets'), + "deploy:index": require('./unsupported/deploy-index'), + "activate": require('./unsupported/activate'), + "deploy:versions": require('./unsupported/versions') }; diff --git a/lib/commands/deprecated/activate.js b/lib/commands/unsupported/activate.js similarity index 71% rename from lib/commands/deprecated/activate.js rename to lib/commands/unsupported/activate.js index 4938864e..e6f04b25 100644 --- a/lib/commands/deprecated/activate.js +++ b/lib/commands/unsupported/activate.js @@ -1,6 +1,6 @@ -var DeprecatedCommand = require('./deprecated-command'); +var UnsupportedCommand = require('./unsupported-command'); -module.exports = DeprecatedCommand({ +module.exports = UnsupportedCommand({ name: 'activate', description: 'Activate a deployed version of index.html', works: 'insideProject', diff --git a/lib/commands/deprecated/assets.js b/lib/commands/unsupported/assets.js similarity index 86% rename from lib/commands/deprecated/assets.js rename to lib/commands/unsupported/assets.js index ad2e459f..570a973e 100644 --- a/lib/commands/deprecated/assets.js +++ b/lib/commands/unsupported/assets.js @@ -1,6 +1,6 @@ -var DeprecatedCommand = require('./deprecated-command'); +var UnsupportedCommand = require('./unsupported-command'); -module.exports = DeprecatedCommand({ +module.exports = UnsupportedCommand({ name: 'deploy:assets', description: 'Deploys assets to an asset-host (default: aws:s3)', works: 'insideProject', diff --git a/lib/commands/deprecated/deploy-index.js b/lib/commands/unsupported/deploy-index.js similarity index 87% rename from lib/commands/deprecated/deploy-index.js rename to lib/commands/unsupported/deploy-index.js index 53821850..91256e2e 100644 --- a/lib/commands/deprecated/deploy-index.js +++ b/lib/commands/unsupported/deploy-index.js @@ -1,6 +1,6 @@ -var DeprecatedCommand = require('./deprecated-command'); +var UnsupportedCommand = require('./unsupported-command'); -module.exports = DeprecatedCommand({ +module.exports = UnsupportedCommand({ name: 'deploy:index', description: 'Deploys index to key-value store (default: redis)', works: 'insideProject', diff --git a/lib/commands/deprecated/deprecated-command.js b/lib/commands/unsupported/unsupported-command.js similarity index 52% rename from lib/commands/deprecated/deprecated-command.js rename to lib/commands/unsupported/unsupported-command.js index d8a4a7b8..90fb9f10 100644 --- a/lib/commands/deprecated/deprecated-command.js +++ b/lib/commands/unsupported/unsupported-command.js @@ -3,9 +3,9 @@ var SilentError = require('ember-cli/lib/errors/silent'); module.exports = function(command) { var description = command.description || ''; - command.description = chalk.red('[DEPRECATED] ') + description; + command.description = chalk.red('[NO LONGER SUPPORTED] ') + description; command.run = function() { - throw new SilentError('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); + throw new SilentError('This command is no longer supported. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); } return command; diff --git a/lib/commands/deprecated/versions.js b/lib/commands/unsupported/versions.js similarity index 69% rename from lib/commands/deprecated/versions.js rename to lib/commands/unsupported/versions.js index 5adbc71c..d12e1257 100644 --- a/lib/commands/deprecated/versions.js +++ b/lib/commands/unsupported/versions.js @@ -1,6 +1,6 @@ -var DeprecatedCommand = require('./deprecated-command'); +var UnsupportedCommand = require('./unsupported-command'); -module.exports = DeprecatedCommand({ +module.exports = UnsupportedCommand({ name: 'deploy:versions', description: 'Lists all versions of the app have been deployed', works: 'insideProject', From 4de84a3f86bb2a7a03dc52f29908bb8fc02729d1 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 28 Feb 2015 10:49:31 -0500 Subject: [PATCH 038/300] Deprecate use of deploy.json in favor of config/deploy.js. Closes #51 * introduces a deprecate util * provides the ConfigurationReader with the ui instance * improves error message when config file is missing * changes default value for --deploy-config-file option * updates README --- README.md | 26 +++------ deploy.json => config/deploy.js | 2 +- lib/commands/activate.js | 2 +- lib/commands/deploy.js | 5 +- lib/commands/list.js | 2 +- lib/commands/unsupported/assets.js | 2 +- lib/commands/unsupported/deploy-index.js | 2 +- lib/tasks/activate.js | 3 +- lib/tasks/assets.js | 8 ++- lib/tasks/deploy-index.js | 3 +- lib/tasks/list.js | 3 +- node-tests/fixtures/{ => config}/deploy.js | 0 node-tests/fixtures/{ => config}/deploy.json | 0 .../utilities/configuration-reader-test.js | 57 ++++++++++++++----- utilities/configuration-reader.js | 22 +++++-- utilities/deprecate.js | 9 +++ 16 files changed, 97 insertions(+), 49 deletions(-) rename deploy.json => config/deploy.js (97%) rename node-tests/fixtures/{ => config}/deploy.js (100%) rename node-tests/fixtures/{ => config}/deploy.json (100%) create mode 100644 utilities/deprecate.js diff --git a/README.md b/README.md index 9cc782d1..8aeab36a 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ This Ember-CLI Addon adds multiple deployment related tasks to your Ember-CLI Ap You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-deploy` will use the `development`-environment. -You can pass `--deploy-config-file ` to every command. If you don't pass a deploy-config-file explicitly `deploy.json` will be read. +You can pass `--deploy-config-file ` to every command. If you don't pass a deploy-config-file explicitly `config/deploy.js` will be read. ## Lightning-Approach Workflow @@ -63,10 +63,10 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad ## Config file -By default, `ember-deploy` expects a `deploy.json` file in the root of your Ember-CLI app directory. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: +By default, `ember-deploy` expects a `deploy.js` file in the `config/` directory of your Ember-CLI project root. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: ```js -{ +module.exports = { "development": { "store": { "type": "redis", // the default store is 'redis' @@ -78,7 +78,7 @@ By default, `ember-deploy` expects a `deploy.json` file in the root of your Embe "gzip": false, // if undefined or set to true, files are gziped "gzipExtensions": ["js", "css", "svg"], // if undefined, js, css & svg files are gziped "accessKeyId": "", - "secretAccessKey": "", + "secretAccessKey": process.env['AWS_ACCESS_KEY'], "bucket": "" } }, @@ -91,7 +91,7 @@ By default, `ember-deploy` expects a `deploy.json` file in the root of your Embe }, "assets": { "accessKeyId": "", - "secretAccessKey": "", + "secretAccessKey": process.env['AWS_ACCESS_KEY'], "bucket": "" } }, @@ -104,26 +104,14 @@ By default, `ember-deploy` expects a `deploy.json` file in the root of your Embe }, "assets": { "accessKeyId": "", - "secretAccessKey": "", + "secretAccessKey": process.env['AWS_ACCESS_KEY'], "bucket": "" } } } ``` -You have to have an entry for every environment you want to use in this file. - -If you would prefer to use a .js file for your configuration, that is also supported. -Specify the path to the file using `--deploy-config-file=path/to/deploy.js`. You may want to -do this so that you can access secrets from environment variables. For example: - -```js -module.exports = { - //... - "secretAccessKey": process.env['AWS_ACCESS_KEY'], - //... -}; -``` +You must have an entry for every environment you want to use in this file. ## How to use diff --git a/deploy.json b/config/deploy.js similarity index 97% rename from deploy.json rename to config/deploy.js index 7c4b265f..38d703e7 100644 --- a/deploy.json +++ b/config/deploy.js @@ -1,4 +1,4 @@ -{ +module.exports = { "development": { "store": { "host": "localhost", diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 67953a64..e7294c3a 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -6,7 +6,7 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'revision', type: String }, - { name: 'deploy-config-file', type: String, default: 'deploy.json' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 8652d0ed..c3d14a2d 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -7,7 +7,7 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'deploy.json' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], run: function(commandOptions, rawArgs) { @@ -17,7 +17,8 @@ module.exports = { var config = new ConfigurationReader({ environment: commandOptions.environment, - configFile: commandOptions.deployConfigFile + configFile: commandOptions.deployConfigFile, + ui: this.ui }).config; var buildTask = new BuildTask({ ui: this.ui, diff --git a/lib/commands/list.js b/lib/commands/list.js index 05c709d0..9c1be552 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -5,7 +5,7 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'deploy.json' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/unsupported/assets.js b/lib/commands/unsupported/assets.js index 570a973e..528e32df 100644 --- a/lib/commands/unsupported/assets.js +++ b/lib/commands/unsupported/assets.js @@ -7,7 +7,7 @@ module.exports = UnsupportedCommand({ availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'deploy.json' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/commands/unsupported/deploy-index.js b/lib/commands/unsupported/deploy-index.js index 91256e2e..a2f657a6 100644 --- a/lib/commands/unsupported/deploy-index.js +++ b/lib/commands/unsupported/deploy-index.js @@ -7,7 +7,7 @@ module.exports = UnsupportedCommand({ availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'deploy.json' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], run: function(commandOptions, rawArgs) { diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index bfc0fb80..dc185a72 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -14,7 +14,8 @@ module.exports = Task.extend({ var revision = options.revision; var config = new ConfigurationReader({ environment: options.environment, - configFile: options.deployConfigFile + configFile: options.deployConfigFile, + ui: ui }).config; var adapterType = config.get('store.type'); var Adapter = new AdapterRegistry({ project: this.project }) diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 89748098..20e56f6f 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -21,7 +21,8 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, - configFile: options.deployConfigFile + configFile: options.deployConfigFile, + ui: this.ui }).config; var fileTreeOrPath; @@ -49,9 +50,10 @@ module.exports = Task.extend({ uploadAssets: function(environment, configFile) { var config = new ConfigurationReader({ environment: environment, - configFile: configFile + configFile: configFile, + ui: this.ui }).config; - + var assetsUploader = new AssetsUploader({ ui: this.ui, config: config, diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 86a63643..93d99842 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -12,7 +12,8 @@ module.exports = Task.extend({ var ui = this.ui; var config = new ConfigurationReader({ environment: options.environment, - configFile: options.deployConfigFile + configFile: options.deployConfigFile, + ui: ui }).config; var adapterType = config.get('store.type'); diff --git a/lib/tasks/list.js b/lib/tasks/list.js index 93bf0a06..9e678b39 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -8,7 +8,8 @@ module.exports = Task.extend({ var ui = this.ui; var config = new ConfigurationReader({ environment: options.environment, - configFile: options.deployConfigFile + configFile: options.deployConfigFile, + ui: ui }).config; var adapterType = config.get('store.type'); var Adapter = new AdapterRegistry({ project: this.project }) diff --git a/node-tests/fixtures/deploy.js b/node-tests/fixtures/config/deploy.js similarity index 100% rename from node-tests/fixtures/deploy.js rename to node-tests/fixtures/config/deploy.js diff --git a/node-tests/fixtures/deploy.json b/node-tests/fixtures/config/deploy.json similarity index 100% rename from node-tests/fixtures/deploy.json rename to node-tests/fixtures/config/deploy.json diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 0c64942f..43bc3f06 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -1,19 +1,31 @@ var ConfigurationReader = require('../../../utilities/configuration-reader'); var expect = require('chai').expect; var path = require('path'); +var MockUI = require('ember-cli/tests/helpers/mock-ui'); +var EOL = require('os').EOL; +var chalk = require('chalk'); describe('ConfigurationReader', function() { + var ui; + + beforeEach(function() { + ui = new MockUI(); + }); + describe('environment settings', function() { it('knows about its passed _environment', function() { var config = new ConfigurationReader({ - environment: 'staging' + environment: 'staging', + ui: ui }); expect(config._environment).to.equal('staging'); }); it('`development` is default when no environment is passed', function() { - var config = new ConfigurationReader(); + var config = new ConfigurationReader({ + ui: ui + }); expect(config._environment).to.equal('development'); }); @@ -21,52 +33,70 @@ describe('ConfigurationReader', function() { describe('configuration settings', function() { it('reads a passed json deploy-config-file if one is passed', function() { - var configPath = './node-tests/fixtures/deploy.json'; + var configPath = './node-tests/fixtures/config/deploy.json'; var root = process.cwd(); var fixtureConfigPath = path.join(root, configPath); var expectedConfig = require(fixtureConfigPath); var config = new ConfigurationReader({ - configFile: configPath + configFile: configPath, + ui: ui }); + expect(ui.output).to.include('DEPRECATION: Using a .json file for deployment configuration is deprecated. Please use a .js file instead'); expect(config._config).to.equal(expectedConfig); }); it('reads a passed js deploy-config-file if one is passed', function() { - var configPath = './node-tests/fixtures/deploy.js'; + var configPath = './node-tests/fixtures/config/deploy.js'; var root = process.cwd(); var fixtureConfigPath = path.join(root, configPath); var expectedConfig = require(fixtureConfigPath); var config = new ConfigurationReader({ - configFile: configPath + configFile: configPath, + ui: ui }); expect(config._config).to.equal(expectedConfig); }); - it('uses `./deploy.json` as default when no config is passed', function() { + it('uses `./config/deploy.js` as default when no config is passed', function() { var root = process.cwd(); - var expectedConfig = require(path.join(root, './deploy.json')); + var expectedConfig = require(path.join(root, './config/deploy.js')); - var config = new ConfigurationReader(); + var config = new ConfigurationReader({ + ui: ui + }); expect(config._config).to.equal(expectedConfig) }); + + it('raises an error in the case of a passed deploy-config-file that doesn\'t exist', function() { + var configPath = './node-tests/fixtures/config/does-not-exist.js'; + var root = process.cwd(); + + expect(function() { + var config = new ConfigurationReader({ + configFile: configPath, + ui: ui + }); + }).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); + }); }); describe('store settings', function() { it('proxies the store settings for the passed environment', function() { var ENVs = ['development', 'staging']; var root = process.cwd(); - var cfgFile = require(path.join(root, './node-tests/fixtures/deploy.json')); + var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); ENVs.forEach(function(ENV) { var expected = cfgFile[ENV].store; var config = new ConfigurationReader({ - environment: ENV + environment: ENV, + ui: ui }).config; expect(config.get('store')).to.deep.equal(expected); @@ -78,13 +108,14 @@ describe('ConfigurationReader', function() { it('proxies the asset setting for the passed environment', function() { var ENVs = ['development', 'staging']; var root = process.cwd(); - var cfgFile = require(path.join(root, './node-tests/fixtures/deploy.json')); + var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); ENVs.forEach(function(ENV) { var expected = cfgFile[ENV].assets; var config = new ConfigurationReader({ - environment: ENV + environment: ENV, + ui: ui }).config; expect(config.get('assets')).to.deep.equal(expected); diff --git a/utilities/configuration-reader.js b/utilities/configuration-reader.js index af959a0a..2445916c 100644 --- a/utilities/configuration-reader.js +++ b/utilities/configuration-reader.js @@ -1,15 +1,29 @@ -var path = require('path'); -var Config = require('../lib/models/config'); +var path = require('path'); +var Config = require('../lib/models/config'); +var deprecate = require('./deprecate'); function ConfigurationReader(options) { var root = process.cwd(); - var defaultConfigPath = 'deploy.json'; + var defaultConfigPath = path.join('config', 'deploy.js'); this._options = options || {}; this._environment = this._options.environment || 'development'; this._deployConfig = this._options.configFile || defaultConfigPath; - this._config = require(path.join(root, this._deployConfig)); + var ui = options.ui; + + deprecate( + "Using a .json file for deployment configuration is deprecated. Please use a .js file instead", + /\.json$/.test(this._options.configFile), + ui + ); + try { + var pathToConfig = path.join(root, this._deployConfig); + this._config = require(pathToConfig); + } catch(e) { + ui.writeError(e); + throw new Error('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); + } this.config = new Config({ project: this.project, rawConfig: this._config[this._environment] diff --git a/utilities/deprecate.js b/utilities/deprecate.js new file mode 100644 index 00000000..f1bdd02a --- /dev/null +++ b/utilities/deprecate.js @@ -0,0 +1,9 @@ +'use strict'; + +var chalk = require('chalk'); + +module.exports = function(message, test, ui) { + if (!test) { return; } + + ui.writeLine(chalk.yellow('DEPRECATION: ' + message)); +}; From d06493324a690c5d95aab3e74f16f51a3c5cd21f Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 28 Feb 2015 22:29:18 +0000 Subject: [PATCH 039/300] Add blueprint to auto generate config/deploy.js * adds `deploy-config` blueprint to `ember generate` * Populates config/deploy.js with example config --- blueprints/.jshintrc | 6 +++ .../deploy-config/files/config/deploy.js | 43 +++++++++++++++++++ blueprints/deploy-config/index.js | 8 ++++ index.js | 5 +++ package.json | 3 +- 5 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 blueprints/.jshintrc create mode 100644 blueprints/deploy-config/files/config/deploy.js create mode 100644 blueprints/deploy-config/index.js diff --git a/blueprints/.jshintrc b/blueprints/.jshintrc new file mode 100644 index 00000000..33f4f6f4 --- /dev/null +++ b/blueprints/.jshintrc @@ -0,0 +1,6 @@ +{ + "predef": [ + "console" + ], + "strict": false +} diff --git a/blueprints/deploy-config/files/config/deploy.js b/blueprints/deploy-config/files/config/deploy.js new file mode 100644 index 00000000..7bfc3366 --- /dev/null +++ b/blueprints/deploy-config/files/config/deploy.js @@ -0,0 +1,43 @@ +module.exports = { + //development: { + //store: { + //type: 'redis', // the default store is 'redis' + //host: 'localhost', + //port: 6379 + //}, + //assets: { + //type: 's3', // default asset-adapter is 's3' + //gzip: false, // if undefined or set to true, files are gziped + //gzipExtensions: ['js', 'css', 'svg'], // if undefined, js, css & svg files are gziped + //accessKeyId: '', + //secretAccessKey: process.env['AWS_ACCESS_KEY'], + //bucket: '' + //} + //}, + + //staging: { + //buildEnv: 'staging', // Override the environment passed to the ember asset build. Defaults to 'production' + //store: { + //host: 'staging-redis.example.com', + //port: 6379 + //}, + //assets: { + //accessKeyId: '', + //secretAccessKey: process.env['AWS_ACCESS_KEY'], + //bucket: '' + //} + //}, + + //production: { + //store: { + //host: 'production-redis.example.com', + //port: 6379, + //password: '' + //}, + //assets: { + //accessKeyId: '', + //secretAccessKey: process.env['AWS_ACCESS_KEY'], + //bucket: '' + //} + //} +} diff --git a/blueprints/deploy-config/index.js b/blueprints/deploy-config/index.js new file mode 100644 index 00000000..fab62a38 --- /dev/null +++ b/blueprints/deploy-config/index.js @@ -0,0 +1,8 @@ +module.exports = { + description: 'Generate config for ember-cli deployments', + normalizeEntityName: function() { + // this prevents an error when the entityName is + // not specified (since that doesn't actually matter + // to us + } +}; diff --git a/index.js b/index.js index 9a18163f..ba0f8f45 100644 --- a/index.js +++ b/index.js @@ -1,3 +1,4 @@ +var path = require('path'); var commands = require('./lib/commands'); function Deploy() { @@ -9,5 +10,9 @@ Deploy.prototype.includedCommands = function() { return commands; } +Deploy.prototype.blueprintsPath = function() { + return path.join(__dirname, 'blueprints'); +}, + module.exports = Deploy; diff --git a/package.json b/package.json index 67b2a177..69d2d88f 100644 --- a/package.json +++ b/package.json @@ -42,7 +42,8 @@ "ember-cli-deploy" ], "ember-addon": { - "configPath": "tests/dummy/config" + "configPath": "tests/dummy/config", + "defaultBlueprint": "deploy-config" }, "dependencies": { "broccoli": "^0.13.2", From 339792cf76c88928e584fd872aebe5d5f338f848 Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Sat, 28 Feb 2015 20:34:44 -0500 Subject: [PATCH 040/300] update ember-deploy references to be ember-cli-deploy Closes #55 --- bower.json | 4 ++-- index.js | 2 +- node-tests/unit/utilities/adapter-registry-test.js | 4 ++-- node-tests/unit/utilities/tagging/sha-test.js | 2 +- package.json | 2 +- utilities/adapter-registry.js | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/bower.json b/bower.json index c803a4fa..eafbc31d 100644 --- a/bower.json +++ b/bower.json @@ -1,5 +1,5 @@ { - "name": "ember-deploy", + "name": "ember-cli-deploy", "dependencies": { "handlebars": "~1.3.0", "jquery": "^1.11.1", @@ -14,4 +14,4 @@ "ember-qunit-notifications": "0.0.4", "qunit": "~1.15.0" } -} \ No newline at end of file +} diff --git a/index.js b/index.js index ba0f8f45..83722b3c 100644 --- a/index.js +++ b/index.js @@ -2,7 +2,7 @@ var path = require('path'); var commands = require('./lib/commands'); function Deploy() { - this.name = "ember-deploy" + this.name = "ember-cli-deploy" return this; } diff --git a/node-tests/unit/utilities/adapter-registry-test.js b/node-tests/unit/utilities/adapter-registry-test.js index 9065ab80..7e832f16 100644 --- a/node-tests/unit/utilities/adapter-registry-test.js +++ b/node-tests/unit/utilities/adapter-registry-test.js @@ -1,6 +1,6 @@ +/* jshint expr:true */ var Adapter = require('../../../utilities/adapter'); var AdapterRegistry = require('../../../utilities/adapter-registry'); -var CoreObject = require('core-object'); var UnknownAdapter = require('../../../utilities/assets/unknown'); var expect = require('chai').expect; @@ -37,7 +37,7 @@ describe('AdapterRegistry', function() { var adapterRegistry = new AdapterRegistry(); expect(adapterRegistry.lookup('index', 'trolol')).to.eq(UnknownAdapter); - }) + }); }); describe('adapters can be added via addons', function() { diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 1af2268c..73457fbe 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -32,7 +32,7 @@ describe('ShaTaggingAdapter', function() { describe('#createTag', function() { it('returns a tag based on current git-sha and manifestName', function() { - var manifestName = 'ember-deploy'; + var manifestName = 'ember-cli-deploy'; var expectedTag = manifestName+':'+GIT_SHA_SHORTENED; var revisionTagger = new ShaTaggingAdapter({ manifest: manifestName diff --git a/package.json b/package.json index 69d2d88f..86a464f7 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "test": "./node_modules/mocha/bin/mocha node-tests/**/*-test.js", "autotest": "./node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" }, - "repository": "https://github.com/ember-cli/ember-deploy", + "repository": "https://github.com/ember-cli/ember-cli-deploy", "engines": { "node": ">= 0.10.0" }, diff --git a/utilities/adapter-registry.js b/utilities/adapter-registry.js index 23f44a87..ac5c6573 100644 --- a/utilities/adapter-registry.js +++ b/utilities/adapter-registry.js @@ -5,7 +5,7 @@ var merge = require('lodash-node/modern/objects/merge'); module.exports = CoreObject.extend({ init: function() { - if (!this.project) { return }; + if (!this.project) { return; } this.project.addons.forEach(this._mergeDeployAdapters.bind(this)); }, From 5e6389019fb79fab951a2b7ea9e9bcd22f87d997 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sun, 1 Mar 2015 00:07:59 -0500 Subject: [PATCH 041/300] Move utilities dir into lib --- lib/commands/deploy.js | 2 +- lib/tasks/activate.js | 4 ++-- lib/tasks/assets.js | 4 ++-- lib/tasks/deploy-index.js | 4 ++-- lib/tasks/list.js | 4 ++-- {utilities => lib/utilities}/adapter-registry.js | 0 {utilities => lib/utilities}/adapter.js | 0 {utilities => lib/utilities}/assets-uploader.js | 0 {utilities => lib/utilities}/assets/unknown.js | 0 {utilities => lib/utilities}/configuration-reader.js | 2 +- {utilities => lib/utilities}/deprecate.js | 0 {utilities => lib/utilities}/tagging/sha.js | 0 node-tests/unit/utilities/adapter-registry-test.js | 6 +++--- node-tests/unit/utilities/assets-uploader-test.js | 4 ++-- node-tests/unit/utilities/assets/unknown-test.js | 2 +- node-tests/unit/utilities/configuration-reader-test.js | 2 +- node-tests/unit/utilities/tagging/sha-test.js | 2 +- 17 files changed, 18 insertions(+), 18 deletions(-) rename {utilities => lib/utilities}/adapter-registry.js (100%) rename {utilities => lib/utilities}/adapter.js (100%) rename {utilities => lib/utilities}/assets-uploader.js (100%) rename {utilities => lib/utilities}/assets/unknown.js (100%) rename {utilities => lib/utilities}/configuration-reader.js (95%) rename {utilities => lib/utilities}/deprecate.js (100%) rename {utilities => lib/utilities}/tagging/sha.js (100%) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index c3d14a2d..3202d9af 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,4 +1,4 @@ -var ConfigurationReader = require('../../utilities/configuration-reader'); +var ConfigurationReader = require('../utilities/configuration-reader'); module.exports = { name: 'deploy', diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index dc185a72..89c8dc5b 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -1,7 +1,7 @@ var chalk = require('chalk'); var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../../utilities/configuration-reader'); -var AdapterRegistry = require('../../utilities/adapter-registry'); +var ConfigurationReader = require('../utilities/configuration-reader'); +var AdapterRegistry = require('../utilities/adapter-registry'); var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('ember-cli/lib/errors/silent'); diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 20e56f6f..b5b75059 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -1,5 +1,5 @@ var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../../utilities/configuration-reader'); +var ConfigurationReader = require('../utilities/configuration-reader'); var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('ember-cli/lib/errors/silent'); var chalk = require('chalk'); @@ -10,7 +10,7 @@ var ncp = Promise.denodeify(require('ncp')); var white = chalk.white; var green = chalk.green; -var AssetsUploader = require('../../utilities/assets-uploader'); +var AssetsUploader = require('../utilities/assets-uploader'); var EXPIRE_IN_2030 = new Date('2030'); var TWO_YEAR_CACHE_PERIOD_IN_SEC = 60 * 60 * 24 * 365 * 2; diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 93d99842..f1a57958 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -1,5 +1,5 @@ -var ConfigurationReader = require('../../utilities/configuration-reader'); -var AdapterRegistry = require('../../utilities/adapter-registry'); +var ConfigurationReader = require('../utilities/configuration-reader'); +var AdapterRegistry = require('../utilities/adapter-registry'); var Promise = require('ember-cli/lib/ext/promise'); var Task = require('ember-cli/lib/models/task'); var chalk = require('chalk'); diff --git a/lib/tasks/list.js b/lib/tasks/list.js index 9e678b39..ae000a51 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -1,7 +1,7 @@ var chalk = require('chalk'); var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../../utilities/configuration-reader'); -var AdapterRegistry = require('../../utilities/adapter-registry'); +var ConfigurationReader = require('../utilities/configuration-reader'); +var AdapterRegistry = require('../utilities/adapter-registry'); module.exports = Task.extend({ run: function(options) { diff --git a/utilities/adapter-registry.js b/lib/utilities/adapter-registry.js similarity index 100% rename from utilities/adapter-registry.js rename to lib/utilities/adapter-registry.js diff --git a/utilities/adapter.js b/lib/utilities/adapter.js similarity index 100% rename from utilities/adapter.js rename to lib/utilities/adapter.js diff --git a/utilities/assets-uploader.js b/lib/utilities/assets-uploader.js similarity index 100% rename from utilities/assets-uploader.js rename to lib/utilities/assets-uploader.js diff --git a/utilities/assets/unknown.js b/lib/utilities/assets/unknown.js similarity index 100% rename from utilities/assets/unknown.js rename to lib/utilities/assets/unknown.js diff --git a/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js similarity index 95% rename from utilities/configuration-reader.js rename to lib/utilities/configuration-reader.js index 2445916c..228c96ad 100644 --- a/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -1,6 +1,6 @@ var path = require('path'); -var Config = require('../lib/models/config'); var deprecate = require('./deprecate'); +var Config = require('../models/config'); function ConfigurationReader(options) { var root = process.cwd(); diff --git a/utilities/deprecate.js b/lib/utilities/deprecate.js similarity index 100% rename from utilities/deprecate.js rename to lib/utilities/deprecate.js diff --git a/utilities/tagging/sha.js b/lib/utilities/tagging/sha.js similarity index 100% rename from utilities/tagging/sha.js rename to lib/utilities/tagging/sha.js diff --git a/node-tests/unit/utilities/adapter-registry-test.js b/node-tests/unit/utilities/adapter-registry-test.js index 7e832f16..e35c9122 100644 --- a/node-tests/unit/utilities/adapter-registry-test.js +++ b/node-tests/unit/utilities/adapter-registry-test.js @@ -1,7 +1,7 @@ /* jshint expr:true */ -var Adapter = require('../../../utilities/adapter'); -var AdapterRegistry = require('../../../utilities/adapter-registry'); -var UnknownAdapter = require('../../../utilities/assets/unknown'); +var Adapter = require('../../../lib/utilities/adapter'); +var AdapterRegistry = require('../../../lib/utilities/adapter-registry'); +var UnknownAdapter = require('../../../lib/utilities/assets/unknown'); var expect = require('chai').expect; var MockRedisAdapter = Adapter.extend(); diff --git a/node-tests/unit/utilities/assets-uploader-test.js b/node-tests/unit/utilities/assets-uploader-test.js index 94db5eae..fb2572f1 100644 --- a/node-tests/unit/utilities/assets-uploader-test.js +++ b/node-tests/unit/utilities/assets-uploader-test.js @@ -1,5 +1,5 @@ -var UnknownAdapter = require('../../../utilities/assets/unknown'); -var AssetsUploader = require('../../../utilities/assets-uploader'); +var UnknownAdapter = require('../../../lib/utilities/assets/unknown'); +var AssetsUploader = require('../../../lib/utilities/assets-uploader'); var expect = require('chai').expect; describe('AssetsUploader', function() { diff --git a/node-tests/unit/utilities/assets/unknown-test.js b/node-tests/unit/utilities/assets/unknown-test.js index ceec3dd0..0bc554f5 100644 --- a/node-tests/unit/utilities/assets/unknown-test.js +++ b/node-tests/unit/utilities/assets/unknown-test.js @@ -1,6 +1,6 @@ var chai = require('chai'); var chaiAsPromised = require('chai-as-promised'); -var UnknownAdapter = require('../../../../utilities/assets/unknown'); +var UnknownAdapter = require('../../../../lib/utilities/assets/unknown'); chai.use(chaiAsPromised); diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 43bc3f06..801b80e8 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -1,4 +1,4 @@ -var ConfigurationReader = require('../../../utilities/configuration-reader'); +var ConfigurationReader = require('../../../lib/utilities/configuration-reader'); var expect = require('chai').expect; var path = require('path'); var MockUI = require('ember-cli/tests/helpers/mock-ui'); diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 73457fbe..5116b032 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -1,6 +1,6 @@ var expect = require('chai').expect; var sinon = require('sinon'); -var ShaTaggingAdapter = require('../../../../utilities/tagging/sha'); +var ShaTaggingAdapter = require('../../../../lib/utilities/tagging/sha'); var getShortShaVersion = function(sha) { return sha.slice(0,7); From faf2b152de3577b74c7ba5146e33e9d804fb7b26 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 1 Mar 2015 14:41:06 +0100 Subject: [PATCH 042/300] Update CodeClimate batch. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 8aeab36a..3646b24f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ember-cli-deploy [![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/LevelbossMike/ember-deploy/badges/gpa.svg)](https://codeclimate.com/github/LevelbossMike/ember-deploy) +# ember-cli-deploy [![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/ember-cli/ember-cli-deploy/badges/gpa.svg)](https://codeclimate.com/github/ember-cli/ember-cli-deploy) An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps` From a8afaa3d026bda836022305b89d86b63fcf4ee48 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 28 Feb 2015 23:33:20 -0500 Subject: [PATCH 043/300] =?UTF-8?q?Fix=20regression=20to=20the=20type=20of?= =?UTF-8?q?=20object=20that=20was=20being=20passed=20to=20assets=20adapter?= =?UTF-8?q?s=20as=20=E2=80=9Cconfig=E2=80=9D.=20Closes=20#62?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Slight refactoring to AssetsTask to make it’s interaction with AssetsUploader more testable * this change means we are not being as lazy with default values as before. That’s ok. * ConfigurationReader now needs to be constructed with a project reference --- lib/commands/deploy.js | 4 +- lib/commands/unsupported/assets.js | 4 +- lib/models/config.js | 64 +++++++++++++------ lib/tasks/assets.js | 9 +-- lib/utilities/configuration-reader.js | 4 +- node-tests/unit/tasks/assets-test.js | 36 +++++++++++ .../utilities/configuration-reader-test.js | 27 +++++--- 7 files changed, 112 insertions(+), 36 deletions(-) create mode 100644 node-tests/unit/tasks/assets-test.js diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 3202d9af..246e374d 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,4 +1,5 @@ var ConfigurationReader = require('../utilities/configuration-reader'); +var AssetsUploader = require('../utilities/assets-uploader'); module.exports = { name: 'deploy', @@ -35,7 +36,8 @@ module.exports = { var assetsTask = new AssetsTask({ ui: this.ui, analytics: this.analytics, - project: this.project + project: this.project, + AssetsUploader: AssetsUploader }); var deployIndexTask = new DeployIndexTask({ ui: this.ui, diff --git a/lib/commands/unsupported/assets.js b/lib/commands/unsupported/assets.js index 528e32df..f43d541d 100644 --- a/lib/commands/unsupported/assets.js +++ b/lib/commands/unsupported/assets.js @@ -1,4 +1,5 @@ var UnsupportedCommand = require('./unsupported-command'); +var AssetsUploader = require('../../utilities/assets-uploader'); module.exports = UnsupportedCommand({ name: 'deploy:assets', @@ -15,7 +16,8 @@ module.exports = UnsupportedCommand({ var assetsTask = new AssetsTask({ ui: this.ui, analytics: this.analytics, - project: this.project + project: this.project, + AssetsUploader: AssetsUploader }); return assetsTask.run(commandOptions); diff --git a/lib/models/config.js b/lib/models/config.js index 53422744..475ad769 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -18,10 +18,53 @@ function getPath(config, propertyPath) { return node; } +function setPath(config, propertyPath, value) { + var parts = propertyPath.split('.'); + var lastPropertyPath = parts.pop() + function read(node, part){ + if (node) { + return node[part]; + } else { + return undefined; + } + } + var node = config; + var part = parts.shift() + while (part !== undefined && part !== null) { + node = read(node, part); + part = parts.shift(); + } + node[lastPropertyPath] = value; +} + module.exports = CoreObject.extend({ init: function() { this._config = this.rawConfig; + this._defaultPropertyPaths = { + 'assets.gzip': true, + 'assets.gzipExtensions': ['js', 'css', 'svg'], + 'assets.type': 's3', + 'buildEnv': 'production', + 'manifestPrefix': this.project.name(), + 'store.manifestSize': 10, + 'store.type': 'redis', + 'tagging': 'sha' + }; + }, + + // This is a temporary method to preserve an API where we are giving an + // adapter a reference to the whole, raw config as a POJO. Remove it + // once we move away from that + _materialize: function(){ + var materialized = JSON.parse(JSON.stringify(this._config)); + var defaultPropertyPaths = this._defaultPropertyPaths; + Object.keys(defaultPropertyPaths).forEach(function(propertyPath){ + if (!getPath(this._config, propertyPath)) { + setPath(materialized, propertyPath, defaultPropertyPaths[propertyPath]); + } + }); + return materialized; }, get: function(propertyPath) { var configValue = getPath(this._config, propertyPath); @@ -32,25 +75,6 @@ module.exports = CoreObject.extend({ } }, defaultFor: function(propertyPath) { - switch(propertyPath) { - case 'buildEnv': - return 'production'; - case 'manifestPrefix': - return this.project.name(); - case 'assets.gzip': - return true; - case 'assets.type': - return 's3'; - case 'assets.gzipExtensions': - return ['js', 'css', 'svg']; - case 'store.type': - return 'redis'; - case 'store.manifestSize': - return 10; - case 'tagging': - return 'sha'; - default: - return undefined; - } + return this._defaultPropertyPaths[propertyPath]; } }); diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index b5b75059..0a52b193 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -10,8 +10,6 @@ var ncp = Promise.denodeify(require('ncp')); var white = chalk.white; var green = chalk.green; -var AssetsUploader = require('../utilities/assets-uploader'); - var EXPIRE_IN_2030 = new Date('2030'); var TWO_YEAR_CACHE_PERIOD_IN_SEC = 60 * 60 * 24 * 365 * 2; @@ -22,11 +20,12 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, + project: this.project, ui: this.ui }).config; var fileTreeOrPath; - if(config.get('assets.gzip') === false) { + if (config.get('assets.gzip') === false) { fileTreeOrPath = 'dist'; } else { var gzipFiles = require('broccoli-gzip'); @@ -51,12 +50,14 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: environment, configFile: configFile, + project: this.project, ui: this.ui }).config; + var AssetsUploader = this.AssetsUploader; var assetsUploader = new AssetsUploader({ ui: this.ui, - config: config, + config: config._materialize(), type: config.get('assets.type'), project: this.project }); diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index 228c96ad..63ad13c0 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -11,6 +11,7 @@ function ConfigurationReader(options) { this._deployConfig = this._options.configFile || defaultConfigPath; var ui = options.ui; + var project = options.project; deprecate( "Using a .json file for deployment configuration is deprecated. Please use a .js file instead", @@ -24,8 +25,9 @@ function ConfigurationReader(options) { ui.writeError(e); throw new Error('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); } + this.config = new Config({ - project: this.project, + project: project, rawConfig: this._config[this._environment] }); } diff --git a/node-tests/unit/tasks/assets-test.js b/node-tests/unit/tasks/assets-test.js new file mode 100644 index 00000000..6b7a0ae6 --- /dev/null +++ b/node-tests/unit/tasks/assets-test.js @@ -0,0 +1,36 @@ +var CoreObject = require('core-object'); +var AssetsTask = require('../../../lib/tasks/assets'); +var MockUI = require('ember-cli/tests/helpers/mock-ui'); +var expect = require('chai').expect; +var path = require('path'); + +describe('AssetsTask', function() { + var ui, project, MockAssetsUploader, mockAssetsUploaderConfig; + + beforeEach(function() { + mockAssetsUploaderConfig = null; + ui = new MockUI(); + project = { name: function(){ return 'foo'; }} + MockAssetsUploader = CoreObject.extend({ + init: function() { + mockAssetsUploaderConfig = this.config; + }, + upload: function(){} + }) + }); + describe('#uploadAssets', function(){ + it('receives a POJO config object (which is a bad idea and we should change this API)', function() { + var root = process.cwd(); + var task = new AssetsTask({ + ui: ui, + AssetsUploader: MockAssetsUploader, + project: project + }); + var configFile = require(path.join(root, './config/deploy.js')); + task.uploadAssets('development', 'config/deploy.js'); + expect(mockAssetsUploaderConfig.assets).to.be.exist; + expect(mockAssetsUploaderConfig.assets.bucket).to.equal(''); + expect(mockAssetsUploaderConfig.assets.type).to.equal('s3'); + }); + }); +}); diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 801b80e8..a944d3c1 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -6,17 +6,19 @@ var EOL = require('os').EOL; var chalk = require('chalk'); describe('ConfigurationReader', function() { - var ui; + var ui, project; beforeEach(function() { ui = new MockUI(); + project = { name: function(){ return 'foo'; }} }); describe('environment settings', function() { it('knows about its passed _environment', function() { var config = new ConfigurationReader({ environment: 'staging', - ui: ui + ui: ui, + project: project }); expect(config._environment).to.equal('staging'); @@ -24,7 +26,8 @@ describe('ConfigurationReader', function() { it('`development` is default when no environment is passed', function() { var config = new ConfigurationReader({ - ui: ui + ui: ui, + project: project }); expect(config._environment).to.equal('development'); @@ -40,7 +43,8 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ configFile: configPath, - ui: ui + ui: ui, + project: project }); expect(ui.output).to.include('DEPRECATION: Using a .json file for deployment configuration is deprecated. Please use a .js file instead'); @@ -55,7 +59,8 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ configFile: configPath, - ui: ui + ui: ui, + project: project }); expect(config._config).to.equal(expectedConfig); @@ -66,7 +71,8 @@ describe('ConfigurationReader', function() { var expectedConfig = require(path.join(root, './config/deploy.js')); var config = new ConfigurationReader({ - ui: ui + ui: ui, + project: project }); expect(config._config).to.equal(expectedConfig) @@ -79,7 +85,8 @@ describe('ConfigurationReader', function() { expect(function() { var config = new ConfigurationReader({ configFile: configPath, - ui: ui + ui: ui, + project: project }); }).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); }); @@ -96,7 +103,8 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ environment: ENV, - ui: ui + ui: ui, + project: project }).config; expect(config.get('store')).to.deep.equal(expected); @@ -115,7 +123,8 @@ describe('ConfigurationReader', function() { var config = new ConfigurationReader({ environment: ENV, - ui: ui + ui: ui, + project: project }).config; expect(config.get('assets')).to.deep.equal(expected); From a60b72791ffed8baf6201835abefa58d6e00a1d9 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 1 Mar 2015 15:04:36 +0100 Subject: [PATCH 044/300] Add note for fingerprint.prepend and staging envs. Closes #43. --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 8aeab36a..f7ee3413 100644 --- a/README.md +++ b/README.md @@ -121,6 +121,43 @@ This is an example of how one would use this addon to deploy an ember-cli app: * `ember deploy:list --environment production` (this will print out a list of revisions) * `ember deploy:activate --revision ember-deploy:44f2f92 --environment production ` +## Fingerprinting Options / Staging environments + +`ember-cli` comes with [fingerprinting +support](http://www.ember-cli.com/#fingerprinting-and-cdn-urls) built-in. In +most production scenarios you will need to provide a `prepend`-property to your +app's fingerprint-property (to reference your CDN served assets correctly). + +```javascript +// Brocfile.js +var app = new EmberApp({ + fingerprint: { + prepend: 'https://subdomain.cloudfront.net/' + } +}); +``` + +`ember-cli` will only create a production like build for the +`production`-environment by default. If you want to support multiple +'production-like' environments you need to configure minification for these +environments manually. You can do someting like this: + +```javascript +// Brocfile.js +var env = EmberApp.env(); +var isProductionLikeBuild = ['production', 'staging'].indexOf(env) > -1; + +var app = new EmberApp({ + fingerprint: { + prepend: 'https://subdomain.cloudfront.net/' + }, + + minifyAssets: { enabled: isProductionLikeBuild }, + + minifyJS: { enabled: isProductionLikeBuild } +}); +``` + ## S3-Asset uploads `ember-deploy-s3` sets the correct cache headers for you. Currently these are hard coded to a two year cache period. Assets are also gzipped before uploading to S3. This should be enough to cache aggressively and you should not run into problems due to ember-cli's fingerprinting support. I will try to add more configuration options for caching in the near future. From fd3971163ccdd7df74ebf28eda3754c378b3dbcd Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Sun, 1 Mar 2015 22:32:06 -0500 Subject: [PATCH 045/300] ensure project is passed into all configuration readers Noticed this as a regression. Will work to add some tests around the tasks to catch this in the future. --- lib/commands/deploy.js | 1 + lib/tasks/activate.js | 1 + lib/tasks/deploy-index.js | 1 + lib/tasks/list.js | 1 + 4 files changed, 4 insertions(+) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 246e374d..7025aa38 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -19,6 +19,7 @@ module.exports = { var config = new ConfigurationReader({ environment: commandOptions.environment, configFile: commandOptions.deployConfigFile, + project: this.project, ui: this.ui }).config; var buildTask = new BuildTask({ diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index 89c8dc5b..e57a8d66 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -15,6 +15,7 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, + project: this.project, ui: ui }).config; var adapterType = config.get('store.type'); diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index f1a57958..75896910 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -13,6 +13,7 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, + project: this.project, ui: ui }).config; diff --git a/lib/tasks/list.js b/lib/tasks/list.js index ae000a51..3df646d9 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -9,6 +9,7 @@ module.exports = Task.extend({ var config = new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, + project: this.project, ui: ui }).config; var adapterType = config.get('store.type'); From 05050dc2abf1471660815256bcc4f999176b3e7b Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Tue, 3 Mar 2015 07:31:51 -0500 Subject: [PATCH 046/300] Revert "Commands are now `No Longer Supported` as opposed to deprecated`" This reverts commit e4e6e2a27274b381948bac3ea3d10faa7c617366. Closes #72 --- lib/commands/{unsupported => deprecated}/activate.js | 4 ++-- lib/commands/{unsupported => deprecated}/assets.js | 4 ++-- lib/commands/{unsupported => deprecated}/deploy-index.js | 4 ++-- .../deprecated-command.js} | 4 ++-- lib/commands/{unsupported => deprecated}/versions.js | 4 ++-- lib/commands/index.js | 8 ++++---- 6 files changed, 14 insertions(+), 14 deletions(-) rename lib/commands/{unsupported => deprecated}/activate.js (71%) rename lib/commands/{unsupported => deprecated}/assets.js (88%) rename lib/commands/{unsupported => deprecated}/deploy-index.js (87%) rename lib/commands/{unsupported/unsupported-command.js => deprecated/deprecated-command.js} (52%) rename lib/commands/{unsupported => deprecated}/versions.js (69%) diff --git a/lib/commands/unsupported/activate.js b/lib/commands/deprecated/activate.js similarity index 71% rename from lib/commands/unsupported/activate.js rename to lib/commands/deprecated/activate.js index e6f04b25..4938864e 100644 --- a/lib/commands/unsupported/activate.js +++ b/lib/commands/deprecated/activate.js @@ -1,6 +1,6 @@ -var UnsupportedCommand = require('./unsupported-command'); +var DeprecatedCommand = require('./deprecated-command'); -module.exports = UnsupportedCommand({ +module.exports = DeprecatedCommand({ name: 'activate', description: 'Activate a deployed version of index.html', works: 'insideProject', diff --git a/lib/commands/unsupported/assets.js b/lib/commands/deprecated/assets.js similarity index 88% rename from lib/commands/unsupported/assets.js rename to lib/commands/deprecated/assets.js index f43d541d..2953b707 100644 --- a/lib/commands/unsupported/assets.js +++ b/lib/commands/deprecated/assets.js @@ -1,7 +1,7 @@ -var UnsupportedCommand = require('./unsupported-command'); var AssetsUploader = require('../../utilities/assets-uploader'); +var DeprecatedCommand = require('./deprecated-command'); -module.exports = UnsupportedCommand({ +module.exports = DeprecatedCommand({ name: 'deploy:assets', description: 'Deploys assets to an asset-host (default: aws:s3)', works: 'insideProject', diff --git a/lib/commands/unsupported/deploy-index.js b/lib/commands/deprecated/deploy-index.js similarity index 87% rename from lib/commands/unsupported/deploy-index.js rename to lib/commands/deprecated/deploy-index.js index a2f657a6..6419fbe5 100644 --- a/lib/commands/unsupported/deploy-index.js +++ b/lib/commands/deprecated/deploy-index.js @@ -1,6 +1,6 @@ -var UnsupportedCommand = require('./unsupported-command'); +var DeprecatedCommand = require('./deprecated-command'); -module.exports = UnsupportedCommand({ +module.exports = DeprecatedCommand({ name: 'deploy:index', description: 'Deploys index to key-value store (default: redis)', works: 'insideProject', diff --git a/lib/commands/unsupported/unsupported-command.js b/lib/commands/deprecated/deprecated-command.js similarity index 52% rename from lib/commands/unsupported/unsupported-command.js rename to lib/commands/deprecated/deprecated-command.js index 90fb9f10..d8a4a7b8 100644 --- a/lib/commands/unsupported/unsupported-command.js +++ b/lib/commands/deprecated/deprecated-command.js @@ -3,9 +3,9 @@ var SilentError = require('ember-cli/lib/errors/silent'); module.exports = function(command) { var description = command.description || ''; - command.description = chalk.red('[NO LONGER SUPPORTED] ') + description; + command.description = chalk.red('[DEPRECATED] ') + description; command.run = function() { - throw new SilentError('This command is no longer supported. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); + throw new SilentError('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); } return command; diff --git a/lib/commands/unsupported/versions.js b/lib/commands/deprecated/versions.js similarity index 69% rename from lib/commands/unsupported/versions.js rename to lib/commands/deprecated/versions.js index d12e1257..5adbc71c 100644 --- a/lib/commands/unsupported/versions.js +++ b/lib/commands/deprecated/versions.js @@ -1,6 +1,6 @@ -var UnsupportedCommand = require('./unsupported-command'); +var DeprecatedCommand = require('./deprecated-command'); -module.exports = UnsupportedCommand({ +module.exports = DeprecatedCommand({ name: 'deploy:versions', description: 'Lists all versions of the app have been deployed', works: 'insideProject', diff --git a/lib/commands/index.js b/lib/commands/index.js index d8b281be..707d12a6 100644 --- a/lib/commands/index.js +++ b/lib/commands/index.js @@ -3,8 +3,8 @@ module.exports = { "deploy:activate": require('./activate'), "deploy:list": require('./list'), - "deploy:assets": require('./unsupported/assets'), - "deploy:index": require('./unsupported/deploy-index'), - "activate": require('./unsupported/activate'), - "deploy:versions": require('./unsupported/versions') + "deploy:assets": require('./deprecated/assets'), + "deploy:index": require('./deprecated/deploy-index'), + "activate": require('./deprecated/activate'), + "deploy:versions": require('./deprecated/versions') }; From fe5f6536341cfa0469ed7c0f6f96e69ba5bedfb6 Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Tue, 3 Mar 2015 08:36:33 -0500 Subject: [PATCH 047/300] update deprecated-command to wrap a command run --- lib/commands/deprecated/deprecated-command.js | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/lib/commands/deprecated/deprecated-command.js b/lib/commands/deprecated/deprecated-command.js index d8a4a7b8..78a8ae08 100644 --- a/lib/commands/deprecated/deprecated-command.js +++ b/lib/commands/deprecated/deprecated-command.js @@ -1,12 +1,15 @@ var chalk = require('chalk'); -var SilentError = require('ember-cli/lib/errors/silent'); module.exports = function(command) { var description = command.description || ''; command.description = chalk.red('[DEPRECATED] ') + description; - command.run = function() { - throw new SilentError('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.'); - } + + var oldRun = command.run; + command.run = function () { + var message = chalk.red('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.\n'); + this.ui.writeLine(message, 'WARNING'); + return oldRun.apply(this, arguments); + }; return command; }; From 62848219813e84669f02c2cae51292b375e64d0b Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Tue, 3 Mar 2015 08:38:02 -0500 Subject: [PATCH 048/300] re-enable old ember-cli-deploy commands support `ember deploy:versions` and `ember activate` for release 0.4.0 to support users on the original ember-cli-deploy npm package. --- lib/commands/deprecated/activate.js | 20 ++++++++++++++++++-- lib/commands/deprecated/versions.js | 8 ++++++-- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/lib/commands/deprecated/activate.js b/lib/commands/deprecated/activate.js index 4938864e..468d0038 100644 --- a/lib/commands/deprecated/activate.js +++ b/lib/commands/deprecated/activate.js @@ -1,4 +1,8 @@ +var chalk = require('chalk'); +var Promise = require('ember-cli/lib/ext/promise'); +var SilentError = require('ember-cli/lib/errors/silent'); var DeprecatedCommand = require('./deprecated-command'); +var ActivateCommand = require('../activate'); module.exports = DeprecatedCommand({ name: 'activate', @@ -10,6 +14,18 @@ module.exports = DeprecatedCommand({ ], availableOptions: [ - { name: 'environment', type: String, default: 'development' } - ] + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } + ], + + run: function (commandOptions, rawArgs) { + var key = rawArgs[0]; + if(!key) { + var message = chalk.yellow('The `ember activate` command requires a deploy version to be specified.'); + return Promise.reject(new SilentError(message)); + } + commandOptions.revision = key; + return ActivateCommand.run.apply(this, arguments); + } + }); diff --git a/lib/commands/deprecated/versions.js b/lib/commands/deprecated/versions.js index 5adbc71c..902525f1 100644 --- a/lib/commands/deprecated/versions.js +++ b/lib/commands/deprecated/versions.js @@ -1,4 +1,5 @@ var DeprecatedCommand = require('./deprecated-command'); +var ListCommand = require('../list'); module.exports = DeprecatedCommand({ name: 'deploy:versions', @@ -6,6 +7,9 @@ module.exports = DeprecatedCommand({ works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development' } - ] + { name: 'environment', type: String, default: 'development' }, + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } + ], + + run: ListCommand.run }); From b15eacb523bd7832a4e7c898ec2fcd7827cd4e75 Mon Sep 17 00:00:00 2001 From: Dan Shultz Date: Tue, 3 Mar 2015 08:38:36 -0500 Subject: [PATCH 049/300] fix requires in `deploy:assets` and `deploy:index` --- lib/commands/deprecated/assets.js | 2 +- lib/commands/deprecated/deploy-index.js | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/commands/deprecated/assets.js b/lib/commands/deprecated/assets.js index 2953b707..5ebc9eb0 100644 --- a/lib/commands/deprecated/assets.js +++ b/lib/commands/deprecated/assets.js @@ -12,7 +12,7 @@ module.exports = DeprecatedCommand({ ], run: function(commandOptions, rawArgs) { - var AssetsTask = require('../tasks/assets'); + var AssetsTask = require('../../tasks/assets'); var assetsTask = new AssetsTask({ ui: this.ui, analytics: this.analytics, diff --git a/lib/commands/deprecated/deploy-index.js b/lib/commands/deprecated/deploy-index.js index 6419fbe5..749dab36 100644 --- a/lib/commands/deprecated/deploy-index.js +++ b/lib/commands/deprecated/deploy-index.js @@ -11,7 +11,7 @@ module.exports = DeprecatedCommand({ ], run: function(commandOptions, rawArgs) { - var DeployIndexTask = require('../tasks/deploy-index'); + var DeployIndexTask = require('../../tasks/deploy-index'); var deployIndexTask = new DeployIndexTask({ ui: this.ui, analytics: this.analytics, From 0c4562d80063cd803f491f2e6256ecd1bb4bb3b0 Mon Sep 17 00:00:00 2001 From: Robert Jackson Date: Wed, 4 Mar 2015 10:19:26 -0800 Subject: [PATCH 050/300] Update usage of project name in readme. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 261c045f..a4490124 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,9 @@ This project includes the necessary commands for 'Lightning Fast Deployments of Ember-CLI Apps'. The whole workflow is heavily inspired by Luke Melia's talk about [Lightning Fast Deployment(s) of Rails-backed Javascript Apps](https://www.youtube.com/watch?v=QZVYP3cPcWQ). -`ember-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about `custom adapters` on how to get started with your own deployment strategy with `ember-deploy`. +`ember-cli-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about `custom adapters` on how to get started with your own deployment strategy with `ember-cli-deploy`. -You can also have a look on how to use this ember-cli-addon in the following video of a talk about `ember-deploy` I gave at [Ember.js-Munich](http://www.meetup.com/Ember-js-Munich/) (demo starts around 7 minutes into the video). +You can also have a look on how to use this ember-cli-addon in the following video of a talk about `ember-cli-deploy` I gave at [Ember.js-Munich](http://www.meetup.com/Ember-js-Munich/) (demo starts around 7 minutes into the video). ![ember-deploy talk](http://img.youtube.com/vi/Ro2_I5vtTIg/0.jpg) @@ -17,7 +17,7 @@ You can also have a look on how to use this ember-cli-addon in the following vid Simply run ``` -npm install ember-deploy --save-dev +npm install ember-cli-deploy --save-dev ``` and the new commands will be available in your ember-cli app! From 02b92bf8aeba1bda586649549e0ed8a8cb32917d Mon Sep 17 00:00:00 2001 From: Ilya Radchenko Date: Thu, 5 Mar 2015 10:38:42 -0500 Subject: [PATCH 051/300] Cleanup config example --- README.md | 63 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 32 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index a4490124..801b842d 100644 --- a/README.md +++ b/README.md @@ -67,48 +67,49 @@ By default, `ember-deploy` expects a `deploy.js` file in the `config/` directory ```js module.exports = { - "development": { - "store": { - "type": "redis", // the default store is 'redis' - "host": "localhost", - "port": 6379 + development: { + buildEnv: 'development', // Override the environment passed to the ember asset build. Defaults to 'production' + store: { + type: 'redis', // the default store is 'redis' + host: 'localhost', + port: 6379 }, - "assets": { - "type": "s3", // default asset-adapter is 's3' - "gzip": false, // if undefined or set to true, files are gziped - "gzipExtensions": ["js", "css", "svg"], // if undefined, js, css & svg files are gziped - "accessKeyId": "", - "secretAccessKey": process.env['AWS_ACCESS_KEY'], - "bucket": "" + assets: { + type: 's3', // default asset-adapter is 's3' + gzip: false, // if undefined or set to true, files are gziped + gzipExtensions: ['js', 'css', 'svg'], // if undefined, js, css & svg files are gziped + accessKeyId: '', + secretAccessKey: process.env['AWS_ACCESS_KEY'], + bucket: '' } }, - "staging": { - "buildEnv": "staging", // Override the environment passed to the ember asset build. Defaults to 'production' - "store": { - "host": "staging-redis.example.com", - "port": 6379 + staging: { + buildEnv: 'staging', // Override the environment passed to the ember asset build. Defaults to 'production' + store: { + host: 'staging-redis.example.com", + port: 6379 }, - "assets": { - "accessKeyId": "", - "secretAccessKey": process.env['AWS_ACCESS_KEY'], - "bucket": "" + assets": { + accessKeyId: '', + secretAccessKey: process.env['AWS_ACCESS_KEY'], + bucket: '' } }, - "production": { - "store": { - "host": "production-redis.example.com", - "port": 6379, - "password": "" + production: { + store: { + host: 'production-redis.example.com', + port: 6379, + password: '' }, - "assets": { - "accessKeyId": "", - "secretAccessKey": process.env['AWS_ACCESS_KEY'], - "bucket": "" + assets: { + accessKeyId: '', + secretAccessKey: process.env['AWS_ACCESS_KEY'], + bucket: '' } } -} +}; ``` You must have an entry for every environment you want to use in this file. From 92faef36d75f795d8c8184bbe743695952aaab4d Mon Sep 17 00:00:00 2001 From: Ilya Radchenko Date: Thu, 5 Mar 2015 10:45:15 -0500 Subject: [PATCH 052/300] Remove quote, typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 801b842d..caead8e1 100644 --- a/README.md +++ b/README.md @@ -90,7 +90,7 @@ module.exports = { host: 'staging-redis.example.com", port: 6379 }, - assets": { + assets: { accessKeyId: '', secretAccessKey: process.env['AWS_ACCESS_KEY'], bucket: '' From d0f47a65bdf5b6d73e917f0633083cbfb437f7a4 Mon Sep 17 00:00:00 2001 From: Ilya Radchenko Date: Thu, 5 Mar 2015 11:11:30 -0500 Subject: [PATCH 053/300] Another incorrect quote I promise this is the last one --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index caead8e1..fa39cc7c 100644 --- a/README.md +++ b/README.md @@ -87,7 +87,7 @@ module.exports = { staging: { buildEnv: 'staging', // Override the environment passed to the ember asset build. Defaults to 'production' store: { - host: 'staging-redis.example.com", + host: 'staging-redis.example.com', port: 6379 }, assets: { From 4781aee2cc273682f859a06589e46c59d72be1e8 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 7 Mar 2015 13:55:14 -0500 Subject: [PATCH 054/300] Name fixes from knownasilya. Closes #81 Squashed commit of the following: commit 8eddfa98514593f92518b5521b0a94fd0d7abca3 Author: Ilya Radchenko Date: Thu Mar 5 10:43:35 2015 -0500 More name fixes ember-deploy to ember-cli-deploy --- README.md | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fa39cc7c..797773cc 100644 --- a/README.md +++ b/README.md @@ -32,15 +32,15 @@ This Ember-CLI Addon adds multiple deployment related tasks to your Ember-CLI Ap * `ember deploy:activate` Activates an uploaded `revision`. This will set the `:current` revision to the passed revision. `:current` is the revision you will serve your users as default. * `ember deploy` This commands builds your ember application, uploads it to your file hoster and uploads it to your key value store in one step. -You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-deploy` will use the `development`-environment. +You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-cli-deploy` will use the `development`-environment. You can pass `--deploy-config-file ` to every command. If you don't pass a deploy-config-file explicitly `config/deploy.js` will be read. ## Lightning-Approach Workflow -`ember-deploy` is built around the idea of adapters for custom deployment strategies but for most people the approach Luke suggest in his talk will be a perfect fit. +`ember-cli-deploy` is built around the idea of adapters for custom deployment strategies but for most people the approach Luke suggest in his talk will be a perfect fit. -To use the Lightning-Approach workflow from Luke's talk you will also need to install the redis- and s3-adapters for `ember-deploy`: +To use the Lightning-Approach workflow from Luke's talk you will also need to install the redis- and s3-adapters for `ember-cli-deploy`: ``` npm install ember-deploy-redis ember-deploy-s3 --save-dev @@ -63,7 +63,7 @@ If you don't install the redis- and s3-adapters you will need to use a custom ad ## Config file -By default, `ember-deploy` expects a `deploy.js` file in the `config/` directory of your Ember-CLI project root. In this file you tell `ember-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: +By default, `ember-cli-deploy` expects a `deploy.js` file in the `config/` directory of your Ember-CLI project root. In this file you tell `ember-cli-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: ```js module.exports = { @@ -165,7 +165,7 @@ var app = new EmberApp({ ### Example Sinatra app -This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-deploy` and `ember-deploy-redis`. +This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-cli-deploy` and `ember-deploy-redis`. ```ruby require 'sinatra' @@ -187,17 +187,17 @@ The nice thing about this is that you can deploy your app to production, test it ### Example nodejs app -This app does the same as the *Sinatra app* from before, it supports the same index_key query param. It should help you to get up and running in seconds and dont worry about server code. You also need to deploy your ember app with `ember-deploy` and `ember-deploy-redis`. +This app does the same as the *Sinatra app* from before, it supports the same index_key query param. It should help you to get up and running in seconds and dont worry about server code. You also need to deploy your ember app with `ember-cli-deploy` and `ember-deploy-redis`. [Nodejs example with one click deploy!](https://github.com/philipheinser/ember-lightning) ## Custom Adapters -`ember-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. For `ember-deploy` to give you the deployment approach Luke talks about in his talk you will for example need to install the `ember-deploy-redis` and `ember-deploy-s3` adapters via npm. +`ember-cli-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. For `ember-cli-deploy` to give you the deployment approach Luke talks about in his talk you will for example need to install the `ember-deploy-redis` and `ember-deploy-s3` adapters via npm. -Because `ember-deploy` is built with adapters in mind you can write your own adapters for your project specific use cases. +Because `ember-cli-deploy` is built with adapters in mind you can write your own adapters for your project specific use cases. -Custom Adapters can be integrated via custom [Ember-CLI-Addons](http://www.ember-cli.com/#developing-addons-and-blueprints). For `ember-deploy` to integrate your custom adapter addons you have to define your addon-type as an `ember-deploy-addon`. +Custom Adapters can be integrated via custom [Ember-CLI-Addons](http://www.ember-cli.com/#developing-addons-and-blueprints). For `ember-cli-deploy` to integrate your custom adapter addons you have to define your addon-type as an `ember-deploy-addon`. You can have a look at [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3) and [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis) to get an idea how one would implement 'real-world'-adapters. @@ -212,7 +212,7 @@ function EmberDeploySuperAwesome() { this.name = 'ember-deploy-super-awesome'; this.type = 'ember-deploy-addon'; - // ember-deploy will merge ember-deploy-addon's adapters property + // ember-cli-deploy will merge ember-deploy-addon's adapters property this.adapters = { index: { 'super-awesome': SuperAwesomeCustomIndexAdapter @@ -230,9 +230,9 @@ function EmberDeploySuperAwesome() { module.exports = EmberDeploySuperAwesome; ``` -Because `ember-deploy` will simply merge an `ember-deploy-addon`'s adapters property into its own bundled adapter-registry you could in theory bundle a complete new approach for deploying in one addon (just add an index- and an asset-adapter). +Because `ember-cli-deploy` will simply merge an `ember-deploy-addon`'s adapters property into its own bundled adapter-registry you could in theory bundle a complete new approach for deploying in one addon (just add an index- and an asset-adapter). -After adding your custom ember-deploy-addon to your project as an ember-cli-addon you can then use your custom adapters in ember-deploy's deploy.json: +After adding your custom ember-deploy-addon to your project as an ember-cli-addon you can then use your custom adapters in ember-cli-deploy's deploy.json: ```js { @@ -262,7 +262,7 @@ The following adapters have already been developed: `index-adapters` take care of publishing bootstrap-index html that ember-cli builds for you. If you don't want to use `redis` as a key-value store for your index.html files if you are using the Lightning approach from Luke Melia's talk you could for example create a `cassandra`-adapter to use [Apacha Cassandra](http://cassandra.apache.org/) instead. -Index adapters have to implement the following methods for `ember-deploy` to be able to use them: +Index adapters have to implement the following methods for `ember-cli-deploy` to be able to use them: ####`upload([bootstrapIndexHTML])` @@ -292,7 +292,7 @@ This method has to return a `RSVP.Promise`. ### Asset-Adapters -`asset-adapters` take care of publishing your project assets. In the default use case (Luke Melia's lightning approach) your assets will be published to a static asset server like AWS S3. If you want to use some other static asset server service or you want to do something entirely different you can write your own `asset-adapter`. Asset-Adapters have to implement the following method for ember-deploy to know what to do: +`asset-adapters` take care of publishing your project assets. In the default use case (Luke Melia's lightning approach) your assets will be published to a static asset server like AWS S3. If you want to use some other static asset server service or you want to do something entirely different you can write your own `asset-adapter`. Asset-Adapters have to implement the following method for ember-cli-deploy to know what to do: ####`upload` @@ -302,9 +302,9 @@ This method has to return a `RSVP.Promise`. ### Tagging-Adapters -`tagging-adapters` take care of tagging revisions when uploading revisions via the `deploy-index`-command. `ember-deploy` comes bundled with the `sha`-tagging-adapter that will tag your revisions according to the current git-sha. +`tagging-adapters` take care of tagging revisions when uploading revisions via the `deploy-index`-command. `ember-cli-deploy` comes bundled with the `sha`-tagging-adapter that will tag your revisions according to the current git-sha. -Tagging Adapters need to implement the following method for ember-deploy to know what to do: +Tagging Adapters need to implement the following method for ember-cli-deploy to know what to do: ####`createTag` From 50406a10fde54e136ee9e38d32fc23fc9c9ff89b Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 6 Mar 2015 12:17:09 +0000 Subject: [PATCH 055/300] Added migration instructions for users of `v0.0.6` --- MIGRATION_STEPS.md | 116 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 116 insertions(+) create mode 100644 MIGRATION_STEPS.md diff --git a/MIGRATION_STEPS.md b/MIGRATION_STEPS.md new file mode 100644 index 00000000..f93c8a58 --- /dev/null +++ b/MIGRATION_STEPS.md @@ -0,0 +1,116 @@ +##Overview + +`achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` are coming together to create the offical Ember CLI deployment tool, `ember-cli/ember-cli-deploy`. + +Users upgrading from the `ember-cli-deploy` npm package `<= v0.0.6` to `>= v0.4.0` will need to follow the migration steps below as the core codebase of the package will be changing completely. + +While we are trying our best to maintain backwards compatability for users of `<= v0.0.6`, this will only be temporary and users are strongly urged to migrate ASAP. + +## Migrate config + +Migrate your `<= v0.0.6` config from this: + +```javascript +// config/deploy/staging.js + +module.exports = { + assets: { + accessKeyId: process.env.AWS_ACCESS_KEY, + secretAccessKey: process.env.AWS_SECRET, + bucket: 'staging-bucket', + region: 'eu-west-1' + }, + + index: { + host: 'staging-redis.example.com', + port: '1234' + } +}; +``` + +```javascript +// config/deploy/production.js + +module.exports = { + assets: { + accessKeyId: process.env.AWS_ACCESS_KEY, + secretAccessKey: process.env.AWS_SECRET, + bucket: 'prod-bucket', + region: 'eu-west-1' + }, + + index: { + host: 'production-redis.example.com', + port: '9876', + password: process.env.REDIS_PASSWORD + } +}; +``` + +to this: + +```javascript +// config/deploy.js + +module.exports = { + staging: { + buildEnv: 'staging', + store: { + host: 'staging-redis.example.com', + port: 1234 + }, + assets: { + accessKeyId: process.env.AWS_ACCESS_KEY, + secretAccessKey: process.env.AWS_SECRET, + bucket: 'staging-bucket' + region: 'eu-west-1' + } + }, + + production: { + store: { + host: 'production-redis.example.com', + port: 9876, + password: process.env.REDIS_PASSWORD + }, + assets: { + accessKeyId: process.env.AWS_ACCESS_KEY, + secretAccessKey: process.env.AWS_SECRET, + bucket: 'prod-bucket' + region: 'eu-west-1' + } + } +}; +``` + +## Migrate adapters + +Uninstall the now unsupported adapters: + +```shell +$ npm uninstall ember-cli-deploy-redis-index-adapter --save-dev +``` + +And install the corresponding supported plugins: + +```shell +$ npm install ember-deploy-redis --save-dev + +$ npm install ember-deploy-s3 --save-dev +``` + +## Serving of index.html + +Due to the way `v0.4.0` now stores the list of previous revisions, [achambers/fuzzy-wookie](https://github.com/achambers/fuzzy-wookie) is no longer compatible with ember-cli-deploy. + +If you were using [achambers/fuzzy-wookie](https://github.com/achambers/fuzzy-wookie), please migrate to use [philipheinser/ember-lightning](https://github.com/philipheinser/ember-lightning) instead. + +If you wrote your own server to serve the index.html, you will need to modify it in order for it to work with `v0.4.0`. The breaking change is that instead of storing just `sha` in the list of previous revisions,ember-cli-deploy now stores `app-name:sha`. Please make any changes necessary to your server to support this change. + +## Unsupported commands + +A number of commands became deprecated in `v0.4.0` and will become unsupported in future versions very soon. + +- instead of `ember deploy:index` and `ember deploy:assets`, please use `ember deploy` +- instead of `ember activate`, please use `ember deploy:activate` +- instead of `ember deploy:versions`, please use `ember deploy:list` From 82cca5fbd46a2211cb836e144b1e27d59937b3e0 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 2 Mar 2015 20:26:54 +0000 Subject: [PATCH 056/300] Add warning message for people upgrading achambers/ember-cli-deploy This message is fired only for users that seem to have config from `v0.0.6`. For these users the message will be displayed everytime they run an ember-cli-deploy command --- index.js | 30 +++++++++++++++++++---- lib/utilities/detect-deprecated-config.js | 8 ++++++ 2 files changed, 33 insertions(+), 5 deletions(-) create mode 100644 lib/utilities/detect-deprecated-config.js diff --git a/index.js b/index.js index 83722b3c..3a57e039 100644 --- a/index.js +++ b/index.js @@ -1,5 +1,26 @@ -var path = require('path'); -var commands = require('./lib/commands'); +var path = require('path'); +var commands = require('./lib/commands'); +var red = require('chalk').red; +var grey = require('chalk').grey; +var hasDeprecatedConfig = require('./lib/utilities/detect-deprecated-config'); + +if (hasDeprecatedConfig()) { + console.log(red('\n===========================================================================\n')); + + console.log(red('NOTICE TO USERS OF ember-cli-deploy VERSION <= 0.0.6\n\n')); + + console.log(grey('ember-cli/ember-cli-deploy') + red(' will now be using this npm module to host the\n')); + console.log(red('offial Ember CLI deployment tool.\n\n')); + + console.log(red('Due to the changes being made, you should migrate your project to use the\n')); + console.log(red('new module now.\n\n')); + + console.log(red('For more information on how to migrate from ') + grey('achambers/ember-cli-deploy') + red(' to ') + grey('ember-cli/ember-cli-deploy') + red(', please go to:\n\n')); + + console.log(red('https://github.com/ember-cli/ember-cli-deploy/MIGRATION_STEPS.md')); + + console.log(red('\n===========================================================================\n')); +} function Deploy() { this.name = "ember-cli-deploy" @@ -8,11 +29,10 @@ function Deploy() { Deploy.prototype.includedCommands = function() { return commands; -} +}; Deploy.prototype.blueprintsPath = function() { return path.join(__dirname, 'blueprints'); -}, +}; module.exports = Deploy; - diff --git a/lib/utilities/detect-deprecated-config.js b/lib/utilities/detect-deprecated-config.js new file mode 100644 index 00000000..9450b48d --- /dev/null +++ b/lib/utilities/detect-deprecated-config.js @@ -0,0 +1,8 @@ +var path = require('path'); +var glob = require('glob'); + +module.exports = function() { + var deprecatedConfigPath = path.join(__dirname, '../../../..', 'config', 'deploy', '*.js'); + var files = glob.sync(deprecatedConfigPath); + return files.length > 0; +}; From 714499b24418c181e5e681e97fff589dcd3ee017 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 7 Mar 2015 19:54:17 +0000 Subject: [PATCH 057/300] Added ./bin/changelog --- bin/changelog | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 1 + 2 files changed, 71 insertions(+) create mode 100755 bin/changelog diff --git a/bin/changelog b/bin/changelog new file mode 100755 index 00000000..decdcfef --- /dev/null +++ b/bin/changelog @@ -0,0 +1,70 @@ +#!/usr/bin/env node +'use strict'; + +/* + * This script generates the template a changelog by comparing a current version + * with master. Run this, copy what's logged into the `CHANGELOG.md` and update + * the top section based on the changes listed in "Community Contributions" + * + * Usage: + * + * bin/changelog + */ + +var EOL = require('os').EOL; +var Promise = require('ember-cli/lib/ext/promise'); +var GitHubApi = require('github'); + +var github = new GitHubApi({version: '3.0.0'}); +var compareCommits = Promise.denodeify(github.repos.compareCommits); +var currentVersion = 'v' + require('../package').version; + +compareCommits({ + user: 'ember-cli', + repo: 'ember-cli-deploy', + base: currentVersion, + head: 'master' +}).then(function(res) { + return res.commits.map(function(commitInfo) { + return commitInfo.commit.message + + }).filter(function(message) { + return message.indexOf('Merge pull request #') > -1; + + }).map(function(message) { + var numAndAuthor = message.match(/#(\d+) from (.*)\//).slice(1,3); + var title = message.split('\n\n')[1]; + + return { + number: +numAndAuthor[0], + author: numAndAuthor[1], + title: title + }; + + }).sort(function(a, b) { + return a.number > b.number; + }).map(function(pr) { + var link = '[#' + pr.number + ']' + + '(https://github.com/ember-cli/ember-cli-deploy/pull/' + pr.number + ')'; + var title = pr.title; + var author = '[@' + pr.author + ']' + + '(https://github.com/' + pr.author +')'; + + return '- ' + link + ' ' + title + ' ' + author; + + }).join('\n'); + +}).then(function(contributions) { + var changelog = generateChangelog(contributions); + + console.log(changelog); +}).catch(function(err) { + console.error(err); +}) + +function generateChangelog(contributions) { + var header = '#### Community Contributions'; + var footer = 'Thank you to all who took the time to contribute!'; + + return header + EOL + EOL + contributions + EOL + EOL + footer; +} diff --git a/package.json b/package.json index 86a464f7..64dec06a 100644 --- a/package.json +++ b/package.json @@ -33,6 +33,7 @@ "ember-data": "1.0.0-beta.12", "ember-export-application-global": "^1.0.0", "express": "^4.8.5", + "github": "0.2.3", "glob": "^4.0.5", "mocha": "^2.0.1", "sinon": "^1.12.1" From 95142b3eb8dd07f80a494534264587ffb2813f3c Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 7 Mar 2015 20:11:39 +0000 Subject: [PATCH 058/300] Release 0.4.0 --- .gitignore | 1 + CHANGELOG.md | 23 ++++++++++++++++++++++- package.json | 2 +- 3 files changed, 24 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 1f8dfc23..3681d4e4 100644 --- a/.gitignore +++ b/.gitignore @@ -18,3 +18,4 @@ testem.log deploy_test.json .DS_Store NERD_tree_2 +*.tgz diff --git a/CHANGELOG.md b/CHANGELOG.md index 070d0c53..e29781a7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,25 @@ -# Ember-Deploy Changelog +# ember-cli-deploy Changelog + +### 0.4.0 (March 07, 2015) + +This release marks the merge of `achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` into the official `ember-cli-deploy` + +If you are upgrading from `achambers/ember-cli-deploy v0.0.6`, please follow these [miragtion steps](https://github.com/ember-cli/ember-cli-deploy/blob/master/MIGRATION_STEPS.md); + +#### Community Contributions + +- [#33](https://github.com/ember-cli/ember-cli-deploy/pull/33) [DOCS] Link to new S3 Index Adapter [@pootsbook](https://github.com/pootsbook) +- [#65](https://github.com/ember-cli/ember-cli-deploy/pull/65) [DOCS] Update CodeClimate batch. [@LevelbossMike](https://github.com/LevelbossMike) +- [#35](https://github.com/ember-cli/ember-cli-deploy/pull/35) [ENHANCEMENT] Match ember-cli's build command aliases by supporting --prod and --dev [@jamesfid](https://github.com/jamesfid) +- [#36](https://github.com/ember-cli/ember-cli-deploy/pull/36) [ENHANCEMENT] Allow custom config file via --deploy-config-file. [@yapplabs](https://github.com/yapplabs) +- [#63](https://github.com/ember-cli/ember-cli-deploy/pull/63) [BUGFIX] Fix regression to the type of object that was being passed to assets adapters as “config”. [@yapplabs](https://github.com/yapplabs) +- [#56](https://github.com/ember-cli/ember-cli-deploy/pull/56) [BREAKING ENHANCEMENT] Deprecated commands no longer needed. [@ember-cli](https://github.com/ember-cli) +- [#40](https://github.com/ember-cli/ember-cli-deploy/pull/40) [BUGFIX] Removed erroneous conflict markers. [@jamesfid](https://github.com/jamesfid) +- [#58](https://github.com/ember-cli/ember-cli-deploy/pull/58) [ENHANCEMENT] Add blueprint to auto generate config/deploy.js [@ember-cli](https://github.com/ember-cli) +- [#57](https://github.com/ember-cli/ember-cli-deploy/pull/57) [DEPRECATION] Deprecate use of deploy.json in favor of config/deploy.js. Closes #51 [@yapplabs](https://github.com/yapplabs) +- [#66](https://github.com/ember-cli/ember-cli-deploy/pull/66) [DOCS] Add note for fingerprint.prepend and staging envs. [@LevelbossMike](https://github.com/LevelbossMike) +- [#74](https://github.com/ember-cli/ember-cli-deploy/pull/74) [BREAKING DEPRECATION] Revert Unsupported Commands back to Deprecated for 0.4.0 release [@danshultz](https://github.com/danshultz) +- [#85](https://github.com/ember-cli/ember-cli-deploy/pull/85) [DEPRECATION] npm post install message for users of v0.0.6 [@achambers](https://github.com/achambers) ### 0.3.1 (February 08, 2015) diff --git a/package.json b/package.json index 64dec06a..99b486b4 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.3.1", + "version": "0.4.0", "directories": { "doc": "doc", "test": "tests" From 20f9e84a287dddb2a5f977159546dd45805f71bb Mon Sep 17 00:00:00 2001 From: Eric Walti Date: Tue, 10 Mar 2015 21:46:20 -0700 Subject: [PATCH 059/300] move glob from devDependencies to dependencies --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 99b486b4..48aabe74 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,6 @@ "ember-export-application-global": "^1.0.0", "express": "^4.8.5", "github": "0.2.3", - "glob": "^4.0.5", "mocha": "^2.0.1", "sinon": "^1.12.1" }, @@ -52,6 +51,7 @@ "chalk": "^0.5.1", "core-object": "0.0.2", "execSync": "^1.0.2", + "glob": "^4.0.5", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", "ncp": "^1.0.1", From 3be393702f7f8165960420816fe20f59b85e353f Mon Sep 17 00:00:00 2001 From: joseph bartels Date: Mon, 9 Mar 2015 15:18:02 -0400 Subject: [PATCH 060/300] Fix for incompatibility with execSync on win64 and certain node builds Fixes #90, Fixes #92 Allow option to pass syncExec function to tagging adapter via constructor instead. --- lib/utilities/tagging/sha.js | 18 ++++++------ node-tests/unit/utilities/tagging/sha-test.js | 28 ++++--------------- package.json | 4 +-- 3 files changed, 16 insertions(+), 34 deletions(-) diff --git a/lib/utilities/tagging/sha.js b/lib/utilities/tagging/sha.js index f3faf358..8f8766f9 100644 --- a/lib/utilities/tagging/sha.js +++ b/lib/utilities/tagging/sha.js @@ -1,19 +1,17 @@ var CoreObject = require('core-object'); module.exports = CoreObject.extend({ - createTag: function() { - var commandResult; - if (require('child_process').execSync) { - commandResult = require('child_process').execSync("git rev-parse HEAD"); - } else { - commandResult = require('execSync').exec("git rev-parse HEAD").stdout; - } - this._generateKey(commandResult); + init: function() { + this.syncExec = this.syncExec || require('sync-exec'); + }, - return this.revisionKey; + createTag: function() { + var commandResult = this.syncExec("git rev-parse HEAD").stdout; + return this._generateKey(commandResult); }, _generateKey: function(sha) { - this.revisionKey = this.manifest+':'+sha.slice(0,7); + this.revisionKey = this.manifest + ':' + sha.slice(0,7); + return this.revisionKey; } }); diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js index 5116b032..af601800 100644 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ b/node-tests/unit/utilities/tagging/sha-test.js @@ -1,5 +1,4 @@ var expect = require('chai').expect; -var sinon = require('sinon'); var ShaTaggingAdapter = require('../../../../lib/utilities/tagging/sha'); var getShortShaVersion = function(sha) { @@ -10,32 +9,17 @@ var GIT_SHA = '04b724a6c656a21795067f9c344d22532cf593ae'; var GIT_SHA_SHORTENED = getShortShaVersion(GIT_SHA); describe('ShaTaggingAdapter', function() { - var sandbox; - - beforeEach(function() { - sandbox = sinon.sandbox.create(); - if (require('child_process').execSync) { - sandbox - .stub(require('child_process'), 'execSync') - .returns(GIT_SHA); - } else { - // Node 0.10 - sandbox - .stub(require('execSync'), 'exec') - .returns({stdout: GIT_SHA}); - } - }); - - afterEach(function() { - sandbox.restore(); - }); + var mockSyncExec = function(){ + return {stdout: GIT_SHA}; + } describe('#createTag', function() { it('returns a tag based on current git-sha and manifestName', function() { var manifestName = 'ember-cli-deploy'; - var expectedTag = manifestName+':'+GIT_SHA_SHORTENED; + var expectedTag = manifestName + ':' + GIT_SHA_SHORTENED; var revisionTagger = new ShaTaggingAdapter({ - manifest: manifestName + manifest: manifestName, + syncExec: mockSyncExec }); expect(revisionTagger.createTag()).to.eq(expectedTag); diff --git a/package.json b/package.json index 48aabe74..a337a733 100644 --- a/package.json +++ b/package.json @@ -50,11 +50,11 @@ "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", "core-object": "0.0.2", - "execSync": "^1.0.2", "glob": "^4.0.5", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", "ncp": "^1.0.1", - "rimraf": "^2.2.8" + "rimraf": "^2.2.8", + "sync-exec": "^0.5.0" } } From 2ec3bc72c46c6f2f35ca5a9655a3bb19d8b109d0 Mon Sep 17 00:00:00 2001 From: Josemar Luedke Date: Thu, 12 Mar 2015 17:35:09 -0300 Subject: [PATCH 061/300] Fix link to migration steps doc --- index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.js b/index.js index 3a57e039..6da88834 100644 --- a/index.js +++ b/index.js @@ -17,7 +17,7 @@ if (hasDeprecatedConfig()) { console.log(red('For more information on how to migrate from ') + grey('achambers/ember-cli-deploy') + red(' to ') + grey('ember-cli/ember-cli-deploy') + red(', please go to:\n\n')); - console.log(red('https://github.com/ember-cli/ember-cli-deploy/MIGRATION_STEPS.md')); + console.log(red('https://github.com/ember-cli/ember-cli-deploy/blob/master/MIGRATION_STEPS.md')); console.log(red('\n===========================================================================\n')); } From 365cdb5851045b6e0c7b2d245ca7bf559fabab37 Mon Sep 17 00:00:00 2001 From: Christopher Chow Date: Fri, 13 Mar 2015 16:50:13 +1100 Subject: [PATCH 062/300] Update config around production-like environments --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 797773cc..64700b1e 100644 --- a/README.md +++ b/README.md @@ -150,12 +150,26 @@ var isProductionLikeBuild = ['production', 'staging'].indexOf(env) > -1; var app = new EmberApp({ fingerprint: { + enabled: isProductionLikeBuild, prepend: 'https://subdomain.cloudfront.net/' }, + sourcemaps: { + enabled: !isProductionLikeBuild, + }, + minifyCSS: { enabled: isProductionLikeBuild }, + minifyJS: { enabled: isProductionLikeBuild }, - minifyAssets: { enabled: isProductionLikeBuild }, + tests: process.env.EMBER_CLI_TEST_COMMAND || !isProductionLikeBuild, + hinting: process.env.EMBER_CLI_TEST_COMMAND || !isProductionLikeBuild, - minifyJS: { enabled: isProductionLikeBuild } + vendorFiles: { + 'handlebars.js': { + staging: 'bower_components/handlebars/handlebars.runtime.js' + }, + 'ember.js': { + staging: 'bower_components/ember/ember.prod.js' + } + } }); ``` From 32004b01f02e79ef26cb27c7f795f90112195eae Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 13 Mar 2015 20:01:34 +0000 Subject: [PATCH 063/300] Release 0.4.1 --- CHANGELOG.md | 9 +++++++++ package.json | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e29781a7..ec949116 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # ember-cli-deploy Changelog +### 0.4.1 (March 13, 2015) + +This release mainly revolves round fixing a bug around `child_process` and `execSync` compatability among the nodejs versions and platforms. + +#### Community Contributions + +- [#93](https://github.com/ember-cli/ember-cli-deploy/pull/93) [BUGFIX] execSync compat issue #92 [@joebartels](https://github.com/joebartels) +- [#100](https://github.com/ember-cli/ember-cli-deploy/pull/100) [DOCS] Update config around production-like environments [@Soliah](https://github.com/Soliah) + ### 0.4.0 (March 07, 2015) This release marks the merge of `achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` into the official `ember-cli-deploy` diff --git a/package.json b/package.json index a337a733..5405d0ec 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.4.0", + "version": "0.4.1", "directories": { "doc": "doc", "test": "tests" From 36bb7409cc8ea37007c91d63baa4525607563a15 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sun, 22 Mar 2015 14:08:27 +0000 Subject: [PATCH 064/300] Improve messaging when config is missing for current environment This change will first check that config exists for the current environment. If not, the user will be prompted with a message pointing them to the README. --- lib/utilities/configuration-reader.js | 25 +++++++++++++------ .../utilities/configuration-reader-test.js | 13 ++++++++++ 2 files changed, 31 insertions(+), 7 deletions(-) diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index 63ad13c0..4bf35f1b 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -1,16 +1,18 @@ -var path = require('path'); -var deprecate = require('./deprecate'); -var Config = require('../models/config'); +var path = require('path'); +var deprecate = require('./deprecate'); +var Config = require('../models/config'); +var SilentError = require('ember-cli/lib/errors/silent'); function ConfigurationReader(options) { var root = process.cwd(); var defaultConfigPath = path.join('config', 'deploy.js'); + var environmentConfig; - this._options = options || {}; - this._environment = this._options.environment || 'development'; + this._options = options || {}; + this._environment = this._options.environment || 'development'; this._deployConfig = this._options.configFile || defaultConfigPath; - var ui = options.ui; + var ui = options.ui; var project = options.project; deprecate( @@ -18,6 +20,7 @@ function ConfigurationReader(options) { /\.json$/.test(this._options.configFile), ui ); + try { var pathToConfig = path.join(root, this._deployConfig); this._config = require(pathToConfig); @@ -26,9 +29,17 @@ function ConfigurationReader(options) { throw new Error('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); } + environmentConfig = this._config[this._environment]; + + if (!environmentConfig) { + throw new SilentError('You are using the `' + this._environment + '` environment but have not specified any configuration.' + + '\n\nPlease add a `' + this._environment + '` section to your `config/deploy.js` file.' + + '\n\nFor more information, go to: `https://github.com/ember-cli/ember-cli-deploy#config-file`'); + } + this.config = new Config({ project: project, - rawConfig: this._config[this._environment] + rawConfig: environmentConfig }); } diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index a944d3c1..c696112b 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -90,6 +90,19 @@ describe('ConfigurationReader', function() { }); }).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); }); + + it('raises an error if a config doesn\'t exist for the current environment', function() { + var configPath = './node-tests/fixtures/config/deploy.js'; + + expect(function() { + new ConfigurationReader({ + configFile: configPath, + ui: ui, + project: project, + environment: 'non-existent-env' + }); + }).to.throw(/You are using the `non-existent-env` environment/); + }); }); describe('store settings', function() { From cbf2e1ebac2285f3a244b59949f032a10cb7f8b7 Mon Sep 17 00:00:00 2001 From: Bryan Crotaz Date: Sun, 22 Mar 2015 15:29:44 +0000 Subject: [PATCH 065/300] Changed package to be able to run tests on windows. Aaron tested on Mac and this still works. Needs testing on other platforms --- package.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 5405d0ec..7371b81a 100644 --- a/package.json +++ b/package.json @@ -9,8 +9,8 @@ "scripts": { "start": "ember server", "build": "ember build", - "test": "./node_modules/mocha/bin/mocha node-tests/**/*-test.js", - "autotest": "./node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" + "test": "node node_modules/mocha/bin/mocha node-tests/**/*-test.js", + "autotest": "node node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" }, "repository": "https://github.com/ember-cli/ember-cli-deploy", "engines": { From d365a44a28db26367470a78699564c05c12198f6 Mon Sep 17 00:00:00 2001 From: Robin Daugherty Date: Wed, 25 Mar 2015 13:40:24 -0400 Subject: [PATCH 066/300] Deploy index adapter `uploadFiles` Support the `indexFiles` option to support more than just `index.html` being uploaded. By setting the `indexFiles` attribute in the deployment config, the index-adapter's `uploadFiles` method is called instead of `upload`. --- lib/models/config.js | 1 + lib/tasks/deploy-index.js | 17 ++++++++++++----- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/lib/models/config.js b/lib/models/config.js index 475ad769..c68aa2f6 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -49,6 +49,7 @@ module.exports = CoreObject.extend({ 'manifestPrefix': this.project.name(), 'store.manifestSize': 10, 'store.type': 'redis', + 'indexFiles': null, 'tagging': 'sha' }; }, diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 75896910..7ccbcb36 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -41,10 +41,17 @@ module.exports = Task.extend({ ui: ui }); - return readFile('dist/index.html') - .then(function(fileContent) { - ui.writeLine(chalk.blue('\nTrying to upload `dist/index.html`...\n')); - return deploy.upload(fileContent); - }); + var indexFiles = config.get('indexFiles'); + + if(indexFiles) { + ui.writeLine(chalk.blue('\nUploading '+indexFiles.length+' files from `dist/`...\n')); + return deploy.uploadFiles(indexFiles); + } else { + return readFile('dist/index.html') + .then(function(fileContent) { + ui.writeLine(chalk.blue('\nUploading `dist/index.html`...\n')); + return deploy.upload(fileContent); + }); + } } }); From 279d99e8ac43bf1028cc6459f5f363892aa7cdbf Mon Sep 17 00:00:00 2001 From: Archit Baweja Date: Thu, 26 Mar 2015 18:59:23 -0700 Subject: [PATCH 067/300] Stub activate, list, createTag UnknownAdapter methods. * Added unit tests --- lib/utilities/assets/unknown.js | 15 +++++++++----- .../unit/utilities/assets/unknown-test.js | 20 ++++++++++++++++++- 2 files changed, 29 insertions(+), 6 deletions(-) diff --git a/lib/utilities/assets/unknown.js b/lib/utilities/assets/unknown.js index 71c58b7c..78c88ad1 100644 --- a/lib/utilities/assets/unknown.js +++ b/lib/utilities/assets/unknown.js @@ -2,10 +2,15 @@ var Adapter = require('../adapter'); var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('ember-cli/lib/errors/silent'); +var errorMessage = function() { + var errorMessage = 'You tried to use an unknown adapter: `' + this.name + + '`. Please pass a supported adapter-type.'; + return Promise.reject(new SilentError(errorMessage)); +} + module.exports = Adapter.extend({ - upload: function() { - var errorMessage = 'You tried to use an unknown adapter: `' + this.name + - '`. Please pass a supported adapter-type.'; - return Promise.reject(new SilentError(errorMessage)); - } + upload: errorMessage, + activate: errorMessage, + list: errorMessage, + createTag: errorMessage }); diff --git a/node-tests/unit/utilities/assets/unknown-test.js b/node-tests/unit/utilities/assets/unknown-test.js index 0bc554f5..f68c2c8a 100644 --- a/node-tests/unit/utilities/assets/unknown-test.js +++ b/node-tests/unit/utilities/assets/unknown-test.js @@ -12,5 +12,23 @@ describe('UnknownAdapter', function() { unknown = new UnknownAdapter(); expect(unknown.upload()).to.be.rejected; }); - }) + }); + describe('#activate', function() { + it('rejects to print out an error message', function(){ + unknown = new UnknownAdapter(); + expect(unknown.activate()).to.be.rejected; + }); + }); + describe('#list', function() { + it('rejects to print out an error message', function(){ + unknown = new UnknownAdapter(); + expect(unknown.list()).to.be.rejected; + }); + }); + describe('#createTag', function() { + it('rejects to print out an error message', function(){ + unknown = new UnknownAdapter(); + expect(unknown.createTag()).to.be.rejected; + }); + }); }); From ca5f49dc844d636956a6f62a7d359e3311fd91a9 Mon Sep 17 00:00:00 2001 From: Archit Baweja Date: Fri, 27 Mar 2015 02:09:29 -0700 Subject: [PATCH 068/300] Consolidate tests. --- .../unit/utilities/assets/unknown-test.js | 38 +++++++------------ 1 file changed, 14 insertions(+), 24 deletions(-) diff --git a/node-tests/unit/utilities/assets/unknown-test.js b/node-tests/unit/utilities/assets/unknown-test.js index f68c2c8a..9e0054f6 100644 --- a/node-tests/unit/utilities/assets/unknown-test.js +++ b/node-tests/unit/utilities/assets/unknown-test.js @@ -6,29 +6,19 @@ chai.use(chaiAsPromised); var expect = chai.expect; -describe('UnknownAdapter', function() { - describe('#upload', function() { - it('rejects to print out an error message', function(){ - unknown = new UnknownAdapter(); - expect(unknown.upload()).to.be.rejected; - }); - }); - describe('#activate', function() { - it('rejects to print out an error message', function(){ - unknown = new UnknownAdapter(); - expect(unknown.activate()).to.be.rejected; - }); - }); - describe('#list', function() { - it('rejects to print out an error message', function(){ - unknown = new UnknownAdapter(); - expect(unknown.list()).to.be.rejected; - }); - }); - describe('#createTag', function() { - it('rejects to print out an error message', function(){ - unknown = new UnknownAdapter(); - expect(unknown.createTag()).to.be.rejected; +var methodTest = function(adapter, method) { + return function() { + it('rejects to print out an error message', function() { + expect(adapter[method]()).to.be.rejected; }); - }); + }; +} + +describe('UnknownAdapter', function() { + var adapter = new UnknownAdapter(); + + describe('#upload', methodTest(adapter, "upload")); + describe('#activate', methodTest(adapter, "activate")); + describe('#list', methodTest(adapter, "list")); + describe('#createTag', methodTest(adapter, "createTag")); }); From 40df360f32aa57275c43b8c6974aadd934f0026e Mon Sep 17 00:00:00 2001 From: Justin Giancola Date: Fri, 27 Mar 2015 10:17:16 -0700 Subject: [PATCH 069/300] [DOCUMENTATION] Make Sinatra example a bit more secure I know it's just an example and that real code should have more checking, but people often copy examples verbatim and I wouldn't want to read a blog post in the future about this cool trick that lets you read arbitrary redis keys for most apps deployed via ember-cli-deploy. The current example allows users to view any key in redis by passing an appropriate index_key parameter. This is obviously not desirable. The amendment I propose isn't 100% secure--it's still possible to read information that happens to have the same prefix as the manifest. Ideally one would additionally check to see if the provided index_key existed in the revisions list before serving it. While I could update the example to do this check as well, I worry that doing so would make the example significantly more complicated and would obscure what is going on. --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 64700b1e..35652d8e 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,8 @@ require 'redis' def bootstrap_index(index_key) redis = Redis.new - index_key ||= redis.get(':current') + index_key &&= ":#{index_key}" + index_key ||= redis.get(":current") redis.get(index_key) end From 6c2b44cc276f49f80d56bdec2e5f434bc66da742 Mon Sep 17 00:00:00 2001 From: Jay Phelps Date: Thu, 16 Apr 2015 16:22:26 -0700 Subject: [PATCH 070/300] Link to custom adapters section for quick ref --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 64700b1e..d81e760b 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This project includes the necessary commands for 'Lightning Fast Deployments of Ember-CLI Apps'. The whole workflow is heavily inspired by Luke Melia's talk about [Lightning Fast Deployment(s) of Rails-backed Javascript Apps](https://www.youtube.com/watch?v=QZVYP3cPcWQ). -`ember-cli-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about `custom adapters` on how to get started with your own deployment strategy with `ember-cli-deploy`. +`ember-cli-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about [custom adapters](#custom-adapters) on how to get started with your own deployment strategy with `ember-cli-deploy`. You can also have a look on how to use this ember-cli-addon in the following video of a talk about `ember-cli-deploy` I gave at [Ember.js-Munich](http://www.meetup.com/Ember-js-Munich/) (demo starts around 7 minutes into the video). From b15a4babcb5817b90f471014ad2377b07632d69e Mon Sep 17 00:00:00 2001 From: Jorge Davila Date: Tue, 21 Apr 2015 11:40:04 -0400 Subject: [PATCH 071/300] Make a callout easily actionable --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d81e760b..63502cac 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ To use the Lightning-Approach workflow from Luke's talk you will also need to in npm install ember-deploy-redis ember-deploy-s3 --save-dev ``` -__Please watch Luke's Talk before using this project!__ +[__Please watch Luke's Talk before using this project!__](https://www.youtube.com/watch?v=QZVYP3cPcWQ) The TL;DR of the talk is that you want to serve your bootstrap index.html that Ember-CLI builds for you from a Key-Value store via your Backend and serve the rest of your assets from a static file hoster like for example [S3](https://aws.amazon.com/de/s3/). This is a sketch of what this Addon gives you out of the box: From d793350868a797934949a8721d74985715b5e941 Mon Sep 17 00:00:00 2001 From: Archit Baweja Date: Tue, 26 May 2015 18:00:26 -0700 Subject: [PATCH 072/300] Link to ember-deploy-couchbase. --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 64700b1e..af79ec92 100644 --- a/README.md +++ b/README.md @@ -271,6 +271,7 @@ The following adapters have already been developed: * [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3), assets-adapter for AWS [S3](http://aws.amazon.com/s3/) * [ember-deploy-s3-index](https://github.com/Kerry350/ember-deploy-s3-index), index-adapter for AWS [S3](http://aws.amazon.com/s3/) * [ember-deploy-azure](https://github.com/duizendnegen/ember-deploy-azure), index-adapter and assets-adapter for Azure Tables & Blob Storage respectively +* [ember-deploy-couchbase](https://github.com/waltznetworks/ember-deploy-couchbase), index-adapter for [Couchbase](http://www.couchbase.com) ### Index-Adapters From 2ce2395fa8564b56a22330c6616b87e08c6161f4 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Wed, 27 May 2015 00:11:20 -0400 Subject: [PATCH 073/300] Test against stable node versions --- .travis.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.travis.yml b/.travis.yml index f2a202f4..cdb44dd3 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,8 +4,8 @@ language: node_js sudo: false node_js: - - "0.10.36" - - "0.11" + - "0.10" + - "0.12" cache: directories: From d806b98fc2de897b49f1b302f74035c7f1045112 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Tue, 26 May 2015 23:57:38 -0400 Subject: [PATCH 074/300] Add configuration option to exclude asset files from being deployed. Closes #138 --- .gitignore | 1 + README.md | 1 + lib/models/config.js | 1 + lib/tasks/assets.js | 44 ++++++++++++++------------- node-tests/unit/models/config-test.js | 11 +++++++ node-tests/unit/tasks/assets-test.js | 40 ++++++++++++++++++++++++ 6 files changed, 77 insertions(+), 21 deletions(-) diff --git a/.gitignore b/.gitignore index 3681d4e4..c7d5bd15 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ deploy_test.json .DS_Store NERD_tree_2 *.tgz +/tmp-delete-excluded-test diff --git a/README.md b/README.md index 83e7f39c..f96abfd2 100644 --- a/README.md +++ b/README.md @@ -78,6 +78,7 @@ module.exports = { type: 's3', // default asset-adapter is 's3' gzip: false, // if undefined or set to true, files are gziped gzipExtensions: ['js', 'css', 'svg'], // if undefined, js, css & svg files are gziped + exclude: ['.DS_Store', '*-test.js'], // defaults to empty array accessKeyId: '', secretAccessKey: process.env['AWS_ACCESS_KEY'], bucket: '' diff --git a/lib/models/config.js b/lib/models/config.js index c68aa2f6..7581ca2e 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -45,6 +45,7 @@ module.exports = CoreObject.extend({ 'assets.gzip': true, 'assets.gzipExtensions': ['js', 'css', 'svg'], 'assets.type': 's3', + 'assets.exclude': [], 'buildEnv': 'production', 'manifestPrefix': this.project.name(), 'store.manifestSize': 10, diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 0a52b193..58a74934 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -1,17 +1,12 @@ var Task = require('ember-cli/lib/models/task'); var ConfigurationReader = require('../utilities/configuration-reader'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); -var chalk = require('chalk'); var fs = require('fs'); var path = require('path'); - -var ncp = Promise.denodeify(require('ncp')); -var white = chalk.white; -var green = chalk.green; - -var EXPIRE_IN_2030 = new Date('2030'); -var TWO_YEAR_CACHE_PERIOD_IN_SEC = 60 * 60 * 24 * 365 * 2; +var rimraf = Promise.denodeify(require('rimraf')); +var glob = Promise.denodeify(require('glob')); +var ncp = Promise.denodeify(require('ncp')); +var mkdirp = require('mkdirp'); module.exports = Task.extend({ run: function(options) { @@ -39,7 +34,7 @@ module.exports = Task.extend({ var builder = new broccoli.Builder(fileTreeOrPath); return builder.build() - .then(this.processBuildResult.bind(this)) + .then(this.processBuildResult.bind(this, config)) .then(this.uploadAssets.bind(this, options.environment, options.deployConfigFile)) .then(function() { builder.cleanup(); @@ -65,29 +60,25 @@ module.exports = Task.extend({ return assetsUploader.upload(); }, - processBuildResult: function(results) { + processBuildResult: function(config, results) { return this.clearOutputPath('tmp/assets-sync/') .then(function() { return this.copyToOutputPath(results.directory, 'tmp/assets-sync/'); - }.bind(this)) + }.bind(this)).then(function(){ + return this.deleteExcluded('tmp/assets-sync/', config); + }.bind(this)); }, clearOutputPath: function(outputPath) { - var rimraf = Promise.denodeify(require('rimraf')); if (!fs.existsSync(outputPath)) { return Promise.resolve(); } - var promises = []; var entries = fs.readdirSync(outputPath); - - for (var i = 0, l = entries.length; i < l; i++) { - promises.push(rimraf(path.join(outputPath, entries[i]))); - } - - return Promise.all(promises); + return Promise.map(entries, function(entry){ + return rimraf(path.join(outputPath, entry)); + }); }, copyToOutputPath: function(inputPath, outputPath) { - var mkdirp = require('mkdirp'); if (!fs.existsSync(outputPath)) { mkdirp.sync(outputPath); } @@ -98,5 +89,16 @@ module.exports = Task.extend({ stopOnErr: true, limit: 2 }); + }, + + deleteExcluded: function(dir, config){ + var exclusions = config.get('assets.exclude'); + return Promise.map(exclusions, function(exclusion){ + return glob(exclusion, { cwd: dir, matchBase: true }).then(function(entries){ + return Promise.map(entries, function(entry) { + return rimraf(path.join(dir, entry)); + }); + }); + }); } }); diff --git a/node-tests/unit/models/config-test.js b/node-tests/unit/models/config-test.js index 57cb7aa8..b6fb5055 100644 --- a/node-tests/unit/models/config-test.js +++ b/node-tests/unit/models/config-test.js @@ -87,6 +87,17 @@ describe('Config', function() { }); }); + describe('assets.exclude', function(){ + it('defaults to empty array', function() { + var config = createConfig('tomster', {}); + expect(config.get('assets.exclude')).to.deep.equal([]); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { assets: { exclude: ['.DS_Store'] } }); + expect(config.get('assets.exclude')).to.deep.equal(['.DS_Store']); + }); + }); + describe('tagging', function(){ it('defaults to sha', function() { var config = createConfig('tomster', {}); diff --git a/node-tests/unit/tasks/assets-test.js b/node-tests/unit/tasks/assets-test.js index 6b7a0ae6..60cfc7b9 100644 --- a/node-tests/unit/tasks/assets-test.js +++ b/node-tests/unit/tasks/assets-test.js @@ -2,7 +2,12 @@ var CoreObject = require('core-object'); var AssetsTask = require('../../../lib/tasks/assets'); var MockUI = require('ember-cli/tests/helpers/mock-ui'); var expect = require('chai').expect; +var Promise = require('ember-cli/lib/ext/promise'); var path = require('path'); +var mkdirp = require('mkdirp'); +var fs = require('fs'); +var rimraf = Promise.denodeify(require('rimraf')); +var existsSync = path.existsSync || fs.existsSync; //renaned in node 0.12 describe('AssetsTask', function() { var ui, project, MockAssetsUploader, mockAssetsUploaderConfig; @@ -33,4 +38,39 @@ describe('AssetsTask', function() { expect(mockAssetsUploaderConfig.assets.type).to.equal('s3'); }); }); + describe('#deleteExcluded', function () { + it('deletes files matching exclude globs from specified dir', function() { + var task = new AssetsTask({ + ui: ui, + AssetsUploader: MockAssetsUploader, + project: project + }); + var mockConfig = { + get: function(key){ + if (key === 'assets.exclude') { + return [".DS_Store", "foo-*"]; + } + } + }; + var root = process.cwd(); + var dir = path.join(root, 'tmp-delete-excluded-test'); + var subdir = path.join(dir, 'subdir'); + mkdirp.sync(dir); + mkdirp.sync(subdir); + ['keep.me', '.DS_Store', 'foo-bar.js'].forEach(function(fileName){ + fs.closeSync(fs.openSync(path.join(dir, fileName), 'w')); + fs.closeSync(fs.openSync(path.join(subdir, fileName), 'w')); + }); + return task.deleteExcluded(dir, mockConfig).then(function(){ + expect(existsSync(path.join(dir, 'keep.me'))).to.equal(true); + expect(existsSync(path.join(subdir, 'keep.me'))).to.equal(true); + expect(existsSync(path.join(dir, '.DS_Store'))).to.equal(false); + expect(existsSync(path.join(subdir, '.DS_Store'))).to.equal(false); + expect(existsSync(path.join(dir, 'foo-bar.js'))).to.equal(false); + expect(existsSync(path.join(subdir, 'foo-bar.js'))).to.equal(false); + }).finally(function(){ + return rimraf(dir); + }); + }); + }); }); From c8df59b6b1192e892b6bf0683906ae917c9d8438 Mon Sep 17 00:00:00 2001 From: Ben Limmer Date: Thu, 28 May 2015 14:57:01 -0600 Subject: [PATCH 075/300] Resolve JSHint error on deploy.js blueprint --- blueprints/deploy-config/files/config/deploy.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/blueprints/deploy-config/files/config/deploy.js b/blueprints/deploy-config/files/config/deploy.js index 7bfc3366..89222c2a 100644 --- a/blueprints/deploy-config/files/config/deploy.js +++ b/blueprints/deploy-config/files/config/deploy.js @@ -1,3 +1,5 @@ +/* jshint node: true */ + module.exports = { //development: { //store: { From d0c218adfe5d9b0d2f3940859644f88b125aa4db Mon Sep 17 00:00:00 2001 From: Trym Skaar Date: Thu, 4 Jun 2015 14:27:19 +0200 Subject: [PATCH 076/300] Upgrade ncp package --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 7371b81a..938314f6 100644 --- a/package.json +++ b/package.json @@ -53,7 +53,7 @@ "glob": "^4.0.5", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", - "ncp": "^1.0.1", + "ncp": "^2.0.0", "rimraf": "^2.2.8", "sync-exec": "^0.5.0" } From 6b96fe989a24566f80df6a06596678b02d5a45aa Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 14 Jun 2015 14:28:53 +0200 Subject: [PATCH 077/300] Release 0.4.2 --- CHANGELOG.md | 23 +++++++++++++++++++++++ package.json | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ec949116..67563144 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,28 @@ # ember-cli-deploy Changelog +### 0.4.2 (June 14, 2015) + +This release fixes asset upload issues with io.js, adds the possibility for +index adapters to support multiple files and adds a configuration option to +exclude asset files from deployment. + +#### Community Contributions + +- [#140](https://github.com/ember-cli/ember-cli-deploy/pull/140) Link to ember-deploy-couchbase. [@waltznetworks](https://github.com/waltznetworks) +- [#113](https://github.com/ember-cli/ember-cli-deploy/pull/113) Provide better error support for missing environment config [@achambers](https://github.com/achambers) +- [#115](https://github.com/ember-cli/ember-cli-deploy/pull/115) Changed package to be able to run tests on windows. [@Twinkletoes](https://github.com/Twinkletoes) +- [#119](https://github.com/ember-cli/ember-cli-deploy/pull/119) Stub active, list, createTag UnknownAdapter methods [@waltznetworks](https://github.com/waltznetworks) +- [#120](https://github.com/ember-cli/ember-cli-deploy/pull/120) [DOCUMENTATION] Make Sinatra example a bit more secure [@elucid](https://github.com/elucid) +- [#124](https://github.com/ember-cli/ember-cli-deploy/pull/124) Index Adapter support for multiple files [@Ahalogy](https://github.com/Ahalogy) +- [#128](https://github.com/ember-cli/ember-cli-deploy/pull/128) Link to custom adapters section for quick ref [@jayphelps](https://github.com/jayphelps) +- [#129](https://github.com/ember-cli/ember-cli-deploy/pull/129) Make a callout easily actionable [@jorgedavila25](https://github.com/jorgedavila25) +- [#141](https://github.com/ember-cli/ember-cli-deploy/pull/141) Add configuration option to exclude asset files from being deployed. [@yapplabs](https://github.com/yapplabs) +- [#142](https://github.com/ember-cli/ember-cli-deploy/pull/142) Test against stable node versions [@yapplabs](https://github.com/yapplabs) +- [#144](https://github.com/ember-cli/ember-cli-deploy/pull/144) Resolve JSHint error on deploy.js blueprint [@blimmer](https://github.com/blimmer) +- [#146](https://github.com/ember-cli/ember-cli-deploy/pull/146) Make io.js work [@trym](https://github.com/trym) + +Thank you to all who took the time to contribute! + ### 0.4.1 (March 13, 2015) This release mainly revolves round fixing a bug around `child_process` and `execSync` compatability among the nodejs versions and platforms. diff --git a/package.json b/package.json index 938314f6..a357d7ca 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.4.1", + "version": "0.4.2", "directories": { "doc": "doc", "test": "tests" From 7939316eb756629bc87bc1784dab0a928f2b6696 Mon Sep 17 00:00:00 2001 From: Jeff Hertzler Date: Tue, 16 Jun 2015 20:08:00 -0400 Subject: [PATCH 078/300] add failing test --- config/deploy.js | 5 +- .../fixtures/config-with-defaults/deploy.js | 46 +++++++++++++++++++ node-tests/fixtures/config/deploy.js | 5 +- .../utilities/configuration-reader-test.js | 21 +++++++++ 4 files changed, 73 insertions(+), 4 deletions(-) create mode 100644 node-tests/fixtures/config-with-defaults/deploy.js diff --git a/config/deploy.js b/config/deploy.js index 38d703e7..f47046aa 100644 --- a/config/deploy.js +++ b/config/deploy.js @@ -2,7 +2,7 @@ module.exports = { "development": { "store": { "host": "localhost", - "port": 6379 + "port": 63790 }, "assets": { "accessKeyId": "", @@ -21,7 +21,8 @@ module.exports = { "accessKeyId": "", "secretAccessKey": "", "bucket": "", - "prefix": "" + "prefix": "", + "gzipExtensions": ["js", "css", "svg", "json"] } } } diff --git a/node-tests/fixtures/config-with-defaults/deploy.js b/node-tests/fixtures/config-with-defaults/deploy.js new file mode 100644 index 00000000..0ac54f4e --- /dev/null +++ b/node-tests/fixtures/config-with-defaults/deploy.js @@ -0,0 +1,46 @@ +module.exports = { + "development": { + "buildEnv": "production", + "indexFiles": null, + "manifestPrefix": "foo", + "tagging": "sha", + "store": { + "host": "localhost", + "manifestSize": 10, + "port": 63790, + "type": "redis" + }, + "assets": { + "accessKeyId": "", + "secretAccessKey": "", + "bucket": "", + "exclude": [], + "gzip": true, + "gzipExtensions": ["js", "css", "svg"], + "type": "s3" + } + }, + + "staging": { + "buildEnv": "staging", + "indexFiles": null, + "manifestPrefix": "foo", + "tagging": "sha", + "store": { + "host": "staging-redis.firstiwaslike.com", + "manifestSize": 10, + "port": 6379, + "type": "redis" + }, + "assets": { + "accessKeyId": "", + "secretAccessKey": "", + "bucket": "", + "exclude": [], + "gzip": true, + "prefix": "", + "gzipExtensions": ["js", "css", "svg", "json"], + "type": "s3" + } + } +} diff --git a/node-tests/fixtures/config/deploy.js b/node-tests/fixtures/config/deploy.js index 19988188..f60f58b0 100644 --- a/node-tests/fixtures/config/deploy.js +++ b/node-tests/fixtures/config/deploy.js @@ -2,7 +2,7 @@ module.exports = { "development": { "store": { "host": "localhost", - "port": 6379 + "port": 63790 }, "assets": { "accessKeyId": "", @@ -20,7 +20,8 @@ module.exports = { "accessKeyId": "", "secretAccessKey": "", "bucket": "", - "prefix": "" + "prefix": "", + "gzipExtensions": ["js", "css", "svg", "json"] } } } diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index c696112b..38dfeb77 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -143,5 +143,26 @@ describe('ConfigurationReader', function() { expect(config.get('assets')).to.deep.equal(expected); }); }); + }); + + describe('materialized settings', function() { + it('proxies the materialized settings for the passed environment', function() { + var ENVs = ['development', 'staging']; + var root = process.cwd(); + var cfgFile = require(path.join(root, './node-tests/fixtures/config-with-defaults/deploy.js')); + + ENVs.forEach(function(ENV) { + var expected = cfgFile[ENV]; + + var config = new ConfigurationReader({ + environment: ENV, + ui: ui, + project: project + }).config; + + expect(config._materialize()).to.deep.equal(expected); + }); + }); }) + }); From a3c13ad542e5de9a4aea7468af3b09bb9c368e35 Mon Sep 17 00:00:00 2001 From: Jeff Hertzler Date: Tue, 16 Jun 2015 20:08:28 -0400 Subject: [PATCH 079/300] fix _materialize using wrong this context in forEach --- lib/models/config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/models/config.js b/lib/models/config.js index 7581ca2e..66554701 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -62,7 +62,7 @@ module.exports = CoreObject.extend({ var materialized = JSON.parse(JSON.stringify(this._config)); var defaultPropertyPaths = this._defaultPropertyPaths; Object.keys(defaultPropertyPaths).forEach(function(propertyPath){ - if (!getPath(this._config, propertyPath)) { + if (!getPath(materialized, propertyPath)) { setPath(materialized, propertyPath, defaultPropertyPaths[propertyPath]); } }); From 367f6dd9676e6e815f35e8a21a8e1d4a4ae38e18 Mon Sep 17 00:00:00 2001 From: Leo Hernandez Date: Tue, 16 Jun 2015 22:17:45 -0400 Subject: [PATCH 080/300] added ember-cli-rest-index adapter to list of adapter --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index f96abfd2..d32bb526 100644 --- a/README.md +++ b/README.md @@ -274,6 +274,7 @@ The following adapters have already been developed: * [ember-deploy-s3-index](https://github.com/Kerry350/ember-deploy-s3-index), index-adapter for AWS [S3](http://aws.amazon.com/s3/) * [ember-deploy-azure](https://github.com/duizendnegen/ember-deploy-azure), index-adapter and assets-adapter for Azure Tables & Blob Storage respectively * [ember-deploy-couchbase](https://github.com/waltznetworks/ember-deploy-couchbase), index-adapter for [Couchbase](http://www.couchbase.com) +* [ember-deploy-rest-index](https://github.com/leojh/ember-deploy-rest-index), index-adapter for REST API backends ### Index-Adapters From 3c759e5913b6dc1fe31d6133d20b5a91750ce59c Mon Sep 17 00:00:00 2001 From: Ben Limmer Date: Thu, 18 Jun 2015 08:21:26 -0600 Subject: [PATCH 081/300] Update video link in README. This will be useful until 0.5, and is more up-to-date than the current talk. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d32bb526..1124dd8f 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ about [Lightning Fast Deployment(s) of Rails-backed Javascript Apps](https://www `ember-cli-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about [custom adapters](#custom-adapters) on how to get started with your own deployment strategy with `ember-cli-deploy`. -You can also have a look on how to use this ember-cli-addon in the following video of a talk about `ember-cli-deploy` I gave at [Ember.js-Munich](http://www.meetup.com/Ember-js-Munich/) (demo starts around 7 minutes into the video). +You can also have a look on how to use this ember-cli addon in the following video of a talk about `ember-cli-deploy` [Ben Limmer](https://github.com/blimmer) gave at [Ember.js-Denver](http://www.meetup.com/Ember-js-Denver/). -![ember-deploy talk](http://img.youtube.com/vi/Ro2_I5vtTIg/0.jpg) +![ember-deploy talk](http://i.imgur.com/dOGvXty.png) ## Installation From e7dd0d8c308c404929918ff8d05c5e3646a48d08 Mon Sep 17 00:00:00 2001 From: Stefan Penner Date: Sat, 20 Jun 2015 07:19:37 -0700 Subject: [PATCH 082/300] Add link to community guidelines as CODE_OF_CONDUCT.md --- CODE_OF_CONDUCT.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..b9fca524 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,9 @@ ++The Ember team and community are committed to everyone having a safe and inclusive experience. ++ ++**Our Community Guidelines / Code of Conduct can be found here**: ++ ++http://emberjs.com/guidelines/ ++ ++For a history of updates, see the page history here: ++ ++https://github.com/emberjs/website/commits/master/source/guidelines.html.erb From b3b66e6253e068c92254623ad6c6434eb0f98fb3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Clemens=20M=C3=BCller?= Date: Mon, 22 Jun 2015 08:52:51 +0200 Subject: [PATCH 083/300] Remove leading '+' es from code of conduct --- CODE_OF_CONDUCT.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index b9fca524..98fe2cd0 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,9 +1,9 @@ -+The Ember team and community are committed to everyone having a safe and inclusive experience. -+ -+**Our Community Guidelines / Code of Conduct can be found here**: -+ -+http://emberjs.com/guidelines/ -+ -+For a history of updates, see the page history here: -+ -+https://github.com/emberjs/website/commits/master/source/guidelines.html.erb +The Ember team and community are committed to everyone having a safe and inclusive experience. + +**Our Community Guidelines / Code of Conduct can be found here**: + +http://emberjs.com/guidelines/ + +For a history of updates, see the page history here: + +https://github.com/emberjs/website/commits/master/source/guidelines.html.erb From 5a671a7ad9f1baf782c34a7ac31e00f2dd171a43 Mon Sep 17 00:00:00 2001 From: posadchiy Date: Tue, 23 Jun 2015 13:18:20 +0300 Subject: [PATCH 084/300] [#151] read manifestPrefix from config [#151] readme --- README.md | 3 ++- lib/tasks/deploy-index.js | 2 +- lib/tasks/list.js | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1124dd8f..ed673586 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,8 @@ module.exports = { accessKeyId: '', secretAccessKey: process.env['AWS_ACCESS_KEY'], bucket: '' - } + }, + manifestPrefix: 'stage-app' // optional, defaults to this.project.name() }, production: { diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 7ccbcb36..b007b113 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -30,7 +30,7 @@ module.exports = Task.extend({ .lookup('tagging', taggingAdapterType) var taggingAdapter = new TaggingAdapter({ - manifest: manifest + manifest: config.get('manifestPrefix') }); var deploy = new Adapter({ diff --git a/lib/tasks/list.js b/lib/tasks/list.js index 3df646d9..bf41853a 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -18,7 +18,7 @@ module.exports = Task.extend({ var deploy = new Adapter({ config: config.get('store'), - manifest: this.project.name(), + manifest: config.get('manifestPrefix'), manifestSize: config.get('store.manifestSize'), ui: ui }); From 445a6f5cb0d0a725fd7c10cf357fa8ae9491e92a Mon Sep 17 00:00:00 2001 From: Sam Selikoff Date: Sat, 27 Jun 2015 10:45:50 -0400 Subject: [PATCH 085/300] clean up empty dummy app dirs --- tests/dummy/app/components/.gitkeep | 0 tests/dummy/app/controllers/.gitkeep | 0 tests/dummy/app/helpers/.gitkeep | 0 tests/dummy/app/index.html | 2 +- .../application.hbs => pods/application/template.hbs} | 0 tests/dummy/app/routes/.gitkeep | 0 tests/dummy/app/templates/.gitkeep | 0 tests/dummy/app/templates/components/.gitkeep | 0 tests/dummy/app/views/.gitkeep | 0 tests/dummy/config/environment.js | 1 + 10 files changed, 2 insertions(+), 1 deletion(-) delete mode 100644 tests/dummy/app/components/.gitkeep delete mode 100644 tests/dummy/app/controllers/.gitkeep delete mode 100644 tests/dummy/app/helpers/.gitkeep rename tests/dummy/app/{templates/application.hbs => pods/application/template.hbs} (100%) delete mode 100644 tests/dummy/app/routes/.gitkeep delete mode 100644 tests/dummy/app/templates/.gitkeep delete mode 100644 tests/dummy/app/templates/components/.gitkeep delete mode 100644 tests/dummy/app/views/.gitkeep diff --git a/tests/dummy/app/components/.gitkeep b/tests/dummy/app/components/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/controllers/.gitkeep b/tests/dummy/app/controllers/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/helpers/.gitkeep b/tests/dummy/app/helpers/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/index.html b/tests/dummy/app/index.html index 1c49d36d..014db721 100644 --- a/tests/dummy/app/index.html +++ b/tests/dummy/app/index.html @@ -3,7 +3,7 @@ - Dummy + Ember CLI Deploy diff --git a/tests/dummy/app/templates/application.hbs b/tests/dummy/app/pods/application/template.hbs similarity index 100% rename from tests/dummy/app/templates/application.hbs rename to tests/dummy/app/pods/application/template.hbs diff --git a/tests/dummy/app/routes/.gitkeep b/tests/dummy/app/routes/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/templates/.gitkeep b/tests/dummy/app/templates/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/templates/components/.gitkeep b/tests/dummy/app/templates/components/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/app/views/.gitkeep b/tests/dummy/app/views/.gitkeep deleted file mode 100644 index e69de29b..00000000 diff --git a/tests/dummy/config/environment.js b/tests/dummy/config/environment.js index c59bcd53..445c5336 100644 --- a/tests/dummy/config/environment.js +++ b/tests/dummy/config/environment.js @@ -5,6 +5,7 @@ module.exports = function(environment) { modulePrefix: 'dummy', environment: environment, baseURL: '/', + podModulePrefix: 'dummy/pods', locationType: 'auto', EmberENV: { FEATURES: { From d02884c1424fea23c74fcf87170449e0340eb9f0 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Sun, 28 Jun 2015 16:14:06 +0200 Subject: [PATCH 086/300] Add ability to configure build paths, defaulting to tmp/deploy-dist/. By default this prevents problems occuring when running both `ember deploy` and `ember serve`. --- lib/commands/deploy.js | 4 ++-- lib/models/config.js | 1 + lib/tasks/assets.js | 4 ++-- lib/tasks/deploy-index.js | 6 +++--- node-tests/unit/models/config-test.js | 11 +++++++++++ 5 files changed, 19 insertions(+), 7 deletions(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 7025aa38..d1fcd8ec 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -26,11 +26,11 @@ module.exports = { ui: this.ui, analytics: this.analytics, project: this.project - }); + var buildOptions = { environment: config.get('buildEnv'), - outputPath: "dist/", + outputPath: config.get('buildPath'), watch: false, disableAnalytics: false }; diff --git a/lib/models/config.js b/lib/models/config.js index 7581ca2e..13be7445 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -47,6 +47,7 @@ module.exports = CoreObject.extend({ 'assets.type': 's3', 'assets.exclude': [], 'buildEnv': 'production', + 'buildPath': 'tmp/deploy-dist/', 'manifestPrefix': this.project.name(), 'store.manifestSize': 10, 'store.type': 'redis', diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 58a74934..523251e5 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -21,11 +21,11 @@ module.exports = Task.extend({ var fileTreeOrPath; if (config.get('assets.gzip') === false) { - fileTreeOrPath = 'dist'; + fileTreeOrPath = config.get('buildPath'); } else { var gzipFiles = require('broccoli-gzip'); - fileTreeOrPath = gzipFiles('dist', { + fileTreeOrPath = gzipFiles(config.get('buildPath'), { extensions: config.get('assets.gzipExtensions'), appendSuffix: false }); diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 7ccbcb36..cdbcd3a5 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -44,12 +44,12 @@ module.exports = Task.extend({ var indexFiles = config.get('indexFiles'); if(indexFiles) { - ui.writeLine(chalk.blue('\nUploading '+indexFiles.length+' files from `dist/`...\n')); + ui.writeLine(chalk.blue('\nUploading '+indexFiles.length+' files from `'+config.get('buildPath')+'`...\n')); return deploy.uploadFiles(indexFiles); } else { - return readFile('dist/index.html') + return readFile(config.get('buildPath')+'index.html') .then(function(fileContent) { - ui.writeLine(chalk.blue('\nUploading `dist/index.html`...\n')); + ui.writeLine(chalk.blue('\nUploading `'+config.get('buildPath')+'index.html`...\n')); return deploy.upload(fileContent); }); } diff --git a/node-tests/unit/models/config-test.js b/node-tests/unit/models/config-test.js index b6fb5055..c2f564df 100644 --- a/node-tests/unit/models/config-test.js +++ b/node-tests/unit/models/config-test.js @@ -32,6 +32,17 @@ describe('Config', function() { }); }); + describe('buildPath', function(){ + it('defaults to tmp/deploy-dist/', function() { + var config = createConfig('tomster', {}); + expect(config.get('buildPath')).to.eq('tmp/deploy-dist/'); + }); + it('allows configuration', function() { + var config = createConfig('tomster', { buildPath: 'hamsterwheel' }); + expect(config.get('buildPath')).to.eq('hamsterwheel'); + }); + }); + describe('store.type', function(){ it('defaults to redis', function() { var config = createConfig('tomster', {}); From d7d50c42c898c4dd8eb9614c5ae8bb498dfe3db9 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Mon, 29 Jun 2015 12:24:24 -0400 Subject: [PATCH 087/300] lock debug to 2.1.1 to avoid npm warnings --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index a357d7ca..4cb97ddf 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,8 @@ "express": "^4.8.5", "github": "0.2.3", "mocha": "^2.0.1", - "sinon": "^1.12.1" + "sinon": "^1.12.1", + "debug": "2.1.1" }, "keywords": [ "ember-addon", From c2f961e7ce85cc4775cb446068707e760f50b211 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Mon, 29 Jun 2015 12:50:50 -0400 Subject: [PATCH 088/300] update to ember-cli 0.2.7 --- .editorconfig | 1 + .npmignore | 14 ++++++++++ .travis.yml | 9 ++++--- .watchmanconfig | 3 +++ Brocfile.js | 21 ++++++--------- bower.json | 23 ++++++++--------- package.json | 31 +++++++++++------------ testem.json | 3 ++- tests/dummy/app/app.js | 4 ++- tests/dummy/app/templates/application.hbs | 3 +++ tests/dummy/config/environment.js | 1 - tests/dummy/public/crossdomain.xml | 18 ++++++------- tests/dummy/public/robots.txt | 1 + tests/index.html | 16 ------------ tests/test-helper.js | 6 ----- 15 files changed, 75 insertions(+), 79 deletions(-) create mode 100644 .npmignore create mode 100644 .watchmanconfig create mode 100644 tests/dummy/app/templates/application.hbs diff --git a/.editorconfig b/.editorconfig index 2fe4874a..47c54384 100644 --- a/.editorconfig +++ b/.editorconfig @@ -18,6 +18,7 @@ indent_style = space indent_size = 2 [*.hbs] +insert_final_newline = false indent_style = space indent_size = 2 diff --git a/.npmignore b/.npmignore new file mode 100644 index 00000000..49996f5a --- /dev/null +++ b/.npmignore @@ -0,0 +1,14 @@ +bower_components/ +tests/ +tmp/ +dist/ + +.bowerrc +.editorconfig +.ember-cli +.travis.yml +.npmignore +**/.gitkeep +bower.json +Brocfile.js +testem.json diff --git a/.travis.yml b/.travis.yml index cdb44dd3..66dd1076 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,22 +1,23 @@ --- language: node_js - -sudo: false - node_js: - - "0.10" - "0.12" +sudo: false + cache: directories: - node_modules before_install: + - export PATH=/usr/local/phantomjs-2.0.0/bin:$PATH - "npm config set spin false" - "npm install -g npm@^2" install: + - npm install -g bower - npm install + - bower install script: - npm test diff --git a/.watchmanconfig b/.watchmanconfig new file mode 100644 index 00000000..5e9462c2 --- /dev/null +++ b/.watchmanconfig @@ -0,0 +1,3 @@ +{ + "ignore_dirs": ["tmp"] +} diff --git a/Brocfile.js b/Brocfile.js index 042a64dd..2a682c03 100644 --- a/Brocfile.js +++ b/Brocfile.js @@ -3,19 +3,14 @@ var EmberAddon = require('ember-cli/lib/broccoli/ember-addon'); -var app = new EmberAddon(); +/* + This Brocfile specifes the options for the dummy test app of this + addon, located in `/tests/dummy` + + This Brocfile does *not* influence how the addon or the app using it + behave. You most likely want to be modifying `./index.js` or app's Brocfile +*/ -// Use `app.import` to add additional libraries to the generated -// output files. -// -// If you need to use different assets in different -// environments, specify an object as the first parameter. That -// object's keys should be the environment name and the values -// should be the asset to use in that environment. -// -// If the library that you are including contains AMD or ES6 -// modules that you would like to import into your application -// please specify an object with the list of modules as keys -// along with the exports of each module as its value. +var app = new EmberAddon(); module.exports = app.toTree(); diff --git a/bower.json b/bower.json index eafbc31d..15db356f 100644 --- a/bower.json +++ b/bower.json @@ -1,17 +1,16 @@ { "name": "ember-cli-deploy", "dependencies": { - "handlebars": "~1.3.0", + "ember": "1.12.0", + "ember-cli-shims": "ember-cli/ember-cli-shims#0.0.3", + "ember-cli-test-loader": "ember-cli-test-loader#0.1.3", + "ember-data": "1.0.0-beta.18", + "ember-load-initializers": "ember-cli/ember-load-initializers#0.1.4", + "ember-qunit": "0.3.3", + "ember-qunit-notifications": "0.0.7", + "ember-resolver": "~0.1.15", "jquery": "^1.11.1", - "ember": "1.8.1", - "ember-data": "1.0.0-beta.12", - "ember-resolver": "~0.1.11", - "loader.js": "stefanpenner/loader.js#1.0.1", - "ember-cli-shims": "stefanpenner/ember-cli-shims#0.0.3", - "ember-cli-test-loader": "rwjblue/ember-cli-test-loader#0.0.4", - "ember-load-initializers": "stefanpenner/ember-load-initializers#0.0.2", - "ember-qunit": "0.1.8", - "ember-qunit-notifications": "0.0.4", - "qunit": "~1.15.0" + "loader.js": "ember-cli/loader.js#3.2.0", + "qunit": "~1.17.1" } -} +} \ No newline at end of file diff --git a/package.json b/package.json index 4cb97ddf..5b20be42 100644 --- a/package.json +++ b/package.json @@ -19,39 +19,38 @@ "author": "", "license": "MIT", "devDependencies": { - "broccoli-asset-rev": "^2.0.0", - "broccoli-ember-hbs-template-compiler": "^1.6.1", "chai": "^1.9.2", "chai-as-promised": "^4.1.1", - "ember-cli": "^0.1.5", - "ember-cli-content-security-policy": "0.3.0", - "ember-cli-dependency-checker": "0.0.7", - "ember-cli-esnext": "0.1.1", + "broccoli-asset-rev": "^2.0.2", + "ember-cli": "0.2.7", + "ember-cli-app-version": "0.3.3", + "ember-cli-content-security-policy": "0.4.0", + "ember-cli-dependency-checker": "^1.0.0", + "ember-cli-htmlbars": "0.7.6", "ember-cli-ic-ajax": "0.1.1", "ember-cli-inject-live-reload": "^1.3.0", - "ember-cli-qunit": "0.1.2", - "ember-data": "1.0.0-beta.12", - "ember-export-application-global": "^1.0.0", - "express": "^4.8.5", "github": "0.2.3", "mocha": "^2.0.1", "sinon": "^1.12.1", - "debug": "2.1.1" + "debug": "2.1.1", + "ember-cli-qunit": "0.3.13", + "ember-cli-uglify": "^1.0.1", + "ember-data": "1.0.0-beta.18", + "ember-disable-proxy-controllers": "^1.0.0", + "ember-export-application-global": "^1.0.2", + "ember-disable-prototype-extensions": "^1.0.0" }, "keywords": [ "ember-addon", "ember-cli-deploy" ], - "ember-addon": { - "configPath": "tests/dummy/config", - "defaultBlueprint": "deploy-config" - }, "dependencies": { + "ember-cli-babel": "^5.0.0", "broccoli": "^0.13.2", "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", "core-object": "0.0.2", - "glob": "^4.0.5", + "glob": "4.4.2", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", "ncp": "^2.0.0", diff --git a/testem.json b/testem.json index eff93f9b..0f35392c 100644 --- a/testem.json +++ b/testem.json @@ -1,6 +1,7 @@ { "framework": "qunit", - "test_page": "tests/index.html", + "test_page": "tests/index.html?hidepassed", + "disable_watching": true, "launch_in_ci": [ "PhantomJS" ], diff --git a/tests/dummy/app/app.js b/tests/dummy/app/app.js index 757df389..8d66b958 100644 --- a/tests/dummy/app/app.js +++ b/tests/dummy/app/app.js @@ -3,9 +3,11 @@ import Resolver from 'ember/resolver'; import loadInitializers from 'ember/load-initializers'; import config from './config/environment'; +var App; + Ember.MODEL_FACTORY_INJECTIONS = true; -var App = Ember.Application.extend({ +App = Ember.Application.extend({ modulePrefix: config.modulePrefix, podModulePrefix: config.podModulePrefix, Resolver: Resolver diff --git a/tests/dummy/app/templates/application.hbs b/tests/dummy/app/templates/application.hbs new file mode 100644 index 00000000..05eb936c --- /dev/null +++ b/tests/dummy/app/templates/application.hbs @@ -0,0 +1,3 @@ +

Welcome to Ember.js

+ +{{outlet}} diff --git a/tests/dummy/config/environment.js b/tests/dummy/config/environment.js index 445c5336..c59bcd53 100644 --- a/tests/dummy/config/environment.js +++ b/tests/dummy/config/environment.js @@ -5,7 +5,6 @@ module.exports = function(environment) { modulePrefix: 'dummy', environment: environment, baseURL: '/', - podModulePrefix: 'dummy/pods', locationType: 'auto', EmberENV: { FEATURES: { diff --git a/tests/dummy/public/crossdomain.xml b/tests/dummy/public/crossdomain.xml index 29a035d7..0c16a7a0 100644 --- a/tests/dummy/public/crossdomain.xml +++ b/tests/dummy/public/crossdomain.xml @@ -1,15 +1,15 @@ - + - - + + - - + + diff --git a/tests/dummy/public/robots.txt b/tests/dummy/public/robots.txt index 5debfa4d..f5916452 100644 --- a/tests/dummy/public/robots.txt +++ b/tests/dummy/public/robots.txt @@ -1,2 +1,3 @@ # http://www.robotstxt.org User-agent: * +Disallow: diff --git a/tests/index.html b/tests/index.html index 4112b61b..8fea6fe7 100644 --- a/tests/index.html +++ b/tests/index.html @@ -13,22 +13,6 @@ - {{content-for 'head-footer'}} {{content-for 'test-head-footer'}} diff --git a/tests/test-helper.js b/tests/test-helper.js index b5f6449d..e6cfb70f 100644 --- a/tests/test-helper.js +++ b/tests/test-helper.js @@ -4,9 +4,3 @@ import { } from 'ember-qunit'; setResolver(resolver); - -document.write('

'); - -QUnit.config.urlConfig.push({ id: 'nocontainer', label: 'Hide container'}); -var containerVisibility = QUnit.urlParams.nocontainer ? 'hidden' : 'visible'; -document.getElementById('ember-testing-container').style.visibility = containerVisibility; From d31c278d71b6d6ff4a4f0851de221abbdbefc0cd Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 6 Jul 2015 22:59:50 -0400 Subject: [PATCH 089/300] Fix tests. --- node-tests/fixtures/config-with-defaults/deploy.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/node-tests/fixtures/config-with-defaults/deploy.js b/node-tests/fixtures/config-with-defaults/deploy.js index 0ac54f4e..d1cab0fc 100644 --- a/node-tests/fixtures/config-with-defaults/deploy.js +++ b/node-tests/fixtures/config-with-defaults/deploy.js @@ -1,6 +1,7 @@ module.exports = { "development": { "buildEnv": "production", + "buildPath": "tmp/deploy-dist/", "indexFiles": null, "manifestPrefix": "foo", "tagging": "sha", @@ -23,6 +24,7 @@ module.exports = { "staging": { "buildEnv": "staging", + "buildPath": "tmp/deploy-dist/", "indexFiles": null, "manifestPrefix": "foo", "tagging": "sha", From a00df737bfa5e829fdc826bddcbc572c3c777742 Mon Sep 17 00:00:00 2001 From: Julien Guimont Date: Wed, 8 Jul 2015 10:09:20 -0400 Subject: [PATCH 090/300] Manifest prefix for activate task. --- lib/tasks/activate.js | 2 +- lib/tasks/deploy-index.js | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index e57a8d66..474139db 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -24,7 +24,7 @@ module.exports = Task.extend({ var deploy = new Adapter({ config: config.get('store'), - manifest: this.project.name(), + manifest: config.get('manifestPrefix'), manifestSize: config.get('store.manifestSize'), ui: ui }); diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 55bdc354..042700c1 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -19,7 +19,7 @@ module.exports = Task.extend({ var adapterType = config.get('store.type'); var taggingAdapterType = config.get('tagging'); - var manifest = this.project.name(); + var manifest = config.get('manifestPrefix'); var adapterRegistry = new AdapterRegistry({ project: this.project }); @@ -30,7 +30,7 @@ module.exports = Task.extend({ .lookup('tagging', taggingAdapterType) var taggingAdapter = new TaggingAdapter({ - manifest: config.get('manifestPrefix') + manifest: manifest }); var deploy = new Adapter({ From b6e49815f4709d39f735377bacf5efad76377a4d Mon Sep 17 00:00:00 2001 From: James Herdman Date: Wed, 8 Jul 2015 15:20:06 -0400 Subject: [PATCH 091/300] Use silent-error NPM Package It was removed from Ember CLI proper, so we'll need to include this ourselves now. Resolves #163 --- lib/commands/deprecated/activate.js | 2 +- lib/tasks/activate.js | 2 +- lib/utilities/adapter.js | 2 +- lib/utilities/assets/unknown.js | 2 +- lib/utilities/configuration-reader.js | 2 +- package.json | 3 ++- 6 files changed, 7 insertions(+), 6 deletions(-) diff --git a/lib/commands/deprecated/activate.js b/lib/commands/deprecated/activate.js index 468d0038..7c42f0e9 100644 --- a/lib/commands/deprecated/activate.js +++ b/lib/commands/deprecated/activate.js @@ -1,6 +1,6 @@ var chalk = require('chalk'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); var DeprecatedCommand = require('./deprecated-command'); var ActivateCommand = require('../activate'); diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index 474139db..e1bdea8f 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -3,7 +3,7 @@ var Task = require('ember-cli/lib/models/task'); var ConfigurationReader = require('../utilities/configuration-reader'); var AdapterRegistry = require('../utilities/adapter-registry'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); var white = chalk.white; var green = chalk.green; diff --git a/lib/utilities/adapter.js b/lib/utilities/adapter.js index 863ab9ee..dd879827 100644 --- a/lib/utilities/adapter.js +++ b/lib/utilities/adapter.js @@ -1,6 +1,6 @@ var CoreObject = require('core-object'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); module.exports = CoreObject.extend({ upload: function() { diff --git a/lib/utilities/assets/unknown.js b/lib/utilities/assets/unknown.js index 78c88ad1..e546ca4a 100644 --- a/lib/utilities/assets/unknown.js +++ b/lib/utilities/assets/unknown.js @@ -1,6 +1,6 @@ var Adapter = require('../adapter'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); var errorMessage = function() { var errorMessage = 'You tried to use an unknown adapter: `' + this.name + diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index 4bf35f1b..6c57f1d7 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -1,7 +1,7 @@ var path = require('path'); var deprecate = require('./deprecate'); var Config = require('../models/config'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); function ConfigurationReader(options) { var root = process.cwd(); diff --git a/package.json b/package.json index 5b20be42..4f657ad5 100644 --- a/package.json +++ b/package.json @@ -45,16 +45,17 @@ "ember-cli-deploy" ], "dependencies": { - "ember-cli-babel": "^5.0.0", "broccoli": "^0.13.2", "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", "core-object": "0.0.2", + "ember-cli-babel": "^5.0.0", "glob": "4.4.2", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", "ncp": "^2.0.0", "rimraf": "^2.2.8", + "silent-error": "^1.0.0", "sync-exec": "^0.5.0" } } From 9e6cff06b88bcbf7686adad2b6f029077f8cfabf Mon Sep 17 00:00:00 2001 From: Robert Jackson Date: Thu, 9 Jul 2015 17:52:14 -0400 Subject: [PATCH 092/300] Use SilentError to log errors when parsing config. The original error and stack is already printed to the console, there is no need to throw a "real" error (because the stack within ember-cli-deploy itself is not useful). --- lib/utilities/configuration-reader.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index 6c57f1d7..f367ecc8 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -26,7 +26,7 @@ function ConfigurationReader(options) { this._config = require(pathToConfig); } catch(e) { ui.writeError(e); - throw new Error('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); + throw new SilentError('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); } environmentConfig = this._config[this._environment]; From d140acd79194f0649c30fa8fb13d2ca78c7ec939 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sat, 11 Apr 2015 19:42:03 +0100 Subject: [PATCH 093/300] First cut of pipeline task. --- lib/tasks/pipeline.js | 66 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 lib/tasks/pipeline.js diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js new file mode 100644 index 00000000..3035a812 --- /dev/null +++ b/lib/tasks/pipeline.js @@ -0,0 +1,66 @@ +var Task = require('ember-cli/lib/models/task'); +var Promise = require('ember-cli/lib/ext/promise'); + +module.exports = Task.extend({ + init: function() { + this._context = { + ui: this.ui, + project: this.project, + analytics: this.analytics, + data: {} + }; + + var addons = this.project.addons; + addons.forEach(this._mergePluginHooks.bind(this)); + }, + + _deploymentHooks: { + willDeploy: [], + build: [], + upload: [], + activate: [], + didDeploy: [] + }, + + run: function(hooks) { + var context = this._context; + var deploymentHooks = this._deploymentHooks; + + hooks = hooks || Object.keys(deploymentHooks); + + return hooks.reduce(function(promise, hookName) { + var hookPromise = this._executeHook.bind(this, hookName, context); + return promise.then(hookPromise); + }.bind(this), Promise.resolve()); + }, + + _executeHook: function(hookName, context) { + var pluginHooks = this._deploymentHooks[hookName]; + + return pluginHooks.reduce(function(promise, fn) { + return promise.then(fn.bind(null, context)); + }, Promise.resolve()); + }, + + _mergePluginHooks: function(addon) { + var keywords = addon.pkg.keywords; + + if (keywords.indexOf('ember-cli-deploy-plugin') > -1) { + if (addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function') { + var deploymentHooks = this._deploymentHooks; + var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; + var name = addon.name.match(pluginNameRegex)[2]; + var pluginHooks = addon.createDeployPlugin({name: name}); + + Object.keys(deploymentHooks).forEach(function(hookName) { + var fn = pluginHooks[hookName]; + + if (fn) { + deploymentHooks[hookName].push(fn); + } + }); + } + } + } +}); + From 8773c4ff6e3b2093341614620aece335d35f4ac7 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 13 Apr 2015 23:10:37 +0100 Subject: [PATCH 094/300] Added to the pipeline tasks - Moved `this._deploymentHooks` initialisation into the init method so that it is an instance variable - Moved code to check if addon is a valid plugin into it's own function - Added checks for config, project, appConfig etc on init of pipeline task - Added test for pipeline task --- lib/tasks/pipeline.js | 79 ++++--- node-tests/unit/tasks/pipeline-test.js | 298 +++++++++++++++++++++++++ 2 files changed, 349 insertions(+), 28 deletions(-) create mode 100644 node-tests/unit/tasks/pipeline-test.js diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 3035a812..5def4eaf 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -1,12 +1,37 @@ -var Task = require('ember-cli/lib/models/task'); -var Promise = require('ember-cli/lib/ext/promise'); +var Task = require('ember-cli/lib/models/task'); +var Promise = require('ember-cli/lib/ext/promise'); +var SilentError = require('ember-cli/lib/errors/silent'); module.exports = Task.extend({ init: function() { + if (!this.project) { + throw new SilentError('No project passed to pipeline task'); + } + + if (!this.config) { + throw new SilentError('No deploy config passed to pipeline task'); + } + + if (!this.appConfig) { + throw new SilentError('No app config passed to pipeline task'); + } + + if (!this.ui) { + throw new SilentError('No ui passed to pipeline task'); + } + + this._deploymentHooks = { + willDeploy: [], + build: [], + upload: [], + activate: [], + didDeploy: [] + }, + this._context = { ui: this.ui, - project: this.project, - analytics: this.analytics, + config: this.config, + appConfig: this.appConfig, data: {} }; @@ -14,14 +39,6 @@ module.exports = Task.extend({ addons.forEach(this._mergePluginHooks.bind(this)); }, - _deploymentHooks: { - willDeploy: [], - build: [], - upload: [], - activate: [], - didDeploy: [] - }, - run: function(hooks) { var context = this._context; var deploymentHooks = this._deploymentHooks; @@ -43,24 +60,30 @@ module.exports = Task.extend({ }, _mergePluginHooks: function(addon) { - var keywords = addon.pkg.keywords; + var isValidDeployPlugin = this._isValidDeployPlugin(addon); + + if (isValidDeployPlugin) { + var deploymentHooks = this._deploymentHooks; + var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; + var name = addon.name.match(pluginNameRegex)[2]; + var pluginHooks = addon.createDeployPlugin({name: name}); + + Object.keys(deploymentHooks).forEach(function(hookName) { + var fn = pluginHooks[hookName]; - if (keywords.indexOf('ember-cli-deploy-plugin') > -1) { - if (addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function') { - var deploymentHooks = this._deploymentHooks; - var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; - var name = addon.name.match(pluginNameRegex)[2]; - var pluginHooks = addon.createDeployPlugin({name: name}); - - Object.keys(deploymentHooks).forEach(function(hookName) { - var fn = pluginHooks[hookName]; - - if (fn) { - deploymentHooks[hookName].push(fn); - } - }); - } + if (fn) { + deploymentHooks[hookName].push(fn); + } + }); } + }, + + _isValidDeployPlugin: function(addon) { + var keywords = addon.pkg.keywords; + var hasDeployKeyword = keywords.indexOf('ember-cli-deploy-plugin') > -1; + var implementsDeploymentHooks = addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; + + return hasDeployKeyword && implementsDeploymentHooks; } }); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js new file mode 100644 index 00000000..4e61674f --- /dev/null +++ b/node-tests/unit/tasks/pipeline-test.js @@ -0,0 +1,298 @@ +var Promise = require('ember-cli/lib/ext/promise'); +var PipelineTask = require('../../../lib/tasks/pipeline'); +var expect = require('chai').expect; +var assert = require('chai').assert; + +describe('PipelineTask', function() { + var mockProject = {addons: []}; + var mockConfig = {}; + var mockAppConfig = {}; + var mockUi = {}; + + describe('creating a new instance', function() { + it ('raises an error if project is not provided', function() { + var fn = function() { + new PipelineTask({}); + }; + + expect(fn).to.throw('No project passed to pipeline task'); + }); + + it ('raises an error if deploy config is not provided', function() { + var fn = function() { + new PipelineTask({ + project: mockProject + }); + }; + + expect(fn).to.throw('No deploy config passed to pipeline task'); + }); + + it ('raises an error if app config is not provided', function() { + var fn = function() { + new PipelineTask({ + project: mockProject, + config: mockConfig + }); + }; + + expect(fn).to.throw('No app config passed to pipeline task'); + }); + + it ('raises an error if ui is not provided', function() { + var fn = function() { + new PipelineTask({ + project: mockProject, + config: mockConfig, + appConfig: mockAppConfig + }); + }; + + expect(fn).to.throw('No ui passed to pipeline task'); + }); + + it ('creates the deployment context object', function() { + var task = new PipelineTask({ + project: mockProject, + config: mockConfig, + appConfig: mockAppConfig, + ui: mockUi + }); + + var context = task._context; + + expect(context.ui).to.equal(mockUi); + expect(context.config).to.equal(mockConfig); + expect(context.appConfig).to.equal(mockAppConfig); + expect(context.data).to.eql({}); + }); + + it('registers addons with correct keywords that create the deploy plugin', function() { + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + willDeploy: function() {}, + upload: function() {}, + didDeploy: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + var registeredHooks = task._deploymentHooks; + + expect(registeredHooks.willDeploy[0]).to.be.a('function'); + expect(registeredHooks.upload[0]).to.be.a('function'); + expect(registeredHooks.didDeploy[0]).to.be.a('function'); + }); + + it('does not register addons missing the correct keywords', function() { + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ ] + }, + createDeployPlugin: function() { + return { + willDeploy: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + var registeredHooks = task._deploymentHooks; + + expect(registeredHooks.willDeploy[0]).to.be.undefined; + }); + + it('does not register addons that don\'t implement the createDeployPlugin function', function() { + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ ] + }, + someOtherFunction: function() { + return { + willDeploy: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + var registeredHooks = task._deploymentHooks; + + expect(registeredHooks.willDeploy[0]).to.be.undefined; + }); + }); + + describe('running the pipeline task', function() { + it ('runs the hook function, passing in the deployment context', function(done) { + var ctx; + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + willDeploy: function(context) { + ctx = context; + return Promise.resolve(); + } + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + task.run() + .then(function() { + expect(ctx.ui).to.equal(mockUi); + expect(ctx.config).to.equal(mockConfig); + expect(ctx.appConfig).to.equal(mockAppConfig); + expect(ctx.data).to.eql({}); + done(); + }) + .catch(function() { + done(arguments[0]); + }); + }); + + describe('running all deploy hooks', function() { + it ('runs functions for all hooks', function(done) { + var functionsRun = 0; + var fn = function() { functionsRun += 1;} + + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + willDeploy: fn, + build: fn, + upload: fn, + activate: fn, + didDeploy: fn, + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + task.run() + .then(function() { + expect(functionsRun).to.equal(5); + done(); + }) + .catch(function() { + done(arguments[0]); + }); + }); + }); + + describe('running specific deploy hooks', function() { + it ('runs only the functions specified', function(done) { + var functionsRun = 0; + var fn = function() { functionsRun += 1;} + + var project = { + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + willDeploy: fn, + build: fn, + upload: fn, + activate: fn, + didDeploy: fn, + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + config: mockConfig, + appConfig: mockAppConfig + }); + + task.run(['build', 'activate', 'didDeploy']) + .then(function() { + expect(functionsRun).to.equal(3); + done(); + }) + .catch(function() { + done(arguments[0]); + }); + }); + }); + }); +}); From 894898c4ee24e645a7f568bd565bf87266ec59ea Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 14 Apr 2015 20:52:59 +0100 Subject: [PATCH 095/300] Changed ConfigurationReader to expect deploy.js to be the same format as environment.js So, now the deploy.js is ecpected to be a function that returns an object. This means that we can use the ConfigurationReader for both the deploy.js and environment.js noth of which we want to pass through the pipeline --- config/deploy.js | 56 ++++++++++--------- lib/utilities/configuration-reader.js | 8 +-- node-tests/fixtures/config/deploy.js | 55 ++++++++++-------- .../utilities/configuration-reader-test.js | 53 +++++++++--------- 4 files changed, 93 insertions(+), 79 deletions(-) diff --git a/config/deploy.js b/config/deploy.js index f47046aa..469cfe6c 100644 --- a/config/deploy.js +++ b/config/deploy.js @@ -1,28 +1,34 @@ -module.exports = { - "development": { - "store": { - "host": "localhost", - "port": 63790 - }, - "assets": { - "accessKeyId": "", - "secretAccessKey": "", - "bucket": "" - } - }, +module.exports = function(environment) { + var ENV = {}; - "staging": { - "buildEnv": "staging", - "store": { - "host": "staging-redis.firstiwaslike.com", - "port": 6379 - }, - "assets": { - "accessKeyId": "", - "secretAccessKey": "", - "bucket": "", - "prefix": "", - "gzipExtensions": ["js", "css", "svg", "json"] - } + if (environment === 'development') { + ENV.store = { + host: 'localhost', + port: 6379 + }; + + ENV.assets = { + accessKeyId: '', + secretAccessKey: '', + bucket: '' + }; + } + + if (environment === 'staging') { + ENV.buildEnv = 'staging'; + + ENV.store = { + host: 'staging-redis.firstiwaslike.com', + port: 6379 + }; + + ENV.assets = { + accessKeyId: '', + secretAccessKey: '', + bucket: '', + prefix: '' + }; } + + return ENV; } diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index f367ecc8..8eeab4be 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -23,15 +23,13 @@ function ConfigurationReader(options) { try { var pathToConfig = path.join(root, this._deployConfig); - this._config = require(pathToConfig); + this._config = require(pathToConfig)(this._environment); } catch(e) { ui.writeError(e); throw new SilentError('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); } - environmentConfig = this._config[this._environment]; - - if (!environmentConfig) { + if (!Object.keys(this._config).length) { throw new SilentError('You are using the `' + this._environment + '` environment but have not specified any configuration.' + '\n\nPlease add a `' + this._environment + '` section to your `config/deploy.js` file.' + '\n\nFor more information, go to: `https://github.com/ember-cli/ember-cli-deploy#config-file`'); @@ -39,7 +37,7 @@ function ConfigurationReader(options) { this.config = new Config({ project: project, - rawConfig: environmentConfig + rawConfig: this._config }); } diff --git a/node-tests/fixtures/config/deploy.js b/node-tests/fixtures/config/deploy.js index f60f58b0..469cfe6c 100644 --- a/node-tests/fixtures/config/deploy.js +++ b/node-tests/fixtures/config/deploy.js @@ -1,27 +1,34 @@ -module.exports = { - "development": { - "store": { - "host": "localhost", - "port": 63790 - }, - "assets": { - "accessKeyId": "", - "secretAccessKey": "", - "bucket": "" - } - }, +module.exports = function(environment) { + var ENV = {}; - "staging": { - "store": { - "host": "staging-redis.firstiwaslike.com", - "port": 6379 - }, - "assets": { - "accessKeyId": "", - "secretAccessKey": "", - "bucket": "", - "prefix": "", - "gzipExtensions": ["js", "css", "svg", "json"] - } + if (environment === 'development') { + ENV.store = { + host: 'localhost', + port: 6379 + }; + + ENV.assets = { + accessKeyId: '', + secretAccessKey: '', + bucket: '' + }; + } + + if (environment === 'staging') { + ENV.buildEnv = 'staging'; + + ENV.store = { + host: 'staging-redis.firstiwaslike.com', + port: 6379 + }; + + ENV.assets = { + accessKeyId: '', + secretAccessKey: '', + bucket: '', + prefix: '' + }; } + + return ENV; } diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 38dfeb77..4d5b8862 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -35,27 +35,28 @@ describe('ConfigurationReader', function() { }); describe('configuration settings', function() { - it('reads a passed json deploy-config-file if one is passed', function() { + it('throws an error when passed a json deploy-config-file', function() { var configPath = './node-tests/fixtures/config/deploy.json'; var root = process.cwd(); var fixtureConfigPath = path.join(root, configPath); var expectedConfig = require(fixtureConfigPath); - var config = new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }); + var fn = function() { + new ConfigurationReader({ + configFile: configPath, + ui: ui, + project: project + }); + } - expect(ui.output).to.include('DEPRECATION: Using a .json file for deployment configuration is deprecated. Please use a .js file instead'); - expect(config._config).to.equal(expectedConfig); + expect(fn).to.throw('Cannot load configuration file'); }); it('reads a passed js deploy-config-file if one is passed', function() { var configPath = './node-tests/fixtures/config/deploy.js'; var root = process.cwd(); var fixtureConfigPath = path.join(root, configPath); - var expectedConfig = require(fixtureConfigPath); + var expectedConfig = require(fixtureConfigPath)('development'); var config = new ConfigurationReader({ configFile: configPath, @@ -63,45 +64,47 @@ describe('ConfigurationReader', function() { project: project }); - expect(config._config).to.equal(expectedConfig); + expect(config._config).to.eql(expectedConfig); }); it('uses `./config/deploy.js` as default when no config is passed', function() { var root = process.cwd(); - var expectedConfig = require(path.join(root, './config/deploy.js')); + var expectedConfig = require(path.join(root, './config/deploy.js'))('development'); var config = new ConfigurationReader({ ui: ui, project: project }); - expect(config._config).to.equal(expectedConfig) + expect(config._config).to.eql(expectedConfig) }); it('raises an error in the case of a passed deploy-config-file that doesn\'t exist', function() { var configPath = './node-tests/fixtures/config/does-not-exist.js'; var root = process.cwd(); - - expect(function() { - var config = new ConfigurationReader({ + var fn = function() { + new ConfigurationReader({ configFile: configPath, ui: ui, project: project }); - }).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); + }; + + expect(fn).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); }); it('raises an error if a config doesn\'t exist for the current environment', function() { var configPath = './node-tests/fixtures/config/deploy.js'; - - expect(function() { + var fn = function() { new ConfigurationReader({ configFile: configPath, ui: ui, project: project, environment: 'non-existent-env' }); - }).to.throw(/You are using the `non-existent-env` environment/); + }; + + expect(fn).to.throw(/You are using the `non-existent-env` environment/); }); }); @@ -111,11 +114,11 @@ describe('ConfigurationReader', function() { var root = process.cwd(); var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - ENVs.forEach(function(ENV) { - var expected = cfgFile[ENV].store; + ENVs.forEach(function(env) { + var expected = cfgFile(env).store; var config = new ConfigurationReader({ - environment: ENV, + environment: env, ui: ui, project: project }).config; @@ -131,11 +134,11 @@ describe('ConfigurationReader', function() { var root = process.cwd(); var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - ENVs.forEach(function(ENV) { - var expected = cfgFile[ENV].assets; + ENVs.forEach(function(env) { + var expected = cfgFile(env).assets; var config = new ConfigurationReader({ - environment: ENV, + environment: env, ui: ui, project: project }).config; From 7e12b11c1cfdf017fb3561eb29d92af2331cd308 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 14 Apr 2015 20:54:23 +0100 Subject: [PATCH 096/300] Changed deploy command to use the pipeline task --- lib/commands/deploy.js | 48 +++++++++++++----------------------------- 1 file changed, 15 insertions(+), 33 deletions(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index d1fcd8ec..d4c9dacd 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,6 +1,3 @@ -var ConfigurationReader = require('../utilities/configuration-reader'); -var AssetsUploader = require('../utilities/assets-uploader'); - module.exports = { name: 'deploy', description: 'Deploys an ember-cli app', @@ -12,46 +9,31 @@ module.exports = { ], run: function(commandOptions, rawArgs) { - var DeployIndexTask = require('../tasks/deploy-index'); - var AssetsTask = require('../tasks/assets'); - var BuildTask = this.tasks.Build; - + var ConfigurationReader = require('../utilities/configuration-reader'); var config = new ConfigurationReader({ environment: commandOptions.environment, configFile: commandOptions.deployConfigFile, project: this.project, ui: this.ui }).config; - var buildTask = new BuildTask({ - ui: this.ui, - analytics: this.analytics, - project: this.project - }); - var buildOptions = { - environment: config.get('buildEnv'), - outputPath: config.get('buildPath'), - watch: false, - disableAnalytics: false - }; - var assetsTask = new AssetsTask({ - ui: this.ui, - analytics: this.analytics, + var buildEnv = config.get('buildEnv'); + + var appConfig = new ConfigurationReader({ + environment: buildEnv, + configFile: 'config/environment.js', + project: this.project, + ui: this.ui + }).config; + + var PipelineTask = require('../tasks/pipeline'); + var pipeline = new PipelineTask({ project: this.project, - AssetsUploader: AssetsUploader - }); - var deployIndexTask = new DeployIndexTask({ ui: this.ui, - analytics: this.analytics, - project: this.project + config: config, + appConfig: appConfig }); - return buildTask.run(buildOptions) - .then(function() { - return assetsTask.run(commandOptions); - }) - .then(function() { - return deployIndexTask.run(commandOptions); - }); + return pipeline.run(); } }; From d26d0b7916c6b42bb35a2c79964a5a2a8fb726aa Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 17 Apr 2015 09:03:32 +0100 Subject: [PATCH 097/300] Now each plugin hook has `this` bound to the object that `createDeployPlugin` returns As suggeste by Luke --- lib/tasks/pipeline.js | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 5def4eaf..1d575b29 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -55,7 +55,7 @@ module.exports = Task.extend({ var pluginHooks = this._deploymentHooks[hookName]; return pluginHooks.reduce(function(promise, fn) { - return promise.then(fn.bind(null, context)); + return promise.then(fn(context)); }, Promise.resolve()); }, @@ -72,7 +72,7 @@ module.exports = Task.extend({ var fn = pluginHooks[hookName]; if (fn) { - deploymentHooks[hookName].push(fn); + deploymentHooks[hookName].push(fn.bind(pluginHooks)); } }); } From 5c3626830c53e9be06813b6d7127203075682a03 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 17 Apr 2015 23:36:11 +0100 Subject: [PATCH 098/300] Fixed bug where we were executing fn and passing the result into then --- lib/tasks/pipeline.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 1d575b29..1ae692a5 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -26,7 +26,7 @@ module.exports = Task.extend({ upload: [], activate: [], didDeploy: [] - }, + }; this._context = { ui: this.ui, @@ -55,7 +55,9 @@ module.exports = Task.extend({ var pluginHooks = this._deploymentHooks[hookName]; return pluginHooks.reduce(function(promise, fn) { - return promise.then(fn(context)); + return promise.then(function() { + return fn(context); + }); }, Promise.resolve()); }, From 4b815309213fe4c358f7c6b92e951a55eb066c15 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 17 Apr 2015 23:52:17 +0100 Subject: [PATCH 099/300] Added `analytics` and `project` to the deployment context object The BuildTask requires at the least the analytics object and I think the project object too. Therefore I think it's a good idea to add these to the deployment object --- lib/commands/deploy.js | 1 + lib/tasks/pipeline.js | 6 ++++++ node-tests/unit/tasks/pipeline-test.js | 12 +++++++++++- 3 files changed, 18 insertions(+), 1 deletion(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index d4c9dacd..5946cadd 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -30,6 +30,7 @@ module.exports = { var pipeline = new PipelineTask({ project: this.project, ui: this.ui, + analytics: this.analytics, config: config, appConfig: appConfig }); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 1ae692a5..f4bd5dd7 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -20,6 +20,10 @@ module.exports = Task.extend({ throw new SilentError('No ui passed to pipeline task'); } + if (!this.analytics) { + throw new SilentError('No analytics passed to pipeline task'); + } + this._deploymentHooks = { willDeploy: [], build: [], @@ -30,6 +34,8 @@ module.exports = Task.extend({ this._context = { ui: this.ui, + project: this.project, + analytics: this.analytics, config: this.config, appConfig: this.appConfig, data: {} diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 4e61674f..37c63ab6 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -8,6 +8,7 @@ describe('PipelineTask', function() { var mockConfig = {}; var mockAppConfig = {}; var mockUi = {}; + var mockAnalytics = {}; describe('creating a new instance', function() { it ('raises an error if project is not provided', function() { @@ -56,12 +57,14 @@ describe('PipelineTask', function() { project: mockProject, config: mockConfig, appConfig: mockAppConfig, - ui: mockUi + ui: mockUi, + analytics: mockAnalytics }); var context = task._context; expect(context.ui).to.equal(mockUi); + expect(context.analytics).to.equal(mockAnalytics); expect(context.config).to.equal(mockConfig); expect(context.appConfig).to.equal(mockAppConfig); expect(context.data).to.eql({}); @@ -91,6 +94,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -122,6 +126,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -151,6 +156,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -188,6 +194,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -195,6 +202,7 @@ describe('PipelineTask', function() { task.run() .then(function() { expect(ctx.ui).to.equal(mockUi); + expect(ctx.analytics).to.equal(mockAnalytics); expect(ctx.config).to.equal(mockConfig); expect(ctx.appConfig).to.equal(mockAppConfig); expect(ctx.data).to.eql({}); @@ -235,6 +243,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -280,6 +289,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); From 87bbaed236b7ac3fc89fe9a2d9d036119d8451a2 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 20 Apr 2015 10:41:21 +0100 Subject: [PATCH 100/300] Removed analytics as ember-cli-deploy-build now uses the Builder instead of BuildTask --- lib/commands/deploy.js | 1 - lib/tasks/pipeline.js | 5 ----- 2 files changed, 6 deletions(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 5946cadd..d4c9dacd 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -30,7 +30,6 @@ module.exports = { var pipeline = new PipelineTask({ project: this.project, ui: this.ui, - analytics: this.analytics, config: config, appConfig: appConfig }); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index f4bd5dd7..b5d8efe1 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -20,10 +20,6 @@ module.exports = Task.extend({ throw new SilentError('No ui passed to pipeline task'); } - if (!this.analytics) { - throw new SilentError('No analytics passed to pipeline task'); - } - this._deploymentHooks = { willDeploy: [], build: [], @@ -35,7 +31,6 @@ module.exports = Task.extend({ this._context = { ui: this.ui, project: this.project, - analytics: this.analytics, config: this.config, appConfig: this.appConfig, data: {} From 92374aa205be3926ce33a5ffb574e6c8b304d7b8 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 20 Apr 2015 22:27:27 +0100 Subject: [PATCH 101/300] Removed anayltics fmor tests --- node-tests/unit/tasks/pipeline-test.js | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 37c63ab6..4e61674f 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -8,7 +8,6 @@ describe('PipelineTask', function() { var mockConfig = {}; var mockAppConfig = {}; var mockUi = {}; - var mockAnalytics = {}; describe('creating a new instance', function() { it ('raises an error if project is not provided', function() { @@ -57,14 +56,12 @@ describe('PipelineTask', function() { project: mockProject, config: mockConfig, appConfig: mockAppConfig, - ui: mockUi, - analytics: mockAnalytics + ui: mockUi }); var context = task._context; expect(context.ui).to.equal(mockUi); - expect(context.analytics).to.equal(mockAnalytics); expect(context.config).to.equal(mockConfig); expect(context.appConfig).to.equal(mockAppConfig); expect(context.data).to.eql({}); @@ -94,7 +91,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -126,7 +122,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -156,7 +151,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -194,7 +188,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -202,7 +195,6 @@ describe('PipelineTask', function() { task.run() .then(function() { expect(ctx.ui).to.equal(mockUi); - expect(ctx.analytics).to.equal(mockAnalytics); expect(ctx.config).to.equal(mockConfig); expect(ctx.appConfig).to.equal(mockAppConfig); expect(ctx.data).to.eql({}); @@ -243,7 +235,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); @@ -289,7 +280,6 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - analytics: mockAnalytics, config: mockConfig, appConfig: mockAppConfig }); From 3405aae891feee9c64738f08faf71b91a73a082c Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 21 Apr 2015 21:45:36 +0100 Subject: [PATCH 102/300] Add new pipeline object, but it's not being used as yet --- lib/utilities/pipeline.js | 49 ++++++++ node-tests/helpers/expect.js | 6 + node-tests/unit/utilities/pipeline-test.js | 140 +++++++++++++++++++++ 3 files changed, 195 insertions(+) create mode 100644 lib/utilities/pipeline.js create mode 100644 node-tests/helpers/expect.js create mode 100644 node-tests/unit/utilities/pipeline-test.js diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js new file mode 100644 index 00000000..cf32c68f --- /dev/null +++ b/lib/utilities/pipeline.js @@ -0,0 +1,49 @@ +'use strict'; + +var Promise = require('rsvp').Promise; +var _ = require('lodash-node'); + +function Pipeline(hookNames) { + hookNames = hookNames || []; + + this._pipelineHooks = hookNames.reduce(function(pipelineHooks, hookName) { + pipelineHooks[hookName] = []; + + return pipelineHooks; + }, {}); +} + +Pipeline.prototype.register = function(hookName, fn) { + var pipelineHooks = this._pipelineHooks; + + if (pipelineHooks[hookName]) { + pipelineHooks[hookName].push(fn); + } +}; + +Pipeline.prototype.execute = function(context) { + context = context || { }; + + var pipelineHooks = this._pipelineHooks; + var hookNames = Object.keys(pipelineHooks); + + return hookNames.reduce(function(promise, hookName) { + return promise.then(this._executeHook.bind(this, hookName)); + }.bind(this), Promise.resolve(context)); +}; + +Pipeline.prototype._executeHook = function(hookName, context) { + var hookFunctions = this._pipelineHooks[hookName]; + + return hookFunctions.reduce(function(promise, fn) { + return promise + .then(function(context) { + return fn(_.cloneDeep(context)); + }) + .then(function(result) { + return _.merge(result, context); + }) + }, Promise.resolve(context)); +} + +module.exports = Pipeline; diff --git a/node-tests/helpers/expect.js b/node-tests/helpers/expect.js new file mode 100644 index 00000000..46b3ea76 --- /dev/null +++ b/node-tests/helpers/expect.js @@ -0,0 +1,6 @@ +var chai = require('chai'); +var chaiAsPromised = require('chai-as-promised'); + +chai.use(chaiAsPromised); + +module.exports = chai.expect; diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js new file mode 100644 index 00000000..b2948ebb --- /dev/null +++ b/node-tests/unit/utilities/pipeline-test.js @@ -0,0 +1,140 @@ +var Promise = require('ember-cli/lib/ext/promise'); +var Pipeline = require('../../../lib/utilities/pipeline'); + +var expect = require('../../helpers/expect'); + +describe ('Pipeline', function() { + describe ('initialization', function() { + it ('initializes the given list of hooks', function() { + var subject = new Pipeline(['willDeploy', 'didDeploy']); + + expect(Object.keys(subject._pipelineHooks).length).to.eq(2); + expect(subject._pipelineHooks.willDeploy).to.eql([]); + expect(subject._pipelineHooks.didDeploy).to.eql([]); + }); + }); + + describe ('#register', function() { + it ('registers functions for defined hooks', function() { + var subject = new Pipeline(['willDeploy']); + var fn = function() {}; + + subject.register('willDeploy', fn); + + expect(subject._pipelineHooks.willDeploy.length).to.eq(1) + expect(subject._pipelineHooks.willDeploy[0]).to.eql(fn); + }); + + it ('doesn\'t register functions for hooks not defined', function() { + var subject = new Pipeline(['willDeploy']); + var fn = function() {}; + + subject.register('build', fn); + + expect(subject._pipelineHooks.willDeploy.length).to.eq(0) + expect(subject._pipelineHooks.build).to.eq(undefined); + }); + }); + + describe ('#execute', function() { + it ('runs the registered functions', function() { + var subject = new Pipeline(['hook1', 'hook2']); + var hooksRun = []; + + subject.register('hook1', function() { + hooksRun.push('1'); + }); + + subject.register('hook2', function() { + hooksRun.push('2'); + }); + + return expect(subject.execute()).to.be.fulfilled + .then(function() { + expect(hooksRun.length).to.eq(2); + expect(hooksRun[0]).to.eq('1'); + expect(hooksRun[1]).to.eq('2'); + }); + }); + + it('passes the default context object when one isn\'t provided', function() { + var subject = new Pipeline(['hook1']); + var data = null; + + subject.register('hook1', function(context) { + data = context; + }); + + return expect(subject.execute()).to.be.fulfilled + .then(function() { + expect(data).to.deep.equal({}); + }); + }); + + it('passes the provided context object to hooks when provided', function() { + var subject = new Pipeline(['hook1']); + var data = null; + + subject.register('hook1', function(context) { + data = context; + }); + + return expect(subject.execute({deploy: {}})).to.be.fulfilled + .then(function() { + expect(data).to.deep.equal({deploy: {}}); + }); + }); + + it('passes in a copy of the context to each hook', function() { + var subject = new Pipeline(['hook1']); + var context = {name: 'test-context'}; + + subject.register('hook1', function(context) { + context.name = 'changed'; + }); + + return expect(subject.execute(context)).to.be.fulfilled + .then(function() { + expect(context.name).to.equal('test-context'); + }); + }); + + it('merges the return value (object) of each hook into the context', function() { + var subject = new Pipeline(['hook1']); + var finalContext = null; + + subject.register('hook1', function(context) { + return {age: 47}; + }); + + subject.register('hook1', function(context) { + finalContext = context; + }); + + return expect(subject.execute({name: 'test-context'})).to.be.fulfilled + .then(function() { + expect(finalContext.name).to.equal('test-context'); + expect(finalContext.age).to.equal(47); + }); + }); + + it('merges the return value (promise) of each hook into the context', function() { + var subject = new Pipeline(['hook1']); + var finalContext = null; + + subject.register('hook1', function(context) { + return Promise.resolve({age: 47}); + }); + + subject.register('hook1', function(context) { + finalContext = context; + }); + + return expect(subject.execute({name: 'test-context'})).to.be.fulfilled + .then(function() { + expect(finalContext.name).to.equal('test-context'); + expect(finalContext.age).to.equal(47); + }); + }); + }); +}); From 2fafafcd3129041bead33774991aa03f358fb7ee Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 00:32:23 +0100 Subject: [PATCH 103/300] Now we're using the pipeline object inside the PipelineTask --- config/environment.js | 2 +- lib/commands/deploy.js | 28 +-- lib/tasks/pipeline.js | 86 ++++--- node-tests/fixtures/config/deploy.js | 4 + node-tests/unit/tasks/pipeline-test.js | 299 +++++++------------------ 5 files changed, 136 insertions(+), 283 deletions(-) diff --git a/config/environment.js b/config/environment.js index 0dfaed47..51d56363 100644 --- a/config/environment.js +++ b/config/environment.js @@ -1,5 +1,5 @@ 'use strict'; module.exports = function(/* environment, appConfig */) { - return { }; + return { something: 'test' }; }; diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index d4c9dacd..eab2ca3d 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -9,29 +9,19 @@ module.exports = { ], run: function(commandOptions, rawArgs) { - var ConfigurationReader = require('../utilities/configuration-reader'); - var config = new ConfigurationReader({ - environment: commandOptions.environment, - configFile: commandOptions.deployConfigFile, - project: this.project, - ui: this.ui - }).config; - - var buildEnv = config.get('buildEnv'); - - var appConfig = new ConfigurationReader({ - environment: buildEnv, - configFile: 'config/environment.js', - project: this.project, - ui: this.ui - }).config; - var PipelineTask = require('../tasks/pipeline'); var pipeline = new PipelineTask({ project: this.project, ui: this.ui, - config: config, - appConfig: appConfig + deployEnvironment: commandOptions.environment, + deployConfigPath: commandOptions.deployConfigFile, + hooks: [ + 'willDeploy', + 'willBuild', 'build', 'didBuild', + 'willUpload', 'upload', 'didUpload', + 'willActivate', 'activate', 'didActivate', + 'didDeploy' + ] }); return pipeline.run(); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index b5d8efe1..9f7042b4 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -2,82 +2,74 @@ var Task = require('ember-cli/lib/models/task'); var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('ember-cli/lib/errors/silent'); +var Pipeline = require('../utilities/pipeline'); +var ConfigurationReader = require('../utilities/configuration-reader'); + module.exports = Task.extend({ init: function() { if (!this.project) { throw new SilentError('No project passed to pipeline task'); } - if (!this.config) { - throw new SilentError('No deploy config passed to pipeline task'); - } - - if (!this.appConfig) { - throw new SilentError('No app config passed to pipeline task'); - } - if (!this.ui) { throw new SilentError('No ui passed to pipeline task'); } - this._deploymentHooks = { - willDeploy: [], - build: [], - upload: [], - activate: [], - didDeploy: [] - }; + this._pipeline = this.pipeline || new Pipeline(this.hooks); - this._context = { - ui: this.ui, - project: this.project, - config: this.config, - appConfig: this.appConfig, - data: {} - }; + this.project.addons.forEach(this._registerPipelineHooks.bind(this)); - var addons = this.project.addons; - addons.forEach(this._mergePluginHooks.bind(this)); - }, + this.deployEnvironment = this.deployEnvironment || 'production'; + this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; - run: function(hooks) { - var context = this._context; - var deploymentHooks = this._deploymentHooks; + this._config = new ConfigurationReader({ + environment: this.deployEnvironment, + configFile: this.deployConfigPath, + project: this.project, + ui: this.ui + }).config; - hooks = hooks || Object.keys(deploymentHooks); + var buildEnv = this._config.get('build.buildEnv') || 'production'; - return hooks.reduce(function(promise, hookName) { - var hookPromise = this._executeHook.bind(this, hookName, context); - return promise.then(hookPromise); - }.bind(this), Promise.resolve()); + this._appConfig = new ConfigurationReader({ + environment: buildEnv, + configFile: 'config/environment.js', + project: this.project, + ui: this.ui + }).config; }, - _executeHook: function(hookName, context) { - var pluginHooks = this._deploymentHooks[hookName]; + run: function(hooks) { + var pipeline = this._pipeline; + var context = { + ui: this.ui, + project: this.project, + config: this._config, + appConfig: this._appConfig + }; - return pluginHooks.reduce(function(promise, fn) { - return promise.then(function() { - return fn(context); - }); - }, Promise.resolve()); + return pipeline.execute({ + deployment: context + }); }, - _mergePluginHooks: function(addon) { + _registerPipelineHooks: function(addon) { var isValidDeployPlugin = this._isValidDeployPlugin(addon); if (isValidDeployPlugin) { - var deploymentHooks = this._deploymentHooks; var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; var name = addon.name.match(pluginNameRegex)[2]; var pluginHooks = addon.createDeployPlugin({name: name}); - Object.keys(deploymentHooks).forEach(function(hookName) { - var fn = pluginHooks[hookName]; + Object.keys(pluginHooks).forEach(function(hookName) { + if (hookName !== 'name') { + var fn = pluginHooks[hookName]; - if (fn) { - deploymentHooks[hookName].push(fn.bind(pluginHooks)); + if (typeof fn === 'function') { + this._pipeline.register(hookName, fn.bind(pluginHooks)); + } } - }); + }.bind(this)); } }, diff --git a/node-tests/fixtures/config/deploy.js b/node-tests/fixtures/config/deploy.js index 469cfe6c..bf80fd4f 100644 --- a/node-tests/fixtures/config/deploy.js +++ b/node-tests/fixtures/config/deploy.js @@ -2,6 +2,10 @@ module.exports = function(environment) { var ENV = {}; if (environment === 'development') { + ENV.build = { + buildEnv: 'development' + }; + ENV.store = { host: 'localhost', port: 6379 diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 4e61674f..db55bf8f 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -1,6 +1,6 @@ var Promise = require('ember-cli/lib/ext/promise'); var PipelineTask = require('../../../lib/tasks/pipeline'); -var expect = require('chai').expect; +var expect = require('../../helpers/expect'); var assert = require('chai').assert; describe('PipelineTask', function() { @@ -18,27 +18,6 @@ describe('PipelineTask', function() { expect(fn).to.throw('No project passed to pipeline task'); }); - it ('raises an error if deploy config is not provided', function() { - var fn = function() { - new PipelineTask({ - project: mockProject - }); - }; - - expect(fn).to.throw('No deploy config passed to pipeline task'); - }); - - it ('raises an error if app config is not provided', function() { - var fn = function() { - new PipelineTask({ - project: mockProject, - config: mockConfig - }); - }; - - expect(fn).to.throw('No app config passed to pipeline task'); - }); - it ('raises an error if ui is not provided', function() { var fn = function() { new PipelineTask({ @@ -51,181 +30,57 @@ describe('PipelineTask', function() { expect(fn).to.throw('No ui passed to pipeline task'); }); - it ('creates the deployment context object', function() { - var task = new PipelineTask({ - project: mockProject, - config: mockConfig, - appConfig: mockAppConfig, - ui: mockUi - }); - - var context = task._context; - - expect(context.ui).to.equal(mockUi); - expect(context.config).to.equal(mockConfig); - expect(context.appConfig).to.equal(mockAppConfig); - expect(context.data).to.eql({}); - }); - - it('registers addons with correct keywords that create the deploy plugin', function() { - var project = { - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - willDeploy: function() {}, - upload: function() {}, - didDeploy: function() {} - }; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig - }); - - var registeredHooks = task._deploymentHooks; - - expect(registeredHooks.willDeploy[0]).to.be.a('function'); - expect(registeredHooks.upload[0]).to.be.a('function'); - expect(registeredHooks.didDeploy[0]).to.be.a('function'); - }); - - it('does not register addons missing the correct keywords', function() { - var project = { - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ ] - }, - createDeployPlugin: function() { - return { - willDeploy: function() {} - }; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig - }); - - var registeredHooks = task._deploymentHooks; - - expect(registeredHooks.willDeploy[0]).to.be.undefined; - }); - - it('does not register addons that don\'t implement the createDeployPlugin function', function() { - var project = { - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ ] - }, - someOtherFunction: function() { - return { - willDeploy: function() {} - }; + describe('registering addons with the pipeline', function() { + it('registers addons with ember-cli-deploy-plugin keyword', function() { + var project = { + name: function() {return 'test-project';}, + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + willDeploy: function() {}, + upload: function() {} + }; + } } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig - }); - - var registeredHooks = task._deploymentHooks; + ] + }; - expect(registeredHooks.willDeploy[0]).to.be.undefined; - }); - }); + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'] + }); - describe('running the pipeline task', function() { - it ('runs the hook function, passing in the deployment context', function(done) { - var ctx; - var project = { - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - willDeploy: function(context) { - ctx = context; - return Promise.resolve(); - } - }; - } - } - ] - }; + var registeredHooks = task._pipeline._pipelineHooks; - var task = new PipelineTask({ - project: project, - ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig + expect(registeredHooks.willDeploy[0]).to.be.a('function'); + expect(registeredHooks.upload[0]).to.be.a('function'); }); - task.run() - .then(function() { - expect(ctx.ui).to.equal(mockUi); - expect(ctx.config).to.equal(mockConfig); - expect(ctx.appConfig).to.equal(mockAppConfig); - expect(ctx.data).to.eql({}); - done(); - }) - .catch(function() { - done(arguments[0]); - }); - }); - - describe('running all deploy hooks', function() { - it ('runs functions for all hooks', function(done) { - var functionsRun = 0; - var fn = function() { functionsRun += 1;} - + it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { var project = { + name: function() {return 'test-project';}, addons: [ { name: 'ember-cli-deploy-test-plugin', pkg: { keywords: [ - 'ember-cli-deploy-plugin' + 'some-other-plugin' ] }, createDeployPlugin: function() { return { - willDeploy: fn, - build: fn, - upload: fn, - activate: fn, - didDeploy: fn, + willDeploy: function() {}, + upload: function() {} }; } } @@ -235,42 +90,28 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'] }); - task.run() - .then(function() { - expect(functionsRun).to.equal(5); - done(); - }) - .catch(function() { - done(arguments[0]); - }); - }); - }); + var registeredHooks = task._pipeline._pipelineHooks; - describe('running specific deploy hooks', function() { - it ('runs only the functions specified', function(done) { - var functionsRun = 0; - var fn = function() { functionsRun += 1;} + expect(registeredHooks.willDeploy[0]).to.be.undefined; + }); + it('does not register addons that don\'t implement the createDeployPlugin function', function() { var project = { + name: function() {return 'test-project';}, addons: [ { name: 'ember-cli-deploy-test-plugin', pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] + keywords: [ ] }, - createDeployPlugin: function() { + someOtherFunction: function() { return { - willDeploy: fn, - build: fn, - upload: fn, - activate: fn, - didDeploy: fn, + willDeploy: function() {} }; } } @@ -280,19 +121,45 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - config: mockConfig, - appConfig: mockAppConfig + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'] }); - task.run(['build', 'activate', 'didDeploy']) - .then(function() { - expect(functionsRun).to.equal(3); - done(); - }) - .catch(function() { - done(arguments[0]); - }); + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy[0]).to.be.undefined; }); }); }); + + describe('executing the pipeline task', function() { + it ('executes the pipeline, passing in the deployment context', function() { + var pipelineExecuted = false; + + var project = { + name: function() {return 'test-project';}, + addons: [ ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'], + pipeline: { + execute: function() { + pipelineExecuted = true; + return Promise.resolve(); + } + } + }); + + return expect(task.run()).to.be.fulfilled + .then(function() { + expect(pipelineExecuted).to.be.true; + }); + }); + }); }); From 4cfc873a742388d057122f8d813e14c374d6d28e Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 14:09:46 +0100 Subject: [PATCH 104/300] Removed the need for the ConfigurationReader and Configuration objects. --- lib/tasks/pipeline.js | 37 ++++++++++++---------- lib/utilities/pipeline.js | 2 +- node-tests/unit/tasks/pipeline-test.js | 4 +++ node-tests/unit/utilities/pipeline-test.js | 14 -------- 4 files changed, 25 insertions(+), 32 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 9f7042b4..6c872f27 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -2,8 +2,10 @@ var Task = require('ember-cli/lib/models/task'); var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('ember-cli/lib/errors/silent'); -var Pipeline = require('../utilities/pipeline'); -var ConfigurationReader = require('../utilities/configuration-reader'); +var existsSync = require('fs').existsSync; +var path = require('path'); + +var Pipeline = require('../utilities/pipeline'); module.exports = Task.extend({ init: function() { @@ -19,24 +21,25 @@ module.exports = Task.extend({ this.project.addons.forEach(this._registerPipelineHooks.bind(this)); + var root = this.project.root; + this.deployEnvironment = this.deployEnvironment || 'production'; - this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; + this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; + this.configPath = 'config/environment.js'; - this._config = new ConfigurationReader({ - environment: this.deployEnvironment, - configFile: this.deployConfigPath, - project: this.project, - ui: this.ui - }).config; + if (!existsSync(this.deployConfigPath)) { + throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); + } - var buildEnv = this._config.get('build.buildEnv') || 'production'; + if (!existsSync(this.configPath)) { + throw new SilentError('App config does not exist at `' + this.configPath + '`'); + } - this._appConfig = new ConfigurationReader({ - environment: buildEnv, - configFile: 'config/environment.js', - project: this.project, - ui: this.ui - }).config; + this._deployConfig = require(path.join(this.project.root, this.deployConfigPath))(this.deployEnvironment); + + var buildEnv = (this._deployConfig.build && this._deployConfig.build.buildEnv) || 'production'; + + this._appConfig = require(path.join(this.project.root, this.configPath))(buildEnv); }, run: function(hooks) { @@ -44,7 +47,7 @@ module.exports = Task.extend({ var context = { ui: this.ui, project: this.project, - config: this._config, + config: this._deployConfig, appConfig: this._appConfig }; diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index cf32c68f..51ffa4f6 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -38,7 +38,7 @@ Pipeline.prototype._executeHook = function(hookName, context) { return hookFunctions.reduce(function(promise, fn) { return promise .then(function(context) { - return fn(_.cloneDeep(context)); + return fn(context); }) .then(function(result) { return _.merge(result, context); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index db55bf8f..b070d957 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -34,6 +34,7 @@ describe('PipelineTask', function() { it('registers addons with ember-cli-deploy-plugin keyword', function() { var project = { name: function() {return 'test-project';}, + root: process.cwd(), addons: [ { name: 'ember-cli-deploy-test-plugin', @@ -69,6 +70,7 @@ describe('PipelineTask', function() { it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { var project = { name: function() {return 'test-project';}, + root: process.cwd(), addons: [ { name: 'ember-cli-deploy-test-plugin', @@ -103,6 +105,7 @@ describe('PipelineTask', function() { it('does not register addons that don\'t implement the createDeployPlugin function', function() { var project = { name: function() {return 'test-project';}, + root: process.cwd(), addons: [ { name: 'ember-cli-deploy-test-plugin', @@ -139,6 +142,7 @@ describe('PipelineTask', function() { var project = { name: function() {return 'test-project';}, + root: process.cwd(), addons: [ ] }; diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index b2948ebb..6746dade 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -85,20 +85,6 @@ describe ('Pipeline', function() { }); }); - it('passes in a copy of the context to each hook', function() { - var subject = new Pipeline(['hook1']); - var context = {name: 'test-context'}; - - subject.register('hook1', function(context) { - context.name = 'changed'; - }); - - return expect(subject.execute(context)).to.be.fulfilled - .then(function() { - expect(context.name).to.equal('test-context'); - }); - }); - it('merges the return value (object) of each hook into the context', function() { var subject = new Pipeline(['hook1']); var finalContext = null; From 203cc568cad7630a809afaa0678e54287586a2bf Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 14:39:15 +0100 Subject: [PATCH 105/300] Had the order of objects around the wrong way when merging --- lib/utilities/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index 51ffa4f6..42d36e39 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -41,7 +41,7 @@ Pipeline.prototype._executeHook = function(hookName, context) { return fn(context); }) .then(function(result) { - return _.merge(result, context); + return _.merge(context, result); }) }, Promise.resolve(context)); } From 0a7dead5adffe127ce7a4b8b531dcc5bf12ef18d Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 15:09:15 +0100 Subject: [PATCH 106/300] Added rsvp to package.json to fix tests --- package.json | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/package.json b/package.json index 4f657ad5..25baa94a 100644 --- a/package.json +++ b/package.json @@ -31,14 +31,8 @@ "ember-cli-inject-live-reload": "^1.3.0", "github": "0.2.3", "mocha": "^2.0.1", - "sinon": "^1.12.1", - "debug": "2.1.1", - "ember-cli-qunit": "0.3.13", - "ember-cli-uglify": "^1.0.1", - "ember-data": "1.0.0-beta.18", - "ember-disable-proxy-controllers": "^1.0.0", - "ember-export-application-global": "^1.0.2", - "ember-disable-prototype-extensions": "^1.0.0" + "rsvp": "^3.0.18", + "sinon": "^1.12.1" }, "keywords": [ "ember-addon", From a8c3587e36af106c3d356dd0fe70598269fa2c97 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 15:48:58 +0100 Subject: [PATCH 107/300] Added some console logging when running each hook --- lib/tasks/pipeline.js | 4 ++- lib/utilities/pipeline.js | 30 +++++++++++++++++++--- node-tests/unit/utilities/pipeline-test.js | 10 ++++---- 3 files changed, 35 insertions(+), 9 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 6c872f27..42fa40d7 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -17,7 +17,9 @@ module.exports = Task.extend({ throw new SilentError('No ui passed to pipeline task'); } - this._pipeline = this.pipeline || new Pipeline(this.hooks); + this._pipeline = this.pipeline || new Pipeline(this.hooks, { + ui: this.ui + }); this.project.addons.forEach(this._registerPipelineHooks.bind(this)); diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index 42d36e39..04a42157 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -3,8 +3,16 @@ var Promise = require('rsvp').Promise; var _ = require('lodash-node'); -function Pipeline(hookNames) { +var chalk = require('chalk'); +var blue = chalk.blue; +var red = chalk.red; +var grey = chalk.grey; + +function Pipeline(hookNames, options) { hookNames = hookNames || []; + options = options || {}; + + this._ui = options.ui; this._pipelineHooks = hookNames.reduce(function(pipelineHooks, hookName) { pipelineHooks[hookName] = []; @@ -24,12 +32,28 @@ Pipeline.prototype.register = function(hookName, fn) { Pipeline.prototype.execute = function(context) { context = context || { }; + var ui = this._ui; var pipelineHooks = this._pipelineHooks; var hookNames = Object.keys(pipelineHooks); + ui.write(blue('Executing pipeline\n')); + return hookNames.reduce(function(promise, hookName) { - return promise.then(this._executeHook.bind(this, hookName)); - }.bind(this), Promise.resolve(context)); + return promise + .then(function(context) { + ui.write(blue(' Hook: ' + hookName + '\n')); + + return context; + }) + .then(this._executeHook.bind(this, hookName)); + }.bind(this), Promise.resolve(context)) + .then(function() { + ui.write(blue('Pipeline complete\n')); + }) + .catch(function(error) { + ui.write(red('Pipeline aborted\n')); + ui.write(grey(' Reason: ') + red(error) + '\n'); + }); }; Pipeline.prototype._executeHook = function(hookName, context) { diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index 6746dade..c8e974c0 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -38,7 +38,7 @@ describe ('Pipeline', function() { describe ('#execute', function() { it ('runs the registered functions', function() { - var subject = new Pipeline(['hook1', 'hook2']); + var subject = new Pipeline(['hook1', 'hook2'], {ui: {write: function() {}}}); var hooksRun = []; subject.register('hook1', function() { @@ -58,7 +58,7 @@ describe ('Pipeline', function() { }); it('passes the default context object when one isn\'t provided', function() { - var subject = new Pipeline(['hook1']); + var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var data = null; subject.register('hook1', function(context) { @@ -72,7 +72,7 @@ describe ('Pipeline', function() { }); it('passes the provided context object to hooks when provided', function() { - var subject = new Pipeline(['hook1']); + var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var data = null; subject.register('hook1', function(context) { @@ -86,7 +86,7 @@ describe ('Pipeline', function() { }); it('merges the return value (object) of each hook into the context', function() { - var subject = new Pipeline(['hook1']); + var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var finalContext = null; subject.register('hook1', function(context) { @@ -105,7 +105,7 @@ describe ('Pipeline', function() { }); it('merges the return value (promise) of each hook into the context', function() { - var subject = new Pipeline(['hook1']); + var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var finalContext = null; subject.register('hook1', function(context) { From dec33c12ef3b0b662ae147688714a95143bd0f25 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 22 Apr 2015 17:40:32 +0100 Subject: [PATCH 108/300] Now we load env vars from .env files --- .env.deploy.development | 1 + lib/tasks/pipeline.js | 11 +++++++++++ node-tests/unit/tasks/pipeline-test.js | 22 ++++++++++++++++++++++ package.json | 1 + 4 files changed, 35 insertions(+) create mode 100644 .env.deploy.development diff --git a/.env.deploy.development b/.env.deploy.development new file mode 100644 index 00000000..3c73ec85 --- /dev/null +++ b/.env.deploy.development @@ -0,0 +1 @@ +ENVTEST=SUCCESS diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 42fa40d7..6fef028e 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -4,6 +4,7 @@ var SilentError = require('ember-cli/lib/errors/silent'); var existsSync = require('fs').existsSync; var path = require('path'); +var dotenv = require('dotenv'); var Pipeline = require('../utilities/pipeline'); @@ -26,6 +27,16 @@ module.exports = Task.extend({ var root = this.project.root; this.deployEnvironment = this.deployEnvironment || 'production'; + + var dotEnvFilename = '.env.deploy.' + this.deployEnvironment; + var dotEnvFilePath = path.join(root, dotEnvFilename); + + if (existsSync(dotEnvFilePath)) { + dotenv.load({ + path: dotEnvFilename + }); + } + this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; this.configPath = 'config/environment.js'; diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index b070d957..78e9c43f 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -30,6 +30,28 @@ describe('PipelineTask', function() { expect(fn).to.throw('No ui passed to pipeline task'); }); + describe('setting environment variables from .env', function() { + it('sets the process.env vars if a .env file exists for deploy environment', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + + assert.isUndefined(process.env.ENVTEST); + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'] + }); + + assert.equal(process.env.ENVTEST, 'SUCCESS'); + }); + }); + describe('registering addons with the pipeline', function() { it('registers addons with ember-cli-deploy-plugin keyword', function() { var project = { diff --git a/package.json b/package.json index 25baa94a..c535b1ad 100644 --- a/package.json +++ b/package.json @@ -44,6 +44,7 @@ "chalk": "^0.5.1", "core-object": "0.0.2", "ember-cli-babel": "^5.0.0", + "dotenv": "^1.1.0", "glob": "4.4.2", "lodash-node": "^2.4.1", "mkdirp": "^0.5.0", From f2bf5993324c61792dab06796ee1694fe7aa29ca Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 23 Apr 2015 12:08:28 +0100 Subject: [PATCH 109/300] Added some console messaging of what is going on in the pipeline --- lib/tasks/pipeline.js | 7 ++++++- lib/utilities/pipeline.js | 23 +++++++++++++++++++---- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 6fef028e..b250c12f 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -82,7 +82,12 @@ module.exports = Task.extend({ var fn = pluginHooks[hookName]; if (typeof fn === 'function') { - this._pipeline.register(hookName, fn.bind(pluginHooks)); + var fnObject = { + name: pluginHooks.name, + fn: fn.bind(pluginHooks) + }; + + this._pipeline.register(hookName, fnObject); } } }.bind(this)); diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index 04a42157..fea2b1db 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -22,8 +22,18 @@ function Pipeline(hookNames, options) { } Pipeline.prototype.register = function(hookName, fn) { + var ui = this._ui; var pipelineHooks = this._pipelineHooks; + if (typeof fn === 'function') { + fn = { + name: 'anonymous function', + fn: fn + }; + } + + ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); + if (pipelineHooks[hookName]) { pipelineHooks[hookName].push(fn); } @@ -41,28 +51,33 @@ Pipeline.prototype.execute = function(context) { return hookNames.reduce(function(promise, hookName) { return promise .then(function(context) { - ui.write(blue(' Hook: ' + hookName + '\n')); + ui.write(blue('|\n')); + ui.write(blue('+- ' + hookName + '\n')); return context; }) .then(this._executeHook.bind(this, hookName)); }.bind(this), Promise.resolve(context)) .then(function() { + ui.write(blue('|\n')); ui.write(blue('Pipeline complete\n')); }) .catch(function(error) { + ui.write(blue('|\n')); ui.write(red('Pipeline aborted\n')); - ui.write(grey(' Reason: ') + red(error) + '\n'); }); }; Pipeline.prototype._executeHook = function(hookName, context) { + var ui = this._ui; var hookFunctions = this._pipelineHooks[hookName]; - return hookFunctions.reduce(function(promise, fn) { + return hookFunctions.reduce(function(promise, fnObject) { return promise .then(function(context) { - return fn(context); + ui.write(blue('| |\n')); + ui.write(blue('| +- ' + fnObject.name + '\n')); + return fnObject.fn(context); }) .then(function(result) { return _.merge(context, result); From 598886948e35436dd68ecd9799b340c7a7fb01d7 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 23 Apr 2015 12:35:30 +0100 Subject: [PATCH 110/300] Fixed tests --- node-tests/unit/tasks/pipeline-test.js | 9 ++++++--- node-tests/unit/utilities/pipeline-test.js | 11 ++++++++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 78e9c43f..8adddc60 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -7,7 +7,7 @@ describe('PipelineTask', function() { var mockProject = {addons: []}; var mockConfig = {}; var mockAppConfig = {}; - var mockUi = {}; + var mockUi = { write: function() {} }; describe('creating a new instance', function() { it ('raises an error if project is not provided', function() { @@ -67,6 +67,7 @@ describe('PipelineTask', function() { }, createDeployPlugin: function() { return { + name: 'test-plugin', willDeploy: function() {}, upload: function() {} }; @@ -85,8 +86,10 @@ describe('PipelineTask', function() { var registeredHooks = task._pipeline._pipelineHooks; - expect(registeredHooks.willDeploy[0]).to.be.a('function'); - expect(registeredHooks.upload[0]).to.be.a('function'); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); }); it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index c8e974c0..3ddfa62a 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -16,17 +16,22 @@ describe ('Pipeline', function() { describe ('#register', function() { it ('registers functions for defined hooks', function() { - var subject = new Pipeline(['willDeploy']); + var subject = new Pipeline(['willDeploy'], { + ui: {write: function() {}} + }); var fn = function() {}; subject.register('willDeploy', fn); expect(subject._pipelineHooks.willDeploy.length).to.eq(1) - expect(subject._pipelineHooks.willDeploy[0]).to.eql(fn); + expect(subject._pipelineHooks.willDeploy[0].name).to.eq('anonymous function'); + expect(subject._pipelineHooks.willDeploy[0].fn).to.eql(fn); }); it ('doesn\'t register functions for hooks not defined', function() { - var subject = new Pipeline(['willDeploy']); + var subject = new Pipeline(['willDeploy'], { + ui: {write: function() {}} + }); var fn = function() {}; subject.register('build', fn); From ad030ea8572f3be43dc59bd71ac7247ce4020656 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 27 Apr 2015 10:04:27 +0100 Subject: [PATCH 111/300] No need to exclude name as we're checking for type function --- lib/tasks/pipeline.js | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index b250c12f..03b5023e 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -78,17 +78,15 @@ module.exports = Task.extend({ var pluginHooks = addon.createDeployPlugin({name: name}); Object.keys(pluginHooks).forEach(function(hookName) { - if (hookName !== 'name') { - var fn = pluginHooks[hookName]; + var fn = pluginHooks[hookName]; - if (typeof fn === 'function') { - var fnObject = { - name: pluginHooks.name, - fn: fn.bind(pluginHooks) - }; + if (typeof fn === 'function') { + var fnObject = { + name: pluginHooks.name, + fn: fn.bind(pluginHooks) + }; - this._pipeline.register(hookName, fnObject); - } + this._pipeline.register(hookName, fnObject); } }.bind(this)); } From 60ffc5f511fbf986b1891ae446b99873336f1f3f Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 28 Apr 2015 17:34:47 +0100 Subject: [PATCH 112/300] Now we can modify the broccoli-asset-rev options dynamically via config It's a little bit hacky for the first cut but the ember deploy command now sets the current deploy environment as an env var which allows us to, in the `included` hook, modify the `app.options.fingerprint` options allowing a user to set things like the prepend url dynamically based on the env they want to deploy to. This means that we no longer need the user to specify the fingerprint settings in the Brocfile and it also means that they can prepend a differnt url based on deploy env --- index.js | 27 +++++++++++++++++++++++++++ lib/commands/deploy.js | 2 ++ package.json | 5 +++++ 3 files changed, 34 insertions(+) diff --git a/index.js b/index.js index 6da88834..51127690 100644 --- a/index.js +++ b/index.js @@ -35,4 +35,31 @@ Deploy.prototype.blueprintsPath = function() { return path.join(__dirname, 'blueprints'); }; +Deploy.prototype.included = function(app) { + var buildEnv = this._deployEnvSetByDeployCommand(); + var root = app.project.root; + var configPath = path.join(root, 'config', 'deploy'); + var config; + var fingerprint; + + if (buildEnv) { + config = require(configPath)(buildEnv); + + if (config.fingerprint === false) { + app.options.fingerprint = {enabled: false}; + } else { + fingerprint = config.fingerprint || {}; + app.options.fingerprint = app.options.fingerprint || {}; + + for (var option in fingerprint) { + app.options.fingerprint[option] = fingerprint[option]; + } + } + } +}; + +Deploy.prototype._deployEnvSetByDeployCommand = function() { + return process.env.DEPLOY_ENVIRONMENT; +} + module.exports = Deploy; diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index eab2ca3d..1855a880 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -9,6 +9,8 @@ module.exports = { ], run: function(commandOptions, rawArgs) { + process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; + var PipelineTask = require('../tasks/pipeline'); var pipeline = new PipelineTask({ project: this.project, diff --git a/package.json b/package.json index c535b1ad..1f6813af 100644 --- a/package.json +++ b/package.json @@ -38,6 +38,11 @@ "ember-addon", "ember-cli-deploy" ], + "ember-addon": { + "configPath": "tests/dummy/config", + "defaultBlueprint": "deploy-config", + "before": "broccoli-asset-rev" + }, "dependencies": { "broccoli": "^0.13.2", "broccoli-gzip": "^0.2.0", From 931304796f4704453a09178f844d9ce37fc3c406 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 28 Apr 2015 19:22:15 +0100 Subject: [PATCH 113/300] Fixed rsvp dependency problem --- lib/utilities/pipeline.js | 2 +- package.json | 1 - 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index fea2b1db..ffca4ade 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -1,6 +1,6 @@ 'use strict'; -var Promise = require('rsvp').Promise; +var Promise = require('ember-cli/lib/ext/promise'); var _ = require('lodash-node'); var chalk = require('chalk'); diff --git a/package.json b/package.json index 1f6813af..84f5a6e9 100644 --- a/package.json +++ b/package.json @@ -31,7 +31,6 @@ "ember-cli-inject-live-reload": "^1.3.0", "github": "0.2.3", "mocha": "^2.0.1", - "rsvp": "^3.0.18", "sinon": "^1.12.1" }, "keywords": [ From ab6cf684e8d15c4abeaa5755d9bc092e2c579606 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 29 Apr 2015 09:41:44 +0100 Subject: [PATCH 114/300] Now we return an exit code of 1 to tell CI that the process failed --- lib/utilities/pipeline.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index ffca4ade..186ead6a 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -65,6 +65,7 @@ Pipeline.prototype.execute = function(context) { .catch(function(error) { ui.write(blue('|\n')); ui.write(red('Pipeline aborted\n')); + return Promise.reject(); }); }; From f915601b0de533beb1482eb020762a4c32fb4197 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 29 Apr 2015 11:52:29 +0100 Subject: [PATCH 115/300] Fixed bug where merging was overwriting the array elements of distFiles --- lib/utilities/pipeline.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index 186ead6a..c6748f48 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -81,7 +81,11 @@ Pipeline.prototype._executeHook = function(hookName, context) { return fnObject.fn(context); }) .then(function(result) { - return _.merge(context, result); + return _.merge(context, result, function(a, b) { + if (_.isArray(a)) { + return a.concat(b); + } + }); }) }, Promise.resolve(context)); } From 83266735198c4d00af8a5241554b82cce034319b Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 28 May 2015 12:16:32 -0400 Subject: [PATCH 116/300] Make ConfigurationReader promise aware - lets you can return a promise from the function exported in your deploy config file, in order to use async operations to build your configuration --- lib/tasks/activate.js | 28 +++--- lib/tasks/assets.js | 73 +++++++------- lib/tasks/deploy-index.js | 45 +++++---- lib/tasks/list.js | 28 +++--- lib/utilities/configuration-reader.js | 72 +++++++------- node-tests/unit/tasks/assets-test.js | 11 +-- .../utilities/configuration-reader-test.js | 98 ++++++++++--------- 7 files changed, 182 insertions(+), 173 deletions(-) diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js index e1bdea8f..b0bee22a 100644 --- a/lib/tasks/activate.js +++ b/lib/tasks/activate.js @@ -10,25 +10,27 @@ var green = chalk.green; module.exports = Task.extend({ run: function(options) { - var ui = this.ui; + var self = this; + var ui = this.ui; var revision = options.revision; - var config = new ConfigurationReader({ + return new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, project: this.project, ui: ui - }).config; - var adapterType = config.get('store.type'); - var Adapter = new AdapterRegistry({ project: this.project }) - .lookup('index', adapterType); + }).read().then(function(config){ + var adapterType = config.get('store.type'); + var Adapter = new AdapterRegistry({ project: self.project }) + .lookup('index', adapterType); - var deploy = new Adapter({ - config: config.get('store'), - manifest: config.get('manifestPrefix'), - manifestSize: config.get('store.manifestSize'), - ui: ui - }); + var deploy = new Adapter({ + config: config.get('store'), + manifest: self.project.name(), + manifestSize: config.get('store.manifestSize'), + ui: ui + }); - return deploy.activate(revision); + return deploy.activate(revision); + }); } }); diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js index 523251e5..2f407f33 100644 --- a/lib/tasks/assets.js +++ b/lib/tasks/assets.js @@ -5,59 +5,60 @@ var fs = require('fs'); var path = require('path'); var rimraf = Promise.denodeify(require('rimraf')); var glob = Promise.denodeify(require('glob')); -var ncp = Promise.denodeify(require('ncp')); var mkdirp = require('mkdirp'); module.exports = Task.extend({ run: function(options) { var broccoli = require('broccoli'); - var config = new ConfigurationReader({ - environment: options.environment, - configFile: options.deployConfigFile, - project: this.project, - ui: this.ui - }).config; + var self = this; + return this.readConfiguration(options.environment, options.deployConfigFile).then(function(config){ + var fileTreeOrPath; + if (config.get('assets.gzip') === false) { + fileTreeOrPath = 'dist'; + } else { + var gzipFiles = require('broccoli-gzip'); - var fileTreeOrPath; - if (config.get('assets.gzip') === false) { - fileTreeOrPath = config.get('buildPath'); - } else { - var gzipFiles = require('broccoli-gzip'); - - fileTreeOrPath = gzipFiles(config.get('buildPath'), { - extensions: config.get('assets.gzipExtensions'), - appendSuffix: false - }); - } + fileTreeOrPath = gzipFiles('dist', { + extensions: config.get('assets.gzipExtensions'), + appendSuffix: false + }); + } - var builder = new broccoli.Builder(fileTreeOrPath); + var builder = new broccoli.Builder(fileTreeOrPath); - return builder.build() - .then(this.processBuildResult.bind(this, config)) - .then(this.uploadAssets.bind(this, options.environment, options.deployConfigFile)) - .then(function() { - builder.cleanup(); - }); + return builder.build() + .then(self.processBuildResult.bind(self)) + .then(self.uploadAssets.bind(self, options.environment, options.deployConfigFile)) + .then(function() { + builder.cleanup(); + }); + }); }, - uploadAssets: function(environment, configFile) { - var config = new ConfigurationReader({ + readConfiguration: function(environment, configFile){ + var self = this; + return new ConfigurationReader({ environment: environment, configFile: configFile, project: this.project, ui: this.ui - }).config; + }).read() + }, - var AssetsUploader = this.AssetsUploader; - var assetsUploader = new AssetsUploader({ - ui: this.ui, - config: config._materialize(), - type: config.get('assets.type'), - project: this.project - }); + uploadAssets: function(environment, configFile) { + var self = this; + return this.readConfiguration(environment, configFile).then(function(config){ + var AssetsUploader = this.AssetsUploader; + var assetsUploader = new AssetsUploader({ + ui: self.ui, + config: config._materialize(), + type: config.get('assets.type'), + project: self.project + }); - return assetsUploader.upload(); + return assetsUploader.upload(); + }); }, processBuildResult: function(config, results) { diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js index 042700c1..1af9d215 100644 --- a/lib/tasks/deploy-index.js +++ b/lib/tasks/deploy-index.js @@ -9,36 +9,43 @@ var readFile = Promise.denodeify(fs.readFile); module.exports = Task.extend({ run: function(options) { + var self = this; var ui = this.ui; - var config = new ConfigurationReader({ + return new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, project: this.project, ui: ui - }).config; + }).read().then(function(config){ + var adapterType = config.get('store.type'); + var taggingAdapterType = config.get('tagging'); + var manifest = config.get('manifestPrefix'); - var adapterType = config.get('store.type'); - var taggingAdapterType = config.get('tagging'); - var manifest = config.get('manifestPrefix'); + var adapterRegistry = new AdapterRegistry({ project: self.project }); - var adapterRegistry = new AdapterRegistry({ project: this.project }); + var Adapter = adapterRegistry + .lookup('index', adapterType); - var Adapter = adapterRegistry - .lookup('index', adapterType); + var TaggingAdapter = adapterRegistry + .lookup('tagging', taggingAdapterType) - var TaggingAdapter = adapterRegistry - .lookup('tagging', taggingAdapterType) + var taggingAdapter = new TaggingAdapter({ + manifest: manifest + }); - var taggingAdapter = new TaggingAdapter({ - manifest: manifest - }); + var deploy = new Adapter({ + config: config.get('store'), + manifest: manifest, + manifestSize: config.get('store.manifestSize'), + taggingAdapter: taggingAdapter, + ui: ui + }); - var deploy = new Adapter({ - config: config.get('store'), - manifest: manifest, - manifestSize: config.get('store.manifestSize'), - taggingAdapter: taggingAdapter, - ui: ui + return readFile('dist/index.html') + .then(function(fileContent) { + ui.writeLine(chalk.blue('\nTrying to upload `dist/index.html`...\n')); + return deploy.upload(fileContent); + }); }); var indexFiles = config.get('indexFiles'); diff --git a/lib/tasks/list.js b/lib/tasks/list.js index bf41853a..1f357a88 100644 --- a/lib/tasks/list.js +++ b/lib/tasks/list.js @@ -5,24 +5,26 @@ var AdapterRegistry = require('../utilities/adapter-registry'); module.exports = Task.extend({ run: function(options) { - var ui = this.ui; - var config = new ConfigurationReader({ + var ui = this.ui; + var project = this.project; + return new ConfigurationReader({ environment: options.environment, configFile: options.deployConfigFile, project: this.project, ui: ui - }).config; - var adapterType = config.get('store.type'); - var Adapter = new AdapterRegistry({ project: this.project }) - .lookup('index', adapterType); + }).read().then(function(config){ + var adapterType = config.get('store.type'); + var Adapter = new AdapterRegistry({ project: project }) + .lookup('index', adapterType); - var deploy = new Adapter({ - config: config.get('store'), - manifest: config.get('manifestPrefix'), - manifestSize: config.get('store.manifestSize'), - ui: ui - }); + var deploy = new Adapter({ + config: config.get('store'), + manifest: config.get('manifestPrefix'), + manifestSize: config.get('store.manifestSize'), + ui: ui + }); - return deploy.list(); + return deploy.list(); + }); } }); diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js index 8eeab4be..eb66c9f3 100644 --- a/lib/utilities/configuration-reader.js +++ b/lib/utilities/configuration-reader.js @@ -2,43 +2,39 @@ var path = require('path'); var deprecate = require('./deprecate'); var Config = require('../models/config'); var SilentError = require('silent-error'); - -function ConfigurationReader(options) { - var root = process.cwd(); - var defaultConfigPath = path.join('config', 'deploy.js'); - var environmentConfig; - - this._options = options || {}; - this._environment = this._options.environment || 'development'; - this._deployConfig = this._options.configFile || defaultConfigPath; - - var ui = options.ui; - var project = options.project; - - deprecate( - "Using a .json file for deployment configuration is deprecated. Please use a .js file instead", - /\.json$/.test(this._options.configFile), - ui - ); - - try { - var pathToConfig = path.join(root, this._deployConfig); - this._config = require(pathToConfig)(this._environment); - } catch(e) { - ui.writeError(e); - throw new SilentError('Cannot load configuration file \'' + pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ defaultConfigPath + '\''); - } - - if (!Object.keys(this._config).length) { - throw new SilentError('You are using the `' + this._environment + '` environment but have not specified any configuration.' + - '\n\nPlease add a `' + this._environment + '` section to your `config/deploy.js` file.' + - '\n\nFor more information, go to: `https://github.com/ember-cli/ember-cli-deploy#config-file`'); +var Promise = require('ember-cli/lib/ext/promise'); +var CoreObject = require('core-object'); + +module.exports = CoreObject.extend({ + init: function() { + var root = process.cwd(); + this.defaultConfigPath = path.join('config', 'deploy.js'); + var environmentConfig; + this.environment = this.environment || 'development'; + this.configFile = this.configFile || this.defaultConfigPath; + this.pathToConfig = path.join(root, this.configFile); + }, + read: function(){ + var self = this; + var configResult; + try { + configResult = require(this.pathToConfig)(this.environment); + } catch(e) { + this.ui.writeError(e); + return Promise.reject(new Error('Cannot load configuration file \'' + this.pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ self.defaultConfigPath + '\'')); + } + + return Promise.resolve(configResult).then(function(config){ + if (!Object.keys(config).length) { + throw new SilentError('You are using the `' + self.environment + '` environment but have not specified any configuration.' + + '\n\nPlease add a `' + self.environment + '` section to your `config/deploy.js` file.' + + '\n\nFor more information, go to: `https://github.com/ember-cli/ember-cli-deploy#config-file`'); + } + return new Config({ + project: self.project, + rawConfig: config + }); + }); } +}); - this.config = new Config({ - project: project, - rawConfig: this._config - }); -} - -module.exports = ConfigurationReader; diff --git a/node-tests/unit/tasks/assets-test.js b/node-tests/unit/tasks/assets-test.js index 60cfc7b9..1d0813d1 100644 --- a/node-tests/unit/tasks/assets-test.js +++ b/node-tests/unit/tasks/assets-test.js @@ -25,17 +25,16 @@ describe('AssetsTask', function() { }); describe('#uploadAssets', function(){ it('receives a POJO config object (which is a bad idea and we should change this API)', function() { - var root = process.cwd(); var task = new AssetsTask({ ui: ui, AssetsUploader: MockAssetsUploader, project: project }); - var configFile = require(path.join(root, './config/deploy.js')); - task.uploadAssets('development', 'config/deploy.js'); - expect(mockAssetsUploaderConfig.assets).to.be.exist; - expect(mockAssetsUploaderConfig.assets.bucket).to.equal(''); - expect(mockAssetsUploaderConfig.assets.type).to.equal('s3'); + task.uploadAssets('development', 'config/deploy.js').then(function(){ + expect(mockAssetsUploaderConfig.assets).to.be.exist; + expect(mockAssetsUploaderConfig.assets.bucket).to.equal(''); + expect(mockAssetsUploaderConfig.assets.type).to.equal('s3'); + }); }); }); describe('#deleteExcluded', function () { diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 4d5b8862..7c6c096f 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -2,6 +2,7 @@ var ConfigurationReader = require('../../../lib/utilities/configuration-reader') var expect = require('chai').expect; var path = require('path'); var MockUI = require('ember-cli/tests/helpers/mock-ui'); +var Promise = require('ember-cli/lib/ext/promise'); var EOL = require('os').EOL; var chalk = require('chalk'); @@ -14,23 +15,23 @@ describe('ConfigurationReader', function() { }); describe('environment settings', function() { - it('knows about its passed _environment', function() { - var config = new ConfigurationReader({ + it('knows about its passed environment', function() { + var reader = new ConfigurationReader({ environment: 'staging', ui: ui, project: project }); - expect(config._environment).to.equal('staging'); + expect(reader.environment).to.equal('staging'); }); it('`development` is default when no environment is passed', function() { - var config = new ConfigurationReader({ + var reader = new ConfigurationReader({ ui: ui, project: project }); - expect(config._environment).to.equal('development'); + expect(reader.environment).to.equal('development'); }); }); @@ -41,15 +42,15 @@ describe('ConfigurationReader', function() { var fixtureConfigPath = path.join(root, configPath); var expectedConfig = require(fixtureConfigPath); - var fn = function() { - new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }); - } - - expect(fn).to.throw('Cannot load configuration file'); + return new ConfigurationReader({ + configFile: configPath, + ui: ui, + project: project + }).read().then(function(){ + expect(false).to.equal(true); + }, function(err){ + expect(err.message).to.match(/Cannot load configuration file/); + }); }); it('reads a passed js deploy-config-file if one is passed', function() { @@ -58,53 +59,54 @@ describe('ConfigurationReader', function() { var fixtureConfigPath = path.join(root, configPath); var expectedConfig = require(fixtureConfigPath)('development'); - var config = new ConfigurationReader({ + return new ConfigurationReader({ configFile: configPath, ui: ui, project: project + }).read().then(function(config){ + expect(config._config).to.eql(expectedConfig); }); - - expect(config._config).to.eql(expectedConfig); }); it('uses `./config/deploy.js` as default when no config is passed', function() { var root = process.cwd(); var expectedConfig = require(path.join(root, './config/deploy.js'))('development'); - var config = new ConfigurationReader({ + return new ConfigurationReader({ ui: ui, project: project + }).read().then(function(config){ + expect(config._config).to.eql(expectedConfig) }); - expect(config._config).to.eql(expectedConfig) }); it('raises an error in the case of a passed deploy-config-file that doesn\'t exist', function() { var configPath = './node-tests/fixtures/config/does-not-exist.js'; var root = process.cwd(); - var fn = function() { - new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }); - }; - - expect(fn).to.throw('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); + return new ConfigurationReader({ + configFile: configPath, + ui: ui, + project: project + }).read().then(function(){ + expect(false).to.equal(true); + }, function(err){ + expect(err.message).to.equal('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); + }); }); it('raises an error if a config doesn\'t exist for the current environment', function() { var configPath = './node-tests/fixtures/config/deploy.js'; - var fn = function() { - new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project, - environment: 'non-existent-env' - }); - }; - - expect(fn).to.throw(/You are using the `non-existent-env` environment/); + return new ConfigurationReader({ + configFile: configPath, + ui: ui, + project: project, + environment: 'non-existent-env' + }).read().then(function(){ + expect(false).to.equal(true); + }, function(err){ + expect(err.message).to.match(/You are using the `non-existent-env` environment/); + }); }); }); @@ -114,16 +116,16 @@ describe('ConfigurationReader', function() { var root = process.cwd(); var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - ENVs.forEach(function(env) { + return Promise.map(ENVs, function(env) { var expected = cfgFile(env).store; - var config = new ConfigurationReader({ + return new ConfigurationReader({ environment: env, ui: ui, project: project - }).config; - - expect(config.get('store')).to.deep.equal(expected); + }).read().then(function(config){ + expect(config.get('store')).to.deep.equal(expected); + }); }); }); }); @@ -134,16 +136,16 @@ describe('ConfigurationReader', function() { var root = process.cwd(); var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - ENVs.forEach(function(env) { + return Promise.map(ENVs, function(env) { var expected = cfgFile(env).assets; - var config = new ConfigurationReader({ + return new ConfigurationReader({ environment: env, ui: ui, project: project - }).config; - - expect(config.get('assets')).to.deep.equal(expected); + }).read().then(function(config){ + expect(config.get('assets')).to.deep.equal(expected); + }); }); }); }); From 6ac2e239b0c52dd594751f1ec5316bdcb6fd8426 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 28 May 2015 13:53:09 -0400 Subject: [PATCH 117/300] Promise-aware config reading and support for `plugins` configuration list - Allow the deploy config function to return a promise - If the deploy config includes a `plugins` array, it will be used to filter addons registered with the pipeline --- lib/tasks/pipeline.js | 93 ++++++++++++------- .../config/deploy-for-addons-config-test.js | 5 + node-tests/unit/tasks/pipeline-test.js | 72 ++++++++++++-- 3 files changed, 128 insertions(+), 42 deletions(-) create mode 100644 node-tests/fixtures/config/deploy-for-addons-config-test.js diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 03b5023e..60e847a2 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -22,8 +22,6 @@ module.exports = Task.extend({ ui: this.ui }); - this.project.addons.forEach(this._registerPipelineHooks.bind(this)); - var root = this.project.root; this.deployEnvironment = this.deployEnvironment || 'production'; @@ -38,58 +36,83 @@ module.exports = Task.extend({ } this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; - this.configPath = 'config/environment.js'; + this.appConfigPath = 'config/environment.js'; if (!existsSync(this.deployConfigPath)) { throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); } - if (!existsSync(this.configPath)) { - throw new SilentError('App config does not exist at `' + this.configPath + '`'); + if (!existsSync(this.appConfigPath)) { + throw new SilentError('App config does not exist at `' + this.appConfigPath + '`'); } + }, - this._deployConfig = require(path.join(this.project.root, this.deployConfigPath))(this.deployEnvironment); - - var buildEnv = (this._deployConfig.build && this._deployConfig.build.buildEnv) || 'production'; - - this._appConfig = require(path.join(this.project.root, this.configPath))(buildEnv); + setup: function(){ + var self = this; + return this._readConfig().then(function(configs){ + self.project.addons.forEach(function(addon){ + self._registerPipelineHooks(addon, configs.deployConfig.plugins); + }); + return configs; + }); }, run: function(hooks) { var pipeline = this._pipeline; - var context = { - ui: this.ui, - project: this.project, - config: this._deployConfig, - appConfig: this._appConfig - }; - - return pipeline.execute({ - deployment: context + var ui = this.ui; + var project = this.project; + var self = this; + return this.setup().then(function(configs){ + var context = { + ui: ui, + project: project, + config: configs.deployConfig, + appConfig: configs.appConfig + }; + return pipeline.execute({ + deployment: context + }); }); }, - _registerPipelineHooks: function(addon) { + _readConfig: function() { + var project = this.project; + var appConfigPath = this.appConfigPath; + var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); + return Promise.resolve(deployConfigFn(this.deployEnvironment)).then(function(deployConfig){ + var buildEnv = (deployConfig.build && deployConfig.build.buildEnv) || 'production'; + var appConfigFn = require(path.join(project.root, appConfigPath)); + return { + deployConfig: deployConfig, + appConfig: appConfigFn(buildEnv) + }; + }); + }, + + _registerPipelineHooks: function(addon, configuredPluginList) { var isValidDeployPlugin = this._isValidDeployPlugin(addon); + if (!isValidDeployPlugin) { return; } - if (isValidDeployPlugin) { - var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; - var name = addon.name.match(pluginNameRegex)[2]; - var pluginHooks = addon.createDeployPlugin({name: name}); + var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; + var name = addon.name.match(pluginNameRegex)[2]; + if (configuredPluginList && configuredPluginList.indexOf(name) === -1) { + return; + } - Object.keys(pluginHooks).forEach(function(hookName) { - var fn = pluginHooks[hookName]; + var pluginHooks = addon.createDeployPlugin({name: name}); - if (typeof fn === 'function') { - var fnObject = { - name: pluginHooks.name, - fn: fn.bind(pluginHooks) - }; + Object.keys(pluginHooks).forEach(function(hookName) { + var fn = pluginHooks[hookName]; - this._pipeline.register(hookName, fnObject); - } - }.bind(this)); - } + if (typeof fn === 'function') { + var fnObject = { + name: pluginHooks.name, + fn: fn.bind(pluginHooks) + }; + + this._pipeline.register(hookName, fnObject); + } + }.bind(this)); }, _isValidDeployPlugin: function(addon) { diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test.js b/node-tests/fixtures/config/deploy-for-addons-config-test.js new file mode 100644 index 00000000..35c807c1 --- /dev/null +++ b/node-tests/fixtures/config/deploy-for-addons-config-test.js @@ -0,0 +1,5 @@ +module.exports = function(environment) { + return { + plugins: ['foo-plugin'] + }; +} diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 8adddc60..c8a7b70e 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -9,7 +9,7 @@ describe('PipelineTask', function() { var mockAppConfig = {}; var mockUi = { write: function() {} }; - describe('creating a new instance', function() { + describe('creating and setting up a new instance', function() { it ('raises an error if project is not provided', function() { var fn = function() { new PipelineTask({}); @@ -83,13 +83,14 @@ describe('PipelineTask', function() { deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); + return task.setup().then(function(){ + var registeredHooks = task._pipeline._pipelineHooks; - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload[0].name).to.eq('test-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); + }); }); it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { @@ -158,6 +159,63 @@ describe('PipelineTask', function() { expect(registeredHooks.willDeploy[0]).to.be.undefined; }); + + it('registers configured addons only, if addons configuration is present', function () { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'foo-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + }, + { + name: 'ember-cli-deploy-bar-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'bar-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test.js', + hooks: ['willDeploy', 'upload'] + }); + return task.setup().then(function(){ + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy.length).to.equal(1); + expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload.length).to.equal(1); + expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); + }); + }); }); }); From 4e29eedefef337fbefd263193d6addfc53fb3579 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 7 Jun 2015 19:59:15 +0200 Subject: [PATCH 118/300] Add didFail-hook Some plugins need the ability to react to failures in the deployment pipeline to for example notify some webservice of the failed deployment. It is now possible to add a `didFail`-hook to a plugin that gets executed as soon as a deployment-hook's execution promise rejects. * add didFail-hook to pipeline * 'deanonymize' functions in pipeline utility class --- lib/utilities/pipeline.js | 103 +++++++++++++-------- node-tests/unit/utilities/pipeline-test.js | 33 ++++++- 2 files changed, 96 insertions(+), 40 deletions(-) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index c6748f48..d85818e7 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -18,7 +18,7 @@ function Pipeline(hookNames, options) { pipelineHooks[hookName] = []; return pipelineHooks; - }, {}); + }, { didFail: [] }); } Pipeline.prototype.register = function(hookName, fn) { @@ -44,50 +44,77 @@ Pipeline.prototype.execute = function(context) { var ui = this._ui; var pipelineHooks = this._pipelineHooks; - var hookNames = Object.keys(pipelineHooks); - + var hookNames = this._deploymentHooks(Object.keys(pipelineHooks)); ui.write(blue('Executing pipeline\n')); - return hookNames.reduce(function(promise, hookName) { - return promise - .then(function(context) { - ui.write(blue('|\n')); - ui.write(blue('+- ' + hookName + '\n')); - - return context; - }) - .then(this._executeHook.bind(this, hookName)); - }.bind(this), Promise.resolve(context)) - .then(function() { - ui.write(blue('|\n')); - ui.write(blue('Pipeline complete\n')); - }) - .catch(function(error) { - ui.write(blue('|\n')); - ui.write(red('Pipeline aborted\n')); - return Promise.reject(); - }); + return hookNames.reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) + .then(this._notifyPipelineCompletion.bind(this, ui)) + .catch(this._handleDeploymentFailure.bind(this, ui, context)) + .catch(this._abortPipelineExecution.bind(this, ui)); +}; + +Pipeline.prototype._addHookExecutionPromiseToPipelinePromiseChain = function(ui, promise, hookName) { + return promise + .then(this._notifyPipelineHookExecution.bind(this, ui, hookName)) + .then(this._executeHook.bind(this, hookName)); +}; + +Pipeline.prototype._deploymentHooks = function(hooks) { + return hooks.filter(function(hook) { + return hook !== 'didFail'; + }); +}; + +Pipeline.prototype._handleDeploymentFailure = function(ui, context, error) { + ui.write(red('|\n')); + ui.write(red('+- didFail\n')); + return this._executeHook.bind(this, 'didFail')(context) + .then(Promise.reject.bind(this, error)); +}; + +Pipeline.prototype._abortPipelineExecution = function(ui, error) { + ui.write(blue('|\n')); + ui.write(red('Pipeline aborted\n')); + return Promise.reject(); +}; + +Pipeline.prototype._notifyPipelineCompletion = function(ui) { + ui.write(blue('|\n')); + ui.write(blue('Pipeline complete\n')); +}; + +Pipeline.prototype._notifyPipelineHookExecution = function(ui, hookName, context) { + ui.write(blue('|\n')); + ui.write(blue('+- ' + hookName + '\n')); + + return context; }; Pipeline.prototype._executeHook = function(hookName, context) { var ui = this._ui; var hookFunctions = this._pipelineHooks[hookName]; - return hookFunctions.reduce(function(promise, fnObject) { - return promise - .then(function(context) { - ui.write(blue('| |\n')); - ui.write(blue('| +- ' + fnObject.name + '\n')); - return fnObject.fn(context); - }) - .then(function(result) { - return _.merge(context, result, function(a, b) { - if (_.isArray(a)) { - return a.concat(b); - } - }); - }) - }, Promise.resolve(context)); -} + return hookFunctions.reduce(this._addPluginHookExecutionPromiseToHookPromiseChain.bind(this, ui, context), Promise.resolve(context)); +}; + +Pipeline.prototype._addPluginHookExecutionPromiseToHookPromiseChain = function(ui, context, promise, fnObject) { + return promise + .then(this._notifyPipelinePluginHookExecution.bind(this, ui, fnObject)) + .then(this._mergePluginHookResultIntoContext.bind(this, context)); +}; + +Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, context) { + ui.write(blue('| |\n')); + ui.write(blue('| +- ' + fnObject.name + '\n')); + return fnObject.fn(context); +}; + +Pipeline.prototype._mergePluginHookResultIntoContext = function(context,result) { + return _.merge(context, result, function(a, b) { + if (_.isArray(a)) { + return a.concat(b); + } + }); +}; module.exports = Pipeline; diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index 3ddfa62a..028184e6 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -5,12 +5,13 @@ var expect = require('../../helpers/expect'); describe ('Pipeline', function() { describe ('initialization', function() { - it ('initializes the given list of hooks', function() { + it ('initializes the given list of hooks plus the `didFail`-hook', function() { var subject = new Pipeline(['willDeploy', 'didDeploy']); - expect(Object.keys(subject._pipelineHooks).length).to.eq(2); + expect(Object.keys(subject._pipelineHooks).length).to.eq(3); expect(subject._pipelineHooks.willDeploy).to.eql([]); expect(subject._pipelineHooks.didDeploy).to.eql([]); + expect(subject._pipelineHooks.didFail).to.eql([]); }); }); @@ -62,6 +63,34 @@ describe ('Pipeline', function() { }); }); + it('executes the `didFail`-hook as soon as one of the deployment hooks rejects', function() { + var subject = new Pipeline(['hook1', 'hook2'], {ui: {write: function() {}}}); + var hooksRun = []; + + subject.register('hook1', function() { + hooksRun.push('hook1'); + }); + + subject.register('hook2', function() { + return Promise.reject(); + }); + + subject.register('hook3', function() { + hooksRun.push('3'); + }); + + subject.register('didFail', function() { + hooksRun.push('didFail'); + }); + + return expect(subject.execute()).to.be.rejected + .then(function() { + expect(hooksRun.length).to.eq(2); + expect(hooksRun[0]).to.eq('hook1'); + expect(hooksRun[1]).to.eq('didFail'); + }); + }); + it('passes the default context object when one isn\'t provided', function() { var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var data = null; From 3c730631a2755101e0b48a78a53e4b5694e853b8 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 16 Jun 2015 23:20:05 +0100 Subject: [PATCH 119/300] Add hook --- lib/commands/deploy.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 1855a880..bfed5146 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -18,6 +18,7 @@ module.exports = { deployEnvironment: commandOptions.environment, deployConfigPath: commandOptions.deployConfigFile, hooks: [ + 'configure', 'willDeploy', 'willBuild', 'build', 'didBuild', 'willUpload', 'upload', 'didUpload', From bc4f3bf6e7695bc55ba50b82ebc49dcd3e302ea8 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 22 Jun 2015 18:21:06 +0100 Subject: [PATCH 120/300] Refactored 'pluginHooks' var name to be 'deployPlugin' --- lib/tasks/pipeline.js | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 60e847a2..4fbbf7a4 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -99,18 +99,19 @@ module.exports = Task.extend({ return; } - var pluginHooks = addon.createDeployPlugin({name: name}); + var deployPlugin = addon.createDeployPlugin({name: name}); - Object.keys(pluginHooks).forEach(function(hookName) { - var fn = pluginHooks[hookName]; + Object.keys(deployPlugin).forEach(function(key) { + var fn = deployPlugin[key]; + var hookName = (typeof deployPlugin.name === 'function') ? deployPlugin.name() : deployPlugin.name; if (typeof fn === 'function') { var fnObject = { - name: pluginHooks.name, - fn: fn.bind(pluginHooks) + name: hookName, + fn: fn.bind(deployPlugin) }; - this._pipeline.register(hookName, fnObject); + this._pipeline.register(key, fnObject); } }.bind(this)); }, From 7e47ba70534425c4ebab24f52516262bcb9af36b Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 22 Jun 2015 18:21:43 +0100 Subject: [PATCH 121/300] Now we don't register 'private' plugin functions --- lib/tasks/pipeline.js | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 4fbbf7a4..fdfc09ac 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -103,9 +103,10 @@ module.exports = Task.extend({ Object.keys(deployPlugin).forEach(function(key) { var fn = deployPlugin[key]; + var isPrivate = this._isPrivateProperty(key); var hookName = (typeof deployPlugin.name === 'function') ? deployPlugin.name() : deployPlugin.name; - if (typeof fn === 'function') { + if (!isPrivate && (typeof fn === 'function')) { var fnObject = { name: hookName, fn: fn.bind(deployPlugin) @@ -122,6 +123,10 @@ module.exports = Task.extend({ var implementsDeploymentHooks = addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; return hasDeployKeyword && implementsDeploymentHooks; + }, + + _isPrivateProperty: function(propertyName) { + return propertyName.charAt(0) === '_'; } }); From ba703c9a09028810d2f52c63a58b9e6d00c0078e Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 22 Jun 2015 18:22:39 +0100 Subject: [PATCH 122/300] Added commandLineArgs to deployment context --- lib/tasks/pipeline.js | 20 ++++++++++++-------- node-tests/unit/tasks/pipeline-test.js | 9 ++++++++- 2 files changed, 20 insertions(+), 9 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index fdfc09ac..344861a4 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -25,6 +25,7 @@ module.exports = Task.extend({ var root = this.project.root; this.deployEnvironment = this.deployEnvironment || 'production'; + this.commandLineArgs = this.commandLineArgs || {}; var dotEnvFilename = '.env.deploy.' + this.deployEnvironment; var dotEnvFilePath = path.join(root, dotEnvFilename); @@ -58,16 +59,19 @@ module.exports = Task.extend({ }, run: function(hooks) { - var pipeline = this._pipeline; - var ui = this.ui; - var project = this.project; - var self = this; + var pipeline = this._pipeline; + var ui = this.ui; + var project = this.project; + var self = this; + var commandLineArgs = this.commandLineArgs; + return this.setup().then(function(configs){ var context = { ui: ui, project: project, config: configs.deployConfig, - appConfig: configs.appConfig + appConfig: configs.appConfig, + commandLineArgs: commandLineArgs }; return pipeline.execute({ deployment: context @@ -76,9 +80,9 @@ module.exports = Task.extend({ }, _readConfig: function() { - var project = this.project; - var appConfigPath = this.appConfigPath; - var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); + var project = this.project; + var appConfigPath = this.appConfigPath; + var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); return Promise.resolve(deployConfigFn(this.deployEnvironment)).then(function(deployConfig){ var buildEnv = (deployConfig.build && deployConfig.build.buildEnv) || 'production'; var appConfigFn = require(path.join(project.root, appConfigPath)); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index c8a7b70e..ab1f435f 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -222,6 +222,7 @@ describe('PipelineTask', function() { describe('executing the pipeline task', function() { it ('executes the pipeline, passing in the deployment context', function() { var pipelineExecuted = false; + var deployment; var project = { name: function() {return 'test-project';}, @@ -234,10 +235,12 @@ describe('PipelineTask', function() { ui: mockUi, deployEnvironment: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', + commandLineArgs: {revision: '123abc'}, hooks: ['willDeploy', 'upload'], pipeline: { - execute: function() { + execute: function(context) { pipelineExecuted = true; + deployment = context.deployment; return Promise.resolve(); } } @@ -246,6 +249,10 @@ describe('PipelineTask', function() { return expect(task.run()).to.be.fulfilled .then(function() { expect(pipelineExecuted).to.be.true; + expect(deployment.ui).to.eq(mockUi); + expect(deployment.project).to.eq(project); + expect(deployment.config.build.buildEnv).to.eq('development'); + expect(deployment.commandLineArgs.revision).to.eq('123abc'); }); }); }); From 95a598045c617c3d421c07f8d8d6407147772881 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 22 Jun 2015 18:24:09 +0100 Subject: [PATCH 123/300] Implement 'ember deploy:activate' as pipeline --- lib/commands/activate.js | 30 ++++++++++++++++++++++++------ 1 file changed, 24 insertions(+), 6 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index e7294c3a..0bcf7edf 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -5,18 +5,36 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'revision', type: String }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], + anonymousOptions: [ + '' + ], + run: function(commandOptions, rawArgs) { - var ActivateTask = require('../tasks/activate'); - var activateTask = new ActivateTask({ + process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; + + var commandLineArgs = { + revisionKey: rawArgs.shift(), + activateRevision: true + }; + + var PipelineTask = require('../tasks/pipeline'); + var pipeline = new PipelineTask({ + project: this.project, ui: this.ui, - analytics: this.analytics, - project: this.project + deployEnvironment: commandOptions.environment, + deployConfigPath: commandOptions.deployConfigFile, + commandLineArgs: commandLineArgs, + hooks: [ + 'configure', + 'willActivate', + 'activate', + 'didActivate' + ] }); - return activateTask.run(commandOptions); + return pipeline.run(); } }; From e9b5744f79ccb32d0d02466ee1b074e4e273c2e4 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 22 Jun 2015 18:24:37 +0100 Subject: [PATCH 124/300] Add command line arg to specify intention to force activation --- lib/commands/deploy.js | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index bfed5146..4c952225 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -5,18 +5,24 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'activate', type: Boolean, default: false } ], run: function(commandOptions, rawArgs) { process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; + var commandLineArgs = { + activateRevision: commandOptions.activate + }; + var PipelineTask = require('../tasks/pipeline'); var pipeline = new PipelineTask({ project: this.project, ui: this.ui, deployEnvironment: commandOptions.environment, deployConfigPath: commandOptions.deployConfigFile, + commandLineArgs: commandLineArgs, hooks: [ 'configure', 'willDeploy', From a88d20623fb5081dab482af59dd5dbe978b635fa Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 23 Jun 2015 11:49:18 +0100 Subject: [PATCH 125/300] Conditionally register activation hooks --- lib/commands/activate.js | 3 +-- lib/commands/deploy.js | 56 ++++++++++++++++++++++++++++++---------- 2 files changed, 44 insertions(+), 15 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 0bcf7edf..fb6d814d 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -16,8 +16,7 @@ module.exports = { process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; var commandLineArgs = { - revisionKey: rawArgs.shift(), - activateRevision: true + revisionKey: rawArgs.shift() }; var PipelineTask = require('../tasks/pipeline'); diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 4c952225..19393c48 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,3 +1,6 @@ +var existsSync = require('fs').existsSync; +var path = require('path'); + module.exports = { name: 'deploy', description: 'Deploys an ember-cli app', @@ -6,15 +9,13 @@ module.exports = { availableOptions: [ { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, - { name: 'activate', type: Boolean, default: false } + { name: 'activate', type: Boolean } ], run: function(commandOptions, rawArgs) { process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; - var commandLineArgs = { - activateRevision: commandOptions.activate - }; + var shouldActivate = this._shouldActivate(commandOptions); var PipelineTask = require('../tasks/pipeline'); var pipeline = new PipelineTask({ @@ -22,17 +23,46 @@ module.exports = { ui: this.ui, deployEnvironment: commandOptions.environment, deployConfigPath: commandOptions.deployConfigFile, - commandLineArgs: commandLineArgs, - hooks: [ - 'configure', - 'willDeploy', - 'willBuild', 'build', 'didBuild', - 'willUpload', 'upload', 'didUpload', - 'willActivate', 'activate', 'didActivate', - 'didDeploy' - ] + hooks: this._hooks(shouldActivate) }); return pipeline.run(); + }, + + _shouldActivate: function(options) { + var config = this._pipelineConfig(options); + var referToPipelineConfig = (options.activate === undefined); + return referToPipelineConfig ? config.activateOnDeploy : options.activate; + }, + + _hooks: function(shouldActivate) { + var hooks = ['configure', + 'willDeploy', + 'willBuild', 'build', 'didBuild', + 'willUpload', 'upload', 'didUpload', + 'willActivate', 'activate', 'didActivate', + 'didDeploy' + ]; + + if (!shouldActivate) { + hooks.splice(hooks.indexOf('willActivate'), 3); + } + + return hooks; + }, + + _pipelineConfig: function(options) { + var root = this.project.root; + var filePath = options.deployConfigFile; + var fullPath = path.join(root, filePath); + var env = options.environment; + + if (!existsSync(fullPath)) { + return {}; + } + + var fn = require(fullPath); + + return fn(env)['pipeline'] || {}; } }; From 53d7877c2a42b7c1792a261bd6e3dca293cfec87 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 23 Jun 2015 19:10:15 +0100 Subject: [PATCH 126/300] Added function to return list of initialised hook names --- lib/utilities/pipeline.js | 11 +++++++---- node-tests/unit/utilities/pipeline-test.js | 10 ++++++++++ 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index d85818e7..635ae906 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -42,17 +42,20 @@ Pipeline.prototype.register = function(hookName, fn) { Pipeline.prototype.execute = function(context) { context = context || { }; - var ui = this._ui; - var pipelineHooks = this._pipelineHooks; - var hookNames = this._deploymentHooks(Object.keys(pipelineHooks)); + var ui = this._ui; ui.write(blue('Executing pipeline\n')); - return hookNames.reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) + return this._deploymentHooks(this.hookNames()) + .reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) .then(this._notifyPipelineCompletion.bind(this, ui)) .catch(this._handleDeploymentFailure.bind(this, ui, context)) .catch(this._abortPipelineExecution.bind(this, ui)); }; +Pipeline.prototype.hookNames = function() { + return Object.keys(this._pipelineHooks); +}; + Pipeline.prototype._addHookExecutionPromiseToPipelinePromiseChain = function(ui, promise, hookName) { return promise .then(this._notifyPipelineHookExecution.bind(this, ui, hookName)) diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index 028184e6..3fb45ea3 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -157,4 +157,14 @@ describe ('Pipeline', function() { }); }); }); + + describe('#hookNames', function() { + it('returns the names of the registered hooks', function() { + var subject = new Pipeline(['hook1', 'hook2']); + + var result = subject.hookNames(); + + expect(result).to.have.members(['hook1', 'hook2', 'didFail']); + }); + }); }); From 74c8d5636313de979a79c32a7e1a08cdf80ea5c3 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 23 Jun 2015 19:28:02 +0100 Subject: [PATCH 127/300] Now we only register hooks if the pipeline has been initialised with a hook of the same name --- lib/tasks/pipeline.js | 17 ++++++++--------- lib/utilities/pipeline.js | 4 ++-- 2 files changed, 10 insertions(+), 11 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 344861a4..03c5f376 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -105,18 +105,17 @@ module.exports = Task.extend({ var deployPlugin = addon.createDeployPlugin({name: name}); - Object.keys(deployPlugin).forEach(function(key) { - var fn = deployPlugin[key]; - var isPrivate = this._isPrivateProperty(key); - var hookName = (typeof deployPlugin.name === 'function') ? deployPlugin.name() : deployPlugin.name; + this._hookNames().forEach(function(hookName) { + var fn = deployPlugin[hookName]; + var pluginName = (typeof deployPlugin.name === 'function') ? deployPlugin.name() : deployPlugin.name; - if (!isPrivate && (typeof fn === 'function')) { + if (typeof fn === 'function') { var fnObject = { - name: hookName, + name: pluginName, fn: fn.bind(deployPlugin) }; - this._pipeline.register(key, fnObject); + this._pipeline.register(hookName, fnObject); } }.bind(this)); }, @@ -129,8 +128,8 @@ module.exports = Task.extend({ return hasDeployKeyword && implementsDeploymentHooks; }, - _isPrivateProperty: function(propertyName) { - return propertyName.charAt(0) === '_'; + _hookNames: function() { + return this._pipeline.hookNames(); } }); diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index 635ae906..bac52411 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -32,9 +32,9 @@ Pipeline.prototype.register = function(hookName, fn) { }; } - ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); - if (pipelineHooks[hookName]) { + ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); + pipelineHooks[hookName].push(fn); } }; From c2a6b680e7d8a476c6b033e5f4f2361aa7660a59 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 4 Jul 2015 13:30:44 -0400 Subject: [PATCH 128/300] =?UTF-8?q?Adds=20support=20for=20=E2=80=9Cplugin?= =?UTF-8?q?=20packs=E2=80=9D.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A plugin pack is an addon with the keyword “ember-cli-deploy-plugin-pack” and one or more dependent addons that are ember-cli-deploy-plugins. Note that the plugin pack’s dependent addons should be listed as dependencies in the pack’s package.json, not as devDependencies. I expect that plugin packs may also implement a config/deploy.js blueprint that is auto-executed upon `ember install` of the pack. --- lib/tasks/pipeline.js | 15 ++++++++ node-tests/unit/tasks/pipeline-test.js | 51 ++++++++++++++++++++++++++ 2 files changed, 66 insertions(+) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 03c5f376..224f16c9 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -94,6 +94,16 @@ module.exports = Task.extend({ }, _registerPipelineHooks: function(addon, configuredPluginList) { + var self = this; + + var isDeployPluginPack = this._isDeployPluginPack(addon); + if (isDeployPluginPack) { + addon.addons.forEach(function(nestedAddon){ + self._registerPipelineHooks(nestedAddon, configuredPluginList); + }); + return; + } + var isValidDeployPlugin = this._isValidDeployPlugin(addon); if (!isValidDeployPlugin) { return; } @@ -120,6 +130,11 @@ module.exports = Task.extend({ }.bind(this)); }, + _isDeployPluginPack: function(addon) { + var keywords = addon.pkg.keywords; + return keywords.indexOf('ember-cli-deploy-plugin-pack') > -1; + }, + _isValidDeployPlugin: function(addon) { var keywords = addon.pkg.keywords; var hasDeployKeyword = keywords.indexOf('ember-cli-deploy-plugin') > -1; diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index ab1f435f..9c999d20 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -216,6 +216,57 @@ describe('PipelineTask', function() { expect(registeredHooks.upload[0].fn).to.be.a('function'); }); }); + it('registers dependent plugin addons of a plugin pack addon designated by the ember-cli-deploy-plugin-pack keyword', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-test-plugin-pack', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin-pack' + ] + }, + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'test-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + } + ] + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployEnvironment: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + hooks: ['willDeploy', 'upload'] + }); + return task.setup().then(function(){ + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy.length).to.eq(1); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload.length).to.eq(1); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); + }); + }); }); }); From 0b7a8620c32cb347efdc337e68c4e251ae1089b4 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sun, 5 Jul 2015 19:53:35 -0400 Subject: [PATCH 129/300] Refactoring for clarity and efficiency. --- lib/tasks/pipeline.js | 50 ++++++++++++---------- lib/utilities/pipeline.js | 12 ++++-- node-tests/unit/utilities/pipeline-test.js | 2 +- 3 files changed, 37 insertions(+), 27 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 224f16c9..d276d7d5 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -96,16 +96,14 @@ module.exports = Task.extend({ _registerPipelineHooks: function(addon, configuredPluginList) { var self = this; - var isDeployPluginPack = this._isDeployPluginPack(addon); - if (isDeployPluginPack) { + if (this._isDeployPluginPack(addon)) { addon.addons.forEach(function(nestedAddon){ self._registerPipelineHooks(nestedAddon, configuredPluginList); }); return; } - var isValidDeployPlugin = this._isValidDeployPlugin(addon); - if (!isValidDeployPlugin) { return; } + if (!this._isValidDeployPlugin(addon)) { return; } var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; var name = addon.name.match(pluginNameRegex)[2]; @@ -114,37 +112,45 @@ module.exports = Task.extend({ } var deployPlugin = addon.createDeployPlugin({name: name}); + var pluginName = this._getPluginName(deployPlugin); - this._hookNames().forEach(function(hookName) { - var fn = deployPlugin[hookName]; - var pluginName = (typeof deployPlugin.name === 'function') ? deployPlugin.name() : deployPlugin.name; - - if (typeof fn === 'function') { - var fnObject = { - name: pluginName, - fn: fn.bind(deployPlugin) - }; - - this._pipeline.register(hookName, fnObject); + this._pipeline.hookNames().forEach(function(hookName) { + var fn = deployPlugin[hookName]; + if (typeof fn !== 'function') { + return; } + + this._pipeline.register(hookName, { + name: pluginName, + fn: fn.bind(deployPlugin) + }); }.bind(this)); }, _isDeployPluginPack: function(addon) { - var keywords = addon.pkg.keywords; - return keywords.indexOf('ember-cli-deploy-plugin-pack') > -1; + return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin-pack'); }, _isValidDeployPlugin: function(addon) { + return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin') + && this._addonImplementsDeploymentHooks(addon); + }, + + _addonHasKeyword: function(addon, keyword) { var keywords = addon.pkg.keywords; - var hasDeployKeyword = keywords.indexOf('ember-cli-deploy-plugin') > -1; - var implementsDeploymentHooks = addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; + return keywords.indexOf(keyword) > -1; + }, - return hasDeployKeyword && implementsDeploymentHooks; + _addonImplementsDeploymentHooks: function(addon) { + return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; }, - _hookNames: function() { - return this._pipeline.hookNames(); + _getPluginName: function(plugin) { + if (typeof plugin.name === 'function') { + return plugin.name(); + } else { + return plugin.name; + } } }); diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index bac52411..bf977cef 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -8,6 +8,10 @@ var blue = chalk.blue; var red = chalk.red; var grey = chalk.grey; +/* This is a generic implementation of a pipeline with ordered, promise-aware hooks, + * pleasant logging, and failure handling. It should not have any "deployment" domain + * logic or semantics, and is a candidate for extraction to its own npm module. + */ function Pipeline(hookNames, options) { hookNames = hookNames || []; options = options || {}; @@ -45,10 +49,10 @@ Pipeline.prototype.execute = function(context) { var ui = this._ui; ui.write(blue('Executing pipeline\n')); - return this._deploymentHooks(this.hookNames()) + return this._hooksWithoutDidFail(this.hookNames()) .reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) .then(this._notifyPipelineCompletion.bind(this, ui)) - .catch(this._handleDeploymentFailure.bind(this, ui, context)) + .catch(this._handlePipelineFailure.bind(this, ui, context)) .catch(this._abortPipelineExecution.bind(this, ui)); }; @@ -62,13 +66,13 @@ Pipeline.prototype._addHookExecutionPromiseToPipelinePromiseChain = function(ui, .then(this._executeHook.bind(this, hookName)); }; -Pipeline.prototype._deploymentHooks = function(hooks) { +Pipeline.prototype._hooksWithoutDidFail = function(hooks) { return hooks.filter(function(hook) { return hook !== 'didFail'; }); }; -Pipeline.prototype._handleDeploymentFailure = function(ui, context, error) { +Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { ui.write(red('|\n')); ui.write(red('+- didFail\n')); return this._executeHook.bind(this, 'didFail')(context) diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index 3fb45ea3..6d825b03 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -63,7 +63,7 @@ describe ('Pipeline', function() { }); }); - it('executes the `didFail`-hook as soon as one of the deployment hooks rejects', function() { + it('executes the `didFail`-hook as soon as one of the pipeline hooks rejects', function() { var subject = new Pipeline(['hook1', 'hook2'], {ui: {write: function() {}}}); var hooksRun = []; From 1025bccd700e09b7b07ca21afe74f6013b97213b Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sun, 5 Jul 2015 20:04:22 -0400 Subject: [PATCH 130/300] Include deployEnvironment as part of context. --- lib/tasks/pipeline.js | 9 +++++---- node-tests/unit/tasks/pipeline-test.js | 1 + 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index d276d7d5..b2613c59 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -67,11 +67,12 @@ module.exports = Task.extend({ return this.setup().then(function(configs){ var context = { - ui: ui, - project: project, - config: configs.deployConfig, appConfig: configs.appConfig, - commandLineArgs: commandLineArgs + commandLineArgs: commandLineArgs, + config: configs.deployConfig, + deployEnvironment: self.deployEnvironment, + project: project, + ui: ui }; return pipeline.execute({ deployment: context diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 9c999d20..0209ad60 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -302,6 +302,7 @@ describe('PipelineTask', function() { expect(pipelineExecuted).to.be.true; expect(deployment.ui).to.eq(mockUi); expect(deployment.project).to.eq(project); + expect(deployment.deployEnvironment).to.eq('development'); expect(deployment.config.build.buildEnv).to.eq('development'); expect(deployment.commandLineArgs.revision).to.eq('123abc'); }); From f6905c972335b426465e60fae79dba5bca72d83d Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 10 Jul 2015 00:24:39 -0400 Subject: [PATCH 131/300] Cleanup from master rebase --- node-tests/fixtures/config-with-defaults/deploy.js | 4 ++-- node-tests/unit/utilities/configuration-reader-test.js | 10 +++++----- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/node-tests/fixtures/config-with-defaults/deploy.js b/node-tests/fixtures/config-with-defaults/deploy.js index d1cab0fc..8023b9fa 100644 --- a/node-tests/fixtures/config-with-defaults/deploy.js +++ b/node-tests/fixtures/config-with-defaults/deploy.js @@ -8,7 +8,7 @@ module.exports = { "store": { "host": "localhost", "manifestSize": 10, - "port": 63790, + "port": 6379, "type": "redis" }, "assets": { @@ -41,7 +41,7 @@ module.exports = { "exclude": [], "gzip": true, "prefix": "", - "gzipExtensions": ["js", "css", "svg", "json"], + "gzipExtensions": ["js", "css", "svg"], "type": "s3" } } diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 7c6c096f..192d27c6 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -156,16 +156,16 @@ describe('ConfigurationReader', function() { var root = process.cwd(); var cfgFile = require(path.join(root, './node-tests/fixtures/config-with-defaults/deploy.js')); - ENVs.forEach(function(ENV) { + return Promise.map(ENVs, function(ENV) { var expected = cfgFile[ENV]; - var config = new ConfigurationReader({ + return new ConfigurationReader({ environment: ENV, ui: ui, project: project - }).config; - - expect(config._materialize()).to.deep.equal(expected); + }).read().then(function(config){ + expect(config._materialize()).to.deep.equal(expected); + }); }); }); }) From 9b610e7f4267af50e88e74c06f6d9c5fe50e6a96 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 10 Jul 2015 00:34:42 -0400 Subject: [PATCH 132/300] Plugin architecture overview --- rfc/plugins.md | 321 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 321 insertions(+) create mode 100644 rfc/plugins.md diff --git a/rfc/plugins.md b/rfc/plugins.md new file mode 100644 index 00000000..64ae2a3b --- /dev/null +++ b/rfc/plugins.md @@ -0,0 +1,321 @@ +# Plugins for ember-cli-deploy + +This document describes the API related to plugins in the next +version of ember-cli-deploy. + +### Overview of plugins + +A plugin is an ember-cli addon that hooks into the ember-cli-deploy +pipeline in order to add functionality to a deploy. Example addon +functionality would be uploading assets to S3, writing the index.html to +Redis, or notifying a Slack channel a deploy has completed. + +In general, OSS plugins should focus on doing a specific task. Most +Ember developers with common deployment targets will compose multiple +plugins to fine tune their deployment process. Developers with very +custom needs might create a single private plugin that implements all +aspects of their deployment process within the structure provided by +ember-cli-deploy. + +Because plugins are implemented via addons, they may be included via +node_module dependencies or via in-repo-addons. + +### Identifying plugins + +Plugins are ember-cli addons. They will also have the keyword +`ember-cli-deploy-plugin`. An example `package.json` for a plugin: + +``` +{ + "name": "ember-cli-deploy-example-plugin", + "version": "0.4.0", + // ... + "devDependencies": { + "ember-cli": "0.2.0", + "ember-cli-deploy": "0.4.1" + // ... + }, + "keywords": [ + "ember-addon", + "ember-cli-deploy-plugin" + ] +} +``` + +By default, any plugin that is installed will be loaded, similar to +ember-cli addons. The plugin order is determined by how ember-cli orders +addons (based on `before:`/`after:` properties). To override this, see +Advanced Plugin Configuration and Ordering below. + +### Plugins are provided by ember-cli addons + +Plugins are ember-cli addons which implement an `createDeployPlugin()` method +to return an object which implements one or more methods that are called by +ember-cli-deploy. For example: + +```javascript +module.exports = { + name: 'ember-cli-deploy-example-plugin', + createDeployPlugin: function(options){ + return { + name: options.name, + willDeploy: function:(deployment){ + // do something during the willDeploy phase of the pipeline + }, + didDeploy: function:(deployment){ + // do something during the didDeploy phase of the pipeline + }, + // etc, see hooks section for a complete list of methods that + // may be implemented by a plugin + } + } +} +``` + +This approach limits the risk of name conflicts at the top-level of the addon. +It also allows for the plugin author to consult the addon instance during +creation of the plugin object to make any contextual decisions necessary. +Finally, it is agnostic with respect to the type of object the plugin is. +It may be a POJO, a subclass of CoreObject, or maybe an ES6 class. + +The `options` argument passed to `createDeployPlugin` will have a `name` +property. Usually, the `name` will be the plugin name sans the `ember-cli-deploy-` +prefix, unless a name has been specified as described in Advanced Plugin +Configuration below. + +### The `deployment` object + +For each high-level ember-cli-deploy operation, a `deployment` object is created. +This object is passed to each hook that is invoked on the plugins. It has a number +of properties that may be of use to a plugin: + +Property | file | info +--- | --- | --- +`ui` | - | The ember-cli UI object that can be used to write to stdout. +`appConfig` | `config/environment.js` | The application configuration. +`config` | stored in `config/deploy.js` | The configuration portion of `config/deploy.js` for the active environment +`data` | - | Runtime information about the current operation. Plugins can set properties on this object for later use by themselves or another plugin. + +### Async operations in hooks + +Hook functions can return a promise to block the deployment pipeline. +Since most deployment involves some sort of IO it makes senses that most +plugins will want an async function to complete before continuing to the +next step. If a plugin does not return a promise, then ember-cli-deploy +proceeds immediately. + +If a promise from any of the plugins is rejected then the deployment +pipeline will stop and ember-cli-deploy will exit. Returned promises that are +rejected are treated as unrecoverable errors. + +### Configuration + +By convention, plugin configuration should be kept in `config/deploy.js` and scoped by +the plugin's name. e.g. for an `ember-cli-deploy-example` plugin, the configuration might look like: + +```javascript +// config/deploy.js +module.exports = return function(environment) { + return { + "example": { + bucket: "my-app-" + environment, + awsAccessKeyId: process.env.AWS_ACCESS_KEY_ID, + awsSecretAccessKey: process.env.AWS_SECRET_ACCESS_KEY + } + }; +}; +``` + +### Hooks + +These hooks (part of a typical deployment process) are available for plugins to implement: + +``` +willDeploy: --> runs before anything happens. good opportunity for plugins to validate + configuration or other preconditions + + /-- willBuild confirm environment + / +build --------> builds app assets, documentation, etc. + \ + \-- didBuild manipulate index.html, validate assets + + /-- willUpload confirm remote servers(S3, Redis, Azure, etc.) + / +upload -------> puts the assets somewhere(S3, Redis, Azure, Rackspace, etc.) + | Note: a plugin that implements upload of the HTML file and + | wants to support version activation should set + | `currentVersion` on the `deployment` object to the ID + | of the newly deployed version. + \ + \-- didUpload notify APIs (slack, pusher, etc.), warm cache + + /-- willActivate create backup of assets, notify APIs, uninstall earlier versions + / +activate -------> make a new version live (clear cache, swap Redis values, etc.) + \ + \-- didActivate notify APIs, warm cache + + Note: when hooks in the activate series of hooks are called, the plugin can assume the + presence of a `currentVersion` property on the deployment object, that is set to + the ID of the version to be activated. + +didDeploy: --> runs at the end of a full deployment operation. +``` + +In addition, there are a few more specialized hooks that plugins may implement: + +``` +discoverVersions: --> should return a promise resolving to an array of version objects. Each + version object _must_ have an `id` property. Each version _may_ have one + or more of the following properties: + + `timestamp`: (Date) when the version was created + `revision`: (String) reference of version in SCM + `creator`: (String) email address of developer who deployed the version + `description`: (String) summary of the version + +``` + +### Advanced Plugin Configuration + +As mentioned above, by default, all plugins from installed addons will be loaded, and +ordered based on ember-cli's order of the addons. Developers may have advanced use cases +for specifying the order of plugins, disabling plugins, or configuring a single plugin to +be configured and used twice. + +If you want to opt-into this configuration, you can set the `plugins` property in your `config/deploy.js` file at either the top-level (for global configuration), or under an environment (for per-environment configuration). + +``` +plugins: ["s3-assets", "s3-index", "notify-slack"] +``` + +Any plugins not included in the list will not have their hooks executed. + +To include a plugin twice, alias it using a colon. + +``` +plugins: ["s3-assets:foo-assets", "s3-assets:bar-assets", "s3-index", "notify-slack"] +``` + +The name specified after the colon will be passed as the `name` property +of the `options` argument to the addon's `createDeployPlugin` method. Plugins +should use their name to retrieve configuration values. In this example, +the foo-assets instance of the s3-assets plugin could have different configuration +than the bar-assets instance does. + +### Another take on configuration + +Convention-over-configuration is of utmost importance. For golden path use cases, including the packages and doing unavoidable configuration (e.g. credentials and connection info) should be all it takes. Of course, it should be possible to wire together plugins in ways beside the golden path, too. + +Here's how we should accomplish this. + +Goals: + +1) A great out-of-the-box app developer experience for common deployment scenarios. +2) An API for app developers to define deployment pipeline configuration synchronously or asynchronously. +3) An API for plugin developers to provide static default configuration values. +4) An API for plugin developers to provide default configuration values that are derived at run-time from the data produced by plugin running prior to it in the pipeline. +5) An API for plugin developers to allow ap developers to interact with plugin settings via command line flags. +6) An API for app developers to specify configuration of a plugin to use data produced by a plugin running prior to it in the pipeline. + +Approach: + +* App developers use `config/deploy.js` to return a function that receives the build environment as a string and returns either a config object or a Promise that fulfills with a config object. The config object has properties corresponding to the name of the plugin (e.g. for ember-cli-deploy-redis, the property is “redis”). Supports goal No. 2 above. (This is implemented in the 0.5.0 WIP already.) + +Examples: + +```js +// deploy.js (sync) +module.export function(environment){ + var ENV = { + redis: { + url: process.env.REDIS_URL + } + } + return ENV; +}; + +// deploy.js (async) +module.export function(environment){ + var ENV = { + redis: { + } + } + return someAsyncDataRetrieval(environment).then(function(data){ + ENV.redis = data.redisUrl; + return ENV; + } +}; +``` + +* Plugin developers can implement a `configure` hook that runs at the beginning of pipeline execution (because “configure” is the first step of the pipeline). This hook has read/write access to the config object. It can specify default configuration values, as well as throw an Error in the case that a required configuration property was not provided. Supports goal No. 3 above. (This is implemented in the 0.5.0 WIP already, although we should provide plugins with helper to define defaults and enforce required properties more expressively and more consistently with other plugins.) + +Example: + +```js +// some-ember-cli-deploy-plugin/index.js +module.exports = { + name: 'ember-cli-deploy-myplugin', + + createDeployPlugin: function(options) { + return { + name: options.name, + configure: function(context) { + var deployment = context.deployment; + var config = deployment.config[this.name] = deployment.config[this.name] || {}; + config.filePattern = config.filePattern || “**/*.html”; // provide default + + }, + // ... + } +}; +``` + +* Plugin developers can also use `configure` hook specify a default configuration property as a function, which will be called at run-time, when a plugin wishes to read and use the configuration value. The function will receive the context and must return a value or throw an Error. The context would allow access to data added to pipeline by previous plugins, as well as flags set on command line. Supports goal No. 4 and No. 5 above. (This is not yet implemented.) + +Example: + +```js +// some-ember-cli-deploy-plugin/index.js +module.exports = { + name: 'ember-cli-deploy-myplugin', + + createDeployPlugin: function(options) { + return { + name: options.name, + configure: function(context) { + var deployment = context.deployment; + var config = deployment.config[this.name] = deployment.config[this.name] || {}; + config.revision = config.revision || function(context){ + return context.deployment.revision; + }; + // we could also provide a helper for this, e.g. + // config.revision = config.revision || fromPipelineData(context, “revision”); + config.shouldActivate = config.shouldActivate || function(context){ + return !!context.flags.activate; // set via `--activate on command line + }; + }, + // ... + } +}; +``` + +* App developers can also use this `function`-style configuration in `config/deploy.js` in order to wire together plugins. The function will receive the context and must return a value or throw an Error. Supports goal No. 6 above. (No additional implementation would be necessary if the above were implemented.) + +Example: + +```js +// deploy.js +module.export function(environment){ + var ENV = { + redis: { + revisionKey: function(context) { return context.deployment.tag; }, + forceUpdate: function(context) { return context.flags.force; } + } + } + return ENV; +}; +``` + +These approaches all combine to achieve goal No. 1 above. From 36c20db687148cc30cc2ccde3baf909ede4e98f6 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 10 Jul 2015 01:01:22 -0400 Subject: [PATCH 133/300] Add plugin pack concept to architecture doc --- rfc/plugins.md | 25 ++++++++++++++++++++----- 1 file changed, 20 insertions(+), 5 deletions(-) diff --git a/rfc/plugins.md b/rfc/plugins.md index 64ae2a3b..b0657e0f 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -192,6 +192,8 @@ plugins: ["s3-assets", "s3-index", "notify-slack"] Any plugins not included in the list will not have their hooks executed. +#### Aliasing plugins (probably post-0.5.0) + To include a plugin twice, alias it using a colon. ``` @@ -216,12 +218,12 @@ Goals: 2) An API for app developers to define deployment pipeline configuration synchronously or asynchronously. 3) An API for plugin developers to provide static default configuration values. 4) An API for plugin developers to provide default configuration values that are derived at run-time from the data produced by plugin running prior to it in the pipeline. -5) An API for plugin developers to allow ap developers to interact with plugin settings via command line flags. +5) An API for plugin developers to allow ap developers to interact with plugin settings via command line flags. 6) An API for app developers to specify configuration of a plugin to use data produced by a plugin running prior to it in the pipeline. Approach: -* App developers use `config/deploy.js` to return a function that receives the build environment as a string and returns either a config object or a Promise that fulfills with a config object. The config object has properties corresponding to the name of the plugin (e.g. for ember-cli-deploy-redis, the property is “redis”). Supports goal No. 2 above. (This is implemented in the 0.5.0 WIP already.) +* App developers use `config/deploy.js` to return a function that receives the build environment as a string and returns either a config object or a Promise that fulfills with a config object. The config object has properties corresponding to the name of the plugin (e.g. for ember-cli-deploy-redis, the property is “redis”). Supports goal No. 2 above. (This is implemented in the 0.5.0 WIP already.) Examples: @@ -245,7 +247,7 @@ module.export function(environment){ return someAsyncDataRetrieval(environment).then(function(data){ ENV.redis = data.redisUrl; return ENV; - } + } }; ``` @@ -265,7 +267,7 @@ module.exports = { var deployment = context.deployment; var config = deployment.config[this.name] = deployment.config[this.name] || {}; config.filePattern = config.filePattern || “**/*.html”; // provide default - + }, // ... } @@ -273,7 +275,7 @@ module.exports = { ``` * Plugin developers can also use `configure` hook specify a default configuration property as a function, which will be called at run-time, when a plugin wishes to read and use the configuration value. The function will receive the context and must return a value or throw an Error. The context would allow access to data added to pipeline by previous plugins, as well as flags set on command line. Supports goal No. 4 and No. 5 above. (This is not yet implemented.) - + Example: ```js @@ -319,3 +321,16 @@ module.export function(environment){ ``` These approaches all combine to achieve goal No. 1 above. + +### Plugins packs + +A "plugin pack" is an ember-cli addon with the keyword +"ember-cli-deploy-plugin-pack" and one or more dependent +addons that are ember-cli-deploy-plugins. + +Note that the plugin pack’s dependent addons should be listed as +dependencies in the pack’s package.json, not as devDependencies. + +Plugin packs may also implement a config/deploy.js blueprint that +is auto-executed upon `ember install` of the pack to make +configuration easy for end-developers. From 76b4cc1003605daaa806d591dae52c459c473b57 Mon Sep 17 00:00:00 2001 From: Michael Klein Date: Sun, 12 Jul 2015 14:06:26 +0200 Subject: [PATCH 134/300] Release 0.4.3 --- CHANGELOG.md | 24 ++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67563144..dbde79ce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,29 @@ # ember-cli-deploy Changelog +### 0.4.3 (July 12, 2015) + +This release fixes problems with the silent-error package used by +`ember-cli-deploy` internally, brings improvements for the activate task and +makes it possible to configure the build path that `ember-cli-deploy` uses to +store files before uploading. + +Thanks to everyone who took time to contribute to this release! + +#### Community Contributions + +- [#156](https://github.com/ember-cli/ember-cli-deploy/pull/156) Fix `_materialize` using wrong this context [@jeffhertzler](https://github.com/jeffhertzler) +- [#158](https://github.com/ember-cli/ember-cli-deploy/pull/158) added ember-cli-rest-index adapter to list of adapter [@leojh](https://github.com/leojh) +- [#159](https://github.com/ember-cli/ember-cli-deploy/pull/159) Update video link in README. [@blimmer](https://github.com/blimmer) +- [#161](https://github.com/ember-cli/ember-cli-deploy/pull/161) Remove leading '+' es from code of conduct [@pangratz](https://github.com/pangratz) +- [#164](https://github.com/ember-cli/ember-cli-deploy/pull/164) [#151] read manifestPrefix from config [@pavloo](https://github.com/pavloo) +- [#170](https://github.com/ember-cli/ember-cli-deploy/pull/170) Add ability to configure build paths, defaulting to tmp/deploy-dist/. [@duizendnegen/feature](https://github.com/duizendnegen/feature) +- [#171](https://github.com/ember-cli/ember-cli-deploy/pull/171) Update ember cli 0.2.7 and fix npm warnings [@ghedamat](https://github.com/ghedamat) +- [#175](https://github.com/ember-cli/ember-cli-deploy/pull/175) Manifest prefix for activate task. [@juggy](https://github.com/juggy) +- [#176](https://github.com/ember-cli/ember-cli-deploy/pull/176) Use silent-error NPM Package [@jherdman](https://github.com/jherdman) +- [#178](https://github.com/ember-cli/ember-cli-deploy/pull/178) Use SilentError to log errors when parsing config. [@ember-cli](https://github.com/ember-cli) + +Thank you to all who took the time to contribute! + ### 0.4.2 (June 14, 2015) This release fixes asset upload issues with io.js, adds the possibility for diff --git a/package.json b/package.json index 4f657ad5..e2f9e1b2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.4.2", + "version": "0.4.3", "directories": { "doc": "doc", "test": "tests" From 4018b260ca95854f4ec67b661f3a8e5268c4e2d0 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Sun, 12 Jul 2015 15:57:57 +0200 Subject: [PATCH 135/300] generate deploy.js containing a function instead of an object --- .../deploy-config/files/config/deploy.js | 73 ++++++++----------- 1 file changed, 32 insertions(+), 41 deletions(-) diff --git a/blueprints/deploy-config/files/config/deploy.js b/blueprints/deploy-config/files/config/deploy.js index 89222c2a..a66852c3 100644 --- a/blueprints/deploy-config/files/config/deploy.js +++ b/blueprints/deploy-config/files/config/deploy.js @@ -1,45 +1,36 @@ /* jshint node: true */ -module.exports = { - //development: { - //store: { - //type: 'redis', // the default store is 'redis' - //host: 'localhost', - //port: 6379 - //}, - //assets: { - //type: 's3', // default asset-adapter is 's3' - //gzip: false, // if undefined or set to true, files are gziped - //gzipExtensions: ['js', 'css', 'svg'], // if undefined, js, css & svg files are gziped - //accessKeyId: '', - //secretAccessKey: process.env['AWS_ACCESS_KEY'], - //bucket: '' - //} - //}, +module.exports = function(environment) { + var ENV = {}; + + // if (environment === 'development') { + // ENV.store = { + // host: 'localhost', + // port: 6379 + // }; + // + // ENV.assets = { + // accessKeyId: '', + // secretAccessKey: '', + // bucket: '' + // }; + // } + // + // if (environment === 'staging') { + // ENV.buildEnv = 'staging'; + // + // ENV.store = { + // host: 'staging-redis.firstiwaslike.com', + // port: 6379 + // }; + // + // ENV.assets = { + // accessKeyId: '', + // secretAccessKey: '', + // bucket: '', + // prefix: '' + // }; + // } - //staging: { - //buildEnv: 'staging', // Override the environment passed to the ember asset build. Defaults to 'production' - //store: { - //host: 'staging-redis.example.com', - //port: 6379 - //}, - //assets: { - //accessKeyId: '', - //secretAccessKey: process.env['AWS_ACCESS_KEY'], - //bucket: '' - //} - //}, - - //production: { - //store: { - //host: 'production-redis.example.com', - //port: 6379, - //password: '' - //}, - //assets: { - //accessKeyId: '', - //secretAccessKey: process.env['AWS_ACCESS_KEY'], - //bucket: '' - //} - //} + return ENV; } From 7d5d5bf4e4c59ec7dccf03dae4780954a14c4e80 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Sun, 12 Jul 2015 16:00:16 +0200 Subject: [PATCH 136/300] fix failing test on windows caused by path.join returning backslashes for the path --- node-tests/unit/utilities/configuration-reader-test.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js index 192d27c6..36334d14 100644 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ b/node-tests/unit/utilities/configuration-reader-test.js @@ -91,7 +91,7 @@ describe('ConfigurationReader', function() { }).read().then(function(){ expect(false).to.equal(true); }, function(err){ - expect(err.message).to.equal('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \'config/deploy.js\''); + expect(err.message).to.equal('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ path.join('config', 'deploy.js')+'\''); }); }); From cfcc73764562652ee439928ec92b5b578e890ee2 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 10 Jul 2015 23:20:13 -0400 Subject: [PATCH 137/300] No longer pass appConfig to plugins. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit In real-world experience developing our first 8 plugins, we have had no need for appConfig, so we’re dropping support for it. We have a plan to reintroduce if later plugin development makes it necessary or useful. --- config/environment.js | 2 +- lib/tasks/pipeline.js | 26 ++++++-------------------- node-tests/unit/tasks/pipeline-test.js | 4 +--- rfc/plugins.md | 1 - 4 files changed, 8 insertions(+), 25 deletions(-) diff --git a/config/environment.js b/config/environment.js index 51d56363..c9faa7e3 100644 --- a/config/environment.js +++ b/config/environment.js @@ -1,5 +1,5 @@ 'use strict'; -module.exports = function(/* environment, appConfig */) { +module.exports = function(/* environment */) { return { something: 'test' }; }; diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index b2613c59..e28b6916 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -37,24 +37,19 @@ module.exports = Task.extend({ } this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; - this.appConfigPath = 'config/environment.js'; if (!existsSync(this.deployConfigPath)) { throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); } - - if (!existsSync(this.appConfigPath)) { - throw new SilentError('App config does not exist at `' + this.appConfigPath + '`'); - } }, setup: function(){ var self = this; - return this._readConfig().then(function(configs){ + return this._readConfig().then(function(deployConfig){ self.project.addons.forEach(function(addon){ - self._registerPipelineHooks(addon, configs.deployConfig.plugins); + self._registerPipelineHooks(addon, deployConfig.plugins); }); - return configs; + return deployConfig; }); }, @@ -65,11 +60,10 @@ module.exports = Task.extend({ var self = this; var commandLineArgs = this.commandLineArgs; - return this.setup().then(function(configs){ + return this.setup().then(function(deployConfig){ var context = { - appConfig: configs.appConfig, commandLineArgs: commandLineArgs, - config: configs.deployConfig, + config: deployConfig, deployEnvironment: self.deployEnvironment, project: project, ui: ui @@ -82,16 +76,8 @@ module.exports = Task.extend({ _readConfig: function() { var project = this.project; - var appConfigPath = this.appConfigPath; var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); - return Promise.resolve(deployConfigFn(this.deployEnvironment)).then(function(deployConfig){ - var buildEnv = (deployConfig.build && deployConfig.build.buildEnv) || 'production'; - var appConfigFn = require(path.join(project.root, appConfigPath)); - return { - deployConfig: deployConfig, - appConfig: appConfigFn(buildEnv) - }; - }); + return Promise.resolve(deployConfigFn(this.deployEnvironment)); }, _registerPipelineHooks: function(addon, configuredPluginList) { diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 0209ad60..9eefc013 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -6,7 +6,6 @@ var assert = require('chai').assert; describe('PipelineTask', function() { var mockProject = {addons: []}; var mockConfig = {}; - var mockAppConfig = {}; var mockUi = { write: function() {} }; describe('creating and setting up a new instance', function() { @@ -22,8 +21,7 @@ describe('PipelineTask', function() { var fn = function() { new PipelineTask({ project: mockProject, - config: mockConfig, - appConfig: mockAppConfig + config: mockConfig }); }; diff --git a/rfc/plugins.md b/rfc/plugins.md index b0657e0f..46c3fd04 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -92,7 +92,6 @@ of properties that may be of use to a plugin: Property | file | info --- | --- | --- `ui` | - | The ember-cli UI object that can be used to write to stdout. -`appConfig` | `config/environment.js` | The application configuration. `config` | stored in `config/deploy.js` | The configuration portion of `config/deploy.js` for the active environment `data` | - | Runtime information about the current operation. Plugins can set properties on this object for later use by themselves or another plugin. From 6c8e6d1e0f889db01a02a1138910bc67438c7b6d Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 11 Jul 2015 19:43:43 -0400 Subject: [PATCH 138/300] Restructure to support plugin base class. * Removes `deployment` node in favor of moving ui, config, etc properties to top level of "context". * Invokes `beforeHook` on a plugin (if defined) before each hook is called. --- config/deploy.js | 7 +++- index.js | 6 ++-- lib/models/config.js | 2 +- lib/tasks/pipeline.js | 35 ++++++++----------- lib/utilities/pipeline.js | 14 ++++++-- .../fixtures/config-with-defaults/deploy.js | 8 +++-- node-tests/unit/models/config-test.js | 6 ++-- node-tests/unit/tasks/pipeline-test.js | 14 ++++---- node-tests/unit/utilities/pipeline-test.js | 3 +- rfc/plugins.md | 4 +-- 10 files changed, 55 insertions(+), 44 deletions(-) diff --git a/config/deploy.js b/config/deploy.js index 469cfe6c..a3f8ea2e 100644 --- a/config/deploy.js +++ b/config/deploy.js @@ -2,6 +2,9 @@ module.exports = function(environment) { var ENV = {}; if (environment === 'development') { + ENV.build = { + environment: 'development' + }; ENV.store = { host: 'localhost', port: 6379 @@ -15,7 +18,9 @@ module.exports = function(environment) { } if (environment === 'staging') { - ENV.buildEnv = 'staging'; + ENV.build = { + environment: 'production' + }; ENV.store = { host: 'staging-redis.firstiwaslike.com', diff --git a/index.js b/index.js index 51127690..92cceac7 100644 --- a/index.js +++ b/index.js @@ -36,14 +36,14 @@ Deploy.prototype.blueprintsPath = function() { }; Deploy.prototype.included = function(app) { - var buildEnv = this._deployEnvSetByDeployCommand(); + var deployEnv = this._deployEnvSetByDeployCommand(); var root = app.project.root; var configPath = path.join(root, 'config', 'deploy'); var config; var fingerprint; - if (buildEnv) { - config = require(configPath)(buildEnv); + if (deployEnv) { + config = require(configPath)(deployEnv); if (config.fingerprint === false) { app.options.fingerprint = {enabled: false}; diff --git a/lib/models/config.js b/lib/models/config.js index 08b9704f..30623fcf 100644 --- a/lib/models/config.js +++ b/lib/models/config.js @@ -46,7 +46,7 @@ module.exports = CoreObject.extend({ 'assets.gzipExtensions': ['js', 'css', 'svg'], 'assets.type': 's3', 'assets.exclude': [], - 'buildEnv': 'production', + 'build.environment': 'production', 'buildPath': 'tmp/deploy-dist/', 'manifestPrefix': this.project.name(), 'store.manifestSize': 10, diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index e28b6916..4d1a3e92 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -45,19 +45,19 @@ module.exports = Task.extend({ setup: function(){ var self = this; - return this._readConfig().then(function(deployConfig){ + return this._readDeployConfig().then(function(deployConfig){ self.project.addons.forEach(function(addon){ - self._registerPipelineHooks(addon, deployConfig.plugins); + self._registerPipelineHooks(addon, deployConfig); }); return deployConfig; }); }, run: function(hooks) { + var self = this; var pipeline = this._pipeline; var ui = this.ui; var project = this.project; - var self = this; var commandLineArgs = this.commandLineArgs; return this.setup().then(function(deployConfig){ @@ -68,24 +68,23 @@ module.exports = Task.extend({ project: project, ui: ui }; - return pipeline.execute({ - deployment: context - }); + return pipeline.execute(context); }); }, - _readConfig: function() { + _readDeployConfig: function() { var project = this.project; var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); return Promise.resolve(deployConfigFn(this.deployEnvironment)); }, - _registerPipelineHooks: function(addon, configuredPluginList) { + _registerPipelineHooks: function(addon, deployConfig) { var self = this; + var configuredPluginList = deployConfig.plugins; if (this._isDeployPluginPack(addon)) { addon.addons.forEach(function(nestedAddon){ - self._registerPipelineHooks(nestedAddon, configuredPluginList); + self._registerPipelineHooks(nestedAddon, deployConfig); }); return; } @@ -99,7 +98,6 @@ module.exports = Task.extend({ } var deployPlugin = addon.createDeployPlugin({name: name}); - var pluginName = this._getPluginName(deployPlugin); this._pipeline.hookNames().forEach(function(hookName) { var fn = deployPlugin[hookName]; @@ -108,8 +106,13 @@ module.exports = Task.extend({ } this._pipeline.register(hookName, { - name: pluginName, - fn: fn.bind(deployPlugin) + name: deployPlugin.name, + fn: function(context){ + if (deployPlugin.beforeHook && typeof deployPlugin.beforeHook === 'function') { + deployPlugin.beforeHook(context); + } + return fn.call(deployPlugin, context); + } }); }.bind(this)); }, @@ -130,14 +133,6 @@ module.exports = Task.extend({ _addonImplementsDeploymentHooks: function(addon) { return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; - }, - - _getPluginName: function(plugin) { - if (typeof plugin.name === 'function') { - return plugin.name(); - } else { - return plugin.name; - } } }); diff --git a/lib/utilities/pipeline.js b/lib/utilities/pipeline.js index bf977cef..c59d9f05 100644 --- a/lib/utilities/pipeline.js +++ b/lib/utilities/pipeline.js @@ -61,9 +61,16 @@ Pipeline.prototype.hookNames = function() { }; Pipeline.prototype._addHookExecutionPromiseToPipelinePromiseChain = function(ui, promise, hookName) { + var self = this; return promise - .then(this._notifyPipelineHookExecution.bind(this, ui, hookName)) - .then(this._executeHook.bind(this, hookName)); + .then(this._notifyPipelineHookExecution.bind(this, ui, hookName)) + .then(function(context){ + try { + return self._executeHook(hookName, context); + } catch(error) { + return Promise.reject(error); + } + }); }; Pipeline.prototype._hooksWithoutDidFail = function(hooks) { @@ -75,7 +82,8 @@ Pipeline.prototype._hooksWithoutDidFail = function(hooks) { Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { ui.write(red('|\n')); ui.write(red('+- didFail\n')); - return this._executeHook.bind(this, 'didFail')(context) + ui.write(red(error + "\n" + (error ? error.stack : null))); + return this._executeHook('didFail', context) .then(Promise.reject.bind(this, error)); }; diff --git a/node-tests/fixtures/config-with-defaults/deploy.js b/node-tests/fixtures/config-with-defaults/deploy.js index 8023b9fa..4f60cf6b 100644 --- a/node-tests/fixtures/config-with-defaults/deploy.js +++ b/node-tests/fixtures/config-with-defaults/deploy.js @@ -1,6 +1,8 @@ module.exports = { "development": { - "buildEnv": "production", + "build": { + "environment": "development" + }, "buildPath": "tmp/deploy-dist/", "indexFiles": null, "manifestPrefix": "foo", @@ -23,7 +25,9 @@ module.exports = { }, "staging": { - "buildEnv": "staging", + "build": { + "environment": "production" + }, "buildPath": "tmp/deploy-dist/", "indexFiles": null, "manifestPrefix": "foo", diff --git a/node-tests/unit/models/config-test.js b/node-tests/unit/models/config-test.js index c2f564df..7beffe2b 100644 --- a/node-tests/unit/models/config-test.js +++ b/node-tests/unit/models/config-test.js @@ -24,11 +24,11 @@ describe('Config', function() { describe('buildEnv', function(){ it('defaults to production', function() { var config = createConfig('tomster', {}); - expect(config.get('buildEnv')).to.eq('production'); + expect(config.get('build.environment')).to.eq('production'); }); it('allows configuration', function() { - var config = createConfig('tomster', { buildEnv: 'chocula' }); - expect(config.get('buildEnv')).to.eq('chocula'); + var config = createConfig('tomster', { build: { environment: 'chocula' } }); + expect(config.get('build.environment')).to.eq('chocula'); }); }); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 9eefc013..453672d5 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -271,7 +271,7 @@ describe('PipelineTask', function() { describe('executing the pipeline task', function() { it ('executes the pipeline, passing in the deployment context', function() { var pipelineExecuted = false; - var deployment; + var pipelineContext; var project = { name: function() {return 'test-project';}, @@ -289,7 +289,7 @@ describe('PipelineTask', function() { pipeline: { execute: function(context) { pipelineExecuted = true; - deployment = context.deployment; + pipelineContext = context; return Promise.resolve(); } } @@ -298,11 +298,11 @@ describe('PipelineTask', function() { return expect(task.run()).to.be.fulfilled .then(function() { expect(pipelineExecuted).to.be.true; - expect(deployment.ui).to.eq(mockUi); - expect(deployment.project).to.eq(project); - expect(deployment.deployEnvironment).to.eq('development'); - expect(deployment.config.build.buildEnv).to.eq('development'); - expect(deployment.commandLineArgs.revision).to.eq('123abc'); + expect(pipelineContext.ui).to.eq(mockUi); + expect(pipelineContext.project).to.eq(project); + expect(pipelineContext.deployEnvironment).to.eq('development'); + expect(pipelineContext.config.build.buildEnv).to.eq('development'); + expect(pipelineContext.commandLineArgs.revision).to.eq('123abc'); }); }); }); diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/utilities/pipeline-test.js index 6d825b03..fc27f273 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/utilities/pipeline-test.js @@ -43,7 +43,7 @@ describe ('Pipeline', function() { }); describe ('#execute', function() { - it ('runs the registered functions', function() { + it('runs the registered functions', function() { var subject = new Pipeline(['hook1', 'hook2'], {ui: {write: function() {}}}); var hooksRun = []; @@ -54,7 +54,6 @@ describe ('Pipeline', function() { subject.register('hook2', function() { hooksRun.push('2'); }); - return expect(subject.execute()).to.be.fulfilled .then(function() { expect(hooksRun.length).to.eq(2); diff --git a/rfc/plugins.md b/rfc/plugins.md index 46c3fd04..39be4b3a 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -83,9 +83,9 @@ property. Usually, the `name` will be the plugin name sans the `ember-cli-deploy prefix, unless a name has been specified as described in Advanced Plugin Configuration below. -### The `deployment` object +### The `context` object -For each high-level ember-cli-deploy operation, a `deployment` object is created. +For each high-level ember-cli-deploy operation, a `context` object is created. This object is passed to each hook that is invoked on the plugins. It has a number of properties that may be of use to a plugin: From 20991673d480cfdf23fb1f6633cc4e318d2744f4 Mon Sep 17 00:00:00 2001 From: Katie Gengler Date: Sun, 12 Jul 2015 23:38:35 -0400 Subject: [PATCH 139/300] Update package.json Update description in package.json to match that of the github repo. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index e2f9e1b2..bdf8ff60 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ember-cli-deploy", - "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", + "description": "A deployment pipeline for ember-cli apps", "version": "0.4.3", "directories": { "doc": "doc", From 42e3c13f863af3108351411bf93d3d45f2c4b258 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 23 Jul 2015 00:06:31 -0400 Subject: [PATCH 140/300] [BREAKING] New command line args * Move to `ember deploy [--activate]` and `ember deploy:activate --revision=abc123etc` * Move from DEPLOY_ENVIRONMENT env var to DEPLOY_TARGET env var * provide `commandOptions` on context instead of `commandLineArgs` The motivation for this change was to avoid confusion about the term `environment` and be more succinct. --- README.md | 6 +++--- lib/commands/activate.js | 15 ++++++--------- lib/commands/deploy.js | 17 +++++++++++------ lib/commands/list.js | 5 ++++- lib/tasks/pipeline.js | 22 +++++++++++----------- node-tests/unit/tasks/pipeline-test.js | 20 ++++++++++---------- package.json | 2 +- 7 files changed, 46 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index ed673586..b3e90c89 100644 --- a/README.md +++ b/README.md @@ -120,9 +120,9 @@ You must have an entry for every environment you want to use in this file. This is an example of how one would use this addon to deploy an ember-cli app: -* `ember deploy --environment production` -* `ember deploy:list --environment production` (this will print out a list of revisions) -* `ember deploy:activate --revision ember-deploy:44f2f92 --environment production ` +* `ember deploy production` +* `ember deploy:list production` (this will print out a list of revisions) +* `ember deploy:activate production --revision 44f2f92` ## Fingerprinting Options / Staging environments diff --git a/lib/commands/activate.js b/lib/commands/activate.js index fb6d814d..4bcb1355 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -4,28 +4,25 @@ module.exports = { works: 'insideProject', availableOptions: [ - { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, + { name: 'revision', type: String, required: true }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], anonymousOptions: [ - '' + '' ], run: function(commandOptions, rawArgs) { - process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; - - var commandLineArgs = { - revisionKey: rawArgs.shift() - }; + commandOptions.deployTarget = rawArgs.shift() + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var PipelineTask = require('../tasks/pipeline'); var pipeline = new PipelineTask({ project: this.project, ui: this.ui, - deployEnvironment: commandOptions.environment, + deployTarget: commandOptions.deployTarget, deployConfigPath: commandOptions.deployConfigFile, - commandLineArgs: commandLineArgs, + commandOptions: commandOptions, hooks: [ 'configure', 'willActivate', diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 19393c48..b51f8131 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -6,14 +6,18 @@ module.exports = { description: 'Deploys an ember-cli app', works: 'insideProject', + anonymousOptions: [ + '' + ], + availableOptions: [ - { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, { name: 'activate', type: Boolean } ], run: function(commandOptions, rawArgs) { - process.env.DEPLOY_ENVIRONMENT = commandOptions.environment; + commandOptions.deployTarget = rawArgs.shift() + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var shouldActivate = this._shouldActivate(commandOptions); @@ -21,8 +25,9 @@ module.exports = { var pipeline = new PipelineTask({ project: this.project, ui: this.ui, - deployEnvironment: commandOptions.environment, + deployTarget: commandOptions.deployTarget, deployConfigPath: commandOptions.deployConfigFile, + commandOptions: commandOptions, hooks: this._hooks(shouldActivate) }); @@ -52,10 +57,10 @@ module.exports = { }, _pipelineConfig: function(options) { - var root = this.project.root; + var root = this.project.root; var filePath = options.deployConfigFile; var fullPath = path.join(root, filePath); - var env = options.environment; + var deployTarget = options.deployTarget; if (!existsSync(fullPath)) { return {}; @@ -63,6 +68,6 @@ module.exports = { var fn = require(fullPath); - return fn(env)['pipeline'] || {}; + return fn(deployTarget)['pipeline'] || {}; } }; diff --git a/lib/commands/list.js b/lib/commands/list.js index 9c1be552..45a08174 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -3,8 +3,11 @@ module.exports = { description: 'Lists the currently uploaded deploy-revisions', works: 'insideProject', + anonymousOptions: [ + '' + ], + availableOptions: [ - { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 4d1a3e92..1e791e9f 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -24,10 +24,10 @@ module.exports = Task.extend({ var root = this.project.root; - this.deployEnvironment = this.deployEnvironment || 'production'; - this.commandLineArgs = this.commandLineArgs || {}; + this.deployTarget = this.deployTarget || 'production'; + this.commandOptions = this.commandOptions || {}; - var dotEnvFilename = '.env.deploy.' + this.deployEnvironment; + var dotEnvFilename = '.env.deploy.' + this.deployTarget; var dotEnvFilePath = path.join(root, dotEnvFilename); if (existsSync(dotEnvFilePath)) { @@ -54,17 +54,17 @@ module.exports = Task.extend({ }, run: function(hooks) { - var self = this; - var pipeline = this._pipeline; - var ui = this.ui; - var project = this.project; - var commandLineArgs = this.commandLineArgs; + var self = this; + var pipeline = this._pipeline; + var ui = this.ui; + var project = this.project; + var commandOptions = this.commandOptions; return this.setup().then(function(deployConfig){ var context = { - commandLineArgs: commandLineArgs, + commandOptions: commandOptions, config: deployConfig, - deployEnvironment: self.deployEnvironment, + deployTarget: self.deployTarget, project: project, ui: ui }; @@ -75,7 +75,7 @@ module.exports = Task.extend({ _readDeployConfig: function() { var project = this.project; var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); - return Promise.resolve(deployConfigFn(this.deployEnvironment)); + return Promise.resolve(deployConfigFn(this.deployTarget)); }, _registerPipelineHooks: function(addon, deployConfig) { diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 453672d5..b52cd3a9 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -41,7 +41,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); @@ -77,7 +77,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); @@ -116,7 +116,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); @@ -148,7 +148,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); @@ -199,7 +199,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test.js', hooks: ['willDeploy', 'upload'] }); @@ -250,7 +250,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', hooks: ['willDeploy', 'upload'] }); @@ -282,9 +282,9 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, - deployEnvironment: 'development', + deployTarget: 'development', deployConfigPath: 'node-tests/fixtures/config/deploy.js', - commandLineArgs: {revision: '123abc'}, + commandOptions: {revision: '123abc'}, hooks: ['willDeploy', 'upload'], pipeline: { execute: function(context) { @@ -300,9 +300,9 @@ describe('PipelineTask', function() { expect(pipelineExecuted).to.be.true; expect(pipelineContext.ui).to.eq(mockUi); expect(pipelineContext.project).to.eq(project); - expect(pipelineContext.deployEnvironment).to.eq('development'); + expect(pipelineContext.deployTarget).to.eq('development'); expect(pipelineContext.config.build.buildEnv).to.eq('development'); - expect(pipelineContext.commandLineArgs.revision).to.eq('123abc'); + expect(pipelineContext.commandOptions.revision).to.eq('123abc'); }); }); }); diff --git a/package.json b/package.json index 84f5a6e9..750cffc1 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.4.2", + "version": "0.5.0", "directories": { "doc": "doc", "test": "tests" From 99ede0201e37ea2183f24cc0c2742a5bf1bee214 Mon Sep 17 00:00:00 2001 From: Peter Wagenet Date: Mon, 27 Jul 2015 12:06:54 -0700 Subject: [PATCH 141/300] Update fingerprinting URL in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ed673586..aa923493 100644 --- a/README.md +++ b/README.md @@ -127,7 +127,7 @@ This is an example of how one would use this addon to deploy an ember-cli app: ## Fingerprinting Options / Staging environments `ember-cli` comes with [fingerprinting -support](http://www.ember-cli.com/#fingerprinting-and-cdn-urls) built-in. In +support](http://www.ember-cli.com/user-guide/#fingerprinting-and-cdn-urls) built-in. In most production scenarios you will need to provide a `prepend`-property to your app's fingerprint-property (to reference your CDN served assets correctly). From e70cfde4042e256995d861ef35999fd8acb91cc0 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 27 Jul 2015 16:15:50 -0400 Subject: [PATCH 142/300] Fix a typo --- rfc/plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfc/plugins.md b/rfc/plugins.md index 39be4b3a..4ecbcc69 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -321,7 +321,7 @@ module.export function(environment){ These approaches all combine to achieve goal No. 1 above. -### Plugins packs +### Plugin packs A "plugin pack" is an ember-cli addon with the keyword "ember-cli-deploy-plugin-pack" and one or more dependent From 39f64f2757d0b982876028dae998beab60a16508 Mon Sep 17 00:00:00 2001 From: Sam Selikoff Date: Tue, 28 Jul 2015 09:55:16 -0400 Subject: [PATCH 143/300] Update README.md --- README.md | 328 +----------------------------------------------------- 1 file changed, 6 insertions(+), 322 deletions(-) diff --git a/README.md b/README.md index aa923493..b08f2df5 100644 --- a/README.md +++ b/README.md @@ -1,335 +1,19 @@ -# ember-cli-deploy [![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/ember-cli/ember-cli-deploy/badges/gpa.svg)](https://codeclimate.com/github/ember-cli/ember-cli-deploy) +# Ember CLI Deploy +[![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/ember-cli/ember-cli-deploy/badges/gpa.svg)](https://codeclimate.com/github/ember-cli/ember-cli-deploy) -An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps` - -This project includes the necessary commands for 'Lightning Fast Deployments of -Ember-CLI Apps'. The whole workflow is heavily inspired by Luke Melia's talk -about [Lightning Fast Deployment(s) of Rails-backed Javascript Apps](https://www.youtube.com/watch?v=QZVYP3cPcWQ). - -`ember-cli-deploy` aims to be the go-to-solution for deploying all Ember-CLI apps thus it also supports other types of deployments that differ from the one Luke suggests. Please see this README's subsection about [custom adapters](#custom-adapters) on how to get started with your own deployment strategy with `ember-cli-deploy`. - -You can also have a look on how to use this ember-cli addon in the following video of a talk about `ember-cli-deploy` [Ben Limmer](https://github.com/blimmer) gave at [Ember.js-Denver](http://www.meetup.com/Ember-js-Denver/). - -![ember-deploy talk](http://i.imgur.com/dOGvXty.png) +Simple, flexible deployment for your Ember CLI app ## Installation -Simply run - ``` npm install ember-cli-deploy --save-dev ``` -and the new commands will be available in your ember-cli app! - -## Commands - -This Ember-CLI Addon adds multiple deployment related tasks to your Ember-CLI App. - -* `ember deploy:assets` Uploads your production assets to a static file hoster. -* `ember deploy:index` Uploads a bootstrap index.html to a key-value store. -* `ember deploy:list` Lists all currently uploaded `revisions` of bootstrap index.html files in your key-value store. -* `ember deploy:activate` Activates an uploaded `revision`. This will set the `:current` revision to the passed revision. `:current` is the revision you will serve your users as default. -* `ember deploy` This commands builds your ember application, uploads it to your file hoster and uploads it to your key value store in one step. - -You can pass `--environment ` to every command. If you don't pass an environment explicitly `ember-cli-deploy` will use the `development`-environment. - -You can pass `--deploy-config-file ` to every command. If you don't pass a deploy-config-file explicitly `config/deploy.js` will be read. - -## Lightning-Approach Workflow - -`ember-cli-deploy` is built around the idea of adapters for custom deployment strategies but for most people the approach Luke suggest in his talk will be a perfect fit. - -To use the Lightning-Approach workflow from Luke's talk you will also need to install the redis- and s3-adapters for `ember-cli-deploy`: - -``` -npm install ember-deploy-redis ember-deploy-s3 --save-dev -``` - -[__Please watch Luke's Talk before using this project!__](https://www.youtube.com/watch?v=QZVYP3cPcWQ) - -The TL;DR of the talk is that you want to serve your bootstrap index.html that Ember-CLI builds for you from a Key-Value store via your Backend and serve the rest of your assets from a static file hoster like for example [S3](https://aws.amazon.com/de/s3/). This is a sketch of what this Addon gives you out of the box: - -![Workflow](https://dl.dropboxusercontent.com/s/tun9kbr4eyrcama/ember-deploy.png?dl=0) - -A deployment consists of multiple steps: - -1. Build your assets for production via `ember build --environment production` -2. Upload assets to S3. -3. Upload your bootstrap index.html to a key-value store. -4. Activate the uploaded index.html as the default revision your users will get served from your backend. - -If you don't install the redis- and s3-adapters you will need to use a custom adapter you or the community have written. Please have a look at the Custom-Adapters section of this README for further information. In essence your custom adapters will implement the same steps as for the Lightning-Approach but you can customize the different steps as you see fit. - -## Config file - -By default, `ember-cli-deploy` expects a `deploy.js` file in the `config/` directory of your Ember-CLI project root. In this file you tell `ember-cli-deploy` about the necessary credentials for your file hoster and for your key-value store. An example could look like this: - -```js -module.exports = { - development: { - buildEnv: 'development', // Override the environment passed to the ember asset build. Defaults to 'production' - store: { - type: 'redis', // the default store is 'redis' - host: 'localhost', - port: 6379 - }, - assets: { - type: 's3', // default asset-adapter is 's3' - gzip: false, // if undefined or set to true, files are gziped - gzipExtensions: ['js', 'css', 'svg'], // if undefined, js, css & svg files are gziped - exclude: ['.DS_Store', '*-test.js'], // defaults to empty array - accessKeyId: '', - secretAccessKey: process.env['AWS_ACCESS_KEY'], - bucket: '' - } - }, - - staging: { - buildEnv: 'staging', // Override the environment passed to the ember asset build. Defaults to 'production' - store: { - host: 'staging-redis.example.com', - port: 6379 - }, - assets: { - accessKeyId: '', - secretAccessKey: process.env['AWS_ACCESS_KEY'], - bucket: '' - }, - manifestPrefix: 'stage-app' // optional, defaults to this.project.name() - }, - - production: { - store: { - host: 'production-redis.example.com', - port: 6379, - password: '' - }, - assets: { - accessKeyId: '', - secretAccessKey: process.env['AWS_ACCESS_KEY'], - bucket: '' - } - } -}; -``` - -You must have an entry for every environment you want to use in this file. - -## How to use - -This is an example of how one would use this addon to deploy an ember-cli app: - -* `ember deploy --environment production` -* `ember deploy:list --environment production` (this will print out a list of revisions) -* `ember deploy:activate --revision ember-deploy:44f2f92 --environment production ` - -## Fingerprinting Options / Staging environments - -`ember-cli` comes with [fingerprinting -support](http://www.ember-cli.com/user-guide/#fingerprinting-and-cdn-urls) built-in. In -most production scenarios you will need to provide a `prepend`-property to your -app's fingerprint-property (to reference your CDN served assets correctly). - -```javascript -// Brocfile.js -var app = new EmberApp({ - fingerprint: { - prepend: 'https://subdomain.cloudfront.net/' - } -}); -``` - -`ember-cli` will only create a production like build for the -`production`-environment by default. If you want to support multiple -'production-like' environments you need to configure minification for these -environments manually. You can do someting like this: - -```javascript -// Brocfile.js -var env = EmberApp.env(); -var isProductionLikeBuild = ['production', 'staging'].indexOf(env) > -1; - -var app = new EmberApp({ - fingerprint: { - enabled: isProductionLikeBuild, - prepend: 'https://subdomain.cloudfront.net/' - }, - sourcemaps: { - enabled: !isProductionLikeBuild, - }, - minifyCSS: { enabled: isProductionLikeBuild }, - minifyJS: { enabled: isProductionLikeBuild }, - - tests: process.env.EMBER_CLI_TEST_COMMAND || !isProductionLikeBuild, - hinting: process.env.EMBER_CLI_TEST_COMMAND || !isProductionLikeBuild, - - vendorFiles: { - 'handlebars.js': { - staging: 'bower_components/handlebars/handlebars.runtime.js' - }, - 'ember.js': { - staging: 'bower_components/ember/ember.prod.js' - } - } -}); -``` - -## S3-Asset uploads - -`ember-deploy-s3` sets the correct cache headers for you. Currently these are hard coded to a two year cache period. Assets are also gzipped before uploading to S3. This should be enough to cache aggressively and you should not run into problems due to ember-cli's fingerprinting support. I will try to add more configuration options for caching in the near future. - -### Example Sinatra app - -This is a small sinatra application that can be used to serve an Ember-CLI application deployed with the help of `ember-cli-deploy` and `ember-deploy-redis`. - -```ruby -require 'sinatra' -require 'redis' - -def bootstrap_index(index_key) - redis = Redis.new - index_key &&= ":#{index_key}" - index_key ||= redis.get(":current") - redis.get(index_key) -end - -get '/' do - content_type 'text/html' - bootstrap_index(params[:index_key]) -end -``` - -The nice thing about this is that you can deploy your app to production, test it out by passing an index_key parameter with the revision you want to test and activate when you feel confident that everything is working as expected. - -### Example nodejs app - -This app does the same as the *Sinatra app* from before, it supports the same index_key query param. It should help you to get up and running in seconds and dont worry about server code. You also need to deploy your ember app with `ember-cli-deploy` and `ember-deploy-redis`. - -[Nodejs example with one click deploy!](https://github.com/philipheinser/ember-lightning) - -## Custom Adapters - -`ember-cli-deploy` is built around the idea of adapters for the bootstrap-index- and the assets-uploads. For `ember-cli-deploy` to give you the deployment approach Luke talks about in his talk you will for example need to install the `ember-deploy-redis` and `ember-deploy-s3` adapters via npm. - -Because `ember-cli-deploy` is built with adapters in mind you can write your own adapters for your project specific use cases. - -Custom Adapters can be integrated via custom [Ember-CLI-Addons](http://www.ember-cli.com/#developing-addons-and-blueprints). For `ember-cli-deploy` to integrate your custom adapter addons you have to define your addon-type as an `ember-deploy-addon`. - -You can have a look at [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3) and [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis) to get an idea how one would implement 'real-world'-adapters. - -For the sake of clarity here's a quick example of how you will structure your addon to add custom adapters. - -```js -//index.js in your custom addon - -var SuperAwesomeCustomIndexAdapter = require('./lib/index-adapter'); - -function EmberDeploySuperAwesome() { - this.name = 'ember-deploy-super-awesome'; - this.type = 'ember-deploy-addon'; - - // ember-cli-deploy will merge ember-deploy-addon's adapters property - this.adapters = { - index: { - 'super-awesome': SuperAwesomeCustomIndexAdapter - }, - assets: { - // you can add multiple adapters in one ember-deploy-addon - }, - - tagging: { - // you can add multiple adapters in one ember-deploy-addon - } - }; -} - -module.exports = EmberDeploySuperAwesome; -``` - -Because `ember-cli-deploy` will simply merge an `ember-deploy-addon`'s adapters property into its own bundled adapter-registry you could in theory bundle a complete new approach for deploying in one addon (just add an index- and an asset-adapter). - -After adding your custom ember-deploy-addon to your project as an ember-cli-addon you can then use your custom adapters in ember-cli-deploy's deploy.json: - -```js -{ - "development": { - "store": { - "type": "super-awesome", - // .. whatever additional config your adapter needs - }, - "assets": { - "accessKeyId": "", - "secretAccessKey": "", - "bucket": "" - } - }, - //... -} -``` - -### Existing Custom Adapters -The following adapters have already been developed: -* [ember-deploy-redis](https://github.com/LevelbossMike/ember-deploy-redis), index-adapter for [Redis](http://redis.io) -* [ember-deploy-s3](https://github.com/LevelbossMike/ember-deploy-s3), assets-adapter for AWS [S3](http://aws.amazon.com/s3/) -* [ember-deploy-s3-index](https://github.com/Kerry350/ember-deploy-s3-index), index-adapter for AWS [S3](http://aws.amazon.com/s3/) -* [ember-deploy-azure](https://github.com/duizendnegen/ember-deploy-azure), index-adapter and assets-adapter for Azure Tables & Blob Storage respectively -* [ember-deploy-couchbase](https://github.com/waltznetworks/ember-deploy-couchbase), index-adapter for [Couchbase](http://www.couchbase.com) -* [ember-deploy-rest-index](https://github.com/leojh/ember-deploy-rest-index), index-adapter for REST API backends - -### Index-Adapters - -`index-adapters` take care of publishing bootstrap-index html that ember-cli builds for you. If you don't want to use `redis` as a key-value store for your index.html files if you are using the Lightning approach from Luke Melia's talk you could for example create a `cassandra`-adapter to use [Apacha Cassandra](http://cassandra.apache.org/) instead. - -Index adapters have to implement the following methods for `ember-cli-deploy` to be able to use them: - -####`upload([bootstrapIndexHTML])` - - __Parameters__ - - _bootstrapIndexHTML_ - - `upload` will get passed the content of `dist/index.html` that gets build from ember-cli. Feel free to do whatever you need to do with its file content. - - This method has to return a `RSVP.Promise`. - -####`activate([revisionToActivate])` - -__Parameters__ - -_revisionToActivate_ - -`activate` takes a revision you pass to it and activates it in the key-value store. The `redis`-adapter for example takes the passed revision-key and sets it as the value of the `:current`-key in redis. Of course you can do whatever you want in this method. If you decide that you don't need a notion of activating revisions it is recommended that you nevertheless return a useful message to the user in this method. - -This method has to return a `RSVP.Promise`. - -####`list` - -`list` lists all uploaded revisions you have deployed and that you want the user to be able to preview or to rollback to. Of course you can do whatever you want in this method. If you decide that you don't need a notion of listing revisions it is recommended that you nevertheless return a useful message to the user in this method. - -This method has to return a `RSVP.Promise`. - -### Asset-Adapters - -`asset-adapters` take care of publishing your project assets. In the default use case (Luke Melia's lightning approach) your assets will be published to a static asset server like AWS S3. If you want to use some other static asset server service or you want to do something entirely different you can write your own `asset-adapter`. Asset-Adapters have to implement the following method for ember-cli-deploy to know what to do: - -####`upload` - -Ember deploy will gzip your `js` and `css` assets and copy these gzipped assets and all other assets from ember-cli's `dist`-folder to the `tmp/assets-sync`-directory. You can do whatever you want in an `asset-adapter`'s `upload`-method but most likely you will upload these assets to some kind of static-asset server with the `upload`-method. - -This method has to return a `RSVP.Promise`. - -### Tagging-Adapters - -`tagging-adapters` take care of tagging revisions when uploading revisions via the `deploy-index`-command. `ember-cli-deploy` comes bundled with the `sha`-tagging-adapter that will tag your revisions according to the current git-sha. - -Tagging Adapters need to implement the following method for ember-cli-deploy to know what to do: - -####`createTag` +## Documentation -This method has to return a `String`. +[Visit the Docs site](http://ember-cli.github.io/ember-cli-deploy/) -### Contributing +## Contributing Clone the repo and run `npm install`. To run tests, From bef5e3acfda05afde55df5ff9236eadc21e62dbe Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Wed, 29 Jul 2015 22:13:59 +0200 Subject: [PATCH 144/300] Upgrade instructions for plugin authors (and a bit for end users) --- UPGRADE_TO_0.5.0.md | 53 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 UPGRADE_TO_0.5.0.md diff --git a/UPGRADE_TO_0.5.0.md b/UPGRADE_TO_0.5.0.md new file mode 100644 index 00000000..5547861f --- /dev/null +++ b/UPGRADE_TO_0.5.0.md @@ -0,0 +1,53 @@ +## Overview + +The pipeline approach in 0.5.0 requires some modifications to ember-cli-deploy plugins and a few to deploy configuration scripts. + +## Plugin users + +- Add the following dependencies: `ember-cli-deploy-build` and `ember-cli-deploy-revision-key` +- Change your config/deploy.js to return a function instead of an object, for each `environment` setting: + - `ENV.store = %INDEX_ADAPTER_NAME%` (for example 'redis') + - `ENV.assets = %ASSETS_ADAPTER_NAME%` (for example ('s3') + - `ENV["%INDEX_ADAPTER_NAME%"] = { /* plugin config goes here */ }` + - `ENV["%ASSETS_ADAPTER_NAME%"] = { /* plugin config goes here */ }` + +## Plugin authors +Depending on what type of adapters you're publishing, you'll have to make different amendments. + +### For all adapters + +1. update package.json keywords to include the keyword "ember-cli-deploy-plugin" +2. `npm install ember-cli-deploy-plugin --save` and subclass the new https://github.com/lukemelia/ember-cli-deploy-plugin for all your adapters. +3. implement `createDeployPlugin` in index.js and return an extended `ember-cli-deploy-plugin` from there. +4. listen to hooks to actually upload stuff, most notably upload (index and assets adapter) and activate (index adapter) +5. instruct your users to update their config (see above) +6. instruct your users to install ember-cli-deploy-build (see above) (there's discussion of whether to put this in ember-cli-deploy by default for 0.5.0, follow https://github.com/ember-cli/ember-cli-deploy/pull/179) +7. replace console.log statements to this.log to play nicely with the formatting in ember-cli-deploy + +### For index/store adapters: +1. instruct your users to install ember-cli-deploy-revision-key (see above) +2. mind you that the revision key is now under context.revisionKey (provided ember-cli-deploy-revision-key is installed) and it doesn't include your project name yet. +```javascript +_key: function(context) { + var revisionKey = context.commandOptions.revision || context.revisionKey.substr(0, 8); + return context.project.name() + ':' + revisionKey; +} +``` +3. mind you that you won't be passed the contents of index.html to your upload function, instead you will have to read the file using the filesystem package, +```javascript +var path = require('path'); +var fs = require('fs'); +var readFile = denodeify(fs.readFile); + +upload: function() { + readFile(path.join(context.distDir, "index.html")) + .then(function(buffer) { + return buffer.toString(); + }).then(function(indexContents) { + // do uploady stuff with contents here + }); +} +``` + +### For asset adapters: +1. if you have a hard reference to "tmp/asset-sync", replace that with context.distDir. From d6e3e3f7c755aac9dd68b8f27ac5ae6a13140347 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Wed, 29 Jul 2015 22:32:19 +0200 Subject: [PATCH 145/300] remove unused store & assets config (which was a legacy config) --- UPGRADE_TO_0.5.0.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/UPGRADE_TO_0.5.0.md b/UPGRADE_TO_0.5.0.md index 5547861f..3226c3a4 100644 --- a/UPGRADE_TO_0.5.0.md +++ b/UPGRADE_TO_0.5.0.md @@ -6,8 +6,6 @@ The pipeline approach in 0.5.0 requires some modifications to ember-cli-deploy p - Add the following dependencies: `ember-cli-deploy-build` and `ember-cli-deploy-revision-key` - Change your config/deploy.js to return a function instead of an object, for each `environment` setting: - - `ENV.store = %INDEX_ADAPTER_NAME%` (for example 'redis') - - `ENV.assets = %ASSETS_ADAPTER_NAME%` (for example ('s3') - `ENV["%INDEX_ADAPTER_NAME%"] = { /* plugin config goes here */ }` - `ENV["%ASSETS_ADAPTER_NAME%"] = { /* plugin config goes here */ }` From 1484b33c08179946d17ceca7526ca074366583fc Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Fri, 31 Jul 2015 11:30:12 +0200 Subject: [PATCH 146/300] list pipeline containing fetchRevisions and displayRevisions --- lib/commands/list.js | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/lib/commands/list.js b/lib/commands/list.js index 45a08174..51df5cd3 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -8,17 +8,28 @@ module.exports = { ], availableOptions: [ - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } + { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'amount', type: Number, default: 10 } ], run: function(commandOptions, rawArgs) { - var ListTask = require('../tasks/list'); - var listTask = new ListTask({ + commandOptions.deployTarget = rawArgs.shift() + process.env.DEPLOY_TARGET = commandOptions.deployTarget; + + var PipelineTask = require('../tasks/pipeline'); + var pipeline = new PipelineTask({ + project: this.project, ui: this.ui, - analytics: this.analytics, - project: this.project + deployTarget: commandOptions.deployTarget, + deployConfigPath: commandOptions.deployConfigFile, + commandOptions: commandOptions, + hooks: [ + 'configure', + 'fetchRevisions', + 'displayRevisions' + ] }); - return listTask.run(commandOptions); + return pipeline.run(); } }; From 227e07ff82ededf494047e70d1db680e68ded9a4 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Thu, 30 Jul 2015 14:36:55 +0200 Subject: [PATCH 147/300] Add quick start guide to README to not redirect everyone to the docs site --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b08f2df5..9f026a30 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,11 @@ Simple, flexible deployment for your Ember CLI app npm install ember-cli-deploy --save-dev ``` -## Documentation +## Quick start + +After installation, choose [deployment adapters](http://ember-cli.github.io/ember-cli-deploy/docs/v0.4.x/existing-custom-adapters/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.4.x/configuration/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.4.x/how-to-use/). + +## In-depth documentation [Visit the Docs site](http://ember-cli.github.io/ember-cli-deploy/) From 4830ddf29adc249bb32c05e5fb127d45ac2e988d Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Sun, 2 Aug 2015 21:06:14 +0200 Subject: [PATCH 148/300] Implement aliases to support multiple instances of plugins --- lib/tasks/pipeline.js | 76 +++++++++++--- ...eploy-for-addons-config-test-with-alias.js | 5 + ...loy-for-addons-config-test-with-aliases.js | 5 + node-tests/unit/tasks/pipeline-test.js | 99 +++++++++++++++++++ 4 files changed, 169 insertions(+), 16 deletions(-) create mode 100644 node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js create mode 100644 node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 1e791e9f..7d833c20 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -46,13 +46,36 @@ module.exports = Task.extend({ setup: function(){ var self = this; return this._readDeployConfig().then(function(deployConfig){ - self.project.addons.forEach(function(addon){ - self._registerPipelineHooks(addon, deployConfig); + self._plugins = Object.create(null); + (self.project.addons || []).forEach(function(addon){ + self._registerPlugin(addon); }); + + var aliasHash = self._aliasHash(deployConfig, self._plugins); + + Object.keys(aliasHash).forEach(function(alias) { + self._registerPipelineHooks(aliasHash[alias], alias); + }); + return deployConfig; }); }, + _registerPlugin: function(addon) { + var self = this; + + if (this._isDeployPluginPack(addon)) { + addon.addons.forEach(function(nestedAddon){ + self._registerPlugin(nestedAddon); + }); + return; + } + + if (!this._isValidDeployPlugin(addon)) { return; } + + this._plugins[this._pluginName(addon)] = addon; + }, + run: function(hooks) { var self = this; var pipeline = this._pipeline; @@ -78,26 +101,47 @@ module.exports = Task.extend({ return Promise.resolve(deployConfigFn(this.deployTarget)); }, - _registerPipelineHooks: function(addon, deployConfig) { - var self = this; - var configuredPluginList = deployConfig.plugins; + _aliasHash: function(deployConfig, plugins) { + var aliasList = deployConfig.plugins; + if(!aliasList) { + // no whitelist available, autodiscover all the plugins + aliasList = Object.keys(plugins); + } - if (this._isDeployPluginPack(addon)) { - addon.addons.forEach(function(nestedAddon){ - self._registerPipelineHooks(nestedAddon, deployConfig); - }); - return; + + var unavailablePlugins = Object.create(null); + var aliasHash = Object.create(null); + + aliasList.forEach(function(alias) { + var split = alias.split(':', 2); + var pluginName = split[0]; + var configuredName = split[1] ? split[1] : split[0]; + + aliasHash[configuredName] = plugins[pluginName]; + + if(!aliasHash[configuredName]) { + unavailablePlugins[configuredName] = pluginName; + } + }); + + if(Object.keys(unavailablePlugins).length !== 0) { + console.log(unavailablePlugins); + var error = new SilentError('Configured alias for plugins, which are not available.'); + error.unavailablePlugins = unavailablePlugins; + throw error; } - if (!this._isValidDeployPlugin(addon)) { return; } + return aliasHash; + }, + _pluginName: function(addon) { var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; - var name = addon.name.match(pluginNameRegex)[2]; - if (configuredPluginList && configuredPluginList.indexOf(name) === -1) { - return; - } + return addon.name.match(pluginNameRegex)[2]; + }, - var deployPlugin = addon.createDeployPlugin({name: name}); + _registerPipelineHooks: function(addon, alias) { + var self = this; + var deployPlugin = addon.createDeployPlugin({name: alias}); this._pipeline.hookNames().forEach(function(hookName) { var fn = deployPlugin[hookName]; diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js b/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js new file mode 100644 index 00000000..cd4e5790 --- /dev/null +++ b/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js @@ -0,0 +1,5 @@ +module.exports = function(environment) { + return { + plugins: ['foo-plugin:bar-alias'] + }; +} diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js b/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js new file mode 100644 index 00000000..2076a6d8 --- /dev/null +++ b/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js @@ -0,0 +1,5 @@ +module.exports = function(environment) { + return { + plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] + }; +} diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index b52cd3a9..f8ddeae7 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -306,4 +306,103 @@ describe('PipelineTask', function() { }); }); }); + + describe('plugin aliases are correctly handled', function() { + it('passes correct name to single plugin alias', function () { + var correctAliasUsed = false; + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function(options) { + correctAliasUsed = (options.name === 'bar-alias'); + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js', + pipeline: { + hookNames: function () { + return []; + } + } + }); + + return task.setup().then(function() { + expect(correctAliasUsed).to.be.true; + }); + }); + + it('passes correct name to multiple instances of the same plugin', function () { + var correctAliasUsed = { + 'foo-plugin': false, // plugin without alias + 'bar-alias': false, // first alias + 'doo-alias': false // second alias + }; + + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function(options) { + correctAliasUsed[options.name] = true; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', + pipeline: { + hookNames: function () { + return []; + } + } + }); + + return task.setup().then(function() { + expect(correctAliasUsed['foo-plugin']).to.be.true; + expect(correctAliasUsed['bar-alias']).to.be.true; + expect(correctAliasUsed['doo-alias']).to.be.true; + }); + }); + + it('throws error on non-existent plugin in whitelist and appends them to err.unavailablePlugins', function () { + var correctAliasUsed = false; + var project = { + name: function() {return 'test-project';}, + root: process.cwd() + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', + }); + + return task.setup().then(null, function(err) { + assert.equal(Object.keys(err.unavailablePlugins).length, 3); + }); + }); + }); }); From f61f057decfaf5050528d555bd901daf61919039 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Tue, 4 Aug 2015 00:43:53 -0400 Subject: [PATCH 149/300] Improve semantics --- lib/tasks/pipeline.js | 70 ++++++++++++++------------ node-tests/unit/tasks/pipeline-test.js | 5 +- 2 files changed, 42 insertions(+), 33 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 7d833c20..82a327e8 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -46,34 +46,47 @@ module.exports = Task.extend({ setup: function(){ var self = this; return this._readDeployConfig().then(function(deployConfig){ - self._plugins = Object.create(null); - (self.project.addons || []).forEach(function(addon){ - self._registerPlugin(addon); - }); - - var aliasHash = self._aliasHash(deployConfig, self._plugins); + self._installedPlugins = self._discoverInstalledPlugins(); + + var plugins; + var configuredPluginList = deployConfig.plugins; + if (configuredPluginList) { + plugins = self._configuredPlugins(configuredPluginList, self._installedPlugins); + } else { + // no whitelist available, use all autodiscovered plugins + plugins = self._installedPlugins; + } - Object.keys(aliasHash).forEach(function(alias) { - self._registerPipelineHooks(aliasHash[alias], alias); + Object.keys(plugins).forEach(function(pluginName) { + self._registerPipelineHooks(plugins[pluginName], pluginName); }); return deployConfig; }); }, - _registerPlugin: function(addon) { + _discoverInstalledPlugins: function(){ + var self = this; + var installedPlugins = Object.create(null); + (this.project.addons || []).forEach(function(addon){ + self._registerInstalledPlugin(addon, installedPlugins); + }); + return installedPlugins; + }, + + _registerInstalledPlugin: function(addon, registry) { var self = this; if (this._isDeployPluginPack(addon)) { addon.addons.forEach(function(nestedAddon){ - self._registerPlugin(nestedAddon); + self._registerInstalledPlugin(nestedAddon, registry); }); return; } if (!this._isValidDeployPlugin(addon)) { return; } - this._plugins[this._pluginName(addon)] = addon; + registry[this._pluginNameFromAddonName(addon)] = addon; }, run: function(hooks) { @@ -101,40 +114,33 @@ module.exports = Task.extend({ return Promise.resolve(deployConfigFn(this.deployTarget)); }, - _aliasHash: function(deployConfig, plugins) { - var aliasList = deployConfig.plugins; - if(!aliasList) { - // no whitelist available, autodiscover all the plugins - aliasList = Object.keys(plugins); - } - - + _configuredPlugins: function(configuredPluginNames, availablePlugins) { var unavailablePlugins = Object.create(null); - var aliasHash = Object.create(null); - - aliasList.forEach(function(alias) { - var split = alias.split(':', 2); - var pluginName = split[0]; - var configuredName = split[1] ? split[1] : split[0]; + var configuredPlugins = Object.create(null); - aliasHash[configuredName] = plugins[pluginName]; + configuredPluginNames.forEach(function(configuredPluginKey) { + var parts = configuredPluginKey.split(':', 2); + var pluginName = parts[0]; + var configuredName = parts[1] ? parts[1] : parts[0]; - if(!aliasHash[configuredName]) { + if (availablePlugins[pluginName]) { + configuredPlugins[configuredName] = availablePlugins[pluginName]; + } else { unavailablePlugins[configuredName] = pluginName; } }); - if(Object.keys(unavailablePlugins).length !== 0) { - console.log(unavailablePlugins); - var error = new SilentError('Configured alias for plugins, which are not available.'); + if (Object.keys(unavailablePlugins).length !== 0) { + this.ui.writeError(unavailablePlugins); + var error = new SilentError('plugins configuration references plugins which are not available.'); error.unavailablePlugins = unavailablePlugins; throw error; } - return aliasHash; + return configuredPlugins; }, - _pluginName: function(addon) { + _pluginNameFromAddonName: function(addon) { var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; return addon.name.match(pluginNameRegex)[2]; }, diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index f8ddeae7..468bb0bb 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -6,7 +6,7 @@ var assert = require('chai').assert; describe('PipelineTask', function() { var mockProject = {addons: []}; var mockConfig = {}; - var mockUi = { write: function() {} }; + var mockUi = { write: function() {}, writeError: function() {} }; describe('creating and setting up a new instance', function() { it ('raises an error if project is not provided', function() { @@ -29,6 +29,9 @@ describe('PipelineTask', function() { }); describe('setting environment variables from .env', function() { + beforeEach(function(){ + delete process.env.ENVTEST; + }); it('sets the process.env vars if a .env file exists for deploy environment', function() { var project = { name: function() {return 'test-project';}, From 847274856d24dc7e2fc48879e2829f416450af11 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sun, 9 Aug 2015 13:17:23 +0100 Subject: [PATCH 150/300] Release v0.5.0-beta.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 750cffc1..f4604ffa 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.5.0", + "version": "0.5.0-beta.1", "directories": { "doc": "doc", "test": "tests" From 8a6cbab2cfff06626e0c25acaa5734b013985ca6 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Sun, 9 Aug 2015 22:42:16 +0100 Subject: [PATCH 151/300] Updated DEPLOY_ENVIRONMENT to DEPLOY_TARGET as this was forgotten which caused a bug with fingerprinting --- index.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/index.js b/index.js index 92cceac7..960e0684 100644 --- a/index.js +++ b/index.js @@ -36,7 +36,7 @@ Deploy.prototype.blueprintsPath = function() { }; Deploy.prototype.included = function(app) { - var deployEnv = this._deployEnvSetByDeployCommand(); + var deployEnv = this._deployTargetSetByDeployCommand(); var root = app.project.root; var configPath = path.join(root, 'config', 'deploy'); var config; @@ -58,8 +58,8 @@ Deploy.prototype.included = function(app) { } }; -Deploy.prototype._deployEnvSetByDeployCommand = function() { - return process.env.DEPLOY_ENVIRONMENT; +Deploy.prototype._deployTargetSetByDeployCommand = function() { + return process.env.DEPLOY_TARGET; } module.exports = Deploy; From b33314e086e345359225df257677d170e3194b5d Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sun, 9 Aug 2015 21:41:36 -0400 Subject: [PATCH 152/300] Remove unused code and commands deprecated in 0.4.0. - Addressed some jshint suggestions - Moved lib/utilities/pipeline.js to lib/models/pipeline.js --- .jshintrc | 3 +- ...EPS.md => MIGRATING_FROM_0_0_x_TO_0_4_x.md | 0 .../deploy-config/files/config/deploy.js | 56 +++--- config/deploy.js | 39 ---- index.js | 23 +-- lib/commands/activate.js | 2 +- lib/commands/deploy.js | 2 +- .../{deprecated => }/deprecated-command.js | 0 lib/commands/deprecated/activate.js | 31 ---- lib/commands/deprecated/assets.js | 25 --- lib/commands/deprecated/deploy-index.js | 23 --- lib/commands/deprecated/versions.js | 15 -- lib/commands/discontinued-command.js | 16 ++ lib/commands/index.js | 15 +- lib/commands/list.js | 2 +- lib/models/config.js | 83 --------- lib/{utilities => models}/pipeline.js | 5 +- lib/tasks/activate.js | 36 ---- lib/tasks/assets.js | 105 ----------- lib/tasks/deploy-index.js | 64 ------- lib/tasks/list.js | 30 --- lib/tasks/pipeline.js | 8 +- lib/utilities/adapter-registry.js | 40 ---- lib/utilities/adapter.js | 12 -- lib/utilities/assets-uploader.js | 22 --- lib/utilities/assets/unknown.js | 16 -- lib/utilities/configuration-reader.js | 40 ---- lib/utilities/deprecate.js | 9 - lib/utilities/detect-deprecated-config.js | 8 - lib/utilities/tagging/sha.js | 17 -- node-tests/unit/models/config-test.js | 122 ------------ .../{utilities => models}/pipeline-test.js | 2 +- node-tests/unit/tasks/assets-test.js | 75 -------- .../unit/utilities/adapter-registry-test.js | 87 --------- .../unit/utilities/assets-uploader-test.js | 13 -- .../unit/utilities/assets/unknown-test.js | 24 --- .../utilities/configuration-reader-test.js | 173 ------------------ node-tests/unit/utilities/tagging/sha-test.js | 28 --- 38 files changed, 60 insertions(+), 1211 deletions(-) rename MIGRATION_STEPS.md => MIGRATING_FROM_0_0_x_TO_0_4_x.md (100%) delete mode 100644 config/deploy.js rename lib/commands/{deprecated => }/deprecated-command.js (100%) delete mode 100644 lib/commands/deprecated/activate.js delete mode 100644 lib/commands/deprecated/assets.js delete mode 100644 lib/commands/deprecated/deploy-index.js delete mode 100644 lib/commands/deprecated/versions.js create mode 100644 lib/commands/discontinued-command.js delete mode 100644 lib/models/config.js rename lib/{utilities => models}/pipeline.js (96%) delete mode 100644 lib/tasks/activate.js delete mode 100644 lib/tasks/assets.js delete mode 100644 lib/tasks/deploy-index.js delete mode 100644 lib/tasks/list.js delete mode 100644 lib/utilities/adapter-registry.js delete mode 100644 lib/utilities/adapter.js delete mode 100644 lib/utilities/assets-uploader.js delete mode 100644 lib/utilities/assets/unknown.js delete mode 100644 lib/utilities/configuration-reader.js delete mode 100644 lib/utilities/deprecate.js delete mode 100644 lib/utilities/detect-deprecated-config.js delete mode 100644 lib/utilities/tagging/sha.js delete mode 100644 node-tests/unit/models/config-test.js rename node-tests/unit/{utilities => models}/pipeline-test.js (98%) delete mode 100644 node-tests/unit/tasks/assets-test.js delete mode 100644 node-tests/unit/utilities/adapter-registry-test.js delete mode 100644 node-tests/unit/utilities/assets-uploader-test.js delete mode 100644 node-tests/unit/utilities/assets/unknown-test.js delete mode 100644 node-tests/unit/utilities/configuration-reader-test.js delete mode 100644 node-tests/unit/utilities/tagging/sha-test.js diff --git a/.jshintrc b/.jshintrc index 08096eff..2ca6b930 100644 --- a/.jshintrc +++ b/.jshintrc @@ -28,5 +28,6 @@ "white": false, "eqnull": true, "esnext": true, - "unused": true + "unused": true, + "node": true } diff --git a/MIGRATION_STEPS.md b/MIGRATING_FROM_0_0_x_TO_0_4_x.md similarity index 100% rename from MIGRATION_STEPS.md rename to MIGRATING_FROM_0_0_x_TO_0_4_x.md diff --git a/blueprints/deploy-config/files/config/deploy.js b/blueprints/deploy-config/files/config/deploy.js index a66852c3..ad83ebab 100644 --- a/blueprints/deploy-config/files/config/deploy.js +++ b/blueprints/deploy-config/files/config/deploy.js @@ -1,36 +1,28 @@ /* jshint node: true */ -module.exports = function(environment) { - var ENV = {}; - - // if (environment === 'development') { - // ENV.store = { - // host: 'localhost', - // port: 6379 - // }; - // - // ENV.assets = { - // accessKeyId: '', - // secretAccessKey: '', - // bucket: '' - // }; - // } - // - // if (environment === 'staging') { - // ENV.buildEnv = 'staging'; - // - // ENV.store = { - // host: 'staging-redis.firstiwaslike.com', - // port: 6379 - // }; - // - // ENV.assets = { - // accessKeyId: '', - // secretAccessKey: '', - // bucket: '', - // prefix: '' - // }; - // } +module.exports = function(deployTarget) { + var ENV = { + build: {} + // include other plugin configuration that applies to all deploy targets here + }; + if (deployTarget === 'development') { + ENV.build.environment = 'development'; + // configure other plugins for development deploy target here + } + + if (deployTarget === 'staging') { + ENV.build.environment = 'production'; + // configure other plugins for staging deploy target here + } + + if (deployTarget === 'production') { + ENV.build.environment = 'production'; + // configure other plugins for production deploy target here + } + + // Note: if you need to build some configuration asynchronously, you can return + // a promise that resolves with the ENV object instead of returning the + // ENV object synchronously. return ENV; -} +}; diff --git a/config/deploy.js b/config/deploy.js deleted file mode 100644 index a3f8ea2e..00000000 --- a/config/deploy.js +++ /dev/null @@ -1,39 +0,0 @@ -module.exports = function(environment) { - var ENV = {}; - - if (environment === 'development') { - ENV.build = { - environment: 'development' - }; - ENV.store = { - host: 'localhost', - port: 6379 - }; - - ENV.assets = { - accessKeyId: '', - secretAccessKey: '', - bucket: '' - }; - } - - if (environment === 'staging') { - ENV.build = { - environment: 'production' - }; - - ENV.store = { - host: 'staging-redis.firstiwaslike.com', - port: 6379 - }; - - ENV.assets = { - accessKeyId: '', - secretAccessKey: '', - bucket: '', - prefix: '' - }; - } - - return ENV; -} diff --git a/index.js b/index.js index 92cceac7..c9019c9b 100644 --- a/index.js +++ b/index.js @@ -1,29 +1,8 @@ var path = require('path'); var commands = require('./lib/commands'); -var red = require('chalk').red; -var grey = require('chalk').grey; -var hasDeprecatedConfig = require('./lib/utilities/detect-deprecated-config'); - -if (hasDeprecatedConfig()) { - console.log(red('\n===========================================================================\n')); - - console.log(red('NOTICE TO USERS OF ember-cli-deploy VERSION <= 0.0.6\n\n')); - - console.log(grey('ember-cli/ember-cli-deploy') + red(' will now be using this npm module to host the\n')); - console.log(red('offial Ember CLI deployment tool.\n\n')); - - console.log(red('Due to the changes being made, you should migrate your project to use the\n')); - console.log(red('new module now.\n\n')); - - console.log(red('For more information on how to migrate from ') + grey('achambers/ember-cli-deploy') + red(' to ') + grey('ember-cli/ember-cli-deploy') + red(', please go to:\n\n')); - - console.log(red('https://github.com/ember-cli/ember-cli-deploy/blob/master/MIGRATION_STEPS.md')); - - console.log(red('\n===========================================================================\n')); -} function Deploy() { - this.name = "ember-cli-deploy" + this.name = 'ember-cli-deploy'; return this; } diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 4bcb1355..2813d4a2 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -13,7 +13,7 @@ module.exports = { ], run: function(commandOptions, rawArgs) { - commandOptions.deployTarget = rawArgs.shift() + commandOptions.deployTarget = rawArgs.shift(); process.env.DEPLOY_TARGET = commandOptions.deployTarget; var PipelineTask = require('../tasks/pipeline'); diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index b51f8131..f20c409c 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -16,7 +16,7 @@ module.exports = { ], run: function(commandOptions, rawArgs) { - commandOptions.deployTarget = rawArgs.shift() + commandOptions.deployTarget = rawArgs.shift(); process.env.DEPLOY_TARGET = commandOptions.deployTarget; var shouldActivate = this._shouldActivate(commandOptions); diff --git a/lib/commands/deprecated/deprecated-command.js b/lib/commands/deprecated-command.js similarity index 100% rename from lib/commands/deprecated/deprecated-command.js rename to lib/commands/deprecated-command.js diff --git a/lib/commands/deprecated/activate.js b/lib/commands/deprecated/activate.js deleted file mode 100644 index 7c42f0e9..00000000 --- a/lib/commands/deprecated/activate.js +++ /dev/null @@ -1,31 +0,0 @@ -var chalk = require('chalk'); -var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('silent-error'); -var DeprecatedCommand = require('./deprecated-command'); -var ActivateCommand = require('../activate'); - -module.exports = DeprecatedCommand({ - name: 'activate', - description: 'Activate a deployed version of index.html', - works: 'insideProject', - - anonymousOptions: [ - '' - ], - - availableOptions: [ - { name: 'environment', type: String, default: 'development' }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } - ], - - run: function (commandOptions, rawArgs) { - var key = rawArgs[0]; - if(!key) { - var message = chalk.yellow('The `ember activate` command requires a deploy version to be specified.'); - return Promise.reject(new SilentError(message)); - } - commandOptions.revision = key; - return ActivateCommand.run.apply(this, arguments); - } - -}); diff --git a/lib/commands/deprecated/assets.js b/lib/commands/deprecated/assets.js deleted file mode 100644 index 5ebc9eb0..00000000 --- a/lib/commands/deprecated/assets.js +++ /dev/null @@ -1,25 +0,0 @@ -var AssetsUploader = require('../../utilities/assets-uploader'); -var DeprecatedCommand = require('./deprecated-command'); - -module.exports = DeprecatedCommand({ - name: 'deploy:assets', - description: 'Deploys assets to an asset-host (default: aws:s3)', - works: 'insideProject', - - availableOptions: [ - { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } - ], - - run: function(commandOptions, rawArgs) { - var AssetsTask = require('../../tasks/assets'); - var assetsTask = new AssetsTask({ - ui: this.ui, - analytics: this.analytics, - project: this.project, - AssetsUploader: AssetsUploader - }); - - return assetsTask.run(commandOptions); - } -}); diff --git a/lib/commands/deprecated/deploy-index.js b/lib/commands/deprecated/deploy-index.js deleted file mode 100644 index 749dab36..00000000 --- a/lib/commands/deprecated/deploy-index.js +++ /dev/null @@ -1,23 +0,0 @@ -var DeprecatedCommand = require('./deprecated-command'); - -module.exports = DeprecatedCommand({ - name: 'deploy:index', - description: 'Deploys index to key-value store (default: redis)', - works: 'insideProject', - - availableOptions: [ - { name: 'environment', type: String, default: 'development', aliases: ['e',{'dev' : 'development'}, {'prod' : 'production'}] }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } - ], - - run: function(commandOptions, rawArgs) { - var DeployIndexTask = require('../../tasks/deploy-index'); - var deployIndexTask = new DeployIndexTask({ - ui: this.ui, - analytics: this.analytics, - project: this.project - }); - - return deployIndexTask.run(commandOptions); - } -}); diff --git a/lib/commands/deprecated/versions.js b/lib/commands/deprecated/versions.js deleted file mode 100644 index 902525f1..00000000 --- a/lib/commands/deprecated/versions.js +++ /dev/null @@ -1,15 +0,0 @@ -var DeprecatedCommand = require('./deprecated-command'); -var ListCommand = require('../list'); - -module.exports = DeprecatedCommand({ - name: 'deploy:versions', - description: 'Lists all versions of the app have been deployed', - works: 'insideProject', - - availableOptions: [ - { name: 'environment', type: String, default: 'development' }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } - ], - - run: ListCommand.run -}); diff --git a/lib/commands/discontinued-command.js b/lib/commands/discontinued-command.js new file mode 100644 index 00000000..3837608f --- /dev/null +++ b/lib/commands/discontinued-command.js @@ -0,0 +1,16 @@ +var chalk = require('chalk'); + +module.exports = function(name, description) { + return { + name: name, + description: chalk.red('[DISCONTNUED] ') + description, + works: 'insideProject', + + availableOptions: [], + + run: function(/* commandOptions, rawArgs */) { + var message = chalk.red('This command has been discontinued. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.\n'); + this.ui.writeLine(message, 'WARNING'); + } + }; +}; diff --git a/lib/commands/index.js b/lib/commands/index.js index 707d12a6..07c9c5a8 100644 --- a/lib/commands/index.js +++ b/lib/commands/index.js @@ -1,10 +1,11 @@ +var buildDiscontinuedCommand = require('./discontinued-command'); + module.exports = { - "deploy": require('./deploy'), - "deploy:activate": require('./activate'), - "deploy:list": require('./list'), + 'deploy': require('./deploy'), + 'deploy:activate': require('./activate'), + 'deploy:list': require('./list'), - "deploy:assets": require('./deprecated/assets'), - "deploy:index": require('./deprecated/deploy-index'), - "activate": require('./deprecated/activate'), - "deploy:versions": require('./deprecated/versions') + 'deploy:assets': buildDiscontinuedCommand('deploy:assets', 'deploy assets'), + 'deploy:index': buildDiscontinuedCommand('deploy:assets', 'deploy index'), + 'deploy:versions': buildDiscontinuedCommand('deploy:assets', 'list versions') }; diff --git a/lib/commands/list.js b/lib/commands/list.js index 51df5cd3..286daddd 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -13,7 +13,7 @@ module.exports = { ], run: function(commandOptions, rawArgs) { - commandOptions.deployTarget = rawArgs.shift() + commandOptions.deployTarget = rawArgs.shift(); process.env.DEPLOY_TARGET = commandOptions.deployTarget; var PipelineTask = require('../tasks/pipeline'); diff --git a/lib/models/config.js b/lib/models/config.js deleted file mode 100644 index 30623fcf..00000000 --- a/lib/models/config.js +++ /dev/null @@ -1,83 +0,0 @@ -var CoreObject = require('core-object'); - -function getPath(config, propertyPath) { - var parts = propertyPath.split('.'); - function read(node, part){ - if (node) { - return node[part]; - } else { - return undefined; - } - } - var node = config; - var part = parts.shift() - while (part !== undefined && part !== null) { - node = read(node, part); - part = parts.shift(); - } - return node; -} - -function setPath(config, propertyPath, value) { - var parts = propertyPath.split('.'); - var lastPropertyPath = parts.pop() - function read(node, part){ - if (node) { - return node[part]; - } else { - return undefined; - } - } - var node = config; - var part = parts.shift() - while (part !== undefined && part !== null) { - node = read(node, part); - part = parts.shift(); - } - node[lastPropertyPath] = value; -} - - -module.exports = CoreObject.extend({ - init: function() { - this._config = this.rawConfig; - this._defaultPropertyPaths = { - 'assets.gzip': true, - 'assets.gzipExtensions': ['js', 'css', 'svg'], - 'assets.type': 's3', - 'assets.exclude': [], - 'build.environment': 'production', - 'buildPath': 'tmp/deploy-dist/', - 'manifestPrefix': this.project.name(), - 'store.manifestSize': 10, - 'store.type': 'redis', - 'indexFiles': null, - 'tagging': 'sha' - }; - }, - - // This is a temporary method to preserve an API where we are giving an - // adapter a reference to the whole, raw config as a POJO. Remove it - // once we move away from that - _materialize: function(){ - var materialized = JSON.parse(JSON.stringify(this._config)); - var defaultPropertyPaths = this._defaultPropertyPaths; - Object.keys(defaultPropertyPaths).forEach(function(propertyPath){ - if (!getPath(materialized, propertyPath)) { - setPath(materialized, propertyPath, defaultPropertyPaths[propertyPath]); - } - }); - return materialized; - }, - get: function(propertyPath) { - var configValue = getPath(this._config, propertyPath); - if (configValue === undefined) { - return this.defaultFor(propertyPath); - } else { - return configValue; - } - }, - defaultFor: function(propertyPath) { - return this._defaultPropertyPaths[propertyPath]; - } -}); diff --git a/lib/utilities/pipeline.js b/lib/models/pipeline.js similarity index 96% rename from lib/utilities/pipeline.js rename to lib/models/pipeline.js index c59d9f05..83e95cd3 100644 --- a/lib/utilities/pipeline.js +++ b/lib/models/pipeline.js @@ -6,7 +6,6 @@ var _ = require('lodash-node'); var chalk = require('chalk'); var blue = chalk.blue; var red = chalk.red; -var grey = chalk.grey; /* This is a generic implementation of a pipeline with ordered, promise-aware hooks, * pleasant logging, and failure handling. It should not have any "deployment" domain @@ -82,12 +81,12 @@ Pipeline.prototype._hooksWithoutDidFail = function(hooks) { Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { ui.write(red('|\n')); ui.write(red('+- didFail\n')); - ui.write(red(error + "\n" + (error ? error.stack : null))); + ui.write(red(error + '\n' + (error ? error.stack : null))); return this._executeHook('didFail', context) .then(Promise.reject.bind(this, error)); }; -Pipeline.prototype._abortPipelineExecution = function(ui, error) { +Pipeline.prototype._abortPipelineExecution = function(ui/*, error */) { ui.write(blue('|\n')); ui.write(red('Pipeline aborted\n')); return Promise.reject(); diff --git a/lib/tasks/activate.js b/lib/tasks/activate.js deleted file mode 100644 index b0bee22a..00000000 --- a/lib/tasks/activate.js +++ /dev/null @@ -1,36 +0,0 @@ -var chalk = require('chalk'); -var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../utilities/configuration-reader'); -var AdapterRegistry = require('../utilities/adapter-registry'); -var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('silent-error'); - -var white = chalk.white; -var green = chalk.green; - -module.exports = Task.extend({ - run: function(options) { - var self = this; - var ui = this.ui; - var revision = options.revision; - return new ConfigurationReader({ - environment: options.environment, - configFile: options.deployConfigFile, - project: this.project, - ui: ui - }).read().then(function(config){ - var adapterType = config.get('store.type'); - var Adapter = new AdapterRegistry({ project: self.project }) - .lookup('index', adapterType); - - var deploy = new Adapter({ - config: config.get('store'), - manifest: self.project.name(), - manifestSize: config.get('store.manifestSize'), - ui: ui - }); - - return deploy.activate(revision); - }); - } -}); diff --git a/lib/tasks/assets.js b/lib/tasks/assets.js deleted file mode 100644 index 2f407f33..00000000 --- a/lib/tasks/assets.js +++ /dev/null @@ -1,105 +0,0 @@ -var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../utilities/configuration-reader'); -var Promise = require('ember-cli/lib/ext/promise'); -var fs = require('fs'); -var path = require('path'); -var rimraf = Promise.denodeify(require('rimraf')); -var glob = Promise.denodeify(require('glob')); -var mkdirp = require('mkdirp'); - -module.exports = Task.extend({ - run: function(options) { - var broccoli = require('broccoli'); - - var self = this; - return this.readConfiguration(options.environment, options.deployConfigFile).then(function(config){ - var fileTreeOrPath; - if (config.get('assets.gzip') === false) { - fileTreeOrPath = 'dist'; - } else { - var gzipFiles = require('broccoli-gzip'); - - fileTreeOrPath = gzipFiles('dist', { - extensions: config.get('assets.gzipExtensions'), - appendSuffix: false - }); - } - - var builder = new broccoli.Builder(fileTreeOrPath); - - return builder.build() - .then(self.processBuildResult.bind(self)) - .then(self.uploadAssets.bind(self, options.environment, options.deployConfigFile)) - .then(function() { - builder.cleanup(); - }); - }); - }, - - readConfiguration: function(environment, configFile){ - var self = this; - return new ConfigurationReader({ - environment: environment, - configFile: configFile, - project: this.project, - ui: this.ui - }).read() - }, - - uploadAssets: function(environment, configFile) { - var self = this; - return this.readConfiguration(environment, configFile).then(function(config){ - var AssetsUploader = this.AssetsUploader; - var assetsUploader = new AssetsUploader({ - ui: self.ui, - config: config._materialize(), - type: config.get('assets.type'), - project: self.project - }); - - return assetsUploader.upload(); - }); - }, - - processBuildResult: function(config, results) { - return this.clearOutputPath('tmp/assets-sync/') - .then(function() { - return this.copyToOutputPath(results.directory, 'tmp/assets-sync/'); - }.bind(this)).then(function(){ - return this.deleteExcluded('tmp/assets-sync/', config); - }.bind(this)); - }, - - clearOutputPath: function(outputPath) { - if (!fs.existsSync(outputPath)) { return Promise.resolve(); } - - var entries = fs.readdirSync(outputPath); - return Promise.map(entries, function(entry){ - return rimraf(path.join(outputPath, entry)); - }); - }, - - copyToOutputPath: function(inputPath, outputPath) { - if (!fs.existsSync(outputPath)) { - mkdirp.sync(outputPath); - } - - return ncp(inputPath, outputPath, { - dereference: true, - clobber: true, - stopOnErr: true, - limit: 2 - }); - }, - - deleteExcluded: function(dir, config){ - var exclusions = config.get('assets.exclude'); - return Promise.map(exclusions, function(exclusion){ - return glob(exclusion, { cwd: dir, matchBase: true }).then(function(entries){ - return Promise.map(entries, function(entry) { - return rimraf(path.join(dir, entry)); - }); - }); - }); - } -}); diff --git a/lib/tasks/deploy-index.js b/lib/tasks/deploy-index.js deleted file mode 100644 index 1af9d215..00000000 --- a/lib/tasks/deploy-index.js +++ /dev/null @@ -1,64 +0,0 @@ -var ConfigurationReader = require('../utilities/configuration-reader'); -var AdapterRegistry = require('../utilities/adapter-registry'); -var Promise = require('ember-cli/lib/ext/promise'); -var Task = require('ember-cli/lib/models/task'); -var chalk = require('chalk'); -var fs = require('fs'); - -var readFile = Promise.denodeify(fs.readFile); - -module.exports = Task.extend({ - run: function(options) { - var self = this; - var ui = this.ui; - return new ConfigurationReader({ - environment: options.environment, - configFile: options.deployConfigFile, - project: this.project, - ui: ui - }).read().then(function(config){ - var adapterType = config.get('store.type'); - var taggingAdapterType = config.get('tagging'); - var manifest = config.get('manifestPrefix'); - - var adapterRegistry = new AdapterRegistry({ project: self.project }); - - var Adapter = adapterRegistry - .lookup('index', adapterType); - - var TaggingAdapter = adapterRegistry - .lookup('tagging', taggingAdapterType) - - var taggingAdapter = new TaggingAdapter({ - manifest: manifest - }); - - var deploy = new Adapter({ - config: config.get('store'), - manifest: manifest, - manifestSize: config.get('store.manifestSize'), - taggingAdapter: taggingAdapter, - ui: ui - }); - - return readFile('dist/index.html') - .then(function(fileContent) { - ui.writeLine(chalk.blue('\nTrying to upload `dist/index.html`...\n')); - return deploy.upload(fileContent); - }); - }); - - var indexFiles = config.get('indexFiles'); - - if(indexFiles) { - ui.writeLine(chalk.blue('\nUploading '+indexFiles.length+' files from `'+config.get('buildPath')+'`...\n')); - return deploy.uploadFiles(indexFiles); - } else { - return readFile(config.get('buildPath')+'index.html') - .then(function(fileContent) { - ui.writeLine(chalk.blue('\nUploading `'+config.get('buildPath')+'index.html`...\n')); - return deploy.upload(fileContent); - }); - } - } -}); diff --git a/lib/tasks/list.js b/lib/tasks/list.js deleted file mode 100644 index 1f357a88..00000000 --- a/lib/tasks/list.js +++ /dev/null @@ -1,30 +0,0 @@ -var chalk = require('chalk'); -var Task = require('ember-cli/lib/models/task'); -var ConfigurationReader = require('../utilities/configuration-reader'); -var AdapterRegistry = require('../utilities/adapter-registry'); - -module.exports = Task.extend({ - run: function(options) { - var ui = this.ui; - var project = this.project; - return new ConfigurationReader({ - environment: options.environment, - configFile: options.deployConfigFile, - project: this.project, - ui: ui - }).read().then(function(config){ - var adapterType = config.get('store.type'); - var Adapter = new AdapterRegistry({ project: project }) - .lookup('index', adapterType); - - var deploy = new Adapter({ - config: config.get('store'), - manifest: config.get('manifestPrefix'), - manifestSize: config.get('store.manifestSize'), - ui: ui - }); - - return deploy.list(); - }); - } -}); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 82a327e8..baf2cedb 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -6,7 +6,7 @@ var existsSync = require('fs').existsSync; var path = require('path'); var dotenv = require('dotenv'); -var Pipeline = require('../utilities/pipeline'); +var Pipeline = require('../models/pipeline'); module.exports = Task.extend({ init: function() { @@ -89,7 +89,7 @@ module.exports = Task.extend({ registry[this._pluginNameFromAddonName(addon)] = addon; }, - run: function(hooks) { + run: function() { var self = this; var pipeline = this._pipeline; var ui = this.ui; @@ -146,7 +146,6 @@ module.exports = Task.extend({ }, _registerPipelineHooks: function(addon, alias) { - var self = this; var deployPlugin = addon.createDeployPlugin({name: alias}); this._pipeline.hookNames().forEach(function(hookName) { @@ -172,8 +171,7 @@ module.exports = Task.extend({ }, _isValidDeployPlugin: function(addon) { - return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin') - && this._addonImplementsDeploymentHooks(addon); + return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin') && this._addonImplementsDeploymentHooks(addon); }, _addonHasKeyword: function(addon, keyword) { diff --git a/lib/utilities/adapter-registry.js b/lib/utilities/adapter-registry.js deleted file mode 100644 index ac5c6573..00000000 --- a/lib/utilities/adapter-registry.js +++ /dev/null @@ -1,40 +0,0 @@ -var CoreObject = require('core-object'); -var UnknownAdapter = require('./assets/unknown'); -var ShaAdapter = require('./tagging/sha'); -var merge = require('lodash-node/modern/objects/merge'); - -module.exports = CoreObject.extend({ - init: function() { - if (!this.project) { return; } - - this.project.addons.forEach(this._mergeDeployAdapters.bind(this)); - }, - - lookup: function(type, adapterName) { - var Adapter = this.adapters[type][adapterName]; - - if (!Adapter) { - return UnknownAdapter; - } else { - return Adapter; - } - }, - - adapters: { - index: { - }, - - assets: { - }, - - tagging: { - "sha": ShaAdapter - } - }, - - _mergeDeployAdapters: function(addon) { - if (addon.type === 'ember-deploy-addon') { - this.adapters = merge(this.adapters, addon.adapters); - } - } -}); diff --git a/lib/utilities/adapter.js b/lib/utilities/adapter.js deleted file mode 100644 index dd879827..00000000 --- a/lib/utilities/adapter.js +++ /dev/null @@ -1,12 +0,0 @@ -var CoreObject = require('core-object'); -var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('silent-error'); - -module.exports = CoreObject.extend({ - upload: function() { - var message = 'You have to implement the `upload` method in a subclass ' + - 'of Adapter!'; - - return Promise.reject(new SilentError(message)); - } -}); diff --git a/lib/utilities/assets-uploader.js b/lib/utilities/assets-uploader.js deleted file mode 100644 index 56b4cc2d..00000000 --- a/lib/utilities/assets-uploader.js +++ /dev/null @@ -1,22 +0,0 @@ -var CoreObject = require('core-object'); -var AdapterRegistry = require('./adapter-registry'); - -module.exports = CoreObject.extend({ - init: function() { - var adapterRegistry = new AdapterRegistry({ - project: this.project - }); - var adapterName = this.type; - var Adapter = adapterRegistry.lookup('assets', adapterName); - - this.adapter = new Adapter({ - name: adapterName, - ui: this.ui, - config: this.config - }); - }, - - upload: function() { - return this.adapter.upload(); - } -}); diff --git a/lib/utilities/assets/unknown.js b/lib/utilities/assets/unknown.js deleted file mode 100644 index e546ca4a..00000000 --- a/lib/utilities/assets/unknown.js +++ /dev/null @@ -1,16 +0,0 @@ -var Adapter = require('../adapter'); -var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('silent-error'); - -var errorMessage = function() { - var errorMessage = 'You tried to use an unknown adapter: `' + this.name + - '`. Please pass a supported adapter-type.'; - return Promise.reject(new SilentError(errorMessage)); -} - -module.exports = Adapter.extend({ - upload: errorMessage, - activate: errorMessage, - list: errorMessage, - createTag: errorMessage -}); diff --git a/lib/utilities/configuration-reader.js b/lib/utilities/configuration-reader.js deleted file mode 100644 index eb66c9f3..00000000 --- a/lib/utilities/configuration-reader.js +++ /dev/null @@ -1,40 +0,0 @@ -var path = require('path'); -var deprecate = require('./deprecate'); -var Config = require('../models/config'); -var SilentError = require('silent-error'); -var Promise = require('ember-cli/lib/ext/promise'); -var CoreObject = require('core-object'); - -module.exports = CoreObject.extend({ - init: function() { - var root = process.cwd(); - this.defaultConfigPath = path.join('config', 'deploy.js'); - var environmentConfig; - this.environment = this.environment || 'development'; - this.configFile = this.configFile || this.defaultConfigPath; - this.pathToConfig = path.join(root, this.configFile); - }, - read: function(){ - var self = this; - var configResult; - try { - configResult = require(this.pathToConfig)(this.environment); - } catch(e) { - this.ui.writeError(e); - return Promise.reject(new Error('Cannot load configuration file \'' + this.pathToConfig + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ self.defaultConfigPath + '\'')); - } - - return Promise.resolve(configResult).then(function(config){ - if (!Object.keys(config).length) { - throw new SilentError('You are using the `' + self.environment + '` environment but have not specified any configuration.' + - '\n\nPlease add a `' + self.environment + '` section to your `config/deploy.js` file.' + - '\n\nFor more information, go to: `https://github.com/ember-cli/ember-cli-deploy#config-file`'); - } - return new Config({ - project: self.project, - rawConfig: config - }); - }); - } -}); - diff --git a/lib/utilities/deprecate.js b/lib/utilities/deprecate.js deleted file mode 100644 index f1bdd02a..00000000 --- a/lib/utilities/deprecate.js +++ /dev/null @@ -1,9 +0,0 @@ -'use strict'; - -var chalk = require('chalk'); - -module.exports = function(message, test, ui) { - if (!test) { return; } - - ui.writeLine(chalk.yellow('DEPRECATION: ' + message)); -}; diff --git a/lib/utilities/detect-deprecated-config.js b/lib/utilities/detect-deprecated-config.js deleted file mode 100644 index 9450b48d..00000000 --- a/lib/utilities/detect-deprecated-config.js +++ /dev/null @@ -1,8 +0,0 @@ -var path = require('path'); -var glob = require('glob'); - -module.exports = function() { - var deprecatedConfigPath = path.join(__dirname, '../../../..', 'config', 'deploy', '*.js'); - var files = glob.sync(deprecatedConfigPath); - return files.length > 0; -}; diff --git a/lib/utilities/tagging/sha.js b/lib/utilities/tagging/sha.js deleted file mode 100644 index 8f8766f9..00000000 --- a/lib/utilities/tagging/sha.js +++ /dev/null @@ -1,17 +0,0 @@ -var CoreObject = require('core-object'); - -module.exports = CoreObject.extend({ - init: function() { - this.syncExec = this.syncExec || require('sync-exec'); - }, - - createTag: function() { - var commandResult = this.syncExec("git rev-parse HEAD").stdout; - return this._generateKey(commandResult); - }, - - _generateKey: function(sha) { - this.revisionKey = this.manifest + ':' + sha.slice(0,7); - return this.revisionKey; - } -}); diff --git a/node-tests/unit/models/config-test.js b/node-tests/unit/models/config-test.js deleted file mode 100644 index 7beffe2b..00000000 --- a/node-tests/unit/models/config-test.js +++ /dev/null @@ -1,122 +0,0 @@ -var Config = require('../../../lib/models/config'); -var expect = require('chai').expect; - -describe('Config', function() { - function createConfig(projectName, configJson) { - return new Config({ - project: { name: function(){ return projectName; } }, - rawConfig: configJson - }); - } - - describe('manifestPrefix', function(){ - it('defaults to project name', function() { - var config = createConfig('tomster', {}); - expect(config.get('manifestPrefix')).to.eq('tomster'); - }); - - it('allows configuration', function() { - var config = createConfig('tomster', { manifestPrefix: 'seldenator' }); - expect(config.get('manifestPrefix')).to.eq('seldenator'); - }); - }); - - describe('buildEnv', function(){ - it('defaults to production', function() { - var config = createConfig('tomster', {}); - expect(config.get('build.environment')).to.eq('production'); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { build: { environment: 'chocula' } }); - expect(config.get('build.environment')).to.eq('chocula'); - }); - }); - - describe('buildPath', function(){ - it('defaults to tmp/deploy-dist/', function() { - var config = createConfig('tomster', {}); - expect(config.get('buildPath')).to.eq('tmp/deploy-dist/'); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { buildPath: 'hamsterwheel' }); - expect(config.get('buildPath')).to.eq('hamsterwheel'); - }); - }); - - describe('store.type', function(){ - it('defaults to redis', function() { - var config = createConfig('tomster', {}); - expect(config.get('store.type')).to.eq('redis'); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { store: { type: 'cassandra' } }); - expect(config.get('store.type')).to.eq('cassandra'); - }); - }); - - describe('store.manifestSize', function(){ - it('defaults to 10', function() { - var config = createConfig('tomster', {}); - expect(config.get('store.manifestSize')).to.eq(10); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { store: { manifestSize: 42 } }); - expect(config.get('store.manifestSize')).to.eq(42); - }); - }); - - describe('assets.type', function(){ - it('defaults to s3', function() { - var config = createConfig('tomster', {}); - expect(config.get('assets.type')).to.eq('s3'); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { assets: { type: 'akamai' } }); - expect(config.get('assets.type')).to.eq('akamai'); - }); - }); - - describe('assets.gzip', function(){ - it('defaults to true', function() { - var config = createConfig('tomster', {}); - expect(config.get('assets.gzip')).to.eq(true); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { assets: { gzip: false } }); - expect(config.get('assets.gzip')).to.eq(false); - }); - }); - - describe('assets.gzipExtensions', function(){ - it('defaults to js,css,svg', function() { - var config = createConfig('tomster', {}); - expect(config.get('assets.gzipExtensions')).to.deep.equal(['js', 'css', 'svg']); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { assets: { gzipExtensions: ['js', 'css'] } }); - expect(config.get('assets.gzipExtensions')).to.deep.equal(['js', 'css']); - }); - }); - - describe('assets.exclude', function(){ - it('defaults to empty array', function() { - var config = createConfig('tomster', {}); - expect(config.get('assets.exclude')).to.deep.equal([]); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { assets: { exclude: ['.DS_Store'] } }); - expect(config.get('assets.exclude')).to.deep.equal(['.DS_Store']); - }); - }); - - describe('tagging', function(){ - it('defaults to sha', function() { - var config = createConfig('tomster', {}); - expect(config.get('tagging')).to.equal('sha'); - }); - it('allows configuration', function() { - var config = createConfig('tomster', { tagging: 'yapp-custom' }); - expect(config.get('tagging')).to.equal('yapp-custom'); - }); - }); -}); diff --git a/node-tests/unit/utilities/pipeline-test.js b/node-tests/unit/models/pipeline-test.js similarity index 98% rename from node-tests/unit/utilities/pipeline-test.js rename to node-tests/unit/models/pipeline-test.js index fc27f273..1a40df03 100644 --- a/node-tests/unit/utilities/pipeline-test.js +++ b/node-tests/unit/models/pipeline-test.js @@ -1,5 +1,5 @@ var Promise = require('ember-cli/lib/ext/promise'); -var Pipeline = require('../../../lib/utilities/pipeline'); +var Pipeline = require('../../../lib/models/pipeline'); var expect = require('../../helpers/expect'); diff --git a/node-tests/unit/tasks/assets-test.js b/node-tests/unit/tasks/assets-test.js deleted file mode 100644 index 1d0813d1..00000000 --- a/node-tests/unit/tasks/assets-test.js +++ /dev/null @@ -1,75 +0,0 @@ -var CoreObject = require('core-object'); -var AssetsTask = require('../../../lib/tasks/assets'); -var MockUI = require('ember-cli/tests/helpers/mock-ui'); -var expect = require('chai').expect; -var Promise = require('ember-cli/lib/ext/promise'); -var path = require('path'); -var mkdirp = require('mkdirp'); -var fs = require('fs'); -var rimraf = Promise.denodeify(require('rimraf')); -var existsSync = path.existsSync || fs.existsSync; //renaned in node 0.12 - -describe('AssetsTask', function() { - var ui, project, MockAssetsUploader, mockAssetsUploaderConfig; - - beforeEach(function() { - mockAssetsUploaderConfig = null; - ui = new MockUI(); - project = { name: function(){ return 'foo'; }} - MockAssetsUploader = CoreObject.extend({ - init: function() { - mockAssetsUploaderConfig = this.config; - }, - upload: function(){} - }) - }); - describe('#uploadAssets', function(){ - it('receives a POJO config object (which is a bad idea and we should change this API)', function() { - var task = new AssetsTask({ - ui: ui, - AssetsUploader: MockAssetsUploader, - project: project - }); - task.uploadAssets('development', 'config/deploy.js').then(function(){ - expect(mockAssetsUploaderConfig.assets).to.be.exist; - expect(mockAssetsUploaderConfig.assets.bucket).to.equal(''); - expect(mockAssetsUploaderConfig.assets.type).to.equal('s3'); - }); - }); - }); - describe('#deleteExcluded', function () { - it('deletes files matching exclude globs from specified dir', function() { - var task = new AssetsTask({ - ui: ui, - AssetsUploader: MockAssetsUploader, - project: project - }); - var mockConfig = { - get: function(key){ - if (key === 'assets.exclude') { - return [".DS_Store", "foo-*"]; - } - } - }; - var root = process.cwd(); - var dir = path.join(root, 'tmp-delete-excluded-test'); - var subdir = path.join(dir, 'subdir'); - mkdirp.sync(dir); - mkdirp.sync(subdir); - ['keep.me', '.DS_Store', 'foo-bar.js'].forEach(function(fileName){ - fs.closeSync(fs.openSync(path.join(dir, fileName), 'w')); - fs.closeSync(fs.openSync(path.join(subdir, fileName), 'w')); - }); - return task.deleteExcluded(dir, mockConfig).then(function(){ - expect(existsSync(path.join(dir, 'keep.me'))).to.equal(true); - expect(existsSync(path.join(subdir, 'keep.me'))).to.equal(true); - expect(existsSync(path.join(dir, '.DS_Store'))).to.equal(false); - expect(existsSync(path.join(subdir, '.DS_Store'))).to.equal(false); - expect(existsSync(path.join(dir, 'foo-bar.js'))).to.equal(false); - expect(existsSync(path.join(subdir, 'foo-bar.js'))).to.equal(false); - }).finally(function(){ - return rimraf(dir); - }); - }); - }); -}); diff --git a/node-tests/unit/utilities/adapter-registry-test.js b/node-tests/unit/utilities/adapter-registry-test.js deleted file mode 100644 index e35c9122..00000000 --- a/node-tests/unit/utilities/adapter-registry-test.js +++ /dev/null @@ -1,87 +0,0 @@ -/* jshint expr:true */ -var Adapter = require('../../../lib/utilities/adapter'); -var AdapterRegistry = require('../../../lib/utilities/adapter-registry'); -var UnknownAdapter = require('../../../lib/utilities/assets/unknown'); -var expect = require('chai').expect; - -var MockRedisAdapter = Adapter.extend(); -var MockS3Adapter = Adapter.extend(); - -var bundledAdapters; - -describe('AdapterRegistry', function() { - beforeEach(function() { - bundledAdapters = { - index: { - redis: MockRedisAdapter - }, - - assets: { - s3: MockS3Adapter - } - }; - }); - - describe('lookup', function() { - it('looks up adapters by type and name', function() { - var adapterRegistry = new AdapterRegistry({ - adapters: bundledAdapters - }); - - var IndexAdapter = adapterRegistry.lookup('index', 'redis'); - - expect(IndexAdapter).to.eq(MockRedisAdapter); - }); - - it('returns the `UnknownAdapter` for unknown adapter types', function() { - var adapterRegistry = new AdapterRegistry(); - - expect(adapterRegistry.lookup('index', 'trolol')).to.eq(UnknownAdapter); - }); - }); - - describe('adapters can be added via addons', function() { - it('registers adapters via the project addons', function() { - var MockAdapterA = Adapter.extend(); - var MockAdapterB = Adapter.extend(); - var project = { - addons: [ - { - type: 'ember-deploy-addon', - adapters: { - index: { - "a": MockAdapterA - }, - assets: { - "b": MockAdapterB - } - } - } - ] - }; - - var adapterRegistry = new AdapterRegistry({ - project: project, - adapters: bundledAdapters - }); - - expect(adapterRegistry.adapters.index).to.have.keys(['redis', 'a']); - expect(adapterRegistry.adapters.assets).to.have.keys(['s3', 'b']); - }); - - it('does not break when addons bundle no adapters', function() { - var project = { - addons: [ - { type: 'ember-deploy-addon' } - ] - }; - - var adapterRegistry = new AdapterRegistry({ - project: project, - adapters: bundledAdapters - }); - - expect(adapterRegistry.adapters).to.exist; - }); - }); -}); diff --git a/node-tests/unit/utilities/assets-uploader-test.js b/node-tests/unit/utilities/assets-uploader-test.js deleted file mode 100644 index fb2572f1..00000000 --- a/node-tests/unit/utilities/assets-uploader-test.js +++ /dev/null @@ -1,13 +0,0 @@ -var UnknownAdapter = require('../../../lib/utilities/assets/unknown'); -var AssetsUploader = require('../../../lib/utilities/assets-uploader'); -var expect = require('chai').expect; - -describe('AssetsUploader', function() { - it('uses the UnknownAdapter when an unknown adapter is passed', function() { - var uploader = new AssetsUploader({ - type: 'trolololol' - }); - - expect(uploader.adapter.constructor).to.eq(UnknownAdapter); - }); -}); diff --git a/node-tests/unit/utilities/assets/unknown-test.js b/node-tests/unit/utilities/assets/unknown-test.js deleted file mode 100644 index 9e0054f6..00000000 --- a/node-tests/unit/utilities/assets/unknown-test.js +++ /dev/null @@ -1,24 +0,0 @@ -var chai = require('chai'); -var chaiAsPromised = require('chai-as-promised'); -var UnknownAdapter = require('../../../../lib/utilities/assets/unknown'); - -chai.use(chaiAsPromised); - -var expect = chai.expect; - -var methodTest = function(adapter, method) { - return function() { - it('rejects to print out an error message', function() { - expect(adapter[method]()).to.be.rejected; - }); - }; -} - -describe('UnknownAdapter', function() { - var adapter = new UnknownAdapter(); - - describe('#upload', methodTest(adapter, "upload")); - describe('#activate', methodTest(adapter, "activate")); - describe('#list', methodTest(adapter, "list")); - describe('#createTag', methodTest(adapter, "createTag")); -}); diff --git a/node-tests/unit/utilities/configuration-reader-test.js b/node-tests/unit/utilities/configuration-reader-test.js deleted file mode 100644 index 36334d14..00000000 --- a/node-tests/unit/utilities/configuration-reader-test.js +++ /dev/null @@ -1,173 +0,0 @@ -var ConfigurationReader = require('../../../lib/utilities/configuration-reader'); -var expect = require('chai').expect; -var path = require('path'); -var MockUI = require('ember-cli/tests/helpers/mock-ui'); -var Promise = require('ember-cli/lib/ext/promise'); -var EOL = require('os').EOL; -var chalk = require('chalk'); - -describe('ConfigurationReader', function() { - var ui, project; - - beforeEach(function() { - ui = new MockUI(); - project = { name: function(){ return 'foo'; }} - }); - - describe('environment settings', function() { - it('knows about its passed environment', function() { - var reader = new ConfigurationReader({ - environment: 'staging', - ui: ui, - project: project - }); - - expect(reader.environment).to.equal('staging'); - }); - - it('`development` is default when no environment is passed', function() { - var reader = new ConfigurationReader({ - ui: ui, - project: project - }); - - expect(reader.environment).to.equal('development'); - }); - }); - - describe('configuration settings', function() { - it('throws an error when passed a json deploy-config-file', function() { - var configPath = './node-tests/fixtures/config/deploy.json'; - var root = process.cwd(); - var fixtureConfigPath = path.join(root, configPath); - var expectedConfig = require(fixtureConfigPath); - - return new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }).read().then(function(){ - expect(false).to.equal(true); - }, function(err){ - expect(err.message).to.match(/Cannot load configuration file/); - }); - }); - - it('reads a passed js deploy-config-file if one is passed', function() { - var configPath = './node-tests/fixtures/config/deploy.js'; - var root = process.cwd(); - var fixtureConfigPath = path.join(root, configPath); - var expectedConfig = require(fixtureConfigPath)('development'); - - return new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }).read().then(function(config){ - expect(config._config).to.eql(expectedConfig); - }); - }); - - it('uses `./config/deploy.js` as default when no config is passed', function() { - var root = process.cwd(); - var expectedConfig = require(path.join(root, './config/deploy.js'))('development'); - - return new ConfigurationReader({ - ui: ui, - project: project - }).read().then(function(config){ - expect(config._config).to.eql(expectedConfig) - }); - - }); - - it('raises an error in the case of a passed deploy-config-file that doesn\'t exist', function() { - var configPath = './node-tests/fixtures/config/does-not-exist.js'; - var root = process.cwd(); - return new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project - }).read().then(function(){ - expect(false).to.equal(true); - }, function(err){ - expect(err.message).to.equal('Cannot load configuration file \'' + path.join(root, configPath) + '\'. Note that the default location of the ember-cli-deploy config file is now \''+ path.join('config', 'deploy.js')+'\''); - }); - }); - - it('raises an error if a config doesn\'t exist for the current environment', function() { - var configPath = './node-tests/fixtures/config/deploy.js'; - return new ConfigurationReader({ - configFile: configPath, - ui: ui, - project: project, - environment: 'non-existent-env' - }).read().then(function(){ - expect(false).to.equal(true); - }, function(err){ - expect(err.message).to.match(/You are using the `non-existent-env` environment/); - }); - }); - }); - - describe('store settings', function() { - it('proxies the store settings for the passed environment', function() { - var ENVs = ['development', 'staging']; - var root = process.cwd(); - var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - - return Promise.map(ENVs, function(env) { - var expected = cfgFile(env).store; - - return new ConfigurationReader({ - environment: env, - ui: ui, - project: project - }).read().then(function(config){ - expect(config.get('store')).to.deep.equal(expected); - }); - }); - }); - }); - - describe('assets settings', function() { - it('proxies the asset setting for the passed environment', function() { - var ENVs = ['development', 'staging']; - var root = process.cwd(); - var cfgFile = require(path.join(root, './node-tests/fixtures/config/deploy.js')); - - return Promise.map(ENVs, function(env) { - var expected = cfgFile(env).assets; - - return new ConfigurationReader({ - environment: env, - ui: ui, - project: project - }).read().then(function(config){ - expect(config.get('assets')).to.deep.equal(expected); - }); - }); - }); - }); - - describe('materialized settings', function() { - it('proxies the materialized settings for the passed environment', function() { - var ENVs = ['development', 'staging']; - var root = process.cwd(); - var cfgFile = require(path.join(root, './node-tests/fixtures/config-with-defaults/deploy.js')); - - return Promise.map(ENVs, function(ENV) { - var expected = cfgFile[ENV]; - - return new ConfigurationReader({ - environment: ENV, - ui: ui, - project: project - }).read().then(function(config){ - expect(config._materialize()).to.deep.equal(expected); - }); - }); - }); - }) - -}); diff --git a/node-tests/unit/utilities/tagging/sha-test.js b/node-tests/unit/utilities/tagging/sha-test.js deleted file mode 100644 index af601800..00000000 --- a/node-tests/unit/utilities/tagging/sha-test.js +++ /dev/null @@ -1,28 +0,0 @@ -var expect = require('chai').expect; -var ShaTaggingAdapter = require('../../../../lib/utilities/tagging/sha'); - -var getShortShaVersion = function(sha) { - return sha.slice(0,7); -}; - -var GIT_SHA = '04b724a6c656a21795067f9c344d22532cf593ae'; -var GIT_SHA_SHORTENED = getShortShaVersion(GIT_SHA); - -describe('ShaTaggingAdapter', function() { - var mockSyncExec = function(){ - return {stdout: GIT_SHA}; - } - - describe('#createTag', function() { - it('returns a tag based on current git-sha and manifestName', function() { - var manifestName = 'ember-cli-deploy'; - var expectedTag = manifestName + ':' + GIT_SHA_SHORTENED; - var revisionTagger = new ShaTaggingAdapter({ - manifest: manifestName, - syncExec: mockSyncExec - }); - - expect(revisionTagger.createTag()).to.eq(expectedTag); - }); - }); -}); From d1ede8a669564c803c44aab6ce53c4fecfc470c3 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 10 Aug 2015 09:40:11 -0400 Subject: [PATCH 153/300] Update plugins.md doc to reflect that aliases have landed --- rfc/plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfc/plugins.md b/rfc/plugins.md index 4ecbcc69..5cd39a41 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -191,7 +191,7 @@ plugins: ["s3-assets", "s3-index", "notify-slack"] Any plugins not included in the list will not have their hooks executed. -#### Aliasing plugins (probably post-0.5.0) +#### Aliasing plugins To include a plugin twice, alias it using a colon. From 59bfc4347a7ba15f5769bf1e664d102a5b58b3d4 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 27 Aug 2015 19:05:33 +0100 Subject: [PATCH 154/300] Remove modifying fingerprint options on `included` hook It was decided that until we can pluginerize asset-rev, we should continue to set broccoli-asset-rev options in the Brocfile.js --- index.js | 27 --------------------------- package.json | 3 +-- 2 files changed, 1 insertion(+), 29 deletions(-) diff --git a/index.js b/index.js index b992e6bd..d8841b32 100644 --- a/index.js +++ b/index.js @@ -14,31 +14,4 @@ Deploy.prototype.blueprintsPath = function() { return path.join(__dirname, 'blueprints'); }; -Deploy.prototype.included = function(app) { - var deployEnv = this._deployTargetSetByDeployCommand(); - var root = app.project.root; - var configPath = path.join(root, 'config', 'deploy'); - var config; - var fingerprint; - - if (deployEnv) { - config = require(configPath)(deployEnv); - - if (config.fingerprint === false) { - app.options.fingerprint = {enabled: false}; - } else { - fingerprint = config.fingerprint || {}; - app.options.fingerprint = app.options.fingerprint || {}; - - for (var option in fingerprint) { - app.options.fingerprint[option] = fingerprint[option]; - } - } - } -}; - -Deploy.prototype._deployTargetSetByDeployCommand = function() { - return process.env.DEPLOY_TARGET; -} - module.exports = Deploy; diff --git a/package.json b/package.json index f4604ffa..cbe00529 100644 --- a/package.json +++ b/package.json @@ -39,8 +39,7 @@ ], "ember-addon": { "configPath": "tests/dummy/config", - "defaultBlueprint": "deploy-config", - "before": "broccoli-asset-rev" + "defaultBlueprint": "deploy-config" }, "dependencies": { "broccoli": "^0.13.2", From c0bc7f134847acc6ac0b05e0dbed9e1716ad8759 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 27 Aug 2015 19:48:20 +0100 Subject: [PATCH 155/300] Add 'prepare' hooks to pipeline --- lib/commands/deploy.js | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index f20c409c..a347e2c4 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -44,6 +44,7 @@ module.exports = { var hooks = ['configure', 'willDeploy', 'willBuild', 'build', 'didBuild', + 'willPrepare', 'prepare', 'didPrepare', 'willUpload', 'upload', 'didUpload', 'willActivate', 'activate', 'didActivate', 'didDeploy' From e5c200a8195b4c8fd7fcf1af1cdc953ec65ec8b3 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Fri, 28 Aug 2015 17:24:55 +0100 Subject: [PATCH 156/300] Update RFC with prepare hook --- rfc/plugins.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/rfc/plugins.md b/rfc/plugins.md index 5cd39a41..ca7ad116 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -139,6 +139,12 @@ build --------> builds app assets, documentation, etc. \ \-- didBuild manipulate index.html, validate assets + /-- willPrepare confirm deployment info + / +prepare --------> prepare information about the deploy, eg revisonKey, timestamp, commit message + \ + \-- didPrepare notify APIS (slack etc) + /-- willUpload confirm remote servers(S3, Redis, Azure, etc.) / upload -------> puts the assets somewhere(S3, Redis, Azure, Rackspace, etc.) From 7554d9259301acd40603ca7dfc69d51a4638d49b Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Wed, 2 Sep 2015 08:41:26 -0400 Subject: [PATCH 157/300] add setup and teardown hooks to all commands --- lib/commands/activate.js | 4 +++- lib/commands/deploy.js | 4 +++- lib/commands/list.js | 4 +++- rfc/plugins.md | 6 ++++++ 4 files changed, 15 insertions(+), 3 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 2813d4a2..b1e3fe59 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -25,9 +25,11 @@ module.exports = { commandOptions: commandOptions, hooks: [ 'configure', + 'setup', 'willActivate', 'activate', - 'didActivate' + 'didActivate', + 'teardown' ] }); diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index a347e2c4..a226a34f 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -42,12 +42,14 @@ module.exports = { _hooks: function(shouldActivate) { var hooks = ['configure', + 'setup', 'willDeploy', 'willBuild', 'build', 'didBuild', 'willPrepare', 'prepare', 'didPrepare', 'willUpload', 'upload', 'didUpload', 'willActivate', 'activate', 'didActivate', - 'didDeploy' + 'didDeploy', + 'teardown' ]; if (!shouldActivate) { diff --git a/lib/commands/list.js b/lib/commands/list.js index 286daddd..e9079aca 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -25,8 +25,10 @@ module.exports = { commandOptions: commandOptions, hooks: [ 'configure', + 'setup', 'fetchRevisions', - 'displayRevisions' + 'displayRevisions', + 'teardown' ] }); diff --git a/rfc/plugins.md b/rfc/plugins.md index ca7ad116..ed997deb 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -130,6 +130,10 @@ module.exports = return function(environment) { These hooks (part of a typical deployment process) are available for plugins to implement: ``` +configure: ---> runs before anything happens + +setup: -------> the first hook for every command + willDeploy: --> runs before anything happens. good opportunity for plugins to validate configuration or other preconditions @@ -166,6 +170,8 @@ activate -------> make a new version live (clear cache, swap Redis values, etc.) the ID of the version to be activated. didDeploy: --> runs at the end of a full deployment operation. + +teardown: ---> always the last hook being run ``` In addition, there are a few more specialized hooks that plugins may implement: From 134838f34a9ba7b61305dcb213559777536d65e1 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Fri, 4 Sep 2015 20:39:33 -0400 Subject: [PATCH 158/300] update description of hooks in rfc --- rfc/plugins.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/rfc/plugins.md b/rfc/plugins.md index ed997deb..8a5d4aea 100644 --- a/rfc/plugins.md +++ b/rfc/plugins.md @@ -188,6 +188,40 @@ discoverVersions: --> should return a promise resolving to an array of version o ``` +### Hooks by command + +Depending on the command you're running the hooks that are called vary + +#### `ember deploy` +``` +- configure +- setup +- willDeploy +- willBuild, build, didBuild, +- willPrepare, prepare, didPrepare, +- willUpload, upload, didUpload, +- willActivate, activate, didActivate, (only if --activate flag is passed) +- didDeploy, +- teardown +``` + +#### `ember deploy:activate` +``` +- configure +- setup +- willActivate, activate, didActivate +- teardown +``` + +#### `ember deploy:list` +``` +- configure +- setup +- fetchRevisions +- displayRevisions +- teardown +``` + ### Advanced Plugin Configuration As mentioned above, by default, all plugins from installed addons will be loaded, and From f7a3dbff56215c0c73379e9d9a36cba4ecd97a39 Mon Sep 17 00:00:00 2001 From: Duke Date: Sun, 6 Sep 2015 21:46:10 -0300 Subject: [PATCH 159/300] remove deprecated 'ember-cli/lib/errors/silent.js' require --- lib/tasks/pipeline.js | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index baf2cedb..e56bc882 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -1,6 +1,6 @@ var Task = require('ember-cli/lib/models/task'); var Promise = require('ember-cli/lib/ext/promise'); -var SilentError = require('ember-cli/lib/errors/silent'); +var SilentError = require('silent-error'); var existsSync = require('fs').existsSync; var path = require('path'); @@ -183,4 +183,3 @@ module.exports = Task.extend({ return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; } }); - From 5a6b6917b2e209d33f2c4a943469635ddf36b362 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 14 Sep 2015 22:40:32 +0100 Subject: [PATCH 160/300] Release v0.5.0-beta.2 --- CHANGELOG.md | 16 ++++++++++++++++ package.json | 2 +- 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 67563144..08de68c7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,21 @@ # ember-cli-deploy Changelog +### 0.5.0-beta.2 (June 14, 2015) + +#### Community Contributions + +- [#189](https://github.com/ember-cli/ember-cli-deploy/pull/189) [DOCUMENTATION] Upgrade instructions for plugin authors (and a bit for end users) [@duizendnegen/feature](https://github.com/duizendnegen/feature) +- [#196](https://github.com/ember-cli/ember-cli-deploy/pull/196) [BUGFIX] Fix bug where fingerprint options in deploy.js don't work [@achambers](https://github.com/achambers) +- [#197](https://github.com/ember-cli/ember-cli-deploy/pull/197) Remove unused code and commands deprecated in 0.4.0. [@yapplabs](https://github.com/yapplabs) +- [#206](https://github.com/ember-cli/ember-cli-deploy/pull/206) Remove modifying fingerprint options on `included` hook [@achambers](https://github.com/achambers) +- [#207](https://github.com/ember-cli/ember-cli-deploy/pull/207) Add 'prepare' hooks to pipeline [@achambers](https://github.com/achambers) +- [#208](https://github.com/ember-cli/ember-cli-deploy/pull/208) [DOCUMENTATION] Update RFC with prepare hook [@achambers](https://github.com/achambers) +- [#210](https://github.com/ember-cli/ember-cli-deploy/pull/210) add setup and teardown hooks to all commands [@ghedamat](https://github.com/ghedamat) +- [#212](https://github.com/ember-cli/ember-cli-deploy/pull/212) [DOCUMENTATION] Update description of hooks in rfc [@ghedamat](https://github.com/ghedamat) +- [#213](https://github.com/ember-cli/ember-cli-deploy/pull/213) Change deprecated require 'ember-cli/lib/errors/silent' to 'silent-error' [@dukex](https://github.com/dukex) + +Thank you to all who took the time to contribute! + ### 0.4.2 (June 14, 2015) This release fixes asset upload issues with io.js, adds the possibility for diff --git a/package.json b/package.json index cbe00529..ba3ca5b5 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "An Ember-CLI Addon for `Lightning Fast Deployments of Ember-CLI Apps`", - "version": "0.5.0-beta.1", + "version": "0.5.0-beta.2", "directories": { "doc": "doc", "test": "tests" From 83925fa4204206fa8409e8c3e5951caf10eb36d7 Mon Sep 17 00:00:00 2001 From: Pepijn Schoen Date: Mon, 5 Oct 2015 18:05:03 +0200 Subject: [PATCH 161/300] Update upgrade guide to highlight newly created revision-data instead of revision-key --- UPGRADE_TO_0.5.0.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/UPGRADE_TO_0.5.0.md b/UPGRADE_TO_0.5.0.md index 3226c3a4..f36bd146 100644 --- a/UPGRADE_TO_0.5.0.md +++ b/UPGRADE_TO_0.5.0.md @@ -4,7 +4,7 @@ The pipeline approach in 0.5.0 requires some modifications to ember-cli-deploy p ## Plugin users -- Add the following dependencies: `ember-cli-deploy-build` and `ember-cli-deploy-revision-key` +- Add the following dependencies: `ember-cli-deploy-build` and `ember-cli-deploy-revision-data` - Change your config/deploy.js to return a function instead of an object, for each `environment` setting: - `ENV["%INDEX_ADAPTER_NAME%"] = { /* plugin config goes here */ }` - `ENV["%ASSETS_ADAPTER_NAME%"] = { /* plugin config goes here */ }` @@ -23,11 +23,11 @@ Depending on what type of adapters you're publishing, you'll have to make differ 7. replace console.log statements to this.log to play nicely with the formatting in ember-cli-deploy ### For index/store adapters: -1. instruct your users to install ember-cli-deploy-revision-key (see above) -2. mind you that the revision key is now under context.revisionKey (provided ember-cli-deploy-revision-key is installed) and it doesn't include your project name yet. +1. instruct your users to install ember-cli-deploy-revision-data (see above) +2. mind you that the revision key is now under context.revisionData.revisionKey (provided ember-cli-deploy-revision-data is installed) and it doesn't include your project name yet. ```javascript _key: function(context) { - var revisionKey = context.commandOptions.revision || context.revisionKey.substr(0, 8); + var revisionKey = context.commandOptions.revision || context.revisionData.revisionKey.substr(0, 8); return context.project.name() + ':' + revisionKey; } ``` From 2cf1624262f79a1a111b7e679f36c781168e1a26 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Wed, 7 Oct 2015 23:55:21 +0100 Subject: [PATCH 162/300] Give warning when no plugins are installed --- lib/tasks/pipeline.js | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index e56bc882..e6b76c96 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -57,7 +57,16 @@ module.exports = Task.extend({ plugins = self._installedPlugins; } - Object.keys(plugins).forEach(function(pluginName) { + var pluginNames = Object.keys(plugins); + + if (pluginNames.length === 0) { + self.ui.writeError("\nWARNING: No plugins installed.\n"); + self.ui.writeError("ember-cli-deploy works by registering plugins in it's pipeline."); + self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); + self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/plugins for a list of supported plugins.\n"); + } + + pluginNames.forEach(function(pluginName) { self._registerPipelineHooks(plugins[pluginName], pluginName); }); @@ -96,7 +105,7 @@ module.exports = Task.extend({ var project = this.project; var commandOptions = this.commandOptions; - return this.setup().then(function(deployConfig){ + return this.setup().then(function(deployConfig) { var context = { commandOptions: commandOptions, config: deployConfig, From 967e9e6ab57db73e7e20783d42a5661184d535e3 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Sat, 26 Sep 2015 15:31:28 -0400 Subject: [PATCH 163/300] add support for postBuildDeployHook this adds a config option that will trigger a specific pipeline every time the project is built. the use case is to enable pushing assets to a store during development for example: users of the redis plugin could use this config to get an updated `index.html` in their redis store: ``` if (deployTarget === 'development-postbuild') { ENV.plugins = ['redis']; ENV.build = { environment: 'development' }; ENV.redis = { keyPrefix: 'edd-cli', revisionKey: '__development__', allowOverwrite: true, type: 'redis', // this can be omitted because it is the default host: 'localhost', port: 6379, distDir: function(context) { return context.commandOptions.buildDir; } }; } ``` to enable the postBuild hook we use `ember-cli-config.js` ``` var app = new EmberApp(defaults, { ... emberCLIDeploy: { configFile: 'config/deploy.js', runOnPostBuild: (env === 'development') ? 'development-postbuild' : false, shouldActivate: true }, ... ``` --- README.md | 69 ++++++++++++++ index.js | 40 +++++--- lib/commands/deploy.js | 54 +---------- lib/tasks/deploy.js | 64 +++++++++++++ .../fixtures/config/deploy-postbuild.js | 11 +++ node-tests/unit/tasks/deploy-test.js | 91 +++++++++++++++++++ 6 files changed, 269 insertions(+), 60 deletions(-) create mode 100644 lib/tasks/deploy.js create mode 100644 node-tests/fixtures/config/deploy-postbuild.js create mode 100644 node-tests/unit/tasks/deploy-test.js diff --git a/README.md b/README.md index 776b61d8..c13ab8cf 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,75 @@ After installation, choose [deployment adapters](http://ember-cli.github.io/embe [Visit the Docs site](http://ember-cli.github.io/ember-cli-deploy/) +## Development workflow + +Why do this? `ember-cli-deploy` is an addon for deploying apps. It works fine for cases where your ember-cli app and API app are mostly developed in isolation. However, if you develop your apps more closely or rely on your API app to inject session or initial state data into your ember-cli app's index page, the development process can be cumbersome. + +This workflow simply writes your ember-cli app's index to your index plugin on each build so that your API app can read (and possibly modify it) just like it would in production. + +During app development use `ember server` just to recompile and serve the assets as usual. +This way the ember app is served by your backend and there's no need to setup CORS or proxies. + +This strategy can be easily accomplished with some configurations parameters. + +The following is an example that pushes the `index.html` to redis on each build: + +in your `ember-cli-build.js` + +```javascript + module.exports = function(defaults) { + var env = EmberApp.env()|| 'development'; + ... + + var fingerprintOptions = { + enabled: true, + ... + }; + + switch (env) { + case 'development': + fingerprintOptions.prepend = 'http://localhost:4200/'; // use fingerprinting to prepend your ember server domain path + break; + ... + } + + var app = new EmberApp(defaults, { + fingerprint: fingerprintOptions, + emberCLIDeploy: { + runOnPostBuild: (env === 'development') ? 'development-postbuild' : false, // returns the deployTarget + configFile: 'config/deploy.js', // optionally specifiy a different config file + shouldActivate: true, // optionally call the activate hook on deploy + }, + ... + }); + + return app.toTree(); + }; +``` + +in `config/deploy.js` you can define a custom pipeline for your deploy env. + +```javascript + if (deployTarget === 'development-postbuild') { + ENV.plugins = ['redis']; // only use the redis pluging + ENV.build = { + environment: 'development' + }; + + ENV.redis = { + keyPrefix: 'edd-cli', + revisionKey: '__development__', + allowOverwrite: true, + type: 'redis', // this can be omitted because it is the default + host: 'localhost', + port: 6379, + distDir: function(context) { + return context.commandOptions.buildDir; + } + }; + } +``` + ## Contributing Clone the repo and run `npm install`. To run tests, diff --git a/index.js b/index.js index d8841b32..223c1e39 100644 --- a/index.js +++ b/index.js @@ -1,17 +1,35 @@ var path = require('path'); var commands = require('./lib/commands'); -function Deploy() { - this.name = 'ember-cli-deploy'; - return this; -} +module.exports = { + name: 'ember-cli-deploy', -Deploy.prototype.includedCommands = function() { - return commands; -}; + includedCommands: function() { + return commands; + }, -Deploy.prototype.blueprintsPath = function() { - return path.join(__dirname, 'blueprints'); -}; + blueprintsPath: function() { + return path.join(__dirname, 'blueprints'); + }, + + postBuild: function(result) { + var options = this.app.options.emberCLIDeploy || {}; -module.exports = Deploy; + var deployTarget = options.runOnPostBuild; + if (deployTarget) { + var DeployTask = require('./lib/tasks/deploy'); + var deploy = new DeployTask({ + project: this.project, + ui: this.ui, + deployTarget: deployTarget, + deployConfigFile: options.configFile, + shouldActivate: options.shouldActivate, + commandOptions: { + buildDir: result.directory + } + }); + + return deploy.run(); + } + } +}; diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index a226a34f..62cb0420 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,6 +1,3 @@ -var existsSync = require('fs').existsSync; -var path = require('path'); - module.exports = { name: 'deploy', description: 'Deploys an ember-cli app', @@ -19,58 +16,17 @@ module.exports = { commandOptions.deployTarget = rawArgs.shift(); process.env.DEPLOY_TARGET = commandOptions.deployTarget; - var shouldActivate = this._shouldActivate(commandOptions); - - var PipelineTask = require('../tasks/pipeline'); - var pipeline = new PipelineTask({ + var DeployTask = require('../tasks/deploy'); + var deploy = new DeployTask({ project: this.project, ui: this.ui, deployTarget: commandOptions.deployTarget, - deployConfigPath: commandOptions.deployConfigFile, - commandOptions: commandOptions, - hooks: this._hooks(shouldActivate) + deployConfigFile: commandOptions.deployConfigFile, + commandOptions: this.commandOptions }); - return pipeline.run(); - }, - - _shouldActivate: function(options) { - var config = this._pipelineConfig(options); - var referToPipelineConfig = (options.activate === undefined); - return referToPipelineConfig ? config.activateOnDeploy : options.activate; - }, - - _hooks: function(shouldActivate) { - var hooks = ['configure', - 'setup', - 'willDeploy', - 'willBuild', 'build', 'didBuild', - 'willPrepare', 'prepare', 'didPrepare', - 'willUpload', 'upload', 'didUpload', - 'willActivate', 'activate', 'didActivate', - 'didDeploy', - 'teardown' - ]; - - if (!shouldActivate) { - hooks.splice(hooks.indexOf('willActivate'), 3); - } + return deploy.run(); - return hooks; }, - _pipelineConfig: function(options) { - var root = this.project.root; - var filePath = options.deployConfigFile; - var fullPath = path.join(root, filePath); - var deployTarget = options.deployTarget; - - if (!existsSync(fullPath)) { - return {}; - } - - var fn = require(fullPath); - - return fn(deployTarget)['pipeline'] || {}; - } }; diff --git a/lib/tasks/deploy.js b/lib/tasks/deploy.js new file mode 100644 index 00000000..54a25469 --- /dev/null +++ b/lib/tasks/deploy.js @@ -0,0 +1,64 @@ +var Task = require('ember-cli/lib/models/task'); +var existsSync = require('fs').existsSync; +var path = require('path'); +var PipelineTask = require('../tasks/pipeline'); + +module.exports = Task.extend({ + init: function() { + this.commandOptions = this.commandOptions || {}; + this.shouldActivate = this.shouldActivate || this._shouldActivate(this.commandOptions); + }, + + run: function() { + var pipeline = this._pipeline || new PipelineTask({ + project: this.project, + ui: this.ui, + deployTarget: this.deployTarget, + deployConfigPath: this.deployConfigFile, + commandOptions: this.commandOptions, + hooks: this._hooks(this.shouldActivate) + }); + return pipeline.run(); + }, + + _shouldActivate: function(options) { + var config = this._pipelineConfig(); + var referToPipelineConfig = (options.activate === undefined); + return referToPipelineConfig ? config.activateOnDeploy : options.activate; + }, + + _hooks: function(shouldActivate) { + var hooks = ['configure', + 'setup', + 'willDeploy', + 'willBuild', 'build', 'didBuild', + 'willPrepare', 'prepare', 'didPrepare', + 'willUpload', 'upload', 'didUpload', + 'willActivate', 'activate', 'didActivate', + 'didDeploy', + 'teardown' + ]; + + if (!shouldActivate) { + hooks.splice(hooks.indexOf('willActivate'), 3); + } + + return hooks; + }, + + _pipelineConfig: function() { + var root = this.project.root; + var filePath = this.deployConfigFile; + var fullPath = path.join(root, filePath); + var deployTarget = this.deployTarget; + + if (!existsSync(fullPath)) { + return {}; + } + + var fn = require(fullPath); + + return fn(deployTarget)['pipeline'] || {}; + } + +}); diff --git a/node-tests/fixtures/config/deploy-postbuild.js b/node-tests/fixtures/config/deploy-postbuild.js new file mode 100644 index 00000000..d23b10bb --- /dev/null +++ b/node-tests/fixtures/config/deploy-postbuild.js @@ -0,0 +1,11 @@ +module.exports = function(environment) { + var ENV = {}; + + if (environment === 'development-postbuild') { + ENV.pipeline = { + activateOnDeploy: true + }; + } + + return ENV; +}; diff --git a/node-tests/unit/tasks/deploy-test.js b/node-tests/unit/tasks/deploy-test.js new file mode 100644 index 00000000..78c7d9fa --- /dev/null +++ b/node-tests/unit/tasks/deploy-test.js @@ -0,0 +1,91 @@ +var Promise = require('ember-cli/lib/ext/promise'); +var DeployTask = require('../../../lib/tasks/deploy'); +var expect = require('../../helpers/expect'); +var assert = require('chai').assert; + +describe('DeployTask', function() { + var mockProject = {addons: []}; + var mockConfig = {}; + var mockUi = { write: function() {}, writeError: function() {} }; + + describe('creating and setting up a new instance', function() { + + describe('detects that shouldActivate', function() { + it('is passed as a value', function() { + var deploy = new DeployTask({ + project: mockProject, + ui: mockUi, + deployTarget: 'development-postbuild', + deployConfigFile: 'node-tests/fixtures/config/deploy-postbuild.js', + shouldActivate: true + }); + expect(deploy.shouldActivate).to.eq(true); + }); + + it('is specified in the deploy config', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + var deploy = new DeployTask({ + project: project, + ui: mockUi, + deployTarget: 'development-postbuild', + deployConfigFile: 'node-tests/fixtures/config/deploy-postbuild.js', + }); + expect(deploy.shouldActivate).to.eq(true); + }); + + it('is passed as a commandLine option', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + var deploy = new DeployTask({ + project: project, + ui: mockUi, + deployTarget: 'development-postbuild', + deployConfigFile: 'node-tests/fixtures/config/deploy.js', + commandOptions: { + activate: true + } + }); + expect(deploy.shouldActivate).to.eq(true); + }); + }); + + describe('executing the deployTask', function() { + it ('executes the pipelineTask', function() { + var pipelineExecuted = false; + var pipelineContext; + + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ ] + }; + + var task = new DeployTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + deployConfigFile: 'node-tests/fixtures/config/deploy.js', + _pipeline: { + run: function() { + pipelineExecuted = true; + return Promise.resolve(); + } + } + }); + + return expect(task.run()).to.be.fulfilled + .then(function() { + expect(pipelineExecuted).to.eq(true); + }); + }); + }); + }); + +}); From ef0a95c30f5fe36893a6289b7f53379b852f18af Mon Sep 17 00:00:00 2001 From: Justin Giancola Date: Sat, 10 Oct 2015 14:46:43 -0400 Subject: [PATCH 164/300] Updates README.md to clarify runOnPostBuild uses --- README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c13ab8cf..0865c670 100644 --- a/README.md +++ b/README.md @@ -18,14 +18,16 @@ After installation, choose [deployment adapters](http://ember-cli.github.io/embe ## Development workflow -Why do this? `ember-cli-deploy` is an addon for deploying apps. It works fine for cases where your ember-cli app and API app are mostly developed in isolation. However, if you develop your apps more closely or rely on your API app to inject session or initial state data into your ember-cli app's index page, the development process can be cumbersome. +`ember-cli-deploy` is an addon for deploying apps. It works fine for cases where your ember-cli app and API app are mostly developed in isolation. However, there are some cases where using the `--proxy` command line option is inadequate. For example: + * authentication happens within your API application + * you are progressively updating an app to Ember or developing a hybrid app (i.e. some pages are served by the API application) and you need both applications to work together seamlessly + * the API app injects some initial state (e.g. session info or model preloads) into your ember-cli app's index page so that it is available without having to make xhr requests on boot -This workflow simply writes your ember-cli app's index to your index plugin on each build so that your API app can read (and possibly modify it) just like it would in production. +The development workflow simply writes your ember-cli app's index to your key-value store on each build so that your API app can read (and possibly modify) it just as it would in production. -During app development use `ember server` just to recompile and serve the assets as usual. -This way the ember app is served by your backend and there's no need to setup CORS or proxies. +During app development `ember server` is used to recompile and serve the assets as usual while the app index is served by your API app, eliminating the need to setup CORS or proxies. -This strategy can be easily accomplished with some configurations parameters. +This strategy can be easily accomplished with some `ember-cli-build.js` configuration. Keep in mind that you will need to modify your `fingerprintOptions` in development to prepend your ember-cli server host and port. This way requests for Ember assets still go to ember-cli and not your API application. The following is an example that pushes the `index.html` to redis on each build: From 5a8f25893b4cd554ea6df779c574573ed0a6b52e Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sun, 11 Oct 2015 01:21:51 -0400 Subject: [PATCH 165/300] Remove Development Workflow from README now that it is in website --- README.md | 73 +------------------------------------------------------ 1 file changed, 1 insertion(+), 72 deletions(-) diff --git a/README.md b/README.md index 0865c670..1b253cb5 100644 --- a/README.md +++ b/README.md @@ -10,83 +10,12 @@ npm install ember-cli-deploy --save-dev ``` ## Quick start -After installation, choose [deployment adapters](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/configuration/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/how-to-use/). +After installation, choose [plugins](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/configuration/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/usage/). ## In-depth documentation [Visit the Docs site](http://ember-cli.github.io/ember-cli-deploy/) -## Development workflow - -`ember-cli-deploy` is an addon for deploying apps. It works fine for cases where your ember-cli app and API app are mostly developed in isolation. However, there are some cases where using the `--proxy` command line option is inadequate. For example: - * authentication happens within your API application - * you are progressively updating an app to Ember or developing a hybrid app (i.e. some pages are served by the API application) and you need both applications to work together seamlessly - * the API app injects some initial state (e.g. session info or model preloads) into your ember-cli app's index page so that it is available without having to make xhr requests on boot - -The development workflow simply writes your ember-cli app's index to your key-value store on each build so that your API app can read (and possibly modify) it just as it would in production. - -During app development `ember server` is used to recompile and serve the assets as usual while the app index is served by your API app, eliminating the need to setup CORS or proxies. - -This strategy can be easily accomplished with some `ember-cli-build.js` configuration. Keep in mind that you will need to modify your `fingerprintOptions` in development to prepend your ember-cli server host and port. This way requests for Ember assets still go to ember-cli and not your API application. - -The following is an example that pushes the `index.html` to redis on each build: - -in your `ember-cli-build.js` - -```javascript - module.exports = function(defaults) { - var env = EmberApp.env()|| 'development'; - ... - - var fingerprintOptions = { - enabled: true, - ... - }; - - switch (env) { - case 'development': - fingerprintOptions.prepend = 'http://localhost:4200/'; // use fingerprinting to prepend your ember server domain path - break; - ... - } - - var app = new EmberApp(defaults, { - fingerprint: fingerprintOptions, - emberCLIDeploy: { - runOnPostBuild: (env === 'development') ? 'development-postbuild' : false, // returns the deployTarget - configFile: 'config/deploy.js', // optionally specifiy a different config file - shouldActivate: true, // optionally call the activate hook on deploy - }, - ... - }); - - return app.toTree(); - }; -``` - -in `config/deploy.js` you can define a custom pipeline for your deploy env. - -```javascript - if (deployTarget === 'development-postbuild') { - ENV.plugins = ['redis']; // only use the redis pluging - ENV.build = { - environment: 'development' - }; - - ENV.redis = { - keyPrefix: 'edd-cli', - revisionKey: '__development__', - allowOverwrite: true, - type: 'redis', // this can be omitted because it is the default - host: 'localhost', - port: 6379, - distDir: function(context) { - return context.commandOptions.buildDir; - } - }; - } -``` - ## Contributing Clone the repo and run `npm install`. To run tests, From 615611272682195b8c93b61a019982813093b94c Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 12 Oct 2015 18:22:14 -0400 Subject: [PATCH 166/300] Guard postBuild hook --- index.js | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/index.js b/index.js index 223c1e39..1c799168 100644 --- a/index.js +++ b/index.js @@ -13,6 +13,11 @@ module.exports = { }, postBuild: function(result) { + if (!this.app) { + // You will need ember-cli >= 1.13 to use ember-cli-deploy's postBuild integration. + // This is because prior to 1.13, `this.app` is not available in the postBuild hook. + return; + } var options = this.app.options.emberCLIDeploy || {}; var deployTarget = options.runOnPostBuild; From a2450220985be1249d253ca7cbefe727b107f155 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 13 Oct 2015 19:36:40 +0100 Subject: [PATCH 167/300] Update warning message url when no plugins installed --- lib/tasks/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index e6b76c96..4488d651 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -63,7 +63,7 @@ module.exports = Task.extend({ self.ui.writeError("\nWARNING: No plugins installed.\n"); self.ui.writeError("ember-cli-deploy works by registering plugins in it's pipeline."); self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); - self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/plugins for a list of supported plugins.\n"); + self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); } pluginNames.forEach(function(pluginName) { From 025749711c6d6bd9f7014d956e41402af02acd99 Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Mon, 19 Oct 2015 22:54:28 +0200 Subject: [PATCH 168/300] Make --deploy-config-path accept absolute paths --- lib/tasks/pipeline.js | 2 +- node-tests/unit/tasks/pipeline-test.js | 17 ++++++++++++++++- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 4488d651..c76160a1 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -119,7 +119,7 @@ module.exports = Task.extend({ _readDeployConfig: function() { var project = this.project; - var deployConfigFn = require(path.join(project.root, this.deployConfigPath)); + var deployConfigFn = require(path.resolve(project.root, this.deployConfigPath)); return Promise.resolve(deployConfigFn(this.deployTarget)); }, diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 468bb0bb..54374ba6 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -2,9 +2,10 @@ var Promise = require('ember-cli/lib/ext/promise'); var PipelineTask = require('../../../lib/tasks/pipeline'); var expect = require('../../helpers/expect'); var assert = require('chai').assert; +var path = require('path'); describe('PipelineTask', function() { - var mockProject = {addons: []}; + var mockProject = {addons: [], root: process.cwd()}; var mockConfig = {}; var mockUi = { write: function() {}, writeError: function() {} }; @@ -28,6 +29,20 @@ describe('PipelineTask', function() { expect(fn).to.throw('No ui passed to pipeline task'); }); + it('accepts an absolute deployConfigPath', function() { + var fn = function () { + new PipelineTask({ + project: mockProject, + ui: mockUi, + deployTarget: 'development', + deployConfigPath: path.join(process.cwd(), 'node-tests/fixtures/config/deploy.js'), + hooks: ['willDeploy', 'upload'] + }).run(); + }; + + assert.doesNotThrow(fn, /Cannot find module/, 'config file could not be read'); + }); + describe('setting environment variables from .env', function() { beforeEach(function(){ delete process.env.ENVTEST; From 4eed909c34e01b005d29bce64c4a11b7b94bb5a4 Mon Sep 17 00:00:00 2001 From: Katie Gengler Date: Tue, 20 Oct 2015 18:34:16 -0400 Subject: [PATCH 169/300] Correct typo; commandOptions are a local var --- lib/commands/deploy.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 62cb0420..5fba904e 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -22,7 +22,7 @@ module.exports = { ui: this.ui, deployTarget: commandOptions.deployTarget, deployConfigFile: commandOptions.deployConfigFile, - commandOptions: this.commandOptions + commandOptions: commandOptions }); return deploy.run(); From 680acf68eb114873ef9c280519fdf7358283a666 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Tue, 20 Oct 2015 20:58:45 -0400 Subject: [PATCH 170/300] add postInstall message --- blueprints/deploy-config/index.js | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/blueprints/deploy-config/index.js b/blueprints/deploy-config/index.js index fab62a38..18584411 100644 --- a/blueprints/deploy-config/index.js +++ b/blueprints/deploy-config/index.js @@ -1,8 +1,14 @@ +var chalk = require('chalk'); +var green = chalk.green; + module.exports = { description: 'Generate config for ember-cli deployments', normalizeEntityName: function() { // this prevents an error when the entityName is // not specified (since that doesn't actually matter // to us + }, + afterInstall: function(options) { + this.ui.write(green('ember-cli-deploy needs plugins to actually do the deployment work.\nSee http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/quick-start/\nto learn how to install plugins and see what plugins are available.\n')); } }; From ae5e3a42545b154315e14c26471a6b31ff0dec89 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 22 Oct 2015 00:12:37 -0400 Subject: [PATCH 171/300] Release v0.5.0-beta.3 --- CHANGELOG.md | 22 ++++++++++++++++++++++ package.json | 2 +- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 74dd1032..99e9432e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # ember-cli-deploy Changelog +## [0.5.0-beta.3](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.3) (2015-10-22) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.2...0.5.0-beta.3) + +This release is expected to be the last beta before 0.5.0. We're happy to welcome +@ghedamat to the core team and are grateful for his many contributions to +documentation this cycle. + +Thanks to everyone who took time to contribute to this release! + +#### Community Contributions + +- add postInstall message [\#256](https://github.com/ember-cli/ember-cli-deploy/pull/256) ([ghedamat](https://github.com/ghedamat)) +- Correct typo; commandOptions are a local var [\#255](https://github.com/ember-cli/ember-cli-deploy/pull/255) ([kategengler](https://github.com/kategengler)) +- Make --deploy-config-path accept absolute paths [\#253](https://github.com/ember-cli/ember-cli-deploy/pull/253) ([dschmidt](https://github.com/dschmidt)) +- Update warning message url when no plugins installed [\#234](https://github.com/ember-cli/ember-cli-deploy/pull/234) ([achambers](https://github.com/achambers)) +- Guard postBuild hook [\#232](https://github.com/ember-cli/ember-cli-deploy/pull/232) ([lukemelia](https://github.com/lukemelia)) +- Merge 0.4.x [\#228](https://github.com/ember-cli/ember-cli-deploy/pull/228) ([lukemelia](https://github.com/lukemelia)) +- Give warning when no plugins are installed [\#225](https://github.com/ember-cli/ember-cli-deploy/pull/225) ([achambers](https://github.com/achambers)) +- Add support for postBuildDeployHook [\#222](https://github.com/ember-cli/ember-cli-deploy/pull/222) ([ghedamat](https://github.com/ghedamat)) + ### 0.5.0-beta.2 (June 14, 2015) #### Community Contributions @@ -94,3 +114,5 @@ If you are upgrading from `achambers/ember-cli-deploy v0.0.6`, please follow the ### 0.3.1 (February 08, 2015) - [#32](https://github.com/LevelbossMike/ember-deploy/pull/32) add support for execSync in node >= 0.11 [@kriswill](https://github.com/kriswill) + +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* diff --git a/package.json b/package.json index 173ee838..cf19ff56 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.5.0-beta.2", + "version": "0.5.0-beta.3", "directories": { "doc": "doc", "test": "tests" From dd24c8375e9f0d8828522a238b45dce8a3c60a54 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 24 Oct 2015 17:20:47 -0400 Subject: [PATCH 172/300] Add a `--verbose` option to commands, make default output quiet, and make flag available to plugins via `verbose` property on `ui` object. --- lib/commands/activate.js | 2 + lib/commands/deploy.js | 2 + lib/commands/list.js | 2 + lib/models/pipeline.js | 37 ++++++++---- node-tests/unit/tasks/pipeline-test.js | 78 +++++++++++++++++++++++++- 5 files changed, 108 insertions(+), 13 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index b1e3fe59..62a45a8a 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -5,6 +5,7 @@ module.exports = { availableOptions: [ { name: 'revision', type: String, required: true }, + { name: 'verbose', type: Boolean }, { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } ], @@ -14,6 +15,7 @@ module.exports = { run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); + this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; var PipelineTask = require('../tasks/pipeline'); diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 5fba904e..3125c43f 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -9,11 +9,13 @@ module.exports = { availableOptions: [ { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'verbose', type: Boolean }, { name: 'activate', type: Boolean } ], run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); + this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; var DeployTask = require('../tasks/deploy'); diff --git a/lib/commands/list.js b/lib/commands/list.js index e9079aca..44cda16e 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -9,11 +9,13 @@ module.exports = { availableOptions: [ { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'verbose', type: Boolean }, { name: 'amount', type: Number, default: 10 } ], run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); + this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; var PipelineTask = require('../tasks/pipeline'); diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index 83e95cd3..6f0541d1 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -36,7 +36,9 @@ Pipeline.prototype.register = function(hookName, fn) { } if (pipelineHooks[hookName]) { - ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); + if (ui.verbose) { + ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); + } pipelineHooks[hookName].push(fn); } @@ -46,7 +48,9 @@ Pipeline.prototype.execute = function(context) { context = context || { }; var ui = this._ui; - ui.write(blue('Executing pipeline\n')); + if (ui.verbose) { + ui.write(blue('Executing pipeline\n')); + } return this._hooksWithoutDidFail(this.hookNames()) .reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) @@ -79,28 +83,35 @@ Pipeline.prototype._hooksWithoutDidFail = function(hooks) { }; Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { - ui.write(red('|\n')); - ui.write(red('+- didFail\n')); + if (ui.verbose) { + ui.write(red('|\n')); + ui.write(red('+- didFail\n')); + } ui.write(red(error + '\n' + (error ? error.stack : null))); return this._executeHook('didFail', context) .then(Promise.reject.bind(this, error)); }; Pipeline.prototype._abortPipelineExecution = function(ui/*, error */) { - ui.write(blue('|\n')); + if (ui.verbose) { + ui.write(blue('|\n')); + } ui.write(red('Pipeline aborted\n')); return Promise.reject(); }; Pipeline.prototype._notifyPipelineCompletion = function(ui) { - ui.write(blue('|\n')); - ui.write(blue('Pipeline complete\n')); + if (ui.verbose) { + ui.write(blue('|\n')); + ui.write(blue('Pipeline complete\n')); + } }; Pipeline.prototype._notifyPipelineHookExecution = function(ui, hookName, context) { - ui.write(blue('|\n')); - ui.write(blue('+- ' + hookName + '\n')); - + if (ui.verbose) { + ui.write(blue('|\n')); + ui.write(blue('+- ' + hookName + '\n')); + } return context; }; @@ -118,8 +129,10 @@ Pipeline.prototype._addPluginHookExecutionPromiseToHookPromiseChain = function(u }; Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, context) { - ui.write(blue('| |\n')); - ui.write(blue('| +- ' + fnObject.name + '\n')); + if (ui.verbose) { + ui.write(blue('| |\n')); + ui.write(blue('| +- ' + fnObject.name + '\n')); + } return fnObject.fn(context); }; diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 54374ba6..0f4a59ce 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -1,5 +1,6 @@ var Promise = require('ember-cli/lib/ext/promise'); var PipelineTask = require('../../../lib/tasks/pipeline'); +var Pipeline = require('../../../lib/models/pipeline'); var expect = require('../../helpers/expect'); var assert = require('chai').assert; var path = require('path'); @@ -7,7 +8,10 @@ var path = require('path'); describe('PipelineTask', function() { var mockProject = {addons: [], root: process.cwd()}; var mockConfig = {}; - var mockUi = { write: function() {}, writeError: function() {} }; + var mockUi; + beforeEach(function(){ + mockUi = { write: function() {}, writeError: function() {} }; + }); describe('creating and setting up a new instance', function() { it ('raises an error if project is not provided', function() { @@ -323,6 +327,78 @@ describe('PipelineTask', function() { expect(pipelineContext.commandOptions.revision).to.eq('123abc'); }); }); + + it('executes the pipeline, logging at a verbose level', function() { + var logOutput = ""; + mockUi = { + verbose: true, + write: function(s) { + logOutput = logOutput + s; + }, + writeError: function(s) { + logOutput = logOutput + s + "\n"; + } + }; + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-test-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'test-plugin', + willDeploy: function() { + }, + upload: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js', + commandOptions: {revision: '123abc'}, + hooks: ['willDeploy', 'upload'], + pipeline: new Pipeline(['willDeploy', 'upload'], { + ui: mockUi + }) + }); + + return task.setup().then(function(){ + return expect(task.run()).to.be.fulfilled; + }).then(function() { + var logLines = logOutput.split("\n"); + expect(logLines[ 0]).to.eq("\u001b[34mRegistering hook -> willDeploy[test-plugin]"); + expect(logLines[ 1]).to.eq("\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]"); + expect(logLines[ 2]).to.eq("\u001b[39m\u001b[34mRegistering hook -> willDeploy[test-plugin]"); + expect(logLines[ 3]).to.eq("\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]"); + expect(logLines[ 4]).to.eq("\u001b[39m\u001b[34mExecuting pipeline"); + expect(logLines[ 5]).to.eq("\u001b[39m\u001b[34m|"); + expect(logLines[ 6]).to.eq("\u001b[39m\u001b[34m+- willDeploy"); + expect(logLines[ 7]).to.eq("\u001b[39m\u001b[34m| |"); + expect(logLines[ 8]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); + expect(logLines[ 9]).to.eq("\u001b[39m\u001b[34m| |"); + expect(logLines[10]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); + expect(logLines[11]).to.eq("\u001b[39m\u001b[34m|"); + expect(logLines[12]).to.eq("\u001b[39m\u001b[34m+- upload"); + expect(logLines[13]).to.eq("\u001b[39m\u001b[34m| |"); + expect(logLines[14]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); + expect(logLines[15]).to.eq("\u001b[39m\u001b[34m| |"); + expect(logLines[16]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); + expect(logLines[17]).to.eq("\u001b[39m\u001b[34m|"); + expect(logLines[18]).to.eq("\u001b[39m\u001b[34mPipeline complete"); + }); + }); }); describe('plugin aliases are correctly handled', function() { From e082b9ce228d53abcb3ac1fc6677806575822ad5 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 24 Oct 2015 23:52:01 -0400 Subject: [PATCH 173/300] Release 0.5.0-beta.4 --- CHANGELOG.md | 7 +++++++ package.json | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 99e9432e..23e1c981 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # ember-cli-deploy Changelog +## [0.5.0-beta.4](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.4) (2015-10-24) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.3...0.5.0-beta.4) + +**Merged pull requests:** + +- Add a `--verbose` option to commands, make default output quiet, and … [\#266](https://github.com/ember-cli/ember-cli-deploy/pull/266) ([lukemelia](https://github.com/lukemelia)) + ## [0.5.0-beta.3](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.3) (2015-10-22) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.2...0.5.0-beta.3) diff --git a/package.json b/package.json index cf19ff56..9f850b83 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.5.0-beta.3", + "version": "0.5.0-beta.4", "directories": { "doc": "doc", "test": "tests" From c82572acc25565e2b3cf912f4c429614263777fd Mon Sep 17 00:00:00 2001 From: Jeroen K Date: Tue, 27 Oct 2015 11:52:41 +0100 Subject: [PATCH 174/300] Correct section links for v0.5.x docs Configuration and usage links are changed with v0.5.x --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1b253cb5..3587c33d 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ npm install ember-cli-deploy --save-dev ``` ## Quick start -After installation, choose [plugins](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/configuration/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/usage/). +After installation, choose [plugins](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/configuration-overview/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/usage-overview/). ## In-depth documentation From 2f3890efef1d1ee5928ff05cae0e35ebce5da6c2 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 29 Oct 2015 10:16:10 +0000 Subject: [PATCH 175/300] Release v0.5.0 --- CHANGELOG.md | 13 +++++++++++++ package.json | 2 +- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 23e1c981..175b73c6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,18 @@ # ember-cli-deploy Changelog +## [0.5.0](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0) (2015-10-29) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.4.3...0.5.0) + +[BREAKING] This release is the first in the 0.5.0 series and the first using the new deploy pipeline and plugin architecture. + +0.5.0 harnesses the concept of a pipeline that gives users the ability to flexibly compose plugins to satisfy their +custom deployment needs. + +NOTE: 0.5.0 is a major rewrite and shift from the 0.4.x series and hence introduces a number of breaking changes. + +For more information on the ember-cli-deploy v0.5.0, how to use it and how to write plugins please see the brand new +[documentation site](http://ember-cli-deploy.com). + ## [0.5.0-beta.4](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.4) (2015-10-24) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.3...0.5.0-beta.4) diff --git a/package.json b/package.json index 9f850b83..96b6ac2d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.5.0-beta.4", + "version": "0.5.0", "directories": { "doc": "doc", "test": "tests" From f74eb8986fb3ce081f4e59e80badbcd27693e5de Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Thu, 29 Oct 2015 10:24:13 +0000 Subject: [PATCH 176/300] Fix incorrect version url --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 175b73c6..73700bc6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # ember-cli-deploy Changelog -## [0.5.0](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0) (2015-10-29) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.4.3...0.5.0) +## [0.5.0](https://github.com/ember-cli/ember-cli-deploy/tree/v0.5.0) (2015-10-29) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.4.3...v0.5.0) [BREAKING] This release is the first in the 0.5.0 series and the first using the new deploy pipeline and plugin architecture. From 5c27ef141cc42b9493d43919c1a4f4ff63223364 Mon Sep 17 00:00:00 2001 From: Phil Gengler Date: Thu, 29 Oct 2015 16:53:11 +0000 Subject: [PATCH 177/300] Fix typo (it's/its) --- lib/tasks/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index c76160a1..2c1ebc39 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -61,7 +61,7 @@ module.exports = Task.extend({ if (pluginNames.length === 0) { self.ui.writeError("\nWARNING: No plugins installed.\n"); - self.ui.writeError("ember-cli-deploy works by registering plugins in it's pipeline."); + self.ui.writeError("ember-cli-deploy works by registering plugins in its pipeline."); self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); } From 8f9b40d5b7afb2e3340694038eec31d867ae8085 Mon Sep 17 00:00:00 2001 From: Dave Laird Date: Wed, 4 Nov 2015 20:33:21 -0800 Subject: [PATCH 178/300] Require a deploy target to run ember deploy --- lib/tasks/pipeline.js | 5 ++++- node-tests/unit/tasks/pipeline-test.js | 14 ++++++++++++++ 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 2c1ebc39..902f0eac 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -18,13 +18,16 @@ module.exports = Task.extend({ throw new SilentError('No ui passed to pipeline task'); } + if(!this.deployTarget) { + throw new SilentError('You need to provide a deployTarget: `ember deploy production`'); + } + this._pipeline = this.pipeline || new Pipeline(this.hooks, { ui: this.ui }); var root = this.project.root; - this.deployTarget = this.deployTarget || 'production'; this.commandOptions = this.commandOptions || {}; var dotEnvFilename = '.env.deploy.' + this.deployTarget; diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 0f4a59ce..7ae997e4 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -33,6 +33,17 @@ describe('PipelineTask', function() { expect(fn).to.throw('No ui passed to pipeline task'); }); + it('raises an error if deployTarget is not provided', function() { + var fn = function() { + new PipelineTask({ + project: mockProject, + ui: mockUi + }); + }; + + expect(fn).to.throw('You need to provide a deployTarget: `ember deploy production`'); + }); + it('accepts an absolute deployConfigPath', function() { var fn = function () { new PipelineTask({ @@ -425,6 +436,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + deployTarget: 'staging', deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js', pipeline: { hookNames: function () { @@ -466,6 +478,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + deployTarget: 'staging', deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', pipeline: { hookNames: function () { @@ -491,6 +504,7 @@ describe('PipelineTask', function() { var task = new PipelineTask({ project: project, ui: mockUi, + deployTarget: 'production', deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', }); From 35aa1ae027e5f9a41612c370c93cddb1503ab353 Mon Sep 17 00:00:00 2001 From: Ben Limmer Date: Sun, 8 Nov 2015 14:08:22 -0700 Subject: [PATCH 179/300] Upgrade ember-cli to 1.13.8. --- .npmignore | 1 + Brocfile.js | 16 ---------------- bower.json | 17 ++++++++--------- ember-cli-build.js | 17 +++++++++++++++++ package.json | 18 ++++++++++-------- tests/helpers/start-app.js | 1 - 6 files changed, 36 insertions(+), 34 deletions(-) delete mode 100644 Brocfile.js create mode 100644 ember-cli-build.js diff --git a/.npmignore b/.npmignore index 49996f5a..d522ca2b 100644 --- a/.npmignore +++ b/.npmignore @@ -10,5 +10,6 @@ dist/ .npmignore **/.gitkeep bower.json +ember-cli-build.js Brocfile.js testem.json diff --git a/Brocfile.js b/Brocfile.js deleted file mode 100644 index 2a682c03..00000000 --- a/Brocfile.js +++ /dev/null @@ -1,16 +0,0 @@ -/* jshint node: true */ -/* global require, module */ - -var EmberAddon = require('ember-cli/lib/broccoli/ember-addon'); - -/* - This Brocfile specifes the options for the dummy test app of this - addon, located in `/tests/dummy` - - This Brocfile does *not* influence how the addon or the app using it - behave. You most likely want to be modifying `./index.js` or app's Brocfile -*/ - -var app = new EmberAddon(); - -module.exports = app.toTree(); diff --git a/bower.json b/bower.json index 15db356f..3cd98c71 100644 --- a/bower.json +++ b/bower.json @@ -1,16 +1,15 @@ { "name": "ember-cli-deploy", "dependencies": { - "ember": "1.12.0", + "ember": "1.13.8", "ember-cli-shims": "ember-cli/ember-cli-shims#0.0.3", "ember-cli-test-loader": "ember-cli-test-loader#0.1.3", - "ember-data": "1.0.0-beta.18", - "ember-load-initializers": "ember-cli/ember-load-initializers#0.1.4", - "ember-qunit": "0.3.3", + "ember-load-initializers": "ember-cli/ember-load-initializers#0.1.5", + "ember-qunit": "0.4.9", "ember-qunit-notifications": "0.0.7", - "ember-resolver": "~0.1.15", - "jquery": "^1.11.1", - "loader.js": "ember-cli/loader.js#3.2.0", - "qunit": "~1.17.1" + "ember-resolver": "~0.1.18", + "jquery": "^1.11.3", + "loader.js": "ember-cli/loader.js#3.2.1", + "qunit": "~1.18.0" } -} \ No newline at end of file +} diff --git a/ember-cli-build.js b/ember-cli-build.js new file mode 100644 index 00000000..d37d64cd --- /dev/null +++ b/ember-cli-build.js @@ -0,0 +1,17 @@ +/* global require, module */ +var EmberApp = require('ember-cli/lib/broccoli/ember-addon'); + +module.exports = function(defaults) { + var app = new EmberApp(defaults, { + // Add options here + }); + + /* + This build file specifes the options for the dummy test app of this + addon, located in `/tests/dummy` + This build file does *not* influence how the addon or the app using it + behave. You most likely want to be modifying `./index.js` or app's build file + */ + + return app.toTree(); +}; diff --git a/package.json b/package.json index 96b6ac2d..e02f57e6 100644 --- a/package.json +++ b/package.json @@ -21,14 +21,16 @@ "devDependencies": { "chai": "^1.9.2", "chai-as-promised": "^4.1.1", - "broccoli-asset-rev": "^2.0.2", - "ember-cli": "0.2.7", - "ember-cli-app-version": "0.3.3", + "broccoli-asset-rev": "^2.1.2", + "ember-cli": "1.13.8", + "ember-cli-app-version": "0.5.0", "ember-cli-content-security-policy": "0.4.0", - "ember-cli-dependency-checker": "^1.0.0", - "ember-cli-htmlbars": "0.7.6", - "ember-cli-ic-ajax": "0.1.1", - "ember-cli-inject-live-reload": "^1.3.0", + "ember-cli-dependency-checker": "^1.0.1", + "ember-cli-htmlbars": "0.7.9", + "ember-cli-htmlbars-inline-precompile": "^0.2.0", + "ember-cli-ic-ajax": "0.2.1", + "ember-cli-inject-live-reload": "^1.3.1", + "ember-cli-qunit": "^1.0.0", "github": "0.2.3", "mocha": "^2.0.1", "sinon": "^1.12.1" @@ -46,7 +48,7 @@ "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", "core-object": "0.0.2", - "ember-cli-babel": "^5.0.0", + "ember-cli-babel": "^5.1.3", "dotenv": "^1.1.0", "glob": "4.4.2", "lodash-node": "^2.4.1", diff --git a/tests/helpers/start-app.js b/tests/helpers/start-app.js index 16cc7c39..0f7aab1a 100644 --- a/tests/helpers/start-app.js +++ b/tests/helpers/start-app.js @@ -1,6 +1,5 @@ import Ember from 'ember'; import Application from '../../app'; -import Router from '../../router'; import config from '../../config/environment'; export default function startApp(attrs) { From 1c0cfa1edee6c2f0280f805b6844aa61f648fe7e Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 9 Nov 2015 09:16:22 -0500 Subject: [PATCH 180/300] Release 0.5.1 --- CHANGELOG.md | 7 +++++++ UPGRADE_TO_0.5.0.md => UPGRADE_TO_0.5.x.md | 4 ++-- package.json | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) rename UPGRADE_TO_0.5.0.md => UPGRADE_TO_0.5.x.md (91%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 73700bc6..033ca8e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # ember-cli-deploy Changelog +## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) + +- Upgrade ember-cli to 1.13.8. [\#296](https://github.com/ember-cli/ember-cli-deploy/pull/296) ([blimmer](https://github.com/blimmer)) +- Require a deploy target to run ember deploy [\#294](https://github.com/ember-cli/ember-cli-deploy/pull/294) ([kiwiupover](https://github.com/kiwiupover)) +- Fix typo in "no plugins" warning $it's/its$ [\#284](https://github.com/ember-cli/ember-cli-deploy/pull/284) ([pgengler](https://github.com/pgengler)) + ## [0.5.0](https://github.com/ember-cli/ember-cli-deploy/tree/v0.5.0) (2015-10-29) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.4.3...v0.5.0) diff --git a/UPGRADE_TO_0.5.0.md b/UPGRADE_TO_0.5.x.md similarity index 91% rename from UPGRADE_TO_0.5.0.md rename to UPGRADE_TO_0.5.x.md index f36bd146..59f5ee33 100644 --- a/UPGRADE_TO_0.5.0.md +++ b/UPGRADE_TO_0.5.x.md @@ -1,6 +1,6 @@ ## Overview -The pipeline approach in 0.5.0 requires some modifications to ember-cli-deploy plugins and a few to deploy configuration scripts. +The pipeline approach in 0.5.x requires some modifications to ember-cli-deploy plugins and a few to deploy configuration scripts. ## Plugin users @@ -19,7 +19,7 @@ Depending on what type of adapters you're publishing, you'll have to make differ 3. implement `createDeployPlugin` in index.js and return an extended `ember-cli-deploy-plugin` from there. 4. listen to hooks to actually upload stuff, most notably upload (index and assets adapter) and activate (index adapter) 5. instruct your users to update their config (see above) -6. instruct your users to install ember-cli-deploy-build (see above) (there's discussion of whether to put this in ember-cli-deploy by default for 0.5.0, follow https://github.com/ember-cli/ember-cli-deploy/pull/179) +6. instruct your users to install ember-cli-deploy-build (see above) 7. replace console.log statements to this.log to play nicely with the formatting in ember-cli-deploy ### For index/store adapters: diff --git a/package.json b/package.json index e02f57e6..3e446540 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.5.0", + "version": "0.5.1", "directories": { "doc": "doc", "test": "tests" From 48c28615766ccddeb8586560ceeb9e31ddf8d074 Mon Sep 17 00:00:00 2001 From: Tim Evans Date: Tue, 1 Dec 2015 15:16:43 -0500 Subject: [PATCH 181/300] Unify reading config to a task, and make loading dotEnv vars and reading config happen before any other tasks are executed. An asynchronous collaboration of @tim-evans and @lukemelia --- index.js | 28 ++-- lib/commands/activate.js | 37 +++-- lib/commands/deploy.js | 22 ++- lib/commands/list.js | 35 +++-- lib/tasks/deploy.js | 26 +--- lib/tasks/pipeline.js | 89 ++++------- lib/tasks/read-config.js | 50 +++++++ .../config/deploy-for-addons-config-test.js | 5 - node-tests/fixtures/config/deploy.js | 29 ++-- node-tests/unit/tasks/deploy-test.js | 30 +++- node-tests/unit/tasks/pipeline-test.js | 141 +++++++----------- node-tests/unit/tasks/read-config-test.js | 78 ++++++++++ 12 files changed, 330 insertions(+), 240 deletions(-) create mode 100644 lib/tasks/read-config.js delete mode 100644 node-tests/fixtures/config/deploy-for-addons-config-test.js create mode 100644 node-tests/unit/tasks/read-config-test.js diff --git a/index.js b/index.js index 1c799168..d494b623 100644 --- a/index.js +++ b/index.js @@ -22,19 +22,27 @@ module.exports = { var deployTarget = options.runOnPostBuild; if (deployTarget) { - var DeployTask = require('./lib/tasks/deploy'); - var deploy = new DeployTask({ + + var ReadConfigTask = require('../tasks/read-config'); + var readConfig = new ReadConfigTask({ project: this.project, - ui: this.ui, deployTarget: deployTarget, - deployConfigFile: options.configFile, - shouldActivate: options.shouldActivate, - commandOptions: { - buildDir: result.directory - } + deployConfigFile: options.configFile + }); + return readConfig.run().then(function(config){ + var DeployTask = require('./lib/tasks/deploy'); + var deploy = new DeployTask({ + project: this.project, + ui: this.ui, + deployTarget: deployTarget, + config: config, + shouldActivate: options.shouldActivate, + commandOptions: { + buildDir: result.directory + } + }); + return deploy.run(); }); - - return deploy.run(); } } }; diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 62a45a8a..20da3030 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -18,23 +18,32 @@ module.exports = { this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; - var PipelineTask = require('../tasks/pipeline'); - var pipeline = new PipelineTask({ + var ReadConfigTask = require('../tasks/read-config'); + var readConfig = new ReadConfigTask({ project: this.project, - ui: this.ui, deployTarget: commandOptions.deployTarget, - deployConfigPath: commandOptions.deployConfigFile, - commandOptions: commandOptions, - hooks: [ - 'configure', - 'setup', - 'willActivate', - 'activate', - 'didActivate', - 'teardown' - ] + deployConfigFile: commandOptions.deployConfigFile }); + var self = this; + return readConfig.run().then(function(config){ + var PipelineTask = require('../tasks/pipeline'); + var pipeline = new PipelineTask({ + project: self.project, + ui: self.ui, + config: config, + deployTarget: commandOptions.deployTarget, + commandOptions: commandOptions, + hooks: [ + 'configure', + 'setup', + 'willActivate', + 'activate', + 'didActivate', + 'teardown' + ] + }); - return pipeline.run(); + return pipeline.run(); + }); } }; diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 3125c43f..f97b3a02 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -18,17 +18,25 @@ module.exports = { this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; - var DeployTask = require('../tasks/deploy'); - var deploy = new DeployTask({ + var ReadConfigTask = require('../tasks/read-config'); + var readConfig = new ReadConfigTask({ project: this.project, - ui: this.ui, deployTarget: commandOptions.deployTarget, - deployConfigFile: commandOptions.deployConfigFile, - commandOptions: commandOptions + deployConfigFile: commandOptions.deployConfigFile }); + var self = this; + return readConfig.run().then(function(config){ + var DeployTask = require('../tasks/deploy'); + var deploy = new DeployTask({ + project: self.project, + ui: self.ui, + config: config, + deployTarget: commandOptions.deployTarget, + commandOptions: commandOptions + }); - return deploy.run(); - + return deploy.run(); + }); }, }; diff --git a/lib/commands/list.js b/lib/commands/list.js index 44cda16e..90b6d374 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -18,22 +18,31 @@ module.exports = { this.ui.verbose = commandOptions.verbose; process.env.DEPLOY_TARGET = commandOptions.deployTarget; - var PipelineTask = require('../tasks/pipeline'); - var pipeline = new PipelineTask({ + var ReadConfigTask = require('../tasks/read-config'); + var readConfig = new ReadConfigTask({ project: this.project, - ui: this.ui, deployTarget: commandOptions.deployTarget, - deployConfigPath: commandOptions.deployConfigFile, - commandOptions: commandOptions, - hooks: [ - 'configure', - 'setup', - 'fetchRevisions', - 'displayRevisions', - 'teardown' - ] + deployConfigFile: commandOptions.deployConfigFile }); + var self = this; + return readConfig.run().then(function(config){ + var PipelineTask = require('../tasks/pipeline'); + var pipeline = new PipelineTask({ + project: self.project, + ui: self.ui, + config: config, + deployTarget: commandOptions.deployTarget, + commandOptions: commandOptions, + hooks: [ + 'configure', + 'setup', + 'fetchRevisions', + 'displayRevisions', + 'teardown' + ] + }); - return pipeline.run(); + return pipeline.run(); + }); } }; diff --git a/lib/tasks/deploy.js b/lib/tasks/deploy.js index 54a25469..550680c0 100644 --- a/lib/tasks/deploy.js +++ b/lib/tasks/deploy.js @@ -1,6 +1,4 @@ var Task = require('ember-cli/lib/models/task'); -var existsSync = require('fs').existsSync; -var path = require('path'); var PipelineTask = require('../tasks/pipeline'); module.exports = Task.extend({ @@ -14,7 +12,7 @@ module.exports = Task.extend({ project: this.project, ui: this.ui, deployTarget: this.deployTarget, - deployConfigPath: this.deployConfigFile, + config: this.config, commandOptions: this.commandOptions, hooks: this._hooks(this.shouldActivate) }); @@ -22,9 +20,9 @@ module.exports = Task.extend({ }, _shouldActivate: function(options) { - var config = this._pipelineConfig(); - var referToPipelineConfig = (options.activate === undefined); - return referToPipelineConfig ? config.activateOnDeploy : options.activate; + var pipelineConfig = this.config['pipeline'] || {}; + var shouldReferToPipelineConfig = (options.activate === undefined); + return shouldReferToPipelineConfig ? pipelineConfig.activateOnDeploy : options.activate; }, _hooks: function(shouldActivate) { @@ -44,21 +42,5 @@ module.exports = Task.extend({ } return hooks; - }, - - _pipelineConfig: function() { - var root = this.project.root; - var filePath = this.deployConfigFile; - var fullPath = path.join(root, filePath); - var deployTarget = this.deployTarget; - - if (!existsSync(fullPath)) { - return {}; - } - - var fn = require(fullPath); - - return fn(deployTarget)['pipeline'] || {}; } - }); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 902f0eac..05a4cdea 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -22,58 +22,41 @@ module.exports = Task.extend({ throw new SilentError('You need to provide a deployTarget: `ember deploy production`'); } + if(!this.config) { + throw new SilentError('No config passed to pipeline task'); + } + this._pipeline = this.pipeline || new Pipeline(this.hooks, { ui: this.ui }); - var root = this.project.root; - this.commandOptions = this.commandOptions || {}; - - var dotEnvFilename = '.env.deploy.' + this.deployTarget; - var dotEnvFilePath = path.join(root, dotEnvFilename); - - if (existsSync(dotEnvFilePath)) { - dotenv.load({ - path: dotEnvFilename - }); - } - - this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; - - if (!existsSync(this.deployConfigPath)) { - throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); - } }, setup: function(){ var self = this; - return this._readDeployConfig().then(function(deployConfig){ - self._installedPlugins = self._discoverInstalledPlugins(); - - var plugins; - var configuredPluginList = deployConfig.plugins; - if (configuredPluginList) { - plugins = self._configuredPlugins(configuredPluginList, self._installedPlugins); - } else { - // no whitelist available, use all autodiscovered plugins - plugins = self._installedPlugins; - } - - var pluginNames = Object.keys(plugins); + self._installedPlugins = self._discoverInstalledPlugins(); + + var plugins; + var configuredPluginList = this.config.plugins; + if (configuredPluginList) { + plugins = self._configuredPlugins(configuredPluginList, self._installedPlugins); + } else { + // no whitelist available, use all autodiscovered plugins + plugins = self._installedPlugins; + } - if (pluginNames.length === 0) { - self.ui.writeError("\nWARNING: No plugins installed.\n"); - self.ui.writeError("ember-cli-deploy works by registering plugins in its pipeline."); - self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); - self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); - } + var pluginNames = Object.keys(plugins); - pluginNames.forEach(function(pluginName) { - self._registerPipelineHooks(plugins[pluginName], pluginName); - }); + if (pluginNames.length === 0) { + self.ui.writeError("\nWARNING: No plugins installed.\n"); + self.ui.writeError("ember-cli-deploy works by registering plugins in its pipeline."); + self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); + self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); + } - return deployConfig; + pluginNames.forEach(function(pluginName) { + self._registerPipelineHooks(plugins[pluginName], pluginName); }); }, @@ -102,28 +85,20 @@ module.exports = Task.extend({ }, run: function() { - var self = this; var pipeline = this._pipeline; var ui = this.ui; var project = this.project; var commandOptions = this.commandOptions; - return this.setup().then(function(deployConfig) { - var context = { - commandOptions: commandOptions, - config: deployConfig, - deployTarget: self.deployTarget, - project: project, - ui: ui - }; - return pipeline.execute(context); - }); - }, - - _readDeployConfig: function() { - var project = this.project; - var deployConfigFn = require(path.resolve(project.root, this.deployConfigPath)); - return Promise.resolve(deployConfigFn(this.deployTarget)); + this.setup(); + var context = { + commandOptions: commandOptions, + config: this.config, + deployTarget: this.deployTarget, + project: project, + ui: ui + }; + return pipeline.execute(context); }, _configuredPlugins: function(configuredPluginNames, availablePlugins) { diff --git a/lib/tasks/read-config.js b/lib/tasks/read-config.js new file mode 100644 index 00000000..bd23edf5 --- /dev/null +++ b/lib/tasks/read-config.js @@ -0,0 +1,50 @@ +var Task = require('ember-cli/lib/models/task'); +var Promise = require('ember-cli/lib/ext/promise'); +var SilentError = require('silent-error'); + +var existsSync = require('fs').existsSync; +var path = require('path'); +var dotenv = require('dotenv'); + +module.exports = Task.extend({ + init: function() { + if (!this.project) { + throw new SilentError('No project passed to read-config task'); + } + + if(!this.deployTarget) { + throw new SilentError('No deployTarget passed to read-config task'); + } + + this.root = this.project.root; + + this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; + + if (!existsSync(this.deployConfigPath)) { + throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); + } + }, + + run: function() { + this._loadDotEnv(); + return this._readDeployConfig(); + }, + + _loadDotEnv: function() { + var root = this.root; + var dotEnvFilename = '.env.deploy.' + this.deployTarget; + var dotEnvFilePath = path.join(root, dotEnvFilename); + + if (existsSync(dotEnvFilePath)) { + dotenv.load({ + path: dotEnvFilename + }); + } + }, + + _readDeployConfig: function() { + var root = this.root; + var deployConfigFn = require(path.resolve(root, this.deployConfigPath)); + return Promise.resolve(deployConfigFn(this.deployTarget)); + } +}); diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test.js b/node-tests/fixtures/config/deploy-for-addons-config-test.js deleted file mode 100644 index 35c807c1..00000000 --- a/node-tests/fixtures/config/deploy-for-addons-config-test.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = function(environment) { - return { - plugins: ['foo-plugin'] - }; -} diff --git a/node-tests/fixtures/config/deploy.js b/node-tests/fixtures/config/deploy.js index bf80fd4f..689b6e56 100644 --- a/node-tests/fixtures/config/deploy.js +++ b/node-tests/fixtures/config/deploy.js @@ -3,34 +3,23 @@ module.exports = function(environment) { if (environment === 'development') { ENV.build = { - buildEnv: 'development' + environment: 'development' }; - ENV.store = { - host: 'localhost', - port: 6379 - }; - - ENV.assets = { - accessKeyId: '', - secretAccessKey: '', - bucket: '' + ENV.s3 = { + bucket: 'shineonyoucrazy', + region: 'us-east-1' }; } if (environment === 'staging') { - ENV.buildEnv = 'staging'; - - ENV.store = { - host: 'staging-redis.firstiwaslike.com', - port: 6379 + ENV.build = { + environment: 'production' }; - ENV.assets = { - accessKeyId: '', - secretAccessKey: '', - bucket: '', - prefix: '' + ENV.s3 = { + bucket: 'keepitreal', + region: 'us-east-1' }; } diff --git a/node-tests/unit/tasks/deploy-test.js b/node-tests/unit/tasks/deploy-test.js index 78c7d9fa..b5c68ef9 100644 --- a/node-tests/unit/tasks/deploy-test.js +++ b/node-tests/unit/tasks/deploy-test.js @@ -4,9 +4,18 @@ var expect = require('../../helpers/expect'); var assert = require('chai').assert; describe('DeployTask', function() { - var mockProject = {addons: []}; - var mockConfig = {}; - var mockUi = { write: function() {}, writeError: function() {} }; + var mockProject = {addons: []}; + var mockPostBuildConfig = { + pipeline: { + activateOnDeploy: true + } + }; + var mockDeployConfig = { + build: { + buildEnv: 'development' + } + }; + var mockUi = { write: function() {}, writeError: function() {} }; describe('creating and setting up a new instance', function() { @@ -16,7 +25,7 @@ describe('DeployTask', function() { project: mockProject, ui: mockUi, deployTarget: 'development-postbuild', - deployConfigFile: 'node-tests/fixtures/config/deploy-postbuild.js', + config: mockPostBuildConfig, shouldActivate: true }); expect(deploy.shouldActivate).to.eq(true); @@ -32,7 +41,7 @@ describe('DeployTask', function() { project: project, ui: mockUi, deployTarget: 'development-postbuild', - deployConfigFile: 'node-tests/fixtures/config/deploy-postbuild.js', + config: mockPostBuildConfig, }); expect(deploy.shouldActivate).to.eq(true); }); @@ -47,7 +56,7 @@ describe('DeployTask', function() { project: project, ui: mockUi, deployTarget: 'development-postbuild', - deployConfigFile: 'node-tests/fixtures/config/deploy.js', + config: mockDeployConfig, commandOptions: { activate: true } @@ -71,7 +80,7 @@ describe('DeployTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigFile: 'node-tests/fixtures/config/deploy.js', + config: mockDeployConfig, _pipeline: { run: function() { pipelineExecuted = true; @@ -86,6 +95,13 @@ describe('DeployTask', function() { }); }); }); + + describe('setting environment variables from .env', function() { + beforeEach(function(){ + delete process.env.ENVTEST; + }); + }); + }); }); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 7ae997e4..1e206a4d 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -37,50 +37,24 @@ describe('PipelineTask', function() { var fn = function() { new PipelineTask({ project: mockProject, - ui: mockUi + ui: mockUi, + config: mockConfig }); }; expect(fn).to.throw('You need to provide a deployTarget: `ember deploy production`'); }); - it('accepts an absolute deployConfigPath', function() { - var fn = function () { + it('raises an error if config is not provided', function() { + var fn = function() { new PipelineTask({ project: mockProject, ui: mockUi, - deployTarget: 'development', - deployConfigPath: path.join(process.cwd(), 'node-tests/fixtures/config/deploy.js'), - hooks: ['willDeploy', 'upload'] - }).run(); - }; - - assert.doesNotThrow(fn, /Cannot find module/, 'config file could not be read'); - }); - - describe('setting environment variables from .env', function() { - beforeEach(function(){ - delete process.env.ENVTEST; - }); - it('sets the process.env vars if a .env file exists for deploy environment', function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [] - }; - - assert.isUndefined(process.env.ENVTEST); - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', - hooks: ['willDeploy', 'upload'] + deployTarget: 'development' }); + }; - assert.equal(process.env.ENVTEST, 'SUCCESS'); - }); + expect(fn).to.throw('No config passed to pipeline task'); }); describe('registering addons with the pipeline', function() { @@ -111,17 +85,16 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: mockConfig, hooks: ['willDeploy', 'upload'] }); - return task.setup().then(function(){ - var registeredHooks = task._pipeline._pipelineHooks; + task.setup(); + var registeredHooks = task._pipeline._pipelineHooks; - expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload[0].name).to.eq('test-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); - }); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); }); it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { @@ -150,7 +123,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: mockConfig, hooks: ['willDeploy', 'upload'] }); @@ -182,7 +155,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: mockConfig, hooks: ['willDeploy', 'upload'] }); @@ -233,19 +206,18 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test.js', + config: { plugins: ['foo-plugin'] }, hooks: ['willDeploy', 'upload'] }); - return task.setup().then(function(){ - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy.length).to.equal(1); - expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload.length).to.equal(1); - expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); - }); + task.setup(); + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy.length).to.equal(1); + expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload.length).to.equal(1); + expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); }); it('registers dependent plugin addons of a plugin pack addon designated by the ember-cli-deploy-plugin-pack keyword', function() { var project = { @@ -284,19 +256,18 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: mockConfig, hooks: ['willDeploy', 'upload'] }); - return task.setup().then(function(){ - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy.length).to.eq(1); - expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload.length).to.eq(1); - expect(registeredHooks.upload[0].name).to.eq('test-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); - }); + task.setup(); + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy.length).to.eq(1); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload.length).to.eq(1); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); }); }); }); @@ -316,7 +287,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: { build: { environment: 'development' }}, commandOptions: {revision: '123abc'}, hooks: ['willDeploy', 'upload'], pipeline: { @@ -334,7 +305,7 @@ describe('PipelineTask', function() { expect(pipelineContext.ui).to.eq(mockUi); expect(pipelineContext.project).to.eq(project); expect(pipelineContext.deployTarget).to.eq('development'); - expect(pipelineContext.config.build.buildEnv).to.eq('development'); + expect(pipelineContext.config.build.environment).to.eq('development'); expect(pipelineContext.commandOptions.revision).to.eq('123abc'); }); }); @@ -377,7 +348,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js', + config: mockConfig, commandOptions: {revision: '123abc'}, hooks: ['willDeploy', 'upload'], pipeline: new Pipeline(['willDeploy', 'upload'], { @@ -385,9 +356,8 @@ describe('PipelineTask', function() { }) }); - return task.setup().then(function(){ - return expect(task.run()).to.be.fulfilled; - }).then(function() { + task.setup(); + return expect(task.run()).to.be.fulfilled.then(function() { var logLines = logOutput.split("\n"); expect(logLines[ 0]).to.eq("\u001b[34mRegistering hook -> willDeploy[test-plugin]"); expect(logLines[ 1]).to.eq("\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]"); @@ -437,7 +407,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'staging', - deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js', + config: { plugins: ['foo-plugin:bar-alias'] }, pipeline: { hookNames: function () { return []; @@ -445,9 +415,8 @@ describe('PipelineTask', function() { } }); - return task.setup().then(function() { - expect(correctAliasUsed).to.be.true; - }); + task.setup(); + expect(correctAliasUsed).to.be.true; }); it('passes correct name to multiple instances of the same plugin', function () { @@ -479,7 +448,7 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'staging', - deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', + config: { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }, pipeline: { hookNames: function () { return []; @@ -487,15 +456,13 @@ describe('PipelineTask', function() { } }); - return task.setup().then(function() { - expect(correctAliasUsed['foo-plugin']).to.be.true; - expect(correctAliasUsed['bar-alias']).to.be.true; - expect(correctAliasUsed['doo-alias']).to.be.true; - }); + task.setup(); + expect(correctAliasUsed['foo-plugin']).to.be.true; + expect(correctAliasUsed['bar-alias']).to.be.true; + expect(correctAliasUsed['doo-alias']).to.be.true; }); it('throws error on non-existent plugin in whitelist and appends them to err.unavailablePlugins', function () { - var correctAliasUsed = false; var project = { name: function() {return 'test-project';}, root: process.cwd() @@ -505,12 +472,16 @@ describe('PipelineTask', function() { project: project, ui: mockUi, deployTarget: 'production', + config: { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }, deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', }); - return task.setup().then(null, function(err) { - assert.equal(Object.keys(err.unavailablePlugins).length, 3); - }); + try { + task.setup(); + expect(false).to.be.true; + } catch(err) { + expect(Object.keys(err.unavailablePlugins).length).to.equal(3); + } }); }); }); diff --git a/node-tests/unit/tasks/read-config-test.js b/node-tests/unit/tasks/read-config-test.js new file mode 100644 index 00000000..395037e8 --- /dev/null +++ b/node-tests/unit/tasks/read-config-test.js @@ -0,0 +1,78 @@ +var Promise = require('ember-cli/lib/ext/promise'); +var ReadConfigTask = require('../../../lib/tasks/read-config'); +var expect = require('../../helpers/expect'); +var assert = require('chai').assert; + +describe('ReadConfigTask', function() { + var mockProject = {addons: []}; + var mockPostBuildConfig = { + pipeline: { + activateOnDeploy: true + } + }; + var mockDeployConfig = { + build: { + buildEnv: 'development' + } + }; + var mockUi = { write: function() {}, writeError: function() {} }; + + describe('#run', function() { + it('reads from the config file', function(done){ + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + + var task = new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js' + }); + task.run().then(function(config){ + assert.equal(config.build.environment, 'development'); + assert.equal(config.s3.bucket, 'shineonyoucrazy'); + done(); + }); + }); + + it('accepts an absolute deployConfigPath', function() { + var fn = function () { + new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigPath: path.join(process.cwd(), 'node-tests/fixtures/config/deploy.js') + }).run(); + }; + + assert.doesNotThrow(fn, /Cannot find module/, 'config file could not be read'); + }); + + describe('setting environment variables from .env', function() { + beforeEach(function(){ + delete process.env.ENVTEST; + }); + it('sets the process.env vars if a .env file exists for deploy environment', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + + assert.isUndefined(process.env.ENVTEST); + + var task = new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigPath: 'node-tests/fixtures/config/deploy.js' + }); + task.run(); + + assert.equal(process.env.ENVTEST, 'SUCCESS'); + }); + }); + + }); + +}); From 96ea81223c47b6272aaa4ac5f91866ec8bec765e Mon Sep 17 00:00:00 2001 From: Seth Pollack Date: Fri, 4 Dec 2015 11:37:48 -0500 Subject: [PATCH 182/300] add `fetchRevisions`hook to deploy and activate pipelines --- lib/commands/activate.js | 2 ++ lib/tasks/deploy.js | 15 ++++++++------- 2 files changed, 10 insertions(+), 7 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 20da3030..d31d7e2b 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -36,8 +36,10 @@ module.exports = { hooks: [ 'configure', 'setup', + 'fetchInitialRevisions', 'willActivate', 'activate', + 'fetchRevisions', 'didActivate', 'teardown' ] diff --git a/lib/tasks/deploy.js b/lib/tasks/deploy.js index 550680c0..e1c7e0df 100644 --- a/lib/tasks/deploy.js +++ b/lib/tasks/deploy.js @@ -31,16 +31,17 @@ module.exports = Task.extend({ 'willDeploy', 'willBuild', 'build', 'didBuild', 'willPrepare', 'prepare', 'didPrepare', - 'willUpload', 'upload', 'didUpload', - 'willActivate', 'activate', 'didActivate', - 'didDeploy', - 'teardown' - ]; + 'fetchInitialRevisions', + 'willUpload', 'upload', 'didUpload']; - if (!shouldActivate) { - hooks.splice(hooks.indexOf('willActivate'), 3); + if (shouldActivate) { + hooks.push('willActivate', 'activate', 'fetchRevisions', 'didActivate'); + } else { + hooks.push('fetchRevisions'); } + hooks.push('didDeploy', 'teardown'); + return hooks; } }); From c1766b39a7baa11d54d861cd3664949f85069f52 Mon Sep 17 00:00:00 2001 From: Kevin Pfefferle Date: Tue, 29 Dec 2015 23:51:02 -0500 Subject: [PATCH 183/300] Allow command options to be set in .ember-cli file --- lib/commands/activate.js | 9 +++++++-- lib/commands/deploy.js | 10 ++++++++-- lib/commands/list.js | 12 +++++++++--- lib/commands/option-value.js | 9 +++++++++ 4 files changed, 33 insertions(+), 7 deletions(-) create mode 100644 lib/commands/option-value.js diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 20da3030..b97050ce 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -1,3 +1,5 @@ +var chooseOptionValue = require('./option-value'); + module.exports = { name: 'deploy:activate', description: 'Activates a passed deploy-revision', @@ -6,7 +8,7 @@ module.exports = { availableOptions: [ { name: 'revision', type: String, required: true }, { name: 'verbose', type: Boolean }, - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' } + { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' } ], anonymousOptions: [ @@ -15,7 +17,10 @@ module.exports = { run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); - this.ui.verbose = commandOptions.verbose; + + this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var ReadConfigTask = require('../tasks/read-config'); diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index f97b3a02..580df889 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,3 +1,5 @@ +var chooseOptionValue = require('./option-value'); + module.exports = { name: 'deploy', description: 'Deploys an ember-cli app', @@ -8,14 +10,18 @@ module.exports = { ], availableOptions: [ - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, { name: 'verbose', type: Boolean }, { name: 'activate', type: Boolean } ], run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); - this.ui.verbose = commandOptions.verbose; + + commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); + this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + commandOptions.activate = chooseOptionValue(commandOptions.activate, this.settings, 'activate'); + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var ReadConfigTask = require('../tasks/read-config'); diff --git a/lib/commands/list.js b/lib/commands/list.js index 90b6d374..3a5108de 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -1,3 +1,5 @@ +var chooseOptionValue = require('./option-value'); + module.exports = { name: 'deploy:list', description: 'Lists the currently uploaded deploy-revisions', @@ -8,14 +10,18 @@ module.exports = { ], availableOptions: [ - { name: 'deploy-config-file', type: String, default: 'config/deploy.js' }, + { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, { name: 'verbose', type: Boolean }, - { name: 'amount', type: Number, default: 10 } + { name: 'amount', type: Number, description: '(Default: 10)' } ], run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); - this.ui.verbose = commandOptions.verbose; + + commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); + this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + commandOptions.amount = chooseOptionValue(commandOptions.amount, this.settings, 'amount', 10); + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var ReadConfigTask = require('../tasks/read-config'); diff --git a/lib/commands/option-value.js b/lib/commands/option-value.js new file mode 100644 index 00000000..27138e43 --- /dev/null +++ b/lib/commands/option-value.js @@ -0,0 +1,9 @@ +module.exports = function(commandOption, settings, optionKey, defaultValue) { + if (commandOption !== undefined) { + return commandOption; + } + if (settings && settings['ember-cli-deploy'] && settings['ember-cli-deploy'][optionKey] !== undefined) { + return settings['ember-cli-deploy'][optionKey]; + } + return defaultValue; +}; From 1c1c9b6d07e8c7e6da846132bf4e3293f12d0910 Mon Sep 17 00:00:00 2001 From: Ben Limmer Date: Fri, 8 Jan 2016 13:53:54 -0700 Subject: [PATCH 184/300] Update README.md to ember install vs. npm install. So the default blueprint is run. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3587c33d..89567b68 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Simple, flexible deployment for your Ember CLI app ## Installation ``` -npm install ember-cli-deploy --save-dev +ember install ember-cli-deploy ``` ## Quick start From c91b49a18bdd1fbf8525055be30620cd1807a6f2 Mon Sep 17 00:00:00 2001 From: Ben Limmer Date: Sat, 9 Jan 2016 11:30:10 -0700 Subject: [PATCH 185/300] Allow loading .env files + .env.deploy. files Fixes #341. --- .env.deploy.development | 1 - lib/tasks/read-config.js | 23 +++++++--- node-tests/fixtures/.env | 2 + node-tests/fixtures/.env.deploy.development | 2 + node-tests/unit/tasks/read-config-test.js | 50 ++++++++++++++++++--- 5 files changed, 63 insertions(+), 15 deletions(-) delete mode 100644 .env.deploy.development create mode 100644 node-tests/fixtures/.env create mode 100644 node-tests/fixtures/.env.deploy.development diff --git a/.env.deploy.development b/.env.deploy.development deleted file mode 100644 index 3c73ec85..00000000 --- a/.env.deploy.development +++ /dev/null @@ -1 +0,0 @@ -ENVTEST=SUCCESS diff --git a/lib/tasks/read-config.js b/lib/tasks/read-config.js index bd23edf5..9051c28a 100644 --- a/lib/tasks/read-config.js +++ b/lib/tasks/read-config.js @@ -20,7 +20,7 @@ module.exports = Task.extend({ this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; - if (!existsSync(this.deployConfigPath)) { + if (!existsSync(path.join(this.root, this.deployConfigPath))) { throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); } }, @@ -32,14 +32,23 @@ module.exports = Task.extend({ _loadDotEnv: function() { var root = this.root; - var dotEnvFilename = '.env.deploy.' + this.deployTarget; + + var deployDotEnvFilename = '.env.deploy.' + this.deployTarget; + var deployDotEnvFilePath = path.join(root, deployDotEnvFilename); + + var dotEnvFilename = '.env'; var dotEnvFilePath = path.join(root, dotEnvFilename); - if (existsSync(dotEnvFilePath)) { - dotenv.load({ - path: dotEnvFilename - }); - } + // order is important here. vars defined in files loaded first + // will override files loaded after. + var paths = [deployDotEnvFilePath, dotEnvFilePath]; + paths.forEach(function(path) { + if (existsSync(path)) { + dotenv.load({ + path: path + }); + } + }); }, _readDeployConfig: function() { diff --git a/node-tests/fixtures/.env b/node-tests/fixtures/.env new file mode 100644 index 00000000..3b00078f --- /dev/null +++ b/node-tests/fixtures/.env @@ -0,0 +1,2 @@ +OVERRIDDEN='main-dot-env-flavor' +SHARED='shared-key' diff --git a/node-tests/fixtures/.env.deploy.development b/node-tests/fixtures/.env.deploy.development new file mode 100644 index 00000000..ce433b62 --- /dev/null +++ b/node-tests/fixtures/.env.deploy.development @@ -0,0 +1,2 @@ +ENVTEST=SUCCESS +OVERRIDDEN='deploy-env-flavor' diff --git a/node-tests/unit/tasks/read-config-test.js b/node-tests/unit/tasks/read-config-test.js index 395037e8..3be400ce 100644 --- a/node-tests/unit/tasks/read-config-test.js +++ b/node-tests/unit/tasks/read-config-test.js @@ -2,6 +2,7 @@ var Promise = require('ember-cli/lib/ext/promise'); var ReadConfigTask = require('../../../lib/tasks/read-config'); var expect = require('../../helpers/expect'); var assert = require('chai').assert; +var path = require('path'); describe('ReadConfigTask', function() { var mockProject = {addons: []}; @@ -50,27 +51,62 @@ describe('ReadConfigTask', function() { }); describe('setting environment variables from .env', function() { + var project; + var customDotEnvVars = [ + 'OVERRIDDEN', + 'SHARED', + 'ENVTEST' + ]; + beforeEach(function(){ - delete process.env.ENVTEST; - }); - it('sets the process.env vars if a .env file exists for deploy environment', function() { - var project = { + customDotEnvVars.forEach(function(dotEnvVar) { + delete process.env[dotEnvVar]; + }); + + project = { name: function() {return 'test-project';}, - root: process.cwd(), + root: path.join(process.cwd(), 'node-tests/fixtures'), addons: [] }; - + }); + it('sets the process.env vars if a .env file exists for deploy environment', function() { assert.isUndefined(process.env.ENVTEST); var task = new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js' + deployConfigPath: 'config/deploy.js' }); task.run(); assert.equal(process.env.ENVTEST, 'SUCCESS'); }); + + it('sets the process.env vars from main .env file', function() { + assert.isUndefined(process.env.SHARED); + + var task = new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigPath: 'config/deploy.js' + }); + task.run(); + + assert.equal(process.env.SHARED, 'shared-key'); + }); + + it('overrides vars from main .env file if defined in deploy environment .env file', function() { + assert.isUndefined(process.env.OVERRIDDEN); + + var task = new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigPath: 'config/deploy.js' + }); + task.run(); + + assert.equal(process.env.OVERRIDDEN, 'deploy-env-flavor'); + }); }); }); From aae65c3ae8bc7faf57d2e029baf8ff05f6ef4a81 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 11 Jan 2016 23:27:28 -0500 Subject: [PATCH 186/300] Use the default blueprint instead of one with a custom name. Fixes #203 --- .../{deploy-config => ember-cli-deploy}/files/config/deploy.js | 0 blueprints/{deploy-config => ember-cli-deploy}/index.js | 0 package.json | 3 +-- 3 files changed, 1 insertion(+), 2 deletions(-) rename blueprints/{deploy-config => ember-cli-deploy}/files/config/deploy.js (100%) rename blueprints/{deploy-config => ember-cli-deploy}/index.js (100%) diff --git a/blueprints/deploy-config/files/config/deploy.js b/blueprints/ember-cli-deploy/files/config/deploy.js similarity index 100% rename from blueprints/deploy-config/files/config/deploy.js rename to blueprints/ember-cli-deploy/files/config/deploy.js diff --git a/blueprints/deploy-config/index.js b/blueprints/ember-cli-deploy/index.js similarity index 100% rename from blueprints/deploy-config/index.js rename to blueprints/ember-cli-deploy/index.js diff --git a/package.json b/package.json index 3e446540..40f270aa 100644 --- a/package.json +++ b/package.json @@ -40,8 +40,7 @@ "ember-cli-deploy" ], "ember-addon": { - "configPath": "tests/dummy/config", - "defaultBlueprint": "deploy-config" + "configPath": "tests/dummy/config" }, "dependencies": { "broccoli": "^0.13.2", From 832aee9ecfe0c7f5f60b2e924f583d25a8500b01 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Mon, 11 Jan 2016 12:51:17 -0500 Subject: [PATCH 187/300] fixes to postBuildHook --- index.js | 10 ++++---- node-tests/unit/index-test.js | 48 +++++++++++++++++++++++++++++++++++ 2 files changed, 53 insertions(+), 5 deletions(-) create mode 100644 node-tests/unit/index-test.js diff --git a/index.js b/index.js index d494b623..ba57fd75 100644 --- a/index.js +++ b/index.js @@ -13,6 +13,7 @@ module.exports = { }, postBuild: function(result) { + var _this = this; if (!this.app) { // You will need ember-cli >= 1.13 to use ember-cli-deploy's postBuild integration. // This is because prior to 1.13, `this.app` is not available in the postBuild hook. @@ -22,18 +23,17 @@ module.exports = { var deployTarget = options.runOnPostBuild; if (deployTarget) { - - var ReadConfigTask = require('../tasks/read-config'); + var ReadConfigTask = require('./lib/tasks/read-config'); var readConfig = new ReadConfigTask({ project: this.project, deployTarget: deployTarget, - deployConfigFile: options.configFile + deployConfigPath: options.configFile }); return readConfig.run().then(function(config){ var DeployTask = require('./lib/tasks/deploy'); var deploy = new DeployTask({ - project: this.project, - ui: this.ui, + project: _this.project, + ui: _this.ui, deployTarget: deployTarget, config: config, shouldActivate: options.shouldActivate, diff --git a/node-tests/unit/index-test.js b/node-tests/unit/index-test.js new file mode 100644 index 00000000..459d27a6 --- /dev/null +++ b/node-tests/unit/index-test.js @@ -0,0 +1,48 @@ +var Promise = require('ember-cli/lib/ext/promise'); +var assert = require('ember-cli/tests/helpers/assert'); + +describe ('ember-cli-deploy', function() { + var subject; + beforeEach(function() { + subject = require('../../index.js'); + }); + describe('postBuild', function() { + it('requires an app', function() { + assert(!subject.postBuild(), 'returns false'); + }); + + it('requires a deployTarget', function() { + var context = { + app: { + options: { + emberCLIDeploy: { + runOnPostBuild: null + } + } + } + }; + + assert(!subject.postBuild.apply(context)); + }); + + it('reads the config', function() { + var context = { + project: { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }, + app: { + options: { + emberCLIDeploy: { + runOnPostBuild: 'production', + configFile: 'node-tests/fixtures/config/deploy.js' + } + } + } + }; + + assert(subject.postBuild.apply(context)); + }); + }); +}); From 8aad00736c21dea827faaaf08bc0ce33cd8650a8 Mon Sep 17 00:00:00 2001 From: Edward Faulkner Date: Tue, 19 Jan 2016 20:44:17 -0500 Subject: [PATCH 188/300] code cleanup This change: - adds jshinting to the test suite - makes jshint pass, including some dead code removal - fixes the test script definition so it properly expands and finds all tests --- .jshintignore | 5 +++ lib/tasks/pipeline.js | 6 --- node-tests/.jshintrc | 38 +++++++++++++++++++ .../fixtures/config-with-defaults/deploy.js | 2 +- ...eploy-for-addons-config-test-with-alias.js | 4 +- ...loy-for-addons-config-test-with-aliases.js | 4 +- node-tests/fixtures/config/deploy.js | 2 +- node-tests/unit/index-test.js | 1 - node-tests/unit/jshint-test.js | 1 + node-tests/unit/models/pipeline-test.js | 8 ++-- node-tests/unit/tasks/deploy-test.js | 2 - node-tests/unit/tasks/pipeline-test.js | 2 - node-tests/unit/tasks/read-config-test.js | 21 +++------- package.json | 5 ++- 14 files changed, 63 insertions(+), 38 deletions(-) create mode 100644 .jshintignore create mode 100644 node-tests/.jshintrc create mode 100644 node-tests/unit/jshint-test.js diff --git a/.jshintignore b/.jshintignore new file mode 100644 index 00000000..f997baa2 --- /dev/null +++ b/.jshintignore @@ -0,0 +1,5 @@ +/dist +/tmp +/node_modules +/bower_components + diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 05a4cdea..00bcece5 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -1,11 +1,5 @@ var Task = require('ember-cli/lib/models/task'); -var Promise = require('ember-cli/lib/ext/promise'); var SilentError = require('silent-error'); - -var existsSync = require('fs').existsSync; -var path = require('path'); -var dotenv = require('dotenv'); - var Pipeline = require('../models/pipeline'); module.exports = Task.extend({ diff --git a/node-tests/.jshintrc b/node-tests/.jshintrc new file mode 100644 index 00000000..b40b91b4 --- /dev/null +++ b/node-tests/.jshintrc @@ -0,0 +1,38 @@ +{ + "predef": [ + "document", + "window", + "-Promise", + "describe", + "beforeEach", + "afterEach", + "it" + ], + "browser": true, + "boss": true, + "curly": true, + "debug": false, + "devel": true, + "eqeqeq": true, + "evil": true, + "forin": false, + "immed": false, + "laxbreak": false, + "newcap": true, + "noarg": true, + "noempty": false, + "nonew": false, + "nomen": false, + "onevar": false, + "plusplus": false, + "regexp": false, + "undef": true, + "sub": true, + "strict": false, + "white": false, + "eqnull": true, + "esnext": true, + "unused": true, + "node": true, + "expr": true +} diff --git a/node-tests/fixtures/config-with-defaults/deploy.js b/node-tests/fixtures/config-with-defaults/deploy.js index 4f60cf6b..2361b33a 100644 --- a/node-tests/fixtures/config-with-defaults/deploy.js +++ b/node-tests/fixtures/config-with-defaults/deploy.js @@ -49,4 +49,4 @@ module.exports = { "type": "s3" } } -} +}; diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js b/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js index cd4e5790..9ff332c7 100644 --- a/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js +++ b/node-tests/fixtures/config/deploy-for-addons-config-test-with-alias.js @@ -1,5 +1,5 @@ -module.exports = function(environment) { +module.exports = function(/* environment */) { return { plugins: ['foo-plugin:bar-alias'] }; -} +}; diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js b/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js index 2076a6d8..b4e8da86 100644 --- a/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js +++ b/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js @@ -1,5 +1,5 @@ -module.exports = function(environment) { +module.exports = function(/* environment */) { return { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }; -} +}; diff --git a/node-tests/fixtures/config/deploy.js b/node-tests/fixtures/config/deploy.js index 689b6e56..8c852076 100644 --- a/node-tests/fixtures/config/deploy.js +++ b/node-tests/fixtures/config/deploy.js @@ -24,4 +24,4 @@ module.exports = function(environment) { } return ENV; -} +}; diff --git a/node-tests/unit/index-test.js b/node-tests/unit/index-test.js index 459d27a6..e1776945 100644 --- a/node-tests/unit/index-test.js +++ b/node-tests/unit/index-test.js @@ -1,4 +1,3 @@ -var Promise = require('ember-cli/lib/ext/promise'); var assert = require('ember-cli/tests/helpers/assert'); describe ('ember-cli-deploy', function() { diff --git a/node-tests/unit/jshint-test.js b/node-tests/unit/jshint-test.js new file mode 100644 index 00000000..ee8b8294 --- /dev/null +++ b/node-tests/unit/jshint-test.js @@ -0,0 +1 @@ +require('mocha-jshint')(); diff --git a/node-tests/unit/models/pipeline-test.js b/node-tests/unit/models/pipeline-test.js index 1a40df03..ed94cfc6 100644 --- a/node-tests/unit/models/pipeline-test.js +++ b/node-tests/unit/models/pipeline-test.js @@ -24,7 +24,7 @@ describe ('Pipeline', function() { subject.register('willDeploy', fn); - expect(subject._pipelineHooks.willDeploy.length).to.eq(1) + expect(subject._pipelineHooks.willDeploy.length).to.eq(1); expect(subject._pipelineHooks.willDeploy[0].name).to.eq('anonymous function'); expect(subject._pipelineHooks.willDeploy[0].fn).to.eql(fn); }); @@ -37,7 +37,7 @@ describe ('Pipeline', function() { subject.register('build', fn); - expect(subject._pipelineHooks.willDeploy.length).to.eq(0) + expect(subject._pipelineHooks.willDeploy.length).to.eq(0); expect(subject._pipelineHooks.build).to.eq(undefined); }); }); @@ -122,7 +122,7 @@ describe ('Pipeline', function() { var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var finalContext = null; - subject.register('hook1', function(context) { + subject.register('hook1', function() { return {age: 47}; }); @@ -141,7 +141,7 @@ describe ('Pipeline', function() { var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); var finalContext = null; - subject.register('hook1', function(context) { + subject.register('hook1', function() { return Promise.resolve({age: 47}); }); diff --git a/node-tests/unit/tasks/deploy-test.js b/node-tests/unit/tasks/deploy-test.js index b5c68ef9..8766a441 100644 --- a/node-tests/unit/tasks/deploy-test.js +++ b/node-tests/unit/tasks/deploy-test.js @@ -1,7 +1,6 @@ var Promise = require('ember-cli/lib/ext/promise'); var DeployTask = require('../../../lib/tasks/deploy'); var expect = require('../../helpers/expect'); -var assert = require('chai').assert; describe('DeployTask', function() { var mockProject = {addons: []}; @@ -68,7 +67,6 @@ describe('DeployTask', function() { describe('executing the deployTask', function() { it ('executes the pipelineTask', function() { var pipelineExecuted = false; - var pipelineContext; var project = { name: function() {return 'test-project';}, diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 1e206a4d..79c69968 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -2,8 +2,6 @@ var Promise = require('ember-cli/lib/ext/promise'); var PipelineTask = require('../../../lib/tasks/pipeline'); var Pipeline = require('../../../lib/models/pipeline'); var expect = require('../../helpers/expect'); -var assert = require('chai').assert; -var path = require('path'); describe('PipelineTask', function() { var mockProject = {addons: [], root: process.cwd()}; diff --git a/node-tests/unit/tasks/read-config-test.js b/node-tests/unit/tasks/read-config-test.js index 3be400ce..02b7ddc5 100644 --- a/node-tests/unit/tasks/read-config-test.js +++ b/node-tests/unit/tasks/read-config-test.js @@ -1,23 +1,8 @@ -var Promise = require('ember-cli/lib/ext/promise'); var ReadConfigTask = require('../../../lib/tasks/read-config'); -var expect = require('../../helpers/expect'); var assert = require('chai').assert; var path = require('path'); describe('ReadConfigTask', function() { - var mockProject = {addons: []}; - var mockPostBuildConfig = { - pipeline: { - activateOnDeploy: true - } - }; - var mockDeployConfig = { - build: { - buildEnv: 'development' - } - }; - var mockUi = { write: function() {}, writeError: function() {} }; - describe('#run', function() { it('reads from the config file', function(done){ var project = { @@ -39,6 +24,12 @@ describe('ReadConfigTask', function() { }); it('accepts an absolute deployConfigPath', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + var fn = function () { new ReadConfigTask({ project: project, diff --git a/package.json b/package.json index 40f270aa..403e42c6 100644 --- a/package.json +++ b/package.json @@ -9,8 +9,8 @@ "scripts": { "start": "ember server", "build": "ember build", - "test": "node node_modules/mocha/bin/mocha node-tests/**/*-test.js", - "autotest": "node node_modules/mocha/bin/mocha --watch --reporter spec node-tests/**/*-test.js" + "test": "node node_modules/mocha/bin/mocha 'node-tests/**/*-test.js'", + "autotest": "node node_modules/mocha/bin/mocha --watch --reporter spec 'node-tests/**/*-test.js'" }, "repository": "https://github.com/ember-cli/ember-cli-deploy", "engines": { @@ -33,6 +33,7 @@ "ember-cli-qunit": "^1.0.0", "github": "0.2.3", "mocha": "^2.0.1", + "mocha-jshint": "^2.2.6", "sinon": "^1.12.1" }, "keywords": [ From 86f3c062ac2d74d559459aeb0389a01d20951b16 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Wed, 28 Oct 2015 22:19:10 -0400 Subject: [PATCH 189/300] display progress notification during deploy --- lib/commands/deploy.js | 14 ++-- lib/models/pipeline.js | 46 ++++++++--- node-tests/helpers/fake-progress-bar.js | 11 +++ node-tests/unit/models/pipeline-test.js | 101 ++++++++++++++++++++++++ package.json | 1 + 5 files changed, 159 insertions(+), 14 deletions(-) create mode 100644 node-tests/helpers/fake-progress-bar.js diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 580df889..1626b5d2 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -9,19 +9,24 @@ module.exports = { '' ], + // note: we can not use `default` from ember-cli because we need to use + // settings from .ember-cli config-file as secondary defaults availableOptions: [ { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, - { name: 'verbose', type: Boolean }, - { name: 'activate', type: Boolean } + { name: 'verbose', type: Boolean, description: '(Default: false)' }, + { name: 'activate', type: Boolean, description: '(Default: false)' }, + { name: 'show-progress', type: Boolean, aliases: ['p', 'progress'], description: '(Default: true)'} ], run: function(commandOptions, rawArgs) { commandOptions.deployTarget = rawArgs.shift(); commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); - this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); commandOptions.activate = chooseOptionValue(commandOptions.activate, this.settings, 'activate'); + this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + this.ui.showProgress = chooseOptionValue(commandOptions.showProgress, this.settings, 'showProgress', process.stdout.isTTY ? true : false); + process.env.DEPLOY_TARGET = commandOptions.deployTarget; var ReadConfigTask = require('../tasks/read-config'); @@ -43,6 +48,5 @@ module.exports = { return deploy.run(); }); - }, - + } }; diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index 6f0541d1..d72ab36b 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -22,6 +22,8 @@ function Pipeline(hookNames, options) { return pipelineHooks; }, { didFail: [] }); + + this._progressBarLib = options.progressBarLib || require('progress'); } Pipeline.prototype.register = function(hookName, fn) { @@ -48,15 +50,20 @@ Pipeline.prototype.execute = function(context) { context = context || { }; var ui = this._ui; + var hooks = this._hooksWithoutDidFail(this.hookNames()); + var ProgressBar = this._progressBarLib; if (ui.verbose) { ui.write(blue('Executing pipeline\n')); + } else if (ui.showProgress) { + ui.progressBar = new ProgressBar( (process.platform === 'darwin' ? '🚀 ' : '') + 'deploy progress [:bar] :percent [plugin: :plugin -> :hook]', { + total: this._hooksCount(this._hooksWithoutConfigure(hooks)) + }); } - return this._hooksWithoutDidFail(this.hookNames()) - .reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) - .then(this._notifyPipelineCompletion.bind(this, ui)) - .catch(this._handlePipelineFailure.bind(this, ui, context)) - .catch(this._abortPipelineExecution.bind(this, ui)); + return hooks.reduce(this._addHookExecutionPromiseToPipelinePromiseChain.bind(this, ui), Promise.resolve(context)) + .then(this._notifyPipelineCompletion.bind(this, ui)) + .catch(this._handlePipelineFailure.bind(this, ui, context)) + .catch(this._abortPipelineExecution.bind(this, ui)); }; Pipeline.prototype.hookNames = function() { @@ -82,6 +89,19 @@ Pipeline.prototype._hooksWithoutDidFail = function(hooks) { }); }; +Pipeline.prototype._hooksWithoutConfigure = function(hooks) { + return hooks.filter(function(hook) { + return hook !== 'configure'; + }); +}; + +Pipeline.prototype._hooksCount = function(hooks) { + return hooks.reduce(function(sum, hookName) { + var hookFunctions = this._pipelineHooks[hookName]; + return sum + hookFunctions.length; + }.bind(this), 0); +}; + Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { if (ui.verbose) { ui.write(red('|\n')); @@ -119,20 +139,28 @@ Pipeline.prototype._executeHook = function(hookName, context) { var ui = this._ui; var hookFunctions = this._pipelineHooks[hookName]; - return hookFunctions.reduce(this._addPluginHookExecutionPromiseToHookPromiseChain.bind(this, ui, context), Promise.resolve(context)); + return hookFunctions.reduce(this._addPluginHookExecutionPromiseToHookPromiseChain.bind(this, ui, context, hookName), Promise.resolve(context)); }; -Pipeline.prototype._addPluginHookExecutionPromiseToHookPromiseChain = function(ui, context, promise, fnObject) { +Pipeline.prototype._addPluginHookExecutionPromiseToHookPromiseChain = function(ui, context, hookName, promise, fnObject) { return promise - .then(this._notifyPipelinePluginHookExecution.bind(this, ui, fnObject)) + .then(this._notifyPipelinePluginHookExecution.bind(this, ui, fnObject, hookName)) .then(this._mergePluginHookResultIntoContext.bind(this, context)); }; -Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, context) { +Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, hookName, context) { if (ui.verbose) { ui.write(blue('| |\n')); ui.write(blue('| +- ' + fnObject.name + '\n')); + } else if (ui.showProgress) { + if (hookName !== 'configure') { + ui.progressBar.tick({ + hook: hookName, + plugin: fnObject.name + }); + } } + return fnObject.fn(context); }; diff --git a/node-tests/helpers/fake-progress-bar.js b/node-tests/helpers/fake-progress-bar.js new file mode 100644 index 00000000..dda2b2cb --- /dev/null +++ b/node-tests/helpers/fake-progress-bar.js @@ -0,0 +1,11 @@ +function FakeProgressBar(template, options) { + this.template = template; + this.total = options.total; + this.ticks = []; +} + +FakeProgressBar.prototype.tick = function(options) { + this.ticks.push(options); +}; + +module.exports = FakeProgressBar; diff --git a/node-tests/unit/models/pipeline-test.js b/node-tests/unit/models/pipeline-test.js index ed94cfc6..37b83b21 100644 --- a/node-tests/unit/models/pipeline-test.js +++ b/node-tests/unit/models/pipeline-test.js @@ -2,6 +2,7 @@ var Promise = require('ember-cli/lib/ext/promise'); var Pipeline = require('../../../lib/models/pipeline'); var expect = require('../../helpers/expect'); +var FakeProgressBar = require('../../helpers/fake-progress-bar'); describe ('Pipeline', function() { describe ('initialization', function() { @@ -166,4 +167,104 @@ describe ('Pipeline', function() { expect(result).to.have.members(['hook1', 'hook2', 'didFail']); }); }); + + describe('progressBar', function() { + it('is initalized if showProgress is true', function() { + var ui = { + showProgress: true, + }; + var subject = new Pipeline(['hook1'], { + ui: ui, + progressBarLib: FakeProgressBar + }); + + subject.execute(); + + expect(ui.progressBar).to.be.ok; + }); + + it('is not used in --verbose mode', function() { + var ui = { + verbose: true, + showProgress: true, + write: function() {} + }; + var subject = new Pipeline(['hook1'], { + ui: ui, + progressBarLib: FakeProgressBar + }); + + subject.execute(); + + expect(ui.progressBar).to.be.falsy; + }); + + it('calculates the total number of registered hooks functions', function() { + var ui = { + showProgress: true, + }; + var subject = new Pipeline(['hook1', 'hook2'], { + ui: ui, + showProgress: true, + progressBarLib: FakeProgressBar + }); + + subject.register('hook1', function() {}); + subject.register('hook1', function() {}); + subject.register('hook2', function() {}); + subject.execute(); + + expect(ui.progressBar.total).to.equal(3); + }); + + it('excludes the configure hooks from the total', function() { + var ui = { + showProgress: true, + }; + var subject = new Pipeline(['configure', 'hook1'], { + ui: ui, + showProgress: true, + progressBarLib: FakeProgressBar + }); + + subject.register('hook1', function() {}); + subject.register('hook1', function() {}); + subject.register('configure', function() {}); + subject.execute(); + + expect(ui.progressBar.total).to.equal(2); + }); + + it('ticks during execution', function() { + var ui = { + showProgress: true, + }; + var subject = new Pipeline(['hook1', 'hook2'], { + ui: ui, + showProgress: true, + progressBarLib: FakeProgressBar + }); + + var fn1 = { + fn: function() {}, + name: 'fn1' + }; + var fn2 = { + fn: function() {}, + name: 'fn2' + }; + + subject.register('hook1', fn1); + subject.register('hook2', fn2); + + return expect(subject.execute()).to.be.fulfilled + .then(function() { + expect(ui.progressBar.ticks).to.eql( + [{hook: 'hook1', plugin: 'fn1'}, + {hook: 'hook2', plugin: 'fn2'} + ] + ); + }); + }); + }); }); diff --git a/package.json b/package.json index 403e42c6..487cebed 100644 --- a/package.json +++ b/package.json @@ -56,6 +56,7 @@ "ncp": "^2.0.0", "rimraf": "^2.2.8", "silent-error": "^1.0.0", + "progress": "^1.1.8", "sync-exec": "^0.5.0" } } From d746d8d580dd7bbe7b0f78a868b817dce1ee498d Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 23 Jan 2016 19:14:17 -0500 Subject: [PATCH 190/300] Release 0.6.0-beta.1 --- CHANGELOG.md | 17 +++++++++++++++++ package.json | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 033ca8e5..d7ce7093 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,22 @@ # ember-cli-deploy Changelog +## [0.6.0-beta.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.1) (2016-01-23) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.1...0.6.0-beta.1) + +This release has no breaking changes from 0.5.1. It introduces a progress bar for deploys run on interactive terminals, improved ability to configure command defaults, and new fetchInitialRevisions & fetchRevisions hooks to the deploy pipeline, which will better enable plugins that want to do changelog/diff notifications. + +- display progress notification during deploy [\#280](https://github.com/ember-cli/ember-cli-deploy/pull/280) ([ghedamat](https://github.com/ghedamat)) +- add `fetchRevisions`hook to deploy and activate pipelines [\#323](https://github.com/ember-cli/ember-cli-deploy/pull/323) ([sethpollack](https://github.com/sethpollack)) +- Allow loading .env files + .env.deploy.\ files [\#342](https://github.com/ember-cli/ember-cli-deploy/pull/342) ([blimmer](https://github.com/blimmer)) +- read-config task $fix issue where dotenv files were not loaded in time for deploy tasks$ [\#319](https://github.com/ember-cli/ember-cli-deploy/pull/319) ([lukemelia](https://github.com/lukemelia)) +- Remove temporary fix for broccoli-asset-rev [\#316](https://github.com/ember-cli/ember-cli-deploy/pull/316) ([backspace](https://github.com/backspace)) + +We have also introduced new versioned docs for 0.6.x, available now from the version selector on ember-cli-deploy.com in the Docs section. + +Huge thanks to the fine work of the ember-cli-deploy core team, particularly @ghedamat who has been very active this cycle, and to our growing set of contributors and community. It is amazing to the see the ember-cli-deploy plugin ecosystem blossom. + +Please give this beta a shot and if you notice anything wrong, open an issue or ping us on the Ember Community Slack in #ember-cli-deploy channel. + ## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) diff --git a/package.json b/package.json index 487cebed..b53f6c1f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.5.1", + "version": "0.6.0-beta.1", "directories": { "doc": "doc", "test": "tests" From 0b945e1e705634ee229b2110ce4014df6d9ceeef Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 23 Jan 2016 19:24:59 -0500 Subject: [PATCH 191/300] Add note to plugin authors to 0.6.0-beta.1 changelog section --- CHANGELOG.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index d7ce7093..09d7e25f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -17,6 +17,10 @@ Huge thanks to the fine work of the ember-cli-deploy core team, particularly @gh Please give this beta a shot and if you notice anything wrong, open an issue or ping us on the Ember Community Slack in #ember-cli-deploy channel. +### Plugin Authors + +The `fetchRevisions` hook will now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. In the coming days, we will be updating ember-cli-deploy-redis as an example. + ## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) From 7ab6bcc3815b2876a94a87757de10a4c1a26c444 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 23 Jan 2016 19:51:29 -0500 Subject: [PATCH 192/300] Add note about upgrading to ember-cli-deploy-plugin 0.2.1 --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09d7e25f..5043a75e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -21,6 +21,8 @@ Please give this beta a shot and if you notice anything wrong, open an issue or The `fetchRevisions` hook will now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. In the coming days, we will be updating ember-cli-deploy-redis as an example. +You should also update your ember-cli-deploy-plugin dependency to 0.2.1, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release. + ## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) From 946124d298f34cea1a5f782185e8b1781f21881f Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 9 Feb 2016 23:25:21 +0000 Subject: [PATCH 193/300] Remove discontinued command code --- lib/commands/deprecated-command.js | 15 --------------- lib/commands/discontinued-command.js | 16 ---------------- lib/commands/index.js | 6 ------ 3 files changed, 37 deletions(-) delete mode 100644 lib/commands/deprecated-command.js delete mode 100644 lib/commands/discontinued-command.js diff --git a/lib/commands/deprecated-command.js b/lib/commands/deprecated-command.js deleted file mode 100644 index 78a8ae08..00000000 --- a/lib/commands/deprecated-command.js +++ /dev/null @@ -1,15 +0,0 @@ -var chalk = require('chalk'); - -module.exports = function(command) { - var description = command.description || ''; - command.description = chalk.red('[DEPRECATED] ') + description; - - var oldRun = command.run; - command.run = function () { - var message = chalk.red('This command has been deprecated. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.\n'); - this.ui.writeLine(message, 'WARNING'); - return oldRun.apply(this, arguments); - }; - - return command; -}; diff --git a/lib/commands/discontinued-command.js b/lib/commands/discontinued-command.js deleted file mode 100644 index 3837608f..00000000 --- a/lib/commands/discontinued-command.js +++ /dev/null @@ -1,16 +0,0 @@ -var chalk = require('chalk'); - -module.exports = function(name, description) { - return { - name: name, - description: chalk.red('[DISCONTNUED] ') + description, - works: 'insideProject', - - availableOptions: [], - - run: function(/* commandOptions, rawArgs */) { - var message = chalk.red('This command has been discontinued. Please see `https://github.com/ember-cli/ember-cli-deploy` for details.\n'); - this.ui.writeLine(message, 'WARNING'); - } - }; -}; diff --git a/lib/commands/index.js b/lib/commands/index.js index 07c9c5a8..4fa209b5 100644 --- a/lib/commands/index.js +++ b/lib/commands/index.js @@ -1,11 +1,5 @@ -var buildDiscontinuedCommand = require('./discontinued-command'); - module.exports = { 'deploy': require('./deploy'), 'deploy:activate': require('./activate'), 'deploy:list': require('./list'), - - 'deploy:assets': buildDiscontinuedCommand('deploy:assets', 'deploy assets'), - 'deploy:index': buildDiscontinuedCommand('deploy:assets', 'deploy index'), - 'deploy:versions': buildDiscontinuedCommand('deploy:assets', 'list versions') }; From b11002676a6ee59ede2f2550aa60905fa98d869e Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Tue, 9 Feb 2016 23:25:41 +0000 Subject: [PATCH 194/300] Move option-value to helpers dir --- lib/commands/activate.js | 2 +- lib/commands/deploy.js | 2 +- lib/commands/list.js | 2 +- lib/{commands => helpers}/option-value.js | 0 4 files changed, 3 insertions(+), 3 deletions(-) rename lib/{commands => helpers}/option-value.js (100%) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index cd2d1c15..5c690a6d 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -1,4 +1,4 @@ -var chooseOptionValue = require('./option-value'); +var chooseOptionValue = require('../helpers/option-value'); module.exports = { name: 'deploy:activate', diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 1626b5d2..9e3d2ab4 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -1,4 +1,4 @@ -var chooseOptionValue = require('./option-value'); +var chooseOptionValue = require('../helpers/option-value'); module.exports = { name: 'deploy', diff --git a/lib/commands/list.js b/lib/commands/list.js index 3a5108de..19b074ed 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -1,4 +1,4 @@ -var chooseOptionValue = require('./option-value'); +var chooseOptionValue = require('../helpers/option-value'); module.exports = { name: 'deploy:list', diff --git a/lib/commands/option-value.js b/lib/helpers/option-value.js similarity index 100% rename from lib/commands/option-value.js rename to lib/helpers/option-value.js From c8a6299370a001bea5b4a603ccd07e04f3932dcd Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Mon, 22 Feb 2016 23:38:58 -0500 Subject: [PATCH 195/300] Use our fork of progress so that we can make the rocket part of the progress bar. --- lib/models/pipeline.js | 7 ++++--- package.json | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index d72ab36b..0102cd50 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -23,7 +23,7 @@ function Pipeline(hookNames, options) { return pipelineHooks; }, { didFail: [] }); - this._progressBarLib = options.progressBarLib || require('progress'); + this._progressBarLib = options.progressBarLib || require('@ember-cli-deploy/progress'); } Pipeline.prototype.register = function(hookName, fn) { @@ -55,8 +55,9 @@ Pipeline.prototype.execute = function(context) { if (ui.verbose) { ui.write(blue('Executing pipeline\n')); } else if (ui.showProgress) { - ui.progressBar = new ProgressBar( (process.platform === 'darwin' ? '🚀 ' : '') + 'deploy progress [:bar] :percent [plugin: :plugin -> :hook]', { - total: this._hooksCount(this._hooksWithoutConfigure(hooks)) + ui.progressBar = new ProgressBar('Deploying [:bar] :percent [plugin: :plugin -> :hook]', { + total: this._hooksCount(this._hooksWithoutConfigure(hooks)), + cursor: process.platform === 'darwin' ? '🚀 ' : '>' }); } diff --git a/package.json b/package.json index b53f6c1f..f386170a 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "ncp": "^2.0.0", "rimraf": "^2.2.8", "silent-error": "^1.0.0", - "progress": "^1.1.8", + "@ember-cli-deploy/progress": "^1.2.0", "sync-exec": "^0.5.0" } } From 17d09630e85ce34e071f3a79560597be36c7124c Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Tue, 23 Feb 2016 00:00:18 -0500 Subject: [PATCH 196/300] Release 0.6.0-beta.2 --- CHANGELOG.md | 8 ++++++++ package.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5043a75e..840a870d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # ember-cli-deploy Changelog +## [0.6.0-beta.2](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.2) (2016-02-22) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.6.0-beta.1...0.6.0-beta.2) + +Small refactorings and tweak to new progress bar. If this build is stable, it will be released as 0.6.0 final. + +- Use our fork of progress so that we can make the rocket part of the progress bar [\#364](https://github.com/ember-cli/ember-cli-deploy/pull/364) ([lukemelia](https://github.com/lukemelia)) +- Remove unused code [\#359](https://github.com/ember-cli/ember-cli-deploy/pull/359) ([achambers](https://github.com/achambers)) + ## [0.6.0-beta.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.1) (2016-01-23) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.1...0.6.0-beta.1) diff --git a/package.json b/package.json index f386170a..4e8ca920 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.0-beta.1", + "version": "0.6.0-beta.2", "directories": { "doc": "doc", "test": "tests" From 6eacee3ad90d5a2c6536bfcebe5b18527f366b20 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Wed, 24 Feb 2016 00:18:22 -0500 Subject: [PATCH 197/300] Move to non-scoped npm package for progress, and newer version. - Fixes an issue resulting in crash showing progress bar at certain terminal window sizes --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4e8ca920..0506dab6 100644 --- a/package.json +++ b/package.json @@ -56,7 +56,7 @@ "ncp": "^2.0.0", "rimraf": "^2.2.8", "silent-error": "^1.0.0", - "@ember-cli-deploy/progress": "^1.2.0", + "ember-cli-deploy-progress": "^1.3.0", "sync-exec": "^0.5.0" } } From 86e08a3605b4f4cd75b3e8131a036e829fcb3a45 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Wed, 24 Feb 2016 01:10:19 -0500 Subject: [PATCH 198/300] Update require for new name of progress package --- lib/models/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index 0102cd50..30eec726 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -23,7 +23,7 @@ function Pipeline(hookNames, options) { return pipelineHooks; }, { didFail: [] }); - this._progressBarLib = options.progressBarLib || require('@ember-cli-deploy/progress'); + this._progressBarLib = options.progressBarLib || require('ember-cli-deploy-progress'); } Pipeline.prototype.register = function(hookName, fn) { From 318f490fbef63758de27d72e9444ac5cf45207ee Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Wed, 24 Feb 2016 01:22:48 -0500 Subject: [PATCH 199/300] Release v0.6.0-beta.3 --- CHANGELOG.md | 5 +++++ package.json | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 840a870d..3dc39364 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # ember-cli-deploy Changelog +## [0.6.0-beta.3](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.3) (2016-02-24) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.6.0-beta.2...0.6.0-beta.3) + +- Move to non-scoped npm package for progress, and newer version. Fixes an issue causing crashes when running at certain narrow terminal widths. [\#366](https://github.com/ember-cli/ember-cli-deploy/pull/366) and [\#367](https://github.com/ember-cli/ember-cli-deploy/pull/367) ([lukemelia](https://github.com/lukemelia)) + ## [0.6.0-beta.2](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.2) (2016-02-22) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.6.0-beta.1...0.6.0-beta.2) diff --git a/package.json b/package.json index 0506dab6..07d84222 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.0-beta.2", + "version": "0.6.0-beta.3", "directories": { "doc": "doc", "test": "tests" From 387f75b8ebcec143a4beccb682b8aa31f47c028c Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 26 Feb 2016 23:50:48 -0500 Subject: [PATCH 200/300] Release v0.6.0 --- CHANGELOG.md | 36 +++++++++++++----------------------- package.json | 2 +- 2 files changed, 14 insertions(+), 24 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 3dc39364..e09d2b61 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,41 +1,31 @@ # ember-cli-deploy Changelog -## [0.6.0-beta.3](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.3) (2016-02-24) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.6.0-beta.2...0.6.0-beta.3) +## [0.6.0](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0) (2016-02-26) +[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.1...0.6.0) -- Move to non-scoped npm package for progress, and newer version. Fixes an issue causing crashes when running at certain narrow terminal widths. [\#366](https://github.com/ember-cli/ember-cli-deploy/pull/366) and [\#367](https://github.com/ember-cli/ember-cli-deploy/pull/367) ([lukemelia](https://github.com/lukemelia)) +This release has no breaking changes from 0.5.1. It introduces a progress bar for deploys run on interactive terminals, improved ability to configure command defaults, and new fetchInitialRevisions & fetchRevisions hooks to the deploy pipeline, which will better enable plugins that want to do changelog/diff notifications. -## [0.6.0-beta.2](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.2) (2016-02-22) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.6.0-beta.1...0.6.0-beta.2) +We have also introduced new versioned docs for 0.6.x, available now from the version selector on ember-cli-deploy.com in the Docs section. -Small refactorings and tweak to new progress bar. If this build is stable, it will be released as 0.6.0 final. +Huge thanks to the fine work of the ember-cli-deploy core team, particularly @ghedamat who has been very active this cycle, and to our growing set of contributors and community. It is amazing to the see the ember-cli-deploy plugin ecosystem blossom. -- Use our fork of progress so that we can make the rocket part of the progress bar [\#364](https://github.com/ember-cli/ember-cli-deploy/pull/364) ([lukemelia](https://github.com/lukemelia)) -- Remove unused code [\#359](https://github.com/ember-cli/ember-cli-deploy/pull/359) ([achambers](https://github.com/achambers)) +### Plugin Authors -## [0.6.0-beta.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0-beta.1) (2016-01-23) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.1...0.6.0-beta.1) +The `fetchRevisions` hook will now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. In the coming days, we will be updating ember-cli-deploy-redis as an example. -This release has no breaking changes from 0.5.1. It introduces a progress bar for deploys run on interactive terminals, improved ability to configure command defaults, and new fetchInitialRevisions & fetchRevisions hooks to the deploy pipeline, which will better enable plugins that want to do changelog/diff notifications. +You should also update your ember-cli-ddddddddeploy-plugin dependency to 0.2.2, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release.33 +Pull Requests: + +- Move to non-scoped npm package for progress, and newer version. Fixes an issue causing crashes when running at certain narrow terminal widths. [\#366](https://github.com/ember-cli/ember-cli-deploy/pull/366) and [\#367](https://github.com/ember-cli/ember-cli-deploy/pull/367) ([lukemelia](https://github.com/lukemelia)) +- Use our fork of progress so that we can make the rocket part of the progress bar [\#364](https://github.com/ember-cli/ember-cli-deploy/pull/364) ([lukemelia](https://github.com/lukemelia)) +- Remove unused code [\#359](https://github.com/ember-cli/ember-cli-deploy/pull/359) ([achambers](https://github.com/achambers)) - display progress notification during deploy [\#280](https://github.com/ember-cli/ember-cli-deploy/pull/280) ([ghedamat](https://github.com/ghedamat)) - add `fetchRevisions`hook to deploy and activate pipelines [\#323](https://github.com/ember-cli/ember-cli-deploy/pull/323) ([sethpollack](https://github.com/sethpollack)) - Allow loading .env files + .env.deploy.\ files [\#342](https://github.com/ember-cli/ember-cli-deploy/pull/342) ([blimmer](https://github.com/blimmer)) - read-config task $fix issue where dotenv files were not loaded in time for deploy tasks$ [\#319](https://github.com/ember-cli/ember-cli-deploy/pull/319) ([lukemelia](https://github.com/lukemelia)) - Remove temporary fix for broccoli-asset-rev [\#316](https://github.com/ember-cli/ember-cli-deploy/pull/316) ([backspace](https://github.com/backspace)) -We have also introduced new versioned docs for 0.6.x, available now from the version selector on ember-cli-deploy.com in the Docs section. - -Huge thanks to the fine work of the ember-cli-deploy core team, particularly @ghedamat who has been very active this cycle, and to our growing set of contributors and community. It is amazing to the see the ember-cli-deploy plugin ecosystem blossom. - -Please give this beta a shot and if you notice anything wrong, open an issue or ping us on the Ember Community Slack in #ember-cli-deploy channel. - -### Plugin Authors - -The `fetchRevisions` hook will now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. In the coming days, we will be updating ember-cli-deploy-redis as an example. - -You should also update your ember-cli-deploy-plugin dependency to 0.2.1, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release. - ## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) [Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) diff --git a/package.json b/package.json index 07d84222..afc339dc 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.0-beta.3", + "version": "0.6.0", "directories": { "doc": "doc", "test": "tests" From 8fff21dbde0de4e61b9e9b19ab5efbfd6fcd5507 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Sat, 27 Feb 2016 00:03:00 -0500 Subject: [PATCH 201/300] [DOC] CHANGELOG touchups --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e09d2b61..4a01d12c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,9 +11,9 @@ Huge thanks to the fine work of the ember-cli-deploy core team, particularly @gh ### Plugin Authors -The `fetchRevisions` hook will now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. In the coming days, we will be updating ember-cli-deploy-redis as an example. +The `fetchRevisions` hook is now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. Here is an example of [updating ember-cli-deploy-redis](https://github.com/ember-cli-deploy/ember-cli-deploy-redis/pull/50). -You should also update your ember-cli-ddddddddeploy-plugin dependency to 0.2.2, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release.33 +You should also update your ember-cli-deploy-plugin dependency to 0.2.2, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release. Pull Requests: From 92f281619d01bff6f8059946b8a24380669faefa Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Sun, 20 Mar 2016 22:03:18 -0400 Subject: [PATCH 202/300] add config options for log colors --- lib/commands/activate.js | 6 ++++- lib/commands/deploy.js | 6 ++++- lib/commands/list.js | 6 ++++- lib/models/pipeline.js | 36 ++++++++++++++----------- node-tests/unit/models/pipeline-test.js | 29 +++++++++++++++----- 5 files changed, 59 insertions(+), 24 deletions(-) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 5c690a6d..181e5a59 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -8,7 +8,9 @@ module.exports = { availableOptions: [ { name: 'revision', type: String, required: true }, { name: 'verbose', type: Boolean }, - { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' } + { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, + { name: 'log-info-color', type: String, description: '(Default: "blue")'}, + { name: 'log-error-color', type: String, description: '(Default: "red")'} ], anonymousOptions: [ @@ -19,6 +21,8 @@ module.exports = { commandOptions.deployTarget = rawArgs.shift(); this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + this.ui.logInfoColor = chooseOptionValue(commandOptions.logInfoColor, this.settings, 'logInfoColor', 'blue'); + this.ui.logErrorColor = chooseOptionValue(commandOptions.logErrorColor, this.settings, 'logErrorColor', 'red'); commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); process.env.DEPLOY_TARGET = commandOptions.deployTarget; diff --git a/lib/commands/deploy.js b/lib/commands/deploy.js index 9e3d2ab4..11dfdf62 100644 --- a/lib/commands/deploy.js +++ b/lib/commands/deploy.js @@ -15,7 +15,9 @@ module.exports = { { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, { name: 'verbose', type: Boolean, description: '(Default: false)' }, { name: 'activate', type: Boolean, description: '(Default: false)' }, - { name: 'show-progress', type: Boolean, aliases: ['p', 'progress'], description: '(Default: true)'} + { name: 'show-progress', type: Boolean, aliases: ['p', 'progress'], description: '(Default: true)'}, + { name: 'log-info-color', type: String, description: '(Default: "blue")'}, + { name: 'log-error-color', type: String, description: '(Default: "red")'} ], run: function(commandOptions, rawArgs) { @@ -26,6 +28,8 @@ module.exports = { this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); this.ui.showProgress = chooseOptionValue(commandOptions.showProgress, this.settings, 'showProgress', process.stdout.isTTY ? true : false); + this.ui.logInfoColor = chooseOptionValue(commandOptions.logInfoColor, this.settings, 'logInfoColor', 'blue'); + this.ui.logErrorColor = chooseOptionValue(commandOptions.logErrorColor, this.settings, 'logErrorColor', 'red'); process.env.DEPLOY_TARGET = commandOptions.deployTarget; diff --git a/lib/commands/list.js b/lib/commands/list.js index 19b074ed..03ae8668 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -12,7 +12,9 @@ module.exports = { availableOptions: [ { name: 'deploy-config-file', type: String, description: '(Default: config/deploy.js)' }, { name: 'verbose', type: Boolean }, - { name: 'amount', type: Number, description: '(Default: 10)' } + { name: 'amount', type: Number, description: '(Default: 10)' }, + { name: 'log-info-color', type: String, description: '(Default: "blue")'}, + { name: 'log-error-color', type: String, description: '(Default: "red")'} ], run: function(commandOptions, rawArgs) { @@ -20,6 +22,8 @@ module.exports = { commandOptions.deployConfigFile = chooseOptionValue(commandOptions.deployConfigFile, this.settings, 'deploy-config-file', 'config/deploy.js'); this.ui.verbose = chooseOptionValue(commandOptions.verbose, this.settings, 'verbose'); + this.ui.logInfoColor = chooseOptionValue(commandOptions.logInfoColor, this.settings, 'logInfoColor', 'blue'); + this.ui.logErrorColor = chooseOptionValue(commandOptions.logErrorColor, this.settings, 'logErrorColor', 'red'); commandOptions.amount = chooseOptionValue(commandOptions.amount, this.settings, 'amount', 10); process.env.DEPLOY_TARGET = commandOptions.deployTarget; diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index 30eec726..a2456aa8 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -4,8 +4,6 @@ var Promise = require('ember-cli/lib/ext/promise'); var _ = require('lodash-node'); var chalk = require('chalk'); -var blue = chalk.blue; -var red = chalk.red; /* This is a generic implementation of a pipeline with ordered, promise-aware hooks, * pleasant logging, and failure handling. It should not have any "deployment" domain @@ -14,6 +12,12 @@ var red = chalk.red; function Pipeline(hookNames, options) { hookNames = hookNames || []; options = options || {}; + options = _.merge({ + ui: { + logInfoColor: 'blue', + logErrorColor: 'red' + } + }, options); this._ui = options.ui; @@ -23,6 +27,8 @@ function Pipeline(hookNames, options) { return pipelineHooks; }, { didFail: [] }); + this.logInfo = chalk[this._ui.logInfoColor]; + this.logError = chalk[this._ui.logErrorColor]; this._progressBarLib = options.progressBarLib || require('ember-cli-deploy-progress'); } @@ -39,7 +45,7 @@ Pipeline.prototype.register = function(hookName, fn) { if (pipelineHooks[hookName]) { if (ui.verbose) { - ui.write(blue('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); + ui.write(this.logInfo('Registering hook -> ' + hookName + '[' + fn.name + ']\n')); } pipelineHooks[hookName].push(fn); @@ -53,7 +59,7 @@ Pipeline.prototype.execute = function(context) { var hooks = this._hooksWithoutDidFail(this.hookNames()); var ProgressBar = this._progressBarLib; if (ui.verbose) { - ui.write(blue('Executing pipeline\n')); + ui.write(this.logInfo('Executing pipeline\n')); } else if (ui.showProgress) { ui.progressBar = new ProgressBar('Deploying [:bar] :percent [plugin: :plugin -> :hook]', { total: this._hooksCount(this._hooksWithoutConfigure(hooks)), @@ -105,33 +111,33 @@ Pipeline.prototype._hooksCount = function(hooks) { Pipeline.prototype._handlePipelineFailure = function(ui, context, error) { if (ui.verbose) { - ui.write(red('|\n')); - ui.write(red('+- didFail\n')); + ui.write(this.logError('|\n')); + ui.write(this.logError('+- didFail\n')); } - ui.write(red(error + '\n' + (error ? error.stack : null))); + ui.write(this.logError(error + '\n' + (error ? error.stack : null))); return this._executeHook('didFail', context) .then(Promise.reject.bind(this, error)); }; Pipeline.prototype._abortPipelineExecution = function(ui/*, error */) { if (ui.verbose) { - ui.write(blue('|\n')); + ui.write(this.logInfo('|\n')); } - ui.write(red('Pipeline aborted\n')); + ui.write(this.logError('Pipeline aborted\n')); return Promise.reject(); }; Pipeline.prototype._notifyPipelineCompletion = function(ui) { if (ui.verbose) { - ui.write(blue('|\n')); - ui.write(blue('Pipeline complete\n')); + ui.write(this.logInfo('|\n')); + ui.write(this.logInfo('Pipeline complete\n')); } }; Pipeline.prototype._notifyPipelineHookExecution = function(ui, hookName, context) { if (ui.verbose) { - ui.write(blue('|\n')); - ui.write(blue('+- ' + hookName + '\n')); + ui.write(this.logInfo('|\n')); + ui.write(this.logInfo('+- ' + hookName + '\n')); } return context; }; @@ -151,8 +157,8 @@ Pipeline.prototype._addPluginHookExecutionPromiseToHookPromiseChain = function(u Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, hookName, context) { if (ui.verbose) { - ui.write(blue('| |\n')); - ui.write(blue('| +- ' + fnObject.name + '\n')); + ui.write(this.logInfo('| |\n')); + ui.write(this.logInfo('| +- ' + fnObject.name + '\n')); } else if (ui.showProgress) { if (hookName !== 'configure') { ui.progressBar.tick({ diff --git a/node-tests/unit/models/pipeline-test.js b/node-tests/unit/models/pipeline-test.js index 37b83b21..837d22bf 100644 --- a/node-tests/unit/models/pipeline-test.js +++ b/node-tests/unit/models/pipeline-test.js @@ -6,7 +6,7 @@ var FakeProgressBar = require('../../helpers/fake-progress-bar'); describe ('Pipeline', function() { describe ('initialization', function() { - it ('initializes the given list of hooks plus the `didFail`-hook', function() { + it('initializes the given list of hooks plus the `didFail`-hook', function() { var subject = new Pipeline(['willDeploy', 'didDeploy']); expect(Object.keys(subject._pipelineHooks).length).to.eq(3); @@ -14,10 +14,27 @@ describe ('Pipeline', function() { expect(subject._pipelineHooks.didDeploy).to.eql([]); expect(subject._pipelineHooks.didFail).to.eql([]); }); + + it('configures logging colors with defaults', function() { + var subject = new Pipeline([]); + expect(subject.logInfo._styles).to.eql(['blue']); + expect(subject.logError._styles).to.eql(['red']); + }); + + it('configures logging colors', function() { + var subject = new Pipeline([], { + ui: { + logInfoColor: 'green', + logErrorColor: 'yellow' + } + }); + expect(subject.logInfo._styles).to.eql(['green']); + expect(subject.logError._styles).to.eql(['yellow']); + }); }); describe ('#register', function() { - it ('registers functions for defined hooks', function() { + it('registers functions for defined hooks', function() { var subject = new Pipeline(['willDeploy'], { ui: {write: function() {}} }); @@ -180,7 +197,7 @@ describe ('Pipeline', function() { subject.execute(); - expect(ui.progressBar).to.be.ok; + expect(subject._ui.progressBar).to.be.ok; }); it('is not used in --verbose mode', function() { @@ -214,7 +231,7 @@ describe ('Pipeline', function() { subject.register('hook2', function() {}); subject.execute(); - expect(ui.progressBar.total).to.equal(3); + expect(subject._ui.progressBar.total).to.equal(3); }); it('excludes the configure hooks from the total', function() { @@ -232,7 +249,7 @@ describe ('Pipeline', function() { subject.register('configure', function() {}); subject.execute(); - expect(ui.progressBar.total).to.equal(2); + expect(subject._ui.progressBar.total).to.equal(2); }); it('ticks during execution', function() { @@ -259,7 +276,7 @@ describe ('Pipeline', function() { return expect(subject.execute()).to.be.fulfilled .then(function() { - expect(ui.progressBar.ticks).to.eql( + expect(subject._ui.progressBar.ticks).to.eql( [{hook: 'hook1', plugin: 'fn1'}, {hook: 'hook2', plugin: 'fn2'} ] From ca3200b0f980455f2618e7475177536f76bc9552 Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Wed, 13 Apr 2016 03:17:39 +0200 Subject: [PATCH 203/300] Make tests uncover that deployConfigFile is not correctly used to calculate deployConfigPath --- index.js | 2 +- node-tests/unit/tasks/pipeline-test.js | 2 +- node-tests/unit/tasks/read-config-test.js | 12 ++++++------ 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/index.js b/index.js index ba57fd75..3d3e618d 100644 --- a/index.js +++ b/index.js @@ -27,7 +27,7 @@ module.exports = { var readConfig = new ReadConfigTask({ project: this.project, deployTarget: deployTarget, - deployConfigPath: options.configFile + deployConfigFile: options.configFile }); return readConfig.run().then(function(config){ var DeployTask = require('./lib/tasks/deploy'); diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 79c69968..1ed5faaf 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -471,7 +471,7 @@ describe('PipelineTask', function() { ui: mockUi, deployTarget: 'production', config: { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }, - deployConfigPath: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', + deployConfigFile: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', }); try { diff --git a/node-tests/unit/tasks/read-config-test.js b/node-tests/unit/tasks/read-config-test.js index 02b7ddc5..cc048600 100644 --- a/node-tests/unit/tasks/read-config-test.js +++ b/node-tests/unit/tasks/read-config-test.js @@ -14,7 +14,7 @@ describe('ReadConfigTask', function() { var task = new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: 'node-tests/fixtures/config/deploy.js' + deployConfigFile: 'node-tests/fixtures/config/deploy.js' }); task.run().then(function(config){ assert.equal(config.build.environment, 'development'); @@ -23,7 +23,7 @@ describe('ReadConfigTask', function() { }); }); - it('accepts an absolute deployConfigPath', function() { + it('accepts an absolute deployConfigFile', function() { var project = { name: function() {return 'test-project';}, root: process.cwd(), @@ -34,7 +34,7 @@ describe('ReadConfigTask', function() { new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: path.join(process.cwd(), 'node-tests/fixtures/config/deploy.js') + deployConfigFile: path.join(process.cwd(), 'node-tests/fixtures/config/deploy.js') }).run(); }; @@ -66,7 +66,7 @@ describe('ReadConfigTask', function() { var task = new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: 'config/deploy.js' + deployConfigFile: 'config/deploy.js' }); task.run(); @@ -79,7 +79,7 @@ describe('ReadConfigTask', function() { var task = new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: 'config/deploy.js' + deployConfigFile: 'config/deploy.js' }); task.run(); @@ -92,7 +92,7 @@ describe('ReadConfigTask', function() { var task = new ReadConfigTask({ project: project, deployTarget: 'development', - deployConfigPath: 'config/deploy.js' + deployConfigFile: 'config/deploy.js' }); task.run(); From a02ba7f57cd32f383b619f701d2b551894d089c9 Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Wed, 13 Apr 2016 02:51:51 +0200 Subject: [PATCH 204/300] Fix #384: config file option is ignored --- lib/tasks/read-config.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/tasks/read-config.js b/lib/tasks/read-config.js index 9051c28a..017243c7 100644 --- a/lib/tasks/read-config.js +++ b/lib/tasks/read-config.js @@ -18,7 +18,7 @@ module.exports = Task.extend({ this.root = this.project.root; - this.deployConfigPath = this.deployConfigPath || 'config/deploy.js'; + this.deployConfigPath = this.deployConfigFile || 'config/deploy.js'; if (!existsSync(path.join(this.root, this.deployConfigPath))) { throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); From 3b56367c59065d6e780a86b0301728ee7d9e42e7 Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Wed, 13 Apr 2016 03:50:29 +0200 Subject: [PATCH 205/300] Fix test for absolute config file path and add another test to make it less brittle --- node-tests/unit/tasks/read-config-test.js | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/node-tests/unit/tasks/read-config-test.js b/node-tests/unit/tasks/read-config-test.js index cc048600..71d97be8 100644 --- a/node-tests/unit/tasks/read-config-test.js +++ b/node-tests/unit/tasks/read-config-test.js @@ -23,6 +23,25 @@ describe('ReadConfigTask', function() { }); }); + var configFileNotFoundExceptionPattern = /Deploy config does not exist at/; + it('throws an exception if deployConfigFile cannot be found', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [] + }; + + var fn = function () { + new ReadConfigTask({ + project: project, + deployTarget: 'development', + deployConfigFile: path.join(process.cwd(), 'node-tests/fixtures/config/this-config-does-not-exist.js') + }).run(); + }; + + assert.throws(fn, configFileNotFoundExceptionPattern, 'config file does not exist but exception is not thrown'); + }); + it('accepts an absolute deployConfigFile', function() { var project = { name: function() {return 'test-project';}, @@ -38,7 +57,7 @@ describe('ReadConfigTask', function() { }).run(); }; - assert.doesNotThrow(fn, /Cannot find module/, 'config file could not be read'); + assert.doesNotThrow(fn, configFileNotFoundExceptionPattern, 'config file could not be read'); }); describe('setting environment variables from .env', function() { From b6cf96939f431a3e2299af4974a5ca2a3115e0c7 Mon Sep 17 00:00:00 2001 From: Dominik Schmidt Date: Wed, 13 Apr 2016 03:54:14 +0200 Subject: [PATCH 206/300] Fix tests: Allow absolute paths for config file option (reapplies #253) --- lib/tasks/read-config.js | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/tasks/read-config.js b/lib/tasks/read-config.js index 017243c7..f452ff41 100644 --- a/lib/tasks/read-config.js +++ b/lib/tasks/read-config.js @@ -18,9 +18,10 @@ module.exports = Task.extend({ this.root = this.project.root; - this.deployConfigPath = this.deployConfigFile || 'config/deploy.js'; + this.deployConfigPath = this.deployConfigFile || 'config/deploy.js'; + this.absoluteDeployConfigPath = path.resolve(this.root, this.deployConfigPath); - if (!existsSync(path.join(this.root, this.deployConfigPath))) { + if (!existsSync(this.absoluteDeployConfigPath)) { throw new SilentError('Deploy config does not exist at `' + this.deployConfigPath + '`'); } }, @@ -52,8 +53,7 @@ module.exports = Task.extend({ }, _readDeployConfig: function() { - var root = this.root; - var deployConfigFn = require(path.resolve(root, this.deployConfigPath)); + var deployConfigFn = require(this.absoluteDeployConfigPath); return Promise.resolve(deployConfigFn(this.deployTarget)); } }); From 985293adb35f90499ce9da0af14f7f7c13bc1b79 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 14 Apr 2016 00:15:16 -0400 Subject: [PATCH 207/300] Move repository from ember-cli org to ember-cli-deploy org --- CHANGELOG.md | 152 +++++++++++++++---------------- MIGRATING_FROM_0_0_x_TO_0_4_x.md | 2 +- README.md | 2 +- bin/changelog | 2 +- package.json | 2 +- 5 files changed, 80 insertions(+), 80 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4a01d12c..1d8d1607 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,7 @@ # ember-cli-deploy Changelog -## [0.6.0](https://github.com/ember-cli/ember-cli-deploy/tree/0.6.0) (2016-02-26) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.1...0.6.0) +## [0.6.0](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.0) (2016-02-26) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.5.1...0.6.0) This release has no breaking changes from 0.5.1. It introduces a progress bar for deploys run on interactive terminals, improved ability to configure command defaults, and new fetchInitialRevisions & fetchRevisions hooks to the deploy pipeline, which will better enable plugins that want to do changelog/diff notifications. @@ -17,24 +17,24 @@ You should also update your ember-cli-deploy-plugin dependency to 0.2.2, to ensu Pull Requests: -- Move to non-scoped npm package for progress, and newer version. Fixes an issue causing crashes when running at certain narrow terminal widths. [\#366](https://github.com/ember-cli/ember-cli-deploy/pull/366) and [\#367](https://github.com/ember-cli/ember-cli-deploy/pull/367) ([lukemelia](https://github.com/lukemelia)) -- Use our fork of progress so that we can make the rocket part of the progress bar [\#364](https://github.com/ember-cli/ember-cli-deploy/pull/364) ([lukemelia](https://github.com/lukemelia)) -- Remove unused code [\#359](https://github.com/ember-cli/ember-cli-deploy/pull/359) ([achambers](https://github.com/achambers)) -- display progress notification during deploy [\#280](https://github.com/ember-cli/ember-cli-deploy/pull/280) ([ghedamat](https://github.com/ghedamat)) -- add `fetchRevisions`hook to deploy and activate pipelines [\#323](https://github.com/ember-cli/ember-cli-deploy/pull/323) ([sethpollack](https://github.com/sethpollack)) -- Allow loading .env files + .env.deploy.\ files [\#342](https://github.com/ember-cli/ember-cli-deploy/pull/342) ([blimmer](https://github.com/blimmer)) -- read-config task $fix issue where dotenv files were not loaded in time for deploy tasks$ [\#319](https://github.com/ember-cli/ember-cli-deploy/pull/319) ([lukemelia](https://github.com/lukemelia)) -- Remove temporary fix for broccoli-asset-rev [\#316](https://github.com/ember-cli/ember-cli-deploy/pull/316) ([backspace](https://github.com/backspace)) +- Move to non-scoped npm package for progress, and newer version. Fixes an issue causing crashes when running at certain narrow terminal widths. [\#366](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/366) and [\#367](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/367) ([lukemelia](https://github.com/lukemelia)) +- Use our fork of progress so that we can make the rocket part of the progress bar [\#364](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/364) ([lukemelia](https://github.com/lukemelia)) +- Remove unused code [\#359](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/359) ([achambers](https://github.com/achambers)) +- display progress notification during deploy [\#280](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/280) ([ghedamat](https://github.com/ghedamat)) +- add `fetchRevisions`hook to deploy and activate pipelines [\#323](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/323) ([sethpollack](https://github.com/sethpollack)) +- Allow loading .env files + .env.deploy.\ files [\#342](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/342) ([blimmer](https://github.com/blimmer)) +- read-config task $fix issue where dotenv files were not loaded in time for deploy tasks$ [\#319](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/319) ([lukemelia](https://github.com/lukemelia)) +- Remove temporary fix for broccoli-asset-rev [\#316](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/316) ([backspace](https://github.com/backspace)) -## [0.5.1](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.1) (2015-11-09) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0...0.5.1) +## [0.5.1](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.5.1) (2015-11-09) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.5.0...0.5.1) -- Upgrade ember-cli to 1.13.8. [\#296](https://github.com/ember-cli/ember-cli-deploy/pull/296) ([blimmer](https://github.com/blimmer)) -- Require a deploy target to run ember deploy [\#294](https://github.com/ember-cli/ember-cli-deploy/pull/294) ([kiwiupover](https://github.com/kiwiupover)) -- Fix typo in "no plugins" warning $it's/its$ [\#284](https://github.com/ember-cli/ember-cli-deploy/pull/284) ([pgengler](https://github.com/pgengler)) +- Upgrade ember-cli to 1.13.8. [\#296](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/296) ([blimmer](https://github.com/blimmer)) +- Require a deploy target to run ember deploy [\#294](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/294) ([kiwiupover](https://github.com/kiwiupover)) +- Fix typo in "no plugins" warning $it's/its$ [\#284](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/284) ([pgengler](https://github.com/pgengler)) -## [0.5.0](https://github.com/ember-cli/ember-cli-deploy/tree/v0.5.0) (2015-10-29) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.4.3...v0.5.0) +## [0.5.0](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/v0.5.0) (2015-10-29) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.4.3...v0.5.0) [BREAKING] This release is the first in the 0.5.0 series and the first using the new deploy pipeline and plugin architecture. @@ -46,15 +46,15 @@ NOTE: 0.5.0 is a major rewrite and shift from the 0.4.x series and hence introdu For more information on the ember-cli-deploy v0.5.0, how to use it and how to write plugins please see the brand new [documentation site](http://ember-cli-deploy.com). -## [0.5.0-beta.4](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.4) (2015-10-24) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.3...0.5.0-beta.4) +## [0.5.0-beta.4](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.5.0-beta.4) (2015-10-24) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.5.0-beta.3...0.5.0-beta.4) **Merged pull requests:** -- Add a `--verbose` option to commands, make default output quiet, and … [\#266](https://github.com/ember-cli/ember-cli-deploy/pull/266) ([lukemelia](https://github.com/lukemelia)) +- Add a `--verbose` option to commands, make default output quiet, and … [\#266](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/266) ([lukemelia](https://github.com/lukemelia)) -## [0.5.0-beta.3](https://github.com/ember-cli/ember-cli-deploy/tree/0.5.0-beta.3) (2015-10-22) -[Full Changelog](https://github.com/ember-cli/ember-cli-deploy/compare/v0.5.0-beta.2...0.5.0-beta.3) +## [0.5.0-beta.3](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.5.0-beta.3) (2015-10-22) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.5.0-beta.2...0.5.0-beta.3) This release is expected to be the last beta before 0.5.0. We're happy to welcome @ghedamat to the core team and are grateful for his many contributions to @@ -64,28 +64,28 @@ Thanks to everyone who took time to contribute to this release! #### Community Contributions -- add postInstall message [\#256](https://github.com/ember-cli/ember-cli-deploy/pull/256) ([ghedamat](https://github.com/ghedamat)) -- Correct typo; commandOptions are a local var [\#255](https://github.com/ember-cli/ember-cli-deploy/pull/255) ([kategengler](https://github.com/kategengler)) -- Make --deploy-config-path accept absolute paths [\#253](https://github.com/ember-cli/ember-cli-deploy/pull/253) ([dschmidt](https://github.com/dschmidt)) -- Update warning message url when no plugins installed [\#234](https://github.com/ember-cli/ember-cli-deploy/pull/234) ([achambers](https://github.com/achambers)) -- Guard postBuild hook [\#232](https://github.com/ember-cli/ember-cli-deploy/pull/232) ([lukemelia](https://github.com/lukemelia)) -- Merge 0.4.x [\#228](https://github.com/ember-cli/ember-cli-deploy/pull/228) ([lukemelia](https://github.com/lukemelia)) -- Give warning when no plugins are installed [\#225](https://github.com/ember-cli/ember-cli-deploy/pull/225) ([achambers](https://github.com/achambers)) -- Add support for postBuildDeployHook [\#222](https://github.com/ember-cli/ember-cli-deploy/pull/222) ([ghedamat](https://github.com/ghedamat)) +- add postInstall message [\#256](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/256) ([ghedamat](https://github.com/ghedamat)) +- Correct typo; commandOptions are a local var [\#255](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/255) ([kategengler](https://github.com/kategengler)) +- Make --deploy-config-path accept absolute paths [\#253](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/253) ([dschmidt](https://github.com/dschmidt)) +- Update warning message url when no plugins installed [\#234](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/234) ([achambers](https://github.com/achambers)) +- Guard postBuild hook [\#232](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/232) ([lukemelia](https://github.com/lukemelia)) +- Merge 0.4.x [\#228](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/228) ([lukemelia](https://github.com/lukemelia)) +- Give warning when no plugins are installed [\#225](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/225) ([achambers](https://github.com/achambers)) +- Add support for postBuildDeployHook [\#222](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/222) ([ghedamat](https://github.com/ghedamat)) ### 0.5.0-beta.2 (June 14, 2015) #### Community Contributions -- [#189](https://github.com/ember-cli/ember-cli-deploy/pull/189) [DOCUMENTATION] Upgrade instructions for plugin authors (and a bit for end users) [@duizendnegen/feature](https://github.com/duizendnegen/feature) -- [#196](https://github.com/ember-cli/ember-cli-deploy/pull/196) [BUGFIX] Fix bug where fingerprint options in deploy.js don't work [@achambers](https://github.com/achambers) -- [#197](https://github.com/ember-cli/ember-cli-deploy/pull/197) Remove unused code and commands deprecated in 0.4.0. [@yapplabs](https://github.com/yapplabs) -- [#206](https://github.com/ember-cli/ember-cli-deploy/pull/206) Remove modifying fingerprint options on `included` hook [@achambers](https://github.com/achambers) -- [#207](https://github.com/ember-cli/ember-cli-deploy/pull/207) Add 'prepare' hooks to pipeline [@achambers](https://github.com/achambers) -- [#208](https://github.com/ember-cli/ember-cli-deploy/pull/208) [DOCUMENTATION] Update RFC with prepare hook [@achambers](https://github.com/achambers) -- [#210](https://github.com/ember-cli/ember-cli-deploy/pull/210) add setup and teardown hooks to all commands [@ghedamat](https://github.com/ghedamat) -- [#212](https://github.com/ember-cli/ember-cli-deploy/pull/212) [DOCUMENTATION] Update description of hooks in rfc [@ghedamat](https://github.com/ghedamat) -- [#213](https://github.com/ember-cli/ember-cli-deploy/pull/213) Change deprecated require 'ember-cli/lib/errors/silent' to 'silent-error' [@dukex](https://github.com/dukex) +- [#189](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/189) [DOCUMENTATION] Upgrade instructions for plugin authors (and a bit for end users) [@duizendnegen/feature](https://github.com/duizendnegen/feature) +- [#196](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/196) [BUGFIX] Fix bug where fingerprint options in deploy.js don't work [@achambers](https://github.com/achambers) +- [#197](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/197) Remove unused code and commands deprecated in 0.4.0. [@yapplabs](https://github.com/yapplabs) +- [#206](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/206) Remove modifying fingerprint options on `included` hook [@achambers](https://github.com/achambers) +- [#207](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/207) Add 'prepare' hooks to pipeline [@achambers](https://github.com/achambers) +- [#208](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/208) [DOCUMENTATION] Update RFC with prepare hook [@achambers](https://github.com/achambers) +- [#210](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/210) add setup and teardown hooks to all commands [@ghedamat](https://github.com/ghedamat) +- [#212](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/212) [DOCUMENTATION] Update description of hooks in rfc [@ghedamat](https://github.com/ghedamat) +- [#213](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/213) Change deprecated require 'ember-cli/lib/errors/silent' to 'silent-error' [@dukex](https://github.com/dukex) ### 0.4.3 (July 12, 2015) @@ -98,16 +98,16 @@ Thanks to everyone who took time to contribute to this release! #### Community Contributions -- [#156](https://github.com/ember-cli/ember-cli-deploy/pull/156) Fix `_materialize` using wrong this context [@jeffhertzler](https://github.com/jeffhertzler) -- [#158](https://github.com/ember-cli/ember-cli-deploy/pull/158) added ember-cli-rest-index adapter to list of adapter [@leojh](https://github.com/leojh) -- [#159](https://github.com/ember-cli/ember-cli-deploy/pull/159) Update video link in README. [@blimmer](https://github.com/blimmer) -- [#161](https://github.com/ember-cli/ember-cli-deploy/pull/161) Remove leading '+' es from code of conduct [@pangratz](https://github.com/pangratz) -- [#164](https://github.com/ember-cli/ember-cli-deploy/pull/164) [#151] read manifestPrefix from config [@pavloo](https://github.com/pavloo) -- [#170](https://github.com/ember-cli/ember-cli-deploy/pull/170) Add ability to configure build paths, defaulting to tmp/deploy-dist/. [@duizendnegen/feature](https://github.com/duizendnegen/feature) -- [#171](https://github.com/ember-cli/ember-cli-deploy/pull/171) Update ember cli 0.2.7 and fix npm warnings [@ghedamat](https://github.com/ghedamat) -- [#175](https://github.com/ember-cli/ember-cli-deploy/pull/175) Manifest prefix for activate task. [@juggy](https://github.com/juggy) -- [#176](https://github.com/ember-cli/ember-cli-deploy/pull/176) Use silent-error NPM Package [@jherdman](https://github.com/jherdman) -- [#178](https://github.com/ember-cli/ember-cli-deploy/pull/178) Use SilentError to log errors when parsing config. [@ember-cli](https://github.com/ember-cli) +- [#156](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/156) Fix `_materialize` using wrong this context [@jeffhertzler](https://github.com/jeffhertzler) +- [#158](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/158) added ember-cli-rest-index adapter to list of adapter [@leojh](https://github.com/leojh) +- [#159](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/159) Update video link in README. [@blimmer](https://github.com/blimmer) +- [#161](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/161) Remove leading '+' es from code of conduct [@pangratz](https://github.com/pangratz) +- [#164](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/164) [#151] read manifestPrefix from config [@pavloo](https://github.com/pavloo) +- [#170](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/170) Add ability to configure build paths, defaulting to tmp/deploy-dist/. [@duizendnegen/feature](https://github.com/duizendnegen/feature) +- [#171](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/171) Update ember cli 0.2.7 and fix npm warnings [@ghedamat](https://github.com/ghedamat) +- [#175](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/175) Manifest prefix for activate task. [@juggy](https://github.com/juggy) +- [#176](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/176) Use silent-error NPM Package [@jherdman](https://github.com/jherdman) +- [#178](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/178) Use SilentError to log errors when parsing config. [@ember-cli](https://github.com/ember-cli) Thank you to all who took the time to contribute! @@ -119,18 +119,18 @@ exclude asset files from deployment. #### Community Contributions -- [#140](https://github.com/ember-cli/ember-cli-deploy/pull/140) Link to ember-deploy-couchbase. [@waltznetworks](https://github.com/waltznetworks) -- [#113](https://github.com/ember-cli/ember-cli-deploy/pull/113) Provide better error support for missing environment config [@achambers](https://github.com/achambers) -- [#115](https://github.com/ember-cli/ember-cli-deploy/pull/115) Changed package to be able to run tests on windows. [@Twinkletoes](https://github.com/Twinkletoes) -- [#119](https://github.com/ember-cli/ember-cli-deploy/pull/119) Stub active, list, createTag UnknownAdapter methods [@waltznetworks](https://github.com/waltznetworks) -- [#120](https://github.com/ember-cli/ember-cli-deploy/pull/120) [DOCUMENTATION] Make Sinatra example a bit more secure [@elucid](https://github.com/elucid) -- [#124](https://github.com/ember-cli/ember-cli-deploy/pull/124) Index Adapter support for multiple files [@Ahalogy](https://github.com/Ahalogy) -- [#128](https://github.com/ember-cli/ember-cli-deploy/pull/128) Link to custom adapters section for quick ref [@jayphelps](https://github.com/jayphelps) -- [#129](https://github.com/ember-cli/ember-cli-deploy/pull/129) Make a callout easily actionable [@jorgedavila25](https://github.com/jorgedavila25) -- [#141](https://github.com/ember-cli/ember-cli-deploy/pull/141) Add configuration option to exclude asset files from being deployed. [@yapplabs](https://github.com/yapplabs) -- [#142](https://github.com/ember-cli/ember-cli-deploy/pull/142) Test against stable node versions [@yapplabs](https://github.com/yapplabs) -- [#144](https://github.com/ember-cli/ember-cli-deploy/pull/144) Resolve JSHint error on deploy.js blueprint [@blimmer](https://github.com/blimmer) -- [#146](https://github.com/ember-cli/ember-cli-deploy/pull/146) Make io.js work [@trym](https://github.com/trym) +- [#140](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/140) Link to ember-deploy-couchbase. [@waltznetworks](https://github.com/waltznetworks) +- [#113](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/113) Provide better error support for missing environment config [@achambers](https://github.com/achambers) +- [#115](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/115) Changed package to be able to run tests on windows. [@Twinkletoes](https://github.com/Twinkletoes) +- [#119](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/119) Stub active, list, createTag UnknownAdapter methods [@waltznetworks](https://github.com/waltznetworks) +- [#120](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/120) [DOCUMENTATION] Make Sinatra example a bit more secure [@elucid](https://github.com/elucid) +- [#124](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/124) Index Adapter support for multiple files [@Ahalogy](https://github.com/Ahalogy) +- [#128](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/128) Link to custom adapters section for quick ref [@jayphelps](https://github.com/jayphelps) +- [#129](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/129) Make a callout easily actionable [@jorgedavila25](https://github.com/jorgedavila25) +- [#141](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/141) Add configuration option to exclude asset files from being deployed. [@yapplabs](https://github.com/yapplabs) +- [#142](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/142) Test against stable node versions [@yapplabs](https://github.com/yapplabs) +- [#144](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/144) Resolve JSHint error on deploy.js blueprint [@blimmer](https://github.com/blimmer) +- [#146](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/146) Make io.js work [@trym](https://github.com/trym) Thank you to all who took the time to contribute! @@ -140,29 +140,29 @@ This release mainly revolves round fixing a bug around `child_process` and `exec #### Community Contributions -- [#93](https://github.com/ember-cli/ember-cli-deploy/pull/93) [BUGFIX] execSync compat issue #92 [@joebartels](https://github.com/joebartels) -- [#100](https://github.com/ember-cli/ember-cli-deploy/pull/100) [DOCS] Update config around production-like environments [@Soliah](https://github.com/Soliah) +- [#93](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/93) [BUGFIX] execSync compat issue #92 [@joebartels](https://github.com/joebartels) +- [#100](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/100) [DOCS] Update config around production-like environments [@Soliah](https://github.com/Soliah) ### 0.4.0 (March 07, 2015) This release marks the merge of `achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` into the official `ember-cli-deploy` -If you are upgrading from `achambers/ember-cli-deploy v0.0.6`, please follow these [miragtion steps](https://github.com/ember-cli/ember-cli-deploy/blob/master/MIGRATION_STEPS.md); +If you are upgrading from `achambers/ember-cli-deploy v0.0.6`, please follow these [miragtion steps](https://github.com/ember-cli-deploy/ember-cli-deploy/blob/master/MIGRATION_STEPS.md); #### Community Contributions -- [#33](https://github.com/ember-cli/ember-cli-deploy/pull/33) [DOCS] Link to new S3 Index Adapter [@pootsbook](https://github.com/pootsbook) -- [#65](https://github.com/ember-cli/ember-cli-deploy/pull/65) [DOCS] Update CodeClimate batch. [@LevelbossMike](https://github.com/LevelbossMike) -- [#35](https://github.com/ember-cli/ember-cli-deploy/pull/35) [ENHANCEMENT] Match ember-cli's build command aliases by supporting --prod and --dev [@jamesfid](https://github.com/jamesfid) -- [#36](https://github.com/ember-cli/ember-cli-deploy/pull/36) [ENHANCEMENT] Allow custom config file via --deploy-config-file. [@yapplabs](https://github.com/yapplabs) -- [#63](https://github.com/ember-cli/ember-cli-deploy/pull/63) [BUGFIX] Fix regression to the type of object that was being passed to assets adapters as “config”. [@yapplabs](https://github.com/yapplabs) -- [#56](https://github.com/ember-cli/ember-cli-deploy/pull/56) [BREAKING ENHANCEMENT] Deprecated commands no longer needed. [@ember-cli](https://github.com/ember-cli) -- [#40](https://github.com/ember-cli/ember-cli-deploy/pull/40) [BUGFIX] Removed erroneous conflict markers. [@jamesfid](https://github.com/jamesfid) -- [#58](https://github.com/ember-cli/ember-cli-deploy/pull/58) [ENHANCEMENT] Add blueprint to auto generate config/deploy.js [@ember-cli](https://github.com/ember-cli) -- [#57](https://github.com/ember-cli/ember-cli-deploy/pull/57) [DEPRECATION] Deprecate use of deploy.json in favor of config/deploy.js. Closes #51 [@yapplabs](https://github.com/yapplabs) -- [#66](https://github.com/ember-cli/ember-cli-deploy/pull/66) [DOCS] Add note for fingerprint.prepend and staging envs. [@LevelbossMike](https://github.com/LevelbossMike) -- [#74](https://github.com/ember-cli/ember-cli-deploy/pull/74) [BREAKING DEPRECATION] Revert Unsupported Commands back to Deprecated for 0.4.0 release [@danshultz](https://github.com/danshultz) -- [#85](https://github.com/ember-cli/ember-cli-deploy/pull/85) [DEPRECATION] npm post install message for users of v0.0.6 [@achambers](https://github.com/achambers) +- [#33](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/33) [DOCS] Link to new S3 Index Adapter [@pootsbook](https://github.com/pootsbook) +- [#65](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/65) [DOCS] Update CodeClimate batch. [@LevelbossMike](https://github.com/LevelbossMike) +- [#35](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/35) [ENHANCEMENT] Match ember-cli's build command aliases by supporting --prod and --dev [@jamesfid](https://github.com/jamesfid) +- [#36](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/36) [ENHANCEMENT] Allow custom config file via --deploy-config-file. [@yapplabs](https://github.com/yapplabs) +- [#63](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/63) [BUGFIX] Fix regression to the type of object that was being passed to assets adapters as “config”. [@yapplabs](https://github.com/yapplabs) +- [#56](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/56) [BREAKING ENHANCEMENT] Deprecated commands no longer needed. [@ember-cli](https://github.com/ember-cli) +- [#40](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/40) [BUGFIX] Removed erroneous conflict markers. [@jamesfid](https://github.com/jamesfid) +- [#58](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/58) [ENHANCEMENT] Add blueprint to auto generate config/deploy.js [@ember-cli](https://github.com/ember-cli) +- [#57](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/57) [DEPRECATION] Deprecate use of deploy.json in favor of config/deploy.js. Closes #51 [@yapplabs](https://github.com/yapplabs) +- [#66](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/66) [DOCS] Add note for fingerprint.prepend and staging envs. [@LevelbossMike](https://github.com/LevelbossMike) +- [#74](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/74) [BREAKING DEPRECATION] Revert Unsupported Commands back to Deprecated for 0.4.0 release [@danshultz](https://github.com/danshultz) +- [#85](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/85) [DEPRECATION] npm post install message for users of v0.0.6 [@achambers](https://github.com/achambers) ### 0.3.1 (February 08, 2015) diff --git a/MIGRATING_FROM_0_0_x_TO_0_4_x.md b/MIGRATING_FROM_0_0_x_TO_0_4_x.md index f93c8a58..9fd06a60 100644 --- a/MIGRATING_FROM_0_0_x_TO_0_4_x.md +++ b/MIGRATING_FROM_0_0_x_TO_0_4_x.md @@ -1,6 +1,6 @@ ##Overview -`achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` are coming together to create the offical Ember CLI deployment tool, `ember-cli/ember-cli-deploy`. +`achambers/ember-cli-deploy`, `LevelBossMike/ember-deploy` and `tedconf/ember-cli-front-end-builds` are coming together to create the offical Ember CLI deployment tool, `ember-cli-deploy/ember-cli-deploy`. Users upgrading from the `ember-cli-deploy` npm package `<= v0.0.6` to `>= v0.4.0` will need to follow the migration steps below as the core codebase of the package will be changing completely. diff --git a/README.md b/README.md index 89567b68..ac981c8f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Ember CLI Deploy -[![Build Status](https://travis-ci.org/ember-cli/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/ember-cli/ember-cli-deploy/badges/gpa.svg)](https://codeclimate.com/github/ember-cli/ember-cli-deploy) +[![Build Status](https://travis-ci.org/ember-cli-deploy/ember-cli-deploy.svg?branch=master)](https://travis-ci.org/ember-cli-deploy/ember-cli-deploy) [![Code Climate](https://codeclimate.com/github/ember-cli-deploy/ember-cli-deploy/badges/gpa.svg)](https://codeclimate.com/github/ember-cli-deploy/ember-cli-deploy) Simple, flexible deployment for your Ember CLI app diff --git a/bin/changelog b/bin/changelog index decdcfef..4a7cbff5 100755 --- a/bin/changelog +++ b/bin/changelog @@ -45,7 +45,7 @@ compareCommits({ return a.number > b.number; }).map(function(pr) { var link = '[#' + pr.number + ']' + - '(https://github.com/ember-cli/ember-cli-deploy/pull/' + pr.number + ')'; + '(https://github.com/ember-cli-deploy/ember-cli-deploy/pull/' + pr.number + ')'; var title = pr.title; var author = '[@' + pr.author + ']' + '(https://github.com/' + pr.author +')'; diff --git a/package.json b/package.json index afc339dc..2500b16a 100644 --- a/package.json +++ b/package.json @@ -12,7 +12,7 @@ "test": "node node_modules/mocha/bin/mocha 'node-tests/**/*-test.js'", "autotest": "node node_modules/mocha/bin/mocha --watch --reporter spec 'node-tests/**/*-test.js'" }, - "repository": "https://github.com/ember-cli/ember-cli-deploy", + "repository": "https://github.com/ember-cli-deploy/ember-cli-deploy", "engines": { "node": ">= 0.10.0" }, From 43bdd973c17a7c9d8542a7390af35f801782136f Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 14 Apr 2016 00:26:16 -0400 Subject: [PATCH 208/300] Add ember-cli-release to make our release workflow easier --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index 2500b16a..ef6f67c3 100644 --- a/package.json +++ b/package.json @@ -19,9 +19,9 @@ "author": "", "license": "MIT", "devDependencies": { + "broccoli-asset-rev": "^2.1.2", "chai": "^1.9.2", "chai-as-promised": "^4.1.1", - "broccoli-asset-rev": "^2.1.2", "ember-cli": "1.13.8", "ember-cli-app-version": "0.5.0", "ember-cli-content-security-policy": "0.4.0", @@ -31,6 +31,7 @@ "ember-cli-ic-ajax": "0.2.1", "ember-cli-inject-live-reload": "^1.3.1", "ember-cli-qunit": "^1.0.0", + "ember-cli-release": "0.2.8", "github": "0.2.3", "mocha": "^2.0.1", "mocha-jshint": "^2.2.6", From 53f08c0eb2c3396637871633935a9805caee9b83 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 14 Apr 2016 00:26:48 -0400 Subject: [PATCH 209/300] Released v0.6.1 --- CHANGELOG.md | 12 ++++++++++++ package.json | 2 +- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1d8d1607..a113457a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,17 @@ # ember-cli-deploy Changelog +## [0.6.1](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.1) (2016-04-14) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.0...0.6.1) + +This release fixes a regression introduced by 0.6.0 that caused the command line flag for specifying a config file to stop working. Thanks to @dschmidt for the fix. + +This release also adds config options for specifying log colors (some users had complaints about lack of contrast against certain terminal backgrounds). Documentation is still forthcoming on this feature, but you can check PR #377 if you're anxious to use this. + +Pull Requests: + +- Fix config file option [\#385](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/385) ([dschmidt](https://github.com/dschmidt)) +- add config options for log colors [\#377](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/377) ([ghedamat](https://github.com/ghedamat)) + ## [0.6.0](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.0) (2016-02-26) [Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.5.1...0.6.0) diff --git a/package.json b/package.json index ef6f67c3..9901f6a7 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.0", + "version": "0.6.1", "directories": { "doc": "doc", "test": "tests" From 95ec3e3f2b5a8e25f7863250d5ad247a01fcebe3 Mon Sep 17 00:00:00 2001 From: orf Date: Thu, 14 Apr 2016 10:13:29 +0100 Subject: [PATCH 210/300] Bump lodash version to remove warning --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 9901f6a7..0d3e045b 100644 --- a/package.json +++ b/package.json @@ -52,7 +52,7 @@ "ember-cli-babel": "^5.1.3", "dotenv": "^1.1.0", "glob": "4.4.2", - "lodash-node": "^2.4.1", + "lodash": "^4.0.0", "mkdirp": "^0.5.0", "ncp": "^2.0.0", "rimraf": "^2.2.8", From 2eb2a0c9e2478cee48e2e1d2892e8e069d114fbe Mon Sep 17 00:00:00 2001 From: orf Date: Thu, 14 Apr 2016 10:16:25 +0100 Subject: [PATCH 211/300] Use require('lodash') over 'lodash-node' --- lib/models/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index a2456aa8..aaf2cc72 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -1,7 +1,7 @@ 'use strict'; var Promise = require('ember-cli/lib/ext/promise'); -var _ = require('lodash-node'); +var _ = require('lodash'); var chalk = require('chalk'); From cfb28d971214cd93b4baba2f1159d62103a2eb9d Mon Sep 17 00:00:00 2001 From: Owen Thomas Date: Thu, 14 Apr 2016 13:05:22 -0700 Subject: [PATCH 212/300] Update ember-cli links to ember-cli-deploy --- CHANGELOG.md | 2 +- README.md | 4 ++-- blueprints/ember-cli-deploy/index.js | 2 +- lib/tasks/pipeline.js | 2 +- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a113457a..63820999 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ Huge thanks to the fine work of the ember-cli-deploy core team, particularly @gh ### Plugin Authors -The `fetchRevisions` hook is now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli.com/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. Here is an example of [updating ember-cli-deploy-redis](https://github.com/ember-cli-deploy/ember-cli-deploy-redis/pull/50). +The `fetchRevisions` hook is now be called during the "deploy" and "activate" pipelines. It was previously only called during the "list" pipeline. In addition, a new `fetchInitialRevisions` hook will be called during the "deploy" and "activate" pipelines. See the [0.6.x Pipeline Hooks docs](http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.6.x/pipeline-hooks/) for details. If you maintain a plugin that uploads new revisions, you will want to update your plugin to implement the new hook. Here is an example of [updating ember-cli-deploy-redis](https://github.com/ember-cli-deploy/ember-cli-deploy-redis/pull/50). You should also update your ember-cli-deploy-plugin dependency to 0.2.2, to ensure your plugin's logging plays nicely with the nifty new progress bar in this ember-cli-deploy release. diff --git a/README.md b/README.md index ac981c8f..1deff79d 100644 --- a/README.md +++ b/README.md @@ -10,11 +10,11 @@ ember install ember-cli-deploy ``` ## Quick start -After installation, choose [plugins](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/configuration-overview/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/usage-overview/). +After installation, choose [plugins](http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/plugins/) matching your deployment environment, [configure](http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/configuration-overview/) your deployment script appropriately and you're ready to [start deploying](http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/usage-overview/). ## In-depth documentation -[Visit the Docs site](http://ember-cli.github.io/ember-cli-deploy/) +[Visit the Docs site](http://ember-cli-deploy.github.io/ember-cli-deploy/) ## Contributing diff --git a/blueprints/ember-cli-deploy/index.js b/blueprints/ember-cli-deploy/index.js index 18584411..323aa4c6 100644 --- a/blueprints/ember-cli-deploy/index.js +++ b/blueprints/ember-cli-deploy/index.js @@ -9,6 +9,6 @@ module.exports = { // to us }, afterInstall: function(options) { - this.ui.write(green('ember-cli-deploy needs plugins to actually do the deployment work.\nSee http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/quick-start/\nto learn how to install plugins and see what plugins are available.\n')); + this.ui.write(green('ember-cli-deploy needs plugins to actually do the deployment work.\nSee http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/quick-start/\nto learn how to install plugins and see what plugins are available.\n')); } }; diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 00bcece5..6dc11821 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -46,7 +46,7 @@ module.exports = Task.extend({ self.ui.writeError("\nWARNING: No plugins installed.\n"); self.ui.writeError("ember-cli-deploy works by registering plugins in its pipeline."); self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); - self.ui.writeError("Visit http://ember-cli.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); + self.ui.writeError("Visit http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); } pluginNames.forEach(function(pluginName) { From 75871f923c7bb0266e527ac76dfa312e25bdec0b Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 12 May 2016 15:35:38 -0400 Subject: [PATCH 213/300] Update changelog script to new repo owner --- bin/changelog | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/changelog b/bin/changelog index 4a7cbff5..8d20578f 100755 --- a/bin/changelog +++ b/bin/changelog @@ -20,7 +20,7 @@ var compareCommits = Promise.denodeify(github.repos.compareCommits); var currentVersion = 'v' + require('../package').version; compareCommits({ - user: 'ember-cli', + user: 'ember-cli-deploy', repo: 'ember-cli-deploy', base: currentVersion, head: 'master' From daee5a0eb590fa09bcad28d1016853cf6dd344eb Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 12 May 2016 15:43:09 -0400 Subject: [PATCH 214/300] Released v0.6.2 --- CHANGELOG.md | 6 ++++++ package.json | 2 +- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 63820999..c1c7db3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,11 @@ # ember-cli-deploy Changelog +## [0.6.2](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.2) (2016-05-12) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.1...0.6.2) + +- Bump lodash version to remove warning [#388](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/388) [@orf](https://github.com/orf) +- Update ember-cli links to ember-cli-deploy [#392](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/392) [@yothomas](https://github.com/yothomas) + ## [0.6.1](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.1) (2016-04-14) [Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.0...0.6.1) diff --git a/package.json b/package.json index 0d3e045b..82684a1f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.1", + "version": "0.6.2", "directories": { "doc": "doc", "test": "tests" From 147cedb5e12053faff0014d6aaf83292d20ce077 Mon Sep 17 00:00:00 2001 From: Danny Fallon Date: Thu, 26 May 2016 11:06:25 +0100 Subject: [PATCH 215/300] Fix plugin context merging in the pipeline model Since upgrading to lodash `^4.0.0` in v0.6.2 pipeline context merging has been broken. When your hook result has an object that exists in the context already (e.g. `distFiles`) then the results of your hook are no longer concatenated but instead overwrite the existing values. For example, if you have `context.distFiles` set to `['file1', file2']` and your hook returns `{distFiles: ['file3']}` then the resulting array is now `['file3', 'file2']`, not `['file1', 'file2', 'file3']` as it was before. This is because the `_.merge` function used to merge the contexts was changed in lodash 4 and is now a simple merger that takes an object and one or more sources to merge into that object; it no longer takes a custom merge function. To use a merge function you need to change to use `_.mergeWith`. I've made this change and added a test to ensure regression does not happen in future. --- lib/models/pipeline.js | 2 +- node-tests/unit/models/pipeline-test.js | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index aaf2cc72..f89b5f75 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -172,7 +172,7 @@ Pipeline.prototype._notifyPipelinePluginHookExecution = function(ui, fnObject, h }; Pipeline.prototype._mergePluginHookResultIntoContext = function(context,result) { - return _.merge(context, result, function(a, b) { + return _.mergeWith(context, result, function(a, b) { if (_.isArray(a)) { return a.concat(b); } diff --git a/node-tests/unit/models/pipeline-test.js b/node-tests/unit/models/pipeline-test.js index 837d22bf..b1bd830a 100644 --- a/node-tests/unit/models/pipeline-test.js +++ b/node-tests/unit/models/pipeline-test.js @@ -173,6 +173,24 @@ describe ('Pipeline', function() { expect(finalContext.age).to.equal(47); }); }); + + it('merges the return value of each hook with the context using concatenation', function() { + var subject = new Pipeline(['hook1'], {ui: {write: function() {}}}); + var finalContext = null; + + subject.register('hook1', function() { + return { paths: ['/tmp/path', '/var/path'] }; + }); + + subject.register('hook1', function(context) { + finalContext = context; + }); + + return expect(subject.execute({paths: ['/opt/path']})).to.be.fulfilled + .then(function() { + expect(finalContext.paths).to.deep.equal(['/opt/path', '/tmp/path', '/var/path']); + }); + }); }); describe('#hookNames', function() { From e72a1f35ba5f8249ca9a36abd9f2672ed353df3a Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Thu, 26 May 2016 11:05:28 -0400 Subject: [PATCH 216/300] Released v0.6.3 --- CHANGELOG.md | 5 +++++ package.json | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c1c7db3e..a37d322d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # ember-cli-deploy Changelog +## [0.6.3](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.3) (2016-05-26) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.2...0.6.3) + +- [#402](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/402) Fix plugin context merging in the pipeline model [@dannyfallon/df](https://github.com/dannyfallon/df) + ## [0.6.2](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.2) (2016-05-12) [Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.1...0.6.2) diff --git a/package.json b/package.json index 82684a1f..b1d914f0 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.2", + "version": "0.6.3", "directories": { "doc": "doc", "test": "tests" From e92509ccf544fa7370ae3dcf9d0a403ffd39e74d Mon Sep 17 00:00:00 2001 From: Hector Zarco Date: Fri, 3 Jun 2016 15:33:27 +0200 Subject: [PATCH 217/300] Show proper error login for unavailable plugins (#405) --- lib/tasks/pipeline.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 6dc11821..f7a665e4 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -112,7 +112,7 @@ module.exports = Task.extend({ }); if (Object.keys(unavailablePlugins).length !== 0) { - this.ui.writeError(unavailablePlugins); + this.ui.writeError(Object.keys(unavailablePlugins)); var error = new SilentError('plugins configuration references plugins which are not available.'); error.unavailablePlugins = unavailablePlugins; throw error; From e9b193f378833e56c2e703cc7075dcfd8458e90d Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Sat, 4 Jun 2016 20:45:53 -0400 Subject: [PATCH 218/300] add PULL_REQUEST_TEMPLATE --- .github/PULL_REQUEST_TEMPLATE | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE new file mode 100644 index 00000000..78679112 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE @@ -0,0 +1,13 @@ +## What Changed & Why +Explain what changed and why. + +## Related issues +Link to related issues in this or other repositories (if any) + +## PR Checklist +- [ ] Add tests +- [ ] Add documentation +- [ ] Prefix documentation-only commits with [DOC] + +## People +Mention people who would be interested in the changeset (if any) \ No newline at end of file From a55ff62300c6678287413bbc71f1e1d9c7c8d4d7 Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Sat, 4 Jun 2016 08:46:23 -0400 Subject: [PATCH 219/300] add requiredHooks to PipelineTask Certain tasks (i.e. `deploy:list`) need some hooks to be implemented by at least 1 plugin in order to execute correctly. This adds support for a `requiredHooks` property to the `PipelineTask` and specifies the required hooks for `deploy:list` and `deploy:activate` --- lib/commands/activate.js | 3 + lib/commands/list.js | 4 ++ lib/models/pipeline.js | 4 ++ lib/tasks/pipeline.js | 11 ++++ node-tests/unit/tasks/pipeline-test.js | 77 ++++++++++++++++++++++++++ 5 files changed, 99 insertions(+) diff --git a/lib/commands/activate.js b/lib/commands/activate.js index 181e5a59..59e2c702 100644 --- a/lib/commands/activate.js +++ b/lib/commands/activate.js @@ -51,6 +51,9 @@ module.exports = { 'fetchRevisions', 'didActivate', 'teardown' + ], + requiredHooks: [ + 'activate' ] }); diff --git a/lib/commands/list.js b/lib/commands/list.js index 03ae8668..b5f750ae 100644 --- a/lib/commands/list.js +++ b/lib/commands/list.js @@ -49,6 +49,10 @@ module.exports = { 'fetchRevisions', 'displayRevisions', 'teardown' + ], + requiredHooks: [ + 'fetchRevisions', + 'displayRevisions' ] }); diff --git a/lib/models/pipeline.js b/lib/models/pipeline.js index f89b5f75..928df8ae 100644 --- a/lib/models/pipeline.js +++ b/lib/models/pipeline.js @@ -52,6 +52,10 @@ Pipeline.prototype.register = function(hookName, fn) { } }; +Pipeline.prototype.hasHandlersForHook = function(hook) { + return this._pipelineHooks[hook].length !== 0; +}; + Pipeline.prototype.execute = function(context) { context = context || { }; diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index f7a665e4..5cf6ed0d 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -52,6 +52,17 @@ module.exports = Task.extend({ pluginNames.forEach(function(pluginName) { self._registerPipelineHooks(plugins[pluginName], pluginName); }); + + self._validatePresenceOfRequiredHooks(); + }, + + _validatePresenceOfRequiredHooks: function() { + (this.requiredHooks || []).forEach(function(hook) { + if (!this._pipeline.hasHandlersForHook(hook)) { + var error = new SilentError(hook + ' not implemented by any registered plugin'); + throw error; + } + }.bind(this)); }, _discoverInstalledPlugins: function(){ diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 1ed5faaf..030a611f 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -217,6 +217,83 @@ describe('PipelineTask', function() { expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); expect(registeredHooks.upload[0].fn).to.be.a('function'); }); + + describe('requiredHooks', function() { + it('validates that required hooks are implemented', function () { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'foo-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + config: { plugins: ['foo-plugin'] }, + hooks: ['willDeploy', 'upload'], + requiredHooks: ['willDeploy'] + }); + var fn = function() { + task.setup(); + }; + expect(fn).to.not.throw(/not implemented by any registered plugin/); + }); + + it('throws if required hooks are not implemented', function () { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'foo-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + config: { plugins: ['foo-plugin'] }, + hooks: ['willDeploy', 'upload', 'fetchRevisions'], + requiredHooks: ['fetchRevisions'] + }); + var fn = function() { + task.setup(); + }; + expect(fn).to.throw('fetchRevisions not implemented by any registered plugin'); + }); + }); + it('registers dependent plugin addons of a plugin pack addon designated by the ember-cli-deploy-plugin-pack keyword', function() { var project = { name: function() {return 'test-project';}, From f5c38bbc33c20b6c48e292d6230a41856f7d876d Mon Sep 17 00:00:00 2001 From: Alisdair McDiarmid Date: Thu, 23 Jun 2016 13:59:15 +0100 Subject: [PATCH 220/300] Fix CoreObject init/super deprecation Fixes #409 --- lib/tasks/deploy.js | 4 ++++ lib/tasks/pipeline.js | 4 ++++ lib/tasks/read-config.js | 4 ++++ 3 files changed, 12 insertions(+) diff --git a/lib/tasks/deploy.js b/lib/tasks/deploy.js index e1c7e0df..837a87f4 100644 --- a/lib/tasks/deploy.js +++ b/lib/tasks/deploy.js @@ -3,6 +3,10 @@ var PipelineTask = require('../tasks/pipeline'); module.exports = Task.extend({ init: function() { + if (this._super.init) { + this._super.init.apply(this, arguments); + } + this.commandOptions = this.commandOptions || {}; this.shouldActivate = this.shouldActivate || this._shouldActivate(this.commandOptions); }, diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 5cf6ed0d..724a8973 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -4,6 +4,10 @@ var Pipeline = require('../models/pipeline'); module.exports = Task.extend({ init: function() { + if (this._super.init) { + this._super.init.apply(this, arguments); + } + if (!this.project) { throw new SilentError('No project passed to pipeline task'); } diff --git a/lib/tasks/read-config.js b/lib/tasks/read-config.js index f452ff41..d9147eb8 100644 --- a/lib/tasks/read-config.js +++ b/lib/tasks/read-config.js @@ -8,6 +8,10 @@ var dotenv = require('dotenv'); module.exports = Task.extend({ init: function() { + if (this._super.init) { + this._super.init.apply(this, arguments); + } + if (!this.project) { throw new SilentError('No project passed to read-config task'); } From faf773b783a86516e69fbf533fd456fa3586de52 Mon Sep 17 00:00:00 2001 From: Luke Melia Date: Fri, 24 Jun 2016 13:45:14 -0400 Subject: [PATCH 221/300] Released v0.6.4 --- CHANGELOG.md | 7 +++++++ package.json | 2 +- 2 files changed, 8 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a37d322d..cc2697ac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,12 @@ # ember-cli-deploy Changelog +## [0.6.4](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.4) (2016-06-24) +[Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.3...0.6.4) + +- Fix CoreObject init/super deprecation [\#410](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/410) ([alisdair](https://github.com/alisdair)) +- add support for requiredHooks in pipelines for better error messages [\#406](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/406) ([ghedamat](https://github.com/ghedamat)) +- Validate configured plugins before continue with pipeline [\#405](https://github.com/ember-cli-deploy/ember-cli-deploy/pull/405) ([zzarcon](https://github.com/zzarcon)) + ## [0.6.3](https://github.com/ember-cli-deploy/ember-cli-deploy/tree/0.6.3) (2016-05-26) [Full Changelog](https://github.com/ember-cli-deploy/ember-cli-deploy/compare/v0.6.2...0.6.3) diff --git a/package.json b/package.json index b1d914f0..b7a77089 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.3", + "version": "0.6.4", "directories": { "doc": "doc", "test": "tests" From dfb6cc71d176cc20c88a4f84fcc4fe2eba6ff928 Mon Sep 17 00:00:00 2001 From: Edward Faulkner Date: Tue, 19 Jan 2016 21:57:12 -0500 Subject: [PATCH 222/300] Improved plugin run control This closes #307 with the following replacement for the hard-to-use `plugins` list: - the user can disable individual plugins by setting `disabled: true` on each plugin's config entry. - the user can influence plugin order by expressing inter-plugin dependencies with `runBefore` and `runAfter` on each plugin's config entry. - plugin authors can influence plugin order by expressing inter-plugin dependencies by setting `runBefore` and `runAfter` propreties directly on their plugin instance. --- lib/tasks/pipeline.js | 50 ++++- node-tests/unit/tasks/pipeline-test.js | 244 +++++++++++++++++++++++++ 2 files changed, 288 insertions(+), 6 deletions(-) diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 724a8973..69984207 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -1,4 +1,5 @@ var Task = require('ember-cli/lib/models/task'); +var DAG = require('ember-cli/lib/utilities/DAG'); var SilentError = require('silent-error'); var Pipeline = require('../models/pipeline'); @@ -44,7 +45,10 @@ module.exports = Task.extend({ plugins = self._installedPlugins; } - var pluginNames = Object.keys(plugins); + var pluginNames = Object.keys(plugins).filter(function(pluginName) { + var pluginConfig = self.config[pluginName]; + return !pluginConfig || !pluginConfig.disabled; + }) ; if (pluginNames.length === 0) { self.ui.writeError("\nWARNING: No plugins installed.\n"); @@ -53,8 +57,8 @@ module.exports = Task.extend({ self.ui.writeError("Visit http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); } - pluginNames.forEach(function(pluginName) { - self._registerPipelineHooks(plugins[pluginName], pluginName); + this._inDependencyOrder(plugins, pluginNames, function(deployPlugin) { + self._registerPipelineHooks(deployPlugin); }); self._validatePresenceOfRequiredHooks(); @@ -69,6 +73,32 @@ module.exports = Task.extend({ }.bind(this)); }, + _inDependencyOrder: function(plugins, names, fn) { + var config = this.config; + var graph = new DAG(); + + try { + names.forEach(function(name) { + var pluginConfig = config[name]; + var deployPlugin = plugins[name].createDeployPlugin({name: name}); + var before = asArray(pluginConfig, 'runBefore').concat(asArray(deployPlugin, 'runBefore')); + var after = asArray(pluginConfig, 'runAfter').concat(asArray(deployPlugin, 'runAfter')); + graph.addEdges(name, deployPlugin, before, after); + }); + + + graph.topsort(function (vertex) { + fn(vertex.value); + }); + } catch(err) { + if (/cycle detected/.test(err)) { + throw new SilentError("your ember-cli-deploy plugins have a circular dependency:" + err.message); + } else { + throw err; + } + } + }, + _discoverInstalledPlugins: function(){ var self = this; var installedPlugins = Object.create(null); @@ -141,9 +171,7 @@ module.exports = Task.extend({ return addon.name.match(pluginNameRegex)[2]; }, - _registerPipelineHooks: function(addon, alias) { - var deployPlugin = addon.createDeployPlugin({name: alias}); - + _registerPipelineHooks: function(deployPlugin) { this._pipeline.hookNames().forEach(function(hookName) { var fn = deployPlugin[hookName]; if (typeof fn !== 'function') { @@ -179,3 +207,13 @@ module.exports = Task.extend({ return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; } }); + +function asArray(obj, key) { + if (!obj || !obj[key]) { + return []; + } + if (typeof obj[key] === 'string') { + return [obj[key]]; + } + return obj[key].slice(); +} diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 030a611f..675fe7de 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -294,6 +294,66 @@ describe('PipelineTask', function() { }); }); + it('registers configured addons only, when using per-plugin disable flags', function () { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + { + name: 'ember-cli-deploy-foo-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'foo-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + }, + { + name: 'ember-cli-deploy-bar-plugin', + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + return { + name: 'bar-plugin', + willDeploy: function() {}, + upload: function() {} + }; + } + } + ] + }; + + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + config: { + 'bar-plugin': { + disabled: true + } + }, + hooks: ['willDeploy', 'upload'] + }); + task.setup(); + var registeredHooks = task._pipeline._pipelineHooks; + + expect(registeredHooks.willDeploy.length).to.equal(1); + expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); + expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); + expect(registeredHooks.upload.length).to.equal(1); + expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); + expect(registeredHooks.upload[0].fn).to.be.a('function'); + }); + it('registers dependent plugin addons of a plugin pack addon designated by the ember-cli-deploy-plugin-pack keyword', function() { var project = { name: function() {return 'test-project';}, @@ -559,4 +619,188 @@ describe('PipelineTask', function() { } }); }); + + describe("plugin ordering constraints", function() { + + function makeProject(addonNames) { + return { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: addonNames.map(function(name){ + return makeAddon(name); + }) + }; + } + + function makeAddon(name, props) { + return { + name: 'ember-cli-deploy-' + name, + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function() { + var plugin = Object.create({ + name: name, + willDeploy: function() {}, + upload: function() {} + }); + if (props) { + Object.keys(props).forEach(function(key) { plugin[key] = props[key]; }); + } + return plugin; + } + }; + } + + function testOrder(project, config, expectedNames) { + var task = new PipelineTask({ + project: project, + ui: mockUi, + deployTarget: 'development', + config: config, + hooks: ['willDeploy', 'upload'] + }); + task.setup(); + var registeredHooks = task._pipeline._pipelineHooks; + expect(registeredHooks.willDeploy.map(function(elt){ return elt.name; })).to.deep.equal(expectedNames); + } + + it("respects runBefore", function() { + var project = makeProject(['foo-plugin', 'bar-plugin']); + testOrder(project, { + 'bar-plugin': { + runBefore: ['foo-plugin'] + } + }, ['bar-plugin', 'foo-plugin']); + testOrder(project, { + 'foo-plugin': { + runBefore: ['bar-plugin'] + } + }, ['foo-plugin', 'bar-plugin']); + }); + + it("respects runAfter", function() { + var project = makeProject(['foo-plugin', 'bar-plugin']); + testOrder(project, { + 'bar-plugin': { + runAfter: ['foo-plugin'] + } + }, ['foo-plugin', 'bar-plugin']); + testOrder(project, { + 'foo-plugin': { + runAfter: ['bar-plugin'] + } + }, ['bar-plugin', 'foo-plugin']); + }); + + it("respects multiple constraints", function() { + var project = makeProject(['foo', 'bar', 'baz']); + + testOrder(project, { + foo: { + runAfter: ['bar', 'baz'] + }, + baz: { + runAfter: ['bar'] + } + }, ['bar', 'baz', 'foo']); + + testOrder(project, { + bar: { + runAfter: ['foo', 'baz'] + }, + baz: { + runAfter: ['foo'] + } + }, ['foo', 'baz', 'bar']); + + }); + + it("respects author-provided constraints", function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makeAddon('foo', {}), + makeAddon('bar', { runAfter: ['foo'] }), + makeAddon('baz', { runBefore: ['foo'] }) + ] + }; + + testOrder(project, {}, ['baz', 'foo', 'bar']); + + }); + + + it("merges author-provided and user-provided constraints", function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makeAddon('foo', {}), + makeAddon('bar', { runAfter: ['foo'] }), + makeAddon('baz', { }) + ] + }; + + testOrder(project, { + baz: { + runBefore: ['foo'] + } + }, ['baz', 'foo', 'bar']); + + testOrder(project, { + baz: { + runAfter: ['foo', 'bar'] + } + }, ['foo', 'bar', 'baz']); + + project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makeAddon('foo', {}), + makeAddon('bar', { runBefore: ['foo'] }), + makeAddon('baz', { }) + ] + }; + + testOrder(project, { + baz: { + runBefore: ['foo', 'bar'] + } + }, ['baz', 'bar', 'foo']); + + testOrder(project, { + baz: { + runAfter: ['foo'] + } + }, ['bar', 'foo', 'baz']); + + + }); + + + it("detects cycles", function() { + var project = makeProject(['foo', 'bar', 'baz']); + + expect(function() { + testOrder(project, { + foo: { + runAfter: ['bar'] + }, + bar: { + runAfter: ['baz'] + }, + baz: { + runAfter: ['foo'] + } + }); + }).to.throw(/your ember-cli-deploy plugins have a circular dependency.*baz.*foo.*bar.*baz/); + + }); + + }); }); From 656ebde2c458800ebb34cf2dd2ed66259f9a5448 Mon Sep 17 00:00:00 2001 From: Aaron Chambers Date: Mon, 6 Jun 2016 17:10:53 +0100 Subject: [PATCH 223/300] Move plugin control to Plugin Registry and implement aliasing --- lib/models/deprecated-plugin-registry.js | 56 ++ lib/models/plugin-registry.js | 339 ++++++++ lib/tasks/pipeline.js | 157 +--- ...loy-for-addons-config-test-with-aliases.js | 5 - .../models/deprecated-plugin-registry-test.js | 103 +++ .../unit/models/plugin-registry-test.js | 644 ++++++++++++++++ node-tests/unit/tasks/pipeline-test.js | 723 ++---------------- package.json | 4 +- 8 files changed, 1237 insertions(+), 794 deletions(-) create mode 100644 lib/models/deprecated-plugin-registry.js create mode 100644 lib/models/plugin-registry.js delete mode 100644 node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js create mode 100644 node-tests/unit/models/deprecated-plugin-registry-test.js create mode 100644 node-tests/unit/models/plugin-registry-test.js diff --git a/lib/models/deprecated-plugin-registry.js b/lib/models/deprecated-plugin-registry.js new file mode 100644 index 00000000..60cc1cff --- /dev/null +++ b/lib/models/deprecated-plugin-registry.js @@ -0,0 +1,56 @@ +var CoreObject = require('core-object'); +var SilentError = require('silent-error'); +var PluginRegistry = require('./plugin-registry'); + +module.exports = CoreObject.extend({ + init: function(project, ui, config) { + this._registry = new PluginRegistry(project, ui, config); + this._config = config; + this._project = project; + + if (this._isUsingOldPluginControl()) { + if (this._isUsingNewPluginControl()) { + var message = 'Use of the old and new plugin controls simultaneously does not make sense.\n' + + 'Please use the new plugin controls\n' + + 'See the following page for information:\n\n' + + 'http://ember-cli-deploy.com/docs/v1.0.x-beta.1/configuration/\n'; + throw new SilentError(message); + } else { + ui.writeError('Use of the `config.plugins` property has been deprecated. Please use the new plugin run controls.'); + ui.writeError('See the following page for information:\n'); + ui.writeError('http://ember-cli-deploy.com/docs/v1.0.x-beta.1/configuration/'); + } + } + }, + + pluginInstances: function() { + var addons = this._project.addons || []; + var plugins = this._registry._plugins(addons); + + return this._config.plugins.map(function(entry) { + var parts = entry.split(':'); + var name = parts[0]; + var alias = parts[1] || name; + var addon = plugins[name]; + + if (addon) { + return addon.createDeployPlugin({ name: alias }); + } + }, []) + .filter(function(item) { + return !!item; + }); + }, + + _isUsingOldPluginControl: function() { + return this._config.plugins; + }, + + _isUsingNewPluginControl: function() { + var aliasConfig = Object.keys(this._registry._aliasConfig).length; + var disabledConfig = Object.keys(this._registry._disabledConfig).length; + var runOrderConfig = Object.keys(this._registry._runOrderConfig).length; + + return aliasConfig || disabledConfig || runOrderConfig; + }, +}); diff --git a/lib/models/plugin-registry.js b/lib/models/plugin-registry.js new file mode 100644 index 00000000..21608fe5 --- /dev/null +++ b/lib/models/plugin-registry.js @@ -0,0 +1,339 @@ +var CoreObject = require('core-object'); +var DAG = require('ember-cli/lib/utilities/DAG'); +var SilentError = require('silent-error'); +var chalk = require('chalk'); +var _ = require('lodash'); + +/** + * Glossary + * + * - addon: An ember-cli addon + * - plugin: An addon that contains the `ember-cli-deploy` keyword and implements the `createDeployPlugin` function + * - pluginInstance: An instance of a plugin created by executing `createDeployPLugin`. A single plugin can have multiple aliased instances created + **/ + +module.exports = CoreObject.extend({ + init: function(project, ui, config) { + this._project = project; + this._ui = ui; + this._aliasConfig = (config.pipeline && config.pipeline.alias) || {}; + this._runOrderConfig = (config.pipeline && config.pipeline.runOrder) || {}; + this._disabledConfig = (config.pipeline && config.pipeline.disabled) || {}; + }, + + pluginInstances: function() { + var addons = this._project.addons || []; + var plugins = this._plugins(addons); + var aliasMap = this._buildAliasMap(plugins, this._aliasConfig); + var disabledMap = this._buildDisabledMap(aliasMap, this._disabledConfig); + var pluginInstances = this._pluginInstances(plugins, aliasMap); + var runOrderMap = this._buildRunOrderMap(this._runOrderConfig, aliasMap, pluginInstances); + var enabledPluginInstances = this._applyDisabledConfig(pluginInstances, disabledMap); + var orderedPluginInstances = this._applyRunOrderConfig(enabledPluginInstances, runOrderMap); + + if (orderedPluginInstances.length === 0) { + this._ui.writeError('\nWARNING: No plugins installed/enabled\n'); + this._ui.writeError('ember-cli-deploy works by registering plugins in it\'s pipeline.\n'); + this._ui.writeError('In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n'); + this._ui.writeError('Visit http://ember-cli-deploy.com/plugins/ for a list of supported plugins.\n'); + } + + return orderedPluginInstances; + }, + + _plugins: function(addons) { + if (!this._cachedValidAddons) { + this._cachedValidAddons = this._discoverPlugins(addons); + } + + return this._cachedValidAddons; + }, + + _discoverPlugins: function(addons){ + var self = this; + return addons.reduce(function(plugins, addon) { + if (self._isValidPlugin(addon)) { + var pluginName = self._pluginName(addon); + plugins[pluginName] = addon; + } + + if (self._isDeployPluginPack(addon)) { + var nestedAddons = self._discoverPlugins(addon.addons); + plugins = Object.keys(nestedAddons).reduce(function(v, key) { + v[key] = nestedAddons[key]; + return v; + }, plugins); + } + + return plugins; + }, {}); + }, + + /** + * Build up a hash of the all plugin aliases, keyed by plugin name, with the value being an array of aliases. + * This hash will contain an entry for every installed plugin. + * + * If a plugin has not been referenced in `config.pipeline.alias` then it will be added to the map + * with an alias to it's original name (see `boo` below), + * + * Example return value: + * + * { + * foo: { as: ['bar', 'baz'] }, + * boo: { as: ['boo'] } + * } + * */ + _buildAliasMap: function(plugins, config) { + var self = this; + var aliasMap = Object.keys(plugins) + .reduce(function(aliases, pluginName) { + if (!aliases[pluginName] || !aliases[pluginName].as) { + aliases[pluginName] = { as: [pluginName] }; + } + + aliases[pluginName].as = self._castArray(aliases[pluginName].as); + return aliases; + }, config); + + var unknownConfigKeys = _.difference(Object.keys(aliasMap), Object.keys(plugins)); + + if (unknownConfigKeys.length) { + this._logUnknownPlugins(unknownConfigKeys, 'config.pipeline.alias'); + } + + return aliasMap; + }, + + /** + * Build up a hash of disabled plugin instances, keyed by alias, with the value being whether it's disabled or not + * This hash will contain an entry for every installed plugin. + * + * If a plugin has not been referenced in `config.pipeline.disabled` then it will be added to the map as `disabled: false`. + * + * Example return value: + * + * { + * foo: true, + * bar: false + * } + **/ + _buildDisabledMap: function(aliasMap, config) { + var aliases = this._flattenAliasMap(aliasMap); + var allExcept = null; + + if (typeof config.allExcept !== 'undefined') { + allExcept = this._castArray(config.allExcept); + delete config.allExcept; + } + + var keys = Object.keys(config); + + if (allExcept) { + keys = keys.concat(allExcept); + } + + var unknownConfigKeys = _.difference(keys, aliases); + + if (unknownConfigKeys.length) { + this._logUnknownPlugins(unknownConfigKeys, 'config.pipeline.disabled'); + } + + var disabledMap = aliases.reduce(function(map, alias) { + if (map[alias] === undefined) { + if (allExcept && allExcept.length) { + if (allExcept.indexOf(alias) >= 0) { + map[alias] = false; + } else { + map[alias] = true; + } + } else { + map[alias] = false; + } + } + + return map; + }, config); + + return disabledMap; + }, + + /** + * Build up a hash of plugin instance execution order overrides. + * This hash will only container an entry for instances that should run in a particular order. All other instances will be ordered by their natural + * ordering. + * + * Ordering of plugin instances can be specified by users of ember-cli-deploy via `config.pipeline.runOrder` and by plugin authors via `run{Before,After}`. + * This function will attempt to merge the author defined run orders with the user defined ones. + * + * Example return value: + * + * { + * foo: { before: ['bar'] }, + * baz: { after: ['boo', 'bom'] } + * } + * + * + **/ + _buildRunOrderMap: function(config, aliasMap, pluginInstances) { + var self = this; + + pluginInstances.forEach(function(instance) { + if (instance.runBefore) { + var befores = self._castArray(instance.runBefore); + config = self._mergeAuthorProvidedOrderWithConfigOrder('before', instance.name, befores, config, aliasMap); + } + + if (instance.runAfter) { + var afters = self._castArray(instance.runAfter); + config = self._mergeAuthorProvidedOrderWithConfigOrder('after', instance.name, afters, config, aliasMap); + } + }); + + var aliases = this._flattenAliasMap(aliasMap); + + var configNames = Object.keys(config).reduce(function(arr, key) { + arr.push(key); + + var befores = self._castArray(config[key].before); + var afters = self._castArray(config[key].after); + + return arr.concat(befores).concat(afters); + }, []) + .reduce(function(arr, key) { + if (arr.indexOf(key) === -1) { + arr.push(key); + } + return arr; + }, []); + + var unknownConfigKeys = _.difference(configNames, aliases); + + if (unknownConfigKeys.length) { + this._logUnknownPlugins(unknownConfigKeys, 'config.pipeline.runOrder'); + } + + return config; + }, + + _pluginInstances: function(plugins, aliasMap) { + return Object.keys(plugins) + .map(function(pluginName) { + var addon = plugins[pluginName]; + var aliases = aliasMap[pluginName].as; + + return aliases.map(function(alias) { + var v = addon.createDeployPlugin({ name: alias }); + return v; + }); + }) + .reduce(function(instances, arr) { + return instances.concat(arr); + }, []); + }, + + _applyDisabledConfig: function(pluginInstances, disabledMap) { + return pluginInstances.filter(function(instance) { + return !disabledMap[instance.name]; + }) ; + }, + + _applyRunOrderConfig: function(pluginInstances, runOrderMap) { + var self = this; + var graph = new DAG(); + var sortedInstances = []; + + try { + pluginInstances.forEach(function(instance) { + var before = (runOrderMap[instance.name] && self._castArray(runOrderMap[instance.name].before)) || []; + var after = (runOrderMap[instance.name] && self._castArray(runOrderMap[instance.name].after)) || []; + graph.addEdges(instance.name, instance, before, after); + }); + + graph.topsort(function (vertex) { + sortedInstances.push(vertex.value); + }); + } catch(err) { + if (/cycle detected/.test(err)) { + throw new SilentError('your ember-cli-deploy plugins have a circular dependency:' + err.message); + } else { + throw err; + } + } + + return sortedInstances; + }, + + _isDeployPluginPack: function(addon) { + return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin-pack'); + }, + + _isValidPlugin: function(addon) { + return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin') && this._addonImplementsDeploymentHooks(addon); + }, + + _pluginName: function(addon) { + var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; + return addon.name.match(pluginNameRegex)[2]; + }, + + _addonHasKeyword: function(addon, keyword) { + var keywords = addon.pkg.keywords; + return keywords.indexOf(keyword) > -1; + }, + + _addonImplementsDeploymentHooks: function(addon) { + return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; + }, + + _castArray: function(obj) { + if (!obj) { + return []; + } + + return _.castArray(obj); + }, + + _mergeAuthorProvidedOrderWithConfigOrder: function(type, instanceName, names, config, aliasMap) { + var self = this; + names.forEach(function(name) { + var aliases = aliasMap[name] && aliasMap[name].as; + if (aliases) { + if (!config[instanceName]) { + config[instanceName] = {}; + } + + if (!config[instanceName][type]) { + config[instanceName][type] = aliases; + } else { + var combined = self._castArray(config[instanceName][type]) + .reduce(function(all, current) { + if (all.indexOf(current) === -1) { + all.push(current); + } + + return all; + }, aliases); + config[instanceName][type] = combined; + } + } + }); + + return config; + }, + + _logUnknownPlugins: function(names, key) { + var message = chalk.yellow('Your config has referenced the following unknown plugins or aliases in `' + key + '`:\n'); + this._ui.writeLine(message, 'WARNING'); + names.forEach(function(name) { + message = chalk.yellow('- ' + name + '\n'); + this._ui.writeLine(message, 'WARNING'); + }.bind(this)); + }, + + _flattenAliasMap: function(aliasMap) { + return Object.keys(aliasMap) + .reduce(function(aliases, pluginName) { + return aliases.concat(aliasMap[pluginName].as); + }, []); + }, +}); diff --git a/lib/tasks/pipeline.js b/lib/tasks/pipeline.js index 69984207..2fc0171c 100644 --- a/lib/tasks/pipeline.js +++ b/lib/tasks/pipeline.js @@ -1,7 +1,8 @@ -var Task = require('ember-cli/lib/models/task'); -var DAG = require('ember-cli/lib/utilities/DAG'); -var SilentError = require('silent-error'); -var Pipeline = require('../models/pipeline'); +var Task = require('ember-cli/lib/models/task'); +var SilentError = require('silent-error'); +var Pipeline = require('../models/pipeline'); +var PluginRegistry = require('../models/plugin-registry'); +var DeprecatedPluginRegistry = require('../models/deprecated-plugin-registry'); module.exports = Task.extend({ init: function() { @@ -32,36 +33,12 @@ module.exports = Task.extend({ this.commandOptions = this.commandOptions || {}; }, - setup: function(){ - var self = this; - self._installedPlugins = self._discoverInstalledPlugins(); - - var plugins; - var configuredPluginList = this.config.plugins; - if (configuredPluginList) { - plugins = self._configuredPlugins(configuredPluginList, self._installedPlugins); - } else { - // no whitelist available, use all autodiscovered plugins - plugins = self._installedPlugins; - } - - var pluginNames = Object.keys(plugins).filter(function(pluginName) { - var pluginConfig = self.config[pluginName]; - return !pluginConfig || !pluginConfig.disabled; - }) ; - - if (pluginNames.length === 0) { - self.ui.writeError("\nWARNING: No plugins installed.\n"); - self.ui.writeError("ember-cli-deploy works by registering plugins in its pipeline."); - self.ui.writeError("In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.\n"); - self.ui.writeError("Visit http://ember-cli-deploy.github.io/ember-cli-deploy/docs/v0.5.x/plugins/ for a list of supported plugins.\n"); - } - - this._inDependencyOrder(plugins, pluginNames, function(deployPlugin) { - self._registerPipelineHooks(deployPlugin); - }); + setup: function() { + this._pluginInstances().forEach(function(instance) { + this._registerPipelineHooks(instance); + }.bind(this)); - self._validatePresenceOfRequiredHooks(); + this._validatePresenceOfRequiredHooks(); }, _validatePresenceOfRequiredHooks: function() { @@ -73,56 +50,6 @@ module.exports = Task.extend({ }.bind(this)); }, - _inDependencyOrder: function(plugins, names, fn) { - var config = this.config; - var graph = new DAG(); - - try { - names.forEach(function(name) { - var pluginConfig = config[name]; - var deployPlugin = plugins[name].createDeployPlugin({name: name}); - var before = asArray(pluginConfig, 'runBefore').concat(asArray(deployPlugin, 'runBefore')); - var after = asArray(pluginConfig, 'runAfter').concat(asArray(deployPlugin, 'runAfter')); - graph.addEdges(name, deployPlugin, before, after); - }); - - - graph.topsort(function (vertex) { - fn(vertex.value); - }); - } catch(err) { - if (/cycle detected/.test(err)) { - throw new SilentError("your ember-cli-deploy plugins have a circular dependency:" + err.message); - } else { - throw err; - } - } - }, - - _discoverInstalledPlugins: function(){ - var self = this; - var installedPlugins = Object.create(null); - (this.project.addons || []).forEach(function(addon){ - self._registerInstalledPlugin(addon, installedPlugins); - }); - return installedPlugins; - }, - - _registerInstalledPlugin: function(addon, registry) { - var self = this; - - if (this._isDeployPluginPack(addon)) { - addon.addons.forEach(function(nestedAddon){ - self._registerInstalledPlugin(nestedAddon, registry); - }); - return; - } - - if (!this._isValidDeployPlugin(addon)) { return; } - - registry[this._pluginNameFromAddonName(addon)] = addon; - }, - run: function() { var pipeline = this._pipeline; var ui = this.ui; @@ -140,35 +67,14 @@ module.exports = Task.extend({ return pipeline.execute(context); }, - _configuredPlugins: function(configuredPluginNames, availablePlugins) { - var unavailablePlugins = Object.create(null); - var configuredPlugins = Object.create(null); - - configuredPluginNames.forEach(function(configuredPluginKey) { - var parts = configuredPluginKey.split(':', 2); - var pluginName = parts[0]; - var configuredName = parts[1] ? parts[1] : parts[0]; - - if (availablePlugins[pluginName]) { - configuredPlugins[configuredName] = availablePlugins[pluginName]; - } else { - unavailablePlugins[configuredName] = pluginName; - } - }); - - if (Object.keys(unavailablePlugins).length !== 0) { - this.ui.writeError(Object.keys(unavailablePlugins)); - var error = new SilentError('plugins configuration references plugins which are not available.'); - error.unavailablePlugins = unavailablePlugins; - throw error; + _pluginInstances: function() { + var registry; + if (this.config.plugins) { + registry = new DeprecatedPluginRegistry(this.project, this.ui, this.config); + } else { + registry = new PluginRegistry(this.project, this.ui, this.config); } - - return configuredPlugins; - }, - - _pluginNameFromAddonName: function(addon) { - var pluginNameRegex = /^(ember\-cli\-deploy\-)(.*)$/; - return addon.name.match(pluginNameRegex)[2]; + return registry.pluginInstances(); }, _registerPipelineHooks: function(deployPlugin) { @@ -181,7 +87,7 @@ module.exports = Task.extend({ this._pipeline.register(hookName, { name: deployPlugin.name, fn: function(context){ - if (deployPlugin.beforeHook && typeof deployPlugin.beforeHook === 'function') { + if (deployPlugin.beforeHook && typeof deployPlugin.beforeHook === 'function') { deployPlugin.beforeHook(context); } return fn.call(deployPlugin, context); @@ -189,31 +95,4 @@ module.exports = Task.extend({ }); }.bind(this)); }, - - _isDeployPluginPack: function(addon) { - return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin-pack'); - }, - - _isValidDeployPlugin: function(addon) { - return this._addonHasKeyword(addon, 'ember-cli-deploy-plugin') && this._addonImplementsDeploymentHooks(addon); - }, - - _addonHasKeyword: function(addon, keyword) { - var keywords = addon.pkg.keywords; - return keywords.indexOf(keyword) > -1; - }, - - _addonImplementsDeploymentHooks: function(addon) { - return addon.createDeployPlugin && typeof addon.createDeployPlugin === 'function'; - } }); - -function asArray(obj, key) { - if (!obj || !obj[key]) { - return []; - } - if (typeof obj[key] === 'string') { - return [obj[key]]; - } - return obj[key].slice(); -} diff --git a/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js b/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js deleted file mode 100644 index b4e8da86..00000000 --- a/node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js +++ /dev/null @@ -1,5 +0,0 @@ -module.exports = function(/* environment */) { - return { - plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] - }; -}; diff --git a/node-tests/unit/models/deprecated-plugin-registry-test.js b/node-tests/unit/models/deprecated-plugin-registry-test.js new file mode 100644 index 00000000..0ac7a772 --- /dev/null +++ b/node-tests/unit/models/deprecated-plugin-registry-test.js @@ -0,0 +1,103 @@ +var expect = require('../../helpers/expect'); +var DeprecatedPluginRegistry = require('../../../lib/models/deprecated-plugin-registry'); + +var logOutput, mockUi; + +describe('Deprecated Plugin Registry', function() { + beforeEach(function() { + logOutput = []; + mockUi = { + writeLine: function(s) { + var sanitized = s.replace('\u001b[33m', '') + .replace('\u001b[39m', '') + .replace(/\n/g, ''); + logOutput.push(sanitized); + }, + writeError: function(s) { + var sanitized = s.replace('\u001b[33m', '') + .replace('\u001b[39m', '') + .replace(/\n/g, ''); + logOutput.push(sanitized); + } + }; + }); + + afterEach(function() { + logOutput = null; + mockUi = null; + }); + + it('warns the user that config.plugins has been deprecated', function() { + var project = makeProject(['foo']); + var config = { + plugins: ['foo', 'foo:bar'], + }; + + new DeprecatedPluginRegistry(project, mockUi, config); + + expect(logOutput.length).to.eq(3); + expect(logOutput[0]).to.eq('Use of the `config.plugins` property has been deprecated. Please use the new plugin run controls.'); + expect(logOutput[1]).to.eq('See the following page for information:'); + expect(logOutput[2]).to.eq('http://ember-cli-deploy.com/docs/v1.0.x-beta.1/configuration/'); + }); + + it('throws an error if using old and new plugin controls simultaneously', function() { + var project = makeProject(['foo']); + var config = { + plugins: ['foo', 'foo:bar'], + pipeline: { + alias: { + foo: { as: ['foo', 'foo:bar'] } + }, + }, + }; + + expect(function() { + new DeprecatedPluginRegistry(project, mockUi, config); + }).to.throw('Use of the old and new plugin controls simultaneously does not make sense.\nPlease use the new plugin controls\nSee the following page for information:\n\nhttp://ember-cli-deploy.com/docs/v1.0.x-beta.1/configuration/\n'); + }); + + it('returns the list of deploy plugins', function() { + var project = makeProject(['a', 'b', 'c', 'd']); + + var registry = new DeprecatedPluginRegistry(project, mockUi, { + plugins: ['a', 'c', 'c:2', 'd:e'], + }); + + var plugins = registry.pluginInstances(); + + expect(plugins.map(function(plugin) { return plugin.name; })).to.deep.equal(['a', 'c', '2', 'e']); + }); +}); + +function makeProject(addonNames) { + return { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: addonNames.map(function(name){ + return makePlugin(name); + }) + }; +} + +function makePlugin(name, props) { + return { + name: 'ember-cli-deploy-' + name, + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function(options) { + var plugin = Object.create({ + name: options.name, + willDeploy: function() {}, + upload: function() {} + }); + if (props) { + Object.keys(props).forEach(function(key) { plugin[key] = props[key]; }); + } + return plugin; + } + }; +} diff --git a/node-tests/unit/models/plugin-registry-test.js b/node-tests/unit/models/plugin-registry-test.js new file mode 100644 index 00000000..deaaabb4 --- /dev/null +++ b/node-tests/unit/models/plugin-registry-test.js @@ -0,0 +1,644 @@ +var expect = require('../../helpers/expect'); +var PluginRegistry = require('../../../lib/models/plugin-registry'); + +var logOutput, mockUi; + +describe('Plugin Registry', function() { + beforeEach(function() { + logOutput = []; + mockUi = { + writeLine: function(s) { + var sanitized = s.replace('\u001b[33m', '') + .replace('\u001b[39m', '') + .replace(/\n/g, ''); + logOutput.push(sanitized); + }, + writeError: function(s) { + var sanitized = s.replace('\u001b[33m', '') + .replace('\u001b[39m', '') + .replace(/\n/g, ''); + logOutput.push(sanitized); + } + }; + }); + + afterEach(function() { + logOutput = null; + mockUi = null; + }); + + describe('initialization', function() { + it('initializes the pipeline correctly', function() { + var project = makeProject(['foo']); + var config = { + pipeline: { + alias: {}, + runOrder: {}, + disabled: {}, + }, + }; + + var registry = new PluginRegistry(project, mockUi, config); + + expect(registry._project).to.deep.equal(project); + expect(registry._ui).to.deep.equal(mockUi); + expect(registry._aliasConfig).to.equal(config.pipeline.alias); + expect(registry._runOrderConfig).to.equal(config.pipeline.runOrder); + expect(registry._disabledConfig).to.equal(config.pipeline.disabled); + }); + + it('initializes the pipeline correctly when pipeline is undefined', function() { + var project = makeProject(['foo']); + var config = { }; + + var registry = new PluginRegistry(project, mockUi, config); + + expect(registry._project).to.deep.equal(project); + expect(registry._ui).to.deep.equal(mockUi); + expect(registry._aliasConfig).to.deep.equal({}); + expect(registry._runOrderConfig).to.deep.equal({}); + expect(registry._disabledConfig).to.deep.equal({}); + }); + + it('initializes the pipeline correctly when pipeline is defined but plugin controls are not', function() { + var project = makeProject(['foo']); + var config = { + pipeline: {}, + }; + + var registry = new PluginRegistry(project, mockUi, config); + + expect(registry._project).to.deep.equal(project); + expect(registry._ui).to.deep.equal(mockUi); + expect(registry._aliasConfig).to.deep.equal({}); + expect(registry._runOrderConfig).to.deep.equal({}); + expect(registry._disabledConfig).to.deep.equal({}); + }); + }); + + it('warns if no plugins are installed', function() { + var project = makeProject([]); + + var registry = new PluginRegistry(project, mockUi, {}); + + registry.pluginInstances(); + + expect(logOutput.length).to.eq(4); + expect(logOutput[0]).to.eq('WARNING: No plugins installed/enabled'); + expect(logOutput[1]).to.eq('ember-cli-deploy works by registering plugins in it\'s pipeline.'); + expect(logOutput[2]).to.eq('In order to execute a deployment you must install at least one ember-cli-deploy compatible plugin.'); + expect(logOutput[3]).to.eq('Visit http://ember-cli-deploy.com/plugins/ for a list of supported plugins.'); + }); + + it('returns plugins for addons that have the correct keyword and implement the plugin function', function() { + var validPlugin = makePlugin('foo'); + var addonMissingKeyword = makeAddon('bar'); + var addonMissingPluginFunction = makePlugin('bar'); + delete addonMissingPluginFunction.createDeployPlugin; + + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [validPlugin, addonMissingKeyword, addonMissingPluginFunction], + }; + + var registry = new PluginRegistry(project, mockUi, {}); + + var plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(1); + expect(plugins[0].name).to.equal('foo'); + expect(typeof plugins[0].willDeploy).to.equal('function'); + expect(typeof plugins[0].upload).to.equal('function'); + }); + + it('returns plugins from plugin packs', function() { + var validPlugin = makePlugin('foo'); + var validPluginPack = makePluginPack('bar', [validPlugin]); + + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [validPluginPack], + }; + + var registry = new PluginRegistry(project, mockUi, {}); + + var plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(1); + expect(plugins[0].name).to.equal('foo'); + }); + + it('includes plugin packs that are also plugins', function() { + var validPlugin = makePlugin('foo'); + var validPluginPack = makePluginPack('bar', [validPlugin]); + validPluginPack.pkg.keywords.push('ember-cli-deploy-plugin'); + validPluginPack.createDeployPlugin = function(options) { return { name: options.name }; }; + + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [validPluginPack], + }; + + var registry = new PluginRegistry(project, mockUi, {}); + + var plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(2); + expect(plugins[0].name).to.equal('bar'); + expect(plugins[1].name).to.equal('foo'); + }); + + describe('aliasing plugins', function() { + it('returns plugin instances for aliases defined in config', function() { + var project = makeProject(['foo', 'bar', 'baz']); + + var registry = new PluginRegistry(project, mockUi, { + pipeline: { + alias: { + foo: { as: 'xxx' }, + bar: { as: ['bar', 'bbb'] }, + }, + }, + }); + + var plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(4); + expect(plugins[0].name).to.equal('xxx'); + expect(plugins[1].name).to.equal('bar'); + expect(plugins[2].name).to.equal('bbb'); + expect(plugins[3].name).to.equal('baz'); + }); + + it('warns if alias config references an addon that is not installed', function() { + var project = makeProject(['foo']); + + var registry = new PluginRegistry(project, mockUi, { + pipeline: { + alias: { + bar: { as: ['baz'] }, + }, + }, + }); + + registry.pluginInstances(); + + expect(logOutput.length).to.eq(2); + expect(logOutput[0]).to.eq('Your config has referenced the following unknown plugins or aliases in `config.pipeline.alias`:'); + expect(logOutput[1]).to.eq('- bar'); + }); + }); + + describe('disabling plugins', function() { + it('returns only plugins that are not marked as disabled', function() { + var project = makeProject(['foo', 'bar', 'baz']); + + var registry = new PluginRegistry(project, mockUi, { + pipeline: { + alias: { + baz: { as: ['aaa', 'bbb'] }, + }, + disabled: { + foo: true, + bar: false, + bbb: true, + }, + }, + }); + + var plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(2); + expect(plugins[0].name).to.equal('bar'); + expect(plugins[1].name).to.equal('aaa'); + expect(logOutput.length).to.eq(0); + + registry = new PluginRegistry(project, mockUi, { + pipeline: { + alias: { + baz: { as: ['aaa', 'bbb'] }, + }, + disabled: { + allExcept: 'aaa', + }, + }, + }); + + plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(1); + expect(plugins[0].name).to.equal('aaa'); + expect(logOutput.length).to.eq(0); + + + registry = new PluginRegistry(project, mockUi, { + pipeline: { + alias: { + baz: { as: ['aaa', 'bbb'] }, + }, + disabled: { + allExcept: 'aaa', + foo: false, + }, + }, + }); + + plugins = registry.pluginInstances(); + + expect(plugins.length).to.equal(2); + expect(plugins[0].name).to.equal('foo'); + expect(plugins[1].name).to.equal('aaa'); + expect(logOutput.length).to.eq(0); + }); + + it('warns if disabled config references an addon that is not installed', function() { + var project = makeProject(['foo']); + + var registry = new PluginRegistry(project, mockUi, { + pipeline: { + disabled: { + allExcept: ['xxx', 'bbb'], + bar: true, + foo: false, + }, + }, + }); + + registry.pluginInstances(); + + expect(logOutput.length).to.eq(4); + expect(logOutput[0]).to.eq('Your config has referenced the following unknown plugins or aliases in `config.pipeline.disabled`:'); + expect(logOutput[1]).to.eq('- bar'); + expect(logOutput[2]).to.eq('- xxx'); + expect(logOutput[3]).to.eq('- bbb'); + }); + }); + + describe('specifying plugin run order', function() { + it('warns if runOrder config references an addon that is not installed', function() { + var project = makeProject(['foo']); + + var registry = new PluginRegistry(project, mockUi, { + pipeline: { + runOrder: { + baz: { before: ['foo'] }, + foo: { after: 'xxx' }, + }, + }, + }); + + registry.pluginInstances(); + + expect(logOutput.length).to.eq(3); + expect(logOutput[0]).to.eq('Your config has referenced the following unknown plugins or aliases in `config.pipeline.runOrder`:'); + expect(logOutput[1]).to.eq('- baz'); + expect(logOutput[2]).to.eq('- xxx'); + }); + + it('returns plugins ordered by config specified run before', function() { + var project = makeProject(['foo', 'bar']); + + testOrder(project, { + pipeline: { + runOrder: { + bar: { before: 'foo' }, + }, + }, + }, ['bar', 'foo']); + + testOrder(project, { + pipeline: { + runOrder: { + foo: { before: 'bar' }, + }, + }, + }, ['foo', 'bar']); + + testOrder(project, { + pipeline: { + alias: { + bar: { as: ['bar', 'baz'] }, + }, + runOrder: { + bar: { before: 'foo' }, + baz: { before: 'bar' }, + }, + }, + }, ['baz', 'bar', 'foo']); + }); + + it('returns plugins ordered by config specified run after', function() { + var project = makeProject(['foo', 'bar']); + + testOrder(project, { + pipeline: { + runOrder: { + bar: { after: 'foo' }, + }, + }, + }, ['foo', 'bar']); + + testOrder(project, { + pipeline: { + runOrder: { + foo: { after: 'bar' }, + }, + }, + }, ['bar', 'foo']); + + testOrder(project, { + pipeline: { + alias: { + bar: { as: ['bar', 'baz'] }, + }, + runOrder: { + bar: { after: 'foo' }, + baz: { after: 'bar' }, + }, + }, + }, ['foo', 'bar', 'baz']); + }); + + it('returns plugins ordered by multiple config specified run order constraints', function() { + var project = makeProject(['foo', 'bar', 'baz']); + + testOrder(project, { + pipeline: { + runOrder: { + foo: { after: ['bar', 'baz'] }, + baz: { after: ['bar'] }, + }, + }, + }, ['bar', 'baz', 'foo']); + + testOrder(project, { + pipeline: { + runOrder: { + bar: { after: ['foo', 'baz'] }, + baz: { after: ['foo'] }, + }, + }, + }, ['foo', 'baz', 'bar']); + }); + + it('returns plugins ordered by author specified run order', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', {}), + makePlugin('bar', { runAfter: ['foo'] }), + makePlugin('baz', { runBefore: ['foo'] }) + ] + }; + + testOrder(project, {}, ['baz', 'foo', 'bar']); + }); + + it('returns plugins ordered by merged config and author provided run order', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', {}), + makePlugin('bar', { runAfter: ['foo'] }), + makePlugin('baz', { }) + ] + }; + + testOrder(project, { + pipeline: { + runOrder: { + baz: { before: ['foo'] }, + }, + }, + }, ['baz', 'foo', 'bar']); + + testOrder(project, { + pipeline: { + runOrder: { + baz: { after: ['foo', 'bar'] }, + }, + }, + }, ['foo', 'bar', 'baz']); + + project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', {}), + makePlugin('bar', { runBefore: ['foo'] }), + makePlugin('baz', { }) + ] + }; + + testOrder(project, { + pipeline: { + runOrder: { + baz: { before: ['foo', 'bar'] }, + }, + }, + }, ['baz', 'bar', 'foo']); + + testOrder(project, { + pipeline: { + runOrder: { + baz: { after: ['foo'] }, + }, + }, + }, ['bar', 'foo', 'baz']); + + project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', { runAfter: ['bar'] }), + makePlugin('bar', {}), + makePlugin('baz', {}) + ] + }; + + testOrder(project, { + pipeline: { + runOrder: { + foo: { after: 'baz' }, + }, + }, + }, ['bar', 'baz', 'foo']); + }); + + it('respects aliases when ordering plugins by author provided run order', function() { + var project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', { runAfter: ['bar'] }), + makePlugin('bar', {}), + makePlugin('baz', {}), + makePlugin('bop', {}), + ] + }; + + testOrder(project, { + pipeline: { + alias: { + bar: { as: ['boo', 'bee'] }, + }, + }, + }, ['boo', 'bee', 'foo', 'baz', 'bop']); + + testOrder(project, { + pipeline: { + alias: { + bar: { as: ['bar', 'boo'] }, + }, + }, + }, ['bar', 'boo', 'foo', 'baz', 'bop']); + + testOrder(project, { + pipeline: { + alias: { + bar: { as: ['bar', 'boo'] }, + }, + runOrder: { + foo: { after: 'bop', before: 'baz' }, + }, + }, + }, ['bar', 'boo', 'bop', 'foo', 'baz']); + + project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', {}), + makePlugin('bar', {}), + makePlugin('baz', { runBefore: ['foo'] }), + makePlugin('bop', {}), + ] + }; + + testOrder(project, { + pipeline: { + alias: { + foo: { as: ['boo', 'bee'] }, + }, + }, + }, ['baz', 'boo', 'bee', 'bar', 'bop']); + + testOrder(project, { + pipeline: { + alias: { + foo: { as: ['foo', 'boo'] }, + }, + }, + }, ['baz', 'foo', 'boo', 'bar', 'bop']); + + testOrder(project, { + pipeline: { + alias: { + foo: { as: ['foo', 'boo'] }, + }, + runOrder: { + baz: { after: 'bop', before: 'bar' }, + }, + }, + }, ['bop', 'baz', 'foo', 'boo', 'bar']); + }); + + it('detects circular dependencies', function() { + var project = makeProject(['foo', 'bar', 'baz']); + + expect(function() { + testOrder(project, { + pipeline: { + runOrder: { + foo: { after: ['bar'] }, + bar: { after: ['baz'] }, + baz: { after: ['foo'] }, + }, + }, + }); + }).to.throw(/your ember-cli-deploy plugins have a circular dependency.*baz.*foo.*bar.*baz/); + + project = { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: [ + makePlugin('foo', { runAfter: ['bar'] }), + makePlugin('bar', {}), + makePlugin('baz', {}) + ] + }; + + expect(function() { + testOrder(project, { + pipeline: { + runOrder: { + foo: { before: 'bar' }, + }, + }, + }); + }).to.throw(/your ember-cli-deploy plugins have a circular dependency:cycle detected: foo <- bar <- foo/); + }); + }); +}); + +function makeProject(addonNames) { + return { + name: function() {return 'test-project';}, + root: process.cwd(), + addons: addonNames.map(function(name){ + return makePlugin(name); + }) + }; +} + +function makeAddon(name) { + return { + name: 'ember-cli-deploy-' + name, + pkg: { keywords: [ ] }, + }; +} + +function makePlugin(name, props) { + return { + name: 'ember-cli-deploy-' + name, + pkg: { + keywords: [ + 'ember-cli-deploy-plugin' + ] + }, + createDeployPlugin: function(options) { + var plugin = Object.create({ + name: options.name, + willDeploy: function() {}, + upload: function() {} + }); + if (props) { + Object.keys(props).forEach(function(key) { plugin[key] = props[key]; }); + } + return plugin; + } + }; +} + +function makePluginPack(name, plugins) { + return { + name: 'ember-cli-deploy-' + name, + pkg: { + keywords: [ + 'ember-cli-deploy-plugin-pack' + ] + }, + addons: plugins, + }; +} + +function testOrder(project, config, expectedNames) { + var registry = new PluginRegistry(project, mockUi, config); + var plugins = registry.pluginInstances(); + expect(plugins.map(function(plugin){ return plugin.name; })).to.deep.equal(expectedNames); +} diff --git a/node-tests/unit/tasks/pipeline-test.js b/node-tests/unit/tasks/pipeline-test.js index 675fe7de..f7721c0b 100644 --- a/node-tests/unit/tasks/pipeline-test.js +++ b/node-tests/unit/tasks/pipeline-test.js @@ -11,7 +11,7 @@ describe('PipelineTask', function() { mockUi = { write: function() {}, writeError: function() {} }; }); - describe('creating and setting up a new instance', function() { + describe('creating a new instance', function() { it ('raises an error if project is not provided', function() { var fn = function() { new PipelineTask({}); @@ -54,372 +54,96 @@ describe('PipelineTask', function() { expect(fn).to.throw('No config passed to pipeline task'); }); + }); + describe('setting up a new instance', function() { describe('registering addons with the pipeline', function() { it('registers addons with ember-cli-deploy-plugin keyword', function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'test-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: mockConfig, - hooks: ['willDeploy', 'upload'] - }); - task.setup(); - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload[0].name).to.eq('test-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); - }); - - it('does not register addons missing the ember-cli-deploy-plugin keyword', function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'some-other-plugin' - ] - }, - createDeployPlugin: function() { - return { - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: mockConfig, - hooks: ['willDeploy', 'upload'] - }); - - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy[0]).to.be.undefined; - }); - - it('does not register addons that don\'t implement the createDeployPlugin function', function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ ] - }, - someOtherFunction: function() { - return { - willDeploy: function() {} - }; - } - } - ] - }; - var task = new PipelineTask({ - project: project, + project: mockProject, ui: mockUi, deployTarget: 'development', config: mockConfig, hooks: ['willDeploy', 'upload'] }); - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy[0]).to.be.undefined; - }); - - it('registers configured addons only, if addons configuration is present', function () { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'foo-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - }, - { - name: 'ember-cli-deploy-bar-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'bar-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] + task._pluginInstances = function() { + return [{ + name: 'test-plugin', + willDeploy: function() {}, + upload: function() {}, + }]; }; - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: { plugins: ['foo-plugin'] }, - hooks: ['willDeploy', 'upload'] - }); task.setup(); var registeredHooks = task._pipeline._pipelineHooks; - expect(registeredHooks.willDeploy.length).to.equal(1); - expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); + expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload.length).to.equal(1); - expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); + expect(registeredHooks.upload[0].name).to.eq('test-plugin'); expect(registeredHooks.upload[0].fn).to.be.a('function'); }); describe('requiredHooks', function() { it('validates that required hooks are implemented', function () { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'foo-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - }; - var task = new PipelineTask({ - project: project, + project: mockProject, ui: mockUi, deployTarget: 'development', - config: { plugins: ['foo-plugin'] }, + config: mockConfig, hooks: ['willDeploy', 'upload'], - requiredHooks: ['willDeploy'] + requiredHooks: ['willDeploy'], + _pluginInstances: function() { + return [{ + name: 'test-plugin', + upload: function() {}, + willDeploy: function() {}, + }]; + } }); + var fn = function() { task.setup(); }; + expect(fn).to.not.throw(/not implemented by any registered plugin/); }); it('throws if required hooks are not implemented', function () { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'foo-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - }; - var task = new PipelineTask({ - project: project, + project: mockProject, ui: mockUi, deployTarget: 'development', - config: { plugins: ['foo-plugin'] }, + config: mockConfig, hooks: ['willDeploy', 'upload', 'fetchRevisions'], requiredHooks: ['fetchRevisions'] }); + + task._pluginInstances = function() { + return [{ + name: 'test-plugin', + upload: function() {}, + willDeploy: function() {}, + }]; + }; + var fn = function() { task.setup(); }; - expect(fn).to.throw('fetchRevisions not implemented by any registered plugin'); - }); - }); - - it('registers configured addons only, when using per-plugin disable flags', function () { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'foo-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - }, - { - name: 'ember-cli-deploy-bar-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'bar-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: { - 'bar-plugin': { - disabled: true - } - }, - hooks: ['willDeploy', 'upload'] - }); - task.setup(); - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy.length).to.equal(1); - expect(registeredHooks.willDeploy[0].name).to.eq('foo-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload.length).to.equal(1); - expect(registeredHooks.upload[0].name).to.eq('foo-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); - }); - - it('registers dependent plugin addons of a plugin pack addon designated by the ember-cli-deploy-plugin-pack keyword', function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-test-plugin-pack', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin-pack' - ] - }, - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'test-plugin', - willDeploy: function() {}, - upload: function() {} - }; - } - } - ] - } - ] - }; - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: mockConfig, - hooks: ['willDeploy', 'upload'] + expect(fn).to.throw('fetchRevisions not implemented by any registered plugin'); }); - task.setup(); - var registeredHooks = task._pipeline._pipelineHooks; - - expect(registeredHooks.willDeploy.length).to.eq(1); - expect(registeredHooks.willDeploy[0].name).to.eq('test-plugin'); - expect(registeredHooks.willDeploy[0].fn).to.be.a('function'); - expect(registeredHooks.upload.length).to.eq(1); - expect(registeredHooks.upload[0].name).to.eq('test-plugin'); - expect(registeredHooks.upload[0].fn).to.be.a('function'); }); }); }); describe('executing the pipeline task', function() { - it ('executes the pipeline, passing in the deployment context', function() { + it('executes the pipeline, passing in the deployment context', function() { var pipelineExecuted = false; var pipelineContext; - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ ] - }; - var task = new PipelineTask({ - project: project, + project: mockProject, ui: mockUi, deployTarget: 'development', config: { build: { environment: 'development' }}, @@ -431,14 +155,17 @@ describe('PipelineTask', function() { pipelineContext = context; return Promise.resolve(); } - } + }, + _pluginInstances: function() { + return []; + }, }); return expect(task.run()).to.be.fulfilled .then(function() { expect(pipelineExecuted).to.be.true; expect(pipelineContext.ui).to.eq(mockUi); - expect(pipelineContext.project).to.eq(project); + expect(pipelineContext.project).to.eq(mockProject); expect(pipelineContext.deployTarget).to.eq('development'); expect(pipelineContext.config.build.environment).to.eq('development'); expect(pipelineContext.commandOptions.revision).to.eq('123abc'); @@ -446,41 +173,19 @@ describe('PipelineTask', function() { }); it('executes the pipeline, logging at a verbose level', function() { - var logOutput = ""; + var logOutput = ''; mockUi = { verbose: true, write: function(s) { logOutput = logOutput + s; }, writeError: function(s) { - logOutput = logOutput + s + "\n"; + logOutput = logOutput + s + '\n'; } }; - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-test-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - return { - name: 'test-plugin', - willDeploy: function() { - }, - upload: function() {} - }; - } - } - ] - }; var task = new PipelineTask({ - project: project, + project: mockProject, ui: mockUi, deployTarget: 'development', config: mockConfig, @@ -488,319 +193,41 @@ describe('PipelineTask', function() { hooks: ['willDeploy', 'upload'], pipeline: new Pipeline(['willDeploy', 'upload'], { ui: mockUi - }) - }); - - task.setup(); - return expect(task.run()).to.be.fulfilled.then(function() { - var logLines = logOutput.split("\n"); - expect(logLines[ 0]).to.eq("\u001b[34mRegistering hook -> willDeploy[test-plugin]"); - expect(logLines[ 1]).to.eq("\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]"); - expect(logLines[ 2]).to.eq("\u001b[39m\u001b[34mRegistering hook -> willDeploy[test-plugin]"); - expect(logLines[ 3]).to.eq("\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]"); - expect(logLines[ 4]).to.eq("\u001b[39m\u001b[34mExecuting pipeline"); - expect(logLines[ 5]).to.eq("\u001b[39m\u001b[34m|"); - expect(logLines[ 6]).to.eq("\u001b[39m\u001b[34m+- willDeploy"); - expect(logLines[ 7]).to.eq("\u001b[39m\u001b[34m| |"); - expect(logLines[ 8]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); - expect(logLines[ 9]).to.eq("\u001b[39m\u001b[34m| |"); - expect(logLines[10]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); - expect(logLines[11]).to.eq("\u001b[39m\u001b[34m|"); - expect(logLines[12]).to.eq("\u001b[39m\u001b[34m+- upload"); - expect(logLines[13]).to.eq("\u001b[39m\u001b[34m| |"); - expect(logLines[14]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); - expect(logLines[15]).to.eq("\u001b[39m\u001b[34m| |"); - expect(logLines[16]).to.eq("\u001b[39m\u001b[34m| +- test-plugin"); - expect(logLines[17]).to.eq("\u001b[39m\u001b[34m|"); - expect(logLines[18]).to.eq("\u001b[39m\u001b[34mPipeline complete"); - }); - }); - }); - - describe('plugin aliases are correctly handled', function() { - it('passes correct name to single plugin alias', function () { - var correctAliasUsed = false; - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] + }), + _pluginInstances: function() { + return [{ + name: 'test-plugin', + willDeploy: function() { }, - createDeployPlugin: function(options) { - correctAliasUsed = (options.name === 'bar-alias'); - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'staging', - config: { plugins: ['foo-plugin:bar-alias'] }, - pipeline: { - hookNames: function () { - return []; - } - } - }); - - task.setup(); - expect(correctAliasUsed).to.be.true; - }); - - it('passes correct name to multiple instances of the same plugin', function () { - var correctAliasUsed = { - 'foo-plugin': false, // plugin without alias - 'bar-alias': false, // first alias - 'doo-alias': false // second alias - }; - - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - { - name: 'ember-cli-deploy-foo-plugin', - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function(options) { - correctAliasUsed[options.name] = true; - } - } - ] - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'staging', - config: { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }, - pipeline: { - hookNames: function () { - return []; - } - } + upload: function() {} + }]; + }, }); task.setup(); - expect(correctAliasUsed['foo-plugin']).to.be.true; - expect(correctAliasUsed['bar-alias']).to.be.true; - expect(correctAliasUsed['doo-alias']).to.be.true; - }); - - it('throws error on non-existent plugin in whitelist and appends them to err.unavailablePlugins', function () { - var project = { - name: function() {return 'test-project';}, - root: process.cwd() - }; - - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'production', - config: { plugins: ['foo-plugin', 'foo-plugin:bar-alias', 'foo-plugin:doo-alias'] }, - deployConfigFile: 'node-tests/fixtures/config/deploy-for-addons-config-test-with-aliases.js', - }); - - try { - task.setup(); - expect(false).to.be.true; - } catch(err) { - expect(Object.keys(err.unavailablePlugins).length).to.equal(3); - } - }); - }); - - describe("plugin ordering constraints", function() { - - function makeProject(addonNames) { - return { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: addonNames.map(function(name){ - return makeAddon(name); - }) - }; - } - - function makeAddon(name, props) { - return { - name: 'ember-cli-deploy-' + name, - pkg: { - keywords: [ - 'ember-cli-deploy-plugin' - ] - }, - createDeployPlugin: function() { - var plugin = Object.create({ - name: name, - willDeploy: function() {}, - upload: function() {} - }); - if (props) { - Object.keys(props).forEach(function(key) { plugin[key] = props[key]; }); - } - return plugin; - } - }; - } - function testOrder(project, config, expectedNames) { - var task = new PipelineTask({ - project: project, - ui: mockUi, - deployTarget: 'development', - config: config, - hooks: ['willDeploy', 'upload'] + return expect(task.run()).to.be.fulfilled.then(function() { + var logLines = logOutput.split('\n'); + expect(logLines[ 0]).to.eq('\u001b[34mRegistering hook -> willDeploy[test-plugin]'); + expect(logLines[ 1]).to.eq('\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]'); + expect(logLines[ 2]).to.eq('\u001b[39m\u001b[34mRegistering hook -> willDeploy[test-plugin]'); + expect(logLines[ 3]).to.eq('\u001b[39m\u001b[34mRegistering hook -> upload[test-plugin]'); + expect(logLines[ 4]).to.eq('\u001b[39m\u001b[34mExecuting pipeline'); + expect(logLines[ 5]).to.eq('\u001b[39m\u001b[34m|'); + expect(logLines[ 6]).to.eq('\u001b[39m\u001b[34m+- willDeploy'); + expect(logLines[ 7]).to.eq('\u001b[39m\u001b[34m| |'); + expect(logLines[ 8]).to.eq('\u001b[39m\u001b[34m| +- test-plugin'); + expect(logLines[ 9]).to.eq('\u001b[39m\u001b[34m| |'); + expect(logLines[10]).to.eq('\u001b[39m\u001b[34m| +- test-plugin'); + expect(logLines[11]).to.eq('\u001b[39m\u001b[34m|'); + expect(logLines[12]).to.eq('\u001b[39m\u001b[34m+- upload'); + expect(logLines[13]).to.eq('\u001b[39m\u001b[34m| |'); + expect(logLines[14]).to.eq('\u001b[39m\u001b[34m| +- test-plugin'); + expect(logLines[15]).to.eq('\u001b[39m\u001b[34m| |'); + expect(logLines[16]).to.eq('\u001b[39m\u001b[34m| +- test-plugin'); + expect(logLines[17]).to.eq('\u001b[39m\u001b[34m|'); + expect(logLines[18]).to.eq('\u001b[39m\u001b[34mPipeline complete'); }); - task.setup(); - var registeredHooks = task._pipeline._pipelineHooks; - expect(registeredHooks.willDeploy.map(function(elt){ return elt.name; })).to.deep.equal(expectedNames); - } - - it("respects runBefore", function() { - var project = makeProject(['foo-plugin', 'bar-plugin']); - testOrder(project, { - 'bar-plugin': { - runBefore: ['foo-plugin'] - } - }, ['bar-plugin', 'foo-plugin']); - testOrder(project, { - 'foo-plugin': { - runBefore: ['bar-plugin'] - } - }, ['foo-plugin', 'bar-plugin']); - }); - - it("respects runAfter", function() { - var project = makeProject(['foo-plugin', 'bar-plugin']); - testOrder(project, { - 'bar-plugin': { - runAfter: ['foo-plugin'] - } - }, ['foo-plugin', 'bar-plugin']); - testOrder(project, { - 'foo-plugin': { - runAfter: ['bar-plugin'] - } - }, ['bar-plugin', 'foo-plugin']); - }); - - it("respects multiple constraints", function() { - var project = makeProject(['foo', 'bar', 'baz']); - - testOrder(project, { - foo: { - runAfter: ['bar', 'baz'] - }, - baz: { - runAfter: ['bar'] - } - }, ['bar', 'baz', 'foo']); - - testOrder(project, { - bar: { - runAfter: ['foo', 'baz'] - }, - baz: { - runAfter: ['foo'] - } - }, ['foo', 'baz', 'bar']); - - }); - - it("respects author-provided constraints", function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - makeAddon('foo', {}), - makeAddon('bar', { runAfter: ['foo'] }), - makeAddon('baz', { runBefore: ['foo'] }) - ] - }; - - testOrder(project, {}, ['baz', 'foo', 'bar']); - }); - - - it("merges author-provided and user-provided constraints", function() { - var project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - makeAddon('foo', {}), - makeAddon('bar', { runAfter: ['foo'] }), - makeAddon('baz', { }) - ] - }; - - testOrder(project, { - baz: { - runBefore: ['foo'] - } - }, ['baz', 'foo', 'bar']); - - testOrder(project, { - baz: { - runAfter: ['foo', 'bar'] - } - }, ['foo', 'bar', 'baz']); - - project = { - name: function() {return 'test-project';}, - root: process.cwd(), - addons: [ - makeAddon('foo', {}), - makeAddon('bar', { runBefore: ['foo'] }), - makeAddon('baz', { }) - ] - }; - - testOrder(project, { - baz: { - runBefore: ['foo', 'bar'] - } - }, ['baz', 'bar', 'foo']); - - testOrder(project, { - baz: { - runAfter: ['foo'] - } - }, ['bar', 'foo', 'baz']); - - - }); - - - it("detects cycles", function() { - var project = makeProject(['foo', 'bar', 'baz']); - - expect(function() { - testOrder(project, { - foo: { - runAfter: ['bar'] - }, - bar: { - runAfter: ['baz'] - }, - baz: { - runAfter: ['foo'] - } - }); - }).to.throw(/your ember-cli-deploy plugins have a circular dependency.*baz.*foo.*bar.*baz/); - - }); - }); }); diff --git a/package.json b/package.json index b7a77089..fd74abae 100644 --- a/package.json +++ b/package.json @@ -48,9 +48,9 @@ "broccoli": "^0.13.2", "broccoli-gzip": "^0.2.0", "chalk": "^0.5.1", - "core-object": "0.0.2", - "ember-cli-babel": "^5.1.3", + "core-object": "2.0.1", "dotenv": "^1.1.0", + "ember-cli-babel": "^5.1.3", "glob": "4.4.2", "lodash": "^4.0.0", "mkdirp": "^0.5.0", From 027bf9ff2462ceed00e733d6481d983d4f95018d Mon Sep 17 00:00:00 2001 From: Mattia Gheda Date: Mon, 11 Jul 2016 15:17:02 +0100 Subject: [PATCH 224/300] Released v1.0.0-beta.1 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index fd74abae..226c52ac 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "ember-cli-deploy", "description": "A deployment pipeline for ember-cli apps", - "version": "0.6.4", + "version": "1.0.0-beta.1", "directories": { "doc": "doc", "test": "tests" From 3b1a265470d633d25846f16adb5d3f26abb8d054 Mon Sep 17 00:00:00 2001 From: Dave Wasmer Date: Mon, 29 Aug 2016 14:17:01 -0600 Subject: [PATCH 225/300] Remove extraneous `something` config value --- config/environment.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/environment.js b/config/environment.js index c9faa7e3..dc85cac8 100644 --- a/config/environment.js +++ b/config/environment.js @@ -1,5 +1,5 @@ 'use strict'; module.exports = function(/* environment */) { - return { something: 'test' }; + return {}; }; From 69b3b91cc93b9b3d7b4bf4be15027b5a39deee29 Mon Sep 17 00:00:00 2001 From: Sarup Banskota

Shorthand	{{ include.shorthand }}
Expanded	{{ include.expanded }}

Welcome to Ember.js

Welcome to Ember.js

Welcome to Ember.js

404: Page not found

{{page.page_header}}

{{ page.title }}

Simple, flexible deployment for your app

A Deployment Pipeline

Plugins for Every Task

One-Line Deploys