Class: Morpheus::Cli::LibraryOptionListsCommand

Inherits:
Object
  • Object
show all
Includes:
CliCommand, LibraryHelper
Defined in:
lib/morpheus/cli/commands/library_option_lists_command.rb

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from LibraryHelper

#api_client, #find_container_type_by_id, #find_container_type_by_name, #find_container_type_by_name_or_id, #find_instance_type_by_id, #find_instance_type_by_name, #find_instance_type_by_name_or_id, #find_option_type_by_id, #find_option_type_by_name, #find_option_type_by_name_or_id, #find_option_type_list_by_id, #find_option_type_list_by_name, #find_option_type_list_by_name_or_id, #find_spec_template_by_id, #find_spec_template_by_name, #find_spec_template_by_name_or_id, #find_spec_template_type_by_id, #find_spec_template_type_by_name_or_code, #find_spec_template_type_by_name_or_code_id, #format_container_type_technology, #format_instance_type_technology, #get_all_spec_template_types, included, #load_balance_protocols_dropdown, #print_container_types_table, #print_instance_types_table, #print_resource_specs_table, #prompt_exposed_ports, #prompt_for_container_types, #prompt_for_option_types, #prompt_for_spec_templates

Methods included from CliCommand

#add_query_parameter, #apply_options, #build_common_options, #build_get_options, #build_list_options, #build_option_type_options, #build_standard_add_many_options, #build_standard_add_options, #build_standard_api_options, #build_standard_delete_options, #build_standard_get_options, #build_standard_list_options, #build_standard_post_options, #build_standard_put_options, #build_standard_remove_options, #build_standard_update_options, #command_description, #command_name, #confirm, #confirm!, #default_refresh_interval, #default_sigdig, #default_subcommand, #establish_remote_appliance_connection, #execute_api, #execute_api_payload, #execute_api_request, #find_all, #find_all_json, #find_by_id, #find_by_name, #find_by_name_or_id, #find_record, #find_record_json, #full_command_usage, #get_interface, #get_list_key, #get_object_key, #get_subcommand_description, #handle_each_payload, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_array, #parse_bytes_param, #parse_get_options!, #parse_id_list, #parse_labels, #parse_list_options, #parse_list_options!, #parse_list_subtitles, #parse_options, #parse_parameter_as_resource_id!, #parse_passed_options, #parse_payload, #parse_query_options, #print, #print_error, #println, #prog_name, #puts, #puts_error, #raise_args_error, #raise_command_error, #render_response, #run_command_for_each_arg, #subcommand_aliases, #subcommand_description, #subcommand_usage, #subcommands, #usage, #validate_outfile, #verify_args!, #visible_subcommands

Constructor Details

#initialize ⇒ LibraryOptionListsCommand

Returns a new instance of LibraryOptionListsCommand.



10
11
12
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 10

def initialize()
  # @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
end

Instance Method Details

#_get(id, options) ⇒ Object 



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
155
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
218
219
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 117

def _get(id, options)
  params = {}
  params.merge!(parse_query_options(options))
  begin
    @option_type_lists_interface.setopts(options)
    if options[:dry_run]
      if id.to_s =~ /\A\d{1,}\Z/
        print_dry_run @option_type_lists_interface.dry.get(id.to_i, params)
      else
        print_dry_run @option_type_lists_interface.dry.list(params.merge({name: id}))
      end
      return
    end
    option_type_list = find_option_type_list_by_name_or_id(id)
    return 1 if option_type_list.nil?
    list_items = nil
    if options[:list_items]
      list_items = option_type_list['listItems']
      if list_items.nil?
        begin
          list_items = @option_type_lists_interface.list_items(option_type_list['id'])['listItems']
        rescue => e
          puts_error "Failed to load option list items: #{e.message}"
        end
      end
    end
    json_response = {'optionTypeList' => option_type_list}
    render_result = render_with_format(json_response, options, 'optionTypeList')
    return 0 if render_result

    print_h1 "Option List Details", options
    print cyan
    if option_type_list['type'] == 'manual'
      print_description_list({
        "ID" => 'id',
        "Name" => 'name',
        "Description" => 'description',
        "Labels" => lambda {|it| format_list(it['labels']) },
        "Type" => lambda {|it| it['type'].to_s.capitalize },
      }, option_type_list)
      # print_h2 "Initial Dataset"
      # print reset,"#{option_type_list['initialDataset']}","\n",reset
    else
      option_list_columns = {
        "ID" => 'id',
        "Name" => 'name',
        "Description" => 'description',
        "Labels" => lambda {|it| format_list(it['labels']) },
        "Type" => lambda {|it| it['type'] },
        "API Type" => lambda {|it| it['apiType'] },
        "Source URL" => 'sourceUrl',
        "Real Time" => lambda {|it| format_boolean it['realTime'] },
        "Ignore SSL Errors" => lambda {|it| format_boolean it['ignoreSSLErrors'] },
        "Source Method" => lambda {|it| it['sourceMethod'].to_s.upcase },
        "Credentials" => lambda {|it| it['credential'] ? (it['credential']['type'] == 'local' ? '(Local)' : it['credential']['name']) : nil },
        "Username" => 'serviceUsername',
        "Password" => 'servicePassword',
      }
      option_list_columns.delete("API Type") if option_type_list['type'] != 'api'
      option_list_columns.delete("Credentials") if !['rest','ldap'].include?(option_type_list['type']) # || !(option_type_list['credential'] && option_type_list['credential']['id'])
      option_list_columns.delete("Username") if !['rest','ldap'].include?(option_type_list['type']) || !(option_type_list['serviceUsername'])
      option_list_columns.delete("Password") if !['rest','ldap'].include?(option_type_list['type']) || !(option_type_list['servicePassword'])
      source_headers = []
      if option_type_list['config'] && option_type_list['config']['sourceHeaders']
        source_headers = option_type_list['config']['sourceHeaders'].collect do |header|
          {name: header['name'], value: header['value'], masked: format_boolean(header['masked'])}
        end
        #option_list_columns["Source Headers"] = lambda {|it| source_headers.collect {|it| "#{it[:name]} #{it[:value]}"}.join("\n") }
      end
      print_description_list(option_list_columns, option_type_list)
      if source_headers && !source_headers.empty?
        print cyan
        print_h2 "Source Headers"
        print as_pretty_table(source_headers, [:name, :value, :masked], options)
      end
      if !option_type_list['initialDataset'].empty?
        print_h2 "Initial Dataset"
        print reset,"#{option_type_list['initialDataset']}","\n",reset
      end
      if !option_type_list['translationScript'].empty?
        print_h2 "Translation Script"
        print reset,"#{option_type_list['translationScript']}","\n",reset
      end
      if !option_type_list['requestScript'].empty?
        print_h2 "Request Script"
        print reset,"#{option_type_list['requestScript']}","\n",reset
      end
    end
    if options[:list_items]
      print_h2 "List Items"
      if list_items && list_items.size > 0
        print as_pretty_table(list_items, [:name, :value], options)
        print_results_pagination({size: list_items.size, total: list_items.size})
      else
        print cyan,"No list items found.",reset,"\n"
      end
    end
    print reset,"\n"
  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
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 257

