morpheus-cli 5.5.2.2 → 5.5.3.1

data/lib/morpheus/cli/errors.rb

@@ -14,7 +14,7 @@ module Morpheus::Cli
 
   end
 
-  # An error indicating the command was not recoginzed
+  # An error indicating the command was not recognized, assigned exit code 127
   class CommandNotFoundError < CommandError
     
     def initialize(msg, args=[], optparse=nil, exit_code=nil)
@@ -40,7 +40,14 @@ module Morpheus::Cli
     def initialize(msg, args=[], optparse=nil, exit_code=nil)
       super(msg, args, optparse, exit_code || 1)
     end
+  end
+
+  # An error indicating the user declined to accept a confirmation prompt, assigned exit code 9
+  class CommandAborted < CommandError
 
+    def initialize(msg, args=[], optparse=nil, exit_code=nil)
+      super(msg, args, optparse, exit_code || 9)
+    end
   end
 
 end

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

@@ -144,7 +144,7 @@ module Morpheus::Cli::PrintHelper
     data = {}
     begin
       data = JSON.parse(e.response.to_s)
-    rescue => ex
+    rescue
       # Morpheus::Logging::DarkPrinter.puts "Failed to parse error response as JSON: #{ex}" if Morpheus::Logging.debug?
     end
     return data
@@ -1329,19 +1329,19 @@ module Morpheus::Cli::PrintHelper
     outfile = nil
     begin
       full_filename = File.expand_path(filename)
-      if File.exists?(full_filename)
+      if File.exist?(full_filename)
         if !overwrite
           print "#{red}Output file '#{filename}' already exists.#{reset}\n"
           print "#{red}Use --overwrite to overwrite the existing file.#{reset}\n"
           return 1
         end
       end
-      if Dir.exists?(full_filename)
+      if Dir.exist?(full_filename)
         print "#{red}Output file '#{filename}' is invalid. It is the name of an existing directory.#{reset}\n"
         return 1
       end
       target_dir = File.dirname(full_filename)
-      if !Dir.exists?(target_dir)
+      if !Dir.exist?(target_dir)
         FileUtils.mkdir_p(target_dir)
       end
       outfile = File.open(full_filename, access_mode)
@@ -1362,19 +1362,19 @@ module Morpheus::Cli::PrintHelper
     outfile = nil
     begin
       full_filename = File.expand_path(filename)
-      if File.exists?(full_filename)
+      if File.exist?(full_filename)
         if !overwrite
           print "#{red}Output file '#{filename}' already exists.#{reset}\n"
           print "#{red}Use --overwrite to overwrite the existing file.#{reset}\n"
           return 1
         end
       end
-      if Dir.exists?(full_filename)
+      if Dir.exist?(full_filename)
         print "#{red}Output file '#{filename}' is invalid. It is the name of an existing directory.#{reset}\n"
         return 1
       end
       target_dir = File.dirname(full_filename)
-      if !Dir.exists?(target_dir)
+      if !Dir.exist?(target_dir)
         FileUtils.mkdir_p(target_dir)
       end
       outfile = File.open(full_filename, access_mode)
@@ -1402,13 +1402,17 @@ module Morpheus::Cli::PrintHelper
     end
   end
 
-  def format_percent(val, sig_dig=2)
+  def format_percent(val, sig_dig=2, hide_zero=false)
     if val.nil?
       return ""
     end
     percent_value = val.to_f
     if percent_value == 0
-      return "0%"
+      if hide_zero
+        ""
+      else
+        return "0%"
+      end
     else
       return percent_value.round(sig_dig).to_s + "%"
     end
@@ -1431,8 +1435,8 @@ module Morpheus::Cli::PrintHelper
 
   # convert JSON or YAML string to a map
   def parse_json_or_yaml(config, parsers = [:json, :yaml])
-    rtn = {success: false, data: nil, err: nil}
-    err = nil
+    rtn = {success: false, data: nil, error: nil}
+    error = nil
     config = config.strip
     if config[0..2] == "---"
       parsers = [:yaml]
