Merge lp:~bcsaller/juju-gui/deployer-export into lp:juju-gui/experimental

[Benjamin Saller]

Exports in Deployer format.

Switch default hotkey export to YAML based deployer format. It we don't import
this format yet.

https://codereview.appspot.com/10563043/

[Benjamin Saller (bcsaller)]

Reviewers: mp+171402_code.launchpad.net,

Message:
Please take a look.

Description:
Exports in Deployer format.

Switch default hotkey export to YAML based deployer format. It we don't
import
this format yet.

https://code.launchpad.net/~bcsaller/juju-gui/deployer-export/+merge/171402

(do not edit description out of merge proposal)

Please review this at https://codereview.appspot.com/10563043/

Affected files:
   A [revision details]
   M app/app.js
   M app/models/models.js
   M app/store/env/fakebackend.js
   M app/views/topology/importexport.js
   M test/test_fakebackend.js
   M test/test_model.js

[Jeff Pihach (hatch)]

LGTM !

https://codereview.appspot.com/10563043/diff/1/app/views/topology/importexport.js
File app/views/topology/importexport.js (right):

https://codereview.appspot.com/10563043/diff/1/app/views/topology/importexport.js#newcode112
app/views/topology/importexport.js:112: var self = this;
unused

https://codereview.appspot.com/10563043/

[Benjamin Saller (bcsaller)]

Thanks for the reviews. Made most of the minor updates indicated. Will
submit soon.

https://codereview.appspot.com/10563043/diff/1/app/app.js
File app/app.js (right):

https://codereview.appspot.com/10563043/diff/1/app/app.js#newcode239
app/app.js:239: var result = this.db.exportDeployer();
On 2013/06/25 20:37:03, benji wrote:
> A small thought: "exportDeployer" (despite it's lack of capitalization
and
> having no "new") read like a constructor to me. Perhaps a more
"verby" name
> would be an improvement. Maybe just "export" since we have only one
export
> format (right?).

export is a reserved word in JS and makes linters unhappy. This does
return an object but its not really a constuctor as that objects
prototype is the default.

https://codereview.appspot.com/10563043/diff/1/app/models/models.js
File app/models/models.js (right):

https://codereview.appspot.com/10563043/diff/1/app/models/models.js#newcode183
app/models/models.js:183: }
On 2013/06/25 20:37:03, benji wrote:
> It looks like an empty string would work as well as undefined, so
lines 179-182
> could be replaced with just "return result.join(',');".

It would but I would rather not return a string if we don't expect to
parse it (comma delimited). If you don't feel strongly I'll leave this
for now.

https://codereview.appspot.com/10563043/diff/1/app/models/models.js#newcode849
app/models/models.js:849: * @param {Object} db for application.
On 2013/06/25 20:37:03, benji wrote:
> This was probably left from an earlier iteration.

Nice catch and exactly right.

