Merge branch 'develop', prepare 0.15.0

Author: yamalight

docs/Basics.md

@@ -14,6 +14,7 @@
 | list                   | List currently deployed projects |
 | rm [id]                | Remove existing deployment or project |
 | log [id]               | Get logs for existing deployment or project |
+| token                  | Generate new deployment token |
 | login                  | Login into Exoframe server |
 | endpoint [url]         | Gets or sets the endpoint of Exoframe server |
 | completion             | Generates bash completion script  |
@@ -61,3 +62,12 @@ Currently it contains endpoint URL and list of template plugins:
 ```yaml
 endpoint: 'http://localhost:8080' # your endpoint URL, defaults to localhost
 ```
+
+## Deployment tokens
+
+Sometimes you might need to deploy things from environments that don't have your private key (e.g. CI/CD services).   
+For this cases you can use deployment tokens. Here's how it works:
+
+1. Make sure you are logged in to your Exoframe server
+2. Generate new deployment token using `exoframe token` command
+3. Use the new token to deploy your service without need to authenticate: `exoframe deploy -t $TOKEN`

src/commands/deploy.js

@@ -37,13 +37,20 @@ const streamToResponse = ({tarStream, remoteUrl, options}) =>
 
 exports.command = ['*', 'deploy'];
 exports.describe = 'deploy current folder';
-exports.builder = {};
-exports.handler = async args => {
-  if (!isLoggedIn()) {
+exports.builder = {
+  token: {
+    alias: 't',
+  },
+};
+exports.handler = async (args = {}) => {
+  const deployToken = args.token;
+
+  // exit if not logged in and no token provided
+  if (!deployToken && !isLoggedIn()) {
     return;
   }
 
-  const folder = args && args._ ? args._.filter(arg => arg !== 'deploy').shift() : undefined;
+  const folder = args._ ? args._.filter(arg => arg !== 'deploy').shift() : undefined;
 
   console.log(chalk.bold(`Deploying ${folder || 'current project'} to endpoint:`), userConfig.endpoint);
 
@@ -52,6 +59,13 @@ exports.handler = async args => {
   const folderName = path.basename(workdir);
   const remoteUrl = `${userConfig.endpoint}/deploy`;
 
+  // make sure workdir exists
+  if (!fs.existsSync(workdir)) {
+    console.log(chalk.red(`Error! Path ${chalk.bold(workdir)} do not exists`));
+    console.log('Please, check your arguments and try again.');
+    return;
+  }
+
   // create config if doesn't exist
   const configPath = path.join(workdir, 'exoframe.json');
   try {
@@ -79,9 +93,14 @@ exports.handler = async args => {
     ignore: name => ig.ignores(name),
   });
 
+  let token = userConfig.token;
+  if (deployToken) {
+    token = deployToken;
+    console.log('Deploying using given token..');
+  }
   const options = {
     headers: {
-      Authorization: `Bearer ${userConfig.token}`,
+      Authorization: `Bearer ${token}`,
     },
   };
 

src/commands/login.js

@@ -17,10 +17,10 @@ exports.command = 'login';
 exports.describe = 'login into exoframe server';
 exports.builder = {
   key: {
-    short: 'k',
+    alias: 'k',
   },
   passphrase: {
-    short: 'p',
+    alias: 'p',
   },
 };
 exports.handler = async ({key, passphrase}) => {

src/commands/token.js

@@ -0,0 +1,46 @@
+// npm packages
+const got = require('got');
+const chalk = require('chalk');
+
+// our packages
+const {userConfig, isLoggedIn, logout} = require('../config');
+
+exports.command = ['token'];
+exports.describe = 'generate new deployment token';
+exports.builder = {};
+exports.handler = async () => {
+  if (!isLoggedIn()) {
+    return;
+  }
+
+  console.log(chalk.bold('Generating new deployment token for:'), userConfig.endpoint);
+
+  // services request url
+  const remoteUrl = `${userConfig.endpoint}/deployToken`;
+  // construct shared request params
+  const options = {
+    headers: {
+      Authorization: `Bearer ${userConfig.token}`,
+    },
+    json: true,
+  };
+  // try sending request
+  try {
+    const {body} = await got(remoteUrl, options);
+    const {token} = body;
+    console.log(chalk.bold('New token generated:'));
+    console.log('');
+    console.log(token);
+    console.log('');
+    console.log(chalk.yellow('WARNING!'), 'Make sure to write it down, you will not be able to get it again!');
+  } 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;
+    }
+
+    console.log(chalk.red('Error generating deployment token:'), e.toString());
+  }
+};

src/index.js

@@ -1,6 +1,9 @@
 // npm packages
 const yargs = require('yargs');
 
+// version
+const pkg = require('../package.json');
+
 // our packages
 const login = require('./commands/login');
 const deploy = require('./commands/deploy');
@@ -9,10 +12,11 @@ const logs = require('./commands/logs');
 const remove = require('./commands/remove');
 const endpoint = require('./commands/endpoint');
 const config = require('./commands/config');
+const token = require('./commands/token');
 
 // init program
 yargs
-  .version('0.7.0')
+  .version(pkg.version)
   .completion('completion')
   .demand(1)
   .help()
@@ -22,4 +26,5 @@ yargs
   .command(list)
   .command(logs)
   .command(remove)
+  .command(token)
   .command(config).argv;

test/config.js

@@ -53,6 +53,8 @@ module.exports = () => {
       inquirer.prompt.restore();
       // restore console
       console.log.restore();
+      // remove corrupted config
+      fs.unlinkSync(configPath);
       t.end();
     });
   });

