Class: Morpheus::Cli::Tasks

Inherits:
Object
  • Object
show all
Includes:
CliCommand
Defined in:
lib/morpheus/cli/tasks.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from CliCommand

#build_common_options, #build_option_type_options, #command_name, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #puts, #puts_error, #raise_command_error, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!

Instance Method Details

#_get(id, options) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/morpheus/cli/tasks.rb', line 94

def _get(id, options)
  task_name = id
  begin
    if options[:dry_run]
      if task_name.to_s =~ /\A\d{1,}\Z/
        print_dry_run @tasks_interface.dry.get(task_name.to_i)
      else
        print_dry_run @tasks_interface.dry.get({name: task_name})
      end
      return
    end
    task = find_task_by_name_or_id(task_name)
    exit 1 if task.nil?
    # refetch it
    json_response = {'task' => task}
    unless task_name.to_s =~ /\A\d{1,}\Z/
      json_response = @tasks_interface.get(task['id'])
    end
    if options[:json]
      puts as_json(json_response, options, "task")
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "task")
      return 0
    elsif options[:csv]
      puts records_as_csv([json_response['task']], options)
      return 0
    else
      # load task type to know which options to display
      task_type = task['taskType'] ? find_task_type_by_name(task['taskType']['name']) : nil
      #print "\n", cyan, "Task #{task['name']} - #{task['taskType']['name']}\n\n"
      print_h1 "Task Details"
      print cyan
      description_cols = {
        "ID" => 'id',
        "Name" => 'name',
        "Type" => lambda {|it| it['taskType']['name'] },
      }
      print_description_list(description_cols, task)
      
      # JD: uhh, the api should NOT be returning passwords!!
      if task_type
        task_type['optionTypes'].sort { |x,y| x['displayOrder'].to_i <=> y['displayOrder'].to_i }.each do |optionType|
          if optionType['fieldLabel'].to_s.downcase == 'script'
            print_h2 "Script"
            print reset,bright_black,"#{task['taskOptions'][optionType['fieldName']]}","\n",reset
          else
            print cyan,("#{optionType['fieldLabel']} : " + (optionType['type'] == 'password' ? "#{task['taskOptions'][optionType['fieldName']] ? '************' : ''}" : "#{task['taskOptions'][optionType['fieldName']] || optionType['defaultValue']}")),"\n"
          end
        end
      else
        print yellow,"Task type not found.",reset,"\n"
      end
      print reset,"\n"
      return 0
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#add(args) ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/morpheus/cli/tasks.rb', line 257

def add(args)
  params = {}
  options = {}
  task_name = nil
  task_type_name = nil
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] -t TASK_TYPE")
    opts.on( '-t', '--type TASK_TYPE', "Task Type" ) do |val|
      task_type_name = val
    end
    opts.on('--name NAME', String, "Task Name" ) do |val|
      task_name = val
    end
    opts.on('--file FILE', "File containing the script. This can be used instead of --O taskOptions.script" ) do |filename|
      full_filename = File.expand_path(filename)
      if File.exists?(full_filename)
        options[:options] ||= {}
        options[:options]['taskOptions'] ||= {}
        options[:options]['taskOptions']['script'] = File.read(full_filename)
        # params['script'] = File.read(full_filename)
      else
        print_red_alert "File not found: #{full_filename}"
        exit 1
      end
      # use the filename as the name by default.
      if !params['name']
        options[:options] ||= {}
        options[:options]['taskOptions'] ||= {}
        options[:options]['taskOptions']['script'] = File.read(full_filename)
        params['name'] = File.basename(full_filename)
      end
    end
    build_common_options(opts, options, [:options, :payload, :json, :dry_run, :quiet, :remote])
  end
  optparse.parse!(args)
  if args[0]
    task_name = args[0]
  end

  if task_name.nil? || task_type_name.nil?
    puts optparse
    exit 1
  end
  connect(options)
  begin
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      # construct payload
      task_type = find_task_type_by_name(task_type_name)
      if task_type.nil?
        puts "Task Type not found by id '#{task_type_name}'!"
        return 1
      end
      input_options = Morpheus::Cli::OptionTypes.prompt(task_type['optionTypes'],options[:options],@api_client, options[:params])
      payload = {task: {name: task_name, taskOptions: input_options['taskOptions'], taskType: {code: task_type['code'], id: task_type['id']}}}
    end
    if options[:dry_run]
      print_dry_run @tasks_interface.dry.create(payload)
      return
    end
    json_response = @tasks_interface.create(payload)
    task = json_response['task']
    if options[:json]
      print JSON.pretty_generate(json_response),"\n"
    elsif !options[:quiet]
      task = json_response['task']
      print "\n", cyan, "Task #{task['name']} created successfully", reset, "\n\n"
      get([task['id']])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



16
17
18
19
20
 
