[WIP] Restructure to support plugin base class

Author: lukemelia

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',

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};

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,

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;
-    }
   }
 });
 

lib/utilities/pipeline.js

@@ -75,6 +75,7 @@ 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.stack));
   return this._executeHook.bind(this, 'didFail')(context)
     .then(Promise.reject.bind(this, error));
 };

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",

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');
     });
   });
 

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');
         });
     });
   });

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: