Merge branch 'develop', prepare 0.21.0

Author: yamalight

README.md

@@ -17,10 +17,10 @@ All the configuration of your projects happens automatically. So after running t
 
 Currently, Exoframe understands and can deploy the following project types:
 
-1. static html based projects - will be deployed using [nginx](http://hub.docker.com/_/nginx) image
-2. node.js based projects - will be deployed using [node:alpine](https://hub.docker.com/_/node) image
-3. docker based project - will be deployed using your [Dockerfile](https://docs.docker.com/engine/reference/builder/)
-4. docker-compose based project - will be deployed using your [docker-compose](https://docs.docker.com/compose/compose-file/) file
+1. Static html based projects - will be deployed using [nginx](http://hub.docker.com/_/nginx) image
+2. Node.js based projects - will be deployed using [Node:latest](https://hub.docker.com/_/node) image
+3. Docker based project - will be deployed using your [Dockerfile](https://docs.docker.com/engine/reference/builder/)
+4. Docker-Compose based project - will be deployed using your [docker-compose](https://docs.docker.com/compose/compose-file/) file
 
 To run Exoframe you need two parts - Exoframe CLI on your local machine and [Exoframe server](https://github.com/exoframejs/exoframe-server) on your server with Docker.
 

docs/Basics.md

@@ -17,6 +17,8 @@
 | token                  | Generate new deployment token |
 | login                  | Login into Exoframe server |
 | endpoint [url]         | Selects or adds the endpoint of Exoframe server |
+| rm-endpoint [url]      | Removes an existing endpoint of Exoframe server |
+| update [target]        | Gets current versions or updates given target |
 | completion             | Generates bash completion script  |
 
 ## Project config file

package.json

@@ -32,6 +32,7 @@
   },
   "devDependencies": {
     "coveralls": "^2.13.1",
+    "highland": "^2.11.1",
     "nock": "^9.0.14",
     "pkg": "^4.2.4",
     "proxyquire": "^1.8.0",

src/commands/deploy.js

@@ -16,36 +16,53 @@ const formatServices = require('../util/formatServices');
 
 const ignores = ['.git', 'node_modules'];
 
-const streamToResponse = ({tarStream, remoteUrl, options}) =>
+const streamToResponse = ({tarStream, remoteUrl, options, verbose}) =>
   new Promise((resolve, reject) => {
     // store error and result
     let error;
-    let result = '';
+    let result = {};
     // pipe stream to remote
     const stream = tarStream.pipe(got.stream.post(remoteUrl, options));
     // store output
-    stream.on('data', str => (result += str.toString()));
-    // listen for read stream end
-    stream.on('end', () => {
+    stream.on('data', str => {
+      const s = str.toString();
       try {
-        const res = JSON.parse(result);
-        // if stream had error - reject
-        if (error) {
-          // add response to allow access to body
-          error.response = res;
-          reject(error);
-          return;
+        const data = JSON.parse(s);
+        // always log info
+        if (data.level === 'info') {
+          verbose && console.log(chalk.blue('[info]'), data.message);
+          // if data has deployments info - assign it as result
+          if (data.deployments) {
+            result = data;
+          }
+        }
+        // log verbose if needed
+        data.level === 'verbose' && verbose > 1 && console.log(chalk.grey('[verbose]'), data.message);
+        // if error - store as error and log
+        if (data.level === 'error') {
+          verbose && console.log(chalk.red('[error]'), data.message);
+          verbose > 1 && console.log(JSON.stringify(data, null, 2));
+          error = new Error(data.message);
+          error.response = data;
         }
-        // otherwise resolve
-        resolve(res);
-      } catch (parseErr) {
-        // catch parsing error
-        // add response to allow access to body
-        parseErr.response = {result: {error: result, log: ['No log available']}};
-        reject(parseErr);
+      } catch (e) {
+        error = new Error('Error parsing output!');
+        error.response = {
+          error: s,
+        };
+        verbose && console.log(chalk.red('[error]'), 'Error parsing line:', s);
+      }
+    });
+    // listen for read stream end
+    stream.on('end', () => {
+      // if stream had error - reject
+      if (error) {
+        reject(error);
+        return;
       }
+      // otherwise resolve
+      resolve(result);
     });
-    // listen for stream errors
     stream.on('error', e => (error = e));
   });
 
@@ -67,6 +84,7 @@ exports.builder = {
   verbose: {
     alias: 'v',
     description: 'Verbose mode; will output more information',
+    count: true,
   },
 };
 exports.handler = async (args = {}) => {
@@ -110,13 +128,16 @@ exports.handler = async (args = {}) => {
   }
 
   // show loader
-  const spinner = ora('Uploading project to server...').start();
+  let spinner;
+  if (!verbose) {
+    spinner = ora('Deploying project to server...').start();
+  }
 
   // syntax-check config
   try {
     JSON.parse(fs.readFileSync(configPath));
   } catch (e) {
-    spinner.fail('Your exoframe.json is not valid');
+    spinner && spinner.fail('Your exoframe.json is not valid');
     console.log(chalk.red('Please, check your config and try again:'), e.toString());
     return;
   }
@@ -132,7 +153,7 @@ exports.handler = async (args = {}) => {
   let token = userConfig.token;
   if (deployToken) {
     token = deployToken;
-    console.log('Deploying using given token..');
+    console.log('\nDeploying using given token..');
   }
   const options = {
     headers: {
@@ -143,13 +164,18 @@ exports.handler = async (args = {}) => {
   // pipe stream to remote
   try {
     const res = await streamToResponse({tarStream, remoteUrl, options, verbose});
-    // if in verbose mode - log response
-    verbose && console.log('\nGot response from server:', res);
     // check deployments
     if (!res.deployments || !res.deployments.length) {
-      throw new Error('Something went wrong!');
+      const err = new Error('Something went wrong!');
+      err.response = res;
+      throw err;
     }
-    spinner.succeed('Upload finsihed!');
+    spinner && spinner.succeed('Upload finsihed!');
+
+    // log response in verbose-verbose mode
+    verbose > 2 && console.log(chalk.gray('Server response:'), JSON.stringify(res, null, 2), '\n');
+
+    // log result
     console.log('Your project is now deployed as:\n');
     // create table
     const resultTable = new Table({
@@ -172,7 +198,7 @@ exports.handler = async (args = {}) => {
       opn(`http://${formattedServices[0].domain.split(',')[0].trim()}`);
     }
   } catch (e) {
-    spinner.fail('Deployment failed!');
+    spinner && spinner.fail('Deployment failed!');
     // if authorization is expired/broken/etc
     if (e.statusCode === 401) {
       logout(userConfig);
@@ -181,20 +207,18 @@ exports.handler = async (args = {}) => {
     }
 
     const response = e.response || {};
-    const reason = response.result ? response.result.error : e.toString();
+    const reason = response.error || e.toString();
     console.log(chalk.red('Error deploying project:'), reason || 'Unknown reason');
     console.log('Build log:\n');
-    response.result
-      ? (response.result.log || ['No log available'])
-          .filter(l => l !== undefined)
-          .map(l => l.trim())
-          .filter(l => l && l.length > 0)
-          .forEach(line => console.log(line))
-      : console.log('No log available');
+    (response.log || ['No log available'])
+      .filter(l => l !== undefined)
+      .map(l => l.trim())
+      .filter(l => l && l.length > 0)
+      .forEach(line => console.log(line));
 
     // if in verbose mode - log original error and response
     verbose && console.log('');
     verbose && console.log('Original error:', e);
-    verbose && console.log('Original response:', e.response);
+    verbose > 1 && console.log('Original response:', e.response);
   }
 };

test/deploy.js

@@ -5,6 +5,8 @@ const path = require('path');
 const nock = require('nock');
 const sinon = require('sinon');
 const proxyquire = require('proxyquire');
+const _ = require('highland');
+const {Readable} = require('stream');
 
 // our packages
 const {userConfig, updateConfig} = require('../src/config');
@@ -15,6 +17,14 @@ const opnStub = sinon.spy();
 // require deploy with stub for opn
 const {handler: deploy} = proxyquire('../src/commands/deploy', {opn: opnStub});
 
+// reply with stream helper
+const replyWithStream = dataArr => {
+  const replyStream = _();
+  dataArr.forEach(data => replyStream.write(JSON.stringify(data)));
+  replyStream.end('');
+  return new Readable().wrap(replyStream);
+};
+
 module.exports = () => {
   const folder = 'test_html_project';
   const folderPath = path.join('test', 'fixtures', folder);
@@ -47,13 +57,13 @@ module.exports = () => {
     // handle correct request
     const deployServer = nock('http://localhost:8080')
       .post('/deploy')
-      .reply((uri, requestBody, cb) => {
+      .reply((uri, requestBody) => {
         const excgf = fs.readFileSync(path.join(testFolder, 'exoframe.json'));
         const index = fs.readFileSync(path.join(testFolder, 'index.html'));
         t.ok(requestBody.includes(excgf), 'Should send correct config');
         t.ok(requestBody.includes(index), 'Should send correct index file');
 
-        cb(null, [200, {status: 'success', deployments}]);
+        return replyWithStream([{message: 'Deployment success!', deployments, level: 'info'}]);
       });
 
     // execute login
@@ -87,9 +97,7 @@ module.exports = () => {
     // handle correct request
     const deployServer = nock('http://localhost:8080')
       .post('/deploy')
-      .reply((uri, requestBody, cb) => {
-        cb(null, [200, {status: 'success', deployments}]);
-      });
+      .reply(() => replyWithStream([{message: 'Deployment success!', deployments, level: 'info'}]));
 
     // execute login
     deploy().then(() => {
@@ -124,9 +132,7 @@ module.exports = () => {
     // handle correct request
     const deployServer = nock('http://localhost:8080')
       .post('/deploy')
-      .reply((uri, requestBody, cb) => {
-        cb(null, [200, {status: 'success', deployments}]);
-      });
+      .reply(() => replyWithStream([{message: 'Deployment success!', deployments, level: 'info'}]));
 
     // remove auth from config
     updateConfig({endpoint: 'http://localhost:8080'});
@@ -141,7 +147,7 @@ module.exports = () => {
         consoleSpy.args,
         [
           ['Deploying current project to endpoint:', 'http://localhost:8080'],
-          ['Deploying using given token..'],
+          ['\nDeploying using given token..'],
           ['Your project is now deployed as:\n'],
           ['   ID         URL             Hostname   \n   test       localhost       test       '],
         ],
@@ -165,9 +171,7 @@ module.exports = () => {
     // handle correct request
     const updateServer = nock('http://localhost:8080')
       .post('/update')
-      .reply((uri, requestBody, cb) => {
-        cb(null, [200, {status: 'success', deployments}]);
-      });
+      .reply(() => replyWithStream([{message: 'Deployment success!', deployments, level: 'info'}]));
 
     // execute login
     deploy({update: true}).then(() => {
@@ -200,9 +204,7 @@ module.exports = () => {
     // handle correct request
     const deployServer = nock('http://localhost:8080')
       .post('/deploy')
-      .reply((uri, requestBody, cb) => {
-        cb(null, [200, {status: 'success', deployments}]);
-      });
+      .reply(() => replyWithStream([{message: 'Deployment success!', deployments, level: 'info'}]));
 
     // execute
     deploy({open: true}).then(() => {
@@ -237,19 +239,16 @@ module.exports = () => {
     // handle correct request
     const deployServer = nock('http://localhost:8080')
       .post('/deploy')
-      .reply((uri, requestBody, cb) => {
-        cb(null, [
-          400,
+      .reply(() =>
+        replyWithStream([
           {
-            status: 'error',
-            result: {
-              error: 'Build failed! See build log for details.',
-              log: ['Error log', 'here'],
-              image: 'test:latest',
-            },
+            message: 'Build failed! See build log for details.',
+            error: 'Build failed! See build log for details.',
+            log: ['Error log', 'here'],
+            level: 'error',
           },
-        ]);
-      });
+        ])
+      );
 
     // execute
     deploy().then(() => {
@@ -331,37 +330,24 @@ module.exports = () => {
       t.ok(deployServer.isDone());
       // first check console output
       t.deepEqual(
-        consoleSpy.args,
+        // check beginning of log
+        consoleSpy.args.slice(0, consoleSpy.args.length - 1),
         [
           ['Deploying current project to endpoint:', 'http://localhost:8080'],
           ['\nIgnoring following paths:', ['.git', 'node_modules']],
+          ['[error]', 'Error parsing line:', 'Bad Gateway'],
           ['Error deploying project:', 'Bad Gateway'],
           ['Build log:\n'],
           ['No log available'],
           [''],
-          [
-            'Original error:',
-            {
-              response: {
-                result: {
-                  error: 'Bad Gateway',
-                  log: ['No log available'],
-                },
-              },
-            },
-          ],
-          [
-            'Original response:',
-            {
-              result: {
-                error: 'Bad Gateway',
-                log: ['No log available'],
-              },
-            },
-          ],
         ],
         'Correct log output'
       );
+      // check error correctness
+      const err = consoleSpy.args[consoleSpy.args.length - 1][1];
+      t.equal(err.message, 'Error parsing output!', 'Correct error text');
+      t.ok(err.response, 'Has response');
+      t.equal(err.response.error, 'Bad Gateway', 'Correct error response');
       // restore console
       console.log.restore();
       // tear down nock