@@ -1455,7 +1459,7 @@ module Morpheus::Cli::PrintHelper
           rtn[:success] = true
           break
         rescue => ex
-          rtn[:err] = ex if rtn[:err].nil?
+          rtn[:error] = ex if rtn[:error].nil?
         end
       elsif parser == :json
         begin
@@ -1464,7 +1468,7 @@ module Morpheus::Cli::PrintHelper
           rtn[:success] = true
           break
         rescue => ex
-          rtn[:err] = ex if rtn[:err].nil?
+          rtn[:error] = ex if rtn[:error].nil?
         end
       end
     end

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

@@ -1435,7 +1435,7 @@ module Morpheus::Cli::ProvisioningHelper
               'id' => current_volume['id'].to_i,
               'rootVolume' => false,
               'name' => current_volume['name'],
-              'size' => current_volume['size'] > (plan_size || 0) ? current_volume['size'] : plan_size,
+              'size' => current_volume['size'] ? current_volume['size'] : (plan_size || 0),
               'sizeId' => nil,
               'storageType' => (current_volume['type'] || current_volume['storageType']),
               'datastoreId' => current_volume['datastoreId']
@@ -2003,9 +2003,10 @@ module Morpheus::Cli::ProvisioningHelper
     group_access = nil
     all_plans = nil
     plan_access = nil
+    permissions = {}
 
     # Group Access
-    if !excludes.include?('groups')
+    unless excludes.include?('groups')
       if !options[:groupAccessAll].nil?
         all_groups = options[:groupAccessAll]
       end
@@ -2055,7 +2056,7 @@ module Morpheus::Cli::ProvisioningHelper
     end
 
     # Plan Access
-    if !excludes.include?('plans')
+    unless excludes.include?('plans')
       if !options[:planAccessAll].nil?
         all_plans = options[:planAccessAll]
       end
@@ -2101,13 +2102,14 @@ module Morpheus::Cli::ProvisioningHelper
       end
     end
 
-    resource_perms = {}
-    resource_perms['all'] = all_groups if !all_groups.nil?
-    resource_perms['sites'] = group_access if !group_access.nil?
-    resource_perms['allPlans'] = all_plans if !all_plans.nil?
-    resource_perms['plans'] = plan_access if !plan_access.nil?
-
-    permissions = {'resourcePermissions' => resource_perms}
+    unless excludes.include?('resource')
+      resource_perms = {}
+      resource_perms['all'] = all_groups if !all_groups.nil?
+      resource_perms['sites'] = group_access if !group_access.nil?
+      resource_perms['allPlans'] = all_plans if !all_plans.nil?
+      resource_perms['plans'] = plan_access if !plan_access.nil?
+      permissions['resourcePermissions'] = resource_perms
+    end
 
     available_accounts = get_available_accounts() #.collect {|it| {'name' => it['name'], 'value' => it['id']}}
     accounts = []
@@ -2115,7 +2117,7 @@ module Morpheus::Cli::ProvisioningHelper
     # Prompts for multi tenant
     if available_accounts.count > 1
       visibility = options[:visibility]
-      if !excludes.include?('visibility')
+      unless excludes.include?('visibility')
         if !visibility && !options[:no_prompt]
           visibility = Morpheus::Cli::OptionTypes.prompt([{'fieldName' => 'visibility', 'fieldLabel' => 'Tenant Permissions Visibility', 'type' => 'select', 'defaultValue' => 'private', 'required' => true, 'selectOptions' => [{'name' => 'Private', 'value' => 'private'},{'name' => 'Public', 'value' => 'public'}]}], options[:options], @api_client, {})['visibility']
         end
@@ -2123,7 +2125,7 @@ module Morpheus::Cli::ProvisioningHelper
       end
 
       # Tenants
-      if !excludes.include?('tenants')
+      unless excludes.include?('tenants')
         if !options[:tenants].nil?
           accounts = options[:tenants].collect {|id| id.to_i}
         elsif !options[:no_prompt]

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