https://codereview.appspot.com/10563043/diff/1/app/models/models.js#newcode857
app/models/models.js:857: envExport: {
On 2013/06/25 20:37:03, benji wrote:
> It seems to me that we don't need the "envExport" layer in here.

The deployer format labels each section within the YAML. For example
this might be 'blog' and there could be another block called
'productionBlog' which inherits blog and so on. We don't deal with
inheritance as we don't retain any of the initial structure (and in fact
don't import these things at all yet).

This is provided as a default name to match the format.

https://codereview.appspot.com/10563043/diff/1/app/models/models.js#newcode874
app/models/models.js:874: num_units: units && units.size() || 1
On 2013/06/25 20:37:03, benji wrote:
> A comment about the circumstances in which s.units is not defined
might be nice.

Testing or ghosts. 'units' is created on the delta event under each
service now automatically. Added to code as well.

https://codereview.appspot.com/10563043/diff/1/app/models/models.js#newcode884
app/models/models.js:884: relationList.each(function(r) {
On 2013/06/25 20:37:03, benji wrote:
> Single character variable names... have you been working on juju-core?
  I kid, I
> kid. It might be nice to make that "relation" and the "s" above
"service",
> though.

Done.

https://codereview.appspot.com/10563043/diff/1/app/views/topology/importexport.js
File app/views/topology/importexport.js (right):

https://codereview.appspot.com/10563043/diff/1/app/views/topology/importexport.js#newcode112
app/views/topology/importexport.js:112: var self = this;
On 2013/06/25 20:08:12, jeff.pihach wrote...

[Benjamin Saller (bcsaller)]

*** Submitted:

Exports in Deployer format.

Switch default hotkey export to YAML based deployer format. It we don't
import
this format yet.

R=jeff.pihach, benji, benjamin.saller
CC=
https://codereview.appspot.com/10563043

https://codereview.appspot.com/10563043/

=== modified file 'app/app.js'
--- app/app.js	2013-06-25 14:31:16 +0000
+++ app/app.js	2013-06-25 19:48:30 +0000
@@ -235,12 +235,12 @@
 
       'S-d': {
         callback: function(evt) {
-          this.env.exportEnvironment(function(r) {
-            var exportData = JSON.stringify(r.result, undefined, 2);
-            var exportBlob = new Blob([exportData],
-                                      {type: 'application/json;charset=utf-8'});
-            saveAs(exportBlob, 'export.json');
-          });
+          var yaml;
+          var result = this.db.exportDeployer();
+          var exportData = jsyaml.dump(result);
+          var exportBlob = new Blob([exportData],
+                                    {type: 'application/yaml;charset=utf-8'});
+          saveAs(exportBlob, 'export.yaml');
         },
         help: 'Export the environment'
       },
@@ -502,6 +502,7 @@
       this.env.after('providerTypeChange', this.onProviderTypeChange, this);
       this.env.after('environmentNameChange',
           this.onEnvironmentNameChange, this);
+      this.env.after('defaultSeriesChange', this.onDefaultSeriesChange, this);
 
       // Once the user logs in, we need to redraw.
       this.env.after('login', this.onLogin, this);
@@ -1072,6 +1073,20 @@
     },
 
     /**
+     * Record environment default series changes in our model.
+     *
+     * The provider type arrives asynchronously.  Instead of updating the
+     * display from the environment code (a separation of concerns violation),
+     * we update it here.
+     *
+     * @method onDefaultSeriesChange
+     */
+    onDefaultSeriesChange: function(evt) {
+      this.db.environment.set('defaultSeries', evt.newVal);
+    },
+
+
+    /**
       Display the Environment Name.
 
       The environment name can arrive asynchronously.  Instead of updating

=== modified file 'app/models/models.js'
--- app/models/models.js	2013-06-24 19:43:15 +0000
+++ app/models/models.js	2013-06-25 19:48:30 +0000
@@ -105,6 +105,7 @@
     ATTRS: {
       name: {},
       provider: {},
+      defaultSeries: {},
       annotations: {
         valueFn: function() {return {};}
       }
@@ -169,6 +170,18 @@
       // to help support scale.
       annotations: {value: {}},
       constraints: {},
+      constraintsStr: {
+        'getter': function() {
+          var result = [];
+          Y.each(this.get('constraints'), function(v, k) {
+            result.push(k + '=' + v);
+          });
+          if (result.length) {
+            return result.join(',');
+          }
+          return undefined;
+        }
+      },
       exposed: {
         value: false
       },
@@ -825,12 +838,65 @@
         self.units.update_service_unit_aggregates(service);
       });
       this.fire('update');
+    },
+
+    /**
+     * Export deployer formatted dump of the current environment.
+     * Note: When we have a selection UI in place this should honor
+     * that.
+     *
+     * @method exportDeployer
+     * @param {Object} db for application.
+     * @return {Object} export object suitable for serialization.
+     */
+    exportDeployer: function() {
+      var self = this,
+          serviceList = this.services,
+          relationList = this.relations,
+          result = {
+            envExport: {
+              series: this.environment.get('defaultSeries'),
+              services: [],
+              relations: []
+            }
+          };
+
+      serviceList.each(function(s) {
+        var units = s.units;
+        var charm = self.charms.getById(s.get('charm'));
+        if (s.get('pending') === true) {return;}
+        var serviceData = {
+          // Using package name here so the default series
+          // is picked up. This will likely have to be the full
+          // path in the future.
+          charm: charm.get('package_name'),
+          options: s.get('config'),
+          num_units: units && units.size() || 1
+        };
+        // Add constraints
+        var constraints = s.get('constraintsStr');
+        if (constraints) {
+          serviceData.constraints = constraints;
+        }
+        result.envExport.services.push(serviceData);
+      });
+
+      relationList.each(function(r) {
+        var relationData = [];
+        Y.each(r.get('endpoints'), function(data, name) {
+          relationData.push([data[0], data[1].name]);
+        });
+        // Skip peer, they should add automatically.
+        if (relationData.length === 1) {
+          return;
+        }
+        result.envExport.relations.push(relationData);
+      });
+
+      return result;
     }
-
   });
