Debug pipeline from cli (#366)

* debug pipeline from cli

* bump version

* fix argument

* test

Author: andrii-codefresh

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

@@ -74,6 +74,15 @@ describe('pipeline', () => {
                         await verifyResponsesReturned([DEFAULT_RESPONSE]); // eslint-disable-line
                     });
 
+                    it('should handle running pipeline in debug mode', async () => {
+                        jest.spyOn(sdk.pipelines, 'debug').mockImplementation();
+                        const argv = { name: 'some name', detach: true };
+                        const pip = new CfPipeline(argv);
+                        await pip.runImpl({ pipelineName: argv.name, options: { debug: true } });
+                        expect(sdk.pipelines.debug).toBeCalled();
+                        sdk.pipelines.debug.mockReset();
+                    });
+
                     it('should handle showing logs aaa', async () => {
                         jest.spyOn(sdk.logs, 'showWorkflowLogs').mockImplementation();
                         const argv = { name: 'some name' };

lib/interface/cli/commands/pipeline/run.base.js

@@ -25,6 +25,7 @@ class RunBaseCommand {
         const trigger = this.argv['trigger'];
         const only = this.argv['only'];
         const skip = this.argv['skip'];
+        const debug = this.argv['debug'];
         if (process.env.CF_BUILD_ID) {
             this.argv.annotation.push(`cf_predecessor=${process.env.CF_BUILD_ID}`);
         }
@@ -46,7 +47,7 @@ class RunBaseCommand {
                 only,
                 skip,
                 annotations,
-
+                debug,
             },
         };
         if (variablesFromFile) {

lib/interface/cli/commands/pipeline/run.cf.js

@@ -61,8 +61,9 @@ function _buildBody(data) {
 
 class RunExternalCommand extends RunBaseCommand {
     async runImpl(request) {
-        const { pipelineName, options } = request;
-        this.workflowId = await sdk.pipelines.run({ name: pipelineName }, _buildBody(options));
+        const { pipelineName, options = {} } = request;
+        const interfaceMethod = options.debug ? 'debug' : 'run';
+        this.workflowId = await sdk.pipelines[interfaceMethod]({ name: pipelineName }, _buildBody(options));
         if (this.executionRequests.length === 1) {
             if (this.argv.detach) {
                 console.log(this.workflowId);

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

@@ -96,6 +96,9 @@ const run = new Command({
                 describe: 'skip specifc steps',
                 array: true
             })
+            .option('debug', {
+                describe: 'debug mode',
+            })
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -trigger TRIGGER_ID | TRIGGER_NAME -b=master', 'Choosing a specific trigger')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -b=master', 'Defining the source control context using a branch')
             .example('codefresh run PIPELINE_ID | PIPELINE_NAME -s=52b992e783d2f84dd0123c70ac8623b4f0f938d1', 'Defining the source control context using a commit')

lib/interface/cli/commands/pipeline/run.local.js

@@ -71,7 +71,7 @@ class RunLocalCommand extends RunBaseCommand {
     async runImpl(request) {
         const { pipelineName } = request;
         const {
-            branch, userYamlDescriptor, variables, noCache, resetVolume, noCfCache, enableNotifications, trigger,
+            branch, userYamlDescriptor, variables, noCache, resetVolume, noCfCache, enableNotifications, trigger, debug,
         } = request.options;
         const localVolume = this.argv['local-volume'] === true ?
             path.join(DEFAULTS.CODEFRESH_PATH, pipelineName) : this.argv['local-volume'];
@@ -113,10 +113,12 @@ class RunLocalCommand extends RunBaseCommand {
         console.log(`Running pipeline: ${pipelineName}`);
 
         return new Promise((resolve, reject) => {
-           const eventEmitter =  this.docker.run(DEFAULTS.ENGINE_IMAGE, [], undefined, _.mergeWith({
+            const eventEmitter = this.docker.run(DEFAULTS.ENGINE_IMAGE, [], undefined, _.mergeWith({
                 Env: [
+                    ...(debug ? ['PIPELINE_DEBUG_MODE=true'] : []),
                     `ACCESS_TOKEN=${currentContext.token}`,
-                    `PIPELINE_ID=${pipelineName}`, `BRANCH=${branch}`,
+                    `PIPELINE_ID=${pipelineName}`,
+                    `BRANCH=${branch}`,
                     `CF_HOST=${currentContext.url}`,
                     'DOCKER_SOCKET_PATH=/var/run/docker.sock',
                 ],

openapi.json

@@ -5320,6 +5320,48 @@
         "x-sdk-interface": "pipelines.run"
       }
     },
+    "/pipelines/debug/{name}": {
+      "post": {
+        "responses": {
+          "200": {
+            "description": "ok",
+            "headers": {
+              "Location": {
+                "schema": {
+                  "type": "string"
+                },
+                "description": "Endpoint to query the build status"
+              }
+            }
+          }
+        },
+        "tags": [
+          "pipelines"
+        ],
+        "operationId": "pipelines-debug",
+        "parameters": [
+          {
+            "in": "path",
+            "name": "name",
+            "schema": {
+              "type": "string"
+            },
+            "required": true
+          }
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object"
+              }
+            }
+          }
+        },
+        "summary": "Debug",
+        "x-sdk-interface": "pipelines.debug"
+      }
+    },
     "/pipelines/yaml/validator": {
       "post": {
         "responses": {

package.json

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