Class: Actions::RemoteExecution::RunHostJob

Inherits:
EntryAction
  • Object
show all
Extended by:
ApipieDSL::Class
Includes:
Helpers::WithContinuousOutput, Helpers::WithDelegatedAction, ObservableAction, EventHelpers, 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

Methods included from EventHelpers

#emit_event, included

Methods included from TemplateInvocationProgressLogging

#log_template_invocation_exception, #template_invocation, #with_template_invocation_error_logging

Class Method Details

.event_states ⇒ Object 



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

def self.event_states
  [:success, :failure]
end

Instance Method Details

#check_exit_status ⇒ Object 



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

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 



125
126
127
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 125

def continuous_output_providers
  super << self
end

#exit_status ⇒ Object 



150
151
152
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 150

def exit_status
  task.template_invocation.template_invocation_events.find_by(event_type: 'exit')&.event
end

#fill_continuous_output(continuous_output) ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 129

def fill_continuous_output(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

  # Show the outputs which are already stored in the database
  task.template_invocation.template_invocation_events.order(:timestamp).find_each do |output|
    if output.event_type == 'exit'
      continuous_output.add_output(_('Exit status: %s') % output.event, 'stdout', output.timestamp)
    else
      continuous_output.add_raw_output(output.as_raw_continuous_output)
    end
  end

  # Attach the exception at the end
  continuous_output.add_exception(_('Error loading data from proxy'), e) if e
end

#finalize(*args) ⇒ Object 



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

def finalize(*args)
  with_template_invocation_error_logging do
    update_host_status
    check_exit_status
  end
end

#host ⇒ Object 



170
171
172
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 170

def host
  @host ||= ::Host.authorized.find(host_id)
end

#host_id ⇒ Object 



154
155
156
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 154

def host_id
  input['host']['id']
end

#host_name ⇒ Object 



158
159
160
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 158

def host_name
  input['host']['name']
end

#humanized_input ⇒ Object 



104
105
106
107
108
109
110
111
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 104

def humanized_input
  return unless input.present?

  N_('%{description} on %{host}') % {
    host: input[:host_display_name],
    description: input[:description].try(:capitalize) || input[:job_category],
  }
end

#humanized_name ⇒ Object 



113
114
115
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 113

def humanized_name
  N_('Remote action:')
end

#humanized_output ⇒ Object 



121
122
123
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 121

def humanized_output
  continuous_output.humanize
end

#inner_plan(job_invocation, host, template_invocation, proxy_selector, options) ⇒ Object 



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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 27

def inner_plan(job_invocation, host, template_invocation, proxy_selector, options)
  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,
    :host_display_name => host.to_label,
    :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)

  verify_permissions(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)
  template_invocation.smart_proxy_id = proxy.id
  template_invocation.save!

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

  first_execution = host.executed_through_proxies.where(:id => proxy.id).none?
  host.executed_through_proxies << proxy if first_execution

  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,
                         :first_execution => first_execution,
                         :alternative_names => provider.alternative_names(host) }
  action_options = provider.proxy_command_options(template_invocation, host)
                           .merge(additional_options)

  plan_delegated_action(proxy, provider.proxy_action_class, action_options, proxy_action_class: ::Actions::RemoteExecution::ProxyAction)
  plan_self
end

#job_invocation ⇒ Object 



166
167
168
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 166

def job_invocation
  @job_invocation ||= ::JobInvocation.authorized.find(job_invocation_id)
end

#job_invocation_id ⇒ Object 



162
163
164
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 162

def job_invocation_id
  input['job_invocation_id']
end

#live_output ⇒ Object 



100
101
102
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 100

def live_output
  continuous_output.sort!
end

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



21
22
23
24
25
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 21

def plan(job_invocation, host, template_invocation, proxy_selector = ::RemoteExecutionProxySelector.new, options = {})
  with_template_invocation_error_logging do
    inner_plan(job_invocation, host, template_invocation, proxy_selector, options)
  end
end

#queue ⇒ Object 



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

def queue
  ForemanRemoteExecution::DYNFLOW_QUEUE
end

#rescue_strategy ⇒ Object 



117
118
119
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 117

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

#resource_locks ⇒ Object 



17
18
19
 
# File 'app/lib/actions/remote_execution/run_host_job.rb', line 17

def resource_locks
  :link
end

#secrets(host, job_invocation, provider) ⇒ Object 



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

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