Merge pull request #2 from achambers/set-current-version

Now we can set a specific release version to be the current one

Author: achambers

README.md

@@ -56,6 +56,12 @@ Secondly, the function will keep track of the versions of `data` that have been
 
 Finally, this function will trim the list of uploaded versions to a limit defined by `versionCount`.
 
+### \#setCurrent(key)
+
+This function will set a key called `appId:current` to be the version key specified.  This will only happen if the version key specified is a valid version that has previously been uploaded.
+
+The server that serves the index.html from Redis should look for the index.html file stored under `appId:current` if not query parameter has been passed in, specifying another version.
+
 ## Installation
 
 From within your [Ember CLI][2] application, run:
@@ -74,10 +80,12 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
 
 ## Release History
 
+- [v0.0.2][5]
 - [v0.0.1][4]
 
 
 [1]: https://github.com/achambers/ember-cli-deploy "ember-cli-deploy"
 [2]: http://ember-cli.com "Ember CLI"
 [3]: https://github.com/achambers/ember-cli-deploy#adapters "ember-cli-deploy adapters"
 [4]: https://github.com/achambers/ember-cli-deploy-redis-index-adapter/releases/tag/v0.0.1 "Release v0.0.1"
+[5]: https://github.com/achambers/ember-cli-deploy-redis-index-adapter/releases/tag/v0.0.2 "Release v0.0.2"

lib/redis-index-adapter.js