def add(args)
  options = {}
  my_option_types = nil
  list_type = nil
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, new_option_type_list_option_types())
    build_standard_add_options(opts, options)
    opts.footer = "Create a new option list."
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, max:1)
  if args.count == 1
    options[:options]['name'] = args[0]
  end

  connect(options)
  begin
    payload = nil
    if options[:payload]
      payload = options[:payload]
      payload.deep_merge!({'optionTypeList' => parse_passed_options(options)})
    else
      payload = {}
      payload.deep_merge!({'optionTypeList' => parse_passed_options(options)})
      list_payload = Morpheus::Cli::OptionTypes.prompt(new_option_type_list_option_types(), options[:options], @api_client, options[:params])
      if list_payload['type'] == 'rest'
        # prompt for Source Headers
        if !(payload['optionTypeList']['config'] && payload['optionTypeList']['config']['sourceHeaders'])
          source_headers = prompt_source_headers(options)
          if !source_headers.empty?
            list_payload['config'] ||= {}
            list_payload['config']['sourceHeaders'] = source_headers
          end
        end
      end
      # tweak payload for API
      ['ignoreSSLErrors', 'realTime'].each { |k|
        list_payload[k] = ['on','true'].include?(list_payload[k].to_s) if list_payload.key?(k)
      }
      payload.deep_merge!({'optionTypeList' => list_payload})
    end
    @option_type_lists_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @option_type_lists_interface.dry.create(payload)
      return
    end
    json_response = @option_type_lists_interface.create(payload)
    render_result = render_with_format(json_response, options)
    return 0 if render_result
    option_type_list = json_response['optionTypeList']
    print_green_success "Added Option List #{option_type_list['name']}"
    get([option_type_list['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



14
15
16
17
18
19
20
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 14

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @library_instance_types_interface = @api_client.library_instance_types
  @provision_types_interface = @api_client.provision_types
  @option_types_interface = @api_client.option_types
  @option_type_lists_interface = @api_client.option_type_lists
end

#get(args) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 95

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_standard_get_options(opts, options)
    opts.on(nil,'--items', "Load and display option list items") do |val|
      options[:list_items] = true
    end
    opts.footer = "Get details about an option list.\n" + 
                  "[name] is required. This is the name or id of an option list. Supports 1-N [name] arguments."
  end
  optparse.parse!(args)
  if args.count < 1
    raise_command_error "wrong number of arguments, expected 1-N and got (#{args.count}) #{args.join(', ')}\n#{optparse}"
  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/commands/library_option_lists_command.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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 26

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    opts.on('-l', '--labels LABEL', String, "Filter by labels, can match any of the values") do |val|
      add_query_parameter(params, 'labels', parse_labels(val))
    end
    opts.on('--all-labels LABEL', String, "Filter by labels, must match all of the values") do |val|
      add_query_parameter(params, 'allLabels', parse_labels(val))
    end
    build_standard_list_options(opts, options)
    opts.footer = "List option lists."
  end
  optparse.parse!(args)
  # verify_args!(args:args, optparse:optparse, count:0)
  if args.count > 0
    options[:phrase] = args.join(" ")
  end
  connect(options)
  begin
    
    params.merge!(parse_list_options(options))
    @option_type_lists_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @option_type_lists_interface.dry.list(params)
      return
    end

    json_response = @option_type_lists_interface.list(params)
    render_result = render_with_format(json_response, options, 'optionTypeLists')
    return 0 if render_result

    option_type_lists = json_response['optionTypeLists']
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 "Morpheus Option Lists", subtitles, options
    if option_type_lists.empty?
      print cyan,"No option lists found.",reset,"\n"
    else
      rows = option_type_lists.collect do |option_type_list|
        {
          id: option_type_list['id'],
          name: option_type_list['name'],
          labels: option_type_list['labels'],
          description: option_type_list['description'],
          type: ((option_type_list['type'] == 'api') ? "#{option_type_list['type']} (#{option_type_list['apiType']})" : option_type_list['type'])
        }
      end
        columns = [
        :id,
        :name,
        {:labels => {:display_method => lambda {|it| format_list(it[:labels], '', 3) rescue '' }}},
        :description,
        :type
      ]
      print cyan
      print as_pretty_table(rows, columns, options)
      print reset
      print_results_pagination(json_response)
    end
    print reset,"\n"
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#list_items(args) ⇒ Object 



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/commands/library_option_lists_command.rb', line 221

def list_items(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_standard_get_options(opts, options)
    opts.footer = "List items for an option list.\n" + 
                  "[name] is required. This is the name or id of an option list."
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  option_type_list = find_option_type_list_by_name_or_id(args[0])
  return 1 if option_type_list.nil?

  params.merge!(parse_list_options(options))
  @option_type_lists_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @option_type_lists_interface.dry.list_items(option_type_list['id'], params)
    return
  end
  json_response = @option_type_lists_interface.list_items(option_type_list['id'], params)
  list_items = json_response['listItems']
  render_response(json_response, options, "listItems") do
    print_h2 "List Items"
    if list_items && list_items.size > 0
      print as_pretty_table(list_items, [:name, :value], options)
      print_results_pagination({size: list_items.size, total: list_items.size})
    else
      print cyan,"No list items found.",reset,"\n"
    end
    print reset,"\n"
  end
  return 0, nil
end

#remove(args) ⇒ Object 



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/morpheus/cli/commands/library_option_lists_command.rb', line 373

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name]")
    build_standard_remove_options(opts, options)
    opts.footer = "Delete an option list.\n" +
                  "[name] is required. This is the name or id of an option list."
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)

  begin
    option_type_list = find_option_type_list_by_name_or_id(args[0])
    exit 1 if option_type_list.nil?

    unless Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the option type #{option_type_list['name']}?", options)
      exit
    end
    @option_type_lists_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @option_type_lists_interface.dry.destroy(option_type_list['id'])
      return
    end
    json_response = @option_type_lists_interface.destroy(option_type_list['id'])
    render_result = render_with_format(json_response, options)
    return 0 if render_result

    print_green_success "Removed Option List #{option_type_list['name']}"
    #list([])
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
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/commands/library_option_lists_command.rb', line 317

def update(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, update_option_type_list_option_types())
    build_standard_update_options(opts, options)
    opts.footer = "Update an option list.\n" +
                  "[name] is required. This is the name or id of an option list."
  end
  optparse.parse!(args)
  connect(options)
  begin
    option_type_list = find_option_type_list_by_name_or_id(args[0])
    exit 1 if option_type_list.nil?
    payload = nil
    if options[:payload]
      payload = options[:payload]
      payload.deep_merge!({'optionTypeList' => parse_passed_options(options)})
    else
      payload = {}
      payload.deep_merge!({'optionTypeList' => parse_passed_options(options)})
      list_payload = Morpheus::Cli::OptionTypes.no_prompt(update_option_type_list_option_types(), options[:options], @api_client)
      if list_payload['type'] == 'rest'
        # parse Source Headers
        if !(payload['optionTypeList']['config'] && payload['optionTypeList']['config']['sourceHeaders'])
          source_headers = prompt_source_headers(options.merge({no_prompt: true}))
          if !source_headers.empty?
            #params['config'] ||= option_type_list['config'] || {}
            params['config'] ||= {}
            params['config']['sourceHeaders'] = source_headers
          end
        end
      end
      # tweak payload for API
      ['ignoreSSLErrors', 'realTime'].each { |k|
        list_payload[k] = ['on','true'].include?(list_payload[k].to_s) if list_payload.key?(k)
      }
      payload.deep_merge!({'optionTypeList' => list_payload})
      raise_command_error "Specify at least one option to update.\n#{optparse}" if payload['optionTypeList'].empty?
    end
    @option_type_lists_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @option_type_lists_interface.dry.update(option_type_list['id'], payload)
      return
    end
    json_response = @option_type_lists_interface.update(option_type_list['id'], payload)
    render_result = render_with_format(json_response, options)
    return 0 if render_result
    print_green_success "Updated Option List #{list_payload['name']}"
    get([option_type_list['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    return 1
  end
end