morpheus-cli 5.0.0 → 5.0.1

data/lib/morpheus/cli/remote.rb

@@ -23,6 +23,8 @@ class Morpheus::Cli::Remote
 
   set_default_subcommand :list
 
+  set_subcommands_hidden :setup # this is going away too
+
   def initialize()
     @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
   end
@@ -595,7 +597,7 @@ EOT
     if args.count != 0
       raise_command_error "wrong number of arguments, expected 0-1 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
     end
-    connect(options) # needed?
+    #connect(options) # needed?
     _check_all_appliances(options)
   end
   
@@ -826,6 +828,12 @@ EOT
         options[:do_offline] = true
       end
       build_common_options(opts, options, [:json,:yaml,:csv,:fields, :quiet])
+      opts.footer = <<-EOT
+Print details about the a remote appliance.
+[name] is optional. This is the name of a remote. 
+By default, the current appliance is used.
+Returns an error if the specified remote is not found, or there is no current remote.
+EOT
     end
     optparse.parse!(args)
     id_list = nil
@@ -843,7 +851,16 @@ EOT
 
   def _get(appliance_name, options)
     exit_code, err = 0, nil
-    
+    if appliance_name == 'current'
+      current_appliance = ::Morpheus::Cli::Remote.load_active_remote()
+      if current_appliance.nil?
+        #raise_command_error "No current appliance, see the command `remote use`"
+        unless options[:quiet]
+          print yellow, "No current appliance, see the command `remote use`", reset, "\n"
+        end
+        return 1, "No current appliance"
+      end
+    end
     appliance = load_remote_by_name(appliance_name)
     appliance_name = appliance[:name]
     appliance_url = appliance[:url]
@@ -1039,15 +1056,14 @@ EOT
       end
       build_common_options(opts, options, [:quiet])
       opts.footer = <<-EOT
-[name] is required. This is the name of a remote, see the command `remote list`.
+[name] is required. This is the name of a remote to begin using.
 Start using a remote, making it the active (current) remote appliance.
 This switches the remote context of your client configuration for all subsequent commands.
-So rely on 'remote use' with caution.
 It is important to always be aware of the context your commands are running in.
 The command `remote current` will return the current remote information.
-Also, instead of using an active remote, the -r option can be specified in your commands.
+Instead of using an active remote, the -r option can be specified with each command.
 
-It is recommeneded to set a custom prompt to show the remote name.
+It is recommeneded to set a custom prompt to show the current remote name.
 For example, add the following to your .morpheusrc file:
 
   # set your shell prompt to display the current username and remote
@@ -1155,13 +1171,22 @@ EOT
     end
     optparse.parse!(args)
     verify_args!(args:args, count:0, optparse:optparse)
-    connect(options)
+    #connect(options)
+
+    current_appliance = ::Morpheus::Cli::Remote.load_active_remote()
+    if current_appliance.nil?
+      #raise_command_error "No current appliance, see the command `remote use`"
+      unless options[:quiet]
+        print yellow, "No current appliance, see the command `remote use`", reset, "\n"
+      end
+      return 1, "No current appliance"
+    end
 
     # this does the same thing
     #return _get("current", options)
-
-    # appliance = load_remote_by_name("current")
-    appliance = @remote_appliance
+    appliance = current_appliance
+    #appliance = load_remote_by_name("current")
+    #appliance = @remote_appliance
     exit_code, err = 0, nil
     if appliance.nil?
       raise_command_error "no current remote appliance, see command `remote add`."

data/lib/morpheus/cli/reports_command.rb

@@ -15,7 +15,10 @@ class Morpheus::Cli::ReportsCommand
     @reports_interface = @api_client.reports
   end
 
-  register_subcommands :list, :get, :run, :view, :export, :remove, :types
+  register_subcommands :list, :get, :run, :view, :export, :remove
+  register_subcommands :'list-types' => :list_types
+  register_subcommands :'get-type' => :get_type
+  alias_subcommand :types, :'list-types'
   
   def default_refresh_interval
     5
