Merge pull request #8 from LevelbossMike/add-tests

Add tests for lib/s3

Author: Aaron Chambers

.travis.yml

@@ -9,19 +9,7 @@ cache:
   directories:
     - node_modules
 
-env:
-  - EMBER_TRY_SCENARIO=default
-  - EMBER_TRY_SCENARIO=ember-release
-  - EMBER_TRY_SCENARIO=ember-beta
-  - EMBER_TRY_SCENARIO=ember-canary
-
-matrix:
-  fast_finish: true
-  allow_failures:
-    - env: EMBER_TRY_SCENARIO=ember-canary
-
 before_install:
-  - export PATH=/usr/local/phantomjs-2.0.0/bin:$PATH
   - "npm config set spin false"
   - "npm install -g npm@^2"
 
@@ -31,4 +19,4 @@ install:
   - bower install
 
 script:
-  - ember try $EMBER_TRY_SCENARIO test
+  - npm test

package.json

@@ -9,7 +9,7 @@
   "scripts": {
     "build": "ember build",
     "start": "ember server",
-    "test": "ember try:testall"
+    "test": "node tests/runner.js"
   },
   "repository": "https://github.com/LevelbossMike/ember-cli-deploy-s3-index",
   "engines": {
@@ -19,6 +19,8 @@
   "license": "MIT",
   "devDependencies": {
     "broccoli-asset-rev": "^2.1.2",
+    "chai": "^3.3.0",
+    "chai-as-promised": "^5.1.0",
     "ember-cli": "1.13.8",
     "ember-cli-app-version": "0.5.0",
     "ember-cli-content-security-policy": "0.4.0",
@@ -32,10 +34,12 @@
     "ember-cli-sri": "^1.0.3",
     "ember-cli-uglify": "^1.2.0",
     "ember-data": "1.13.8",
+    "ember-disable-prototype-extensions": "^1.0.0",
     "ember-disable-proxy-controllers": "^1.0.0",
     "ember-export-application-global": "^1.0.3",
-    "ember-disable-prototype-extensions": "^1.0.0",
-    "ember-try": "0.0.6"
+    "ember-try": "0.0.6",
+    "glob": "^5.0.15",
+    "mocha": "^2.3.3"
   },
   "keywords": [
     "ember-addon",

tests/runner.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var glob = require('glob');
+var Mocha = require('mocha');
+
+var mocha = new Mocha({
+  reporter: 'spec'
+});
+
+var arg = process.argv[2];
+var root = 'tests/';
+
+function addFiles(mocha, files) {
+  glob.sync(root + files).forEach(mocha.addFile.bind(mocha));
+}
+
+addFiles(mocha, '/**/*-nodetest.js');
+
+if (arg === 'all') {
+  addFiles(mocha, '/**/*-nodetest-slow.js');
+}
+
+mocha.run(function(failures) {
+  process.on('exit', function() {
+    process.exit(failures);
+  });
+});

tests/unit/fixtures/test.html

@@ -0,0 +1 @@
+<p>Welcome to Ember!</p>

tests/unit/lib/s3-nodetest.js

@@ -0,0 +1,304 @@
+var assert = require('ember-cli/tests/helpers/assert');
+
+describe('s3', function() {
+  var S3, mockUi, s3Client, plugin, subject, options, listParams, headParams, copyParams;
+
+  before(function() {
+    S3 = require('../../../lib/s3');
+  });
+
+  beforeEach(function() {
+    revisionsData = {
+      Contents: [
+        { Key: 'test.html:123', LastModified: new Date('September 27, 2015 01:00:00'), ETag: '123' },
+        { Key: 'test.html:456', LastModified: new Date('September 27, 2015 02:00:00') , ETag: '456' }
+      ]
+    };
+
+    currentData = { Key: 'test.html', lastModified: new Date('September 27, 2015 01:30:00'), ETag: '123' };
+
+    s3Client = {
+      putObject: function(params, cb) {
+        cb();
+      },
+
+      listObjects: function(params, cb) {
+        listParams = params;
+        cb(undefined, revisionsData);
+      },
+
+      headObject: function(params, cb) {
+        headParams = params;
+        cb(undefined, currentData);
+      },
+
+      copyObject: function(params, cb) {
+        copyParams = params;
+        cb();
+      }
+    };
+    mockUi = {
+      messages: [],
+      write: function() {},
+      writeLine: function(message) {
+        this.messages.push(message);
+      }
+    };
+    plugin = {
+      ui: mockUi,
+      readConfig: function(propertyName) {
+        if (propertyName === 's3Client') {
+          return s3Client;
+        }
+      },
+      log: function(message, opts) {
+        this.ui.write('|    ');
+        this.ui.writeLine('- ' + message);
+      }
+    };
+    subject = new S3({
+      plugin: plugin
+    });
+  });
+
+  describe('#upload', function() {
+    var s3Params;
+    var filePattern = 'test.html';
+    var revisionKey = 'some-revision-key';
+    var bucket      = 'some-bucket';
+    var prefix      = 'my-app';
+
+    beforeEach(function() {
+      options = {
+        bucket: bucket,
+        prefix: '',
+        filePattern: filePattern,
+        revisionKey: revisionKey,
+        filePath: 'tests/unit/fixtures/test.html'
+      };
+
+      s3Client.putObject = function(params, cb) {
+        s3Params = params;
+        cb();
+      };
+    });
+
+    it('resolves if upload succeeds', function() {
+      var promise = subject.upload(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          var expectLogOutput = '- ✔  '+filePattern+':'+revisionKey;
+
+          assert.equal(mockUi.messages.length, 1, 'Logs one line');
+          assert.equal(mockUi.messages[0], expectLogOutput, 'Upload log output correct');
+        });
+    });
+
+    it('rejects if upload fails', function() {
+      s3Client.putObject = function(params, cb) {
+        cb('error uploading');
+      };
+
+      var promise = subject.upload(options);
+
+      return assert.isRejected(promise);
+    });
+
+    it('passes expected parameters to the used s3-client', function() {
+
+      var promise = subject.upload(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          var expectedKey = filePattern+':'+revisionKey;
+          var defaultACL  = 'public-read';
+
+          assert.equal(s3Params.Bucket, bucket, 'Bucket passed correctly');
+          assert.equal(s3Params.Key, expectedKey, 'Key passed correctly');
+          assert.equal(s3Params.ACL, defaultACL, 'ACL defaults to `public-read`');
+          assert.equal(s3Params.ContentType, 'text/html', 'contentType is set to `text/html`');
+          assert.equal(s3Params.CacheControl, 'max-age=0, no-cache', 'cacheControl set correctly');
+        });
+    });
+
+    it('allows `prefix` option to be passed to customize upload-path', function() {
+      var prefix = 'my-app';
+
+      options.prefix = prefix;
+      var promise    = subject.upload(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          var expectLogOutput = '- ✔  '+prefix+'/'+filePattern+':'+revisionKey;
+          var expectedKey     = prefix+'/'+filePattern+':'+revisionKey;
+
+          assert.equal(mockUi.messages[0], expectLogOutput, 'Prefix is included in log output');
+          assert.equal(s3Params.Key, expectedKey, 'Key (including prefix) passed correctly');
+        });
+    });
+
+    it('allows `acl` option to be passed to customize the used ACL', function() {
+      var acl = 'authenticated-read';
+
+      options.acl = acl;
+      var promise = subject.upload(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          var expectLogOutput = '- ✔  '+prefix+'/'+filePattern+':'+revisionKey;
+          var expectedKey     = prefix+'/'+filePattern+':'+revisionKey;
+
+          assert.equal(s3Params.ACL, acl, 'acl passed correctly');
+        });
+    });
+  });
+
+  describe('#fetchRevisions', function() {
+    var bucket      = 'some-bucket';
+    var prefix      = '';
+    var filePattern = 'test.html';
+
+    beforeEach(function() {
+      options = {
+        bucket: bucket,
+        prefix: prefix,
+        filePattern: filePattern
+      };
+    });
+
+    it('returns an array of uploaded revisions in `{ revision: revisionKey, timestamp: timestamp, active: active }` format sorted by date in descending order', function() {
+      var promise = subject.fetchRevisions(options);
+      var expected = [
+          { revision: '456', timestamp: new Date('September 27, 2015 02:00:00') , active: false },
+          { revision: '123', timestamp: new Date('September 27, 2015 01:00:00'), active: true }
+      ];
+
+      return assert.isFulfilled(promise)
+        .then(function(revisionsData) {
+          return assert.deepEqual(revisionsData, expected, 'Revisions data correct');
+        });
+    });
+
+    it('sends correct parameters for s3#listObjects and s3#headObject', function() {
+      var expectePrefix = filePattern+':';
+
+      var promise = subject.fetchRevisions(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          assert.equal(listParams.Bucket, bucket, 'list Bucket set correctly');
+          assert.equal(listParams.Prefix, expectePrefix, 'list Prefix set correctly');
+          assert.equal(headParams.Bucket, bucket, 'head Bucket set correctly');
+          assert.equal(headParams.Key, filePattern, 'head Key set correctly');
+        });
+    });
+
+    it('changes parameters sent to s3#listObjects and s3#headObject when setting the `prefix`-option', function() {
+      var prefix = 'my-app';
+      var expectedPrefix = 'my-app/'+filePattern+':';
+      var expectedKey = 'my-app/'+filePattern;
+
+      options.prefix = prefix;
+      var promise = subject.fetchRevisions(options);
+
+      return assert.isFulfilled(promise)
+        .then(function() {
+          assert.equal(listParams.Prefix, expectedPrefix);
+          assert.equal(headParams.Key, expectedKey);
+        });
+    });
+  });
+
+  describe('#activate', function() {
+    var bucket      = 'some-bucket';
+    var prefix      = '';
+    var filePattern = 'test.html';
+
+    beforeEach(function() {
+      options = {
+        bucket: bucket,
+        prefix: prefix,
+        filePattern: filePattern
+      };
+    });
+
+    describe('with a valid revisionKey', function() {
+      beforeEach(function() {
+        options.revisionKey = '456';
+      });
+
+      it('resolves when passing an existing revisionKey', function() {
+        var promise = subject.activate(options);
+
+        return assert.isFulfilled(promise);
+      });
+
+      it('logs to the console when activation was successful', function() {
+        var promise = subject.activate(options);
+        var expectedOutput = '- ✔  '+filePattern+':456 => '+filePattern;
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(mockUi.messages.length, 1, 'Logs one line');
+            assert.equal(mockUi.messages[0], expectedOutput, 'Activation output correct');
+          });
+      });
+
+      it('passes correct parameters to s3#copyObject', function() {
+        var promise = subject.activate(options);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(copyParams.Bucket, bucket);
+            assert.equal(copyParams.ACL, 'public-read');
+            assert.equal(copyParams.CopySource, bucket+'%2F'+filePattern+'%3A456');
+            assert.equal(copyParams.Key, filePattern);
+          });
+      });
+
+      it('allows `prefix` option to be passed to customize Key and CopySource passed to s3#copyObject', function() {
+        var prefix = 'my-app';
+        revisionsData = {
+          Contents: [
+            { Key: prefix+'/test.html:123', LastModified: new Date('September 27, 2015 01:00:00'), ETag: '123' },
+            { Key: prefix+'/test.html:456', LastModified: new Date('September 27, 2015 02:00:00') , ETag: '456' }
+          ]
+        };
+
+        options.prefix = prefix;
+        var promise    = subject.activate(options);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(copyParams.Key, prefix+'/'+filePattern);
+            assert.equal(copyParams.CopySource, bucket+'%2F'+prefix+'%2F'+filePattern+'%3A456');
+          });
+      });
+
+      it('allows `acl` option to be passed to customize the used ACL', function() {
+        var acl = 'authenticated-read';
+
+        options.acl = acl;
+        var promise = subject.activate(options);
+
+        return assert.isFulfilled(promise)
+          .then(function() {
+            assert.equal(copyParams.ACL, acl);
+          });
+      });
+    });
+
+    describe('with an invalid revision key', function() {
+      beforeEach(function() {
+        options.revisionKey = '457';
+      });
+
+      it('rejects when passing an non-existing revisionKey', function() {
+        var promise = subject.activate(options);
+
+        return assert.isRejected(promise);
+      });
+    });
+  });
+});