Class: Morpheus::Cli::CloudFoldersCommand

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

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from InfrastructureHelper

#cloud_type_for_id, #cloud_type_for_name, #cloud_type_for_name_or_id, #clouds_interface, #find_cloud_by_id, #find_cloud_by_name, #find_cloud_by_name_or_id, #find_group_by_id, #find_group_by_name, #find_group_by_name_or_id, #find_network_by_id, #find_network_by_name, #find_network_by_name_or_id, #find_network_group_by_id, #find_network_group_by_name, #find_network_group_by_name_or_id, #find_network_server_type_by_id, #find_network_server_type_by_name, #find_network_server_type_by_name_or_code, #find_network_server_type_by_name_or_id, #find_network_type_by_id, #find_network_type_by_name, #find_network_type_by_name_or_id, #find_resource_pool_by_id, #find_resource_pool_by_name, #find_resource_pool_by_name_or_id, #find_resource_pool_group_by_id, #find_resource_pool_group_by_name, #find_resource_pool_group_by_name_or_id, #find_subnet_by_id, #find_subnet_by_name, #find_subnet_by_name_or_id, #find_subnet_type_by_id, #find_subnet_type_by_name, #find_subnet_type_by_name_or_id, #format_network_pool_server_status, #get_available_cloud_types, #groups_interface, included, #network_groups_interface, #network_pool_server_column_definitions, #network_pool_server_list_column_definitions, #network_pool_server_type_column_definitions, #network_pool_server_type_list_column_definitions, #network_server_type_column_definitions, #network_server_type_list_column_definitions, #network_types_interface, #networks_interface, #prompt_for_network, #prompt_for_networks, #prompt_for_pools, #prompt_for_subnets, #resource_pool_groups_interface, #resource_pools_interface, #subnet_types_interface, #subnets_interface

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 ⇒ CloudFoldersCommand

Returns a new instance of CloudFoldersCommand.



12
13
14
 
# File 'lib/morpheus/cli/commands/cloud_folders_command.rb', line 12

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

Instance Method Details

#connect(opts) ⇒ Object 



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

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @cloud_folders_interface = @api_client.cloud_folders
  @clouds_interface = @api_client.clouds
  @options_interface = @api_client.options
end

#get(args) ⇒ Object 



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
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
 
# File 'lib/morpheus/cli/commands/cloud_folders_command.rb', line 118

