@crestron/ch5-utilities-cli
Version:
CH5 Utilities CLI for archiving and distribution
259 lines (258 loc) • 13.9 kB
JavaScript
"use strict";
// Copyright (C) 2018 to the present, Crestron Electronics, Inc.
// All rights reserved.
// No part of this software may be reproduced in any form, machine
// or natural, without the express written consent of Crestron Electronics.
// Use of this source code is subject to the terms of the Crestron Software License Agreement
// under which you licensed this source code.
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Ch5DeployCli = void 0;
var path_1 = __importDefault(require("path"));
var ch5_utilities_1 = require("@crestron/ch5-utilities");
var Ch5CliUtil_1 = require("./Ch5CliUtil");
var inquirer = require('inquirer');
var Ch5DeployCli = /** @class */ (function () {
function Ch5DeployCli() {
this._cliUtil = new Ch5CliUtil_1.Ch5CliUtil();
}
Ch5DeployCli.prototype.setupDeployCommand = function (program) {
var _this = this;
program
.command('deploy <archive>')
.option("-H, --deviceHost <deviceHost>", "Device host or IP. Required.")
.option("-t, --deviceType <deviceType>", "Device type, value in [touchscreen, controlsystem, web, mobile]. Required.", /^(touchscreen|controlsystem|web|mobile)$/i)
.option("-d, --deviceDirectory <deviceDirectory>", "Device target deploy directory. Defaults to 'display' when deviceType is touchscreen, to 'HTML' when deviceType is controlsystem/web/mobile. Optional.")
.option("-p, --prompt-for-credentials", "Prompt for credentials. Optional.")
.option("-u, --identity-user <identityUser>", "Name of the user connecting to the device. Optional.")
.option("-i, --identity-file <identityFile>", "Path to the private key. Optional.")
.option("-q, --quiet [quiet]", "Don\'t display messages. Optional.")
.option("-s, --slow-mode", "Uploads the project with an additional step to resolve sporadic \"Permission denied\" errors on upload. Optional.")
.option("-vvv, --verbose [verbose]", "Verbose output. Optional.")
.action(function (archive, options) { return __awaiter(_this, void 0, void 0, function () {
var e_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, this.deploy(archive, __assign(__assign({}, options), { projectName: options.projectName || this._cliUtil.getShellProjectPackageJson().name }))];
case 1:
_a.sent();
return [3 /*break*/, 3];
case 2:
e_1 = _a.sent();
this._cliUtil.writeError(e_1);
return [3 /*break*/, 3];
case 3: return [2 /*return*/];
}
});
}); });
};
Ch5DeployCli.prototype.deploy = function (archive, options) {
return __awaiter(this, void 0, void 0, function () {
var deviceType, credentials, configOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
this.validateDeployOptions(archive, options);
deviceType = this._cliUtil.getDeviceType(options.deviceType);
return [4 /*yield*/, this.getCredentials(options.promptForCredentials, options.identityUser, options.identityFile)];
case 1:
credentials = _a.sent();
configOptions = {
projectName: path_1.default.parse(archive).name,
controlSystemHost: options.deviceHost,
deviceType: deviceType,
sftpDirectory: options.deviceDirectory,
sftpUser: credentials.user,
sftpPassword: credentials.password,
privateKey: credentials.privateKey,
passphrase: credentials.passphrase,
outputLevel: this._cliUtil.getOutputLevel(options),
slowMode: options.slowMode
};
return [4 /*yield*/, (0, ch5_utilities_1.distributor)(archive, configOptions)];
case 2:
_a.sent();
process.exit(0); // required, takes too long to exit :|
return [2 /*return*/];
}
});
});
};
Ch5DeployCli.prototype.validateDeployOptions = function (archive, options) {
var missingArguments = [];
var missingOptions = [];
if (!archive) {
missingArguments.push('archive');
}
if (!options.deviceHost) {
missingOptions.push('deviceHost');
}
if (!options.deviceType) {
missingOptions.push('deviceType');
}
if (options.identityUser && !options.identityFile) {
missingOptions.push('identityFile');
}
/* coverity[check_after_deref] */
if (options.slowMode && (options === null || options === void 0 ? void 0 : options.deviceType) !== 'touchscreen') {
throw new Error('Slow mode only works for touchscreen devices!');
}
if (missingArguments.length == 0 && missingOptions.length == 0) {
return;
}
var argumentsMessage = missingArguments.length > 0 ? "Missing arguments: ".concat(missingArguments.join(', '), ".") : '';
var optionsMessage = missingOptions.length > 0 ? "Missing options: ".concat(missingOptions.join('. '), ".") : '';
throw new Error("".concat(argumentsMessage, " ").concat(optionsMessage, " Type 'ch5-cli deploy --help' for usage information."));
};
Ch5DeployCli.prototype.getCredentials = function (promptForCredentials, identityUser, identityFile) {
return __awaiter(this, void 0, void 0, function () {
var _a, user, password, userInput, userInput;
return __generator(this, function (_b) {
switch (_b.label) {
case 0:
_a = this.getCredentialsFromEnvironmentVariables(), user = _a.user, password = _a.password;
if (!(identityUser && identityFile)) return [3 /*break*/, 3];
if (!promptForCredentials) return [3 /*break*/, 2];
return [4 /*yield*/, inquirer.prompt([
{
type: 'password',
message: 'Enter passphrase for the private key (empty for no passphrase)',
name: 'passphrase',
mask: '*'
}
])];
case 1:
userInput = _b.sent();
return [2 /*return*/, {
user: identityUser,
privateKey: identityFile,
passphrase: userInput.passphrase,
}];
case 2:
// 110X; Use passphrase from env var
return [2 /*return*/, {
user: identityUser,
privateKey: identityFile,
passphrase: password
}];
case 3:
if (!(identityFile && !identityUser)) return [3 /*break*/, 6];
if (!promptForCredentials) return [3 /*break*/, 5];
return [4 /*yield*/, inquirer.prompt([
{
type: 'string',
message: 'Enter user',
name: 'user',
},
{
type: 'password',
message: 'Enter passphrase for the private key (empty for no passphrase)',
name: 'passphrase',
mask: '*'
}
])];
case 4:
userInput = _b.sent();
return [2 /*return*/, {
user: userInput.user,
passphrase: userInput.passphrase,
privateKey: identityFile
}];
case 5:
// 0101; Use user and passphrase from env variables
if (user !== undefined && password !== undefined) {
return [2 /*return*/, {
user: user,
passphrase: password,
privateKey: identityFile
}];
}
// 0100; Use system user
return [2 /*return*/, {
user: process.env.USER || process.env.USERNAME,
privateKey: identityFile,
passphrase: password
}];
case 6:
if (!promptForCredentials) return [3 /*break*/, 8];
return [4 /*yield*/, inquirer.prompt([
{
type: 'string',
message: 'Enter SFTP user',
name: 'user',
},
{
type: 'password',
message: 'Enter SFTP password',
name: 'password',
mask: '*'
}
])];
case 7: return [2 /*return*/, _b.sent()];
case 8:
// 000X; Use env vars or default values
return [2 /*return*/, { user: user, password: password }];
}
});
});
};
Ch5DeployCli.prototype.getCredentialsFromEnvironmentVariables = function () {
return {
user: process.env["CH5CLI_DEPLOY_USER"],
password: process.env["CH5CLI_DEPLOY_PW"]
};
};
return Ch5DeployCli;
}());
exports.Ch5DeployCli = Ch5DeployCli;