morpheus-cli 4.2.16 → 4.2.21

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

@@ -70,7 +70,7 @@ module Morpheus::Cli::ProvisioningHelper
 
   def get_available_clouds(group_id, refresh=false)
     if !group_id
-      option_results = options_interface.options_for_source('clouds', {})
+      option_results = options_interface.options_for_source('clouds', {'default' => 'false'})
       return option_results['data'].collect {|it|
         {"id" => it["value"], "name" => it["name"], "value" => it["value"], "zoneTypeId" => it["zoneTypeId"]}
       }
@@ -244,7 +244,7 @@ module Morpheus::Cli::ProvisioningHelper
   end
 
   def find_instance_by_name(name)
-    json_results = instances_interface.get({name: name.to_s})
+    json_results = instances_interface.list({name: name.to_s})
     if json_results['instances'].empty?
       print_red_alert "Instance not found by name #{name}"
       exit 1

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

@@ -1,18 +1,31 @@
 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 fetching and printing whoami information
 module Morpheus::Cli::WhoamiHelper
 
   def self.included(klass)
     klass.send :include, Morpheus::Cli::PrintHelper
   end
 
-  def load_whoami()
-    whoami_interface = @whoami_interface || @api_client.whoami
-    whoami_response = whoami_interface.get()
-    # whoami_response = @whoami_interface.get()
+  def load_whoami(refresh=false)
+    appliance = @remote_appliance # from establish_connection()
+    if appliance.nil?
+      print_red_alert "No current appliance. See `remote use`."
+      exit 1
+    end
+    # fetch from cache first
+    whoami_response = nil
+    cached_response = ::Morpheus::Cli::Whoami.load_whoami(appliance[:name], appliance[:username], refresh)
+    if cached_response
+      whoami_response = cached_response
+    else
+      whoami_interface = @whoami_interface || @api_client.whoami
+      whoami_response = whoami_interface.get()
+      # save the result to the cache
+      ::Morpheus::Cli::Whoami.save_whoami(appliance[:name], appliance[:username], whoami_response)
+    end
+
     @current_user = whoami_response["user"]
     if @current_user.empty?
       print_red_alert "Unauthenticated. Please login."

data/lib/morpheus/cli/network_routers_command.rb

@@ -1040,7 +1040,7 @@ class Morpheus::Cli::NetworkRoutersCommand
 
     begin
       if !is_master_account
-        print_red_alert "Permissions only available for master account"
+        print_red_alert "Permissions only available for master tenant"
         return 1
       end
 

data/lib/morpheus/cli/option_parser.rb

@@ -4,7 +4,11 @@ module Morpheus
   module Cli
 
     # an enhanced OptionParser
-    # not used yet, maybe ever =o
+    # Modifications include
+    # * footer property to compliment banner with footer="Get details about a thing by ID."
+    # * hidden options with add_hidden_option "--not-in-help"
+    # * errors raised from parse! will have a reference to the parser itself.
+    #    this is useful so you can you print the banner (usage) message in your error handling
     class Morpheus::Cli::OptionParser < OptionParser
 
       attr_accessor :footer
@@ -18,7 +22,7 @@ module Morpheus
         full_help_message
       end
 
-      def full_help_message
+      def full_help_message(opts={})
         out = ""
         #out << original_to_s
         if banner
@@ -40,8 +44,15 @@ module Morpheus
                 opt_description.to_s.strip.start_with?("--#{hidden_switch} ")
               end
             }
-            if !is_hidden
-              out  << opt_description
+            if is_hidden
+              if opts[:show_hidden_options]
+                # out << opt_description + " (hidden)"
+                out << opt_description
+              else
+                # hidden
+              end
+            else
+              out << opt_description
             end
           end
         end
@@ -66,7 +77,39 @@ module Morpheus
         @hidden_options
       end
 
-    end
+      # this needs mods too, but we dont use it...
+      # def parse
+      # end
 
+      def parse!(*args)
+        # it is actually # def parse(argv = default_argv, into: nil)
+        argv = [args].flatten() # args[0].flatten
+        #help_wanted = argv.find {|arg| arg == "--help" || arg ==  "-h" }
+        help_wanted = (argv.last == "--help" || argv.last ==  "-h") ? argv.last : nil
+        begin
+          return super(*args)
+        rescue OptionParser::ParseError => e
+          # last arg is --help
+          # maybe they just got the Try --help message and its on the end
+          # so strip all option arguments to avoid OptionParser::InvalidOption, etc.
+          # this is not ideal, it means you cannot pass these strings as the last argument to your command.
+          if help_wanted
+            argv = argv.reject {|arg| arg =~ /^\-+/ }
+            argv << help_wanted
+            return super(argv)
+          else
+            e.optparse = self
+            raise e
+          end
+          
+        end
+      end
+    end
   end
 end
