Class: Morpheus::Cli::Users

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

Instance Attribute Summary

Attributes included from CliCommand

#no_prompt

Instance Method Summary collapse

Methods included from AccountsHelper

#accounts_interface, #find_account_by_id, #find_account_by_name, #find_account_by_name_or_id, #find_account_from_options, #find_role_by_id, #find_role_by_name, #find_role_by_name_or_id, #find_user_by_id, #find_user_by_username, #find_user_by_username_or_id, #format_role_type, #format_user_role_names, #get_access_string, included, #print_accounts_table, #print_roles_table, #print_users_table, #roles_interface, #users_interface

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, #print, #print_error, #puts, #puts_error, #raise_command_error, #run_command_for_each_arg, #subcommand_aliases, #subcommand_usage, #subcommands, #usage, #verify_access_token!

Constructor Details

#initialize ⇒ Users

Returns a new instance of Users.



17
18
19
 
# File 'lib/morpheus/cli/users.rb', line 17

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

Instance Method Details

#add(args) ⇒ Object 



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

def add(args)
  options = {}
  optparse = OptionParser.new do|opts|
    opts.banner = subcommand_usage("[options]")
    build_option_type_options(opts, options, add_user_option_types)
    build_common_options(opts, options, [:account, :options, :json, :dry_run])
  end
  optparse.parse!(args)

  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    # remove role option_type, it is just for help display, the role prompt is separate down below
    prompt_option_types = add_user_option_types().reject {|it| ['role'].include?(it['fieldName']) }
    params = Morpheus::Cli::OptionTypes.prompt(prompt_option_types, options[:options], @api_client, options[:params])

    #puts "parsed params is : #{params.inspect}"
    user_keys = ['username', 'firstName', 'lastName', 'email', 'password', 'passwordConfirmation', 'instanceLimits']
    user_payload = params.select {|k,v| user_keys.include?(k) }
    if !user_payload['instanceLimits']
      user_payload['instanceLimits'] = {}
      user_payload['instanceLimits']['maxStorage'] = params['instanceLimits.maxStorage'].to_i if params['instanceLimits.maxStorage'].to_s.strip != ''
      user_payload['instanceLimits']['maxMemory'] = params['instanceLimits.maxMemory'].to_i if params['instanceLimits.maxMemory'].to_s.strip != ''
      user_payload['instanceLimits']['maxCpu'] = params['instanceLimits.maxCpu'].to_i if params['instanceLimits.maxCpu'].to_s.strip != ''
    end

    roles = prompt_user_roles(, nil, options)
    if !roles.empty?
      user_payload['roles'] = roles.collect {|r| {id: r['id']} }
    end

    payload = {user: user_payload}

    if options[:dry_run]
      print_dry_run @users_interface.dry.create(, payload)
      return
    end
    json_response = @users_interface.create(, payload)
    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      if 
        print_green_success "Added user #{user_payload['username']} to account #{['name']}"
      else
        print_green_success "Added user #{user_payload['username']}"
      end

      details_options = [user_payload["username"]]
      if 
        details_options.push "--account-id", ['id'].to_s
      end
      get(details_options)
    end

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

#connect(opts) ⇒ Object 



21
22
23
24
25
26
27
 
# File 'lib/morpheus/cli/users.rb', line 21

def connect(opts)
  @api_client = establish_remote_appliance_connection(opts)
  @whoami_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).whoami
  @users_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).users
  @accounts_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).accounts
  @roles_interface = Morpheus::APIClient.new(@access_token,nil,nil, @appliance_url).roles
end

#get(args) ⇒ Object 



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

