support cli usage within codefresh pipelines (#597)

* support cli usage within codefresh pipelines

* add new pagination interface

* fix usage

* fix comments

* fix

* fix

* remove v2 builds inteface. add start end date filters

* bump

* Validate dates

* bump

Author: denis-codefresh

lib/interface/cli/Command.js

@@ -50,13 +50,15 @@ class Command {
         this.builders = [];
         this.addBuilder(this._createUsageBuilder.bind(this));
 
-        (_.isUndefined(command.handler)) ? command.handler = (args) => {
-            Output.printError(`Error: unknown command "${args._[args._.length - 1]}"\n` +
-                'Run \'codefresh --help\' for usage.');
-
-        } : _.noop();
-        (_.isUndefined(command.builder)) ? _.noop() :
+        if (_.isUndefined(command.handler)) {
+            command.handler = (args) => {
+                Output.printError(`Error: unknown command "${args._[args._.length - 1]}"\n` +
+                    'Run \'codefresh --help\' for usage.');
+            };
+        }
+        if (!_.isUndefined(command.builder)) {
             this.addBuilder(command.builder);
+        }
     }
 
     _createBuilderFunction() {

lib/interface/cli/commad-line-interface.js

@@ -9,6 +9,7 @@ const { version } = require('../../../package.json');
 const configManager = require('../../logic/cli-config/Manager');
 const openapi = require('../../../openapi');
 const sdk = require('../../logic/sdk');
+const cliConfHelpers = require('./helpers/cli-config');
 
 const PROCESS_ARGV = require('yargs-parser')(process.argv);
 
@@ -25,7 +26,7 @@ async function getConfigForSdk() {
                 'Codefresh-User-Agent-Type': 'cli',
                 'Codefresh-User-Agent-Version': version,
             },
-        }, cliConfig.request),
+        }, cliConfig.request, cliConfHelpers.getSdkConfigForPagination().request),
     };
     return Config.load(configOptions);
 }

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

@@ -74,12 +74,32 @@ const command = new Command({
                 type: Array,
                 default: [],
             })
+            .option('from', {
+                describe: 'Date in format: YYYY-MM-DD. Show builds from the provided date',
+                type: String,
+            })
+            .option('to', {
+                describe: 'Date in format: YYYY-MM-DD. Show builds up to provided date',
+                type: String,
+            })
+            .check((argv) => {
+                const { from, to } = argv;
+
+                const dateRegex = /^\d{4}-\d{1,2}-\d{1,2}$/;
+                if (from && !dateRegex.test(from)) {
+                    throw new Error('--from option should take a date in format: YYYY-MM-DD. Example: --from 2020-12-31');
+                }
+                if (to && !dateRegex.test(to)) {
+                    throw new Error('--to option should take a date in format: YYYY-MM-DD. Example: --to 2020-12-31');
+                }
+                return true;
+            })
             .example('codefresh get build ID', 'Get build ID')
             .example('codefresh get builds', 'Get all builds')
             .example('codefresh get builds --pipeline-id ID', 'Get all builds that are executions of pipeline "ID"')
             .example('codefresh get builds --pipeline-name NAME', 'Get all builds that are executions of pipelines that are named "NAME"')