+
+# ParseError is overridden to set parser reference.
+# todo: dont monkey patch like this
+class OptionParser::ParseError
+  attr_accessor :optparse
+end

data/lib/morpheus/cli/option_types.rb

@@ -322,7 +322,7 @@ module Morpheus
         elsif option_type['optionSource']
           # calculate from inline lambda
           if option_type['optionSource'].is_a?(Proc)
-            select_options = option_type['optionSource'].call()
+            select_options = option_type['optionSource'].call(api_client, grails_params(api_params || {}))
           elsif option_type['optionSource'] == 'list'
             # /api/options/list is a special action for custom OptionTypeLists, just need to pass the optionTypeId parameter
             select_options = load_source_options(option_type['optionSource'], api_client, {'optionTypeId' => option_type['id']})

data/lib/morpheus/cli/projects_command.rb

@@ -102,7 +102,7 @@ EOT
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[project]")
-      build_common_options(opts, options, [:json, :yaml, :csv, :fields, :dry_run, :remote])
+      build_standard_get_options(opts, options, [:find_by_name])
       opts.footer = <<-EOT
 Get details about a project.
 [project] is required. This is the name or id of a project.
@@ -127,8 +127,8 @@ EOT
       end
       return
     end
-    project = find_project_by_name_or_id(id)
-    exit 1 if project.nil?
+    project = options[:find_by_name] ? find_project_by_name(id) : find_project_by_name_or_id(id)
+    return 1, "project not found by '#{id}'" if project.nil?
     # refetch it by id
     json_response = {'project' => project}
     unless id.to_s =~ /\A\d{1,}\Z/
@@ -332,7 +332,7 @@ EOT
       opts.on('--remove-resources LIST', Array, "Remove Resources, comma separated list of resource names or IDs to remove.") do |list|
         remove_resource_ids = list.collect {|it| it.to_s.strip.empty? ? nil : it.to_s.strip }.compact.uniq
       end
-      build_standard_update_options(opts, options)
+      build_standard_update_options(opts, options, [:find_by_name])
       opts.footer = <<-EOT
 Update a project.
 [project] is required. This is the name or id of a project.
@@ -342,7 +342,7 @@ EOT
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
     exit_code, err = 0, nil
-    project = find_project_by_name_or_id(args[0])
+    project = options[:find_by_name] ? find_project_by_name(args[0]) : find_project_by_name_or_id(args[0])
     return 1, "project not found by '#{args[0]}'" if project.nil?
     # construct payload
     if options[:payload]
@@ -433,7 +433,7 @@ EOT
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[project]")
-      build_common_options(opts, options, [:auto_confirm, :json, :dry_run, :quiet, :remote])
+      build_standard_remove_options(opts, options, [:find_by_name])
       # opts.on( '-f', '--force', "Force Delete" ) do
       #   params[:force] = true
       # end
@@ -446,7 +446,7 @@ EOT
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
     exit_code, err = 0, nil
-    project = find_project_by_name_or_id(args[0])
+    project = options[:find_by_name] ? find_project_by_name(args[0]) : find_project_by_name_or_id(args[0])
     return 1, "project not found by '#{args[0]}'" if project.nil?
     unless options[:yes] || Morpheus::Cli::OptionTypes.confirm("Are you sure you want to delete the project #{project['name']}?")
       return 9, "aborted command"

data/lib/morpheus/cli/provisioning_licenses_command.rb

