Class: Actions::RemoteExecution::RunHostJob

Inherits:
EntryAction
  • Object
show all
Includes:
Helpers::WithContinuousOutput, Helpers::WithDelegatedAction
Defined in:
app/lib/actions/remote_execution/run_host_job.rb

Instance Method Summary collapse

Instance Method Details

#check_exit_status ⇒ Object 



67
68
69
70
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 67

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_providers ⇒ Object 



94
95
96
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 94

def continuous_output_providers
  super << self
end

#exit_status ⇒ Object 



119
120
121
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 119

def exit_status
  delegated_output[:exit_status]
end

#fill_continuous_output(continuous_output) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 98

def fill_continuous_output(continuous_output)
  delegated_output.fetch('result', []).each do |raw_output|
    continuous_output.add_raw_output(raw_output)
  end

  final_timestamp = (continuous_output.last_timestamp || task.ended_at).to_f + 1

  if task.state == 'stopped' && task.result == 'cancelled'
    continuous_output.add_output(_('Job cancelled by user'), 'debug', final_timestamp)
  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', final_timestamp)
  elsif run_step&.error
    continuous_output.add_output(_('Job finished with error') + ": #{run_step.error.exception_class} - #{run_step.error.message}", 'debug', final_timestamp)
  end
rescue => e
  continuous_output.add_exception(_('Error loading data from proxy'), e)
end

#finalize(*args) ⇒ Object 



54
55
56
57
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 54

def finalize(*args)
  update_host_status
  check_exit_status
end

#humanized_input ⇒ Object 



77
78
79
80
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 77

def humanized_input
  N_('%{description} on %{host}') % { :host => input[:host].try(:[], :name),
                                      :description => input[:description].try(:capitalize) || input[:job_category] }
end

#humanized_name ⇒ Object 



82
83
84
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 82

def humanized_name
  N_('Remote action:')
end

#humanized_output ⇒ Object 



90
91
92
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 90

def humanized_output
  continuous_output.humanize
end

#live_output ⇒ Object 



72
73
74
75
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 72

def live_output
  continuous_output.sort!
  continuous_output.raw_outputs
end

#plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {}) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
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
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 18

def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {})
  action_subject(host, :job_category => job_invocation.job_category, :description => job_invocation.description)

  template_invocation.host_id = host.id
  template_invocation.run_host_job_task_id = task.id
  template_invocation.save!

  link!(job_invocation)
  link!(template_invocation)

  verify_permissions(host, template_invocation)

  raise _('Could not use any template used in the job invocation') if template_invocation.blank?

  provider_type = template_invocation.template.provider_type.to_s
  proxy = determine_proxy!(proxy_selector, provider_type, host)

  renderer = InputTemplateRenderer.new(template_invocation.template, host, template_invocation)
  script = renderer.render
  raise _('Failed rendering template: %s') % renderer.error_message unless script

  provider = template_invocation.template.provider

  additional_options = { :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,
                         :use_concurrency_control => options[:use_concurrency_control]}
  action_options = provider.proxy_command_options(template_invocation, host)
                           .merge(additional_options)

  plan_delegated_action(proxy, provider.proxy_action_class, action_options)
  plan_self
end

#queue ⇒ Object 



10
11
12
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 10

def queue
  ForemanRemoteExecution::DYNFLOW_QUEUE
end

#rescue_strategy ⇒ Object 



86
87
88
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 86

def rescue_strategy
  ::Dynflow::Action::Rescue::Fail
end

#resource_locks ⇒ Object 



14
15
16
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 14

def resource_locks
  :link
end

#secrets(host, job_invocation, provider) ⇒ Object 



59
60
61
62
63
64
65
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 59

def secrets(host, job_invocation, provider)
  job_secrets = { :ssh_password => job_invocation.password,
                  :key_passphrase => job_invocation.key_passphrase,
                  :sudo_password => job_invocation.sudo_password }

  job_secrets.merge(provider.secrets(host)) { |_key, job_secret, provider_secret| job_secret || provider_secret }
end