morpheus-cli 5.3.3 → 5.4.2

data/lib/morpheus/cli/{users.rb → commands/users.rb}

@@ -1,11 +1,4 @@
-# require 'yaml'
-require 'io/console'
-require 'rest_client'
-require 'optparse'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/option_types'
-require 'morpheus/cli/mixins/accounts_helper'
-require 'json'
 
 class Morpheus::Cli::Users
   include Morpheus::Cli::CliCommand
@@ -22,7 +15,7 @@ class Morpheus::Cli::Users
 
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @accounts_interface = @api_client.accounts
     @roles_interface = @api_client.roles
   end
@@ -62,12 +55,12 @@ class Morpheus::Cli::Users
     account_id = account ? account['id'] : nil
     params['global'] = true if options[:global]
     params.merge!(parse_list_options(options))
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
-      print_dry_run @users_interface.dry.list(account_id, params)
+      print_dry_run @account_users_interface.dry.list(account_id, params)
       return 0, nil
     end
-    json_response = @users_interface.list(account_id, params)
+    json_response = @account_users_interface.list(account_id, params)
     render_response(json_response, options, "users") do
       users = json_response['users']
       title = "Morpheus Users"
@@ -110,12 +103,12 @@ class Morpheus::Cli::Users
       account_id = account ? account['id'] : nil
       params['global'] = true if options[:global]
       params.merge!(parse_list_options(options))
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.list(account_id, params)
+        print_dry_run @account_users_interface.dry.list(account_id, params)
         return
       end
-      json_response = @users_interface.list(account_id, params)
+      json_response = @account_users_interface.list(account_id, params)
       # print number only
       if json_response['meta'] && json_response['meta']['total']
         print cyan, json_response['meta']['total'], reset, "\n"
@@ -202,12 +195,12 @@ EOT
     account = find_account_from_options(options)
     account_id = account ? account['id'] : nil
     params['global'] = true if options[:global]
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
       if args[0].to_s =~ /\A\d{1,}\Z/
-        print_dry_run @users_interface.dry.get(account_id, args[0].to_i, params)
+        print_dry_run @account_users_interface.dry.get(account_id, args[0].to_i, params)
       else
-        print_dry_run @users_interface.dry.list(account_id, params.merge({username: args[0]}))
+        print_dry_run @account_users_interface.dry.list(account_id, params.merge({username: args[0]}))
       end
       return
     end
@@ -220,7 +213,7 @@ EOT
       user_id = user['id']
     end
     # always get by id, index does not return 'access'
-    json_response = @users_interface.get(account_id, user_id, params)
+    json_response = @account_users_interface.get(account_id, user_id, params)
     user = json_response['user']
     render_response(json_response, options, "user") do
       is_tenant_account = current_account['id'] != user['account']['id']
@@ -230,7 +223,7 @@ EOT
 
       # backward compatibility
       if user['access'].nil? && options[:include_features_access]
-        user_feature_permissions_json = @users_interface.feature_permissions(account_id, user['id'])
+        user_feature_permissions_json = @account_users_interface.feature_permissions(account_id, user['id'])
         user_feature_permissions = user_feature_permissions_json['permissions'] || user_feature_permissions_json['featurePermissions']
 
         if user_feature_permissions
@@ -315,15 +308,15 @@ EOT
       params['global'] = true if options[:global]
       user = find_user_by_username_or_id(account_id, args[0], params)
       return 1 if user.nil?
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.permissions(account_id, user['id'])
+        print_dry_run @account_users_interface.dry.permissions(account_id, user['id'])
         return
       end
 
       is_tenant_account = current_account['id'] != user['account']['id']
 
-      json_response = @users_interface.permissions(account_id, user['id'])
+      json_response = @account_users_interface.permissions(account_id, user['id'])
 
       # backward compatibility
       if !json_response['permissions'].nil?
@@ -467,12 +460,12 @@ EOT
         puts as_json(payload, options)
         return 0
       end
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.create(account_id, payload)
+        print_dry_run @account_users_interface.dry.create(account_id, payload)
         return
       end
-      json_response = @users_interface.create(account_id, payload)
+      json_response = @account_users_interface.create(account_id, payload)
       if options[:json]
         print JSON.pretty_generate(json_response)
         print "\n"
