Support showing logs of a workflows

Author: Itai Gendler

codefresh.yml

@@ -33,9 +33,3 @@ steps:
     candidate: ${{build_step}}
     tag: ${{CF_SHORT_REVISION}}
     registry: "CFCR"
-
-  push_to_registry_branch:
-    title: "Pushing image tagged with branch to registry"
-    type: push
-    candidate: ${{build_step}}
-    tag: ${{CF_BRANCH}}

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

@@ -2,7 +2,7 @@ const debug = require('debug')('codefresh:cli:logs');
 const Command = require('../../Command');
 const _ = require('lodash');
 const CFError = require('cf-errors');
-const { logs } = require('../../../../logic').api;
+const { log } = require('../../../../logic').api;
 
 
 const run = new Command({
@@ -25,7 +25,7 @@ const run = new Command({
         const workflowId = argv.id;
         const follow = argv.f;
 
-        await logs.showWorkflowLogs(workflowId, follow);
+        await log.showWorkflowLogs(workflowId, follow);
         // TODO fix this. its a workaround since something related to firebase in not properly closed
         process.exit(0);
     },

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

@@ -5,19 +5,16 @@ const CFError = require('cf-errors');
 const { prepareKeyValueFromCLIEnvOption, crudFilenameOption } = require('../../helpers/general');
 const { pipeline } = require('../../../../logic').api;
 const ObjectID = require('mongodb').ObjectID;
+const { log } = require('../../../../logic').api;
+const { workflow } = require('../../../../logic').api;
 
 
 const run = new Command({
     root: true,
     command: 'run <id>',
-    description: 'Run a pipeline',
+    description: 'Run a pipeline and attach the created workflow logs.\nReturns an exist code according to the workflow finish status (Success: 0, Error: 1, Terminated: 2).',
     builder: (yargs) => {
         yargs
-            .usage('Running a pipeline:\n' +
-                '\n' +
-                '1. Provide an explicit pipeline id\n' +
-                '\n' +
-                '2. Provide a pipeline name, repository owner and repository name \n')
             .positional('id', {
                 describe: 'Pipeline id',
             })
@@ -49,8 +46,9 @@ const run = new Command({
                 type: 'number',
                 default: 1,
             })
-            .option('f', {
-                describe: 'Show and follow the logs of the created workflow',
+            .option('detach', {
+                alias: 'd',
+                describe: 'Run pipeline and print workflow ID',
             });
 
         crudFilenameOption(yargs, {
@@ -103,9 +101,34 @@ const run = new Command({
         }
 
         _.forEach(executionRequests, async (request) => {
-            const res = await pipeline.runPipelineById(request.pipelineId, request.options);
-            console.log(res);
+            const workflowId = await pipeline.runPipelineById(request.pipelineId, request.options);
+            if (executionRequests.length === 1) {
+                if (argv.detach) {
+                    console.log(workflowId);
+                } else {
+                    await log.showWorkflowLogs(workflowId, true);
+                    const workflowInstance = await workflow.getWorkflowById(workflowId);
+                    switch (workflowInstance.getStatus()) {
+                        case 'success':
+                            process.exit(0);
+                            break;
+                        case 'error':
+                            process.exit(1);
+                            break;
+                        case 'terminated':
+                            process.exit(2);
+                            break;
+                        default:
+                            process.exit(100);
+                            break;
+                    }
+                }
+            } else {
+                console.log(workflowId);
+            }
         });
+
+
     },
 });
 

lib/logic/api/helper.js

@@ -26,6 +26,8 @@ const sendHttpRequest = async (httpOptions, authContext) => {
             printError('Forbidden error: You do not have permissions to perform this action');
             process.exit(1);
         }
+
+        throw err;
     }
     debug('Response:\n%O', response);
     return response;

lib/logic/api/index.js

@@ -5,7 +5,7 @@ const image = require('./image');
 const composition = require('./composition');
 const environment = require('./environment');
 const workflow = require('./workflow');
-const logs = require('./logs');
+const log = require('./log');
 
 module.exports = {
     user,
@@ -15,5 +15,5 @@ module.exports = {
     composition,
     environment,
     workflow,
-    logs,
+    log,
 };

lib/logic/api/logs.js renamed to lib/logic/api/log.js

@@ -6,6 +6,7 @@ const { sendHttpRequest } = require('./helper');
 const workflows = require('./workflow');
 const Firebase = require('firebase');
 const rp = require('request-promise');
+const logUpdate = require('log-update');
 
 const getFirebaseToken = async () => {
     const options = {
@@ -41,7 +42,7 @@ const printLogsFromJson = (steps) => {
             .join('=');
         console.log(`${prefixSuffix}\nStep: ${step.name}\n${prefixSuffix}`);
         _.forEach(step.logs, (log) => {
-            console.log(log);
+            process.stdout.write(log);
         });
     });
 };
@@ -64,8 +65,41 @@ const printCurrentFirebaseLogs = async (firebaseAuth, progressJobId) => {
     return promise;
 };
 
-// TODO implement
-const printFollowFirebaseLogs = async (firebaseAuth, progressJobId) => { // eslint-disable-line
+
+const printFollowFirebaseLogs = async (firebaseAuth, progressJobId) => {
+    const promise = new Promise((resolve, reject) => {
+        const jobIdRef = new Firebase(`${firebaseAuth.url}/build-logs/${progressJobId}`);
+
+        const errorCallback = (err) => {
+            reject(new CFError({
+                cause: err,
+                message: 'Failed to get logs from firebase',
+            }));
+        };
+
+        jobIdRef.child('status')
+            .on('value', (snapshot) => {
+                const status = snapshot.val();
+                if (['success', 'error', 'terminated'].includes(status)) {
+                    resolve();
+                }
+            }, errorCallback);
+
+        jobIdRef.child('steps')
+            .on('child_added', (snapshot) => {
+                const step = snapshot.val();
+                const prefixSuffix = Array(step.name.length)
+                    .join('=');
+                console.log(`${prefixSuffix}\nStep: ${step.name}\n${prefixSuffix}`);
+                step.ref = snapshot.ref();
+                step.ref.child('logs')
+                    .on('child_added', (snapshot) => {
+                        const log = snapshot.val();
+                        process.stdout.write(log);
+                    }, errorCallback);
+            }, errorCallback);
+    });
+    return promise;
 };
 
 const getProgressJob = async (workflowId) => {
@@ -84,8 +118,8 @@ const getProgressJob = async (workflowId) => {
 const showWorkflowLogsFromFirebase = async (progressJobId, follow) => {
     const firebaseAuth = await getFirebaseToken();
     await connectToFirebase(firebaseAuth);
-    if (follow) { // eslint-disable-line
-        // TODO implement
+    if (follow) {
+        await printFollowFirebaseLogs(firebaseAuth, progressJobId);
     } else {
         await printCurrentFirebaseLogs(firebaseAuth, progressJobId);
     }