morpheus-cli 4.2.8 → 4.2.10

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

@@ -0,0 +1,255 @@
+require 'morpheus/cli/mixins/print_helper'
+
+# Mixin for Morpheus::Cli command classes
+# Provides common methods for fetching objects via /api/options/:optionSource
+# The including class must establish @options_interface or @api_client
+# This is useful for when the user does not need to have permission to other endpoints
+module Morpheus::Cli::OptionSourceHelper
+
+  def self.included(klass)
+    klass.send :include, Morpheus::Cli::PrintHelper
+  end
+
+  def options_interface
+    api_interface = @options_interface
+    api_interface = @api_client.options if api_interface.nil? && @api_client
+    # @api_client.options
+    raise "#{self.class} has not defined @options_interface or @api_client" if api_interface.nil?
+    api_interface
+  end
+
+   # todo: rewrite these specific methods to use the generic one.
+  
+  def get_available_user_options(refresh=false)
+    if !@available_user_options || refresh
+      option_results = options_interface.options_for_source('users',{})
+        @available_user_options = option_results['data'].collect {|it|
+          {"name" => it["name"], "value" => it["value"],
+            "username" => it["name"], "id" => it["value"]}
+        }
+    end
+    return @available_user_options
+  end
+
+  def find_available_user_option(name)
+    users = get_available_user_options().select {|it| 
+      name && (it['name'].to_s.downcase == name.to_s.downcase || it['value'].to_s == name.to_s) }
+    if users.empty?
+      print_red_alert "User not found by username or id '#{name}'"
+      return nil
+    elsif users.size > 1
+      print_red_alert "#{users.size} users found by username or id '#{name}'"
+      return nil
+    else
+      return users[0]
+    end
+  end
+
+
+  def get_group_options(refresh=false, api_params={})
+    if !@available_group_options || refresh
+      option_results = options_interface.options_for_source('groups', api_params)
+        @available_group_options = option_results['data'].collect {|it|
+          {"name" => it["name"], "value" => it["value"], "id" => it["value"]}
+        }
+    end
+    return @available_group_options
+  end
+
+  def find_group_option(group_id, refresh=false, api_params={})
+    if group_id.to_s.strip == ""
+      print_red_alert "Group not found by for blank id"
+      return nil
+    end
+    groups = get_group_options(refresh, api_params).select {|it| (it['name'].to_s == group_id.to_s || it['id'].to_s == group_id.to_s) }
+    if groups.empty?
+      print_red_alert "Group not found by '#{group_id}'"
+      return nil
+    elsif groups.size > 1
+      print_red_alert "#{groups.size} groups found by '#{group_id}'"
+      return nil
+    else
+      return groups[0]
+    end
+  end
+
+  def get_cloud_options(refresh=false, api_params={})
+    if !@available_cloud_options || refresh
+      option_results = options_interface.options_for_source('clouds', api_params)
+        @available_cloud_options = option_results['data'].collect {|it|
+          {"name" => it["name"], "value" => it["value"], "id" => it["value"]}
+        }
+    end
+    return @available_cloud_options
+  end
+
+  def find_cloud_option(cloud_id, refresh=false, api_params={})
+    if cloud_id.to_s.strip == ""
+      print_red_alert "Cloud not found by for blank id"
+      return nil
+    end
+    clouds = get_cloud_options(refresh, api_params).select {|it| (it['name'].to_s == cloud_id.to_s || it['id'].to_s == cloud_id.to_s) }
+    if clouds.empty?
+      print_red_alert "Cloud not found by '#{cloud_id}'"
+      return nil
+    elsif clouds.size > 1
+      print_red_alert "#{clouds.size} clouds found by '#{cloud_id}'"
+      return nil
+    else
+      return clouds[0]
+    end
+  end
+
+  def get_tenant_options(refresh=false, api_params={})
+    if !@available_tenant_options || refresh
+      # source should be 'tenants' or 'allTenants'
+      # allTenants includes the current tenant
+      # I think we should always use that so you can use your own id
+      option_source = 'allTenants'
+      option_results = options_interface.options_for_source(option_source, api_params)
+        @available_tenant_options = option_results['data'].collect {|it|
+          {"name" => it["name"], "value" => it["value"], "id" => it["value"]}
+        }
+    end
+    return @available_tenant_options
+  end
+
+  def find_tenant_option(tenant_id, refresh=false, api_params={})
+    tenant_id = tenant_id.to_s.strip
+    tenant_id_downcase = tenant_id.to_s.downcase
+    if tenant_id == ""
+      print_red_alert "Tenant not found by for blank id"
+      return nil
+    end
+    tenants = get_tenant_options(refresh, api_params).select {|it| (it['name'].to_s.downcase == tenant_id_downcase || it['id'].to_s == tenant_id.to_s) }
+    if tenants.empty?
+      print_red_alert "Tenant not found by '#{tenant_id}'"
+      return nil
+    elsif tenants.size > 1
+      print_red_alert "#{tenants.size} tenants found by '#{tenant_id}'"
+      return nil
+    else
+      return tenants[0]
+    end
+  end
+
+  # parse cloud names or IDs into a name, works with array or csv
+  # skips validation of ID for now, just worry about translating names/codes
+  # def parse_cloud_id_list(id_list)
+  #   cloud_ids = parse_id_list(id_list).collect {|cloud_id|
+  #     if cloud_id.to_s =~ /\A\d{1,}\Z/
+  #       cloud_id
+  #     else
+  #       cloud = find_cloud_option(cloud_id)
+  #       if cloud.nil?
+  #         # exit 1
+  #         return nil
+  #       end
+  #       cloud['id']
+  #     end
+  #   }
+  #   return cloud_ids
+  # end
+
+  # todo: some other common ones, accounts (tenants), etc.
+
+
+
+  # a generic set of parse and find methods for any option source data
+  def load_option_source_data(option_source, api_params={}, refresh=false, &block)
+    @_option_source_cache ||= {}
+    option_source_hash = "#{option_source}#{api_params.empty? ? '' : api_params.to_s}"
+    data = @_option_source_cache[option_source_hash]
+    if data.nil? || refresh
+      json_response = options_interface.options_for_source(option_source, api_params)
+      data = json_response['data'].collect {|it|
+        {
+          "name" => it["name"], 
+          "value" => it["value"], 
+          "id" => (it["id"] || it["value"]),
+          "code" => it["code"]
+        }
+      }
+      @_option_source_cache[option_source_hash] = data
+    end
+    return data
+  end
+
+  # todo: some other common ones, accounts (tenants), etc.
+  # todo: a generic set of parse and find methods like 
+  # like this:
+  def parse_option_source_id_list(option_source, id_list, api_params={}, refresh=false)
+    option_source_label = option_source.to_s # .capitalize
+    option_data = load_option_source_data(option_source, api_params, refresh)
+    found_ids = []
+    parse_id_list(id_list).each {|record_id|
+      lowercase_id = record_id.to_s.downcase
+      # need to parameterize this behavior
+      if record_id.to_s.empty?
+        # never match blank nil or empty strings
+        print_red_alert "#{option_source_label} cannot be not found by with a blank id!"
+        return nil
+      # elsif record_id.to_s =~ /\A\d{1,}\Z/
+      #   # always allow any ID for now..
+      #   found_ids << record_id
+      else
+        # search with in a presedence by value, then name, then id (usually same as value)
+        # exact match on value first.
+        matching_results = []
+        matching_results = option_data.select {|it| it['value'] && it['value'] == record_id }
+        # match on value case /i
+        if matching_results.empty?
+          matching_results = option_data.select {|it| it['value'] && it['value'].to_s.downcase == lowercase_id }
+        end
+        # match on name case /i
+        if matching_results.empty?
+          matching_results = option_data.select {|it| it['name'] && it['name'].to_s.downcase == lowercase_id } 
+        end
+        # match on id too, in case it is returned and different from value?
+        if matching_results.empty?
+          matching_results = option_data.select {|it| it['id'] && it['id'].to_s.downcase == lowercase_id } 
+        end
+        if matching_results.empty?
+          print_red_alert "No #{option_source_label} found matching name or id '#{record_id}'"
+          return nil
+        elsif matching_results.size > 1
+          print_red_alert "#{matching_results.size} #{option_source_label} found matching name '#{record_id}'. Try specifying the id instead."
+          return nil
+        else
+          matching_result = matching_results[0]
+          if matching_result['value']
+            found_ids << matching_result['value']
+          else
+            found_ids << matching_result['id']
+          end
+        end
+      end
+    }
+    return found_ids
+  end
+
+  def parse_cloud_id_list(id_list, api_params={}, refresh=false)
+    parse_option_source_id_list('clouds', id_list, api_params, refresh)
+  end
+
+  def parse_group_id_list(id_list, api_params={}, refresh=false)
+    parse_option_source_id_list('groups', id_list, api_params, refresh)
+  end
+
+  def parse_user_id_list(id_list, api_params={}, refresh=false)
+    parse_option_source_id_list('users', id_list, api_params, refresh)
+  end
+
+  def parse_tenant_id_list(id_list, api_params={}, refresh=false)
+    parse_option_source_id_list('allTenants', id_list, api_params, refresh)
+  end
+
+  # def parse_blueprints_id_list(id_list)
+  #   parse_option_source_id_list('blueprints', id_list, api_params, refresh)
+  # end
+
+  def parse_project_id_list(id_list, api_params={}, refresh=false)
+    parse_option_source_id_list('projects', id_list, api_params, refresh)
+  end
+
+end

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