@@ -552,12 +545,12 @@ EOT
         end
       end
 
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.update(account_id, user['id'], payload)
+        print_dry_run @account_users_interface.dry.update(account_id, user['id'], payload)
         return
       end
-      json_response = @users_interface.update(account_id, user['id'], payload)
+      json_response = @account_users_interface.update(account_id, user['id'], payload)
       user = json_response['user']
       if options[:json]
         print JSON.pretty_generate(json_response)
@@ -652,12 +645,12 @@ EOT
       }
 
     end
-    @users_interface.setopts(options)
+    @account_users_interface.setopts(options)
     if options[:dry_run]
-      print_dry_run @users_interface.dry.update(account_id, user['id'], payload)
+      print_dry_run @account_users_interface.dry.update(account_id, user['id'], payload)
       return
     end
-    json_response = @users_interface.update(account_id, user['id'], payload)
+    json_response = @account_users_interface.update(account_id, user['id'], payload)
     render_response(json_response, optparse, "user") do
       print_green_success "Updated password for user #{user['username']}"
     end
@@ -691,12 +684,12 @@ EOT
       unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the user #{user['username']}?")
         exit 9, "arborted"
       end
-      @users_interface.setopts(options)
+      @account_users_interface.setopts(options)
       if options[:dry_run]
-        print_dry_run @users_interface.dry.destroy(account_id, user['id'])
+        print_dry_run @account_users_interface.dry.destroy(account_id, user['id'])
         return 0
       end
-      json_response = @users_interface.destroy(account_id, user['id'])
+      json_response = @account_users_interface.destroy(account_id, user['id'])
 
       if options[:json]
         print JSON.pretty_generate(json_response)
@@ -766,7 +759,7 @@ EOT
       end
     end
 
-    available_roles = @users_interface.available_roles(account_id, user_id)['roles']
+    available_roles = @account_users_interface.available_roles(account_id, user_id)['roles']
 
     if available_roles.empty?
       print_red_alert "No available roles found."

data/lib/morpheus/cli/commands/view.rb

