Saas 965 configuring cli (#239)

* cli-config output formatting

* constants extracted

* cli config management

* profiles + schema validation + output changes + get command changes + docs

* packages + docs

* fix docs order

* removed constants

* errors refactored

* set null support

* help for properties + null is now displayed

* config validation

* model defaults for objects in schema

* manager config "lazy load"

* advanced formatting + tests

* output formatting config on get command + fallback mode

* version updated

* add current config to fallback mode

Author: yaroslav-codefresh

docs/index.js

@@ -26,6 +26,7 @@ const categoriesOrder = {
     compositions : 110 ,
     'helm repos' : 111 ,
     'predefined pipelines': 120,
+    'cli config': 121,
     teams: 130,
     more : 150,
 };

lib/interface/cli/commands/cli-config/cli-config.cmd.js

@@ -0,0 +1,40 @@
+const Command = require('../../Command');
+const yargs = require('yargs');
+
+const Manager = require('../../../../logic/cli-config/Manager');
+const { outputCliConfig } = require('../../helpers/cli-config');
+
+const cliConfig = new Command({
+    root: true,
+    command: 'cli-config',
+    description: 'Codefresh CLI configuration. Uses profiles',
+    usage: 'CLI configuration is used for user-specific properties, for example pretty-print',
+    category: 'cli config',
+    webDocs: {
+        description: 'Codefresh CLI configuration. Uses profiles',
+        category: 'CLI Config',
+        title: 'Show Config',
+        weight: 100,
+    },
+    builder: (yargs) => {
+        return yargs
+            .option('output', {
+                alias: 'o',
+                describe: 'Output format',
+                options: ['json', 'yaml'],
+            })
+            .help(false)
+            .example('codefresh cli-config', 'Print configuration for current profile');
+    },
+    handler: async (argv) => {
+        if (argv.help) {
+            yargs.showHelp();
+            return;
+        }
+        const config = Manager.config();
+        console.log(`Current profile: | ${Manager.currentProfile()} |\n`);
+        outputCliConfig(argv.output, config);
+    },
+});
+
+module.exports = cliConfig;

lib/interface/cli/commands/cli-config/ops/get.cmd.js

@@ -0,0 +1,52 @@
+const Command = require('../../../Command');
+const cliCommand = require('../cli-config.cmd');
+const yargs = require('yargs');
+
+const Manager = require('../../../../../logic/cli-config/Manager');
+const { printProperties, outputCliConfig, propertyErrorHandler } = require('../../../helpers/cli-config');
+
+const getCommand = new Command({
+    command: 'get [name]',
+    parent: cliCommand,
+    description: 'For current profile get all properties containing provided "name"',
+    usage: 'Used when you may need to know some exact properties values',
+    webDocs: {
+        description: 'For current profile get all properties containing provided "name"',
+        category: 'CLI Config',
+        title: 'Get Config Properties',
+        weight: 110,
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('name', {
+                describe: 'Property name',
+            })
+            .example('codefresh cli-config get', 'Print available property names')
+            .example('codefresh cli-config get output', 'Print properties, containing "output" word')
+            .example('codefresh cli-config get output.pretty', 'Print properties, containing "output.pretty" path');
+    },
+    handler: async (argv) => {
+        if (argv.help) {
+            yargs.showHelp();
+            return;
+        }
+        const propertyName = argv.name;
+        if (!propertyName) {
+            console.log('Available properties:\n');
+            printProperties(Manager.availableProperties());
+            return;
+        }
+
+        let properties;
+        try {
+            properties = Manager.get(propertyName);
+        } catch (e) {
+            propertyErrorHandler(e);
+            return;
+        }
+        console.log(`Current profile: | ${Manager.currentProfile()} |\n`);
+        outputCliConfig(argv.output, properties);
+    },
+});
+
+module.exports = getCommand;

lib/interface/cli/commands/cli-config/ops/help.cmd.js

@@ -0,0 +1,36 @@
+const Command = require('../../../Command');
+const cliCommand = require('../cli-config.cmd');
+const yargs = require('yargs');
+
+const Manager = require('../../../../../logic/cli-config/Manager');
+const { outputCliMeta } = require('../../../helpers/cli-config');
+
+const helpCommand = new Command({
+    command: 'help [name]',
+    parent: cliCommand,
+    description: 'Show help for properties',
+    usage: 'Used when you may need to know some properties types, defaults, description etc.',
+    webDocs: {
+        description: 'Show help for properties. Used when you may need to know some properties types, defaults, description etc.',
+        category: 'CLI Config',
+        title: 'Describe Config Properties',
+        weight: 130,
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('name', {
+                describe: 'Property name',
+            })
+            .example('codefresh cli-config help', 'Print help for all properties')
+            .example('codefresh cli-config help output', 'Print help for properties, containing "output" word')
+    },
+    handler: async (argv) => {
+        if (argv.help) {
+            yargs.showHelp();
+            return;
+        }
+        outputCliMeta(Manager.meta(argv.name));
+    },
+});
+
+module.exports = helpCommand;

lib/interface/cli/commands/cli-config/ops/profile.cmd.js

@@ -0,0 +1,49 @@
+const Command = require('../../../Command');
+const cliCommand = require('../cli-config.cmd');
+const yargs = require('yargs');
+
+const CliConfigManager = require('../../../../../logic/cli-config/Manager');
+
+const setCommand = new Command({
+    command: 'profile [name]',
+    parent: cliCommand,
+    description: 'Change cli-config profile',
+    usage: 'Using profiles gives an ability to switch fast between the different configuration sets',
+    webDocs: {
+        description: 'Change cli-config profile',
+        category: 'CLI Config',
+        title: 'Profiles',
+        weight: 120,
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('name', {
+                describe: 'Profile name',
+            })
+            .example('codefresh cli-config profile myProfile', 'Use or create profile with name "myProfile"');
+    },
+    handler: async (argv) => {
+        if (argv.help) {
+            yargs.showHelp();
+            return;
+        }
+        const { name } = argv;
+
+        if (!name) {
+            console.log(`Current profile: | ${CliConfigManager.currentProfile()} |\n`);
+            console.log('Available profiles:');
+            CliConfigManager.profiles().forEach((profile) => {
+                console.log(profile);
+            });
+            return;
+        }
+
+        const created = CliConfigManager.useProfile(name);
+        CliConfigManager.persistConfig();
+
+        const message = created ? `Profile "${name}" was created` : `Using profile "${name}"`;
+        console.log(message);
+    },
+});
+
+module.exports = setCommand;

lib/interface/cli/commands/cli-config/ops/set.cmd.js

@@ -0,0 +1,63 @@
+const Command = require('../../../Command');
+const cliCommand = require('../cli-config.cmd');
+const yargs = require('yargs');
+
+const Manager = require('../../../../../logic/cli-config/Manager');
+const { outputCliConfig, propertyErrorHandler, printProperties } = require('../../../helpers/cli-config');
+
+// todo : fix descriptions for docs
+const setCommand = new Command({
+    command: 'set [name] [value]',
+    parent: cliCommand,
+    description: 'For current profile set a property with "name"',
+    webDocs: {
+        description: 'For current profile set an available property',
+        category: 'CLI Config',
+        title: 'Set Config Property',
+        weight: 110,
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('name', {
+                describe: 'Property name',
+            })
+            .positional('value', {
+                describe: 'Property value',
+            })
+            .example('codefresh cli-config set', 'Print available property names')
+            .example('codefresh cli-config set output.pretty false', 'Set "output.pretty" property');
+    },
+    handler: async (argv) => {
+        if (argv.help) {
+            yargs.showHelp();
+            return;
+        }
+        let { name, value } = argv;
+        if (!name) {
+            console.log('Available properties:\n');
+            printProperties(Manager.availableProperties());
+            return;
+        }
+        if (value === undefined) {
+            console.log(`No value provided for property "${name}"`);
+            return;
+        }
+        if (value === 'null') {
+            value = null;
+        }
+
+        let props;
+        try {
+            Manager.set(name, value);
+            Manager.persistConfig();
+            props = Manager.get(name);
+        } catch (e) {
+            propertyErrorHandler(e);
+            return;
+        }
+        console.log(`Property set on profile: | ${Manager.currentProfile()} |\n`);
+        outputCliConfig(argv.output, props);
+    },
+});
+
+module.exports = setCommand;

lib/interface/cli/commands/runtimeEnvironments/create.cmd.js

@@ -3,17 +3,16 @@ const _ = require('lodash');
 const Command = require('../../Command');
 const fs = require('fs');
 const { spawn } = require('child_process');
-const { homedir } = require('os');
 const rp = require('request-promise');
 const createRoot = require('../root/create.cmd');
 const authManager = require('../../../../logic/auth').manager; // eslint-disable-line
 const { cluster } = require('../../../../logic').api;
 const CFError = require('cf-errors');
 
+const { CODEFRESH_PATH } = require('../../defaults');
 const scriptUrl = 'https://raw.githubusercontent.com/codefresh-io/k8s-dind-config/master/codefresh-k8s-configure.sh';
-let filePath = `${homedir()}/.Codefresh/runtime/codefresh-k8s-configure.sh`;
-const dirPath = `${homedir()}/.Codefresh/runtime`;
-const codefreshPath = `${homedir()}/.Codefresh`;
+let filePath = `${CODEFRESH_PATH}/runtime/codefresh-k8s-configure.sh`;
+const dirPath = `${CODEFRESH_PATH}/runtime`;
 
 
 const callToScript = (k8sScript) => {
@@ -74,8 +73,8 @@ const command = new Command({
         });
         if (validCluster) {
             if (!process.env.LOCAL) {
-                if (!fs.existsSync(codefreshPath)) {
-                    fs.mkdirSync(codefreshPath);
+                if (!fs.existsSync(CODEFRESH_PATH)) {
+                    fs.mkdirSync(CODEFRESH_PATH);
                     fs.mkdirSync(dirPath);
                 } else if (!fs.existsSync(dirPath)) {
                     fs.mkdirSync(dirPath);

lib/interface/cli/defaults.js

@@ -1,3 +1,6 @@
+const { homedir } = require('os');
+const path = require('path');
+
 const DEFAULTS = {
     URL: 'https://g.codefresh.io',
     CFCONFIG: `${process.env.HOME || process.env.USERPROFILE}/.cfconfig`,
@@ -7,6 +10,7 @@ const DEFAULTS = {
     CODEFRESH_REGISTRIES: ['r.cfcr.io', '192.168.99.100:5000'],
     WATCH_INTERVAL_MS: 3000,
     MAX_CONSECUTIVE_ERRORS_LIMIT: 10,
+    CODEFRESH_PATH: path.resolve(homedir(), '.Codefresh'),
 };
 
 module.exports = DEFAULTS;

lib/interface/cli/helpers/cli-config.js

@@ -0,0 +1,95 @@
+const _ = require('lodash');
+const flatten = require('flat');
+const columnify = require('columnify');
+const yaml = require('js-yaml');
+const Style = require('../../../output/style');
+const { NoPropertyError, MultiplePropertiesError, NotFullPropertyError, SchemaValidationError } = require('../../../logic/cli-config/errors');
+
+const _jsonFormatter = data => JSON.stringify(data, null, 4);
+const COLUMNIFY_OPTS = { columnSplitter: '   ', headingTransform: Style.bold.uppercase };
+
+const NO_PROPERTIES_MESSAGE = 'no properties';
+
+function _valueFormatter(value) {
+    if (value === null) {
+        return Style.gray('<null>');
+    }
+    if (typeof value === 'string') {
+        return Style.green(`'${value}'`);
+    }
+    if (typeof value === 'boolean') {
+        return Style.yellow(value);
+    }
+    return value;
+}
+
+function _defaultOutput(data) {
+    const flat = flatten(data);
+    const columns = _.keys(flat)
+        .sort()
+        .map((key) => {
+            const value = _valueFormatter(_.get(data, key));
+            return { key, value };
+        });
+    return columnify(columns, COLUMNIFY_OPTS);
+}
+
+function _formatter(format) {
+    switch (format) {
+        case 'yaml':
+            return yaml.safeDump;
+        case 'json':
+            return _jsonFormatter;
+        default:
+            return _defaultOutput;
+    }
+}
+
+function outputCliConfig(format, data) {
+    const formatter = _formatter(format);
+    console.log(formatter(data));
+}
+
+function outputCliMeta(props) {
+    const columns = props.map(meta => {
+        meta.default = _valueFormatter(meta.default);
+        return meta;
+    });
+    if (columns.length) {
+        console.log(columnify(columns, COLUMNIFY_OPTS));
+    } else {
+        console.log(NO_PROPERTIES_MESSAGE);
+    }
+}
+
+function printProperties(properties) {
+    properties.sort().forEach(prop => console.log(prop));
+}
+
+function propertyErrorHandler(e) {
+    if (e instanceof NoPropertyError) {
+        console.log(`Property "${e.property}" is not supported`);
+        return;
+    }
+    if (e instanceof MultiplePropertiesError) {
+        console.log('Choose one of the following properties:\n');
+        printProperties(e.properties);
+        return;
+    }
+    if (e instanceof NotFullPropertyError) {
+        console.log(`Did you mean property: ${e.property}?`);
+        return;
+    }
+    if (e instanceof SchemaValidationError) {
+        e.printErrors();
+        return;
+    }
+    throw e;
+}
+
+module.exports = {
+    outputCliConfig,
+    printProperties,
+    propertyErrorHandler,
+    outputCliMeta,
+};