modulus/lib/routes/project.js

The command line interface for deploying applications to the Modulus hosting platform.

/*
 * Copyright (c) 2014 Modulus
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

module.exports = function (modulus) {
  var help = new modulus.help('Project', modulus);

  // list commands
  help.add('list', function () {
    this.line('project list (list)'.verbose);
    this.line('View all projects you have.'.input);
  });

  modulus.program
    .command('project list')
    .description('Lists all projects you currently have access to.')
    .on('--help', help.commands.list)
    .action(function () {
      modulus.runCommand(modulus.commands.project.list, true);
    });

  modulus.program
    .command('list')
    .description('Lists all projects you currently have access to.')
    .on('--help', help.commands.list)
    .action(function () {
      modulus.runCommand(modulus.commands.project.list, true);
    });

  // create command
  help.add('create', function () {
    this.line('project create <name>'.verbose);
    this.line('Creates a new project.'.input);
    this.line('A prompt for name will occur if none is specified.'.input);
    this.line('  options:'.input);
    this.line('    -s, --servo-size       Servo size for the new project [192, 396, 512, 1024, 2048].'.input);
    this.line('    -r, --runtime          Runtime for the new project [Node.js, PHP, Java, Static].'.input);
    this.line('    -o, --project-owner    Project owner username or organization name for the project.'.input);
  });

  modulus.program.option(
    '-s, --servo-size [value]',
    'Servo size for the new project [192, 396, 512, 1024, 2048]');

  modulus.program.option(
    '-r, --runtime [value]',
    'Runtime for the new project [Node.js, PHP, Java, Static]');

  modulus.program.option(
    '-o, --project-owner [value]',
    'Project owner for the new project');

  modulus.program
    .command('project create')
    .description('Creates a new project.')
    .on('--help', help.commands.create)
    .action(function (name) {
      if (typeof name !== 'string') {
        name = '';
      }
      modulus.runCommand(
        modulus.commands.project.create,
        [
          name,
          modulus.program.servoSize,
          modulus.program.runtime,
          modulus.program.projectOwner
        ],
        true);
    });

  // delete command
  help.add('delete', function () {
    this.line('project delete'.verbose);
    this.line('Deletes a project.'.input);
    this.line('A prompt for name will occur if none is specified.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to restart. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .command('project delete')
    .description('Deletes a project')
    .on('--help', help.commands.delete)
    .action(function() {
      modulus.runCommand(modulus.commands.project.delete, [modulus.program.projectName], true);
    });

  // resize command
  help.add('resize', function () {
    this.line('project resize'.verbose);
    this.line('Updates a project\'s servo size.'.input);
    this.line('Please note that the project must be stopped and started for the changes to take effect.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to resize. Prompts are skipped when specified.'.input);
    this.line('    -s, --servo-size      Servo size for the project [192, 396, 512, 1024, 2048].'.input);
  });

  modulus.program
    .command('project resize')
    .description('Updates a project\'s servo size.')
    .on('--help', help.commands.resize)
    .action(function () {
      modulus.runCommand(
        modulus.commands.project.resize,
        [
          modulus.program.projectName,
          modulus.program.servoSize
        ],
        true);
    });

  // restart command
  help.add('restart', function () {
    this.line('project restart'.verbose);
    this.line('Restarts a project.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to restart. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .command('project restart')
    .description('Restarts a running project.')
    .on('--help', help.commands.restart)
    .action(function () {
      modulus.runCommand(modulus.commands.project.restart, [modulus.program.projectName], true);
    });

  // stop command
  help.add('stop', function () {
    this.line('project stop'.verbose);
    this.line('Stops a running project'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to stop. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .command('project stop')
    .description('Stops a running project.')
    .on('--help', help.commands.stop)
    .action(function () {
      modulus.runCommand(modulus.commands.project.stop, [modulus.program.projectName], true);
    });

  // start command
  help.add('start', function () {
    this.line('project start'.verbose);
    this.line('Starts a project'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to start. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .command('project start')
    .description('Starts a stopped project.')
    .on('--help', help.commands.start)
    .action(function () {
      modulus.runCommand(modulus.commands.project.start, [modulus.program.projectName], true);
    });

  // deploy command
  help.add('deploy', function () {
    this.line('project deploy (deploy) [options] <directory>'.verbose);
    this.line('Deploys a directory\'s contents to the selected project.'.input);
    this.line('The current working directory is used if no directory is specified.'.input);
    this.line('By default a project type will be detected and any additional actions required will be taken.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name      Name of the project to deploy. Prompts are skipped when specified.'.input);
    this.line('    -m, --include-modules   Flag that indicates whether or not to include the node_modules folder in the bundle.'.input);
    this.line('    -r, --registry          Specify a registry to install modules from.'.input);
    this.line('    -w, --with-tests        Specifies that tests should be run before deploying this project.'.input);
    this.line('        --node-version       Specified version of node to use when running application.'.input);
    this.line('        --npm-version        Specified version of npm to use when building application.'.input);
    this.line('    -d, --debug             Specifies to pass the debug flag to demeteorizer.'.input);
  });

  modulus.program
    .option('-p, --project-name [value]', 'Name of the project to retrieve logs from. Prompts are skipped when specified', null)
    .option('-d, --download', 'Flag that signals to download the logs instead of printing them.')
    .option('-o, --output [value]', 'Specifies the file to download to. Must be file type tar.gz')
    .option('-m, --include-modules', 'Flag that indicates whether or not to include the node_modules folder in the bundle.')
    .option('-r, --registry [value]', 'Specify a registry to install modules from', '')
    .option('-w, --with-tests', 'Specifies that tests should be run before deploying this project.')
    .option('--node-version [value]', 'Specified version of node to use when running application..')
    .option('--npm-version [value]', 'Specified version of npm to use when building application.')
    .option('-d, --debug', 'Specifies to pass the debug flag to demeteorizer.')
    .option('-n, --node-env [value]', 'Specifies node version when running application using `modulus run`.');

  modulus.program
    .command('project deploy')
    .description('Deploys the current directory to selected project.')
    .on('--help', help.commands.deploy)
    .action(function (dir) {
      modulus.runCommand(
        modulus.commands.project.deploy,
        [
          modulus.program.projectName,
          dir,
          modulus.program.includeModules,
          modulus.program.registry,
          modulus.program.withTests,
          modulus.program.nodeVersion,
          modulus.program.npmVersion,
          modulus.program.debug
        ],
        true);
    });

  modulus.program
    .command('deploy')
    .description('Deploys the current directory to selected project.')
    .on('--help', help.commands.deploy)
    .action(function (dir) {
      modulus.runCommand(
        modulus.commands.project.deploy,
        [
          modulus.program.projectName,
          dir,
          modulus.program.includeModules,
          modulus.program.registry,
          modulus.program.withTests,
          modulus.program.nodeVersion,
          modulus.program.npmVersion,
          modulus.program.debug
        ],
        true);
    });

  function deployLogsHandler() {
    modulus.runCommand(
      modulus.commands.project.getDeployLogs,
      [
        modulus.program.projectName
      ],
      true);
  }

  // deployLogs command
  help.add('deployLogs', function () {
    this.line('project deployLogs'.verbose);
    this.line('Gets deploy logs for the selected project.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name   Name of the project to retrieve deploy logs from. Prompts are skipped when specified.'.input);
    this.line('');
  });

  modulus.program
    .command('project deployLogs')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.deployLogs();
    })
    .action(deployLogsHandler);

  // project deployLogs -> project deployLog alias
  modulus.program
    .command('project deployLog')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.deployLogs();
    })
    .action(deployLogsHandler);

  // project logs -> logs alias
  modulus.program
    .command('deployLogs')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.deployLogs();
    })
    .action(deployLogsHandler);

  // logs command
  help.add('logs', function () {
    this.line('project logs'.verbose);
    this.line('Gets logs for the selected project.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name   Name of the project to retrieve logs from. Prompts are skipped when specified.'.input);
    this.line('    -d, --download       Flag that signals to download the logs instead of printing them.'.input);
    this.line('    -o, --output         Specifies the file to download to. Must be file type tar.gz'.input);
    this.line('');
  });


  // help for logs clear command
  help.add('logClear', function () {
    this.line('project logs clear'.verbose);
    this.line('Cleans logs for the selected project.'.input);
  });

  var logsHandler = function (dir) {
    modulus.runCommand(
      modulus.commands.project.getLogs,
      [
        modulus.program.projectName,
        modulus.program.download,
        modulus.program.output,
        dir
      ],
      true);
  };

  modulus.program
    .command('project logs')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.logs();
      help.commands.logClear();
    })
    .action(logsHandler);

  // project logs -> project log alias
  modulus.program
    .command('project log')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.logs();
      help.commands.logClear();
    })
    .action(logsHandler);

  // project logs -> logs alias
  modulus.program
    .command('logs')
    .description('Gets logs for the selected project.')
    .on('--help', function () {
      help.commands.logs();
      help.commands.logClear();
    })
    .action(logsHandler);

  // log clear command
  modulus.program
    .command('project logs clear')
    .description('Clears logs for the selected project.')
    .on('--help', help.commands.logClear)
    .action(function () {
      modulus.runCommand(modulus.commands.project.clearLogs, [modulus.program.projectName], true);
    });

  // project logs clear -> logs clear alias
  modulus.program
    .command('logs clear')
    .description('Clears logs for the selected project.')
    .on('--help', help.commands.logClear)
    .action(function () {
      modulus.runCommand(modulus.commands.project.clearLogs, [modulus.program.projectName], true);
    });

  // log stream command
  help.add('logStream', function () {
    this.line('project logs tail'.verbose);
    this.line('Streams logs for the selected project.'.input);
    this.line('  options:'.input);
    this.line('    -S, --servo    Index of a specific servo to tail. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .option('-S, --servo [value]', 'Index of a specific servo to tail. Prompts are skipped when specified.');

  modulus.program
    .command('project logs tail')
    .description('Streams logs for the selected project.')
    .on('--help', help.commands.logStream)
    .action(function () {
      modulus.runCommand(modulus.commands.project.streamLogs, [modulus.program.projectName, modulus.program.servo], true);
    });

  // project logs tail -> logs tail alias
  modulus.program
    .command('logs tail')
    .description('Streams logs for the selected project.')
    .on('--help', help.commands.logStream)
    .action(function () {
      modulus.runCommand(modulus.commands.project.streamLogs, [modulus.program.projectName, modulus.program.servo], true);
    });

  // scale command
  help.add('scale', function () {
    this.line('project scale <servos>'.verbose);
    this.line('Scales a project to use the number of servos given.'.input);
    this.line('    -p, --project-name   Name of the project to scale. Prompts are skipped when specified.'.input);
  });

  modulus.program
    .option('-p, --project-name [value]', 'Name of the project to scale. Prompts are skipped when specified');

  modulus.program
    .command('project scale')
    .description('Scales a project to the number of servos specified.')
    .on('--help', help.commands.scale)
    .action(function () {
      var args = Array.prototype.slice.call(arguments);
      args.pop(); // remove last element, it's always internal commander stuff.
      modulus.runCommand(modulus.commands.project.scale, [args, modulus.program.projectName], true);
    });

  help.add('run', function() {
    this.line('project run (run)'.verbose);
    this.line('Run your node application locally with your environment variables.'.input);
    this.line('Please note you must be within your applications root directory.'.input);
    this.line('A main file must be specified in the package.json'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name    Name of the project to obtain env vars. Prompts are skipped when specified.'.input);
    this.line('    -n, --node-env        Name of the node environment to run the application under. Defaults to "development".'.input);
  });

  modulus.program
    .command('run')
    .description('Run your node application locally with your environment variables. Please note you must be within your applications root directory')
    .on('--help', help.commands.run)
    .action(function(envVars) {
      modulus.runCommand(modulus.commands.project.runApp, [modulus.program.projectName, modulus.program.nodeEnv], true);
    });

  modulus.program
    .command('project run')
    .description('Run your node application locally with your environment variables. Please note you must be within your applications root directory')
    .on('--help', help.commands.run)
    .action(function(envVars) {
      modulus.runCommand(modulus.commands.project.runApp, [modulus.program.projectName, modulus.program.nodeEnv], true);
    });
  help.add('open', function () {
    this.line('project open'.verbose);
    this.line('Opens a project\'s URL in your browser.'.input);
  });

  modulus.program
    .command('project open')
    .description('Open a project\'s URL in your browser.')
    .on('--help', help.commands.open)
    .action(function () {
      modulus.runCommand(modulus.commands.project.open, [modulus.program.projectName], true);
    });

  help.add('download', function () {
    this.line('project download'.verbose);
    this.line('Gets source for the selected project.'.input);
    this.line('  options:'.input);
    this.line('    -p, --project-name   Name of the project to retrieve logs from. Prompts are skipped when specified.'.input);
    this.line('    -o, --output         Specifies the file to download to. Must be file type zip'.input);
    this.line('');
  });

  modulus.program
    .command('project download')
    .description('Gets source for the selected project.')
    .on('--help', function () {
      help.commands.download();
    })
    .action(function () {
      modulus.runCommand(
        modulus.commands.project.download,
        [modulus.program.projectName, modulus.program.output],
        true
      );
    });

  // Generic help for project commands
  modulus.program
    .command('project')
    .description('Lists available project commands.')
    .on('--help', help.getPrinter())
    .action(help.getPrinter());

  return {
    base : 'project',
    help : help
  };
};