feat(ui): show sudo command before it is run

closes TryGhost#164
- add sudo ui method that shows the sudo command before it is run
- make log method synchronous again

lib/services/nginx/index.js

@@ -73,7 +73,6 @@ class NginxService extends BaseService {
             });
         }
 
-        let ghostExec = process.argv.slice(0,2).join(' ');
         let answerPromise;
         let answers;
 
@@ -89,14 +88,12 @@ class NginxService extends BaseService {
         return answerPromise.then((_answers) => {
             answers = _answers;
 
-            return this.ui.noSpin(execa.shell(`sudo ${ghostExec} service nginx-conf${!answers.ssl ? ' no-ssl' : ''}`, {stdio: 'inherit'})).catch((error) => {
+            return this.ui.sudo(`ghost service nginx-conf${!answers.ssl ? ' no-ssl' : ''}`).catch((error) => {
                 return Promise.reject(new errors.ProcessError(error));
             });
         }).then(() => {
             if (answers.ssl) {
-                return this.ui.noSpin(execa.shell(`sudo ${ghostExec} service nginx-ssl ${answers.email}${answers.staging ? ' staging' : ''}`, {
-                    stdio: 'inherit'
-                })).catch((error) => {
+                return this.ui.sudo(`ghost service nginx-ssl ${answers.email}${answers.staging ? ' staging' : ''}`).catch((error) => {
                     return Promise.reject(new errors.ProcessError(error));
                 });
             }
@@ -204,9 +201,9 @@ class NginxService extends BaseService {
         let confFile = `${this.parsedUrl.hostname}.conf`;
 
         if (fs.existsSync(`/etc/nginx/sites-available/${confFile}`)) {
-            return this.ui.noSpin(() => execa.shell(`sudo rm /etc/nginx/sites-available/${confFile} && sudo rm /etc/nginx/sites-enabled/${confFile}`, {
-                stdio: 'inherit'
-            }).catch(() => Promise.reject(new errors.SystemError('Nginx config file could not be removed, you will need to do this manually.'))));
+            return this.ui.sudo(`rm /etc/nginx/sites-available/${confFile}`).then(() => {
+                return this.ui.sudo(`rm /etc/nginx/sites-enabled/${confFile}`);
+            }).catch(() => Promise.reject(new errors.SystemError('Nginx config file could not be removed, you will need to do this manually.')));
         }
     }
 };

lib/services/process/systemd/index.js

@@ -30,28 +30,28 @@ class SystemdProcess extends BaseProcess {
             ghost_exec_path: process.argv.slice(0,2).join(' ')
         }), 'utf8');
 
-        return this.ui.noSpin(() => execa.shell(`sudo mv ${serviceFilename} /lib/systemd/system`, {stdio: 'inherit'}).catch(() => {
+        return this.ui.sudo(`mv ${serviceFilename} /lib/systemd/system`).catch(() => {
             return Promise.reject(new errors.SystemError('Ghost service file could not be put in place, ensure you have proper sudo permissions and systemd is installed.'));
-        }));
+        });
     }
 
     uninstall() {
         let serviceFilename = `/lib/systemd/system/${this.systemdName}.service`;
 
         if (fs.existsSync(serviceFilename)) {
-            return this.ui.noSpin(() => execa.shell(`sudo rm ${serviceFilename}`, {stdio: 'inherit'}).catch(() =>
-                Promise.reject(new errors.SystemError('Ghost systemd service file could not be removed, you will need to do it manually.'))
-            ));
+            return this.ui.sudo(`rm ${serviceFilename}`).catch(
+                () => Promise.reject(new errors.SystemError('Ghost systemd service file could not be removed, you will need to do it manually.'))
+            );
         }
     }
 
     start() {
-        return this.ui.noSpin(() => execa.shell(`sudo systemctl start ${this.systemdName}`, {stdio: 'inherit'}))
+        return this.ui.sudo(`systemctl start ${this.systemdName}`)
             .catch((error) => Promise.reject(new errors.ProcessError(error)));
     }
 
     stop() {
-        return this.ui.noSpin(() => execa.shell(`sudo systemctl stop ${this.systemdName}`, {stdio: 'inherit'}))
+        return this.ui.sudo(`systemctl stop ${this.systemdName}`)
             .catch((error) => Promise.reject(new errors.ProcessError(error)));
     }
 

lib/ui.js

@@ -3,6 +3,7 @@ const fs        = require('fs-extra');
 const path      = require('path');
 const ora       = require('ora');
 const chalk     = require('chalk');
+const execa     = require('execa');
 const errors    = require('./errors');
 const Table     = require('cli-table2');
 const assign    = require('lodash/assign');
@@ -78,6 +79,21 @@ class UI {
         });
     }
 
+    sudo(command, options) {
+        this.log(`Running sudo command: ${command}`, 'gray');
+
+        return this.noSpin(() => {
+            let execaOptions = assign({
+                stdio: 'inherit'
+            }, options || {});
+
+            return execa.shell(
+                `sudo ${command.replace(/^ghost/, process.argv.slice(0, 2).join(' '))}`,
+                execaOptions
+            );
+        });
+    }
+
     noSpin(promiseOrFunc) {
         if (this.spinner) {
             this.spinner.stop();
@@ -97,7 +113,7 @@ class UI {
             message = chalk[color](message);
         }
 
-        this.noSpin(() => this.stdout.write(`${message}\n`));
+        this.stdout.write(`\r${message}\n`);
     }
 
     success(message) {

test/unit/ui/index-spec.js

@@ -18,7 +18,7 @@ describe('Unit: UI', function () {
             stdout = streamTestUtils.getWritableStream(function (output) {
                 expect(output, 'output exists').to.be.ok;
                 expect(chalk.hasColor(output), 'output has color').to.be.false;
-                expect(output, 'output value').to.equal('test\n');
+                expect(output, 'output value').to.equal('\rtest\n');
 
                 done();
             });
@@ -34,7 +34,7 @@ describe('Unit: UI', function () {
             stdout = streamTestUtils.getWritableStream(function (output) {
                 expect(output, 'output exists').to.be.ok;
                 expect(chalk.hasColor(output), 'output has color').to.be.true;
-                expect(output, 'output value').to.equal(chalk.green('test') + '\n');
+                expect(output, 'output value').to.equal(`\r${chalk.green('test')}\n`);
 
                 done();
             });
@@ -51,7 +51,7 @@ describe('Unit: UI', function () {
         stdout = streamTestUtils.getWritableStream(function (output) {
             expect(output, 'output exists').to.be.ok;
             expect(chalk.hasColor(output), 'output has color').to.be.true;
-            expect(output, 'output value').to.equal(chalk.green('test') + '\n');
+            expect(output, 'output value').to.equal(`\r${chalk.green('test')}\n`);
 
             done();
         });
@@ -67,7 +67,7 @@ describe('Unit: UI', function () {
         stdout = streamTestUtils.getWritableStream(function (output) {
             expect(output, 'output exists').to.be.ok;
             expect(chalk.hasColor(output), 'output has color').to.be.true;
-            expect(output, 'output value').to.equal(chalk.red('test') + '\n');
+            expect(output, 'output value').to.equal(`\r${chalk.red('test')}\n`);
 
             done();
         });