@@ -43,7 +43,7 @@ module Morpheus::Cli::RestCommand
     # It is used to derive all other default rest settings key, label, etc.  
     # The default name the command name with underscores `_` instead of dashes `-`.
     def rest_name
-      @rest_name || default_rest_name
+      defined?(@rest_name) ? @rest_name : default_rest_name
     end
 
     def default_rest_name
@@ -58,7 +58,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_key is the singular name of the resource eg. "neat_thing"
     def rest_key
-      @rest_key || default_rest_key
+      defined?(@rest_key) ? @rest_key : default_rest_key
     end
 
     def default_rest_key
@@ -73,7 +73,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_arg is a label for the arg in the command usage eg. "thing" gets displayed as [thing]
     def rest_arg
-      @rest_arg || default_rest_arg
+      defined?(@rest_arg) ? @rest_arg : default_rest_arg
     end
 
     def default_rest_arg
@@ -89,7 +89,7 @@ module Morpheus::Cli::RestCommand
     # rest_has_name indicates a resource has a name and can be retrieved by name or id
     # true by default, set to false for lookups by only id
     def rest_has_name
-      @rest_has_name != nil ? @rest_has_name :  default_rest_has_name
+      defined?(@rest_has_name) ? @rest_has_name :  default_rest_has_name
     end
 
     def default_rest_has_name
@@ -104,7 +104,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_label is the capitalized resource label eg. "Neat Thing"    
     def rest_label
-      @rest_label || default_rest_label
+      defined?(@rest_label) ? @rest_label : default_rest_label
     end
 
     def default_rest_label
@@ -119,7 +119,7 @@ module Morpheus::Cli::RestCommand
 
     # the plural version of the label eg. "Neat Things"
     def rest_label_plural
-      @rest_label_plural || default_rest_label_plural
+      defined?(@rest_label_plural) ? @rest_label_plural : default_rest_label_plural
     end
     
     def default_rest_label_plural
@@ -135,7 +135,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_interface_name is the interface name for the resource. eg. "neat_things"
     def rest_interface_name
-      @rest_interface_name || default_rest_interface_name
+      defined?(@rest_interface_name) ? @rest_interface_name : default_rest_interface_name
     end
 
     def default_rest_interface_name
@@ -150,7 +150,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_perms_config enables and configures permissions prompt
     def rest_perms_config
-      @rest_perms_config || {}
+      defined?(@rest_perms_config) ? @rest_perms_config : {}
     end
 
     def rest_perms_config=(v)
@@ -161,7 +161,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_option_context_map specifies context mapping during option prompt. default is domain => ''
     def rest_option_context_map
-      @option_context_map || {'domain' => ''}
+      defined?(@option_context_map) ? @option_context_map : {'domain' => ''}
     end
 
     def rest_option_context_map=(v)
@@ -172,7 +172,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_has_type indicates a resource has a type. default is false
     def rest_has_type
-      @rest_has_type == true
+      defined?(@rest_has_type) && @rest_has_type
     end
 
     def default_rest_has_type
@@ -189,7 +189,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_type_name is the rest_name for the type, only applicable if rest_has_type
     def rest_type_name
-      @rest_type_name || default_rest_type_name
+      defined?(@rest_type_name) ? @rest_type_name : default_rest_type_name
     end
 
     def default_rest_type_name
@@ -206,7 +206,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_type_key is the singular name of the resource eg. "neat_thing"
     def rest_type_key
-      @rest_type_key || default_rest_type_key
+      defined?(@rest_type_key) ? @rest_type_key : default_rest_type_key
     end
 
     def default_rest_type_key
@@ -220,7 +220,7 @@ module Morpheus::Cli::RestCommand
     alias :set_rest_type_key :rest_type_key=
 
     def rest_type_arg
-      @rest_type_arg || default_rest_type_arg
+      defined?(@rest_type_arg) ? @rest_type_arg : default_rest_type_arg
     end
 
     def default_rest_type_arg
@@ -236,7 +236,7 @@ module Morpheus::Cli::RestCommand
 
     # rest_type_label is the capitalized resource label eg. "Neat Thing"    
     def rest_type_label
