Merge branch 'develop', prepare 5.1 release

Author: yamalight

.gitignore

@@ -8,3 +8,5 @@ exoframe-win.exe
 .idea/
 .DS_Store
 
+package-lock.json
+exoframe.json

docs/Basics.md

@@ -86,6 +86,8 @@ All of the configuration for the deployed projects is done using `exoframe.json`
 It can either be generated/updated using `exoframe config` (or `exoframe init`) command or created manually.
 If it doesn't exist during deployment, Exoframe will generate simple config file that only contains name of the current project.
 
+You can also tell Exoframe to use alternative config file during deployment by supplying `--config` (or `-c`) flag, e.g.: `exoframe -c exoframe.dev.json`
+
 Config file has the following structure:
 
 ```js

package.json

@@ -1,6 +1,6 @@
 {
   "name": "exoframe",
-  "version": "5.0.0",
+  "version": "5.0.2-dev",
   "description": "Exoframe is a self-hosted tool that allows simple one-command deployments using Docker",
   "main": "index.js",
   "repository": "[email protected]:exoframejs/exoframe.git",
@@ -25,7 +25,7 @@
     "inquirer": "^6.5.0",
     "js-yaml": "^3.13.1",
     "jsonwebtoken": "^8.5.1",
-    "lodash": "^4.17.14",
+    "lodash": "^4.17.15",
     "multimatch": "^4.0.0",
     "open": "^6.4.0",
     "ora": "^3.4.0",
@@ -36,10 +36,10 @@
   "devDependencies": {
     "babel-eslint": "^10.0.2",
     "coveralls": "^3.0.5",
-    "eslint": "^6.0.1",
+    "eslint": "^6.1.0",
     "eslint-config-prettier": "^6.0.0",
     "eslint-config-standard": "^13.0.1",
-    "eslint-plugin-import": "^2.18.0",
+    "eslint-plugin-import": "^2.18.2",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-prettier": "^3.1.0",
     "eslint-plugin-promise": "^4.2.1",

src/commands/config.js

@@ -44,7 +44,10 @@ const volumeValidation = input => {
 
 const writeConfig = (configPath, newConfig) => {
   // init config object
-  const config = {name: newConfig.name, restart: newConfig.restart};
+  const config = {name: newConfig.name};
+  if (newConfig.restart && newConfig.restart.length) {
+    config.restart = newConfig.restart;
+  }
   if (newConfig.domain && newConfig.domain.length) {
     config.domain = newConfig.domain;
   }
@@ -116,59 +119,7 @@ const writeConfig = (configPath, newConfig) => {
   console.log(chalk.green('Config created!'));
 };
 
-exports.command = ['config', 'init'];
-exports.describe = 'generate new config file for current project';
-exports.builder = {
-  func: {
-    alias: 'f',
-    description: 'generate a new config for function deployment',
-  },
-};
-exports.handler = async ({func} = {}) => {
-  const workdir = process.cwd();
-  const folderName = path.basename(workdir);
-  const configPath = path.join(workdir, 'exoframe.json');
-  let defaultConfig = {
-    name: folderName,
-    domain: '',
-    project: '',
-    restart: 'on-failure:2',
-    env: undefined,
-    labels: undefined,
-    hostname: '',
-    template: '',
-    rateLimit: {
-      period: '1s',
-      average: 1,
-      burst: 5,
-    },
-    basicAuth: false,
-    function: false,
-  };
-  try {
-    fs.statSync(configPath);
-    console.log(chalk.green('Config already exists! Editing..'));
-    defaultConfig = JSON.parse(fs.readFileSync(configPath).toString());
-  } catch (e) {
-    // check if config didn't exist
-    if (e.message.includes('ENOENT')) {
-      console.log('Creating new config..');
-    } else {
-      // if there was any parsing error - show message and die
-      console.log(chalk.red('Error parsing existing config! Please make sure it is valid and try again.'));
-      return;
-    }
-  }
-
-  if (func) {
-    console.log('Creating new config for function deployment..');
-    // set function flag to true
-    defaultConfig.function = true;
-    // write config to file
-    writeConfig(configPath, defaultConfig);
-    return;
-  }
-
+const generatePrompts = defaultConfig => {
   // ask user for values
   // generate and show choices
   const prompts = [];
@@ -180,19 +131,47 @@ exports.handler = async ({func} = {}) => {
     validate,
     filter,
   });
+
+  // function deployment part
+  prompts.push({
+    type: 'confirm',
+    name: 'function',
+    message: 'Deploy as function? [optional]:',
+    default: Boolean(defaultConfig.function),
+  });
+  prompts.push({
+    type: 'input',
+    name: 'functionType',
+    message: 'Function type [http, worker, trigger, custom]:',
+    default: defaultConfig.function && defaultConfig.function.type ? defaultConfig.function.type : 'http',
+    filter,
+    when: answers => answers.function,
+  });
+  prompts.push({
+    type: 'input',
+    name: 'functionRoute',
+    message: 'Function route [optional]:',
+    default: defaultConfig.function && defaultConfig.function.route ? defaultConfig.function.route : '',
+    filter,
+    when: answers => answers.function,
+  });
+
+  // default stuff
   prompts.push({
     type: 'input',
     name: 'domain',
     message: 'Domain [optional]:',
     default: defaultConfig.domain,
     filter,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
     name: 'project',
     message: 'Project [optional]:',
     default: defaultConfig.project,
     filter,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
@@ -205,6 +184,7 @@ exports.handler = async ({func} = {}) => {
       : '',
     filter,
     validate: pairValidation,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
@@ -217,6 +197,7 @@ exports.handler = async ({func} = {}) => {
       : '',
     filter,
     validate: pairValidation,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
@@ -225,12 +206,14 @@ exports.handler = async ({func} = {}) => {
     default: defaultConfig.volumes ? defaultConfig.volumes.join(', ') : '',
     filter,
     validate: volumeValidation,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'confirm',
     name: 'enableRatelimit',
     message: 'Enable rate-limit? [optional]',
-    default: !!defaultConfig.rateLimit,
+    default: defaultConfig.rateLimit && defaultConfig.rateLimit.enabled,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
@@ -262,27 +245,31 @@ exports.handler = async ({func} = {}) => {
     message: 'Hostname [optional]:',
     default: defaultConfig.hostname,
     filter,
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'list',
     name: 'restart',
     message: 'Restart policy [optional]:',
     default: defaultConfig.restart,
-    choices: ['no', 'on-failure:2', 'always'],
+    choices: ['', 'no', 'on-failure:2', 'always'],
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
     name: 'template',
     message: 'Template [optional]:',
     default: defaultConfig.template,
     filter,
+    when: answers => !answers.function,
   });
   // docker image deployment part
   prompts.push({
     type: 'confirm',
     name: 'deployWithImage',
     message: 'Deploy using docker image? [optional]:',
     default: Boolean(defaultConfig.image),
+    when: answers => !answers.function,
   });
   prompts.push({
     type: 'input',
@@ -301,36 +288,13 @@ exports.handler = async ({func} = {}) => {
     when: ({deployWithImage}) => deployWithImage,
   });
 
-  // function deployment part
-  prompts.push({
-    type: 'confirm',
-    name: 'function',
-    message: 'Deploy as function? [optional]:',
-    default: Boolean(defaultConfig.function),
-  });
-  prompts.push({
-    type: 'input',
-    name: 'functionType',
-    message: 'Function type [http, worker, trigger, custom]:',
-    default: defaultConfig.function && defaultConfig.function.type ? defaultConfig.function.type : 'http',
-    filter,
-    when: answers => answers.function,
-  });
-  prompts.push({
-    type: 'input',
-    name: 'functionRoute',
-    message: 'Function route [optional]:',
-    default: defaultConfig.function && defaultConfig.function.route ? defaultConfig.function.route : '',
-    filter,
-    when: answers => answers.function,
-  });
-
   // basic auth part
   prompts.push({
     type: 'confirm',
     name: 'basicAuth',
     message: 'Add a basic auth user? [optional]:',
     default: Boolean(defaultConfig.basicAuth),
+    when: answers => !answers.function,
   });
   // prompts for recursive questions
   const recursivePrompts = [];
@@ -365,12 +329,110 @@ exports.handler = async ({func} = {}) => {
     }
   };
 
-  // get values from user
-  const newConfig = await inquirer.prompt(prompts);
+  return {prompts, askForUsers};
+};
 
-  // update users for auth if needed
-  if (newConfig.basicAuth) {
-    newConfig.users = await askForUsers();
+exports.command = ['config', 'init'];
+exports.describe = 'generate new config file for current project';
+exports.builder = {
+  func: {
+    alias: 'f',
+    description: 'generate a new config for function deployment',
+  },
+  domain: {
+    alias: 'd',
+    description: 'sets the domain (enables non-interactive mode)',
+  },
+  project: {
+    alias: 'p',
+    description: 'sets the project name (enables non-interactive mode)',
+  },
+  name: {
+    alias: 'n',
+    description: 'sets the name (enables non-interactive mode)',
+  },
+  restart: {
+    alias: 'r',
+    description: 'sets the restart option (enables non-interactive mode)',
+  },
+  hostname: {
+    description: 'sets the hostname (enables non-interactive mode)',
+  },
+};
+exports.handler = async ({_, $0, func, ...args} = {}) => {
+  const workdir = process.cwd();
+  const folderName = path.basename(workdir);
+  const nonInteractive = Object.keys(args).some(key => args[key].length > 0);
+  const configPath = path.join(workdir, 'exoframe.json');
+  let defaultConfig = {
+    name: folderName,
+    domain: '',
+    project: '',
+    restart: '',
+    env: undefined,
+    labels: undefined,
+    hostname: '',
+    template: '',
+    rateLimit: {
+      enabled: false,
+      period: '1s',
+      average: 1,
+      burst: 5,
+    },
+    basicAuth: false,
+    function: false,
+  };
+  try {
+    fs.statSync(configPath);
+    console.log(chalk.green('Config already exists! Editing..'));
+    defaultConfig = JSON.parse(fs.readFileSync(configPath).toString());
+  } catch (e) {
+    // check if config didn't exist
+    if (e.message.includes('ENOENT')) {
+      console.log('Creating new config..');
+    } else {
+      // if there was any parsing error - show message and die
+      console.log(chalk.red('Error parsing existing config! Please make sure it is valid and try again.'));
+      return;
+    }
+  }
+
+  if (func) {
+    console.log('Creating new config for function deployment..');
+    // set function flag to true
+    defaultConfig.function = true;
+    // write config to file
+    writeConfig(configPath, defaultConfig);
+    return;
+  }
+
+  let newConfig = defaultConfig;
+
+  if (nonInteractive) {
+    console.log(chalk.yellow('Mode changed to'), 'non-interactive');
+  }
+
+  const overrideFromArgument = (key, value) => {
+    if (!value) return;
+    console.log('Setting', chalk.red(key), 'to', chalk.yellow(value));
+    newConfig[key] = value;
+  };
+
+  overrideFromArgument('domain', args.domain);
+  overrideFromArgument('name', args.name);
+  overrideFromArgument('project', args.project);
+  overrideFromArgument('restart', args.restart);
+  overrideFromArgument('hostname', args.hostname);
+
+  if (!nonInteractive) {
+    const {prompts, askForUsers} = generatePrompts(defaultConfig);
+    // get values from user
+    newConfig = await inquirer.prompt(prompts);
+
+    // update users for auth if needed
+    if (newConfig.basicAuth) {
+      newConfig.users = await askForUsers();
+    }
   }
 
   writeConfig(configPath, {...defaultConfig, ...newConfig});