codefresh 0.78.2

package/lib/interface/cli/commands/app-proxy/install.cmd.js

@@ -0,0 +1,204 @@
+const colors = require('colors');
+
+const _ = require('lodash');
+const Command = require('../../Command');
+const installRoot = require('../root/install.cmd');
+const {
+    INSTALLATION_DEFAULTS,
+    installAppProxy,
+    createErrorHandler,
+    drawCodefreshFiglet,
+} = require('../hybrid/helper');
+const { getKubeContext } = require('../../helpers/kubernetes');
+const sdk = require('../../../../logic/sdk');
+const { to } = require('../../../../logic/cli-config/errors/awaitTo');
+const {
+    mergeWithValues,
+    selectRuntime,
+    selectNamespace,
+    selectHost,
+} = require('./helper');
+
+const openIssueMessage = 'If you had any issues with this installation process please report them at:'
+    + ` ${colors.blue('https://github.com/codefresh-io/cli/issues/new')}`;
+const handleError = createErrorHandler(openIssueMessage);
+
+function printInstallationOptionsSummary({
+    kubeContextName,
+    kubeNamespace,
+    host,
+    runtimeEnvironment,
+}) {
+    const summary = `\n${colors.green('Installation options summary:')} 
+    1. Kubernetes Context: ${colors.cyan(kubeContextName)}
+    2. Kubernetes Namespace: ${colors.cyan(kubeNamespace)}
+    3. App-Proxy hostname: ${colors.cyan(host)}
+    4. Runtime-Environment: ${colors.cyan(runtimeEnvironment)}
+   `;
+    console.log(summary);
+}
+
+
+const installAppProxyHandler = new Command({
+    root: false,
+    parent: installRoot,
+    command: 'app-proxy',
+    description: 'Installs the App-Proxy component on your Kubernetes cluster',
+    webDocs: {
+        category: 'App-Proxy',
+        title: 'Install',
+        weight: 100,
+    },
+
+    builder: yargs => yargs
+        .env('CF_ARG_') // this means that every process.env.CF_ARG_* will be passed to argv
+        .option('kube-config-path', {
+            describe: 'Path to kubeconfig file [$KUBECONFIG]',
+            default: INSTALLATION_DEFAULTS.KUBECONFIG_PATH,
+            type: 'string',
+        })
+        .option('kube-context-name', {
+            describe: 'Name of the kubernetes context on which the app-proxy should be installed'
+                + ' (default: current context) [$CF_ARG_KUBE_CONTEXT_NAME]',
+        })
+        .option('kube-namespace', {
+            describe: 'Name of the namespace on which app-proxy should be installed (default:'
+                + ` ${INSTALLATION_DEFAULTS.NAMESPACE}) [$CF_ARG_KUBE_NAMESPACE]`,
+            type: 'string',
+        })
+        .option('runtime-environment', {
+            describe: 'The Codefresh runtime-environment that this app-proxy will be associated with',
+            type: 'string',
+        })
+        .option('docker-registry', {
+            describe: 'The prefix for the container registry that will be used for pulling the app-proxy component image',
+            default: 'docker.io',
+            type: 'string',
+        })
+        .option('values', {
+            describe: 'specify values in a YAML file',
+        })
+        .option('set-value', {
+            describe: 'Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes',
+            type: 'array',
+        })
+        .option('verbose', {
+            describe: 'Print logs',
+        })
+        .option('host', {
+            describe: 'the hostname that will be used by the app-proxy ingress',
+            type: 'string',
+        })
+        .option('ingress-class', {
+            describe: 'the ingress class that will be used by the app-proxy ingress',
+            type: 'string',
+        })
+        .option('bypass-download', {
+            describe: 'Will bypass the attempt to download the installer. Instead, will immediately attempt to'
+                + ' use the binary from the components folder',
+            default: false,
+            type: 'boolean',
+        }),
+
+    handler: async (_argv) => {
+        const argv = mergeWithValues(_argv);
+        const {
+            'kube-config-path': kubeConfigPath,
+            'docker-registry': dockerRegistry,
+            verbose,
+            values,
+            'set-value': setValues,
+            'ingress-class': ingressClass,
+            noExit,
+            'bypass-download': bypassDownload,
+        } = argv;
+        let {
+            host,
+            'kube-namespace': kubeNamespace,
+            'kube-context-name': kubeContextName,
+            'runtime-environment': runtimeEnvironment,
+        } = argv;
+
+        const [listReErr, runtimes] = await to(sdk.runtimeEnvs.list({ }));
+        await handleError(listReErr, 'Failed to get account\'s runtime environments');
+        const runtimeNames = runtimes.reduce((acc, re) => {
+            if (_.get(re, 'metadata.agent')) {
+                acc.push(_.get(re, 'metadata.name'));
+            }
+            return acc;
+        }, []);
+
+        if (_.isEmpty(runtimeNames)) {
+            await handleError(
+                new Error('no runtime environments found'),
+                'Cannot install app-proxy without a Codefresh runtime-environment',
+            );
+        }
+
+        if (!kubeContextName) {
+            kubeContextName = getKubeContext(kubeConfigPath);
+        }
+
+        if (!kubeNamespace) {
+            kubeNamespace = await selectNamespace();
+        }
+
+        if (!host) {
+            host = await selectHost();
+        }
+
+        if (!runtimeEnvironment || !runtimeNames.find(re => re === runtimeEnvironment)) {
+            if (runtimeEnvironment) {
+                console.log(colors.bold(`Runtime-environment "${colors.cyan(runtimeEnvironment)}" `
+                    + 'was not found, please choose on of the following:'));
+            }
+            runtimeEnvironment = await selectRuntime(runtimeNames);
+        }
+
+        printInstallationOptionsSummary({
+            kubeContextName,
+            kubeNamespace,
+            host,
+            runtimeEnvironment,
+        });
+
+        console.log('installing app-proxy...');
+        const [installationErr] = await to(installAppProxy({
+            apiHost: sdk.config.context.url,
+            appProxyHost: host,
+            appProxyIngressClass: ingressClass,
+            kubeConfigPath,
+            kubeContextName,
+            kubeNamespace,
+            dockerRegistry,
+            bypassDownload,
+            valuesFile: values,
+            setValue: setValues,
+            verbose,
+        }));
+        await handleError(installationErr, 'Failed to install app-proxy');
+
+        const [getREErr, re] = await to(sdk.runtimeEnvs.get({ name: runtimeEnvironment }));
+        await handleError(getREErr, 'Failed to get runtime environment');
+
+        const appProxyUrl = `https://${host}${argv.pathPrefix || ''}`;
+
+        const body = {
+            appProxy: {
+                externalIP: appProxyUrl,
+            },
+        };
+        console.log(`updating runtime-environment ${colors.cyan(runtimeEnvironment)} with app-proxy url`);
+        await sdk.runtimeEnvs.update({ name: runtimeEnvironment }, _.merge(re, body));
+        console.log(`runtime-environment ${colors.cyan(runtimeEnvironment)} updated`);
+
+        console.log(openIssueMessage);
+        await drawCodefreshFiglet();
+        if (!noExit) {
+            process.exit();
+        }
+    },
+
+});
+
+module.exports = installAppProxyHandler;