-      @rest_type_label || default_rest_type_label
+      defined?(@rest_type_label) ? @rest_type_label : default_rest_type_label
     end
 
     def default_rest_type_label
@@ -251,7 +251,7 @@ module Morpheus::Cli::RestCommand
 
     # the plural version of the label eg. "Neat Things"
     def rest_type_label_plural
-      @rest_type_label_plural || default_rest_type_label_plural
+      defined?(@rest_type_label_plural) ? @rest_type_label_plural : default_rest_type_label_plural
     end
     
     def default_rest_type_label_plural
@@ -267,7 +267,7 @@ module Morpheus::Cli::RestCommand
 
     # the name of the default interface, matches the rest name eg. "neat_things"
     def rest_type_interface_name
-      @rest_type_interface_name || default_rest_type_interface_name
+      defined?(@rest_type_interface_name) ? @rest_type_interface_name : default_rest_type_interface_name
     end
 
     def default_rest_type_interface_name
@@ -720,9 +720,13 @@ EOT
         else
           perms = prompt_permissions(options.deep_merge(rest_perms_config[:options] || {}), rest_perms_config[:excludes] || [])
         end
-        if !rest_perms_config[:name].nil?
+        unless rest_perms_config[:name].nil?
           perms.transform_keys! {|k| k == 'resourcePermissions' ? rest_perms_config[:name] : k}
         end
+        unless rest_perms_config[:context].nil?
+          perms_context = {}
+          perms_context[rest_perms_config[:context]] = perms
+        end
         record_payload.merge!(perms)
       end
       payload[rest_object_key] = record_payload
@@ -742,7 +746,6 @@ EOT
   end
 
   def update(args)
-    id = args[0]
     record_type = nil
     record_type_id = nil
     options = {}
@@ -762,6 +765,7 @@ EOT
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
+    id = args[0]
     record = rest_find_by_name_or_id(id)
     if record.nil?
       return 1, "#{rest_name} not found for '#{id}'"
@@ -857,7 +861,6 @@ EOT
   end
 
   def remove(args)
-    id = args[0]
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
@@ -872,6 +875,7 @@ EOT
     verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
     params.merge!(parse_query_options(options))
+    id = args[0]
     record = rest_find_by_name_or_id(id)
     if record.nil?
       return 1, "#{rest_name} not found for '#{id}'"

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

@@ -33,7 +33,7 @@ module Morpheus::Cli::SecondaryRestCommand
 
     # rest_parent_name is the rest_name for the parent
     def rest_parent_name
-      @rest_parent_name || default_rest_parent_name
+      defined?(@rest_parent_name) ? @rest_parent_name : default_rest_parent_name
     end
 
     def default_rest_parent_name
@@ -58,7 +58,7 @@ module Morpheus::Cli::SecondaryRestCommand
 
     # rest_parent_key is the singular name of the resource eg. "neat_thing"
     def rest_parent_key
-      @rest_parent_key || default_rest_parent_key
+      defined?(@rest_parent_key) ? @rest_parent_key : default_rest_parent_key
     end
 
     def default_rest_parent_key
@@ -72,7 +72,7 @@ module Morpheus::Cli::SecondaryRestCommand
     alias :set_rest_parent_key :rest_parent_key=
 
     def rest_parent_arg
-      @rest_parent_arg || default_rest_parent_arg
+      defined?(@rest_parent_arg) ? @rest_parent_arg : default_rest_parent_arg
     end
 
     def default_rest_parent_arg
@@ -86,7 +86,7 @@ module Morpheus::Cli::SecondaryRestCommand
     alias :set_rest_parent_arg :rest_parent_arg=
 
     def rest_parent_param
-      @rest_parent_param || default_rest_parent_param
+      defined?(@rest_parent_param) ? @rest_parent_param : default_rest_parent_param
     end
 
     def default_rest_parent_param
@@ -103,7 +103,7 @@ module Morpheus::Cli::SecondaryRestCommand
     # rest_parent_has_name indicates a resource has a name and can be retrieved by name or id
     # true by default, set to false for lookups by only id
     def rest_parent_has_name
