144 lines
3.1 KiB
JavaScript
144 lines
3.1 KiB
JavaScript
/**
|
|
* Copyright (c) 2014, Joyent, Inc. All rights reserved.
|
|
*
|
|
* Error classes that the joyent CLI may produce.
|
|
*/
|
|
|
|
var util = require('util'),
|
|
format = util.format;
|
|
var assert = require('assert-plus');
|
|
var verror = require('verror'),
|
|
WError = verror.WError,
|
|
VError = verror.VError;
|
|
|
|
|
|
|
|
// ---- error classes
|
|
|
|
/**
|
|
* Base error. Instances will always have a string `message` and
|
|
* a string `code` (a CamelCase string).
|
|
*/
|
|
function SDCError(options) {
|
|
assert.object(options, 'options');
|
|
assert.string(options.message, 'options.message');
|
|
assert.string(options.code, 'options.code');
|
|
assert.optionalObject(options.cause, 'options.cause');
|
|
assert.optionalNumber(options.statusCode, 'options.statusCode');
|
|
var self = this;
|
|
|
|
var args = [];
|
|
if (options.cause) args.push(options.cause);
|
|
args.push(options.message);
|
|
WError.apply(this, args);
|
|
|
|
var extra = Object.keys(options).filter(
|
|
function (k) { return ['cause', 'message'].indexOf(k) === -1; });
|
|
extra.forEach(function (k) {
|
|
self[k] = options[k];
|
|
});
|
|
}
|
|
util.inherits(SDCError, VError);
|
|
|
|
function InternalError(cause, message) {
|
|
if (message === undefined) {
|
|
message = cause;
|
|
cause = undefined;
|
|
}
|
|
assert.string(message);
|
|
SDCError.call(this, {
|
|
cause: cause,
|
|
message: message,
|
|
code: 'InternalError',
|
|
exitStatus: 1
|
|
});
|
|
}
|
|
util.inherits(InternalError, SDCError);
|
|
|
|
|
|
/**
|
|
* CLI usage error
|
|
*/
|
|
function ConfigError(cause, message) {
|
|
if (message === undefined) {
|
|
message = cause;
|
|
cause = undefined;
|
|
}
|
|
assert.string(message);
|
|
SDCError.call(this, {
|
|
cause: cause,
|
|
message: message,
|
|
code: 'Config',
|
|
exitStatus: 1
|
|
});
|
|
}
|
|
util.inherits(ConfigError, SDCError);
|
|
|
|
|
|
/**
|
|
* CLI usage error
|
|
*/
|
|
function UsageError(cause, message) {
|
|
if (message === undefined) {
|
|
message = cause;
|
|
cause = undefined;
|
|
}
|
|
assert.string(message);
|
|
SDCError.call(this, {
|
|
cause: cause,
|
|
message: message,
|
|
code: 'Usage',
|
|
exitStatus: 1
|
|
});
|
|
}
|
|
util.inherits(UsageError, SDCError);
|
|
|
|
|
|
/**
|
|
* An error signing a request.
|
|
*/
|
|
function SigningError(cause) {
|
|
SDCError.call(this, {
|
|
cause: cause,
|
|
message: 'error signing request',
|
|
code: 'Signing',
|
|
exitStatus: 1
|
|
});
|
|
}
|
|
util.inherits(SigningError, SDCError);
|
|
|
|
|
|
/**
|
|
* Multiple errors in a group.
|
|
*/
|
|
function MultiError(errs) {
|
|
assert.arrayOfObject(errs, 'errs');
|
|
var lines = [format('multiple (%d) errors', errs.length)];
|
|
for (var i = 0; i < errs.length; i++) {
|
|
var err = errs[i];
|
|
lines.push(format(' error (%s): %s', err.code, err.message));
|
|
}
|
|
SDCError.call(this, {
|
|
cause: errs[0],
|
|
message: lines.join('\n'),
|
|
code: 'MultiError',
|
|
exitStatus: 1
|
|
});
|
|
}
|
|
MultiError.description = 'Multiple errors.';
|
|
util.inherits(MultiError, SDCError);
|
|
|
|
|
|
|
|
// ---- exports
|
|
|
|
module.exports = {
|
|
SDCError: SDCError,
|
|
InternalError: InternalError,
|
|
ConfigError: ConfigError,
|
|
UsageError: UsageError,
|
|
SigningError: SigningError,
|
|
MultiError: MultiError
|
|
};
|
|
// vim: set softtabstop=4 shiftwidth=4:
|