package/lib/interface/cli/commands/app-proxy/uninstall.cmd.js

@@ -0,0 +1,175 @@
+/* eslint-disable max-len */
+const Command = require('../../Command');
+const uninstallRoot = require('../root/uninstall.cmd');
+const inquirer = require('inquirer');
+const {
+    selectRuntime,
+    mergeWithValues,
+    selectNamespace,
+} = require('./helper');
+const colors = require('colors');
+const sdk = require('../../../../logic/sdk');
+const _ = require('lodash');
+const { to } = require('../../../../logic/cli-config/errors/awaitTo');
+const {
+    createErrorHandler,
+    drawCodefreshFiglet,
+    unInstallAppProxy,
+    INSTALLATION_DEFAULTS,
+} = require('../hybrid/helper');
+const { getKubeContext } = require('../../helpers/kubernetes');
+
+const openIssueMessage = `If you had any issues with the uninstallation process please report them at: ${colors.blue('https://github.com/codefresh-io/cli/issues/new')}`;
+const handleError = createErrorHandler(openIssueMessage);
+
+async function promptConfirmationMessage() {
+    const answer = await inquirer.prompt({
+        type: 'confirm',
+        name: 'deletionConfirmed',
+        default: false,
+        message: 'Are you sure you want to delete the app-proxy-component? (default is NO)',
+    });
+    if (!answer.deletionConfirmed) {
+        console.log('Deletion process aborted, exiting...');
+        process.exit(1);
+    }
+}
+
+const uninstallAppProxyHandler = new Command({
+    root: false,
+    parent: uninstallRoot,
+    command: 'app-proxy',
+    description: 'Deletes the App-Proxy component from your Kubernetes cluster',
+    webDocs: {
+        category: 'App-Proxy',
+        title: 'Uninstall',
+        weight: 100,
+    },
+    builder: yargs => yargs
+        .env('CF_ARG_') // this means that every process.env.CF_ARG_* will be passed to argv
+        .option('kube-context-name', {
+            describe: 'Name of the kubernetes context on which the app-proxy is installed'
+                + ' (default: current context) [$CF_ARG_KUBE_CONTEXT_NAME]',
+        })
+        .option('kube-namespace', {
+            describe: 'Name of the kubernetes namespace from which the App-Proxy and Runtime should be removed',
+        })
+        .option('kube-config-path', {
+            describe: 'Path to kubeconfig file (default is $HOME/.kube/config)',
+            default: INSTALLATION_DEFAULTS.KUBECONFIG_PATH,
+
+        })
+        .option('runtime-environment', {
+            describe: 'The Codefresh runtime-environment that this App-Proxy will be associated with',
+            type: 'string',
+        })
+        .option('force', {
+            describe: 'Run the delete operation without asking to confirm (use with caution!)',
+            alias: 'f',
+            type: Boolean,
+        })
+        .option('values', {
+            describe: 'specify values in a YAML file',
+        })
+        .option('set-value', {
+            describe: 'Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes',
+            type: 'array',
+        })
+        .option('verbose', {
+            describe: 'Print logs',
+        })
+        .option('bypass-download', {
+            describe: 'Will bypass the attempt to download the installer. Instead, will immediately attempt to'
+                + ' use the binary from the components folder',
+            default: false,
+            type: 'boolean',
+        }),
+    handler: async (_argv) => {
+        const argv = mergeWithValues(_argv);
+        const {
+            'kube-config-path': kubeConfigPath,
+            force,
+            verbose,
+            values,
+            'set-value': setValues,
+            noExit,
+            'bypass-download': bypassDownload,
+        } = argv;
+        let {
+            'kube-namespace': kubeNamespace,
+            'kube-context-name': kubeContextName,
+            'runtime-environment': runtimeEnvironment,
+        } = argv;
+
+        const [listReErr, runtimes] = await to(sdk.runtimeEnvs.list({ }));
+        await handleError(listReErr, 'Failed to get runtime environments');
+        const runtimeNames = runtimes.reduce((acc, re) => {
+            if (_.get(re, 'metadata.agent')) {
+                acc.push(_.get(re, 'metadata.name'));
+            }
+            return acc;
+        }, []);
+
+        if (_.isEmpty(runtimeNames)) {
+            await handleError(
+                new Error('no runtime environments found'),
+                'Cannot uninstall app-proxy without a Codefresh runtime-environment',
+            );
+        }
+
+        console.log(colors.green('This uninstaller will guide you through the App-Proxy uninstallation process'));
+
+        if (!kubeContextName) {
+            kubeContextName = getKubeContext(kubeConfigPath);
+        }
+
+        if (!kubeNamespace) {
+            kubeNamespace = await selectNamespace();
+        }
+
+        if (!runtimeEnvironment || !runtimeNames.find(re => re === runtimeEnvironment)) {
+            if (runtimeEnvironment) {
+                console.log(colors.bold(`Runtime-environment "${colors.cyan(runtimeEnvironment)}" `
+                    + 'was not found, please choose on of the following:'));
+            }
+            runtimeEnvironment = await selectRuntime(runtimeNames);
+        }
+
+        console.log(`\n${colors.green('Uninstallation options summary:')} 
+1. Kubernetes Context: ${colors.cyan(kubeContextName)}
+2. Kubernetes Namespace: ${colors.cyan(kubeNamespace)}
+3. Runtime name: ${colors.cyan(runtimeEnvironment)}
+`);
+
+        if (!force) {
+            await promptConfirmationMessage();
+        }
+
+        const [uninstallErr] = await to(unInstallAppProxy({
+            kubeConfigPath,
+            kubeContextName,
+            kubeNamespace,
+            verbose,
+            valuesFile: values,
+            setValue: setValues,
+            bypassDownload,
+        }));
+        await handleError(uninstallErr, 'Failed to uninstall app-proxy');
+
+        const [getREErr, re] = await to(sdk.runtimeEnvs.get({ name: runtimeEnvironment }));
+        await handleError(getREErr, 'Failed to get runtime environment');
+        delete re.appProxy;
+
+        console.log(`updating runtime-environment ${colors.cyan(runtimeEnvironment)} `);
+        await sdk.runtimeEnvs.update({ name: runtimeEnvironment }, re);
+
+        console.log('Successfully uninstalled App-Proxy');
+        console.log(openIssueMessage);
+        await drawCodefreshFiglet();
+        if (!noExit) {
+            process.exit(); // TODO : This is not needed - needed to be fixed
+        }
+    },
+});
+
+module.exports = uninstallAppProxyHandler;

