added flag --all for getting pipelines without limit (#370)

* [other] - added flag `--all` for getting pipelines without limit (in such cases, actually limit of 10k)

* [other] - chamged >-1 to >=0

* [other] - v up

* bump version

Author: olegz-codefresh

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

@@ -49,9 +49,7 @@ async function startCommandLine() {
             }
         }
     });
-    _.forEach(rootCommands, (command) => {
-        yargs.command(command.toCommand());
-    });
+    _.forEach(rootCommands, command => yargs.command(command.toCommand()));
 
     return yargs // eslint-disable-line
         .env('CF_ARG_') // this means that every process.env.CF_ARG_* will be passed to argv

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

@@ -10,6 +10,19 @@ const Pipeline = require('../../../../logic/entities/Pipeline');
 
 const getRoot = require('../root/get.cmd');
 
+/**
+ * returns a limit based on the passed `--limit, --all` and default values
+ * The limit for the flag `all` (10k) was set in сli defaults values,
+ * so as not to touch the pipeline-manager logic (since requests from other places can go to it)
+ * @param argvLimit {number}- value from `--limit`
+ * @param allFlag {boolean} - value from `--all`
+ * @returns {number|*}
+ * @private
+ */
+function _getLimit(argvLimit, allFlag) {
+    if (allFlag && _.isUndefined(argvLimit)) return DEFAULTS.GET_ALL_PIPELINES_LIMIT;
+    return argvLimit >= 0 ? argvLimit : DEFAULTS.GET_LIMIT_RESULTS;
+}
 
 const command = new Command({
     command: 'pipelines [id..]',
@@ -44,34 +57,39 @@ const command = new Command({
                 default: [],
             })
             .option('limit', {
-                describe: 'Limit amount of returned results',
-                default: DEFAULTS.GET_LIMIT_RESULTS,
+                describe: `Limit amount of returned results [default: ${DEFAULTS.GET_LIMIT_RESULTS}]`,
+            })
+            .option('all', {
+                describe: 'Remove default limit of returned result',
             })
             .option('page', {
                 describe: 'Paginated page',
                 default: DEFAULTS.GET_PAGINATED_PAGE,
             });
     },
     handler: async (argv) => {
-        const { id: ids, name, d: decryptVariables, projectId, project: projectName } = argv;
-        const limit = argv.limit;
-        const offset = (argv.page - 1) * limit;
+        const { id: ids, name, d: decryptVariables, projectId, project: projectName, all } = argv;
+        const limit = _getLimit(argv.limit, all);
+        const offset = (argv.page - 1) * (limit || 0);
         const labels = prepareKeyValueFromCLIEnvOption(argv.label);
-
         debug(`decrypt: ${decryptVariables}`);
         if (!_.isEmpty(ids)) {
             const pipelines = [];
             for (const id of ids) {
                 try {
-                    const currPipeline = await sdk.pipelines.get({ name: id, decryptVariables });
+                    const currPipeline = await sdk.pipelines.get({
+                        name: id,
+                        decryptVariables,
+                    });
                     pipelines.push(Pipeline.fromResponse(currPipeline));
                 } catch (err) {
                     if (pipelines.length) {
                         Output.print(pipelines);
                     }
 
                     debug(err.toString());
-                    const message = err.toString().includes('not find') ? `Pipeline '${id}' was not found.` : 'Error occurred';
+                    const message = err.toString()
+                        .includes('not find') ? `Pipeline '${id}' was not found.` : 'Error occurred';
                     throw new CFError({
                         cause: err,
                         message,
@@ -89,6 +107,7 @@ const command = new Command({
                     })));
                 _projectId = project.id;
             }
+
             const pipelines = await sdk.pipelines.list({
                 limit,
                 offset,
@@ -102,4 +121,5 @@ const command = new Command({
 });
 
 module.exports = command;
+module.exports._getLimit = _getLimit;
 

lib/interface/cli/commands/pipeline/pipeline.sdk.spec.js

@@ -1,3 +1,4 @@
+const DEFAULTS = require('../../defaults');
 const getCmd = require('./get.cmd').toCommand();
 const deleteCmd = require('./delete.cmd').toCommand();
 const BasePipeline = require('./run.base');
@@ -32,6 +33,7 @@ describe('pipeline', () => {
 
     describe('commands', () => {
         describe('get', () => {
+            const { _getLimit } = require('./get.cmd');
             it('should handle getting given id', async () => {
                 const argv = { id: ['some id'] };
                 await getCmd.handler(argv);
@@ -45,6 +47,22 @@ describe('pipeline', () => {
                 await getCmd.handler(argv);
                 await verifyResponsesReturned([response]); // eslint-disable-line
             });
+
+            it('should return limit from arg', async () => {
+                expect(_getLimit(10, true)).toEqual(10);
+            });
+
+            it('should return zero limit', async () => {
+                expect(_getLimit(0, true)).toEqual(0);
+            });
+
+            it('should return default limit', async () => {
+                expect(_getLimit(undefined,false)).toEqual(DEFAULTS.GET_LIMIT_RESULTS);
+            });
+
+            it('should return `unlimited` value', async () => {
+                expect(_getLimit(undefined,true)).toEqual(DEFAULTS.GET_ALL_PIPELINES_LIMIT);
+            });
         });
 
         // decided to follow unit tests modularity concept

lib/interface/cli/defaults.js

@@ -6,6 +6,7 @@ const DEFAULTS = {
     CFCONFIG: `${process.env.HOME || process.env.USERPROFILE}/.cfconfig`,
     DEBUG_PATTERN: 'codefresh',
     GET_LIMIT_RESULTS: 25,
+    GET_ALL_PIPELINES_LIMIT: 10000,
     GET_PAGINATED_PAGE: 1,
     CODEFRESH_REGISTRIES: ['r.cfcr.io', '192.168.99.100:5000'],
     WATCH_INTERVAL_MS: 3000,

package.json

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