-      @rest_parent_has_name != nil ? @rest_parent_has_name :  default_rest_parent_has_name
+      defined?(@rest_parent_has_name) ? @rest_parent_has_name : default_rest_parent_has_name
     end
 
     def default_rest_parent_has_name
@@ -118,7 +118,7 @@ module Morpheus::Cli::SecondaryRestCommand
 
     # rest_parent_label is the capitalized resource label eg. "Neat Thing"    
     def rest_parent_label
-      @rest_parent_label || default_rest_parent_label
+      defined?(@rest_parent_label) ? @rest_parent_label : default_rest_parent_label
     end
 
     def default_rest_parent_label
@@ -133,7 +133,7 @@ module Morpheus::Cli::SecondaryRestCommand
 
     # the plural version of the label eg. "Neat Things"
     def rest_parent_label_plural
-      @rest_parent_label_plural || default_rest_parent_label_plural
+      defined?(@rest_parent_label_plural) ? @rest_parent_label_plural : default_rest_parent_label_plural
     end
     
     def default_rest_parent_label_plural
@@ -149,7 +149,7 @@ module Morpheus::Cli::SecondaryRestCommand
 
     # the name of the default interface, matches the rest name eg. "neat_things"
     def rest_parent_interface_name
-      @rest_parent_interface_name || default_rest_parent_interface_name
+      defined?(@rest_parent_interface_name) ? @rest_parent_interface_name : default_rest_parent_interface_name
     end
 
     def default_rest_parent_interface_name
@@ -294,7 +294,7 @@ EOT
       if records.nil? || records.empty?
         print cyan,"No #{rest_label_plural.downcase} found.",reset,"\n"
       else
-        print as_pretty_table(records, rest_list_column_definitions(options).upcase_keys!, options)
+        print as_pretty_table(records, rest_list_column_definitions(options.merge({:parent_record => parent_record})).upcase_keys!, options)
         print_results_pagination(json_response) if json_response['meta']
       end
       print reset,"\n"
@@ -318,17 +318,15 @@ EOT
     verify_args!(args:args, optparse:optparse, min:2)
     connect(options)
     parse_get_options!(args.count > 1 ? args[1..-1] : [], options, params)
-    parent_id = args[0]
+    _get(args[0], args[1..-1].join(" "), params, options)
+  end
+
+  def _get(parent_id, id, params, options)
     parent_record = rest_parent_find_by_name_or_id(parent_id)
     if parent_record.nil?
       return 1, "#{rest_parent_label} not found for '#{parent_id}"
     end
     parent_id = parent_record['id']
-    id = args[1..-1].join(" ")
-    _get(parent_id, id, params, options)
-  end
-
-  def _get(parent_id, id, params, options)
     if id !~ /\A\d{1,}\Z/
       record = rest_find_by_name_or_id(parent_id, id)
       if record.nil?
@@ -342,7 +340,7 @@ EOT
       return
     end
     json_response = rest_interface.get(parent_id, id, params)
-    render_response_for_get(json_response, options)
+    render_response_for_get(json_response, options.merge({:parent_record => parent_record}))
     return 0, nil
   end
 
@@ -357,14 +355,19 @@ EOT
         print_h2 "Option Types", options
         print format_option_types_table(record['optionTypes'], options, rest_object_key)
       end
+      render_response_details_for_get(record, options)
       print reset,"\n"
     end
   end
 
+  def render_response_details_for_get(record, options)
+    # override for custom details
+  end
+
   def add(args)
     parent_id, parent_record = nil, nil
     record_type_id = nil
-    options = {}
+    options = {:options => {:context_map => rest_option_context_map}}
     option_types = respond_to?("add_#{rest_key}_option_types", true) ? send("add_#{rest_key}_option_types") : []
     advanced_option_types = respond_to?("add_#{rest_key}_advanced_option_types", true) ? send("add_#{rest_key}_advanced_option_types") : []
     type_option_type = option_types.find {|it| it['fieldName'] == 'type'} 
