morpheus-cli 5.3.4 → 5.4.3

data/lib/morpheus/cli/cli_command.rb

@@ -1,15 +1,14 @@
-require 'yaml'
-require 'json'
-require 'fileutils'
 require 'morpheus/logging'
 require 'morpheus/benchmarking'
-require 'morpheus/cli/option_parser'
+require 'morpheus/terminal'
 require 'morpheus/cli/cli_registry'
+require 'morpheus/cli/option_parser'
+require 'morpheus/cli/option_types'
 require 'morpheus/cli/mixins/print_helper'
 require 'morpheus/cli/credentials'
+#require 'morpheus/cli/commands/shell'
+#require 'morpheus/cli/commands/remote'
 require 'morpheus/api/api_client'
-require 'morpheus/cli/remote'
-require 'morpheus/terminal'
 
 module Morpheus
   module Cli
@@ -1012,7 +1011,7 @@ module Morpheus
         # meh, could deprecate and make subcommand define handle() itself
         # if args.count == 0 && default_subcommand
         #   # p "using default subcommand #{default_subcommand}"
-        #   return self.send(default_subcommand, args || [])
+        #   return send(default_subcommand, args || [])
         # end
         subcommand_name = args[0]
         if args.empty?
@@ -1033,7 +1032,7 @@ module Morpheus
           error_msg = "'#{command_name} #{subcommand_name}' is not a #{prog_name} command.\n#{full_command_usage}"
           raise CommandNotFoundError.new(error_msg)
         end
-        self.send(cmd_method, args[1..-1])
+        send(cmd_method, args[1..-1])
       end
 
       def handle(args)
@@ -1231,6 +1230,72 @@ module Morpheus
         true
       end
 
+      # The default way to build options for the list command
+      # @param [OptionParser] opts
+      # @param [Hash] options
+      # @param [Hash] params
+      def build_list_options(opts, options, params)
+        build_standard_list_options(opts, options)
+      end
+
+      # The default way to parse options for the list command
+      # @param [Array] args
+      # @param [Hash] options
+      # @param [Hash] params
+      def parse_list_options!(args, options, params)
+        if args.count > 0
+          options[:phrase] = args.join(" ")
+          # params['phrase'] =  = args.join(" ")
+        end
+        params.merge!(parse_list_options(options))
+      end
+
+      # The default way to build options for the list command
+      # @param [OptionParser] opts
+      # @param [Hash] options
+      # @param [Hash] params
+      def build_get_options(opts, options, params)
+        build_standard_get_options(opts, options)
+      end
+      
+      # The default way to parse options for the get command
+      # @param [OptionParser] opts
+      # @param [Hash] options
+      # @param [Hash] params
+      def parse_get_options!(args, options, params)
+        params.merge!(parse_query_options(options))
+      end
+
+      # The default way to parse options for the get command
+      # @param type [string]
+      # @param options [Hash] The command options
+      # @param params [Hash] The query parameters the output is being appended to
+      # @param param_name [String]
+      # @param lookup_ids [Boolean] Also lookup ids to make sure they exist or else error
+      # @return 
+      def parse_parameter_as_resource_id!(type, options, params, param_name=nil, lookup_ids=false)
+        # type = type.to_s.singularize
+        if options.key?(type)
+          val = options[type].to_s
+          param_name ||= "#{type.to_s.camelcase}Id"
+          if val
+            if val.to_s !~ /\A\d{1,}\Z/ || lookup_ids
+              record = find_by_name(type, val)
+              if record.nil?
+                 # avoid double error render by exiting here, ew
+                exit 1
+                raise_command_error "Storage Server not found for '#{val}'"
+              end
+              params[param_name] = record['id']
+            else
+              params[param_name] = val
+            end
+            return params[param_name]
+          end
+        end
+        return nil
+      end
+
       # parse the parameters provided by the common :list options
       # this includes the :query options too via parse_query_options().
       # returns Hash of params the format {"phrase": => "foobar", "max": 100}
@@ -1245,7 +1310,11 @@ module Morpheus
         end
         # arbitrary filters
         list_params.merge!(parse_query_options(options))
-        
+        # ok, any string keys in options can become query parameters, eg. options['name'] = 'foobar'
+        # do it!
+        # options.each do |k, v|
+        #   list_params[k] = v
+        # end
         return list_params
       end
 
