feat(install): add option to install/update using zip file

closes #59
- add a --zip option to both `ghost install` and `ghost update` so that unreleased new Ghost versions can be tested using install and update
- deps: [email protected]
- update tests

Author: acburdine

lib/commands/install.js

@@ -59,7 +59,7 @@ class InstallCommand extends Command {
                 title: 'Downloading and installing Ghost',
                 task: (ctx, task) => {
                     task.title = `Downloading and installing Ghost v${ctx.version}`;
-                    return yarnInstall(ctx.ui);
+                    return yarnInstall(ctx.ui, ctx.zip);
                 }
             }, {
                 title: 'Finishing install process',
@@ -71,6 +71,7 @@ class InstallCommand extends Command {
                     task: this.casper
                 }], false)
             }], {
+                zip: argv.zip,
                 version: version,
                 cliVersion: this.system.cliVersion
             })
@@ -86,9 +87,11 @@ class InstallCommand extends Command {
     }
 
     version(ctx) {
-        const resolveVersion = require('../utils/resolve-version');
+        const versionResolver = ctx.zip ?
+            require('../utils/version-from-zip') :
+            require('../utils/resolve-version');
 
-        return resolveVersion(ctx.version).then((version) => {
+        return versionResolver(ctx.zip || ctx.version).then((version) => {
             ctx.version = version;
             ctx.installPath = path.join(process.cwd(), 'versions', version);
         });
@@ -124,6 +127,10 @@ InstallCommand.options = {
         description: 'Folder to install Ghost in',
         type: 'string'
     },
+    zip: {
+        description: 'Path to Ghost release zip to install',
+        type: 'string'
+    },
     stack: {
         description: '[--no-stack] Enable/Disable system stack checks on install',
         type: 'boolean',

lib/commands/update.js

@@ -30,7 +30,8 @@ class UpdateCommand extends Command {
             instance: instance,
             force: argv.force,
             activeVersion: instance.cliConfig.get('active-version'),
-            version: argv.version
+            version: argv.version,
+            zip: argv.zip
         };
 
         if (argv.rollback) {
@@ -97,7 +98,7 @@ class UpdateCommand extends Command {
         }
 
         task.title = `Downloading and updating Ghost to v${ctx.version}`;
-        return yarnInstall(ctx.ui);
+        return yarnInstall(ctx.ui, ctx.zip);
     }
 
     stop() {
@@ -137,13 +138,18 @@ class UpdateCommand extends Command {
     }
 
     version(context) {
-        const resolveVersion = require('../utils/resolve-version');
-
         if (context.rollback) {
             return Promise.resolve(true);
         }
 
-        return resolveVersion(context.version, context.force ? null : context.activeVersion).then((version) => {
+        const versionResolver = context.zip ?
+            require('../utils/version-from-zip') :
+            require('../utils/resolve-version');
+
+        return versionResolver(
+            context.zip || context.version,
+            context.force ? null : context.activeVersion
+        ).then((version) => {
             context.version = version;
             context.installPath = path.join(process.cwd(), 'versions', version);
             return true;
@@ -170,6 +176,10 @@ class UpdateCommand extends Command {
 UpdateCommand.description = 'Update a Ghost instance';
 UpdateCommand.params = '[version]';
 UpdateCommand.options = {
+    zip: {
+        description: 'Path to Ghost release zip to install',
+        type: 'string'
+    },
     rollback: {
         alias: 'r',
         description: 'Rollback to the previously installed Ghost version',

lib/tasks/yarn-install.js

@@ -44,20 +44,27 @@ const subTasks = {
     }
 };
 
-module.exports = function yarnInstall(ui) {
-    return ui.listr([{
+module.exports = function yarnInstall(ui, zipFile) {
+    const tasks = zipFile ? [{
+        title: 'Extracting release from local zip',
+        task: (ctx) => decompress(zipFile, ctx.installPath)
+    }] : [{
         title: 'Getting download information',
         task: subTasks.dist
     }, {
         title: 'Downloading',
         task: subTasks.download
-    }, {
+    }];
+
+    tasks.push({
         title: 'Installing dependencies',
         task: (ctx) => yarn(['install', '--no-emoji', '--no-progress'], {
             cwd: ctx.installPath,
             env: {NODE_ENV: 'production'},
             observe: true
         })
-    }], false);
+    });
+
+    return ui.listr(tasks, false);
 };
 module.exports.subTasks = subTasks;

lib/utils/version-from-zip.js

@@ -0,0 +1,41 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const errors = require('../errors');
+const semver = require('semver');
+const AdmZip = require('adm-zip');
+
+module.exports = function versionFromZip(zipPath, currentVersion) {
+    if (!path.isAbsolute(zipPath)) {
+        zipPath = path.join(process.cwd(), zipPath);
+    }
+
+    if (!fs.existsSync(zipPath) || path.extname(zipPath) !== '.zip') {
+        return Promise.reject(new errors.SystemError('Zip file could not be found.'));
+    }
+
+    const zip = new AdmZip(zipPath);
+    let pkg;
+
+    try {
+        pkg = JSON.parse(zip.readAsText('package.json'));
+    } catch (e) {
+        return Promise.reject(new errors.SystemError('Zip file does not contain a valid package.json.'));
+    }
+
+    if (pkg.name !== 'ghost') {
+        return Promise.reject(new errors.SystemError('Zip file does not contain a Ghost release.'));
+    }
+
+    if (semver.lt(pkg.version, '1.0.0')) {
+        return Promise.reject(new errors.SystemError('Zip file contains pre-1.0 version of Ghost.'));
+    }
+
+    if (currentVersion && semver.lt(pkg.version, currentVersion)) {
+        return Promise.reject(
+            new errors.SystemError('Zip file contains an older release version than what is currently installed.')
+        );
+    }
+
+    return Promise.resolve(pkg.version);
+};

package.json

@@ -38,7 +38,8 @@
   },
   "preferGlobal": true,
   "dependencies": {
-    "abbrev": "^1.1.0",
+    "abbrev": "1.1.0",
+    "adm-zip": "0.4.7",
     "bluebird": "3.5.0",
     "chalk": "2.0.1",
     "cli-table2": "0.2.0",

test/fixtures/ghostlts.zip

@@ -2,6 +2,7 @@
 const expect = require('chai').expect;
 const sinon = require('sinon');
 const proxyquire = require('proxyquire').noCallThru();
+const Promise = require('bluebird');
 const path = require('path');
 
 const modulePath = '../../../lib/commands/install';
@@ -116,7 +117,7 @@ describe('Unit: Commands > Install', function () {
             });
             let testInstance = new InstallCommand({listr: listrStub}, {cliVersion: '1.0.0', setEnvironment: setEnvironmentStub});
 
-            return testInstance.run({version: 'local'}).then(() => {
+            return testInstance.run({version: 'local', zip: ''}).then(() => {
                 expect(false, 'run should have rejected').to.be.true;
             }).catch(() => {
                 expect(readdirStub.calledOnce).to.be.true;
@@ -127,12 +128,13 @@ describe('Unit: Commands > Install', function () {
                 ]);
                 expect(listrStub.args[0][1]).to.deep.equal({
                     ui: {listr: listrStub},
-                    argv: {version: 'local'},
+                    argv: {version: 'local', zip: ''},
                     local: true
                 });
                 expect(listrStub.args[1][1]).to.deep.equal({
                     version: null,
-                    cliVersion: '1.0.0'
+                    cliVersion: '1.0.0',
+                    zip: ''
                 });
                 expect(setEnvironmentStub.calledOnce).to.be.true;
                 expect(setEnvironmentStub.calledWithExactly(true, true)).to.be.true;
@@ -152,7 +154,7 @@ describe('Unit: Commands > Install', function () {
             });
             let testInstance = new InstallCommand({listr: listrStub}, {cliVersion: '1.0.0', setEnvironment: setEnvironmentStub});
 
-            return testInstance.run({version: '1.5.0', local: true}).then(() => {
+            return testInstance.run({version: '1.5.0', local: true, zip: ''}).then(() => {
                 expect(false, 'run should have rejected').to.be.true;
             }).catch(() => {
                 expect(readdirStub.calledOnce).to.be.true;
@@ -163,31 +165,47 @@ describe('Unit: Commands > Install', function () {
                 ]);
                 expect(listrStub.args[0][1]).to.deep.equal({
                     ui: {listr: listrStub},
-                    argv: {version: '1.5.0', local: true},
+                    argv: {version: '1.5.0', local: true, zip: ''},
                     local: true
                 });
                 expect(listrStub.args[1][1]).to.deep.equal({
                     version: '1.5.0',
-                    cliVersion: '1.0.0'
+                    cliVersion: '1.0.0',
+                    zip: ''
                 });
                 expect(setEnvironmentStub.calledOnce).to.be.true;
                 expect(setEnvironmentStub.calledWithExactly(true, true)).to.be.true;
             });
         });
 
-        it('returns after tasks run if --no-setup is passed', function () {
-            let readdirStub = sandbox.stub().returns([]);
-            let listrStub = sandbox.stub().resolves();
+        it('calls all tasks and returns after tasks run if --no-setup is passed', function () {
+            const readdirStub = sandbox.stub().returns([]);
+            const yarnInstallStub = sandbox.stub().resolves();
+            const ensureStructureStub = sandbox.stub().resolves();
+            const listrStub = sandbox.stub().callsFake((tasks, ctx) => {
+                return Promise.each(tasks, task => task.task(ctx, {}));
+            });
 
             const InstallCommand = proxyquire(modulePath, {
-                'fs-extra': {readdirSync: readdirStub}
+                'fs-extra': {readdirSync: readdirStub},
+                '../tasks/yarn-install': yarnInstallStub,
+                '../tasks/ensure-structure': ensureStructureStub,
+                './doctor/checks/install': []
             });
-            let testInstance = new InstallCommand({listr: listrStub}, {cliVersion: '1.0.0'});
-            let runCommandStub = sandbox.stub(testInstance, 'runCommand').resolves();
+            const testInstance = new InstallCommand({listr: listrStub}, {cliVersion: '1.0.0'});
+            const runCommandStub = sandbox.stub(testInstance, 'runCommand').resolves();
+            const versionStub = sandbox.stub(testInstance, 'version').resolves();
+            const linkStub = sinon.stub(testInstance, 'link').resolves();
+            const casperStub = sinon.stub(testInstance, 'casper').resolves();
 
             return testInstance.run({version: '1.0.0', setup: false}).then(() => {
                 expect(readdirStub.calledOnce).to.be.true;
-                expect(listrStub.calledTwice).to.be.true;
+                expect(listrStub.calledThrice).to.be.true;
+                expect(yarnInstallStub.calledOnce).to.be.true;
+                expect(ensureStructureStub.calledOnce).to.be.true;
+                expect(versionStub.calledOnce).to.be.true;
+                expect(linkStub.calledOnce).to.be.true;
+                expect(casperStub.calledOnce).to.be.true;
                 expect(runCommandStub.called).to.be.false;
             });
         });
@@ -204,36 +222,56 @@ describe('Unit: Commands > Install', function () {
             let testInstance = new InstallCommand({listr: listrStub}, {cliVersion: '1.0.0', setEnvironment: setEnvironmentStub});
             let runCommandStub = sandbox.stub(testInstance, 'runCommand').resolves();
 
-            return testInstance.run({version: 'local', setup: true}).then(() => {
+            return testInstance.run({version: 'local', setup: true, zip: ''}).then(() => {
                 expect(readdirStub.calledOnce).to.be.true;
                 expect(listrStub.calledTwice).to.be.true;
                 expect(setEnvironmentStub.calledOnce).to.be.true;
                 expect(setEnvironmentStub.calledWithExactly(true, true));
                 expect(runCommandStub.calledOnce).to.be.true;
                 expect(runCommandStub.calledWithExactly(
                     {SetupCommand: true},
-                    {version: 'local', local: true}
+                    {version: 'local', local: true, zip: ''}
                 ));
             });
         });
     });
 
     describe('tasks > version', function () {
         it('calls resolveVersion, sets version and install path', function () {
-            let resolveVersionStub = sinon.stub().resolves('1.5.0');
+            const resolveVersionStub = sinon.stub().resolves('1.5.0');
             const InstallCommand = proxyquire(modulePath, {
                 '../utils/resolve-version': resolveVersionStub
             });
 
-            let testInstance = new InstallCommand({}, {});
-            let context = {version: '1.0.0'};
+            const testInstance = new InstallCommand({}, {});
+            const context = {version: '1.0.0'};
 
             return testInstance.version(context).then(() => {
                 expect(resolveVersionStub.calledOnce).to.be.true;
                 expect(context.version).to.equal('1.5.0');
                 expect(context.installPath).to.equal(path.join(process.cwd(), 'versions/1.5.0'));
             });
         });
+
+        it('calls versionFromZip if zip file is passed in context', function () {
+            const resolveVersionStub = sinon.stub().resolves('1.5.0');
+            const zipVersionStub = sinon.stub().resolves('1.5.2');
+            const InstallCommand = proxyquire(modulePath, {
+                '../utils/resolve-version': resolveVersionStub,
+                '../utils/version-from-zip': zipVersionStub
+            });
+
+            const testInstance = new InstallCommand({}, {});
+            const context = {version: '1.0.0', zip: '/some/zip/file.zip'};
+
+            return testInstance.version(context).then(() => {
+                expect(resolveVersionStub.called).to.be.false;
+                expect(zipVersionStub.calledOnce).to.be.true;
+                expect(zipVersionStub.calledWith('/some/zip/file.zip')).to.be.true;
+                expect(context.version).to.equal('1.5.2');
+                expect(context.installPath).to.equal(path.join(process.cwd(), 'versions/1.5.2'));
+            });
+        });
     });
 
     describe('tasks > casper', function () {