Class: Proxy::RemoteExecution::Ssh::Actions::PullScript

Inherits:
Dynflow::Action::Runner
  • Object
show all
Defined in:
lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb

Constant Summary collapse

JobDelivered = 
Class.new
PickupTimeout = 
Class.new
ResendNotification = 
Class.new

Instance Method Summary collapse

Instance Method Details

#cleanup(_plan = nil) ⇒ Object 



55
56
57
58
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 55

def cleanup(_plan = nil)
  job_storage.drop_job(execution_plan_id, run_step_id)
  Proxy::Dynflow::OtpManager.passwords.delete(execution_plan_id)
end

#host_name ⇒ Object 



158
159
160
161
162
163
164
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 158

def host_name
  alternative_names = input.fetch(:alternative_names, {})

  alternative_names[:consumer_uuid] ||
    alternative_names[:fqdn] ||
    input[:hostname]
end

#init_run ⇒ Object 



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 38

def init_run
  otp_password = if input[:with_mqtt]
                   ::Proxy::Dynflow::OtpManager.generate_otp(execution_plan_id)
                 end

  plan_event(PickupTimeout, input[:time_to_pickup], optional: true) if input[:time_to_pickup]

  input[:job_uuid] = job_storage.store_job(host_name, execution_plan_id, run_step_id, input[:script].tr("\r", ''), effective_user: input[:effective_user])
  output[:state] = :ready_for_pickup
  output[:result] = []
  if input[:with_mqtt]
    schedule_mqtt_resend
    mqtt_start(otp_password)
  end
  suspend
end

#job_storage ⇒ Object 



174
175
176
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 174

def job_storage
  Proxy::RemoteExecution::Ssh.job_storage
end

#kill_run ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 100

def kill_run
  case output[:state]
  when :ready_for_pickup
    # If the job is not running yet on the client, wipe it from storage
    cleanup
    # TODO: Stop the action
  when :notified, :running
    # Client was notified or is already running, dealing with this situation
    # is only supported if mqtt is available
    # Otherwise we have to wait it out
    mqtt_cancel if input[:with_mqtt]
  end
  suspend
end

#mqtt_cancel ⇒ Object 



132
133
134
135
136
137
138
139
140
141
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 132

def mqtt_cancel
  cleanup
  payload = mqtt_payload_base.merge(
    metadata: {
      'event': 'cancel',
      'job_uuid': input[:job_uuid]
    }
  )
  mqtt_notify payload
end

#mqtt_notify(payload) ⇒ Object 



143
144
145
146
147
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 143

def mqtt_notify(payload)
  with_mqtt_client do |c|
    c.publish(mqtt_topic, JSON.dump(payload), false, 1)
  end
end

#mqtt_payload_base ⇒ Object 



178
179
180
181
182
183
184
185
186
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 178

def mqtt_payload_base
  {
    type: 'data',
    message_id: SecureRandom.uuid,
    version: 1,
    sent: DateTime.now.iso8601,
    directive: 'foreman'
  }
end

#mqtt_start(otp_password) ⇒ Object 



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 115

def mqtt_start(otp_password)
  payload = mqtt_payload_base.merge(
    content: "#{input[:proxy_url]}/ssh/jobs/#{input[:job_uuid]}",
    metadata: {
      'event': 'start',
      'job_uuid': input[:job_uuid],
      'username': execution_plan_id,
      'password': otp_password,
      'return_url': "#{input[:proxy_url]}/ssh/jobs/#{input[:job_uuid]}/update",
      'version': 'v1',
      'effective_user': input[:effective_user]
    },
  )
  mqtt_notify payload
  output[:state] = :notified
end

#mqtt_topic ⇒ Object 



166
167
168
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 166

def mqtt_topic
  "yggdrasil/#{host_name}/data/in"
end

#plan(action_input, mqtt: false) ⇒ Object 



13
14
15
16
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 13

def plan(action_input, mqtt: false)
  super(action_input)
  input[:with_mqtt] = mqtt
end

#process_external_event(event) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 60

def process_external_event(event)
  output[:state] = :running
  data = event.data
  case data['version']
  when nil
    process_external_unversioned(data)
  when '1'
    process_external_v1(data)
  else
    raise "Unexpected update message version '#{data['version']}'"
  end
end

#process_external_unversioned(payload) ⇒ Object 



73
74
75
76
77
78
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 73

def process_external_unversioned(payload)
  continuous_output = Proxy::Dynflow::ContinuousOutput.new
  Array(payload['output']).each { |line| continuous_output.add_output(line, payload['type']) } if payload.key?('output')
  exit_code = payload['exit_code'].to_i if payload['exit_code']
  process_update(Proxy::Dynflow::Runner::Update.new(continuous_output, exit_code))
end

#process_external_v1(payload) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 80

def process_external_v1(payload)
  continuous_output = Proxy::Dynflow::ContinuousOutput.new
  exit_code = nil

  payload['updates'].each do |update|
    time = Time.parse update['timestamp']
    type = update['type']
    case type
    when 'output'
      continuous_output.add_output(update['content'], update['stream'], time)
    when 'exit'
      exit_code = update['exit_code'].to_i
    else
      raise "Unexpected update type '#{update['type']}'"
    end
  end

  process_update(Proxy::Dynflow::Runner::Update.new(continuous_output, exit_code))
end

#process_pickup_timeout ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 188

def process_pickup_timeout
  if output[:state] != :delivered
    raise "The job was not picked up in time"
  else
    suspend
  end
end

#run(event = nil) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 18

def run(event = nil)
  if event == JobDelivered
    output[:state] = :delivered
    suspend
  elsif event == PickupTimeout
    process_pickup_timeout
  elsif event == ResendNotification
    if input[:with_mqtt] && %w(ready_for_pickup notified).include?(output[:state])
      schedule_mqtt_resend
      mqtt_start(::Proxy::Dynflow::OtpManager.passwords[execution_plan_id])
    end
    suspend
  else
    super
  end
rescue => e
  action_logger.error(e)
  process_update(Proxy::Dynflow::Runner::Update.encode_exception('Proxy error', e))
end

#schedule_mqtt_resend ⇒ Object 



196
197
198
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 196

def schedule_mqtt_resend
  plan_event(ResendNotification, settings[:mqtt_resend_interval], optional: true)
end

#settings ⇒ Object 



170
171
172
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 170

def settings
  Proxy::RemoteExecution::Ssh::Plugin.settings
end

#with_mqtt_client(&block) ⇒ Object 



149
150
151
152
153
154
155
156
 
# File 'lib/smart_proxy_remote_execution_ssh/actions/pull_script.rb', line 149

def with_mqtt_client(&block)
  MQTT::Client.connect(settings.mqtt_broker, settings.mqtt_port,
                       :ssl => settings.mqtt_tls,
                       :cert_file => ::Proxy::SETTINGS.foreman_ssl_cert || ::Proxy::SETTINGS.ssl_certificate,
                       :key_file => ::Proxy::SETTINGS.foreman_ssl_key || ::Proxy::SETTINGS.ssl_private_key,
                       :ca_file => ::Proxy::SETTINGS.foreman_ssl_ca || ::Proxy::SETTINGS.ssl_ca_file,
                       &block)
end