@@ -1366,7 +1435,7 @@ module Morpheus
           full_outfile = File.expand_path(options[:outfile])
           if output
             print_to_file(output, options[:outfile], options[:overwrite])
-            print "#{cyan}Wrote output to file #{options[:outfile]} (#{File.size(full_outfile)} B)\n" unless options[:quiet]
+            print "#{cyan}Wrote output to file #{options[:outfile]} (#{format_bytes(File.size(full_outfile))})\n" unless options[:quiet]
           else
             # uhhh ok lets try this
             Morpheus::Logging::DarkPrinter.puts "using experimental feature: --out without a common format like json, yml or csv" if Morpheus::Logging.debug?
@@ -1374,7 +1443,7 @@ module Morpheus
             if result && result != 0
               return result
             end
-            print "#{cyan}Wrote output to file #{options[:outfile]} (#{File.size(full_outfile)} B)\n" unless options[:quiet]
+            print "#{cyan}Wrote output to file #{options[:outfile]} (#{format_bytes(File.size(full_outfile))})\n" unless options[:quiet]
             return 0, nil
           end
         else
@@ -1405,6 +1474,184 @@ module Morpheus
 
       alias :render_with_format :render_response
 
+      # Dynamic find methods to load a record of any type
+      # def find_by_name_or_id(type, val)
+      #   interface = instance_variable_get "@#{type}s_interface"
+      #   typeCamelCase = type.gsub(/(?:^|_)([a-z])/) do $1.upcase end
+      #   typeCamelCase = typeCamelCase[0, 1].downcase + typeCamelCase[1..-1]
+      #   (val.to_s =~ /\A\d{1,}\Z/) ? interface.get(val.to_i)[typeCamelCase] : interface.list({'name' => val})["#{typeCamelCase}s"].first
+      # end
+
+      # Find a resource by type and name or id
+      # @param type [String of Symbol] Type of resource formatted as singular, lowerscore with underscores.
+      # @param *id [String or Numeric] ID of resource, multiple arguments may be passed when using a secondary interface where parent_id, id is required.
+      # Example: find_by_name_or_id("instance", "K2")
+      #          find_by_name_or_id("storage_volume", 42)
+      #          find_by_name_or_id("instance", "My Instance")
+      #          find_by_name_or_id("load_balancer_pool", load_balancer_id, id)
+      def find_by_name_or_id(*args)
+        val = args.last
+        if val.to_s =~ /\A\d{1,}\Z/
+          return find_by_id(*args)
+        else
+          return find_by_name(*args)
+        end
+      end
+
+      
+      # Find a resource by type and id
+      # Usage: find_by_name_or_id("app", 3)
+      def find_by_id(*args)
+        #Morpheus::Logging::DarkPrinter.puts "find_by_id(#{args.join(', ')})" if Morpheus::Logging.debug?
+        # type, ids = args.first, args[1..-1]
+        type, *ids = args
+        type = type.to_s.singularize.underscore
+        # still relying on the command or helper to define these _label and _key methods
+        label = send("#{type}_label")
+        object_key = send("#{type}_object_key")
+        interface_name = "@#{type.pluralize}_interface"
+        interface = instance_variable_get(interface_name)
+        if interface.nil?
+          raise "#{self.class} has not defined interface #{interface_name}"
+        end
+        begin
+          json_response = interface.get(*ids)
+          return json_response[object_key]
+        rescue Exception => e
+          if e.response && e.response.code == 404
+            print_red_alert "#{label} not found by id #{ids.last}"
+            return nil
+          else
+            raise e
+          end
+        end
+      end
+
+      # Find a record by type and name
+      # Usage: find_by_name_or_id("network", "Skynet")
+      def find_by_name(*args)
+        #Morpheus::Logging::DarkPrinter.puts "find_by_name(#{args.join(', ')})" if Morpheus::Logging.debug?
+        # type, ids = args.first, args[1..-1]
+        type, *ids = args
+        type = type.to_s.singularize.underscore
+        val = ids.pop
+        params = {}
+        name_property = 'name'
+        if type == 'user'
+          name_property = 'username'
+          params['global'] = 'true'
+        end
+        params[name_property] = val.to_s
+        request_args = ids + [params]
+        request_args.unshift(type)
+        records = find_all(*request_args)
+        # still relying on the command or helper to define these _label and _key methods
+        label = respond_to?("#{type}_label", true) ? send("#{type}_label") : type.titleize
+        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_property} '#{val}'"
+          print_error "\n"
+          if type == "user"
+            puts_error as_pretty_table(records, [:id, :username, {"FIRST NAME" => "firstName"}, {"LAST NAME" => "lastName"}, {"TENANT" => lambda {|it| it['account']['name'] rescue ''}}], {color:red})
+          else
+            puts_error as_pretty_table(records, [:id, :name], {color:red})
+          end
+          print_red_alert "Try using ID instead"
+          print_error reset,"\n"
+          return nil
+        else
+          return records[0]
+        end
+      end
+
+      # Load a list of records by type
+      # @example Find an app by id
+      # find_record(:app, 1)
+      # report_types = find_all("reportTypes", {phrase:"amazon"})
+      # pools = find_all("loadBalancerPool", load_balancer_id)
+      # @return Array of records
+      def find_all(*args)
+        #Morpheus::Logging::DarkPrinter.puts "find_all(#{args.join(', ')})" if Morpheus::Logging.debug?
+        type, *request_args = args
+        type = type.to_s.singularize.underscore
+        list_key = respond_to?("#{type}_list_key", true) ? send("#{type}_list_key") : type.camelcase.pluralize
+        json_response = find_all_json(*args)
+        if !json_response.key?(list_key)
+          # maybe just use the first key like this:
+          # list_key = json_response.keys.find { |k| json_response[k].is_a?(Array) }
+          # print_error(json_response) if Morpheus::Logging.debug?
+          raise "API response is missing list property '#{list_key}'"
+        end
+        return json_response[list_key]
+      end
+
+      # Load json response for a list of records by type
+      # @return Hash of JSON data
+      def find_all_json(*args)
+        type, *request_args = args
+        get_interface(type).list(*request_args)
+      end
+
+      alias :find_all_records :find_all
+      alias :find_all_records_json :find_all_json
+
+      # Load a single record (Hash) by type and id and optional parameters
+      # Examples:
+      # apps = find_record(:app)
+      # report_types = find_record("reportTypes", {phrase:"amazon"})
+      # pools = find_record("loadBalancerPool", balancer_id)
+      # @return [Hash] of the object that was found or raises an exception if 404 not found encountered.
+      def find_record(*args)
+        #Morpheus::Logging::DarkPrinter.puts "find_record(#{args.join(', ')})" if Morpheus::Logging.debug?
+        type, *request_args = args
+        type = type.to_s.singularize.underscore
+        object_key = respond_to?("#{type}_object_key", true) ? send("#{type}_object_key") : type.camelcase.singularize
+        json_response = find_record_json(*args)
+        if !json_response.key?(object_key)
+          # maybe just use the first key like this:
+          # object_key = json_response.keys.find { |k| json_response[k].is_a?(Hash) }
+          # print_error(json_response) if Morpheus::Logging.debug?
+          raise "API response is missing object property '#{object_key}'"
+        end
+        return json_response[object_key]
+      end
+
+      # Load list of records by type and (optional) parameters
+      # Examples:
+      # apps = find_record(:app, 1)
+      # report_types = find_record("reportType", 1)
+      # pools = find_all("loadBalancerPool", load_balancer_id)
+      def find_record_json(*args)
+        #Morpheus::Logging::DarkPrinter.puts "find_record_json(#{args.join(', ')})" if Morpheus::Logging.debug?
+        type, *request_args = args
+        get_interface(type).get(*request_args)
+      end
+
+       # Load json response for a list of records by type
+      def get_interface(type)
+        #Morpheus::Logging::DarkPrinter.puts "get_interface(#{type})" if Morpheus::Logging.debug?
+        # todo: can probably just do @api_client ? @api_client.interface(interface_name) : nil
+        type = type.to_s.singularize.underscore
+        interface_name = "@#{type.pluralize}_interface"
+        interface = nil
+        if instance_variable_defined?(interface_name)
+          interface = instance_variable_get(interface_name)
+          if interface.nil?
+            # Fix is to update connect() to do @apps_interface = @api_client.apps
+            raise "API Interface #{interface_name} is nil"
+          end
+        else
+          if @api_client.is_a?(Morpheus::APIClient)
+            interface = @api_client.interface(type.pluralize)
+          else
+            raise "#{self.class} has not initalized @api_client"
+          end
+        end
+        return interface
+      end
+
       module ClassMethods
 
         def prog_name