-
   models.Database = Database;
-
 }, '0.1.0', {
   requires: [
     'model',

=== modified file 'app/store/env/fakebackend.js'
--- app/store/env/fakebackend.js	2013-06-25 12:57:53 +0000
+++ app/store/env/fakebackend.js	2013-06-25 19:48:30 +0000
@@ -1211,7 +1211,7 @@
           services: [], relations: []},
           blackLists = {
             service: ['id', 'aggregated_status', 'clientId', 'initialized',
-              'destroyed', 'pending'],
+              'constraintsStr', 'destroyed', 'pending'],
             relation: ['id', 'relation_id', 'clientId', 'initialized',
               'destroyed', 'pending']
           };

=== modified file 'app/views/topology/importexport.js'
--- app/views/topology/importexport.js	2013-06-05 16:58:11 +0000
+++ app/views/topology/importexport.js	2013-06-25 19:48:30 +0000
@@ -109,6 +109,7 @@
          * @method update
          */
         update: function() {
+          var self = this;
           // Check the feature flag
           if (!this._dragHandle && window.flags.dndexport) {
             var env = this.get('component').get('env');

=== modified file 'test/test_fakebackend.js'
--- test/test_fakebackend.js	2013-06-25 12:57:53 +0000
+++ test/test_fakebackend.js	2013-06-25 19:48:30 +0000
@@ -114,6 +114,7 @@
         charm: 'cs:precise/wordpress-10',
         config: undefined,
         constraints: {},
+        constraintsStr: undefined,
         destroyed: false,
         displayName: 'wordpress',
         exposed: false,

=== modified file 'test/test_model.js'
--- test/test_model.js	2013-06-25 15:44:15 +0000
+++ test/test_model.js	2013-06-25 19:48:30 +0000
@@ -773,6 +773,44 @@
   });
 });
 
+describe('database export', function() {
+  var models;
+  before(function(done) {
+    YUI(GlobalConfig).use(['juju-models'], function(Y) {
+      models = Y.namespace('juju.models');
+      done();
+    });
+  });
+
+  it('can export in deployer format', function() {
+    var db = new models.Database();
+    var mysql = db.services.add({id: 'mysql', charm: 'precise/mysql-1'});
+    var wordpress = db.services.add({
+      id: 'wordpress',
+      charm: 'precise/wordpress-1'});
+    var rel0 = db.relations.add({
+      id: 'relation-0',
+      endpoints: [
+        ['mysql', {name: 'db', role: 'server'}],
+        ['wordpress', {name: 'app', role: 'client'}]],
+      'interface': 'db'
+    });
+
+    db.environment.set('defaultSeries', 'precise');
+
+    // Add the charms so we can resolve them in the export.
+    db.charms.add([{id: 'precise/mysql-1'}, {id: 'precise/wordpress-1'}]);
+    var result = db.exportDeployer().envExport;
+    var relation = result.relations[0];
+
+    assert.equal(result.series, 'precise');
+    assert.equal(result.services[0].charm, 'mysql');
+    assert.equal(result.services[1].charm, 'wordpress');
+
+    assert.deepEqual(relation[0], ['mysql', 'db']);
+    assert.deepEqual(relation[1], ['wordpress', 'app']);
+  });
+});
 
 describe('service models', function() {
   var models, list, django, rails, wordpress, mysql;