-            .example('codefresh get builds --status=error', 'Get all builds that their status is error');
-
+            .example('codefresh get builds --status=error', 'Get all builds that their status is error')
+            .example('codefresh get builds --from=2020-01-01 --to=2020-02-01', 'Get all builds within given date range');
     },
     handler: async (argv) => {
         const workflowIds = argv.id;
@@ -91,9 +111,12 @@ const command = new Command({
             branch: branchName,
             commitId: revision,
             'pipeline-trigger-id': pipelineTriggerId,
+            from,
+            to,
         } = argv;
         const pipelineNames = !_.isArray(argv['pipeline-name']) ? [(argv['pipeline-name'])] : argv['pipeline-name'];
         const pipelineIds = !_.isArray(argv['pipeline-id']) ? [(argv['pipeline-id'])] : argv['pipeline-id'];
+
         const requestOptions = {
             limit,
             page,
@@ -102,6 +125,9 @@ const command = new Command({
             branchName,
             revision,
             pipelineTriggerId,
+            paginationReset: page === 1,
+            startDate: from,
+            endDate: to,
         };
 
         let workflows = [];

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

@@ -9,6 +9,7 @@ const _jsonFormatter = data => JSON.stringify(data, null, 4);
 const COLUMNIFY_OPTS = { columnSplitter: '   ', headingTransform: Style.bold.uppercase };
 
 const NO_PROPERTIES_MESSAGE = 'no properties';
+const PAGINATION_SESSION_HEADER = 'X-Pagination-Session-Id';
 
 function _valueFormatter(value) {
     if (value === null) {
@@ -87,9 +88,23 @@ function propertyErrorHandler(e) {
     throw e;
 }
 
+function getSdkConfigForPagination() {
+    const conf = {};
+    const { HOSTNAME, CF_BUILD_ID } = process.env;
+
+    //  if cli runs inside of the codefresh pipeline need to create pagination sessionId according to the build id and container id
+    if (HOSTNAME && CF_BUILD_ID) {
+        //  HOSTNAME – container id inside docker container
+        const sessionId = `${HOSTNAME}:${CF_BUILD_ID}`;
+        _.set(conf, `request.headers.${PAGINATION_SESSION_HEADER}`, sessionId);
+    }
+    return conf;
+}
+
 module.exports = {
     outputCliConfig,
     printProperties,
     propertyErrorHandler,
     outputCliMeta,
+    getSdkConfigForPagination,
 };

openapi.json

@@ -2179,7 +2179,40 @@
               "type": "string"
             },
             "description": "Pipeline trigger id"
+          },
+          {
+            "name": "paginationReset",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Should pagination session be reseted to first page"
+          },
+          {
+            "name": "paginationDirection",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Direction of the pagination: 'prev' or 'next'"
+          },
+          {
+            "name": "startDate",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Lower date filter bound"
+          },
+          {
+            "name": "endDate",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            },
+            "description": "Upper date filter bound"
           }
+          
         ],
         "responses": {
           "200": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codefresh",
-  "version": "0.73.28",
+  "version": "0.73.30",
   "description": "Codefresh command line utility",
   "main": "index.js",
   "preferGlobal": true,
@@ -37,7 +37,7 @@
     "cf-errors": "^0.1.12",
     "chalk": "^4.1.0",
     "cli-progress": "3.6.0",
-    "codefresh-sdk": "^1.9.14",
+    "codefresh-sdk": "^1.9.15",
     "colors": "^1.1.2",
     "columnify": "^1.5.4",
     "compare-versions": "^3.4.0",

yarn.lock

@@ -1258,10 +1258,10 @@ code-point-at@^1.0.0:
   resolved "https://registry.yarnpkg.com/code-point-at/-/code-point-at-1.1.0.tgz#0d070b4d043a5bea33a2f1a40e2edb3d9a4ccf77"
   integrity sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=
 
-codefresh-sdk@^1.9.14:
-  version "1.9.14"
-  resolved "https://registry.yarnpkg.com/codefresh-sdk/-/codefresh-sdk-1.9.14.tgz#e0751abd3eb7ce44da501f5130541126d5d40d75"
-  integrity sha512-fQ7gUUUyFQduRoTzhViAJv6d+6wcCQOn+dYQT9VKyos07GETYWFG/Sr4bG7TYlE5M0Yxn5xfkaIvXv+8GczrXQ==
+codefresh-sdk@^1.9.15:
+  version "1.9.15"
+  resolved "https://registry.yarnpkg.com/codefresh-sdk/-/codefresh-sdk-1.9.15.tgz#ccd7e8a0815404f6d89171f27930808e4ca01419"
+  integrity sha512-/pk3cFpOxGlcK2rX7ejveB3oOa4TH0kkIgwLSJHHx7A+9NOta1kJXWtfj6khvct31gidrf/fmw6x29j/Zj4RgQ==
   dependencies:
     "@codefresh-io/cf-receiver" "0.0.1-alpha19"
     bluebird "^3.5.3"