Class: Morpheus::Cli::Groups

Inherits:
Object
  • Object
show all
Extended by:
Term::ANSIColor
Includes:
CliCommand, InfrastructureHelper
Defined in:
lib/morpheus/cli/groups.rb

Constant Summary collapse

@@groups = 
nil

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Class Method Summary collapse

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, #get_available_cloud_types, #groups_interface, included

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_command_result, #parse_id_list, #parse_list_options, #parse_list_subtitles, #print, #print_error, #print_to_file, #puts, #puts_error, #raise_command_error, #render_with_format, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!

Constructor Details

#initialize ⇒ Groups

Returns a new instance of Groups.



19
20
21
 
# File 'lib/morpheus/cli/groups.rb', line 19

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

Class Method Details

.active_group(appliance_name = nil) ⇒ Object

Provides the current active group information (just the ID right now)



544
545
546
547
548
549
550
551
552
 
# File 'lib/morpheus/cli/groups.rb', line 544

def active_group(appliance_name=nil)
  if appliance_name == nil
    appliance_name, appliance_url = Morpheus::Cli::Remote.active_appliance
  end
  if !appliance_name
    return nil
  end
  return active_groups_map[appliance_name.to_sym]
end

.active_group_id(appliance_name = nil) ⇒ Object

alias (unused)



555
556
557
 
# File 'lib/morpheus/cli/groups.rb', line 555

def active_group_id(appliance_name=nil)
  active_group(appliance_name)
end

.active_groups ⇒ Object 



539
540
541
 
# File 'lib/morpheus/cli/groups.rb', line 539

def active_groups
  active_groups_map
end

.active_groups_map ⇒ Object

Provides the current active group information



535
536
537
 
# File 'lib/morpheus/cli/groups.rb', line 535

def active_groups_map
  @@groups ||= load_group_file || {}
end

.clear_active_group(appliance_name) ⇒ Object 



565
566
567
568
569
 
# File 'lib/morpheus/cli/groups.rb', line 565

def clear_active_group(appliance_name)
  the_groups = active_groups_map
  the_groups.delete(appliance_name.to_sym)
  save_groups(the_groups)
end

.groups_file_path ⇒ Object 



581
582
583
 
# File 'lib/morpheus/cli/groups.rb', line 581

def groups_file_path
  return File.join(Morpheus::Cli.home_directory, "groups")
end

.load_group_file ⇒ Object 



571
572
573
574
575
576
577
578
579
 
# File 'lib/morpheus/cli/groups.rb', line 571

def load_group_file
  fn = groups_file_path
  if File.exist? fn
    Morpheus::Logging::DarkPrinter.puts "loading groups file #{fn}" if Morpheus::Logging.debug?
    return YAML.load_file(fn)
  else
    {}
  end
end

.save_groups(groups_map) ⇒ Object 



585
586
587
588
589
590
591
592
593
 
# File 'lib/morpheus/cli/groups.rb', line 585

def save_groups(groups_map)
  fn = groups_file_path
  if !Dir.exists?(File.dirname(fn))
    FileUtils.mkdir_p(File.dirname(fn))
  end
  File.open(fn, 'w') {|f| f.write groups_map.to_yaml } #Store
  FileUtils.chmod(0600, fn)
  @@groups = groups_map
end

.set_active_group(appliance_name, group_id) ⇒ Object 



559
560
561
562
563
 
# File 'lib/morpheus/cli/groups.rb', line 559

def set_active_group(appliance_name, group_id)
  the_groups = active_groups_map
  the_groups[appliance_name.to_sym] = group_id
  save_groups(the_groups)
end

Instance Method Details

#_get(arg, options = {}) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 103

def _get(arg, options={})
  begin
    if options[:dry_run]
      @groups_interface.setopts(options)
      if arg.to_s =~ /\A\d{1,}\Z/
        print_dry_run @groups_interface.dry.get(arg.to_i)
      else
        print_dry_run @groups_interface.dry.get({name:arg})
      end
      return 0
    end
    group = find_group_by_name_or_id(arg)
    @groups_interface.setopts(options)
    #json_response = @groups_interface.get(group['id'])
    json_response = {'group' => group}
    
    render_result = render_with_format(json_response, options)
    return 0 if render_result

    group = json_response['group']
    is_active = @active_group_id && (@active_group_id == group['id'])
    print_h1 "Group Details"
    print cyan
    description_cols = {
      "ID" => 'id',
      "Name" => 'name',
      "Code" => 'code',
      "Location" => 'location',
      "Clouds" => lambda {|it| it['zones'].collect {|z| z['name'] }.join(', ') },
      "Hosts" => 'serverCount'
    }
    print_description_list(description_cols, group)
    # puts "ID: #{group['id']}"
    # puts "Name: #{group['name']}"
    # puts "Code: #{group['code']}"
    # puts "Location: #{group['location']}"
    # puts "Clouds: #{group['zones'].collect {|it| it['name'] }.join(', ')}"
    # puts "Hosts: #{group['serverCount']}"
    if is_active
      puts "\n => This is the active group."
    end

    print reset,"\n"

    #puts instance
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#add(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 154

def add(args)
  options = {}
  params = {}
  use_it = false
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    build_option_type_options(opts, options, add_group_option_types())
    # opts.on( '-l', '--location LOCATION', "Location" ) do |val|
    #   params[:location] = val
    # end
    opts.on( '--use', '--use', "Make this the current active group" ) do
      use_it = true
    end

    build_common_options(opts, options, [:options, :json, :dry_run, :remote])
    opts.footer = "Create a new group."
  end
  optparse.parse!(args)
  # if args.count < 1
  #   puts optparse
  #   exit 1
  # end
  connect(options)
  begin
    # group = {name: args[0], location: params[:location]}
    # payload = {group: group}
    group_payload = {}
    if args[0]
      group_payload[:name] = args[0]
      options[:options]['name'] = args[0] # to skip prompt
    end
    if params[:location]
      group_payload[:name] = params[:location]
      options[:options]['location'] = params[:location] # to skip prompt
    end
    all_option_types = add_group_option_types()
    params = Morpheus::Cli::OptionTypes.prompt(all_option_types, options[:options], @api_client, {})
    group_payload.merge!(params)
    payload = {group: group_payload}
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.dry.create(payload)
      return
    end
    json_response = @groups_interface.create(payload)
    group = json_response['group']
    if use_it
      ::Morpheus::Cli::Groups.set_active_group(@appliance_name, group['id'])
    end
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Added group #{group['name']}"
      list([])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#add_cloud(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 268

def add_cloud(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]", "CLOUD")
    build_common_options(opts, options, [:json, :dry_run, :remote])
    opts.footer = "Add a cloud to a group."
  end
  optparse.parse!(args)
  if args.count < 2
    puts optparse
    exit 1
  end
  connect(options)
  begin
    group = find_group_by_name_or_id(args[0])
    cloud = find_cloud_by_name_or_id(args[1])
    current_zones = group['zones']
    found_zone = current_zones.find {|it| it["id"] == cloud["id"] }
    if found_zone
      print_red_alert "Cloud #{cloud['name']} is already in group #{group['name']}."
      exit 1
    end
    new_zones = current_zones + [{'id' => cloud['id']}]
    payload = {group: {id: group["id"], zones: new_zones}}
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.dry.update_zones(group["id"], payload)
      return
    end
    json_response = @groups_interface.update_zones(group["id"], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Added cloud #{cloud["name"]} to group #{group['name']}"
      #list([])
      get([group["id"]])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#connect(opts) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/morpheus/cli/groups.rb', line 23

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @groups_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).groups
  @clouds_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).clouds
  @active_group_id = Morpheus::Cli::Groups.active_groups[@appliance_name]
end

#get(args) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/morpheus/cli/groups.rb', line 83

def get(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:query, :json, :yaml, :csv, :fields, :dry_run, :remote])
    opts.footer = "Get details about a group.\n" + 
                  "[name] is required. This is the name or id of a group. Supports 1-N arguments."
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 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 



30
31
32
 
# File 'lib/morpheus/cli/groups.rb', line 30

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 34