@@ -1412,14 +1659,14 @@ module Morpheus
         end
 
         def set_command_name(cmd_name)
-          @command_name = cmd_name
+          @command_name = cmd_name.to_sym
           Morpheus::Cli::CliRegistry.add(self, self.command_name)
         end
 
         def default_command_name
           class_name = self.name.split('::')[-1]
           #class_name.sub!(/Command$/, '')
-          Morpheus::Cli::CliRegistry.cli_ize(class_name)
+          Morpheus::Cli::CliRegistry.cli_ize(class_name).to_sym
         end
         
         def command_name

data/lib/morpheus/cli/cli_registry.rb

@@ -4,6 +4,7 @@ require 'morpheus/logging'
 require 'morpheus/cli/errors'
 require 'morpheus/cli/error_handler'
 require 'morpheus/cli/expression_parser'
+require 'morpheus/ext/string'
 
 module Morpheus
   module Cli
@@ -297,7 +298,7 @@ module Morpheus
           every_command = cached_command_list
           guess = command_name
           suggestions = []
-          while guess.size >= 3
+          while suggestions.empty? && guess.size >= 3
             plural_guess = guess.pluralize
             if every_command.include?(guess)
               suggestions << guess

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

@@ -75,7 +75,7 @@ class Morpheus::Cli::AccessTokenCommand
       "Refresh Token" => lambda {|wallet| wallet['refresh_token'] },
       "Login Date" => lambda {|wallet| format_local_dt(wallet['login_date']) },
       "Expire Date" => lambda {|wallet| wallet['expire_date'] ? format_local_dt(wallet['expire_date']) : "" },