@@ -38,13 +38,16 @@ module Morpheus::Cli::PrintHelper
   # puts red message to stderr
   # why this not stderr yet?  use print_error or if respond_to?(:my_terminal)
   def print_red_alert(msg)
-    #$stderr.print "#{red}#{msg}#{reset}\n"
-    print "#{red}#{msg}#{reset}\n"
+    $stderr.print "#{red}#{msg}#{reset}\n"
+    #print_error "#{red}#{msg}#{reset}\n"
     #puts_error "#{red}#{msg}#{reset}"
   end
 
   # puts green message to stdout
-  def print_green_success(msg)
+  def print_green_success(msg=nil)
+    if msg.nil?
+      msg = "success"
+    end
     print "#{green}#{msg}#{reset}\n"
   end
 
@@ -59,10 +62,21 @@ module Morpheus::Cli::PrintHelper
     # print_h1(title, options={})
     # print_h1(title, subtitles, options={})
     # this can go away when we have a dirty @current_options
+    
+    
+    # auto include remote name in h1 titles
+    # eg. Morpheus Instances [dev]
+    # if title && @appliance_name
+    #   title = "#{title} [#{@appliance_name}]"
+    # end
+    
     if subtitles.is_a?(Hash)
       options = subtitles
       subtitles = (options[:subtitles] || []).flatten
     end