test/deploy.js

@@ -104,6 +104,47 @@ module.exports = () => {
     });
   });
 
+  // test
+  tap.test('Should deploy without auth but with token', t => {
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // copy original config for restoration
+    const originalConfig = Object.assign({}, userConfig);
+
+    // handle correct request
+    const deployServer = nock('http://localhost:8080').post('/deploy').reply((uri, requestBody, cb) => {
+      cb(null, [200, {status: 'success', deployments}]);
+    });
+
+    // remove auth from config
+    updateConfig({endpoint: 'http://localhost:8080'});
+
+    // execute login
+    deploy({token: 'test-token'}).then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(deployServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Deploying current project to endpoint:', 'http://localhost:8080'],
+          ['Deploying using given token..'],
+          ['Your project is now deployed as:\n'],
+          ['   ID         URL                    Hostname   \n   test       http://localhost       test       '],
+        ],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      // tear down nock
+      deployServer.done();
+      // restore original config
+      updateConfig(originalConfig);
+      t.end();
+    });
+  });
+
   // test
   tap.test('Should not deploy with broken config', t => {
     // spy on console
@@ -129,6 +170,29 @@ module.exports = () => {
     });
   });
 
+  // test
+  tap.test('Should not deploy with non-existent path', t => {
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+
+    // execute deploy
+    deploy({_: ['i-do-not-exist']}).then(() => {
+      // check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Deploying i-do-not-exist to endpoint:', 'http://localhost:8080'],
+          [`Error! Path ${path.join(process.cwd(), 'i-do-not-exist')} do not exists`],
+          ['Please, check your arguments and try again.'],
+        ],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      t.end();
+    });
+  });
+
   // test
   tap.test('Should deauth on 401', t => {
     // copy original config for restoration

test/index.js

@@ -5,6 +5,7 @@ const deploy = require('./deploy');
 const logs = require('./logs');
 const list = require('./list');
 const config = require('./config');
+const token = require('./token');
 
 // run tests
 login();
@@ -13,3 +14,4 @@ deploy();
 logs();
 list();
 config();
+token();

test/token.js

@@ -0,0 +1,73 @@
+// npm packages
+const tap = require('tap');
+const nock = require('nock');
+const sinon = require('sinon');
+
+// our packages
+const {handler: token} = require('../src/commands/token');
+const {userConfig, updateConfig} = require('../src/config');
+
+module.exports = () => {
+  // test removal
+  tap.test('Should generate token', t => {
+    // handle correct request
+    const tokenServer = nock('http://localhost:8080').get('/deployToken').reply(200, {token: 'test'});
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    token().then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(tokenServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Generating new deployment token for:', 'http://localhost:8080'],
+          ['New token generated:'],
+          [''],
+          ['test'],
+          [''],
+          ['WARNING!', 'Make sure to write it down, you will not be able to get it again!'],
+        ],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      tokenServer.done();
+      t.end();
+    });
+  });
+
+  // test
+  tap.test('Should deauth on 401', t => {
+    // copy original config for restoration
+    const originalConfig = Object.assign({}, userConfig);
+    // handle correct request
+    const tokenServer = nock('http://localhost:8080').get('/deployToken').reply(401);
+    // spy on console
+    const consoleSpy = sinon.spy(console, 'log');
+    // execute login
+    token().then(() => {
+      // make sure log in was successful
+      // check that server was called
+      t.ok(tokenServer.isDone());
+      // first check console output
+      t.deepEqual(
+        consoleSpy.args,
+        [
+          ['Generating new deployment token for:', 'http://localhost:8080'],
+          ['Error: authorization expired!', 'Please, relogin and try again.'],
+        ],
+        'Correct log output'
+      );
+      // restore console
+      console.log.restore();
+      // tear down nock
+      tokenServer.done();
+      // restore original config
+      updateConfig(originalConfig);
+      t.end();
+    });
+  });
+};