Feature/olegz/saas 5245 download audit cmd (#400)

* SAAS-5245 #time 0m 0h Added download audit cmd

* SAAS-5245 #time 0m 0h Added download audit cmd

* SAAS-5245 #time 0m 0h Added download/audit to openapi

* SAAS-5245 #time 0m 0h Up version

* SAAS-5245 #time 0m 0h Up version

Author: olegz-codefresh

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;

lib/interface/cli/commands/root/download.cmd.js

@@ -0,0 +1,18 @@
+const Command = require('../../Command');
+const yargs = require('yargs');
+
+const download = new Command({
+    root: true,
+    command: 'download',
+    description: 'Download resources',
+    usage: 'Codefresh download <resource>',
+    webDocs: {
+        title: 'Download',
+        weight: 70,
+    },
+    handler: async () => {
+        yargs.showHelp();
+    },
+});
+
+module.exports = download;

openapi.json

@@ -285,6 +285,133 @@
     }
   ],
   "paths": {
+    "/audit/download": {
+      "get": {
+        "responses": {
+          "200": {
+            "$ref": "#/components/responses/Json"
+          }
+        },
+        "tags": [
+          "audit",
+          "download"
+        ],
+        "operationId": "audit-download",
+        "parameters": [
+          {
+            "name": "userName",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by user name"
+          },
+          {
+            "name": "userId",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by codefresh user id"
+          },
+          {
+            "name": "entity",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by api entity, example: pipeline, account"
+          },
+          {
+            "name": "entityId",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by api entity id, this value different for each action, example: email, user id"
+          },
+          {
+            "name": "action",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by api action, get possible values on /api/audit/entitiesList, you will see only actions which was happen in your account"
+          },
+          {
+            "name": "rs_status",
+            "in": "query",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "filter by response status code"
+          },
+          {
+            "name": "showTriggers",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "returns only actions related to receiving triggers"
+          },
+          {
+            "name": "search",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "filter by searching substring in request body or query or params or headers or url"
+          },
+          {
+            "name": "from",
+            "in": "query",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "filter by date, value is number of milliseconds since 1970"
+          },
+          {
+            "name": "to",
+            "in": "query",
+            "schema": {
+              "type": "integer"
+            },
+            "description": "filter by date, value is number of milliseconds since 1970"
+          },
+          {
+            "name": "sortField",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": ["id", "createdAt", "updatedAt"]
+            },
+            "description": "name of sorting field, values: id, createdAt, updatedAt"
+          },
+          {
+            "name": "sortType",
+            "in": "query",
+            "schema": {
+              "type": "string",
+              "enum": ["ASK", "DESK"]
+            },
+            "description": "sorting type, values: ASK, DESK"
+          }
+        ],
+        "summary": "Download",
+        "x-sdk-interface": "audit.download",
+        "x-endpoint": {
+          "auth": {
+            "middleware": [
+              "auth.isAuthenticated"
+            ]
+          },
+          "postMiddleware": [
+            "global.iseMiddleware"
+          ],
+          "handler": "audit.download"
+        }
+      }
+    },
     "/abac": {
       "get": {
         "responses": {

package.json

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