Class: Actions::RemoteExecution::RunHostJob
- Inherits:
-
EntryAction
- Object
- EntryAction
- Actions::RemoteExecution::RunHostJob
- Extended by:
- ApipieDSL::Class
- Includes:
- Helpers::WithContinuousOutput, Helpers::WithDelegatedAction, ObservableAction, TemplateInvocationProgressLogging
- Defined in:
- app/lib/actions/remote_execution/run_host_job.rb
Defined Under Namespace
Classes: Jail
Class Method Summary collapse
Instance Method Summary collapse
- #check_exit_status ⇒ Object
- #continuous_output_from_template_invocation_events(continuous_output) ⇒ Object
- #continuous_output_providers ⇒ Object
- #emit_feature_event(execution_plan, hook = :success) ⇒ Object
- #exit_status ⇒ Object
- #fill_continuous_output(continuous_output) ⇒ Object
- #finalize(*args) ⇒ Object
- #host ⇒ Object
- #host_id ⇒ Object
- #host_name ⇒ Object
- #humanized_input ⇒ Object
- #humanized_name ⇒ Object
- #humanized_output ⇒ Object
- #inner_plan(job_invocation, host, template_invocation, proxy_selector, options) ⇒ Object
- #job_invocation ⇒ Object
- #job_invocation_id ⇒ Object
- #live_output ⇒ Object
- #plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {}) ⇒ Object
- #queue ⇒ Object
- #rescue_strategy ⇒ Object
- #resource_locks ⇒ Object
- #secrets(host, job_invocation, provider) ⇒ Object
Methods included from TemplateInvocationProgressLogging
#log_template_invocation_exception, #template_invocation, #with_template_invocation_error_logging
Class Method Details
.feature_job_event_name(label, suffix = :success) ⇒ Object
82 83 84 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 82 def self.feature_job_event_name(label, suffix = :success) ::Foreman::Observable.event_name_for("#{::Actions::RemoteExecution::RunHostJob.event_name_base}_#{label}_#{::Actions::RemoteExecution::RunHostJob.event_name_suffix(suffix)}") end |
Instance Method Details
#check_exit_status ⇒ Object
106 107 108 109 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 106 def check_exit_status error! ForemanTasks::Task::TaskCancelledException.new(_('Task cancelled')) if delegated_action && delegated_action.output[:cancel_sent] error! _('Job execution failed') if exit_status.to_s != '0' end |
#continuous_output_from_template_invocation_events(continuous_output) ⇒ Object
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 163 def continuous_output_from_template_invocation_events(continuous_output) begin # Trigger reload delegated_output unless task.state == 'stopped' rescue => e # This is enough, the error will get shown using add_exception at the end of the method end task.template_invocation.template_invocation_events.order(:sequence_id).find_each do |output| if output.event_type == 'exit' continuous_output.add_output(_('Exit status: %s') % output.event, 'stdout', output.) else continuous_output.add_raw_output(output.as_raw_continuous_output) end end continuous_output.add_exception(_('Error loading data from proxy'), e) if e end |
#continuous_output_providers ⇒ Object
133 134 135 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 133 def continuous_output_providers super << self end |
#emit_feature_event(execution_plan, hook = :success) ⇒ Object
86 87 88 89 90 91 92 93 94 95 96 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 86 def emit_feature_event(execution_plan, hook = :success) return unless root_action? payload = event_payload(execution_plan) if input["job_features"]&.any? input['job_features'].each do |feature| name = "#{self.class.event_name_base}_#{feature}_#{self.class.event_name_suffix(hook)}" trigger_hook name, payload: payload end end end |
#exit_status ⇒ Object
181 182 183 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 181 def exit_status input[:with_event_logging] ? task.template_invocation.template_invocation_events.find_by(event_type: 'exit')&.event : delegated_output[:exit_status] end |
#fill_continuous_output(continuous_output) ⇒ Object
137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 137 def fill_continuous_output(continuous_output) if input[:with_event_logging] continuous_output_from_template_invocation_events(continuous_output) return end delegated_output.fetch('result', []).each do |raw_output| continuous_output.add_raw_output(raw_output) end = (continuous_output. || task.ended_at).to_f + 1 if task.state == 'stopped' && task.result == 'cancelled' continuous_output.add_output(_('Job cancelled by user'), 'debug', ) else fill_planning_errors_to_continuous_output(continuous_output) unless exit_status end if exit_status continuous_output.add_output(_('Exit status: %s') % exit_status, 'stdout', ) elsif run_step&.error continuous_output.add_output(_('Job finished with error') + ": #{run_step.error.exception_class} - #{run_step.error.}", 'debug', ) end rescue => e continuous_output.add_exception(_('Error loading data from proxy'), e) end |
#finalize(*args) ⇒ Object
75 76 77 78 79 80 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 75 def finalize(*args) with_template_invocation_error_logging do update_host_status check_exit_status end end |
#host ⇒ Object
201 202 203 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 201 def host @host ||= ::Host..find(host_id) end |
#host_id ⇒ Object
185 186 187 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 185 def host_id input['host']['id'] end |
#host_name ⇒ Object
189 190 191 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 189 def host_name input['host']['name'] end |
#humanized_input ⇒ Object
116 117 118 119 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 116 def humanized_input N_('%{description} on %{host}') % { :host => input[:host].try(:[], :name), :description => input[:description].try(:capitalize) || input[:job_category] } end |
#humanized_name ⇒ Object
121 122 123 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 121 def humanized_name N_('Remote action:') end |
#humanized_output ⇒ Object
129 130 131 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 129 def humanized_output continuous_output.humanize end |
#inner_plan(job_invocation, host, template_invocation, proxy_selector, options) ⇒ Object
28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 28 def inner_plan(job_invocation, host, template_invocation, proxy_selector, ) raise _('Could not use any template used in the job invocation') if template_invocation.blank? features = template_invocation.template.remote_execution_features.pluck(:label).uniq action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description, :job_invocation_id => job_invocation.id, :job_features => features) template_invocation.host_id = host.id template_invocation.run_host_job_task_id = task.id template_invocation.save! link!(job_invocation) link!(template_invocation) (host, template_invocation) provider = template_invocation.template.provider proxy_selector = provider.required_proxy_selector_for(template_invocation.template) || proxy_selector provider_type = provider.proxy_feature proxy = determine_proxy!(proxy_selector, provider_type, host) link!(proxy) input[:proxy_id] = proxy.id renderer = InputTemplateRenderer.new(template_invocation.template, host, template_invocation) script = renderer.render raise _('Failed rendering template: %s') % renderer. unless script first_execution = host.executed_through_proxies.where(:id => proxy.id).none? host.executed_through_proxies << proxy if first_execution = { :hostname => provider.find_ip_or_hostname(host), :script => script, :execution_timeout_interval => job_invocation.execution_timeout_interval, :secrets => secrets(host, job_invocation, provider), :use_batch_triggering => true, :first_execution => first_execution, :alternative_names => provider.alternative_names(host) } = provider.(template_invocation, host) .merge() plan_delegated_action(proxy, provider.proxy_action_class, , proxy_action_class: ::Actions::RemoteExecution::ProxyAction) plan_self :with_event_logging => true end |
#job_invocation ⇒ Object
197 198 199 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 197 def job_invocation @job_invocation ||= ::JobInvocation..find(job_invocation_id) end |
#job_invocation_id ⇒ Object
193 194 195 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 193 def job_invocation_id input['job_invocation_id'] end |
#live_output ⇒ Object
111 112 113 114 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 111 def live_output continuous_output.sort! continuous_output.raw_outputs end |
#plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {}) ⇒ Object
22 23 24 25 26 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 22 def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, = {}) with_template_invocation_error_logging do inner_plan(job_invocation, host, template_invocation, proxy_selector, ) end end |
#queue ⇒ Object
14 15 16 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 14 def queue ForemanRemoteExecution::DYNFLOW_QUEUE end |
#rescue_strategy ⇒ Object
125 126 127 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 125 def rescue_strategy ::Dynflow::Action::Rescue::Fail end |
#resource_locks ⇒ Object
18 19 20 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 18 def resource_locks :link end |
#secrets(host, job_invocation, provider) ⇒ Object
98 99 100 101 102 103 104 |
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 98 def secrets(host, job_invocation, provider) job_secrets = { :ssh_password => job_invocation.password, :key_passphrase => job_invocation.key_passphrase, :effective_user_password => job_invocation.effective_user_password } job_secrets.merge(provider.secrets(host)) { |_key, job_secret, provider_secret| job_secret || provider_secret } end |