@@ -473,7 +476,7 @@ EOT
       end
       if my_option_types && !my_option_types.empty?
         # remove redundant fieldContext
-        my_option_types.each do |option_type| 
+        my_option_types.each do |option_type|
           if option_type['fieldContext'] == rest_object_key
             option_type['fieldContext'] = nil
           end
@@ -491,6 +494,26 @@ EOT
         v_prompt.booleanize! # 'on' => true
         record_payload.deep_merge!(v_prompt)
       end
+      if respond_to?("#{rest_key}_add_prompt", true)
+        record_payload = send("#{rest_key}_add_prompt", record_payload, record_type, parent_record, options)
+      end
+      # permissions
+      if rest_perms_config[:enabled]
+        if rest_perms_config[:version] == 2
+          perms = prompt_permissions_v2(options.deep_merge(rest_perms_config[:options] || {}), rest_perms_config[:excludes] || [])
+        else
+          perms = prompt_permissions(options.deep_merge(rest_perms_config[:options] || {}), rest_perms_config[:excludes] || [])
+        end
+        unless rest_perms_config[:name].nil?
+          perms.transform_keys! {|k| k == 'resourcePermissions' ? rest_perms_config[:name] : k}
+        end
+        unless rest_perms_config[:context].nil?
+          perms_context = {}
+          perms_context[rest_perms_config[:context]] = perms
+          perms = perms_context
+        end
+        record_payload.merge!(perms)
+      end
       payload[rest_object_key] = record_payload
     end
     rest_interface.setopts(options)
@@ -502,8 +525,8 @@ EOT
     if json_response['success']
       render_response(json_response, options, rest_object_key) do
         record = json_response[rest_object_key]
-        print_green_success "Added #{rest_label.downcase} #{record['name'] || record['id']}"
-        return _get(parent_id, record["id"], {}, options)
+        print_green_success "Added #{rest_label.downcase} #{record.nil? ? json_response['id'] : record['name'] || record['id']}"
+        return _get(parent_id, record.nil? ? json_response['id'] : record['id'], {}, options)
       end
     else
       print red
@@ -514,8 +537,6 @@ EOT
   end
 
   def update(args)
-    parent_id = args[0]
-    id = args[1]
     record_type = nil
     record_type_id = nil
     options = {}
@@ -533,6 +554,8 @@ EOT
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, count:2)
     connect(options)
+    parent_id = args[0]
+    id = args[1]
     parent_record = rest_parent_find_by_name_or_id(parent_id)
     if parent_record.nil?
       return 1, "#{rest_parent_label} not found for '#{parent_id}"
@@ -633,8 +656,6 @@ EOT
   end
 
   def remove(args)
-    parent_id = args[0]
-    id = args[1]
     params = {}
     options = {}
     optparse = Morpheus::Cli::OptionParser.new do |opts|
@@ -649,6 +670,8 @@ EOT
     optparse.parse!(args)
     verify_args!(args:args, optparse:optparse, count:2)
     connect(options)
+    parent_id = args[0]
+    id = args[1]
     parent_record = rest_parent_find_by_name_or_id(parent_id)
     if parent_record.nil?
       return 1, "#{rest_parent_label} not found for '#{parent_id}"

data/lib/morpheus/cli/option_parser.rb

@@ -43,7 +43,7 @@ module Morpheus
             my_summaries.each do |full_line|
               opt_description = full_line.to_s.strip
               if opt_description.start_with?("-")
-                is_hidden = (@hidden_options || []).find { |hidden_switch|
+                is_hidden = (hidden_options || []).find { |hidden_switch|
                   if hidden_switch.start_with?("-")
                     opt_description.start_with?("#{hidden_switch} ")
                   else
@@ -74,6 +74,10 @@ module Morpheus
         out
       end
 
+      def hidden_options
+        @hidden_options ||= []
+      end
+
       def add_hidden_option(opt_name)
         opt_array = [opt_name].flatten.compact
         @hidden_options ||= []