package/lib/interface/cli/commands/app-proxy/upgrade.cmd.js

@@ -0,0 +1,110 @@
+/* eslint-disable max-len */
+const Command = require('../../Command');
+const upgradeRoot = require('../root/upgrade.cmd');
+const {
+    mergeWithValues,
+    selectNamespace,
+} = require('./helper');
+const colors = require('colors');
+const { to } = require('../../../../logic/cli-config/errors/awaitTo');
+const {
+    createErrorHandler,
+    drawCodefreshFiglet,
+    upgradeAppProxy,
+    INSTALLATION_DEFAULTS,
+} = require('../hybrid/helper');
+const { getKubeContext } = require('../../helpers/kubernetes');
+
+const openIssueMessage = `If you had any issues with the process please report them at: ${colors.blue('https://github.com/codefresh-io/cli/issues/new')}`;
+const handleError = createErrorHandler(openIssueMessage);
+
+const upgradeAppProxyHandler = new Command({
+    root: false,
+    parent: upgradeRoot,
+    command: 'app-proxy',
+    description: 'Upgrades an existing App-Proxy',
+    webDocs: {
+        category: 'App-Proxy',
+        title: 'Upgrade',
+        weight: 100,
+    },
+    builder: yargs => yargs
+        .env('CF_ARG_') // this means that every process.env.CF_ARG_* will be passed to argv
+        .option('kube-context-name', {
+            describe: 'Name of the kubernetes context on which the app-proxy is installed'
+                + ' (default: current context) [$CF_ARG_KUBE_CONTEXT_NAME]',
+        })
+        .option('kube-namespace', {
+            describe: 'Name of the kubernetes namespace from which the App-Proxy and Runtime should be removed',
+        })
+        .option('kube-config-path', {
+            describe: 'Path to kubeconfig file (default is $HOME/.kube/config)',
+            default: INSTALLATION_DEFAULTS.KUBECONFIG_PATH,
+        })
+        .option('values', {
+            describe: 'specify values in a YAML file',
+        })
+        .option('set-value', {
+            describe: 'Set values for templates, example: --set-value LocalVolumesDir=/mnt/disks/ssd0/codefresh-volumes',
+            type: 'array',
+        })
+        .option('verbose', {
+            describe: 'Print logs',
+        })
+        .option('bypass-download', {
+            describe: 'Will bypass the attempt to download the installer. Instead, will immediately attempt to'
+                + ' use the binary from the components folder',
+            default: false,
+            type: 'boolean',
+        }),
+    handler: async (_argv) => {
+        const argv = mergeWithValues(_argv);
+        const {
+            'kube-config-path': kubeConfigPath,
+            verbose,
+            values,
+            'set-value': setValues,
+            noExit,
+            'bypass-download': bypassDownload,
+        } = argv;
+        let {
+            'kube-namespace': kubeNamespace,
+            'kube-context-name': kubeContextName,
+        } = argv;
+
+        console.log(colors.green('This installer will guide you through the App-Proxy upgrade process'));
+
+        if (!kubeContextName) {
+            kubeContextName = getKubeContext(kubeConfigPath);
+        }
+
+        if (!kubeNamespace) {
+            kubeNamespace = await selectNamespace();
+        }
+
+        console.log(`\n${colors.green('Upgrade options summary:')} 
+1. Kubernetes Context: ${colors.cyan(kubeContextName)}
+2. Kubernetes Namespace: ${colors.cyan(kubeNamespace)}
+`);
+
+        const [upgradeErr] = await to(upgradeAppProxy({
+            kubeConfigPath,
+            kubeContextName,
+            kubeNamespace,
+            verbose,
+            valuesFile: values,
+            setValue: setValues,
+            bypassDownload,
+        }));
+        handleError(upgradeErr, 'Failed to upgrade app-proxy');
+
+        console.log('Successfully upgraded App-Proxy');
+        console.log(openIssueMessage);
+        await drawCodefreshFiglet();
+        if (!noExit) {
+            process.exit(); // TODO : This is not needed - needed to be fixed
+        }
+    },
+});
+
+module.exports = upgradeAppProxyHandler;