def list(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
    opts.footer = "List groups (sites)."
  end
  optparse.parse!(args)
  connect(options)
  begin
    params.merge!(parse_list_options(options))
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.get(params)
      return 0
    end
    json_response = @groups_interface.get(params)
    render_result = render_with_format(json_response, options, 'groups')
    return 0 if render_result

    groups = json_response['groups']
    subtitles = []
    subtitles += parse_list_subtitles(options)
    print_h1 "Morpheus Groups"
    if groups.empty?
      print yellow,"No groups currently configured.",reset,"\n"
    else
      print_groups_table(groups)
      print_results_pagination(json_response)
      if @active_group_id
        active_group = groups.find { |it| it['id'] == @active_group_id }
        active_group = active_group || find_group_by_name_or_id(@active_group_id)
        #unless @appliances.keys.size == 1
          print cyan, "\n# => Currently using group #{active_group['name']}\n", reset
        #end
      else
        unless options[:remote]
          print "\n# => No active group, see `groups use`\n", reset
        end
      end
    end
    print reset,"\n"
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#print_current(args) ⇒ Object 



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/morpheus/cli/groups.rb', line 461

def print_current(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [])
    opts.footer = "Print the name of the current active group"
  end
  optparse.parse!(args)
  connect(options)

  group = @active_group_id ? find_group_by_name_or_id(@active_group_id) : nil
  if group
    print cyan,group['name'].to_s,"\n",reset
  else
    print yellow,"No active group. See `groups use`","\n",reset
    return false
  end
end

#remove(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 356

def remove(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    build_common_options(opts, options, [:json, :dry_run, :auto_confirm, :remote])
    opts.footer = "Delete a group."
    # more info to display here
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)

  begin
    group = find_group_by_name_or_id(args[0])
    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the group #{group['name']}?")
      exit
    end
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.dry.destroy(group['id'])
      return
    end
    json_response = @groups_interface.destroy(group['id'])
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    elsif !options[:quiet]
      print_green_success "Removed group #{group['name']}"
      #list([])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#remove_cloud(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 312

def remove_cloud(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]", "CLOUD")
    build_common_options(opts, options, [:json, :dry_run, :remote])
    opts.footer = "Remove a cloud from a group."
  end
  optparse.parse!(args)
  if args.count < 2
    puts optparse
    exit 1
  end
  connect(options)
  begin
    group = find_group_by_name_or_id(args[0])
    cloud = find_cloud_by_name_or_id(args[1])
    current_zones = group['zones']
    found_zone = current_zones.find {|it| it["id"] == cloud["id"] }
    if !found_zone
      print_red_alert "Cloud #{cloud['name']} is not in group #{group['name']}."
      exit 1
    end
    new_zones = current_zones.reject {|it| it["id"] == cloud["id"] }
    payload = {group: {id: group["id"], zones: new_zones}}
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.dry.update_zones(group["id"], payload)
      return
    end
    json_response = @groups_interface.update_zones(group["id"], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Removed cloud #{cloud['name']} from group #{group['name']}"
      # list([])
      get([group["id"]])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#unuse(args) ⇒ Object 



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/morpheus/cli/groups.rb', line 434

def unuse(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    opts.footer = "" +
      "This will clear the current active group.\n" +
      "You will be prompted for a Group during provisioning."
    build_common_options(opts, options, [])
  end
  optparse.parse!(args)
  connect(options)

  if @active_group_id
    ::Morpheus::Cli::Groups.clear_active_group(@appliance_name)
    # unless options[:quiet]
    #   print cyan
    #   puts "Switched to no active group."
    #   puts "You will be prompted for Group during provisioning."
    #   print reset
    # end
    return true
  else
    puts "You are not using any group for appliance #{@appliance_name}"
    #return false
  end
end

#update(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 216

def update(args)
  options = {}
  params = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name] [options]")
    build_option_type_options(opts, options, update_group_option_types())
    # opts.on( '-l', '--location LOCATION', "Location" ) do |val|
    #   params[:location] = val
    # end
    build_common_options(opts, options, [:options, :json, :dry_run, :remote])
    opts.footer = "Update an existing group."
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  begin
    group = find_group_by_name_or_id(args[0])
    group_payload = {}

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

    if params.empty?
      puts optparse
      exit 1
    end

    group_payload.merge!(params)

    payload = {group: group_payload}
    @groups_interface.setopts(options)
    if options[:dry_run]
      print_dry_run @groups_interface.dry.update(group['id'], payload)
      return
    end
    json_response = @groups_interface.update(group['id'], payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      #list([])
      get([group["id"]])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#use(args) ⇒ Object 



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
 
# File 'lib/morpheus/cli/groups.rb', line 395

def use(args)
  options = {}
  optparse = Morpheus::Cli::OptionParser.new do|opts|
    opts.banner = subcommand_usage("[name]")
    opts.footer = "" +
      "This sets the active group.\n" +
      "The active group will be auto-selected for use during provisioning.\n" +
      "You can still use the --group option to override this."
    build_common_options(opts, options, [])
  end
  optparse.parse!(args)
  if args.count < 1
    puts optparse
    exit 1
  end
  connect(options)
  begin
    # todo: this is a problem for unprivileged users, need to use find_group_by_id_for_provisioning(group_id)
    group = find_group_by_name_or_id(args[0])
    if !group
      print_red_alert "Group not found by name #{args[0]}"
      exit 1
    end

    if @active_group_id == group['id']
      print reset,"Already using the group #{group['name']}","\n",reset
    else
      ::Morpheus::Cli::Groups.set_active_group(@appliance_name, group['id'])
      # ::Morpheus::Cli::Groups.save_groups(@active_groups)
      #print cyan,"Switched active group to #{group['name']}","\n",reset
      #list([])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end

end