def get(args)
  folder_id = nil
  cloud_id = nil
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[cloud] [folder]")
    opts.on( '-c', '--cloud CLOUD', "Cloud Name or ID" ) do |val|
      cloud_id = val
    end
    opts.add_hidden_option('-c') # prefer args[0] for [cloud]
    build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
    opts.footer = "Get details about a resource folder." + "\n" +
                  "[cloud] is required. This is the name or id of the cloud." + "\n"
                  "[folder] is required. This is the name or id of a resource folder."
  end
  optparse.parse!(args)
  if args.count == 2
    cloud_id = args[0]
    folder_id = args[1]
  elsif args.count == 1 && cloud_id
    folder_id = args[0]
  else
    raise_command_error "wrong number of arguments, expected 2 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
  end
  connect(options)
  begin
    # load cloud
    if cloud_id.nil?
      puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: [cloud]\n#{optparse}"
      return 1
    end
    cloud = find_cloud_by_name_or_id(cloud_id)
    return 1 if cloud.nil?
    @cloud_folders_interface.setopts(options)
    if options[:dry_run]
      if args[0].to_s =~ /\A\d{1,}\Z/
        print_dry_run @cloud_folders_interface.dry.get(cloud['id'], folder_id.to_i)
      else
        print_dry_run @cloud_folders_interface.dry.list(cloud['id'], {name:folder_id})
      end
      return
    end
    folder = find_folder_by_name_or_id(cloud['id'], folder_id)
    return 1 if folder.nil?
    json_response = {'folder' => folder}  # skip redundant request
    # json_response = @folders_interface.get(folder['id'])
    folder = json_response['folder']
    if options[:json]
      puts as_json(json_response, options, "folder")
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "folder")
      return 0
    elsif options[:csv]
      puts records_as_csv([folder], options)
      return 0
    end
    print_h1 "Resource Folder Details"
    print cyan
    description_cols = {
      "ID" => 'id',
      "Name" => 'name',
      "Description" => 'description',
      #"Type" => lambda {|it| it['type'].to_s.capitalize },
      "Cloud" => lambda {|it| it['zone'] ? it['zone']['name'] : '' },
      "Active" => lambda {|it| format_boolean(it['active']) },
      "Default" => lambda {|it| format_boolean(it['defaultFolder']) },
      "Image Target" => lambda {|it| format_boolean(it['defaultStore']) },
      "Visibility" => lambda {|it| it['visibility'].to_s.capitalize },
      #"Tenants" => lambda {|it| it['tenants'] ? it['tenants'].collect {|it| it['name'] }.uniq.join(', ') : '' }
      # "Owner" => lambda {|it| it['owner'] ? it['owner']['name'] : '' },
    }
    print_description_list(description_cols, folder)

    if folder['resourcePermission'].nil?
      #print "\n", "No group access found", "\n"
    else
      print_h2 "Group Access"
      rows = []
      if folder['resourcePermission']['all']
        rows.push({"name" => 'All'})
      end
      if folder['resourcePermission']['sites']
        folder['resourcePermission']['sites'].each do |site|
          rows.push(site)
        end
      end
      group_columns = {
        "GROUP" => 'name',
        "DEFAULT" => lambda {|it| it['default'].nil? ? '' : format_boolean(it['default']) }
      }
      print cyan
      print as_pretty_table(rows, group_columns)
    end

    if folder['resourcePermission'] && folder['resourcePermission']['plans'] && folder['resourcePermission']['plans'].size > 0
      print_h2 "Service Plan Access"
      rows = []
      if folder['resourcePermission']['allPlans']
        rows.push({"name" => 'All'})
      end
      if folder['resourcePermission']['plans']
        folder['resourcePermission']['plans'].each do |plan|
          rows.push(plan)
        end
      end
      # rows = rows.collect do |site|
      #   {plan: site['name'], default: site['default'] ? 'Yes' : ''}
      #   #{group: site['name']}
      # end
      plan_columns = {
        "PLAN" => 'name',
        "DEFAULT" => lambda {|it| it['default'].nil? ? '' : format_boolean(it['default']) }
      }
      print cyan
      print as_pretty_table(rows, plan_columns)
    end

    if folder['tenants'].nil? || folder['tenants'].empty?
      #print "\n", "No tenant permissions found", "\n"
    else
      print_h2 "Tenant Permissions"
      rows = []
      rows = folder['tenants'] || []
      tenant_columns = {
        "TENANT" => 'name',
        "DEFAULT" => lambda {|it| format_boolean(it['defaultTarget']) },
        "IMAGE TARGET" => lambda {|it| format_boolean(it['defaultStore']) }
      }
      print cyan
      print as_pretty_table(rows, tenant_columns)
    end

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

#handle(args) ⇒ Object 



23
24
25
 
# File 'lib/morpheus/cli/commands/cloud_folders_command.rb', line 23

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ 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
75
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/morpheus/cli/commands/cloud_folders_command.rb', line 27

