@broadcom/endevor-bridge-for-git-for-zowe-cli/lib/cli/sessions/EndevorSession.js

Endevor Bridge for Git plug-in for Zowe CLI

'use strict';

var imperative = require('@zowe/imperative');
require('../../api/constants/EBGConstants.js');
require('../../api/constants/PluginConstants.js');
require('../../api/doc/ebg/IMappingView.js');
var object = require('../../utils/object.js');
require('../../api/doc/IBranchMetadata.js');
require('child_process');
require('../../api/utils/ChangeValidator.js');
require('fs');
var OptionUtils = require('../../api/utils/OptionUtils.js');
require('../../api/utils/OptionValidator.js');
var BaseProfileDefinitions = require('./BaseProfileDefinitions.js');

/*
 * Copyright (c) 2019 Broadcom.  All Rights Reserved.  The term
 * "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
 *
 * This software and all information contained therein is
 * confidential and proprietary and shall not be duplicated,
 * used, disclosed, or disseminated in any way except as
 * authorized by the applicable license agreement, without the
 * express written permission of Broadcom.  All authorized
 * reproductions must be marked with this language.
 *
 * EXCEPT AS SET FORTH IN THE APPLICABLE LICENSE AGREEMENT, TO
 * THE EXTENT PERMITTED BY APPLICABLE LAW, BROADCOM PROVIDES THIS
 * SOFTWARE WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT
 * LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR
 * FITNESS FOR A PARTICULAR PURPOSE.  IN NO EVENT WILL BROADCOM
 * BE LIABLE TO THE END USER OR ANY THIRD PARTY FOR ANY LOSS OR
 * DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SOFTWARE,
 * INCLUDING WITHOUT LIMITATION, LOST PROFITS, BUSINESS
 * INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF BROADCOM IS
 * EXPRESSLY ADVISED OF SUCH LOSS OR DAMAGE.
 */
/**
 * Utility Methods for Endevor Session
 */
class EndevorSession extends OptionUtils.OptionUtils {
    /**
     * Creates the Endevor connection session if and only if all the required options are provided
     *
     * @param args command arguments
     * @param profile Endevor profile
     * @param baseProfile Base profile
     */
    createSession(args, profile, baseProfile) {
        const session = {
            type: imperative.SessConstants.AUTH_TYPE_BASIC,
            protocol: this.getOption(true, EndevorSession.ENDEVOR_OPTION_PROTOCOL, args, "http", profile, baseProfile),
            hostname: this.getOption(true, EndevorSession.ENDEVOR_OPTION_HOST, args, null, profile, baseProfile),
            port: Number(this.getOption(true, EndevorSession.ENDEVOR_OPTION_PORT, args, null, profile, baseProfile)),
            user: this.getOption(false, EndevorSession.ENDEVOR_OPTION_USER, args, null, profile, baseProfile),
            password: this.getOption(false, EndevorSession.ENDEVOR_OPTION_PASSWORD, args, null, profile, baseProfile),
            rejectUnauthorized: this.getOption(true, EndevorSession.ENDEVOR_OPTION_REJECT_UNAUTHORIZED, args, imperative.AbstractSession.DEFAULT_REJECT_UNAUTHORIZED_SETTING, profile, baseProfile),
            basePath: this.getOption(true, EndevorSession.ENDEVOR_OPTION_BASE_PATH, args, EndevorSession.DEFAULT_BASE_PATH, profile, baseProfile),
        };
        if (object.isNil(session.user) || object.isNil(session.password)) {
            session.type = imperative.SessConstants.AUTH_TYPE_TOKEN;
            session.tokenType = this.getOption(false, BaseProfileDefinitions.BaseProfileDefinitions.BASE_OPTION_TOKEN_TYPE, args, null, undefined, baseProfile);
            session.tokenValue = this.getOption(false, BaseProfileDefinitions.BaseProfileDefinitions.BASE_OPTION_TOKEN_VALUE, args, null, undefined, baseProfile);
        }
        if (this.optionValidator.isMissingCredentials(session)) {
            this.optionValidator.addMissingOption(EndevorSession.ENDEVOR_OPTION_USER);
            this.optionValidator.addMissingOption(EndevorSession.ENDEVOR_OPTION_PASSWORD);
        }
        if (!this.optionValidator.isMissingOptions(EndevorSession.ENDEVOR_SESSION_OPTION_GROUP)) {
            return new imperative.Session(session);
        }
        else {
            throw new Error("Missing required options for Endevor session");
        }
    }
    getOptionPrefix() {
        return EndevorSession.OPTION_PREFIX;
    }
}
EndevorSession.PROFILE_TYPE = "endevor";
EndevorSession.OPTION_PREFIX = "endevor-";
EndevorSession.ENDEVOR_SESSION_OPTION_GROUP = "Endevor options (alternatively use an 'endevor' profile)";
EndevorSession.DEFAULT_BASE_PATH = "EndevorService/rest";
/**
 * Option used in profile creation and commands for protocol for Endevor
 */