-      # "Remote" => lambda {|wallet| display_appliance(@appliance_name, @appliance_url) },
+      "Remote" => lambda {|wallet| display_appliance(@appliance_name, @appliance_url) },
     }
     print cyan
     puts as_description_list(@wallet, description_cols)

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

@@ -1,12 +1,4 @@
-require 'fileutils'
-require 'yaml'
-require 'io/console'
-require 'rest_client'
-require 'optparse'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/mixins/accounts_helper'
-require 'morpheus/cli/mixins/infrastructure_helper'
-require 'morpheus/logging'
 
 class Morpheus::Cli::AccountGroupsCommand
   include Morpheus::Cli::CliCommand

data/lib/morpheus/cli/commands/{standard/alias_command.rb → alias_command.rb}

@@ -1,7 +1,4 @@
-require 'optparse'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/shell'
-require 'json'
 
 # This command allows the creation of an alias
 # these aliases are stored in the $MORPHEUS_CLI_HOME/.morpheusrc
@@ -273,7 +270,7 @@ EOT
       out << "\n"
       out << cyan
       out << as_pretty_table(my_aliases, alias_columns, {:border_style => :thin}.merge(options))
-      out << format_results_pagination({size:my_aliases.size,total:my_aliases.size.to_i})
+      out << format_results_pagination({'size' => my_aliases.size, 'total' => my_aliases.size.to_i})
       out << reset
       out << "\n"
     end

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

@@ -1,13 +1,4 @@
-# require 'yaml'
-require 'io/console'
-require 'rest_client'
-require 'optparse'
-require 'filesize'
 require 'morpheus/cli/cli_command'
-require 'morpheus/cli/mixins/accounts_helper'
-require 'morpheus/cli/mixins/provisioning_helper'
-require 'morpheus/cli/mixins/processes_helper'
-require 'morpheus/cli/mixins/logs_helper'
 
 class Morpheus::Cli::Apps
   include Morpheus::Cli::CliCommand
@@ -19,9 +10,7 @@ class Morpheus::Cli::Apps
   set_command_name :apps
   set_command_description "View and manage apps."
   register_subcommands :list, :count, :get, :view, :add, :update, :remove, :cancel_removal, :add_instance, :remove_instance, :logs, :security_groups, :apply_security_groups, :history
-  register_subcommands :'prepare-apply' => :prepare_apply
-  register_subcommands :apply
-  register_subcommands :refresh
+  register_subcommands :refresh, :apply
   register_subcommands :stop, :start, :restart
   register_subcommands :wiki, :update_wiki
   #register_subcommands :firewall_disable, :firewall_enable
@@ -36,7 +25,7 @@ class Morpheus::Cli::Apps
   def connect(opts)
     @api_client = establish_remote_appliance_connection(opts)
     @accounts_interface = @api_client.accounts