@@ -271,10 +274,10 @@ class Morpheus::Cli::ReportsCommand
 
         # Report Types tell us what the available filters are...
         report_option_types = report_type['optionTypes'] || []
-        report_option_types = report_option_types.collect {|it|
-          it['fieldContext'] = nil
-          it
-        }
+        # report_option_types = report_option_types.collect {|it|
+        #   it['fieldContext'] = nil
+        #   it
+        # }
         # pluck out optionTypes like the UI does..
         metadata_option_type = nil
         if report_option_types.find {|it| it['fieldName'] == 'metadata' }
@@ -284,6 +287,13 @@ class Morpheus::Cli::ReportsCommand
         v_prompt = Morpheus::Cli::OptionTypes.prompt(report_option_types, options[:options], @api_client)
         payload.deep_merge!({'report' => v_prompt}) unless v_prompt.empty?
 
+        # strip out fieldContext: 'config' please
+        # just report.startDate instead of report.config.startDate
+        if payload['report']['config'].is_a?(Hash)
+          payload['report']['config']
+          payload['report'].deep_merge!(payload['report'].delete('config'))
+        end
+
         if metadata_option_type
           if !options[:options]['metadata']
             metadata_filter = prompt_metadata(options)
@@ -466,33 +476,30 @@ class Morpheus::Cli::ReportsCommand
     end
   end
 
-  def types(args)
+  def list_types(args)
+    params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage()
-      build_common_options(opts, options, [:list, :json, :dry_run, :remote])
+      build_standard_list_options(opts, options)
       opts.footer = "List report types."
     end
     optparse.parse!(args)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
     connect(options)
-    begin
-      params = {}
-      params.merge!(parse_list_options(options))
-      
-      @reports_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @reports_interface.dry.types(params)
-        return
-      end
-
-      json_response = @reports_interface.types(params)
-      if options[:json]
-        print JSON.pretty_generate(json_response)
-        print "\n"
-        return
-      end
-      
+    params.merge!(parse_list_options(options))
+    
+    @reports_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @reports_interface.dry.types(params)
+      return
+    end
 
+    json_response = @reports_interface.types(params)
+    report_types = json_response['reportTypes']
+    render_response(json_response, options, 'reportTypes') do
       title = "Morpheus Report Types"
       subtitles = []
       subtitles += parse_list_subtitles(options)
@@ -520,13 +527,75 @@ class Morpheus::Cli::ReportsCommand
         end
       end
       print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
+    end
+    if report_types.empty?
+      return 1, "no report types found"
+    else
+      return 0, nil
     end
   end
 
+  def get_type(args)
+    params = {}
+    options = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = subcommand_usage()
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get report type
+[name] is required. This is the name of a report type
+EOT
+    end
+    optparse.parse!(args)
+    connect(options)
+    verify_args!(args:args, optparse:optparse, min:1)
+    params.merge!(parse_query_options(options))
+    params['name'] = args.join(" ")
+    @reports_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @reports_interface.dry.types(params)
+      return
+    end
+    
+    # json_response = @reports_interface.types(params)
+    # api does not have a show() action right now... so find by code or name only
+    report_type = find_report_type_by_name_or_code_id(params['name'])
+    return 1 if report_type.nil?
+    
+    # json_response = @reports_interface.get_type(report_type['id'])
+    # report_type = json_response['reportType']
+    json_response = {'reportType' => report_type}
+    render_response(json_response, options, 'reportType') do
+      print_h1 "Report Type Details", [], options
+      
+      description_cols = {
+        "ID" => 'id',
+        "Name" => 'name',
+        "Code" => 'code',
+        "Description" => 'description',
+        "Category" => 'category'
+      }
+      print_description_list(description_cols, report_type)
+
+      print_h2 "Option Types", options
+      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'] } },
+      ]
+      option_types = report_type['optionTypes']
+      sorted_option_types = (option_types && option_types[0] && option_types[0]['displayOrder']) ? option_types.sort { |x,y| x['displayOrder'].to_i <=> y['displayOrder'].to_i } : option_types
+      print as_pretty_table(sorted_option_types, opt_columns)
+
+      print reset,"\n"
+    end
+    return 0, nil
+    
+  end
 
   def find_report_result_by_id(id)
     begin