EndevorSession.ENDEVOR_OPTION_PROTOCOL = {
    name: "endevor-protocol",
    aliases: ["endevorprot"],
    description: "Endevor SCM Rest API protocol. " +
        OptionUtils.OptionUtils.defaultValueDescription("http"),
    type: "string",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
    allowableValues: { values: ["http", "https"], caseSensitive: false },
};
/**
 * Option used in profile creation and commands for hostname for Endevor
 */
EndevorSession.ENDEVOR_OPTION_HOST = {
    name: "endevor-host",
    aliases: ["endevorh"],
    description: "Endevor Rest API hostname.",
    type: "string",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Option used in profile creation and commands for port for Endevor
 */
EndevorSession.ENDEVOR_OPTION_PORT = {
    name: "endevor-port",
    aliases: ["endevorp"],
    description: "Endevor Rest API port.",
    type: "number",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Option used in profile creation and commands for username / ID  for Endevor
 */
EndevorSession.ENDEVOR_OPTION_USER = {
    name: "endevor-user",
    aliases: ["endevoru"],
    description: "Mainframe (Endevor) username (can be the same as your TSO login).",
    type: "string",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Option used in profile creation and commands for password/passphrase for Endevor
 */
EndevorSession.ENDEVOR_OPTION_PASSWORD = {
    name: "endevor-password",
    aliases: ["endevorpass", "endevorpw"],
    description: "Mainframe (Endevor) password (can be the same as your TSO password).",
    type: "string",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Option used in profile creation and commands for rejectUnauthorized setting for connecting to Endevor
 */
EndevorSession.ENDEVOR_OPTION_REJECT_UNAUTHORIZED = {
    name: "endevor-reject-unauthorized",
    aliases: ["endevorru"],
    description: "Reject self-signed certificates. " +
        OptionUtils.OptionUtils.defaultValueDescription(imperative.AbstractSession.DEFAULT_REJECT_UNAUTHORIZED_SETTING),
    type: "boolean",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Option used in profile creation and commands for base path for Endevor
 */
EndevorSession.ENDEVOR_OPTION_BASE_PATH = {
    name: "endevor-base-path",
    aliases: ["endevorbp"],
    description: "The Endevor SCM Rest API base path. " +
        OptionUtils.OptionUtils.defaultValueDescription(EndevorSession.DEFAULT_BASE_PATH),
    type: "string",
    required: false,
    group: EndevorSession.ENDEVOR_SESSION_OPTION_GROUP,
};
/**
 * Options related to connecting to Endevor
 * These options can be filled in if the user creates a profile
 */
EndevorSession.ENDEVOR_CONNECTION_OPTIONS = [
    EndevorSession.ENDEVOR_OPTION_PROTOCOL,
    EndevorSession.ENDEVOR_OPTION_HOST,
    EndevorSession.ENDEVOR_OPTION_PORT,
    EndevorSession.ENDEVOR_OPTION_USER,
    EndevorSession.ENDEVOR_OPTION_PASSWORD,
    EndevorSession.ENDEVOR_OPTION_REJECT_UNAUTHORIZED,
    EndevorSession.ENDEVOR_OPTION_BASE_PATH,
];

exports.EndevorSession = EndevorSession;