package/lib/interface/cli/commands/audit/download.cmd.js

@@ -0,0 +1,57 @@
+const fs = require('fs');
+const moment = require('moment');
+const Command = require('../../Command');
+const getRoot = require('../root/download.cmd');
+const openApi = require('../../../../../openapi.json');
+const { sdk } = require('../../../../logic');
+
+const DEFAULT_DIR = process.cwd();
+const DEFAULT_FILE_NAME = `codefresh_audit_${moment(new Date())
+    .format('YYYY-MM-DD_HH-mm-ss')}.csv`;
+
+const apiParameters = openApi.paths['/audit/download'].get.parameters
+    .map(({ name, description, schema }) => ({
+        name,
+        description,
+        choices: schema.enum,
+    }));
+
+function _buildRequestOptions(argv){
+    return apiParameters.reduce((memo, { name } = {}) => {
+        if (name in argv) {
+            Object.assign(memo, { [name]: argv[name] });
+        }
+        return memo;
+    }, {});
+}
+
+const command = new Command({
+    command: 'audit',
+    parent: getRoot,
+    description: 'Download audit',
+    webDocs: {
+        category: 'Audit',
+        title: 'Download',
+    },
+    builder: (yargs) => {
+        apiParameters
+            .forEach(({ name, description, choices }) => {
+                yargs.option(name, Object.assign({ describe: description }, choices && { choices }));
+            });
+
+        return yargs
+            .option('file', {
+                describe: 'The name of the file and the directory in which the audit will be saved',
+                default: `${DEFAULT_DIR}/${DEFAULT_FILE_NAME}`,
+            })
+            .example('codefresh download audit --file /var/www/audit.csv')
+            .example('--entity account --rs_status 200 --sortType DESK --sortField createdAt');
+    },
+    handler: async (argv) => {
+        const requestOptions = _buildRequestOptions(argv);
+        const content = await sdk.audit.download(requestOptions);
+        fs.writeFileSync(argv.file, content, 'utf-8');
+    },
+});
+
+module.exports = command;