+    if subtitles.is_a?(String)
+      subtitles = [subtitles]
+    end
     subtitles = (subtitles || []).flatten
     options ||= {}
     color = options[:color] || cyan
@@ -728,7 +742,7 @@ module Morpheus::Cli::PrintHelper
     # could use some options[:preferred_columns] logic here to throw away in some specified order
     # --all fields disables this
     trimmed_columns = []
-    if options[:responsive_table] != false # && options[:include_fields].nil? && options[:all_fields] != true
+    if options[:wrap] != true # && options[:include_fields].nil? && options[:all_fields] != true
 
       begin
         term_width = current_terminal_width()

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

@@ -17,6 +17,14 @@ module Morpheus::Cli::ProvisioningHelper
     @api_client.instances
   end
 
+  def apps_interface
+    @api_client.apps
+  end
+
+  def servers_interface
+    @api_client.servers
+  end
+
   def options_interface
     @api_client.options
   end
@@ -82,7 +90,10 @@ module Morpheus::Cli::ProvisioningHelper
 
   def get_available_accounts(refresh=false)
     if !@available_accounts || refresh
-      @available_accounts = accounts_interface.list()['accounts']
+      # @available_accounts = accounts_interface.list()['accounts']
+      @available_accounts = options_interface.options_for_source("allTenants", {})['data'].collect {|it|
+        {"name" => it["name"], "value" => it["value"], "id" => it["value"]}
+      }
     end
     @available_accounts
   end