def get(args)
  options = {}
  optparse = OptionParser.new do|opts|
    opts.banner = subcommand_usage("[username]")
    opts.on(nil,'--feature-access', "Display Feature Access") do |val|
      options[:include_feature_access] = true
    end
    # opts.on(nil,'--group-access', "Display Group Access") do
    #   options[:include_group_access] = true
    # end
    # opts.on(nil,'--cloud-access', "Display Cloud Access") do
    #   options[:include_cloud_access] = true
    # end
    # opts.on(nil,'--instance-type-access', "Display Instance Type Access") do
    #   options[:include_instance_type_access] = true
    # end
    opts.on(nil,'--all-access', "Display All Access Lists") do
      options[:include_feature_access] = true
      options[:include_group_access] = true
      options[:include_cloud_access] = true
      options[:include_instance_type_access] = true
    end
    build_common_options(opts, options, [:account, :json, :dry_run])
  end
  optparse.parse!(args)

  if args.count < 1
    puts optparse
    exit 1
  end

  connect(options)
  begin
     = (options)
     =  ? ['id'] : nil
    if options[:dry_run]
      if args[0].to_s =~ /\A\d{1,}\Z/
        print_dry_run @users_interface.dry.get(, args[0].to_i)
      else
        print_dry_run @users_interface.dry.get(, {username: args[0]})
      end
      if options[:include_feature_access]
        print_dry_run @users_interface.dry.feature_permissions(, ":id")
      end
      return
    end
    # todo: users_response = @users_interface.list(account_id, {name: name})
    #       there may be response data outside of user that needs to be displayed
    user = find_user_by_username_or_id(, args[0])
    exit 1 if user.nil?

    # meh, this should just always be returned with GET /api/users/:id
    user_feature_permissions_json = nil
    user_feature_permissions = nil
    if options[:include_feature_access]
      user_feature_permissions_json = @users_interface.feature_permissions(, user['id'])
      user_feature_permissions = user_feature_permissions_json['featurePermissions']
    end

    if options[:json]
      print JSON.pretty_generate({user:user})
      print "\n"
      if (user_feature_permissions_json)
        print JSON.pretty_generate(user_feature_permissions_json)
        print "\n"
      end
    else
      print_h1 "User Details"
      print cyan
      description_cols = {
        "ID" => 'id',
        "Account" => lambda {|it| it['account'] ? it['account']['name'] : '' },
        # "First" => 'firstName',
        # "Last" => 'lastName',
        # "Name" => 'displayName',
        "Name" => lambda {|it| it['firstName'] ? it['displayName'] : '' },
        "Username" => 'username',
        "Email" => 'email',
        "Role" => lambda {|it| format_user_role_names(it) },
        "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
        "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) }
      }
      print_description_list(description_cols, user)

      print_h2 "User Instance Limits"
      print cyan
      print_description_list({
        "Max Storage"  => lambda {|it| (it && it['maxStorage'].to_i != 0) ? Filesize.from("#{it['maxStorage']} B").pretty : "no limit" },
        "Max Memory"  => lambda {|it| (it && it['maxMemory'].to_i != 0) ? Filesize.from("#{it['maxMemory']} B").pretty : "no limit" },
        "CPU Count"  => lambda {|it| (it && it['maxCpu'].to_i != 0) ? it['maxCpu'] : "no limit" }
      }, user['instanceLimits'])

      if options[:include_feature_access] && user_feature_permissions
        if user_feature_permissions
          print_h2 "Feature Permissions"
          print cyan
          rows = user_feature_permissions.collect do |code, access|
            {code: code, access: get_access_string(access) }
          end
          tp rows, [:code, :access]
        else
          puts yellow,"No permissions found.",reset
        end
      end

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

#handle(args) ⇒ Object 



29
30
31
 
# File 'lib/morpheus/cli/users.rb', line 29

def handle(args)
  handle_subcommand(args)
end

#list(args) ⇒ Object 



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