package/lib/interface/cli/commands/auth/create-context.cmd.js

@@ -0,0 +1,54 @@
+const Command = require('../../Command');
+const DEFAULTS = require('../../defaults');
+const { Config } = require('codefresh-sdk');
+const authRoot = require('../root/auth.cmd');
+
+const command = new Command({
+    command: 'create-context [name]',
+    parent: authRoot,
+    description: 'Create or update an authentication context',
+    usage: 'Creating authentication contexts enables the ability to work against multiple accounts',
+    webDocs: {
+        category: 'Authentication',
+        title: 'Create Context',
+        weight: 20,
+    },
+    builder: (yargs) => { // eslint-disable-line
+        return yargs
+            .option('url', {
+                describe: 'Codefresh system custom url',
+                default: DEFAULTS.URL,
+            })
+            .positional('name', {
+                describe: 'Context name',
+                default: 'default',
+            })
+            .option('api-key', {
+                describe: 'API key',
+                required: true,
+            })
+            .example('codefresh auth create-context --api-key KEY', 'Creating a default context using KEY as the api-key')
+            .example('codefresh auth create-context my-context --api-key KEY', 'Creating a named context');
+    },
+    handler: async (argv) => {
+        const configManager = Config.manager();
+        await configManager.loadConfig({ configFilePath: argv.cfconfig });
+
+        const updatedExistingContext = configManager.getContextByName(argv.name);
+
+        const context = await configManager.createContext({ apiKey: argv.apiKey, url: argv.url, name: argv.name });
+        configManager.addContext(context);
+        configManager.setCurrentContext(context);
+        await configManager.persistConfig();
+
+        if (updatedExistingContext) {
+            console.log(`Updated context: ${context.name}`);
+        } else {
+            console.log(`Created new context: ${context.name}`);
+        }
+
+        console.log(`Switched to context: ${context.name}`);
+    },
+});
+
+module.exports = command;