@@ -242,6 +253,129 @@ module Morpheus::Cli::ProvisioningHelper
     return instance
   end
 
+  def parse_instance_id_list(id_list)
+    parse_id_list(id_list).collect do |instance_id|
+      find_instance_by_name_or_id(instance_id)['id']
+    end
+  end
+
+  ## apps
+
+  def find_app_by_id(id)
+    app_results = apps_interface.get(id.to_i)
+    if app_results['app'].empty?
+      print_red_alert "App not found by id #{id}"
+      exit 1
+    end
+    return app_results['app']
+  end
+
+  def find_app_by_name(name)
+    app_results = apps_interface.list({name: name})
+    apps = app_results['apps']
+    if apps.empty?
+      print_red_alert "App not found by name #{name}"
+      exit 1
+    elsif apps.size > 1
+      print_red_alert "#{apps.size} apps exist with the name #{name}. Try using id instead"
+      exit 1
+    end
+
+    return app_results['apps'][0]
+  end
+
+  def find_app_by_name_or_id(val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return find_app_by_id(val)
+    else
+      return find_app_by_name(val)
+    end
+  end
+
+  ## servers
+
+  def find_server_by_id(id)
+    begin
+      json_response = servers_interface.get(id.to_i)
+      return json_response['server']
+    rescue RestClient::Exception => e
+      if e.response && e.response.code == 404
+        print_red_alert "Server not found by id #{id}"
+        exit 1
+      else
+        raise e
+      end
+    end
+  end
+
+  def find_server_by_name(name)
+    results = servers_interface.list({name: name})
+    if results['servers'].empty?
+      print_red_alert "Server not found by name #{name}"
+      exit 1
+    elsif results['servers'].size > 1
+      print_red_alert "Multiple servers exist with the name #{name}. Try using id instead"
+      exit 1
+    end
+    return results['servers'][0]
+  end
+
+  def find_server_by_name_or_id(val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return find_server_by_id(val)
+    else
+      return find_server_by_name(val)
+    end
+  end
+
+  def parse_server_id_list(id_list)
+    parse_id_list(id_list).collect do |server_id|
+      find_server_by_name_or_id(server_id)['id']
+    end
+  end
+
+  ## hosts is the same as servers, just says 'Host' instead of 'Server'
+
+  def find_host_by_id(id)
+    begin
+      json_response = servers_interface.get(id.to_i)
+      return json_response['server']
+    rescue RestClient::Exception => e
+      if e.response && e.response.code == 404
+        print_red_alert "Host not found by id #{id}"
+        exit 1
+      else
+        raise e
+      end
+    end
+  end
+
+  def find_host_by_name(name)
+    results = servers_interface.list({name: name})
+    if results['servers'].empty?
+      print_red_alert "Host not found by name #{name}"
+      exit 1
+    elsif results['servers'].size > 1
+      print_red_alert "#{results['servers'].size} hosts exist with the name #{name}. Try using id instead"
+      exit 1
+    end
+    return results['servers'][0]
+  end
+
+  def find_host_by_name_or_id(val)
+    if val.to_s =~ /\A\d{1,}\Z/
+      return find_host_by_id(val)
+    else
+      return find_host_by_name(val)
+    end
+  end
+
+  def parse_host_id_list(id_list)
+    parse_id_list(id_list).collect do |host_id|
+      find_host_by_name_or_id(host_id)['id']
+    end
+  end
+
   def find_instance_type_layout_by_id(layout_id, id)
     json_results = instance_type_layouts_interface.get(layout_id, id)
     if json_results['instanceTypeLayout'].empty?
@@ -416,7 +550,7 @@ module Morpheus::Cli::ProvisioningHelper
       arbitrary_options.delete('cloud')
       arbitrary_options.delete('type')
       arbitrary_options.delete('name')
-      arbitrary_options.delete('version')
+      #arbitrary_options.delete('version')
       arbitrary_options.delete('layout')
       arbitrary_options.delete('servicePlan')
       arbitrary_options.delete('description')
@@ -470,6 +604,8 @@ module Morpheus::Cli::ProvisioningHelper
       layout_id = nil
       if options[:layout]
         layout_id = options[:layout]
+      # elsif options[:options]['layout']
+      #   layout_id = options[:options]['layout']
       end
       if layout_id.is_a?(Hash)
         layout_id = layout_id['id'] || layout_id['code'] || layout_id['name']
@@ -479,6 +615,8 @@ module Morpheus::Cli::ProvisioningHelper
         default_layout_value = nil
         if options[:version]
           version_value = options[:version]
+        elsif options[:options]['version']
+          version_value = options[:options]['version']
         else
           available_versions = options_interface.options_for_source('instanceVersions',{groupId: group_id, cloudId: cloud_id, instanceTypeId: instance_type['id']})['data']
           default_version_value = payload['instance']['version'] ? payload['instance']['version'] : payload['version']
@@ -581,8 +719,11 @@ module Morpheus::Cli::ProvisioningHelper
         end
       end
       #todo: consolidate these, instances api looks for instance.plan.id and apps looks for plan.id
-      payload['plan'] = {'id' => service_plan["id"], 'code' => service_plan["code"], 'name' => service_plan["name"]}
-      payload['instance']['plan'] = {'id' => service_plan["id"], 'code' => service_plan["code"], 'name' => service_plan["name"]}
+      if options[:for_app]
+        payload['plan'] = {'id' => service_plan["id"], 'code' => service_plan["code"], 'name' => service_plan["name"]}
+      else
+        payload['instance']['plan'] = {'id' => service_plan["id"], 'code' => service_plan["code"], 'name' => service_plan["name"]}
+      end
     end
 
     # build config option types
@@ -964,7 +1105,6 @@ module Morpheus::Cli::ProvisioningHelper
       default_datastore = datastore_options.find {|ds| ds['value'].to_s == volume['datastoreId'].to_s}
       v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldContext' => field_context, 'fieldName' => 'datastoreId', 'type' => 'select', 'fieldLabel' => 'Root Datastore', 'selectOptions' => datastore_options, 'required' => true, 'description' => 'Choose a datastore.', 'defaultValue' => default_datastore ? default_datastore['name'] : volume['datastoreId']}], options[:options])
       volume['datastoreId'] = v_prompt[field_context]['datastoreId']
-      volume['hasDatastore'] = true
     end
 
     volumes << volume
@@ -1029,7 +1169,6 @@ module Morpheus::Cli::ProvisioningHelper
           if !datastore_options.empty?
             v_prompt = Morpheus::Cli::OptionTypes.prompt([{'fieldContext' => field_context, 'fieldName' => 'datastoreId', 'type' => 'select', 'fieldLabel' => "Disk #{volume_index} Datastore", 'selectOptions' => datastore_options, 'required' => true, 'description' => 'Choose a datastore.', 'defaultValue' => volume['datastoreId']}], options[:options])
             volume['datastoreId'] = v_prompt[field_context]['datastoreId']
-            volume['hasDatastore'] = true
           end
 
           volumes << volume
@@ -1507,6 +1646,45 @@ module Morpheus::Cli::ProvisioningHelper
     return evars
   end
 
+  # Converts metadata tags array into a string like "name:value, foo:bar"
+  def format_metadata(tags)
+    if tags.nil? || tags.empty?
+      ""
+    elsif tags.instance_of?(Array)
+      tags.collect {|tag| "#{tag['name']}: #{tag['value']}" }.sort.join(", ")
+    elsif tags.instance_of?(Hash)
+      tags.collect {|k,v| "#{k}: #{v}" }.sort.join(", ")
+    else
+      tags.to_s
+    end
+  end
+
+  # Parses metadata tags object (string) into an array
+  def parse_metadata(val)
+    metadata = nil
+    if val
+      if val == "[]" || val == "null"
+        metadata = []
+      elsif val.is_a?(Array)
+        metadata = val
+      else
+        # parse string into format name:value, name:value
+        # merge IDs from current metadata
+        # todo: should allow quoted semicolons..
+        metadata_list = val.to_s.split(",").select {|it| !it.to_s.empty? }
+        metadata_list = metadata_list.collect do |it|
+          metadata_pair = it.include?(":") ? it.split(":") : it.split("=")
+          row = {}
+          row['name'] = metadata_pair[0].to_s.strip
+          row['value'] = metadata_pair[1].to_s.strip
+          row
+        end
+        metadata = metadata_list
+      end
+    end
+    return metadata
+  end
+
   # Prompts user for environment variables for new instance
   # returns array of metadata objects {id: null, name: "MYTAG", value: "myvalue"}
   def prompt_metadata(options={})
@@ -1712,8 +1890,12 @@ module Morpheus::Cli::ProvisioningHelper
       end
 
       if !options[:groupAccessList].empty?
-        group_access = options[:groupAccessList].collect {|site_id| {'id' => site_id.to_i}} || []
-      elsif !options[:no_prompt]
+        group_access = options[:groupAccessList].collect {|site_id| 
+          found_group = find_group_by_name_or_id_for_provisioning(site_id)
+          return 1, "group not found by #{site_id}" if found_group.nil?
+          {'id' => found_group['id']}
+        } || []
+      elsif !options[:no_prompt] && !all_groups
         available_groups = options[:available_groups] || get_available_groups
 
         if available_groups.empty?
@@ -1806,19 +1988,20 @@ module Morpheus::Cli::ProvisioningHelper
 
     permissions = {'resourcePermissions' => resource_perms}
 
-    available_accounts = get_available_accounts.collect {|it| {'name' => it['name'], 'value' => it['id']}}
+    available_accounts = get_available_accounts() #.collect {|it| {'name' => it['name'], 'value' => it['id']}}
     accounts = []
 
     # Prompts for multi tenant
     if available_accounts.count > 1
       visibility = options[:visibility]
+      if !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
 
-      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']
+        permissions['resourcePool'] = {'visibility' => visibility} if visibility
       end
 
-      permissions['resourcePool'] = {'visibility' => visibility} if visibility
-
       # Tenants
       if !excludes.include?('tenants')
         if !options[:tenants].nil?
@@ -1980,4 +2163,30 @@ module Morpheus::Cli::ProvisioningHelper
 
     return ports
   end
+
+  def format_blueprint_type(type_code)
+    return type_code.to_s # just show it as is
+    if type_code.to_s.empty?
+      type_code = "morpheus"
+    end
+    if type_code.to_s.downcase == "arm"
+      "ARM"
+    else
+      return type_code.to_s.capitalize
+    end
+  end
+
+  def parse_blueprint_type(type_code)
+    return type_code.to_s # just use it as is
+    # if type_code.to_s.empty?
+    #   type_code = "morpheus"
+    # end
+    if type_code.to_s.downcase == "arm"
+      "arm"
+    elsif type_code.to_s.downcase == "cloudformation"
+      type_code = "cloudFormation"
+    else
+      return type_code.to_s.downcase
+    end
+  end
 end