def list(args)
  options = {}
  optparse = OptionParser.new do|opts|
    opts.banner = subcommand_usage()
    build_common_options(opts, options, [:account, :list, :json, :dry_run])
  end
  optparse.parse!(args)
  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    params = {}
    [:phrase, :offset, :max, :sort, :direction].each do |k|
      params[k] = options[k] unless options[k].nil?
    end
    if options[:dry_run]
      print_dry_run @users_interface.dry.list(, params)
      return
    end
    json_response = @users_interface.list(, params)
    users = json_response['users']

    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      title = "Morpheus Users"
      subtitles = []
      if 
        subtitles << "Account: #{['name']}".strip
      end
      if params[:phrase]
        subtitles << "Search: #{params[:phrase]}".strip
      end
      print_h1 title, subtitles
      if users.empty?
        puts yellow,"No users found.",reset
      else
        print_users_table(users)
        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 



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

def remove(args)
  usage = "Usage: morpheus users remove [username]"
  options = {}
  optparse = OptionParser.new do|opts|
    opts.banner = subcommand_usage("[username]")
    build_common_options(opts, options, [:account, :auto_confirm, :json, :dry_run])
  end
  optparse.parse!(args)

  if args.count < 1
    puts optparse
    exit 1
  end

  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    user = find_user_by_username_or_id(, args[0])
    exit 1 if user.nil?
    unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the user #{user['username']}?")
      exit
    end
    if options[:dry_run]
      print_dry_run @users_interface.dry.destroy(, user['id'])
      return
    end
    json_response = @users_interface.destroy(, user['id'])

    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "User #{user['username']} removed"
      # list([])
    end
  rescue RestClient::Exception => e
    print_rest_exception(e, options)
    exit 1
  end
end

#update(args) ⇒ Object 



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

def update(args)
  options = {}
  optparse = OptionParser.new do|opts|
    opts.banner = subcommand_usage("[username] [options]")
    build_option_type_options(opts, options, update_user_option_types)
    build_common_options(opts, options, [:account, :options, :json, :dry_run])
  end
  optparse.parse!(args)

  if args.count < 1
    print_red_alert "Specify atleast one option to update"
    puts optparse
    exit 1
  end

  connect(options)
  begin

     = (options)
     =  ? ['id'] : nil

    user = find_user_by_username_or_id(, args[0])
    exit 1 if user.nil?

    #params = Morpheus::Cli::OptionTypes.prompt(update_user_option_types, options[:options], @api_client, options[:params])
    params = options[:options] || {}
    if params.empty?
      puts optparse
      exit 1
    end
    roles = prompt_user_roles(, user['id'], options.merge(no_prompt: true))
    if !roles.empty?
      params['roles'] = roles.collect {|r| {id: r['id']} }
    end
    if params.empty?
      puts optparse.banner
      puts Morpheus::Cli::OptionTypes.display_option_types_help(update_user_option_types)
      exit 1
    end

    #puts "parsed params is : #{params.inspect}"
    user_keys = ['username', 'firstName', 'lastName', 'email', 'password', 'instanceLimits', 'roles']
    user_payload = params.select {|k,v| user_keys.include?(k) }
    if !user_payload['instanceLimits']
      user_payload['instanceLimits'] = {}
      user_payload['instanceLimits']['maxStorage'] = params['instanceLimits.maxStorage'].to_i if params['instanceLimits.maxStorage'].to_s.strip != ''
      user_payload['instanceLimits']['maxMemory'] = params['instanceLimits.maxMemory'].to_i if params['instanceLimits.maxMemory'].to_s.strip != ''
      user_payload['instanceLimits']['maxCpu'] = params['instanceLimits.maxCpu'].to_i if params['instanceLimits.maxCpu'].to_s.strip != ''
    end

    payload = {user: user_payload}
    json_response = @users_interface.update(, user['id'], payload)
    if options[:dry_run]
      print_dry_run @users_interface.dry.update(, user['id'], payload)
      return
    end

    if options[:json]
      print JSON.pretty_generate(json_response)
      print "\n"
    else
      print_green_success "Updated user #{user_payload['username']}"
      details_options = [user_payload["username"] || user['username']]
      if 
        details_options.push "--account-id", ['id'].to_s
      end
      get(details_options)
    end

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