# File 'lib/morpheus/cli/tasks.rb', line 16

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @tasks_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).tasks
  @task_sets_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).task_sets
end

#get(args) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/morpheus/cli/tasks.rb', line 76

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[workflow]")
    build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    return 1
  end
  connect(options)
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, options)
  end
end

#handle(args) ⇒ Object 



22
23
24
 
# File 'lib/morpheus/cli/tasks.rb', line 22

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



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

def list(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    opts.on('--types x,y,z', Array, "Filter by task type code(s)") do |val|
      params['taskTypeCodes'] = val
    end
    build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
  end
  optparse.parse!(args)
  connect(options)
  begin
    params.merge!(parse_list_options(options))
    if options[:dry_run]
      print_dry_run @tasks_interface.dry.get(params)
      return
    end
    json_response = @tasks_interface.get(params)
    # print result and return output
    if options[:json]
      puts as_json(json_response, options, "tasks")
      return 0
    elsif options[:csv]
      puts records_as_csv(json_response['tasks'], options)
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "tasks")
      return 0
    else
      title = "Morpheus Tasks"
      subtitles = []
      subtitles += parse_list_subtitles(options)
      print_h1 title, subtitles
      tasks = json_response['tasks']
      if tasks.empty?
        print cyan,"No tasks found.",reset,"\n"
      else
        print cyan
        print_tasks_table(tasks, options)
        print_results_pagination(json_response)
      end
      print reset,"\n"
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#remove(args) ⇒ Object 



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/morpheus/cli/tasks.rb', line 334

def remove(args)
  params = {}
  task_name = args[0]
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[task]")
    build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :quiet, :remote])
    opts.on( '-f', '--force', "Force Delete" ) do
      params[:force] = true
    end
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  begin
    task = find_task_by_name_or_id(task_name)
    exit 1 if task.nil?
    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the task #{task['name']}?")
      exit
    end
    if options[:dry_run]
      print_dry_run @tasks_interface.dry.destroy(task['id'], params)
      return
    end
    json_response = @tasks_interface.destroy(task['id'], params)
    if options[:json]
      print JSON.pretty_generate(json_response),"\n"
    elsif !options[:quiet]
      print "\n", cyan, "Task #{task['name']} removed", reset, "\n\n"
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#task_types(args) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/morpheus/cli/tasks.rb', line 220

def task_types(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:json, :dry_run, :remote])
  end
  optparse.parse!(args)
  connect(options)
  begin
    if options[:dry_run]
      print_dry_run @tasks_interface.dry.task_types()
      return
    end
    json_response = @tasks_interface.task_types()
    if options[:json]
      print JSON.pretty_generate(json_response),"\n"
    else
      task_types = json_response['taskTypes']
      print_h1 "Morpheus Task Types"
      if task_types.nil? || task_types.empty?
        print yellow,"No task types currently exist on this appliance. This could be a seed issue.",reset,"\n"
      else
        print cyan
        tasks_table_data = task_types.collect do |task_type|
          {name: task_type['name'], id: task_type['id'], code: task_type['code'], description: task_type['description']}
        end
        tp tasks_table_data, :id, :name, :code
      end

      print reset,"\n"
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/morpheus/cli/tasks.rb', line 156

def update(args)
  options = {}
   = nil
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[task] [options]")
    build_common_options(opts, options, [:options, :json, :dry_run, :remote])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  task_name = args[0]
  connect(options)
  begin


    task = find_task_by_name_or_id(task_name)
    exit 1 if task.nil?
    task_type = find_task_type_by_name(task['taskType']['name'])

    #params = Morpheus::Cli::OptionTypes.prompt(add_user_option_types, options[:options], @api_client, options[:params]) # options[:params] is mysterious
    params = options[:options] || {}

    if params.empty?
      puts optparse.banner
      option_lines = update_task_option_types(task_type).collect {|it| "\t-O #{it['fieldContext'] ? (it['fieldContext'] + '.') : ''}#{it['fieldName']}=\"value\"" }.join("\n")
      puts "\nAvailable Options:\n#{option_lines}\n\n"
      exit 1
    end

    #puts "parsed params is : #{params.inspect}"
    task_keys = ['name']
    changes_payload = (params.select {|k,v| task_keys.include?(k) })
    task_payload = task
    if changes_payload
      task_payload.merge!(changes_payload)
    end
    if params['taskOptions']
      task_payload['taskOptions'].merge!(params['taskOptions'])
    end

    payload = {task: task_payload}
    if options[:dry_run]
      print_dry_run @tasks_interface.dry.update(task['id'], payload)
      return
    end
    response = @tasks_interface.update(task['id'], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      if !response['success']
        exit 1
      end
    else
      print "\n", cyan, "Task #{response['task']['name']} updated", reset, "\n\n"
      get([task['id']])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end