Merge branch 'develop', prepare 0.19.0

Author: yamalight

README.md

@@ -26,7 +26,8 @@ To run Exoframe you need two parts - Exoframe CLI on your local machine and [Exo
 
 ## Installation and Usage
 
-Install Exoframe CLI (needs at least Node 8.0):
+You can use one of the pre-packaged binaries from [releases](https://github.com/exoframejs/exoframe/releases).  
+Or if you have Node installed, you can install Exoframe CLI using NPM (needs at least Node 8.0):
 
 ```
 npm install exoframe -g

package.json

@@ -15,6 +15,7 @@
     "package": "pkg --targets node8.3.0-linux-x64,node8.3.0-win-x64,node8.3.0-macos-x64 -o exoframe index.js"
   },
   "dependencies": {
+    "boxen": "^1.2.1",
     "chalk": "^2.1.0",
     "cli-table": "^0.3.1",
     "got": "^7.1.0",
@@ -26,6 +27,7 @@
     "opn": "^5.1.0",
     "ora": "^1.3.0",
     "tar-fs": "^1.15.3",
+    "update-notifier": "^2.2.0",
     "yargs": "^8.0.2"
   },
   "devDependencies": {

src/commands/update.js

@@ -0,0 +1,83 @@
+// npm packages
+const _ = require('lodash');
+const got = require('got');
+const chalk = require('chalk');
+
+// our packages
+const {userConfig, isLoggedIn, logout} = require('../config');
+
+// valid targets list
+const validTargets = ['traefik', 'server'];
+
+exports.command = ['update [target]'];
+exports.describe = 'update given target';
+exports.builder = {
+  target: {
+    alias: 't',
+    description: `Target for update (${validTargets.join(', ')})`,
+  },
+};
+exports.handler = async ({target} = {target: 'self'}) => {
+  if (!isLoggedIn()) {
+    return;
+  }
+
+  if (!validTargets.includes(target)) {
+    console.log(
+      chalk.red('Error!'),
+      'Invalid target! Should be one of:',
+      validTargets.map(it => chalk.green(it)).join(', ')
+    );
+    return;
+  }
+
+  console.log(chalk.bold(`Updating ${target} on:`), userConfig.endpoint);
+
+  // services request url
+  const remoteUrl = `${userConfig.endpoint}/update/${target}`;
+  // construct shared request params
+  const options = {
+    headers: {
+      Authorization: `Bearer ${userConfig.token}`,
+    },
+    json: true,
+  };
+  // try sending request
+  try {
+    const {body, statusCode} = await got.post(remoteUrl, options);
+    if (statusCode !== 200 || body.error) {
+      throw new Error(body.error || 'Oops. Something went wrong! Try again please.');
+    }
+
+    if (body.updated) {
+      console.log(chalk.green(`Successfully updated ${target}!`));
+      return;
+    }
+
+    console.log(chalk.green(`${_.capitalize(target)} is already up to date!`));
+  } catch (e) {
+    // if authorization is expired/broken/etc
+    if (e.statusCode === 401) {
+      logout(userConfig);
+      console.log(chalk.red('Error: authorization expired!'), 'Please, relogin and try again.');
+      return;
+    }
+
+    const reason = e.response.body && e.response.body.error ? e.response.body.error : e.toString();
+    console.log(chalk.red(`Error updating ${target}:`), reason);
+    console.log('Update log:\n');
+    (e.response.body.log || 'No log available')
+      .split('\n')
+      .map(l => {
+        try {
+          return JSON.parse(l);
+        } catch (e) {
+          return l;
+        }
+      })
+      .filter(l => l !== undefined)
+      .map(l => l.trim())
+      .filter(l => l && l.length > 0)
+      .forEach(line => console.log(line));
+  }
+};

src/index.js

@@ -1,9 +1,15 @@
 // npm packages
 const yargs = require('yargs');
 
+// our packages
+const checkUpdate = require('./util/checkUpdate');
+
 // version
 const pkg = require('../package.json');
 
+// check for updates on start
+checkUpdate(pkg);
+
 // our packages
 const login = require('./commands/login');
 const deploy = require('./commands/deploy');
@@ -13,6 +19,7 @@ const remove = require('./commands/remove');
 const endpoint = require('./commands/endpoint');
 const config = require('./commands/config');
 const token = require('./commands/token');
+const update = require('./commands/update');
 
 // init program
 yargs
@@ -27,4 +34,5 @@ yargs
   .command(logs)
   .command(remove)
   .command(token)
-  .command(config).argv;
+  .command(config)
+  .command(update).argv;

src/util/checkUpdate.js

@@ -0,0 +1,36 @@
+// npm packages
+const chalk = require('chalk');
+const boxen = require('boxen');
+const updateNotifier = require('update-notifier');
+
+// boxen options
+const boxenOpts = {
+  padding: 1,
+  margin: 1,
+  align: 'center',
+  borderColor: 'yellow',
+  borderStyle: 'round',
+};
+// packaged script path
+const pkgPath = '/snapshot/exoframe-cli/src/util';
+
+// check function
+module.exports = pkg => {
+  // Checks for available update and returns an instance
+  const notifier = updateNotifier({
+    pkg,
+    updateCheckInterval: 1000,
+  });
+  // show message if update is available
+  if (notifier.update) {
+    const {update} = notifier;
+    const isPackaged = __dirname === pkgPath;
+    const upNpmMsg = `Run ${chalk.cyan('npm i -g exoframe')} to update`;
+    const upPkgMsg = `Download from ${chalk.cyan('https://github.com/exoframejs/exoframe/releases')}`;
+    const upmsg = isPackaged ? upPkgMsg : upNpmMsg;
+    const message = `Update available ${chalk.dim(update.current)} ${chalk.reset(' → ')} ${chalk.green(
+      update.latest
+    )}\n${upmsg}`;
+    console.log(`\n${boxen(message, boxenOpts)}`);
+  }
+};

test/fixtures/cli.config.yml

@@ -1,4 +1,8 @@
 endpoint: 'http://localhost:8080'
+endpoints:
+  - endpoint: 'http://test.endpoint'
+    user: null
+    token: null
 token: test-token
 user:
   username: admin

test/index.js

@@ -7,6 +7,7 @@ const list = require('./list');
 const config = require('./config');
 const token = require('./token');
 const endpoint = require('./endpoint');
+const update = require('./update');
 
 // run tests
 login();
@@ -17,3 +18,4 @@ list();
 config();
 token();
 endpoint();
+update();

test/update.js

@@ -0,0 +1,131 @@
+// npm packages
+const tap = require('tap');
+const nock = require('nock');
+const sinon = require('sinon');
+
+// our packages
+const {handler: update} = require('../src/commands/update');
+const {userConfig, updateConfig} = require('../src/config');
+
+module.exports = () => {
+  // test update
+  tap.test('Should update traefik', t => {
+    // handle correct request
+    const updateServer = nock('http://localhost:8080')
+      .post('/update/traefik')
+      .reply(200, {updated: true});
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    update({target: 'traefik'}).then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(updateServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [['Updating traefik on:', 'http://localhost:8080'], ['Successfully updated traefik!']],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      updateServer.done();
+      t.end();
+    });
+  });
+
+  // test update
+  tap.test('Should update server', t => {
+    // handle correct request
+    const updateServer = nock('http://localhost:8080')
+      .post('/update/server')
+      .reply(200, {updated: true});
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    update({target: 'server'}).then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(updateServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [['Updating server on:', 'http://localhost:8080'], ['Successfully updated server!']],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      updateServer.done();
+      t.end();
+    });
+  });
+
+  // test update error
+  tap.test('Should display update error', t => {
+    // handle correct request
+    const response = {updated: false, error: 'Test error', log: 'log'};
+    const updateServer = nock('http://localhost:8080')
+      .post('/update/traefik')
+      .reply(500, response);
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    update({target: 'traefik'}).then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(updateServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Updating traefik on:', 'http://localhost:8080'],
+          ['Error updating traefik:', 'Test error'],
+          ['Update log:\n'],
+          ['log'],
+        ],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      updateServer.done();
+      t.end();
+    });
+  });
+
+  // test deauth
+  tap.test('Should deauth on 401', t => {
+    // copy original config for restoration
+    const originalConfig = Object.assign({}, userConfig);
+    // handle correct request
+    const updateServer = nock('http://localhost:8080')
+      .post(`/update/traefik`)
+      .reply(401);
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    update({target: 'traefik'}).then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(updateServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Updating traefik on:', 'http://localhost:8080'],
+          ['Error: authorization expired!', 'Please, relogin and try again.'],
+        ],
+        'Correct log output'
+      );
+      // check config
+      t.notOk(userConfig.user, 'Should not have user');
+      t.notOk(userConfig.token, 'Should not have token');
+      // restore console
+      console.log.restore();
+      // tear down nock
+      updateServer.done();
+      // restore original config
+      updateConfig(originalConfig);
+      t.end();
+    });
+  });
+};