@@ -478,7 +478,7 @@ class Morpheus::Cli::ProvisioningLicensesCommand
 
   def add_license_option_types
     [
-      {'fieldName' => 'licenseType', 'fieldLabel' => 'License Type', 'type' => 'select', 'optionSource' => lambda { 
+      {'fieldName' => 'licenseType', 'fieldLabel' => 'License Type', 'type' => 'select', 'optionSource' => lambda { |api_client, api_params| 
         # @options_interface.options_for_source("licenseTypes", {})['data']
         get_license_types_dropdown()
       }, 'required' => true, 'displayOrder' => 1},
@@ -493,7 +493,7 @@ class Morpheus::Cli::ProvisioningLicensesCommand
         # @options_interface.options_for_source("virtualImages", {})['data']
         get_virtual_images_dropdown()
       }, 'displayOrder' => 9},
-      {'fieldName' => 'tenants', 'fieldLabel' => 'Tenants', 'type' => 'multiSelect', 'optionSource' => lambda { 
+      {'fieldName' => 'tenants', 'fieldLabel' => 'Tenants', 'type' => 'multiSelect', 'optionSource' => lambda { |api_client, api_params| 
         @options_interface.options_for_source("allTenants", {})['data']
       }, 'displayOrder' => 10},
     ]

data/lib/morpheus/cli/remote.rb

@@ -44,7 +44,7 @@ class Morpheus::Cli::Remote
     current_only = false
     do_check = false
     optparse = Morpheus::Cli::OptionParser.new do|opts|
-      opts.banner = subcommand_usage()
+      opts.banner = subcommand_usage("[search]")
       opts.on("-a",'--all', "Show all the appliance activity details") do
         show_all_activity = true
         options[:wrap] = true
@@ -61,8 +61,9 @@ List the configured remote appliances.
 EOT
     end
     optparse.parse!(args)
+    # verify_args!(args:args, optparse:optparse, count:0)
     if args.count > 0
-      raise_command_error "wrong number of arguments, expected 0 and got (#{args.count}) #{args.join(' ')}\n#{optparse}"
+      options[:phrase] = args.join(" ")
     end
     #connect(options)
     params.merge!(parse_list_options(options))

data/lib/morpheus/cli/roles.rb

@@ -12,6 +12,7 @@ class Morpheus::Cli::Roles
   include Morpheus::Cli::CliCommand
   include Morpheus::Cli::AccountsHelper
   include Morpheus::Cli::ProvisioningHelper
+  include Morpheus::Cli::WhoamiHelper
   register_subcommands :list, :get, :add, :update, :remove, :'list-permissions', :'update-feature-access', :'update-global-group-access', :'update-group-access', :'update-global-cloud-access', :'update-cloud-access', :'update-global-instance-type-access', :'update-instance-type-access', :'update-global-blueprint-access', :'update-blueprint-access'
   alias_subcommand :details, :get
   set_default_subcommand :list
@@ -37,36 +38,28 @@ class Morpheus::Cli::Roles
   def list(args)
     options = {}
     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.banner = subcommand_usage("[search phrase]")
+      build_standard_list_options(opts, options)
       opts.footer = "List roles."
     end
     optparse.parse!(args)
-
+    # verify_args!(args:args, optparse:optparse, count:0)
+    options[:phrase] = args.join(" ") if args.count > 0
     connect(options)
-    begin
-      account = find_account_from_options(options)
-      account_id = account ? account['id'] : nil
-      
-      params = {}
-      params.merge!(parse_list_options(options))
-      @roles_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @roles_interface.dry.list(account_id, params), options
-        return
-      end
-      load_whoami()
-      json_response = @roles_interface.list(account_id, params)
-      if options[:json]
-        puts as_json(json_response, options, "roles")
-        return 0
-      elsif options[:yaml]
-        puts as_yaml(json_response, options, "roles")
-        return 0
-      elsif options[:csv]
-        puts records_as_csv(json_response['roles'], options)
-        return 0
-      end
+
+    account = find_account_from_options(options)
+    account_id = account ? account['id'] : nil
+    params = {}
+    params.merge!(parse_list_options(options))
+    @roles_interface.setopts(options)
+    if options[:dry_run]
+      print_dry_run @roles_interface.dry.list(account_id, params), options
+      return 0, nil
+    end
+    load_whoami()
+    json_response = @roles_interface.list(account_id, params)
+
+    render_response(json_response, options, "roles") do
       roles = json_response['roles']
       title = "Morpheus Roles"
       subtitles = []
@@ -75,22 +68,20 @@ class Morpheus::Cli::Roles
       if roles.empty?
         print cyan,"No roles found.",reset,"\n"
       else
-        print_roles_table(roles, options.merge({is_master_account: @is_master_account}))
+        print cyan
+        columns = @is_master_account ? role_column_definitions : subtenant_role_column_definitions
+        print as_pretty_table(roles, columns.upcase_keys!, options)
         print_results_pagination(json_response)
       end
       print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
     end
+    return 0, nil
   end
 
   def get(args)
     options = {}
-    params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[name]")
+      opts.banner = subcommand_usage("[role]")
       opts.on('-p','--permissions', "Display Permissions") do |val|
         options[:include_feature_access] = true
       end
@@ -117,19 +108,26 @@ class Morpheus::Cli::Roles
         options[:include_instance_type_access] = true
         options[:include_blueprint_access] = true
       end
-      build_common_options(opts, options, [:list, :query, :json, :yaml, :csv, :fields, :dry_run, :remote])
-      opts.footer = "Get details about a role.\n" +
-                    "[name] is required. This is the name or id of a role."
+      build_standard_get_options(opts, options)
+      opts.footer = <<-EOT
+Get details about a role.
+[role] is required. This is the name (authority) or id of a role.
+EOT
     end
     optparse.parse!(args)
-
-    if args.count < 1
-      puts optparse
-      return 1
+    verify_args!(args:args, optparse:optparse, min:1)
+    connect(options)
+    id_list = parse_id_list(args)
+    return run_command_for_each_arg(id_list) do |arg|
+      _get(arg, options)
     end
+  end
 
-    connect(options)
-    begin
+  def _get(id, options={})
+    args = [id] # heh
+    params = {}
+
+    
       account = find_account_from_options(options)
       account_id = account ? account['id'] : nil
 
@@ -150,7 +148,7 @@ class Morpheus::Cli::Roles
       # refetch from show action, argh
       # json_response = @roles_interface.get(account_id, role['id'])
       # role = json_response['role']
-
+      load_whoami()
       json_response = nil
       if args[0].to_s =~ /\A\d{1,}\Z/
         json_response = @roles_interface.get(account_id, args[0].to_i)
@@ -163,27 +161,13 @@ class Morpheus::Cli::Roles
         role = json_response['role']
       end
 
-      render_result = render_with_format(json_response, options, 'role')
-      return 0 if render_result
-
+      render_response(json_response, options, 'role') do
+      
       print cyan
       print_h1 "Role Details", options
       print cyan
-      description_cols = {
-        "ID" => 'id',
-        "Name" => 'authority',
-        "Description" => 'description',
-        "Scope" => lambda {|it| it['scope'] },
-        "Type" => lambda {|it| format_role_type(it) },
-        "Multitenant" => lambda {|it| 
-          format_boolean(it['multitenant']).to_s + (it['multitenantLocked'] ? " (LOCKED)" : "")
-        },
-        "Owner" => lambda {|it| role['owner'] ? role['owner']['name'] : '' },
-        #"Account" => lambda {|it| it['account'] ? it['account']['name'] : '' },
-        "Created" => lambda {|it| format_local_dt(it['dateCreated']) },
-        "Updated" => lambda {|it| format_local_dt(it['lastUpdated']) }
-      }
-      print_description_list(description_cols, role)
+      columns = @is_master_account ? role_column_definitions : subtenant_role_column_definitions
+      print_description_list(columns, role, options)
 
       # print_h2 "Role Instance Limits", options
       # print cyan
@@ -310,13 +294,9 @@ class Morpheus::Cli::Roles
         # print "\n"
         # print cyan,bold,"Blueprint Access: #{get_access_string(json_response['globalAppTemplateAccess'])}",reset,"\n"
       end
-
       print reset,"\n"
-      return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
     end
+    return 0, nil
   end
 
   def list_permissions(args)
@@ -328,14 +308,9 @@ class Morpheus::Cli::Roles
                     "[role] is required. This is the name or id of a role."
     end
     optparse.parse!(args)
-
-    if args.count < 1
-      puts optparse
-      return 1
-    end
-
+    verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
-    begin
+    
       account = find_account_from_options(options)
       account_id = account ? account['id'] : nil
 
@@ -406,14 +381,10 @@ class Morpheus::Cli::Roles
 
       print reset,"\n"
       return 0
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
-    end
+    
   end
 
   def add(args)
-    usage = "Usage: morpheus roles add [options]"
     options = {}
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
@@ -519,7 +490,6 @@ class Morpheus::Cli::Roles
   end
 
   def update(args)
-    usage = "Usage: morpheus roles update [name] [options]"
     options = {}
     params = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
@@ -599,7 +569,6 @@ class Morpheus::Cli::Roles
   end
 
   def remove(args)
-    usage = "Usage: morpheus roles remove [name]"
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
       opts.banner = subcommand_usage("[name]")
@@ -1311,7 +1280,6 @@ class Morpheus::Cli::Roles
     ]
   end
 
-  "A Multitenant role is automatically copied into all existing subaccounts as well as placed into a subaccount when created. Useful for providing a set of predefined roles a Customer can use"
   def update_role_option_types
     add_role_option_types.reject {|it| ['roleType', 'baseRole'].include?(it['fieldName']) }
   end
@@ -1328,17 +1296,6 @@ class Morpheus::Cli::Roles
     end
   end
 
-
-  def load_whoami
-    whoami_response = @whoami_interface.get()
-    @current_user = whoami_response["user"]
-    if @current_user.empty?
-      print_red_alert "Unauthenticated. Please login."
-      exit 1
-    end
-    @is_master_account = whoami_response["isMasterAccount"]
-  end
-
   def role_type_options
     [{'name' => 'User Role', 'value' => 'user'}, {'name' => 'Account Role', 'value' => 'account'}]
   end