@@ -551,7 +620,7 @@ class Morpheus::Cli::ReportsCommand
   end
 
   def find_report_type_by_id(id)
-    @all_report_types ||= @reports_interface.list({max: 1000})['reportTypes'] || []
+    @all_report_types ||= @reports_interface.types({max: 10000})['reportTypes'] || []
     report_types = @all_report_types.select { |it| id && it['id'] == id.to_i }
     if report_types.empty?
       print_red_alert "Report Type not found by id #{id}"
@@ -570,7 +639,7 @@ class Morpheus::Cli::ReportsCommand
   end
 
   def find_report_type_by_name_or_code(name)
-    @all_report_types ||= @reports_interface.list({max: 1000})['reportTypes'] || []
+    @all_report_types ||= @reports_interface.types({max: 10000})['reportTypes'] || []
     report_types = @all_report_types.select { |it| name && it['code'] == name || it['name'] == name }
     if report_types.empty?
       print_red_alert "Report Type not found by code #{name}"

data/lib/morpheus/cli/search_command.rb

@@ -0,0 +1,182 @@
+require 'morpheus/cli/cli_command'
+
+class Morpheus::Cli::SearchCommand
+  include Morpheus::Cli::CliCommand
+  
+  set_command_name :search
+  set_command_description "Global search for finding all types of objects"
+
+  def connect(opts)
+    @api_client = establish_remote_appliance_connection(opts)
+    @search_interface = @api_client.search
+  end
+
+  def handle(args)
+    options = {}
+    params = {}
+    optparse = Morpheus::Cli::OptionParser.new do |opts|
+      opts.banner = "Usage: #{prog_name} #{command_name} [phrase]"
+      opts.on("-g", "--go", "Go get details for the top search result instead of printing the list.") do
+        options[:go] = true
+      end
+      build_standard_list_options(opts, options)
+      opts.footer = <<-EOT
+Global search for finding all types of objects
+[phrase] is required. This is the phrase to search for.
+Prints the list of search results with the most relevant first.
+or use the --go option to get details about the top result instead.
+EOT
+    end
+    optparse.parse!(args)
+    connect(options)
+    # verify_args!(args:args, optparse:optparse, min:1)
+    if args.count > 0
+      options[:phrase] = args.join(" ")
+    end
+    if options[:phrase].to_s.empty?
+      raise_command_error "[phrase] is required.", args, optparse
+    end
+    params.merge!(parse_list_options(options))
+    @search_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @search_interface.dry.list(params)
+      return
+    end
+    json_response = @search_interface.list(params)
+    search_results = json_response["hits"] || json_response["results"] || []
+    top_result = search_results[0]
+    if options[:go]
+      if top_result
+        print cyan,"Loading top search result: #{format_morpheus_type(top_result['type'])} #{top_result['name'] || top_result['id']} (score: #{top_result['score']})",reset,"\n"
+        return go_to_search_result(top_result, options)
+      else
+        # print cyan,"No results found.",reset,"\n"
+        raise_command_error "No search results for phrase '#{options[:phrase]}'"
+      end
+    end
+    render_response(json_response, options, "hits") do
+      print_h1 "Morpheus Search", parse_list_subtitles(options), options
+      if search_results.empty?
+        print cyan,"No results found.",reset,"\n"
+      else
+        columns = {
+          "Type" => lambda {|it| format_morpheus_type(it['type']) },
+          "ID" => 'id',
+          # "UUID" => 'uuid',
+          "Name" => 'name',
+          "Decription" => 'description',
+          #"Score" => 'score',
+          "Date Created" => lambda {|it| format_local_dt(it['dateCreated']) },
+        }
+        print as_pretty_table(search_results, columns.upcase_keys!, options)
+        print_results_pagination(json_response)
+      end
+      print reset,"\n"
+    end
+    if search_results.empty?
+      return 1, "no results found"
+    else
+      return 0, nil
+    end
+  end
+
+  protected
+
+  def format_morpheus_type(val)
+    if val == "ComputeSite"
+      "Group"
+    elsif val == "ComputeZone"
+      "Cloud"
+    elsif val == "ComputeServer"
+      "Host"
+    elsif val == "ComputeServerGroup"
+      "Cluster"
+    elsif val == "ComputeZonePool"
+      "Pool"
+    else
+      val
+    end
+  end
+  
+  def go_to_search_result(result, options)
+    result_type = result['type']
+    cmd_class = lookup_morpheus_command(result['type'])
+    if cmd_class
+      get_options = []
+      get_options += (options[:remote] ? ["-r",options[:remote]] : [])
+      get_options += (options[:json] ? ["--json"] : [])
+      get_options += (options[:yaml] ? ["--yaml"] : [])
+      return cmd_class.new.handle(["get", result['id']] + get_options)
+    else
+      raise_command_error "Sorry, result cannot be loaded. type: #{result_type}, id: #{result['id']}, name: #{result['name']}"
+    end
+  end
+
+
+  def lookup_morpheus_command(result_type)
+    case result_type.to_s.downcase
+    when "computezone","cloud","zone"
+      Morpheus::Cli::Clouds
+    when "computesite","group"
+      Morpheus::Cli::Groups
+    when "computeserver","server","host"
+      Morpheus::Cli::Hosts
+    when "computeservergroup","serverGroup","cluster"
+      Morpheus::Cli::Clusters
+    when "instance"
+      Morpheus::Cli::Instances
+    when "app"
+      Morpheus::Cli::Apps
+    when "container"
+      Morpheus::Cli::Containers
+    when "computezonefolder","zonefolder","resourcefolder"
+      # crap, need result.zoneId, or resource-folders should not require cloud actually, get by id
+      # Morpheus::Cli::CloudFoldersCommand
+      nil
+    when "computezonepool","zonepool","resourcepool"
+      # crap, need result.zoneId, or resource-pools should not require cloud actually, get by id
+      # Morpheus::Cli::CloudResourcePoolsCommand
+      nil
+    # when "chassis"
+    #   Morpheus::Cli::ChassisCommand
+    when "network"
+      Morpheus::Cli::NetworksCommand
+    when "networkgroup"
+      Morpheus::Cli::NetworkGroupsCommand
+    when "networkpool"
+      Morpheus::Cli::NetworkPoolsCommand
+    when "networkdomain"
+      Morpheus::Cli::NetworkDomainsCommand
+    when "virtualimage"
+      Morpheus::Cli::VirtualImages
+    when "loadbalancer"
+      Morpheus::Cli::LoadBalancers
+    # when "virtualserver","loadbalancerinstance"
+    #   Morpheus::Cli::LoadBalancerInstances
+    when "instancetype"
+      # Morpheus::Cli::LibraryInstanceTypesCommand
+      Morpheus::Cli::LibraryInstanceTypes
+    when "instancetypelayout","layout"
+      Morpheus::Cli::LibraryLayoutsCommand
+    when "certificate"
+      # todo: WHAT! didnt I write certs already!?
+      Morpheus::Cli::CertificatesCommand
+    when "keypair"
+      Morpheus::Cli::KeyPairs
+    when "integration"
+      Morpheus::Cli::IntegrationsCommand
+    when "account","tenant"
+      Morpheus::Cli::TenantsCommand
+    when "user"
+      Morpheus::Cli::Users
+    when "role"
+      Morpheus::Cli::Roles
+    when "wikipage","wiki"
+      Morpheus::Cli::WikiCommand
+    else
+      nil
+    end
+  end
+
+end
+