Class: Morpheus::Cli::CatalogCommand

Inherits:
Object
  • Object
show all
Includes:
CatalogHelper, CliCommand, LibraryHelper, OptionSourceHelper
Defined in:
lib/morpheus/cli/catalog_command.rb

Overview

CLI command self service UI is Tools: Self Service - Catalog Items API is /catalog-item-types and returns catalogItemTypes

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from OptionSourceHelper

#find_available_user_option, #find_cloud_option, #find_group_option, #find_tenant_option, #get_available_user_options, #get_cloud_options, #get_group_options, #get_tenant_options, included, #load_option_source_data, #options_interface, #parse_cloud_id_list, #parse_group_id_list, #parse_option_source_id_list, #parse_project_id_list, #parse_tenant_id_list, #parse_user_id_list

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 CatalogHelper

#catalog_item_type_list_key, #catalog_item_type_object_key, #catalog_item_types_interface, #find_catalog_item_type_by_id, #find_catalog_item_type_by_name, #find_catalog_item_type_by_name_or_id, included

Methods included from CliCommand

#apply_options, #build_common_options, #build_option_type_options, #build_standard_add_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_name, #default_refresh_interval, #default_subcommand, #establish_remote_appliance_connection, #full_command_usage, #get_subcommand_description, #handle_subcommand, included, #interactive?, #my_help_command, #my_terminal, #my_terminal=, #parse_bytes_param, #parse_id_list, #parse_list_options, #parse_list_subtitles, #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

Instance Method Details

#_get(id, params, options) ⇒ Object 



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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/morpheus/cli/catalog_command.rb', line 102

def _get(id, params, options)
  catalog_item_type = nil
  if id.to_s !~ /\A\d{1,}\Z/
    catalog_item_type = find_catalog_item_type_by_name(id)
    return 1, "catalog item type not found for #{id}" if catalog_item_type.nil?
    id = catalog_item_type['id']
  end
  @catalog_item_types_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @catalog_item_types_interface.dry.get(id, params)
    return
  end
  # skip extra query, list has same data as show right now
  if catalog_item_type
    json_response = {catalog_item_type_object_key => catalog_item_type}
  else
    json_response = @catalog_item_types_interface.get(id, params)
  end
  catalog_item_type = json_response[catalog_item_type_object_key]
  config = catalog_item_type['config'] || {}
  # export just the config as json or yaml (default)
  if options[:show_config]
    unless options[:json] || options[:yaml] || options[:csv]
      options[:yaml] = true
    end
    return render_with_format(config, options)
  end
  render_response(json_response, options, catalog_item_type_object_key) do
    print_h1 "Catalog Item Type Details", [], options
    print cyan
    show_columns = catalog_item_type_column_definitions
    show_columns.delete("Blueprint") unless catalog_item_type['blueprint']
    print_description_list(show_columns, catalog_item_type)

    if catalog_item_type['optionTypes'] && catalog_item_type['optionTypes'].size > 0
      print_h2 "Option Types"
      opt_columns = [
        {"ID" => lambda {|it| it['id'] } },
        {"NAME" => lambda {|it| it['name'] } },
        {"TYPE" => lambda {|it| it['type'] } },
        {"FIELD NAME" => lambda {|it| it['fieldName'] } },
        {"FIELD LABEL" => lambda {|it| it['fieldLabel'] } },
        {"DEFAULT" => lambda {|it| it['defaultValue'] } },
        {"REQUIRED" => lambda {|it| format_boolean it['required'] } },
      ]
      print as_pretty_table(catalog_item_type['optionTypes'], opt_columns)
    else
      # print cyan,"No option types found for this catalog item.","\n",reset
    end

    if config && options[:no_config] != true
      print_h2 "Config YAML"
      #print reset,(JSON.pretty_generate(config) rescue config),"\n",reset
      #print reset,(as_yaml(config, options) rescue config),"\n",reset
      config_string = as_yaml(config, options) rescue config
      config_lines = config_string.split("\n")
      config_line_count = config_lines.size
      max_lines = 10
      if config_lines.size > max_lines
        config_string = config_lines.first(max_lines).join("\n")
        config_string << "\n\n"
        config_string << "(#{(config_line_count - max_lines)} more lines were not shown, use -c to show the config)"
        #config_string << "\n"
      end
      # strip --- yaml header
      if config_string[0..3] == "---\n"
        config_string = config_string[4..-1]
      end
      print reset,config_string.chomp("\n"),"\n",reset
    end

    print reset,"\n"
  end
  return 0, nil
end

#add(args) ⇒ Object 



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
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
256
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
 
# File 'lib/morpheus/cli/catalog_command.rb', line 178

