Merge branch 'develop', prepare 3.2.0

Author: yamalight

docs/Basics.md

@@ -100,7 +100,7 @@ Config file has the following structure:
   },
   // rate-limit config
   // see "advanced topics" for more info
-  "rate-limit": {
+  "rateLimit": {
     // rate-limit time period
     "period": "1s",
     // request rate over given time period
@@ -110,7 +110,11 @@ Config file has the following structure:
   },
   // template to be used for project deployment
   // undefined by default, detected by server based on file structure
-  "template": "my-template"
+  "template": "my-template",
+  // basic auth, [optional]
+  // this field allows you to have basic auth to access your deployed service
+  // format is in user:pwhash
+  "basicAuth": "user:$apr1$$9Cv/OMGj$$ZomWQzuQbL.3TRCS81A1g/"
 }
 ```
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exoframe",
-  "version": "3.1.1",
+  "version": "3.2.0-dev",
   "description": "Exoframe is a self-hosted tool that allows simple one-command deployments using Docker",
   "main": "index.js",
   "repository": "git@github.com:exoframejs/exoframe.git",
@@ -15,6 +15,7 @@
     "package": "pkg --targets node8.11.3-linux-x64,node8.11.3-win-x64,node8.11.3-macos-x64 -o exoframe index.js"
   },
   "dependencies": {
+    "apache-md5": "^1.1.2",
     "boxen": "^2.0.0",
     "chalk": "^2.4.1",
     "cli-table": "^0.3.1",

src/commands/config.js

@@ -3,6 +3,7 @@ const fs = require('fs');
 const path = require('path');
 const chalk = require('chalk');
 const inquirer = require('inquirer');
+const md5 = require('apache-md5');
 
 const validate = input => input && input.length > 0;
 const filter = input => (input ? input.trim() : '');
@@ -45,6 +46,7 @@ exports.handler = async () => {
       average: 1,
       burst: 5,
     },
+    basicAuth: ''
   };
   try {
     fs.statSync(configPath);
@@ -161,6 +163,45 @@ exports.handler = async () => {
     default: defaultConfig.template,
     filter,
   });
+  prompts.push({
+    type: 'confirm',
+    name: 'basicAuth',
+    message: 'Add a basic auth user? [optional]:',
+  });
+
+  // prompts for recursive questions
+  const recursivePrompts = []
+  recursivePrompts.push({
+    type: 'input',
+    name: 'username',
+    message: 'Username for Basic Auth:',
+    filter,
+    validate,
+  });
+  recursivePrompts.push({
+    type: 'password',
+    name: 'password',
+    message: 'Password for Basic auth:',
+    filter,
+    validate,
+  });
+  recursivePrompts.push({
+    type: 'confirm',
+    name: 'askAgain',
+    message: 'Add another user?',
+    default: false,
+  });
+
+  const askForUsers = async users => {
+    const {username, password, askAgain} = await inquirer.prompt(recursivePrompts);
+    users.push({username, password});
+    if (askAgain) {
+      return askForUsers(users);
+    } else {
+      return users;
+    }
+  };
+
   // get values from user
   const {
     name,
@@ -175,7 +216,15 @@ exports.handler = async () => {
     hostname,
     restart,
     template,
+    basicAuth,
   } = await inquirer.prompt(prompts);
+
+  const users = [];
+
+  if (basicAuth) {
+    await askForUsers(users);
+  }
+
   // init config object
   const config = {name, restart};
   if (domain && domain.length) {
@@ -211,6 +260,13 @@ exports.handler = async () => {
   if (template && template.length) {
     config.template = template;
   }
+  if (users.length !== 0) {
+    config.basicAuth = users.reduce((acc, curr, index) => {
+      const delimeter = users.length - 1 === index ? '' : ',';
+      const pair = `${curr.username}:${md5(curr.password)}`;
+      return `${acc}${pair}${delimeter}`;
+    }, '');
+  }
 
   // write config
   fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8');

test/config.test.js

@@ -8,6 +8,7 @@ const path = require('path');
 const yaml = require('js-yaml');
 const sinon = require('sinon');
 const inquirer = require('inquirer');
+const md5 = require('apache-md5');
 
 // our packages
 const {handler: config} = require('../src/commands/config');
@@ -25,9 +26,26 @@ const configData = {
   ratelimitPeriod: 10,
   ratelimitAverage: 20,
   ratelimitBurst: 30,
+  basicAuth: true,
 };
+const users = [{
+  username: 'user1',
+  password: 'pass',
+  askAgain: true
+}, {
+  username: 'user2',
+  password: 'pass',
+  askAgain: false
+}];
 const configPath = path.join(process.cwd(), 'exoframe.json');
 
+const verifyBasicAuth = (input, actual) => {
+  actual.split(',').forEach((element, index) => {
+    const hash = element.split(':')[1]
+    expect(hash).toEqual(md5(input[index].password, hash))
+  });
+};
+
 beforeAll(() => {
   try {
     fs.statSync(configPath);
@@ -40,7 +58,10 @@ beforeAll(() => {
 // test config generation
 test('Should generate config file', done => {
   // stup inquirer answers
-  sinon.stub(inquirer, 'prompt').callsFake(() => Promise.resolve(configData));
+  sinon.stub(inquirer, 'prompt')
+  .onFirstCall().callsFake(() => Promise.resolve(configData))
+  .onSecondCall().callsFake(() => Promise.resolve(users[0]))
+  .onThirdCall().callsFake(() => Promise.resolve(users[1]));
   // spy on console
   const consoleSpy = sinon.spy(console, 'log');
   // execute login
@@ -64,6 +85,7 @@ test('Should generate config file', done => {
       average: configData.ratelimitAverage,
       burst: configData.ratelimitBurst,
     });
+    verifyBasicAuth(users, cfg.basicAuth);
     // restore inquirer
     inquirer.prompt.restore();
     // restore console