/* * This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ /* * Copyright 2015 Joyent, Inc. * * The `triton` CLI class. */ var assert = require('assert-plus'); var bunyan = require('bunyan'); var child_process = require('child_process'), spawn = child_process.spawn, exec = child_process.exec; var cmdln = require('cmdln'), Cmdln = cmdln.Cmdln; var fs = require('fs'); var mkdirp = require('mkdirp'); var util = require('util'), format = util.format; var path = require('path'); var vasync = require('vasync'); var common = require('./common'); var mod_config = require('./config'); var errors = require('./errors'); var tritonapi = require('./tritonapi'); //---- globals var pkg = require('../package.json'); var CONFIG_DIR = path.resolve(process.env.HOME, '.triton'); var OPTIONS = [ { names: ['help', 'h'], type: 'bool', help: 'Print this help and exit.' }, { name: 'version', type: 'bool', help: 'Print version and exit.' }, { names: ['verbose', 'v'], type: 'bool', help: 'Verbose/debug output.' }, { names: ['profile', 'p'], type: 'string', env: 'TRITON_PROFILE', helpArg: 'NAME', help: 'Triton client profile to use.' }, { group: 'CloudAPI Options' }, /* * Environment variable integration. * * While dashdash supports integrated envvar parsing with options * we don't use that with `triton` because (a) we want to apply *option* * usage (but not envvars) to profiles other than the default 'env' * profile, and (b) we want to support `TRITON_*` *and* `SDC_*` envvars, * which dashdash doesn't support. * * See for some details. */ { names: ['account', 'a'], type: 'string', help: 'Account (login name). Environment: TRITON_ACCOUNT=ACCOUNT ' + 'or SDC_ACCOUNT=ACCOUNT.', helpArg: 'ACCOUNT' }, { names: ['user', 'u'], type: 'string', help: 'RBAC user (login name). Environment: TRITON_USER=USER ' + 'or SDC_USER=USER.', helpArg: 'USER' }, // TODO: full rbac support //{ // names: ['role'], // type: 'arrayOfString', // env: 'MANTA_ROLE', // help: 'Assume a role. Use multiple times or once with a list', // helpArg: 'ROLE,ROLE,...' //}, { names: ['keyId', 'k'], type: 'string', help: 'SSH key fingerprint. Environment: TRITON_KEY_ID=FINGERPRINT ' + 'or SDC_KEY_ID=FINGERPRINT.', helpArg: 'FINGERPRINT' }, { names: ['url', 'U'], type: 'string', help: 'CloudAPI URL. Environment: TRITON_URL=URL or SDC_URL=URL.', helpArg: 'URL' }, { names: ['J'], type: 'string', hidden: true, help: 'Joyent Public Cloud (JPC) datacenter name. This is ' + 'a shortcut to the "https://$dc.api.joyent.com" ' + 'cloudapi URL.' }, { names: ['insecure', 'i'], type: 'bool', help: 'Do not validate the CloudAPI SSL certificate. Environment: ' + 'TRITON_TLS_INSECURE=1, SDC_TLS_INSECURE=1 (or the deprecated ' + 'SDC_TESTING=1).', 'default': false } ]; //---- CLI class function CLI() { Cmdln.call(this, { name: 'triton', desc: pkg.description, options: OPTIONS, helpOpts: { includeEnv: true, minHelpCol: 30 }, helpSubcmds: [ 'help', 'profiles', 'profile', { group: 'Other Commands' }, 'info', 'account', 'keys', 'services', 'datacenters', { group: 'Instances (aka VMs/Machines/Containers)' }, 'create-instance', 'instances', 'instance', 'instance-audit', 'start-instance', 'stop-instance', 'reboot-instance', 'delete-instance', 'wait-instance', 'ssh', { group: 'Images' }, 'images', 'image', { group: 'Packages' }, 'packages', 'package', { group: 'Networks' }, 'networks', 'network' ], helpBody: [ /* BEGIN JSSTYLED */ 'Exit Status:', ' 0 Successful completion.', ' 1 An error occurred.', ' 2 Usage error.', ' 3 "ResourceNotFound" error. Returned when an instance, image,', ' package, etc. with the given name or id is not found.' /* END JSSTYLED */ ].join('\n') }); } util.inherits(CLI, Cmdln); CLI.prototype.init = function (opts, args, callback) { var self = this; this.opts = opts; if (opts.version) { console.log(this.name, pkg.version); callback(false); return; } this.log = bunyan.createLogger({ name: this.name, serializers: bunyan.stdSerializers, stream: process.stderr, level: 'warn' }); if (opts.verbose) { this.log.level('trace'); this.log.src = true; this.showErrStack = true; } if (opts.url && opts.J) { callback(new errors.UsageError( 'cannot use both "--url" and "-J" options')); } else if (opts.J) { opts.url = format('https://%s.api.joyent.com', opts.J); } this.configDir = CONFIG_DIR; this.__defineGetter__('tritonapi', function () { if (self._tritonapi === undefined) { var config = mod_config.loadConfig({ configDir: self.configDir }); self.log.trace({config: config}, 'loaded config'); var profileName = opts.profile || config.profile || 'env'; var profile = mod_config.loadProfile({ configDir: self.configDir, name: profileName }); self._applyProfileOverrides(profile); self.log.trace({profile: profile}, 'loaded profile'); self._tritonapi = tritonapi.createClient({ log: self.log, profile: profile, config: config }); } return self._tritonapi; }); // Cmdln class handles `opts.help`. Cmdln.prototype.init.apply(this, arguments); }; /* * Apply overrides from CLI options to the given profile object *in place*. */ CLI.prototype._applyProfileOverrides = function _applyProfileOverrides(profile) { var self = this; ['account', 'user', 'url', 'keyId', 'insecure'].forEach(function (field) { // We need to check `opts._order` to know if boolean opts // were specified. var specified = self.opts._order.filter( function (opt) { return opt.key === field; }).length > 0; if (specified) { profile[field] = self.opts[field]; } }); }; // Meta CLI.prototype.do_completion = require('./do_completion'); CLI.prototype.do_profiles = require('./do_profiles'); CLI.prototype.do_profile = require('./do_profile'); CLI.prototype.do_env = require('./do_env'); // Other CLI.prototype.do_account = require('./do_account'); CLI.prototype.do_services = require('./do_services'); CLI.prototype.do_datacenters = require('./do_datacenters'); CLI.prototype.do_info = require('./do_info'); CLI.prototype.do_keys = require('./do_keys'); // Images CLI.prototype.do_images = require('./do_images'); CLI.prototype.do_image = require('./do_image'); // Instances (aka VMs/containers/machines) CLI.prototype.do_instance = require('./do_instance'); CLI.prototype.do_instances = require('./do_instances'); CLI.prototype.do_create_instance = require('./do_create_instance'); CLI.prototype.do_instance_audit = require('./do_instance_audit'); CLI.prototype.do_stop_instance = require('./do_startstop_instance')('stop'); CLI.prototype.do_start_instance = require('./do_startstop_instance')('start'); CLI.prototype.do_reboot_instance = require('./do_startstop_instance')('reboot'); CLI.prototype.do_delete_instance = require('./do_startstop_instance')({action: 'delete', aliases: ['rm']}); CLI.prototype.do_wait_instance = require('./do_wait_instance'); CLI.prototype.do_ssh = require('./do_ssh'); // Packages CLI.prototype.do_packages = require('./do_packages'); CLI.prototype.do_package = require('./do_package'); // Networks CLI.prototype.do_networks = require('./do_networks'); CLI.prototype.do_network = require('./do_network'); // Hidden commands CLI.prototype.do_cloudapi = require('./do_cloudapi'); CLI.prototype.do_badger = require('./do_badger'); CLI.prototype.do_rbac = require('./do_rbac'); //---- mainline function main(argv) { if (!argv) { argv = process.argv; } var cli = new CLI(); cli.main(argv, function (err, subcmd) { var exitStatus = (err ? err.exitStatus || 1 : 0); var showErr = (cli.showErr !== undefined ? cli.showErr : true); if (err && showErr) { var code = (err.body ? err.body.code : err.code) || err.restCode; if (code === 'NoCommand') { /* jsl:pass */ } else if (err.message !== undefined) { console.error('%s%s: error%s: %s', cli.name, (subcmd ? ' ' + subcmd : ''), (code ? format(' (%s)', code) : ''), (cli.showErrStack ? err.stack : err.message)); // If this is a usage error, attempt to show some usage info. if (['Usage', 'Option'].indexOf(code) !== -1 && subcmd) { var help = cli.helpFromSubcmd(subcmd); if (help && typeof (help) === 'string') { // Would like a shorter synopsis. Attempt to // parse it down, somewhat generally. Unfortunately this // doesn't work for multi-level subcmds, like // `triton rbac subcmd ...`. var usageIdx = help.indexOf('\nUsage:'); if (usageIdx !== -1) { help = help.slice(usageIdx); } console.error(help); } } } } process.exit(exitStatus); }); } //---- exports module.exports = { CONFIG_DIR: CONFIG_DIR, CLI: CLI, main: main };