Add #raw_stdout_via_worker method

app/models/manageiq/providers/embedded_ansible/automation_manager/job.rb

@@ -7,4 +7,28 @@ def retire_now(requester = nil)
     update_attributes(:retirement_requester => requester)
     finish_retirement
   end
+
+  # Intend to be called by UI to display stdout. The stdout is stored in MiqTask#task_results or #message if error
+  # Since the task_results may contain a large block of data, it is desired to remove the task upon receiving the data
+  def raw_stdout_via_worker(userid, format = 'txt')
+    unless MiqRegion.my_region.role_active?("embedded_ansible")
+      msg = "Cannot get standard output of this playbook because the embedded Ansible role is not enabled"
+      return MiqTask.create(
+        :name    => 'ansible_stdout',
+        :userid  => userid || 'system',
+        :state   => MiqTask::STATE_FINISHED,
+        :status  => MiqTask::STATUS_ERROR,
+        :message => msg
+      ).id
+    end
+
+    options = {:userid => userid || 'system', :action => 'ansible_stdout'}
+    queue_options = {:class_name  => self.class,
+                     :method_name => 'raw_stdout',
+                     :instance_id => id,
+                     :args        => [format],
+                     :priority    => MiqQueue::HIGH_PRIORITY,
+                     :role        => 'embedded_ansible'}
+    MiqTask.generic_action_with_callback(options, queue_options)
+  end
 end

spec/models/manageiq/providers/embedded_ansible/automation_manager/job_spec.rb

@@ -7,4 +7,57 @@
     expect(job).to receive(:finish_retirement).once
     job.retire_now
   end
+
+  describe '#raw_stdout_via_worker' do
+    before do
+      EvmSpecHelper.create_guid_miq_server_zone
+      region = MiqRegion.seed
+      allow(region).to receive(:role_active?).with("embedded_ansible").and_return(role_enabled)
+      allow(MiqRegion).to receive(:my_region).and_return(region)
+    end
+
+    context 'when embedded_ansible role is enabled' do
+      let(:role_enabled) { true }
+
+      before do
+        allow(described_class).to receive(:find).and_return(job)
+
+        allow(MiqTask).to receive(:wait_for_taskid) do
+          request = MiqQueue.find_by(:class_name => described_class.name)
+          request.update_attributes(:state => MiqQueue::STATE_DEQUEUE)
+          request.delivered(*request.deliver)
+        end
+      end
+
+      it 'gets stdout from the job' do
+        expect(job).to receive(:raw_stdout).and_return('A stdout from the job')
+        taskid = job.raw_stdout_via_worker('user')
+        MiqTask.wait_for_taskid(taskid)
+        expect(MiqTask.find(taskid)).to have_attributes(
+          :task_results => 'A stdout from the job',
+          :status       => 'Ok'
+        )
+      end
+
+      it 'returns the error message' do
+        expect(job).to receive(:raw_stdout).and_throw('Failed to get stdout from the job')
+        taskid = job.raw_stdout_via_worker('user')
+        MiqTask.wait_for_taskid(taskid)
+        expect(MiqTask.find(taskid).message).to include('Failed to get stdout from the job')
+        expect(MiqTask.find(taskid).status).to eq('Error')
+      end
+    end
+
+    context 'when embedded_ansible role is disabled' do
+      let(:role_enabled) { false }
+
+      it 'returns an error message' do
+        taskid = job.raw_stdout_via_worker('user')
+        expect(MiqTask.find(taskid)).to have_attributes(
+          :message => 'Cannot get standard output of this playbook because the embedded Ansible role is not enabled',
+          :status  => 'Error'
+        )
+      end
+    end
+  end
 end