@@ -16,18 +16,19 @@ var Adapter = CoreObject.extend({
 
   upload: function(data) {
     var key          = this._key();
-    var promises     = [
-      this._uploadIfNotInVersionList(key, data),
-      this._updateVersionList(key)
-    ];
 
-    return CLIPromise.all(promises)
+    return this._uploadIfNotInVersionList(key, data)
+      .then(this._updateVersionList.bind(this, key))
       .then(this._trimVersionList.bind(this))
       .then(function() {
         return key;
       });
   },
 
+  setCurrent: function(key) {
+    return this._setCurrentIfInVersionList(key);
+  },
+
   _key: function() {
     var cmd = new GitCommand('./', 'rev-parse', ['--short=10'], 'HEAD');
     return cmd.execSync().trim();
@@ -40,14 +41,29 @@ var Adapter = CoreObject.extend({
     return this._listVersions()
       .then(function(keys) {
         if (keys.indexOf(key) === -1) {
-          return self.client.set(redisKey, value);
+          return self._set(redisKey, value);
         } else {
           var message = 'Version for key [' + key + ']' + ' has already been uploaded\n';
           return CLIPromise.reject(new SilentError(message));
         }
       });
   },
 
+  _setCurrentIfInVersionList: function(key) {
+    var self  = this;
+    var appId = this.appId;
+
+    return this._listVersions()
+      .then(function(versions) {
+        if (versions.indexOf(key) === -1) {
+          var message = 'Version for key [' + key + ']' + ' does not exist\n';
+          return CLIPromise.reject(new SilentError(message));
+        } else {
+          return self._set(appId + ':current', key);
+        }
+      });
+  },
+
   _updateVersionList: function(key) {
     var self = this;
 
@@ -71,6 +87,10 @@ var Adapter = CoreObject.extend({
     return this.client.lrange(this.appId, 0, count - 1);
   },
 
+  _set: function(key, value) {
+    return this.client.set(key, value);
+  },
+
   _client: function() {
     return require('romis').createClient(this.connection.port, this.connection.host, {
       auth_pass: this.connection.password

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ember-cli-deploy-redis-index-adapter",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "directories": {
     "doc": "doc",
     "test": "tests"

tests/helpers/mock-redis-client.js

@@ -2,29 +2,34 @@ var CoreObject = require('core-object');
 var CLIPromise = require('ember-cli/lib/ext/promise');
 
 module.exports = CoreObject.extend({
+  init: function() {
+    this.store = {};
+  },
+
   lpush: function(appId, key) {
-    this.appId = appId;
-    this.key = key;
-    return CLIPromise.resolve();
+    this.store[appId] = this.store[appId] || [];
+    var length = this.store[appId].unshift(key);
+
+    return CLIPromise.resolve(length);
   },
   lrange: function(appId, start, end) {
-    this.appId = appId;
-    this.start = start;
-    this.end = end;
+    var values = this.store[appId] || [];
 
-    var result = ['key', 'a', 'b', 'c', 'd'].slice(start, end + 1);
+    var result = values.slice(start, end + 1);
 
     return CLIPromise.resolve(result);
   },
   ltrim: function(appId, min, max) {
-    this.appId = appId;
-    this.min = min;
-    this.max = max;
-    return CLIPromise.resolve();
+    var values = this.store[appId] || [];
+
+    this.store[appId] = values.slice(min, max + 1);
+    return CLIPromise.resolve('OK');
   },
   set: function(key, value) {
-    this.key = key;
-    this.value = value;
-    return CLIPromise.resolve();
+    this.store[key] = value;
+    return CLIPromise.resolve('OK');
+  },
+  get: function(key) {
+    return this.store[key];
   }
 });

tests/unit/redis-index-adapter-nodetest.js

@@ -78,164 +78,91 @@ describe('redis-index-adpater', function(){
   });
 
   describe('#upload', function() {
-    it('proceeds if index is uploaded and returns the key', function() {
-      adapterOptions._uploadIfNotInVersionList = succeeded;
-      adapterOptions._updateVersionList        = succeeded;
-      adapterOptions._trimVersionList          = succeeded;
+    it('rejects if the version is already uploaded', function() {
+      mockClient.set('aaa', 'data');
+      mockClient.lpush(adapterOptions.appId, 'aaa');
 
       var subject = new Adapter(adapterOptions);
 
-      return subject.upload('data')
-        .then(function(key) {
-          assert.ok(/[0-9a-f]{10}/.test(key));
-        }, function(error) {
-          assert.ok(false, 'Should have resolved upload');
-        });
-    });
-
-    it('rejects if index is not uploaded', function() {
-      adapterOptions._uploadIfNotInVersionList = failed;
-      adapterOptions._updateVersionList        = succeeded;
-      adapterOptions._trimVersionList          = succeeded;
-
-      var subject = new Adapter(adapterOptions);
+      subject._key = function() {
+        return 'aaa';
+      };
 
       return subject.upload('data')
         .then(function() {
-          assert.ok(false, 'Should have rejected upload');
+          assert.ok(false, 'Should have rejected due to version already being uploaded');
         }, function(error) {
-          assert.equal(error, 'failed');
+          assert.equal(error.message, 'Version for key [aaa] has already been uploaded\n');
         });
     });
 
-    it('rejects if version list is not updated', function() {
-      adapterOptions._uploadIfNotInVersionList = succeeded;
-      adapterOptions._updateVersionList        = failed;
-      adapterOptions._trimVersionList          = succeeded;
-
+    it('maintains the version list to be at the specified number of versions', function() {
+      for(var i = 0; i < 4; i++) {
+        mockClient.lpush(adapterOptions.appId, 'version-' + i);
+      }
       var subject = new Adapter(adapterOptions);
 
-      return subject.upload('data')
-        .then(function() {
-          assert.ok(false, 'Should have rejected upload');
-        }, function(error) {
-          assert.equal(error, 'failed');
-        });
-    });
-
-    it('rejects if version list is not trimmed', function() {
-      adapterOptions._uploadIfNotInVersionList = succeeded;
-      adapterOptions._updateVersionList        = succeeded;
-      adapterOptions._trimVersionList          = failed;
+      subject._key = function() {
+        return 'aaa';
+      };
 
-      var subject = new Adapter(adapterOptions);
+      assert.equal(mockClient.get(adapterOptions.appId).indexOf('aaa'), -1);
 
       return subject.upload('data')
         .then(function() {
-          assert.ok(false, 'Should have rejected upload');
+          assert.equal(mockClient.get(adapterOptions.appId).length, 4);
+          assert.equal(mockClient.get(adapterOptions.appId)[0], 'aaa');
         }, function(error) {
-          assert.equal(error, 'failed');
+          assert.ok(false, 'Should have resolved');
         });
     });
-  });
 
-  describe('#_key', function() {
-    it('returns the current git hash', function() {
+    it('returns the key for which the data was uploaded', function() {
       var subject = new Adapter(adapterOptions);
 
-      var sha = subject._key();
+      subject._key = function() {
+        return 'aaa';
+      };
 
-      assert.ok(/[0-9a-f]{10}/.test(sha), 'Should return hash');
-    });
-  });
-
-  describe('#_uploadIfNotInVersionList', function() {
-    it('resolves on a successful upload', function() {
-      var subject = new Adapter(adapterOptions);
-
-      return subject._uploadIfNotInVersionList('new-key', 'value')
-        .then(function() {
-          assert.equal(mockClient.key, 'my-app:new-key');
-          assert.equal(mockClient.value, 'value');
+      return subject.upload('data')
+        .then(function(key) {
+          assert.equal(key, 'aaa');
         }, function() {
-          assert.ok(false, 'Should have uploaded successfully');
-        });
-    });
-
-    it('rejects if a version already exists for the current git sha', function() {
-      var subject = new Adapter(adapterOptions);
-
-      return subject._uploadIfNotInVersionList('key', 'value')
-        .then(function() {
-          assert.ok(false, 'Should have rejected due to version already being uploaded');
-        }, function(error) {
-          assert.equal(error.message, 'Version for key [key] has already been uploaded\n');
+          assert.ok(false, 'Should have resolved with upload key');
         });
     });
   });
 
-  describe('#_updateVersionList', function() {
-    it('resolves on a successful update', function() {
+  describe('#setCurrent', function() {
+    it('rejects if the version has not been previously uploaded', function() {
       var subject = new Adapter(adapterOptions);
 
-      return subject._updateVersionList('new-key')
+      return subject.setCurrent('aaa')
         .then(function() {
-          assert.equal(mockClient.appId, 'my-app');
-          assert.equal(mockClient.key, 'new-key');
-        }, function() {
-          assert.ok(false, 'Should have updated versions successfully');
-        });
-    });
-
-    it('rejects if a version already exists for the current git sha', function() {
-      var subject = new Adapter(adapterOptions);
-
-      return subject._updateVersionList('key')
-        .then(function() {
-          assert.ok(false, 'Should have rejected due to version already being in version list');
+          assert.ok(false, 'Should have rejected');
         }, function(error) {
-          assert.equal(error.message, 'Version for key [key] has already been uploaded\n');
-        });
-    });
-  });
-
-  describe('#_trimVersions', function() {
-    it('resolves on a successful call', function() {
-      adapterOptions.versionCount = 5;
-
-      var subject = new Adapter(adapterOptions);
-
-      return subject._trimVersionList()
-        .then(function() {
-          assert.equal(mockClient.appId, 'my-app');
-          assert.equal(mockClient.min, 0);
-          assert.equal(mockClient.max, 4);
-        }, function() {
-          assert.ok(false, 'Should have trimmed the version list successfully');
+          assert.equal(error.message, 'Version for key [aaa] does not exist\n');
+          var currentKey = mockClient.get(adapterOptions.appId + ':current');
+          assert.equal(currentKey, null);
         });
     });
-  });
 
-  describe('#_listVersions', function() {
-    it('returns the number of versions specified', function() {
+    it('sets the specified version as the current version', function() {
       var subject = new Adapter(adapterOptions);
 
-      return subject._listVersions(3)
-        .then(function(result) {
-          assert.equal(result.length, 3);
-        }, function() {
-          assert.ok(false, 'Should have returned specified number of versions');
-        });
-    });
-
-    it('returns the default number of versions when count not specified', function() {
-      var subject = new Adapter(adapterOptions);
+      subject._key = function() {
+        return 'aaa';
+      };
 
-      return subject._listVersions()
-        .then(function(result) {
-          assert.equal(result.length, 4);
-        }, function() {
-          assert.ok(false, 'Should have returned specified number of versions');
+      return subject.upload('data')
+        .then(function(key) {
+          return subject.setCurrent(key)
+            .then(function() {
+              var currentKey = mockClient.get(adapterOptions.appId + ':current');
+              assert.equal(currentKey, key);
+            }, function() {
+              assert.ok(false, 'Should have resolved');
+            });
         });
     });
   });