def list(args)
  cloud_id = nil
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[cloud]")
    opts.on( '-c', '--cloud CLOUD', "Cloud Name or ID" ) do |val|
      cloud_id = val
    end
    opts.add_hidden_option('-c') # prefer args[0] for [cloud]
    build_common_options(opts, options, [:list, :json, :yaml, :csv, :fields, :dry_run, :remote])
    opts.footer = "List resource folders for a cloud." + "\n" +
                  "[cloud] is required. This is the name or id of the cloud."
  end
  optparse.parse!(args)
  if args.count == 1
    cloud_id = args[0]
  elsif args.count == 0 && cloud_id
    # support -c
  else
    raise_command_error "wrong number of arguments, expected 2 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
  end
  connect(options)
  begin
    # load cloud
    if cloud_id.nil?
      puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: [cloud]\n#{optparse}"
      return 1
    end
    cloud = find_cloud_by_name_or_id(cloud_id)
    return 1 if cloud.nil?

    params.merge!(parse_list_options(options))
    @cloud_folders_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @cloud_folders_interface.dry.list(cloud['id'], params)
      return
    end
    json_response = @cloud_folders_interface.list(cloud['id'], params)
    folders = json_response["folders"]
    if options[:json]
      puts as_json(json_response, options, "folders")
      return 0
    elsif options[:yaml]
      puts as_yaml(json_response, options, "folders")
      return 0
    elsif options[:csv]
      puts records_as_csv(folders, options)
      return 0
    end
    title = "Morpheus Resource Folders - Cloud: #{cloud['name']}"
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 title, subtitles
    if folders.empty?
      print cyan,"No resource folders found.",reset,"\n"
    else
      rows = folders.collect {|folder| 
        formatted_name = (folder['depth'] && folder['depth'] > 0) ? (('  ' * folder['depth'].to_i) + folder['name'].to_s) : folder['name'].to_s
        row = {
          id: folder['id'],
          # name: folder['name'],
          name: formatted_name,
          type: folder['type'].to_s.capitalize,
          description: folder['description'],
          active: format_boolean(folder['active']),
          visibility: folder['visibility'].to_s.capitalize,
          default: format_boolean(folder['defaultFolder']),
          imageTarget: format_boolean(folder['defaultStore']),
          tenants: folder['tenants'] ? folder['tenants'].collect {|it| it['name'] }.uniq.join(', ') : ''
          # owner: folder['owner'] ? folder['owner']['name'] : ''
        }
        row
      }
      columns = [:id, :name, :active, :default, :visibility, :tenants]
      if options[:include_fields]
        columns = options[:include_fields]
      end
      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

#update(args) ⇒ Object 



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
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
398
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
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'lib/morpheus/cli/commands/cloud_folders_command.rb', line 259

