saas 1218-1221 - create, get, delete tokens (#260)

* create, get, delete, replace + formatters

* docs corrected + replace -> recreate + delete on ids only now + additional validation

* remove "recreate" + make validation throw + update version

Author: yaroslav-codefresh

lib/interface/cli/Command.js

@@ -296,7 +296,7 @@ class Command {
         yargsCommand.description = this.description;
         yargsCommand.command = this.command;
         yargsCommand.builder = this._createBuilderFunction();
-        yargsCommand.handler = wrapHandler(this.handler, this.requiresAuthentication);
+        yargsCommand.handler = wrapHandler(this.handler || (() => yargs.showHelp()), this.requiresAuthentication);
         return yargsCommand;
 
     }

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

@@ -1,44 +1,56 @@
-const debug = require('debug')('codefresh:cli:create:token');
+const _ = require('lodash');
 const Command = require('../../Command');
 const createCmd = require('../root/create.cmd');
-const {
-    generateToken,
-} = require('../../../../logic/api/token');
+const { token } = require('../../../../logic').api;
+const CFError = require('cf-errors');
+
 
 const command = new Command({
-    command: 'tokens',
-    aliases: ['token'],
+    command: 'token [name]',
     parent: createCmd,
-    description: 'Create Codefresh token',
-    usage: 'Create Codefresh token',
+    description: 'Generate Codefresh token',
+    usage: 'Create default token or provide --type and --subject. See options for more details.',
     webDocs: {
         category: 'Tokens',
-        title: 'Tokens tokens',
+        title: 'Create tokens',
+        weight: 10,
     },
     builder: (yargs) => {
         return yargs
             .option('subject', {
-                describe: 'name of the token subject',
-                required: true,
+                describe: 'Name of the token subject',
             })
             .option('type', {
                 describe: 'Type of the subject',
-                default: 'runtime-environment',
-                options: ['runtime-environment'],
+                choices: ['runtime-environment', 'user'],
+                default: 'user',
             })
-            .option('name', {
+            .positional('name', {
                 describe: 'token name',
                 required: true,
             })
-            .example('codefresh create token --subject my-k8s-cluster/namespace --name new-token', 'Create token form runtime environment');
+            .example('codefresh create token some-token', 'Create token with default type')
+            .example(
+                'codefresh create token some-token --subject my-k8s-cluster/namespace --type runtime-environment',
+                'Create token from runtime environment',
+            );
     },
     handler: async (argv) => {
-        const res = await generateToken({
+        if (_.isEmpty(argv.name)) {
+            throw new CFError('Token name must be provided');
+        }
+
+        if (argv.type === 'runtime-environment' && !argv.subject) {
+            throw new CFError('Type "runtime-environment" needs --subject to be provided');
+        }
+
+        const res = await token.generateToken({
             subjectType: argv.type,
             subjectReference: argv.subject,
             name: argv.name,
         });
-        console.log('Token created');
+
+        console.log('Token created:');
         console.log(res.token);
     },
 });

lib/interface/cli/commands/tokens/delete.cmd.js

@@ -0,0 +1,43 @@
+const _ = require('lodash');
+const Command = require('../../Command');
+const deleteCmd = require('../root/delete.cmd');
+const { token } = require('../../../../logic').api;
+const Promise = require('bluebird');
+const CFError = require('cf-errors');
+
+
+const command = new Command({
+    command: 'tokens [ids..]',
+    aliases: ['token'],
+    parent: deleteCmd,
+    description: 'Revoke Codefresh token',
+    usage: 'Provide one or many token ids to delete. Ids can be retrieved with "get" command',
+    webDocs: {
+        category: 'Tokens',
+        title: 'Delete tokens',
+        weight: 40,
+    },
+    builder: (yargs) => {
+        yargs
+            .positional('ids', {
+                describe: 'token names or ids',
+                required: true,
+            })
+            .example('codefresh delete token [token_id]', 'Delete one token')
+            .example('codefresh delete tokens [token_id_1] [token_id_2]', 'Delete many tokens');
+    },
+    handler: async (argv) => {
+        if (_.isEmpty(argv.ids)) {
+            throw new CFError('Token ids must be provided');
+        }
+
+        await Promise.map(argv.ids, (id) => {
+            return token.deleteToken(id)
+                .then(() => console.log(`Deleted token: '${id}'`))
+                .catch(err => console.log(`Not deleted: '${id}' -- ${err}`));
+        });
+    },
+});
+
+module.exports = command;
+

lib/interface/cli/commands/tokens/get.cmd.js

@@ -0,0 +1,36 @@
+const _ = require('lodash');
+const Command = require('../../Command');
+const getCmd = require('../root/get.cmd');
+const { token } = require('../../../../logic').api;
+const { specifyOutputForArray } = require('../../helpers/get');
+
+const command = new Command({
+    command: 'tokens [names|ids..]',
+    aliases: ['token'],
+    parent: getCmd,
+    description: 'Get Codefresh tokens',
+    usage: 'Provide names/ids to filter results by them',
+    webDocs: {
+        category: 'Tokens',
+        title: 'Get tokens',
+        weight: 20,
+    },
+    builder: (yargs) => {
+        return yargs
+            .positional('names', {
+                describe: 'Token names or ids',
+            })
+            .example('codefresh get tokens', 'Get all tokens')
+            .example('codefresh get tokens [token_1_name] [token_2_id]', 'Get tokens filtered by names or ids');
+    },
+    handler: async (argv) => {
+        let res = await token.getTokens();
+        if (!_.isEmpty(argv.names)) {
+            res = res.filter(t => argv.names.includes(t.info.name) || argv.names.includes(t.info.id));
+        }
+        specifyOutputForArray(argv.output, res, argv.pretty);
+    },
+});
+
+module.exports = command;
+

lib/logic/api/index.js

@@ -15,6 +15,7 @@ const board = require('./board');
 const section = require('./section');
 const cluster = require('./cluster');
 const repository = require('./repository');
+const token = require('./token');
 
 module.exports = {
     user,
@@ -34,4 +35,5 @@ module.exports = {
     section,
     cluster,
     repository,
+    token,
 };

lib/logic/api/token.js

@@ -1,5 +1,5 @@
-const _ = require('lodash');
 const { sendHttpRequest } = require('./helper');
+const Token = require('../entities/Token');
 
 const generateToken = async (info) => {
     const options = {
@@ -19,7 +19,26 @@ const generateToken = async (info) => {
     };
 };
 
+const getTokens = async () => {
+    const options = {
+        url: '/api/auth/keys',
+        method: 'GET',
+    };
+    const result = await sendHttpRequest(options);
+    return result.map(Token.fromResponse);
+};
+
+const deleteToken = (id) => {
+    const options = {
+        url: `/api/auth/key/${id}`,
+        method: 'DELETE',
+    };
+    return sendHttpRequest(options);
+};
+
 
 module.exports = {
     generateToken,
+    getTokens,
+    deleteToken,
 };

lib/logic/entities/Token.js

@@ -0,0 +1,24 @@
+const Entity = require('./Entity');
+const _ = require('lodash');
+
+class Token extends Entity {
+    constructor(data) {
+        super();
+        this.entityType = 'token';
+        this.info = data;
+        this.defaultColumns = ['id', 'name', 'token_prefix', 'created'];
+        this.wideColumns = ['id', 'name', 'token_prefix', 'created', 'subject_type', 'subject'];
+    }
+
+    static fromResponse(response) {
+        const data = Object.assign({}, response);
+        data.id = data._id;
+        data.token_prefix = response.tokenPrefix;
+        data.created = new Date(data.created).toLocaleDateString();
+        data.subject_type = _.get(data, 'subject.type');
+        data.subject = _.get(data, 'subject.ref');
+        return new Token(data);
+    }
+}
+
+module.exports = Token;

lib/output/formatters/Token.formatter.js

@@ -0,0 +1,8 @@
+const { Formatter, Style } = require('../../output');
+
+
+const FORMATTER = Formatter.build()
+    .style('token_prefix', val => `${val}**************`)
+    .style('name', Style.cyan);
+
+module.exports = FORMATTER;

lib/output/formatters/index.js

@@ -17,6 +17,7 @@ const formatters = {
     Environment: require('./Environment.formatter'),
     GitRepo: require('./GitRepo.formatter'),
     CodefreshRepo: require('./CodefreshRepo.formatter'),
+    Token: require('./Token.formatter'),
 };
 /* eslint-enable */
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.9.14",
+  "version": "0.9.15",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,