@@ -0,0 +1,102 @@
+require 'morpheus/cli/cli_command'
+# require 'morpheus/routes'
+
+class Morpheus::Cli::View
+  include Morpheus::Cli::CliCommand
+
+  set_command_description "Open the remote appliance in a web browser"
+  set_command_name :'view'
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+  end
+  
+  def handle(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage("[path] [id]")
+      # debate: should login using /login/ouath-redirect
+      opts.on('-L', '--login', "Login with the CLI access token before loading the path." ) do
+        options[:login] = true
+      end
+      opts.on('--absolute', "Absolute path, do not search for a matching route to use") do
+        options[:absolute_path] = true
+      end
+      build_common_options(opts, options, [:dry_run, :remote])
+      opts.footer = <<-EOT
+View the remote appliance in a web browser.
+[path] is optional. This the path or resource type to load. The default is the index page "/".
+[id] is optional. This is the resource name or id to be append to the path to load details of a specific object.
+The [path] is matched against the #{prog_name} UI site map to find the best matching route.
+Route matching is skipped if the path begins with a "/" or --absolute is used.
+By default no authentication is not done and the existing web browser session used.
+The --login option will authenticate via the CLI access token and create a new browser session.
+
+Examples:
+    view --login
+    view monitoring
+    view user 1
+    view user administrator
+    view /infrastructure/clouds/2
+EOT
+    end
+    optparse.parse!(args)
+    # verify_args!(args:args, optparse:optparse, min: 0, max: 2)
+    connect(options)
+    # todo: it would actually be cool to use the params and include them on the path..
+    # params.merge!(parse_query_options(options))
+    path, *ids = args
+    # default to index page "/"
+    path = path || "/"
+    if options[:absolute_path] != true
+      if path.start_with?("/")
+        # treat like absolute path, no lookup
+      else
+        # lookup best matching route from sitemap
+        # lookup plural routes first, so 'app' finds apps and not approvals
+        found_route = Morpheus::Routes.lookup(path)
+        if found_route
+          # Morpheus::Logging::DarkPrinter.puts "Found matching route: '#{path}' => '#{found_route}'" if Morpheus::Logging.debug?
+          path = found_route
+        else
+          # just use specified path
+        end
+      end
+      # always add a leading slash
+      path = path.start_with?("/") ? path : "/#{path}"
+      # append id(s) to path if passed
+      if ids.size > 0
+        # convert names to ids
+        # assume the last part of path is the type and use generic finder
+        # only lookup names, and allow any id
+        ids = ids.collect do |id|
+          if id.to_s !~ /\A\d{1,}\Z/
+            # assume the last part of path is the type
+            record_type = path.split("/").last
+            record = find_by_name(record_type, id)
+            if record.nil?
+              raise_command_error("[id] is invalid. No #{record_type} found for '#{id}'", args, optparse)
+            end
+            record['id'].to_s
+          else
+            id
+          end
+        end
+        path = "#{path}/" + ids.join("/")
+      end
+    end
+    # build the link to use, either our path or oauth-redirect to that path
+    link = "#{@appliance_url}#{path}"
+    if options[:login]
+      # uh, this should need CGI::escape(path)
+      link = "#{@appliance_url}/login/oauth-redirect?access_token=#{@access_token}\\&redirectUri=#{path}"
+    end
+    if options[:dry_run]
+      print_system_command_dry_run(Morpheus::Util.open_url_command(link), options)
+      return 0, nil
+    end
+    return Morpheus::Util.open_url(link)
+  end
+
+end

data/lib/morpheus/cli/{virtual_images.rb → commands/virtual_images.rb}

@@ -1,7 +1,3 @@
-# require 'yaml'
-require 'io/console'
-require 'rest_client'
-require 'optparse'
 require 'morpheus/cli/cli_command'
 
 # JD: I don't think a lot of this has ever worked, fix it up.
@@ -83,6 +79,7 @@ class Morpheus::Cli::VirtualImages
     json_response = @virtual_images_interface.list(params)
     images = json_response['virtualImages']
     render_response(json_response, options, 'virtualImages') do
+      get_available_virtual_image_types() # preload
       title = "Morpheus Virtual Images"
       subtitles = parse_list_subtitles(options)
       if options[:imageType]
@@ -192,6 +189,7 @@ EOT
       image_type = virtual_image_type_for_name_or_code(image['imageType'])
       image_type_display = image_type ? "#{image_type['name']}" : image['imageType']
       render_response(json_response, options, 'virtualImage') do
+        get_available_virtual_image_types() # preload
         print_h1 "Virtual Image Details", [], options
         description_cols = {
           "ID" => 'id',

data/lib/morpheus/cli/{whitelabel_settings_command.rb → commands/whitelabel_settings_command.rb}

@@ -1,5 +1,4 @@
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/mixins/accounts_helper'
 
 class Morpheus::Cli::WhitelabelSettingsCommand
   include Morpheus::Cli::CliCommand

data/lib/morpheus/cli/{whoami.rb → commands/whoami.rb}

@@ -1,8 +1,4 @@
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/mixins/whoami_helper'
-require 'morpheus/cli/mixins/accounts_helper'
-require 'fileutils'
-require 'yaml'
 
 class Morpheus::Cli::Whoami
   include Morpheus::Cli::CliCommand

data/lib/morpheus/cli/{wiki_command.rb → commands/wiki_command.rb}

@@ -1,9 +1,4 @@
-require 'io/console'
-require 'rest_client'
-require 'optparse'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/option_types'
-require 'json'
 
 class Morpheus::Cli::WikiCommand
   include Morpheus::Cli::CliCommand

data/lib/morpheus/cli/{workflows.rb → commands/workflows.rb}

@@ -1,6 +1,3 @@
-# require 'yaml'
-require 'io/console'
-require 'rest_client'
 require 'morpheus/cli/cli_command'
 
 class Morpheus::Cli::Workflows

data/lib/morpheus/cli/mixins/accounts_helper.rb

@@ -15,10 +15,10 @@ module Morpheus::Cli::AccountsHelper
     @accounts_interface
   end
 
-  def users_interface
+  def account_users_interface
     # @api_client.users
-    raise "#{self.class} has not defined @users_interface" if @users_interface.nil?
-    @users_interface
+    raise "#{self.class} has not defined @account_users_interface" if @account_users_interface.nil?
+    @account_users_interface
   end
 
   def user_groups_interface
@@ -244,7 +244,7 @@ module Morpheus::Cli::AccountsHelper
 
   def find_user_by_id(account_id, id, params={})
     begin
-      json_response = users_interface.get(account_id, id.to_i, params)
+      json_response = account_users_interface.get(account_id, id.to_i, params)
       return json_response['user']
     rescue RestClient::Exception => e
       if e.response && e.response.code == 404
@@ -256,7 +256,7 @@ module Morpheus::Cli::AccountsHelper
   end
 
   def find_user_by_username(account_id, username, params={})
-    users = users_interface.list(account_id, params.merge({username: username.to_s}))['users']
+    users = account_users_interface.list(account_id, params.merge({username: username.to_s}))['users']
     if users.empty?
       print_red_alert "User not found by username #{username}"
       return nil

data/lib/morpheus/cli/mixins/load_balancers_helper.rb

@@ -34,7 +34,7 @@ module Morpheus::Cli::LoadBalancersHelper
     'Load Balancer'
   end
 
-  def load_balancer_plural_label
+  def load_balancer_label_plural
     'Load Balancers'
   end
 
@@ -50,7 +50,7 @@ module Morpheus::Cli::LoadBalancersHelper
     'Load Balancer Type'
   end
 
-  def load_balancer_type_plural_label
+  def load_balancer_type_label_plural
     'Load Balancer Types'
   end
 
@@ -105,12 +105,32 @@ module Morpheus::Cli::LoadBalancersHelper
     end
   end
 
-  def load_balancer_type_for_id(id)
-    return get_available_load_balancer_types().find { |z| z['id'].to_i == id.to_i}
+  def load_balancer_type_for_id(val)
+    record = get_available_load_balancer_types().find { |z| z['id'].to_i == val.to_i}
+    label = "Load Balancer Type"
+    if record.nil?
+      print_red_alert "#{label.downcase} not found by id #{val}"
+      return nil
+    end
+    return record
   end
 
-  def load_balancer_type_for_name(name)
-    return get_available_load_balancer_types().find { |z| z['name'].downcase == name.downcase || z['code'].downcase == name.downcase}
+  def load_balancer_type_for_name(val)
+    records = get_available_load_balancer_types().select { |z| z['name'].downcase == val.downcase || z['code'].downcase == val.downcase}
+    label = "Load Balancer Type"
+    if records.empty?
+      print_red_alert "#{label} not found by name '#{val}'"
+      return nil
+    elsif records.size > 1
+      print_red_alert "More than one #{label.downcase} found by name '#{val}'"
+      print_error "\n"
+      puts_error as_pretty_table(records, [:id, :name], {color:red})
+      print_red_alert "Try using ID instead"
+      print_error reset,"\n"
+      return nil
+    else
+      return records[0]
+    end
   end
 
   def find_load_balancer_type_by_name_or_id(val)

data/lib/morpheus/cli/mixins/logs_helper.rb

@@ -68,7 +68,7 @@ module Morpheus::Cli::LogsHelper
       else
         log_msg = truncate_string(log_entry['message'].to_s.strip.gsub(/\r?\n/, " "), message_col_width)
       end
-      out << "- #{log_msg}"
+      out << "#{log_msg}"
       out << table_color if table_color
       out << "\n"
     end

data/lib/morpheus/cli/mixins/print_helper.rb

@@ -6,6 +6,7 @@ require 'ostruct'
 require 'io/console'
 require 'morpheus/logging'
 require 'fileutils'
+require 'filesize'
 
 module Morpheus::Cli::PrintHelper
 
@@ -201,7 +202,7 @@ module Morpheus::Cli::PrintHelper
     if options[:outfile]
       print_result = print_to_file(output, options[:outfile], options[:overwrite])
       # with_stdout_to_file(options[:outfile], options[:overwrite]) { print output }
-      print "#{cyan}Wrote output to file #{options[:outfile]} (#{format_bytes File.size(options[:outfile])})\n" unless options[:quiet]
+      print "#{cyan}Wrote output to file #{options[:outfile]} (#{format_bytes(File.size(options[:outfile]))})\n" unless options[:quiet]
       #return print_result
       return
     end
@@ -219,6 +220,14 @@ module Morpheus::Cli::PrintHelper
     return
   end
 
+  def print_system_command_dry_run(cmd, options={})
+    print "\n"
+    print "#{cyan}#{bold}#{dark}SYSTEM COMMAND#{reset}\n"
+    print cmd
+    print reset, "\n"
+    return
+  end
+
   def format_api_request(http_method, url, headers, payload=nil, options={})
     out = ""
     # out << "\n"
@@ -384,33 +393,57 @@ module Morpheus::Cli::PrintHelper
     if json_response.nil? || json_response.empty?
       return ""
     end
-    
-    # options = OpenStruct.new(options) # laff, let's do this instead
     color = options.key?(:color) ? options[:color] : cyan
     label = options[:label]
-    n_label = options[:n_label]
-    # label = n_label if !label && n_label
+    n_label = options[:n_label] || (label ? label.to_s.pluralize : nil)
     message = options[:message] || "Viewing %{start_index}-%{end_index} of %{total} %{label}"
     blank_message = options[:blank_message] || nil # "No %{label} found"
 
-    # support lazy passing of common json_response {"meta": {"size": {25}, "total": 56} }
-    # otherwise use the root values given
-    meta = OpenStruct.new(json_response)
-    if meta.meta
-      meta = OpenStruct.new(meta.meta)
-    end
-    offset, size, total = meta.offset.to_i, meta.size.to_i, meta.total.to_i
-    #objects = meta.objects || options[:objects_key] ? json_response[options[:objects_key]] : nil
-    #objects ||= meta.instances || meta.servers || meta.users || meta.roles
-    #size = objects.size if objects && size == 0
-    if total == 0
+    # support lazy passing of common list json_response {"meta": {"size": 25, "total": 56} }
+    # priority is:
+    # 1. "meta" that api response contains for list endpoints
+    # 2. "total" and "size" values if passed explicitely by the cli (pretty sure symbols are no longer used)
+    # 3. examine the first array found in the response
+    meta = nil
+    records = nil
+    # assume records is the first array in the response
+    records_key = json_response.keys.find { |k| json_response[k].is_a?(Array) }
+    if records_key
+      records = json_response[records_key]
+      meta = {'offset' => 0, 'size' => records.size, 'total' => records.size}
+    end
+    if json_response[:meta] || json_response["meta"]
+      meta = json_response[:meta] || json_response["meta"]
+    elsif json_response.key?('size') || json_response.key?('total')
+      meta = json_response
+    elsif json_response.key?(:size) || json_response.key?(:total)
+      meta = {'size' => json_response[:size], 'total' => json_response[:total], 'offset' => json_response[:offset]}
+    elsif records
+      # just use the first key in the response
+      meta = {'size' => records.size, 'total' => records.size}
+    end
+    # did not find pagination meta info?
+    if meta.nil?
+      return ""
+    end
+    # api should not need to return the size, just use records.size
+    if meta["size"].nil? && records
+      meta["size"] = records.size
+    end
+    offset = meta['offset'].to_i
+    size = meta['size'].to_i
+    total = meta['total'].to_i
+    # perhaps no total count returned, let total be equal to size of list
+    if total == 0 && size > 0
       total = size
     end
+    # plural label?
     if total != 1
-      label = n_label || label
+      label = n_label
     end
     out_str = ""
-    string_key_values = {start_index: format_number(offset + 1), end_index: format_number(offset + size), total: format_number(total), size: format_number(size), offset: format_number(offset), label: label}
+    string_key_values = {start_index: format_number(offset + 1), end_index: format_number(offset + size), 
+      total: format_number(total), size: format_number(size), offset: format_number(offset), label: label}
     if size > 0
       if message
         out_str << message % string_key_values

data/lib/morpheus/cli/mixins/processes_helper.rb

@@ -1,8 +1,7 @@
 require 'morpheus/cli/mixins/print_helper'
 
 # Mixin for Morpheus::Cli command classes
-# Provides common methods for fetching and printing accounts, roles, and users.
-# The including class must establish @accounts_interface, @roles_interface, @users_interface
+# Provides common methods for viewing process history
 module Morpheus::Cli::ProcessesHelper
 
   def self.included(klass)