def update(args)
  options = {}
  cloud_id = nil
  folder_id = nil
  tenants = nil
  group_access_all = nil
  group_access_list = nil
  group_defaults_list = nil
  plan_access_all = nil
  plan_access_list = nil
  plan_defaults_list = nil
  optparse = Morpheus::Cli::OptionParser.new do |opts|
    opts.banner = subcommand_usage("[cloud] [folder] [options]")
    opts.on( '-c', '--cloud CLOUD', "Cloud Name or ID" ) do |val|
      cloud_id = val
    end
    opts.add_hidden_option('-c') # prefer args[0] for [cloud]
    opts.on('--group-access-all [on|off]', String, "Toggle Access for all groups.") do |val|
      group_access_all = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
    end
    opts.on('--group-access LIST', Array, "Group Access, comma separated list of group IDs.") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        group_access_list = []
      else
        group_access_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--group-defaults LIST', Array, "Group Default Selection, comma separated list of group IDs") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        group_defaults_list = []
      else
        group_defaults_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--plan-access-all [on|off]', String, "Toggle Access for all plans.") do |val|
      plan_access_all = val.to_s == 'on' || val.to_s == 'true'  || val.to_s == ''
    end
    opts.on('--plan-access LIST', Array, "Plan Access, comma separated list of plan IDs.") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        plan_access_list = []
      else
        plan_access_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--plan-defaults LIST', Array, "Plan Default Selection, comma separated list of plan IDs") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        plan_defaults_list = []
      else
        plan_defaults_list = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--tenants LIST', Array, "Tenant Access, comma separated list of account IDs") do |list|
      if list.size == 1 && list[0] == 'null' # hacky way to clear it
        options['tenants'] = []
      else
        options['tenants'] = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
      end
    end
    opts.on('--visibility [private|public]', String, "Visibility") do |val|
      options['visibility'] = val
    end
    opts.on('--active [on|off]', String, "Can be used to disable a resource folder") do |val|
      options['active'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
    end
    opts.on('--default-folder [on|off]', String, "Default Folder") do |val|
      options['defaultFolder'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
    end
    opts.on('--image-target [on|off]', String, "Image Target") do |val|
      options['defaultStore'] = val.to_s == 'on' || val.to_s == 'true' || val.to_s == ''
    end
    build_common_options(opts, options, [:options, :payload, :json, :dry_run, :remote])
    opts.footer = "Update a resource folder." + "\n" +
                  "[cloud] is required. This is the name or id of the cloud." + "\n"
                  "[folder] is required. This is the id of a folder."
  end
  optparse.parse!(args)
  if args.count == 2
    cloud_id = args[0]
    folder_id = args[1]
  elsif args.count == 1 && cloud_id
    folder_id = args[0]
  else
    raise_command_error "wrong number of arguments, expected 2 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
  end

  connect(options)

  begin
    # load cloud
    if cloud_id.nil?
      puts_error "#{Morpheus::Terminal.angry_prompt}missing required option: [cloud]\n#{optparse}"
      return 1
    end
    cloud = find_cloud_by_name_or_id(cloud_id)
    return 1 if cloud.nil?

    folder = find_folder_by_name_or_id(cloud['id'], folder_id)
    return 1 if folder.nil?
    
    # merge -O options into normally parsed options
    options.deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]

    # construct payload
    payload = nil
    if options[:payload]
      payload = options[:payload]
    else
      # prompt for resource folder options
      payload = {
        'folder' => {
        }
      }
      
      # allow arbitrary -O options
      payload['folder'].deep_merge!(options[:options].reject {|k,v| k.is_a?(Symbol) }) if options[:options]

    
      # Group Access
      if group_access_all != nil
        payload['resourcePermissions'] ||= {}
        payload['resourcePermissions']['all'] = group_access_all
      end
      if group_access_list != nil
        payload['resourcePermissions'] ||= {}
        payload['resourcePermissions']['sites'] = group_access_list.collect do |site_id|
          site = {"id" => site_id.to_i}
          if group_defaults_list && group_defaults_list.include?(site_id)
            site["default"] = true
          end
          site
        end
      end

      # Service Plan Access
      if plan_access_all != nil
        payload['resourcePermissions'] ||= {}
        payload['resourcePermissions']['allPlans'] = plan_access_all
      end
      if plan_access_list != nil
        payload['resourcePermissions'] ||= {}
        payload['resourcePermissions']['plans'] = plan_access_list.collect do |site_id|
          site = {"id" => site_id.to_i}
          if plan_defaults_list && plan_defaults_list.include?(site_id)
            site["default"] = true
          end
          site
        end
      end

      # Tenants
      if options['tenants']
        payload['tenantPermissions'] = {}
        payload['tenantPermissions']['accounts'] = options['tenants']
      end

      # Active
      if options['active'] != nil
        payload['folder']['active'] = options['active']
      end

      # Default
      if options['defaultFolder'] != nil
        payload['folder']['defaultFolder'] = options['defaultFolder']
      end

      # Image Target
      if options['defaultStore'] != nil
        payload['folder']['defaultStore'] = options['defaultStore']
      end
      
      # Visibility
      if options['visibility'] != nil
        payload['folder']['visibility'] = options['visibility']
      end

      if payload['folder'].empty? && payload['resourcePermissions'].nil? && payload['tenantPermissions'].nil?
        raise_command_error "Specify at least one option to update.\n#{optparse}"
      end

    end
    @cloud_folders_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @cloud_folders_interface.dry.update(cloud['id'], folder["id"], payload)
      return
    end
    json_response = @cloud_folders_interface.update(cloud['id'], folder["id"], payload)
    if options[:json]
      puts as_json(json_response)
    else
      folder = json_response['folder']
      print_green_success "Updated resource folder #{folder['name']}"
      get([folder['id'], "-c", cloud['id'].to_s]) # argh, to_s needed on option values..
    end
    return 0
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    return 1
  end
end