def add(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, add_catalog_item_type_option_types)
    opts.on('--config-file FILE', String, "Config from a local JSON or YAML file") do |val|
      options[:config_file] = val.to_s
      file_content = nil
      full_filename = File.expand_path(options[:config_file])
      if File.exists?(full_filename)
        file_content = File.read(full_filename)
      else
        print_red_alert "File not found: #{full_filename}"
        return 1
      end
      parse_result = parse_json_or_yaml(file_content)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:err]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
        options[:options]['config'] = params['config'] # or file_content
      end
    end
    opts.on('--option-types [x,y,z]', Array, "List of Option Type IDs") do |list|
      if list.nil?
        params['optionTypes'] = []
      else
        params['optionTypes'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--optionTypes [x,y,z]', Array, "List of Option Type IDs") do |list|
      if list.nil?
        params['optionTypes'] = []
      else
        params['optionTypes'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.add_hidden_option('--optionTypes')
    build_option_type_options(opts, options, add_catalog_item_type_advanced_option_types)
    build_standard_add_options(opts, options)
    opts.footer = <<-EOT
Create a new catalog item type.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:0, max:1)
  options[:options]['name'] = args[0] if args[0]
  connect(options)
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({catalog_item_type_object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({catalog_item_type_object_key => parse_passed_options(options)})
    v_prompt = Morpheus::Cli::OptionTypes.prompt(add_catalog_item_type_option_types(), options[:options], @api_client, options[:params])
    params.deep_merge!(v_prompt)
    advanced_config = Morpheus::Cli::OptionTypes.no_prompt(add_catalog_item_type_advanced_option_types, options[:options], @api_client, options[:params])
    advanced_config.deep_compact!
    params.deep_merge!(advanced_config)
    # convert checkbox "on" and "off" to true and false
    params.booleanize!
    # convert type to refType until api accepts type
    if params['type'] && !params['refType']
      if params['type'].to_s.downcase == 'blueprint'
        params['refType'] = 'AppTemplate'
      else
        params['refType'] = 'InstanceType'
      end
    end
    # convert config string to a map
    config = params['config']
    if config && config.is_a?(String)
      parse_result = parse_json_or_yaml(config)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:err]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
      end
    end
    if params['optionTypes']
      # todo: move to optionSource, so it will be /api/options/optionTypes  lol
      prompt_results = prompt_for_option_types(params, options, @api_client)
      if prompt_results[:success]
        params['optionTypes'] = prompt_results[:data] unless prompt_results[:data].nil?
      else
        return 1
      end
    end
    payload[catalog_item_type_object_key].deep_merge!(params)
  end
  @catalog_item_types_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @catalog_item_types_interface.dry.create(payload)
    return 0, nil
  end
  json_response = @catalog_item_types_interface.create(payload)
  catalog_item_type = json_response[catalog_item_type_object_key]
  render_response(json_response, options, catalog_item_type_object_key) do
    print_green_success "Added catalog item #{catalog_item_type['name']}"
    return _get(catalog_item_type["id"], {}, options)
  end
  return 0, nil
end

#connect(opts) ⇒ Object 



18
19
20
21
22
 
# File 'lib/morpheus/cli/catalog_command.rb', line 18

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @catalog_item_types_interface = @api_client.catalog_item_types
  @option_types_interface = @api_client.option_types
end

#get(args) ⇒ Object 



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/morpheus/cli/catalog_command.rb', line 76

def get(args)
  params = {}
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[catalog item type]")
    opts.on( '-c', '--config', "Display raw config only. Default is YAML. Combine with -j for JSON instead." ) do
      options[:show_config] = true
    end
    # opts.on('--no-config', "Do not display config content." ) do
    #   options[:no_config] = true
    # end
    build_standard_get_options(opts, options)
    opts.footer = <<-EOT
Get details about a specific catalog item type.
[catalog item type] is required. This is the name or id of a catalog item type.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, min:1)
  connect(options)
  id_list = parse_id_list(args)
  return run_command_for_each_arg(id_list) do |arg|
    _get(arg, params, options)
  end
end

#handle(args) ⇒ Object 



24
25
26
 
# File 'lib/morpheus/cli/catalog_command.rb', line 24

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



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/catalog_command.rb', line 28

def list(args)
  options = {}
  params = {}
  ref_ids = []
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[search]")
    opts.on( '--enabled [on|off]', String, "Filter by enabled" ) do |val|
      params['enabled'] = (val.to_s != 'false' && val.to_s != 'off')
    end
    opts.on( '--featured [on|off]', String, "Filter by featured" ) do |val|
      params['featured'] = (val.to_s != 'false' && val.to_s != 'off')
    end
    build_standard_list_options(opts, options)
    opts.footer = "List catalog items."
  end
  optparse.parse!(args)
  connect(options)
  # verify_args!(args:args, optparse:optparse, count:0)
  if args.count > 0
    options[:phrase] = args.join(" ")
  end
  params.merge!(parse_list_options(options))
  @catalog_item_types_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @catalog_item_types_interface.dry.list(params)
    return
  end
  json_response = @catalog_item_types_interface.list(params)
  catalog_item_types = json_response[catalog_item_type_list_key]
  render_response(json_response, options, catalog_item_type_list_key) do
    print_h1 "Morpheus Catalog Items", parse_list_subtitles(options), options
    if catalog_item_types.empty?
      print cyan,"No catalog items found.",reset,"\n"
    else
      list_columns = catalog_item_type_column_definitions.upcase_keys!
      #list_columns["Config"] = lambda {|it| truncate_string(it['config'], 100) }
      print as_pretty_table(catalog_item_types, list_columns.upcase_keys!, options)
      print_results_pagination(json_response)
    end
    print reset,"\n"
  end
  if catalog_item_types.empty?
    return 1, "no catalog items found"
  else
    return 0, nil
  end
end

#remove(args) ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/morpheus/cli/catalog_command.rb', line 399

def remove(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[catalog item type] [options]")
    build_standard_remove_options(opts, options)
    opts.footer = <<-EOT
Delete a catalog_item_type.
[catalog item type] is required. This is the name or id of a catalog item type.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  catalog_item_type = find_catalog_item_type_by_name_or_id(args[0])
  return 1 if catalog_item_type.nil?
  @catalog_item_types_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @catalog_item_types_interface.dry.destroy(catalog_item_type['id'], params)
    return
  end
  unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the catalog item #{catalog_item_type['name']}?")
    return 9, "aborted command"
  end
  json_response = @catalog_item_types_interface.destroy(catalog_item_type['id'], params)
  render_response(json_response, options) do
    print_green_success "Removed catalog item #{catalog_item_type['name']}"
  end
  return 0, nil
end

#update(args) ⇒ Object 



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
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
372
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
 
# File 'lib/morpheus/cli/catalog_command.rb', line 289

def update(args)
  options = {}
  params = {}
  payload = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[catalog item type] [options]")
    build_option_type_options(opts, options, update_catalog_item_type_option_types)
    opts.on('--config-file FILE', String, "Config from a local JSON or YAML file") do |val|
      options[:config_file] = val.to_s
      file_content = nil
      full_filename = File.expand_path(options[:config_file])
      if File.exists?(full_filename)
        file_content = File.read(full_filename)
      else
        print_red_alert "File not found: #{full_filename}"
        return 1
      end
      parse_result = parse_json_or_yaml(file_content)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:err]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
        options[:options]['config'] = params['config'] # or file_content
      end
    end
    opts.on('--option-types [x,y,z]', Array, "List of Option Type IDs") do |list|
      if list.nil?
        params['optionTypes'] = []
      else
        params['optionTypes'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--optionTypes [x,y,z]', Array, "List of Option Type IDs") do |list|
      if list.nil?
        params['optionTypes'] = []
      else
        params['optionTypes'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.add_hidden_option('--optionTypes')
    build_option_type_options(opts, options, update_catalog_item_type_advanced_option_types)
    build_standard_update_options(opts, options)
    opts.footer = <<-EOT
Update a catalog item type.
[catalog item type] is required. This is the name or id of a catalog item type.
EOT
  end
  optparse.parse!(args)
  verify_args!(args:args, optparse:optparse, count:1)
  connect(options)
  catalog_item_type = find_catalog_item_type_by_name_or_id(args[0])
  return 1 if catalog_item_type.nil?
  payload = {}
  if options[:payload]
    payload = options[:payload]
    payload.deep_merge!({catalog_item_type_object_key => parse_passed_options(options)})
  else
    payload.deep_merge!({catalog_item_type_object_key => parse_passed_options(options)})
    # do not prompt on update
    v_prompt = Morpheus::Cli::OptionTypes.no_prompt(update_catalog_item_type_option_types, options[:options], @api_client, options[:params])
    v_prompt.deep_compact!
    params.deep_merge!(v_prompt)
    advanced_config = Morpheus::Cli::OptionTypes.no_prompt(update_catalog_item_type_advanced_option_types, options[:options], @api_client, options[:params])
    advanced_config.deep_compact!
    params.deep_merge!(advanced_config)
    # convert checkbox "on" and "off" to true and false
    params.booleanize!
    # convert type to refType until api accepts type
    if params['type'] && !params['refType']
      if params['type'].to_s.downcase == 'blueprint'
        params['refType'] = 'AppTemplate'
      else
        params['refType'] = 'InstanceType'
      end
    end
    # convert config string to a map
    config = params['config']
    if config && config.is_a?(String)
      parse_result = parse_json_or_yaml(config)
      config_map = parse_result[:data]
      if config_map.nil?
        # todo: bubble up JSON.parse error message
        raise_command_error "Failed to parse config as YAML or JSON. Error: #{parse_result[:err]}"
        #raise_command_error "Failed to parse config as valid YAML or JSON."
      else
        params['config'] = config_map
      end
    end
    payload.deep_merge!({catalog_item_type_object_key => params})
    if payload[catalog_item_type_object_key].empty? # || options[:no_prompt]
      raise_command_error "Specify at least one option to update.\n#{optparse}"
    end
  end
  @catalog_item_types_interface.setopts(options)
  if options[:dry_run]
    print_dry_run @catalog_item_types_interface.dry.update(catalog_item_type['id'], payload)
    return
  end
  json_response = @catalog_item_types_interface.update(catalog_item_type['id'], payload)
  catalog_item_type = json_response[catalog_item_type_object_key]
  render_response(json_response, options, catalog_item_type_object_key) do
    print_green_success "Updated catalog item #{catalog_item_type['name']}"
    return _get(catalog_item_type["id"], {}, options)
  end
  return 0, nil
end