package/lib/interface/cli/commands/auth/current-context.cmd.js

@@ -0,0 +1,25 @@
+const Command = require('../../Command');
+const authRoot = require('../root/auth.cmd');
+const { Config } = require('codefresh-sdk');
+const { printTableForAuthContexts } = require('../../helpers/auth');
+
+const command = new Command({
+    command: 'current-context',
+    parent: authRoot,
+    description: 'Get the current activated authentication context',
+    webDocs: {
+        category: 'Authentication',
+        title: 'Get Activated Context',
+        weight: 30,
+    },
+    builder: (yargs) => {
+        return yargs
+            .example('codefresh auth current-context', 'Show active authentication context');
+    },
+    handler: async (argv) => {
+        await Config.manager().loadConfig({ configFilePath: argv.cfconfig });
+        await printTableForAuthContexts({ filter: 'current' });
+    },
+});
+
+module.exports = command;

package/lib/interface/cli/commands/auth/get-contexts.cmd.js

@@ -0,0 +1,27 @@
+const debug = require('debug')('codefresh:auth:get-contexts');
+const Command = require('../../Command');
+const { printTableForAuthContexts } = require('../../helpers/auth');
+const { Config } = require('codefresh-sdk');
+const authRoot = require('../root/auth.cmd');
+
+const command = new Command({
+    command: 'get-contexts',
+    parent: authRoot,
+    description: 'Get all possible authentication contexts',
+    webDocs: {
+        category: 'Authentication',
+        title: 'Get Contexts',
+        weight: 10,
+    },
+    builder: (yargs) => {
+        return yargs
+            .example('codefresh auth get-contexts', 'List all existing authentication contexts');
+    },
+    handler: async (argv) => {
+        await Config.manager().loadConfig({ configFilePath: argv.cfconfig });
+        await printTableForAuthContexts({ filter: 'all' });
+    },
+});
+
+
+module.exports = command;