-    @users_interface = @api_client.users
+    @account_users_interface = @api_client.account_users
     @apps_interface = @api_client.apps
     @blueprints_interface = @api_client.blueprints
     @instance_types_interface = @api_client.instance_types
@@ -901,9 +890,7 @@ This is only supported by certain types of apps.
 EOT
     end
     optparse.parse!(args)
-    if args.count != 1
-      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(', ')}\n#{optparse}"
-    end
+    verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
 
     begin
@@ -928,65 +915,11 @@ EOT
         return
       end
       json_response = @apps_interface.refresh(app["id"], params, payload)
-      render_result = render_with_format(json_response, options)
-      return 0 if render_result
-      print_green_success "Refreshed app #{app['name']}"
-      return get([app['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
-    rescue RestClient::Exception => e
-      print_rest_exception(e, options)
-      exit 1
-    end
-  end
-
-  def prepare_apply(args)
-    params, payload, options = {}, {}, {}
-    optparse = Morpheus::Cli::OptionParser.new do |opts|
-      opts.banner = subcommand_usage("[app] [options]")
-      build_standard_update_options(opts, options, [:auto_confirm])
-      opts.footer = <<-EOT
-Prepare to apply an app.
-[app] is required. This is the name or id of an app.
-Template parameter values can be applied with -O templateParameter.foo=bar
-This only prints the app configuration that would be applied.
-It does not make any updates.
-This is only supported by certain types of apps.
-EOT
-    end
-    optparse.parse!(args)
-    if args.count != 1
-      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(', ')}\n#{optparse}"
-    end
-    connect(options)
-
-    begin
-      app = find_app_by_name_or_id(args[0])
-      return 1 if app.nil?
-      # construct request
-      params.merge!(parse_query_options(options))
-      payload = {}
-      if options[:payload]
-        payload = options[:payload]
-        payload.deep_merge!(parse_passed_options(options))
-      else
-        payload.deep_merge!(parse_passed_options(options))
-        # raise_command_error "Specify at least one option to update.\n#{optparse}" if payload.empty?
+      render_response(json_response, options) do
+        print_green_success "Refreshing app #{app['name']}"
+        # return _get(app['id'], options)
       end
-      @apps_interface.setopts(options)
-      if options[:dry_run]
-        print_dry_run @apps_interface.dry.prepare_apply(app["id"], params, payload)
-        return
-      end
-      json_response = @apps_interface.prepare_apply(app["id"], params, payload)
-      render_result = render_with_format(json_response, options)
-      return 0 if render_result
-      # print_green_success "Prepared to apply app: #{app['name']}"
-      print_h1 "Prepared App: #{app['name']}"
-      app_config = json_response['data'] 
-      # app_config = json_response if app_config.nil?
-      puts as_yaml(app_config, options)
-      #return get([app['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
-      print "\n", reset
-      return 0
+      return 0, nil
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1
@@ -1001,17 +934,11 @@ EOT
       opts.footer = <<-EOT
 Apply an app.
 [app] is required. This is the name or id of an app.
-Template parameter values can be applied with -O templateParameter.foo=bar
-This is a way to apply an app with new configuration parameters to an app. 
-This prints the app configuration that would be applied.
-It does not make any updates.
-This is only supported by certain types of apps.
+This is only supported by certain types of apps such as terraform.
 EOT
     end
     optparse.parse!(args)
-    if args.count != 1
-      raise_command_error "wrong number of arguments, expected 1 and got (#{args.count}) #{args.join(', ')}\n#{optparse}"
-    end
+    verify_args!(args:args, optparse:optparse, count:1)
     connect(options)
 
     begin
@@ -1036,11 +963,11 @@ EOT
         return
       end
       json_response = @apps_interface.apply(app["id"], params, payload)
-      render_result = render_with_format(json_response, options)
-      return 0 if render_result
-      print_green_success "Applied app #{app['name']}"
-      #return get([app['id']] + (options[:remote] ? ["-r",options[:remote]] : []))
-      return 0
+      render_response(json_response, options) do
+        print_green_success "Applying app #{app['name']}"
+        # return _get(app['id'], options)
+      end
+      return 0, nil
     rescue RestClient::Exception => e
       print_rest_exception(e, options)
       exit 1

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

@@ -1,9 +1,3 @@
-require 'fileutils'
-require 'json'
-require 'yaml'
-require 'rest_client'
-require 'optparse'
-require 'filesize'
 require 'morpheus/cli/cli_command'
 
 class Morpheus::Cli::ArchivesCommand