Merge pull request #88 from xebialabs-community/displayStepLogs

Adding display step logs to all running tasks

Author: jdewinne

src/main/resources/synthetic.xml

@@ -36,6 +36,7 @@
                   description="Polling interval in seconds to check task status."/>
         <property name="numberOfPollingTrials" category="input" label="Polling Retry Count" required="true"
                   kind="integer" description="Number of times to retry check for task status."/>
+        <property name="displayStepLogs" category="input" kind="boolean" required="false" default="true"/>
     </type>
 
     <type type="xldeploy.DeployTask" label="XL Deploy: Deploy extended" extends="xldeploy.TaskRunningTask"
@@ -58,7 +59,6 @@
                   label="Cancel If Not Rollbacking" default="true"
                   description="Cancel the task in XL Deploy if the tasks fails and Rollback On Error is not selected."/>
         <property name="failOnPause" category="input" kind="boolean" required="false" default="true"/>
-        <property name="displayStepLogs" category="input" kind="boolean" required="false" default="true"/>
     </type>
 
     <type type="xldeploy.UndeployTask" label="XL Deploy: Undeploy extended" extends="xldeploy.TaskRunningTask"

src/main/resources/xlr_xldeploy/XLDeployClient.py

@@ -146,7 +146,7 @@ def prepare_control_task(self, control_task_name, target_ci_id, parameters=None)
 
     def invoke_task_and_wait_for_result(self, task_id, polling_interval=10, number_of_trials=None,
                                         continue_if_step_fails=False, number_of_continue_retrials=0,
-                                        fail_on_pause=True):
+                                        fail_on_pause=True, display_step_logs = False):
         start_task_url = "/deployit/task/%s/start" % task_id
         self.http_request.post(start_task_url, '', contentType='application/xml')
         trial = 0
@@ -175,6 +175,9 @@ def invoke_task_and_wait_for_result(self, task_id, polling_interval=10, number_o
                 if status in ('FAILED', 'ABORTED', 'CANCELLED', 'DONE', 'EXECUTED'):
                     break
             time.sleep(polling_interval)
+        if display_step_logs:
+            print "Display the step logs"
+            self.display_step_logs(task_id)
         return status
 
     def get_deployment_package(self, deployed_application_id):

src/main/resources/xlr_xldeploy/controlTask.py

@@ -12,17 +12,13 @@
 import sys
 from xlr_xldeploy.XLDeployClientUtil import XLDeployClientUtil
 
-
 xld_client = XLDeployClientUtil.create_xldeploy_client(xldeployServer, username, password)
 
-print 'DEBUG: About to prepare %s on %s\n' % (controlTaskName, ciId)
 task_id = xld_client.prepare_control_task(controlTaskName, ciId, parameters)
-print 'DEBUG: About to invoke task and wait for response', task_id, '\n'
-task_state = xld_client.invoke_task_and_wait_for_result(task_id, pollingInterval, numberOfPollingTrials, continueIfStepFails, numberOfContinueRetrials)
-print 'DEBUG: Task state for', task_id, ':', task_state, '\n'
+task_state = xld_client.invoke_task_and_wait_for_result(task_id, pollingInterval, numberOfPollingTrials,
+                                                        continueIfStepFails, numberOfContinueRetrials,
+                                                        display_step_logs=displayStepLogs)
 xld_client.archive_task(task_id)
-if task_state in ('DONE','EXECUTED'):
+if task_state in ('DONE', 'EXECUTED'):
     sys.exit(0)
 sys.exit(1)
-
-

src/main/resources/xlr_xldeploy/deployTask.py

@@ -25,7 +25,8 @@
 # Mapping deployables to the target environment
 # deploymentProperties + configure orchestrators
 print "Mapping all deployables \n"
-deployment = xld_client.deployment_prepare_deployeds(deployment, orchestrators, deployedApplicationProperties, overrideDeployedProps, deployedProperties)
+deployment = xld_client.deployment_prepare_deployeds(deployment, orchestrators, deployedApplicationProperties,
+                                                     overrideDeployedProps, deployedProperties)
 
 print "Validating the deployment\n"
 validation_messages = xld_client.validate(deployment)
@@ -41,11 +42,9 @@
 taskId = xld_client.get_deployment_task_id(deployment)
 
 print "Execute task with id: %s" % taskId
-taskState = xld_client.invoke_task_and_wait_for_result(taskId, pollingInterval, numberOfPollingTrials, continueIfStepFails, numberOfContinueRetrials, failOnPause)
-
-if displayStepLogs:
-    print "Display the step logs"
-    xld_client.display_step_logs(taskId)
+taskState = xld_client.invoke_task_and_wait_for_result(taskId, pollingInterval, numberOfPollingTrials,
+                                                       continueIfStepFails, numberOfContinueRetrials, failOnPause,
+                                                       display_step_logs=displayStepLogs)
 
 if taskState in ('DONE', 'EXECUTED'):
     print "Deployment ended in %s \n" % taskState
@@ -58,7 +57,9 @@
         print "Going to rollback \n"
         xld_client.stop_task(taskId)
         rollBackTaskId = xld_client.deployment_rollback(taskId)
-        taskState = xld_client.invoke_task_and_wait_for_result(rollBackTaskId, pollingInterval, numberOfPollingTrials, continueIfStepFails, numberOfContinueRetrials)
+        taskState = xld_client.invoke_task_and_wait_for_result(rollBackTaskId, pollingInterval, numberOfPollingTrials,
+                                                               continueIfStepFails, numberOfContinueRetrials,
+                                                               display_step_logs=displayStepLogs)
         xld_client.archive_task(rollBackTaskId)
     elif cancelOnError:
         print "Task failed; cancelling task. \n"

src/main/resources/xlr_xldeploy/undeployTask.py

@@ -35,7 +35,8 @@
 
 print "Execute task with id: %s" % task_id
 task_state = xld_client.invoke_task_and_wait_for_result(task_id, pollingInterval, numberOfPollingTrials,
-                                                        continueIfStepFails, numberOfContinueRetrials, failOnPause)
+                                                        continueIfStepFails, numberOfContinueRetrials, failOnPause,
+                                                        display_step_logs=displayStepLogs)
 
 xld_client.display_step_logs(task_id)
 
@@ -50,7 +51,8 @@
     xld_client.stop_task(task_id)
     rollback_task_id = xld_client.deployment_rollback(task_id)
     task_state = xld_client.invoke_task_and_wait_for_result(rollback_task_id, pollingInterval, numberOfPollingTrials,
-                                                            continueIfStepFails, numberOfContinueRetrials)
+                                                            continueIfStepFails, numberOfContinueRetrials,
+                                                            display_step_logs=displayStepLogs)
     xld_client.archive_task(rollback_task_id)
     sys.exit(1)
 elif task_state in ('FAILED', 'STOPPED'):