morpheus-cli 2.10.3 → 2.11.0

data/lib/morpheus/cli/cli_command.rb

@@ -1,13 +1,17 @@
+require 'morpheus/logging'
 require 'morpheus/cli/option_parser'
 require 'morpheus/cli/cli_registry'
 require 'morpheus/cli/mixins/print_helper'
 require 'morpheus/cli/credentials'
 require 'morpheus/api/api_client'
 require 'morpheus/cli/remote'
+require 'morpheus/terminal'
 
 module Morpheus
   module Cli
     # Module to be included by every CLI command so that commands get registered
+    # This mixin defines a print and puts method, and delegates
+    # todo: use delegate
     module CliCommand
 
       def self.included(klass)
@@ -21,17 +25,75 @@ module Morpheus
       # this setting makes it easy for the called to disable prompting
       attr_reader :no_prompt
 
-      # disabled prompting for this command
-      def noninteractive()
-        @no_prompt = true
-        self
+      # @return [Morpheus::Terminal] the terminal this command is being executed inside of
+      def my_terminal
+        @my_terminal ||= Morpheus::Terminal.instance
+      end
+
+      # set the terminal this is running this command.
+      # @param term [MorpheusTerminal] the terminal this command is assigned to
+      # @return the Terminal this command is being executed inside of
+      def my_terminal=(term)
+        if !t.is_a?(Morpheus::Terminal)
+          raise "CliCommand #{self.class} terminal= expects object of type Terminal and instead got a #{t.class}"
+        end
+        @my_terminal = t
+      end
+
+
+      # delegate :print, to: :my_terminal
+      # delegate :puts, to: :my_terminal
+      # or . . . bum  bum bummm
+      # a paradigm shift away from include and use module functions instead.
+      # module_function :print, puts
+      # delegate :puts, to: :my_terminal
+      
+      def print(*msgs)
+        my_terminal.stdout.print(*msgs)
+      end
+
+      def puts(*msgs)
+        my_terminal.stdout.puts(*msgs)
+      end
+
+      def print_error(*msgs)
+        my_terminal.stderr.print(*msgs)
+      end
+
+      def puts_error(*msgs)
+        my_terminal.stderr.puts(*msgs)
       end
 
+      # todo: use terminal.stdin
+      # def readline(*msgs)
+      #   @my_terminal.stdin.readline(*msgs)
+      # end
+
+      # todo: maybe...
+      # disabled prompting for this command
+      # def noninteractive()
+      #   @no_prompt = true
+      #   self
+      # end
+
       # whether to prompt or not, this is true by default.
       def interactive?
         @no_prompt != true
       end
 
+      def raise_command_error(msg)
+        raise Morpheus::Cli::CommandError.new(msg)
+      end
+
+      # parse_id_list splits returns the given id_list with its values split on a comma
+      #               your id values cannot contain a comma, atm...
+      # @param id_list [String or Array of Strings]
+      # @param delim [String] Default is a comma and any surrounding white space.
+      # @return array of values
+      def parse_id_list(id_list, delim=/\s*\,\s*/)
+        [id_list].flatten.collect {|it| it ? it.to_s.split(delim) : nil }.flatten.compact
+      end
+
       # Appends Array of OptionType definitions to an OptionParser instance
       # This adds an option like --fieldContext.fieldName="VALUE"
       # @param opts [OptionParser]
@@ -65,6 +127,12 @@ module Morpheus
           end
 
           description = "#{option_type['fieldLabel']}#{option_type['fieldAddOn'] ? ('(' + option_type['fieldAddOn'] + ') ') : '' }#{!option_type['required'] ? ' (optional)' : ''}#{option_type['defaultValue'] ? ' Default: '+option_type['defaultValue'].to_s : ''}"
+          if option_type['description']
+            description << "\n                                     #{option_type['description']}"
+          end
+          if option_type['helpBlock']
+            description << "\n                                     #{option_type['helpBlock']}"
+          end
           # description = option_type['description'].to_s
           # if option_type['defaultValue']
           #   description = "#{description} Default: #{option_type['defaultValue']}"
@@ -99,7 +167,7 @@ module Morpheus
       # @return opts
       def build_common_options(opts, options, includes=[])
         #opts.separator ""
-        opts.separator "Common options:"
+        # opts.separator "Common options:"
         includes = includes.clone
         while (option_key = includes.shift) do
           case option_key.to_sym
@@ -148,7 +216,7 @@ module Morpheus
             end
 
             opts.on( '-o', '--offset OFFSET', "Offset Results" ) do |offset|
-              options[:offset] = offset.to_i
+              options[:offset] = offset.to_i.abs
             end
 
             opts.on( '-s', '--search PHRASE', "Search Phrase" ) do |phrase|
@@ -163,6 +231,16 @@ module Morpheus
               options[:direction] = "desc"
             end
 
+          when :last_updated
+            # opts.on("--last-updated TIME", Time, "Filter by gte last updated") do |time|
+            opts.on("--last-updated TIME", String, "Filter by Last Updated (gte)") do |time|
+              begin
+                options[:lastUpdated] = parse_time(time)
+              rescue => e
+                raise OptionParser::InvalidArgument.new "Failed to parse time '#{time}'. Error: #{e}"
+              end
+            end
+
           when :remote
 
             # this is the only option now... 
@@ -172,10 +250,15 @@ module Morpheus
             end
 
             # todo: also require this for talking to plain old HTTP
-            opts.on('-I','--insecure', "Allow for insecure HTTPS communication i.e. bad SSL certificate") do |val|
+            opts.on('-I','--insecure', "Allow insecure HTTPS communication.  i.e. bad SSL certificate.") do |val|
+              options[:insecure] = true
               Morpheus::RestClient.enable_ssl_verification = false
             end
 
+            opts.on( '-T', '--token ACCESS_TOKEN', "Access Token for api requests. While authenticated to a remote, the current saved credentials are used." ) do |remote|
+              options[:remote_token] = remote
+            end
+
             # skipping the rest of this for now..
 
             next
@@ -204,10 +287,65 @@ module Morpheus
             opts.on( '-y', '--yes', "Auto Confirm" ) do
               options[:yes] = true
             end
-          
+
           when :json
             opts.on('-j','--json', "JSON Output") do
               options[:json] = true
+              options[:format] = :json
+            end
+
+            opts.on('--json-raw', String, "JSON Output that is not so pretty.") do |val|
+              options[:json] = true
+              options[:format] = :json
+              options[:pretty_json] = false
+            end
+
+          when :yaml
+            opts.on(nil, '--yaml', "YAML Output") do
+              options[:yaml] = true
+              options[:format] = :yaml
+            end
+
+          when :csv
+            opts.on(nil, '--csv', "CSV Output") do
+              options[:csv] = true
+              options[:format] = :csv
+              #options[:csv_delim] = options[:csv_delim] || ","
+            end
+
+            opts.on('--csv-delim CHAR', String, "Delimiter for CSV Output values. Default: ','") do |val|
+              options[:csv] = true
+              options[:format] = :csv
+              val = val.gsub("\\n", "\n").gsub("\\r", "\r").gsub("\\t", "\t") if val.include?("\\")
+              options[:csv_delim] = val
+            end
+
+            opts.on('--csv-newline [CHAR]', String, "Delimiter for CSV Output rows. Default: '\\n'") do |val|
+              options[:csv] = true
+              options[:format] = :csv
+              if val == "no" || val == "none"
+                options[:csv_newline] = ""
+              else
+                val = val.gsub("\\n", "\n").gsub("\\r", "\r").gsub("\\t", "\t") if val.include?("\\")
+                options[:csv_newline] = val
+              end
+            end
+
+            opts.on(nil, '--csv-quotes', "Quote values for CSV Output. Default: false") do
+              options[:csv] = true
+              options[:format] = :csv
+              options[:csv_quotes] = true
+            end
+
+            opts.on(nil, '--csv-no-header', "Exclude header for CSV Output.") do
+              options[:csv] = true
+              options[:format] = :csv
+              options[:csv_no_header] = true
+            end
+
+          when :fields
+            opts.on('--fields x,y,z', Array, "Filter Output to a limited set of fields. Default is all fields.") do |val|
+              options[:include_fields] = val
             end
 
           when :dry_run
@@ -216,7 +354,7 @@ module Morpheus
             end
 
           when :quiet
-            opts.on('-q','--quiet', "No Output, when successful") do
+            opts.on('-q','--quiet', "No Output, do not print to stdout") do
               options[:quiet] = true
             end
 
@@ -235,7 +373,7 @@ module Morpheus
         opts.on('-V','--debug', "Print extra output for debugging. ") do
           options[:debug] = true
           Morpheus::Logging.set_log_level(Morpheus::Logging::Logger::DEBUG)
-          ::RestClient.log = Morpheus::Logging.debug? ? STDOUT : nil
+          ::RestClient.log = Morpheus::Logging.debug? ? Morpheus::Logging::DarkPrinter.instance : nil
           # perhaps...
           # create a new logger instance just for this command instance
           # this way we don't elevate the global level for subsequent commands in a shell
@@ -276,6 +414,10 @@ module Morpheus
         end
       end
 
+      def my_help_command
+        "morpheus #{command_name} --help"
+      end
+
       def subcommand_usage(*extra)
         calling_method = caller[0][/`([^']*)'/, 1].to_s.sub('block in ', '')
         subcommand_name = subcommands.key(calling_method)
@@ -287,14 +429,22 @@ module Morpheus
         "Usage: morpheus #{command_name} #{subcommand_name} #{extra.join(' ')}".squeeze(' ').strip
       end
 
-      def print_usage()
-        puts usage
+      # a string to describe the usage of your command
+      # this is what the --help option
+      # feel free to override this in your commands
+      def full_command_usage
+        out = ""
+        out << usage.to_s.strip if usage
+        out << "\n"
         if !subcommands.empty?
-          puts "Commands:"
+          out << "Commands:"
+          out << "\n"
           subcommands.sort.each {|cmd, method|
-            puts "\t#{cmd.to_s}"
+            out << "\t#{cmd.to_s}\n"
           }
         end
+        # out << "\n"
+        out
       end
 
       # a default handler
@@ -309,20 +459,24 @@ module Morpheus
         #   return self.send(default_subcommand, args || [])
         # end
         subcommand_name = args[0]
+        if args.empty?
+          print_error Morpheus::Terminal.angry_prompt
+          puts_error "[command] argument is required"
+          puts full_command_usage
+          exit 127
+        end
         if args[0] == "-h" || args[0] == "--help" || args[0] == "help"
-          print_usage
-          exit
+          puts full_command_usage
+          return 0
         end
         if subcommand_aliases[subcommand_name]
           subcommand_name = subcommand_aliases[subcommand_name]
         end
         cmd_method = subcommands[subcommand_name]
-        if subcommand_name && !cmd_method
-          puts "unknown command '#{self.command_name} #{subcommand_name}'"
-        end
         if !cmd_method
-          print_usage
-          exit 127
+          print_error Morpheus::Terminal.angry_prompt
+          puts_error "'#{subcommand_name}' is not a morpheus #{self.command_name} command. See '#{my_help_command}'"
+          return 127
         end
         self.send(cmd_method, args[1..-1])
       end
@@ -331,50 +485,73 @@ module Morpheus
         raise "#{self} has not defined handle()!"
       end
 
+      # executes block with each argument in the list
+      # @return [0|1] 0 if they were all successful, else 1
+      def run_command_for_each_arg(args, &block)
+        cmd_results = []
+        args.each do |arg|
+          begin
+            cur_result = yield arg
+          rescue SystemExit => err
+            cur_result = err.success? ? 0 : 1
+          end
+          cmd_results << cur_result
+        end
+        failed_cmd = cmd_results.find {|cmd_result| cmd_result == false || (cmd_result.is_a?(Integer) && cmd_result != 0) }
+        return failed_cmd ? failed_cmd : 0
+      end
+
       # This supports the simple remote option eg. `instances add --remote "qa"`
       # It will establish a connection to the pre-configured appliance named "qa"
       # The calling command can populate @appliances and/or @appliance_name
       # Otherwise, the current active appliance is used...
       # This returns a new instance of Morpheus::APIClient (and sets @access_token, and @appliance)
       # Your command should be ready to make api requests after this.
-      # todo: probably don't exit here, just return nil or raise
       def establish_remote_appliance_connection(options)
-        @appliances ||= ::Morpheus::Cli::Remote.appliances
-        if !@appliance_name
-          @appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
-        end
+        # todo: probably refactor and don't rely on this method to set these instance vars
+        @appliance_name, @appliance_url, @access_token = nil, nil, nil
+        @api_client = nil
 
-        # todo: support old way of accepting --username and --password on the command line
-        # it's probably better not to do that tho, just so it stays out of history files
-
-        # use a specific remote appliance by name
+        appliance = nil # @appliance..why not? laff
         if options[:remote]
-          @appliance_name = options[:remote].to_sym rescue nil
-          if !@appliances
-            print_red_alert "You have no appliances configured. See the `remote add` command."
-            exit 1
-          end
-          found_appliance = @appliances[@appliance_name.to_sym]
-          if !found_appliance
-            print_red_alert "You have no appliance named '#{@appliance_name}' configured. See the `remote add` command."
-            exit 1
-          end
-          @appliance = found_appliance
-          @appliance_name = @appliance_name
-          @appliance_url = @appliance[:host]
-          if options[:debug]
-            print dark,"# => Using remote appliance [#{@appliance_name}] #{@appliance_url}",reset,"\n" if !options[:quiet]
+          appliance = ::Morpheus::Cli::Remote.load_remote(options[:remote])
+          if !appliance
+            if ::Morpheus::Cli::Remote.appliances.empty?
+              raise_command_error "You have no appliances configured. See the `remote add` command."
+            else
+              raise_command_error "Remote appliance not found by the name '#{appliance_name}'"
+            end
           end
         else
-          #@appliance_name, @appliance_url = Morpheus::Cli::Remote.active_appliance
+          appliance = ::Morpheus::Cli::Remote.load_active_remote()
+          if !appliance
+            if ::Morpheus::Cli::Remote.appliances.empty?
+              raise_command_error "You have no appliances configured. See the `remote add` command."
+            else
+              raise_command_error "No current appliance, see `remote use`."
+            end
+          end
         end
+        @appliance_name = appliance[:name]
+        @appliance_url = appliance[:host] || appliance[:url] # it's :host in the YAML..heh
 
-        if !@appliance_name
-          print_red_alert "You must specify a remote appliance with --remote, or see the `remote use` command."
-          exit 1
-        end
+        # todo: support old way of accepting --username and --password on the command line
+        # it's probably better not to do that tho, just so it stays out of history files
+        
 
-        puts "#{dark} #=> establishing connection to [#{@appliance_name}] #{@appliance_url}#{reset}\n" if options[:debug]
+        # if !@appliance_name && !@appliance_url
+        #   raise_command_error "Please specify a remote appliance with -r or see the command `remote use`"
+        # end
+
+        Morpheus::Logging::DarkPrinter.puts "establishing connection to [#{@appliance_name}] #{@appliance_url}" if options[:debug]
+        #puts "#{dark} #=> establishing connection to [#{@appliance_name}] #{@appliance_url}#{reset}\n" if options[:debug]
+
+        
+        # punt.. and just allow passing an access token instead for now..
+        # this skips saving to the appliances file and all that..
+        if options[:token]
+          @access_token = options[:token]
+        end
 
         # ok, get some credentials.
         # this prompts for username, password  without options[:no_prompt]
@@ -400,8 +577,7 @@ module Morpheus
 
       def verify_access_token!
         if @access_token.empty?
-          print_red_alert "Invalid Credentials. Unable to acquire access token. Please verify your credentials and try again."
-          exit 1
+          raise_command_error "Unable to acquire access token. Please verify your credentials and try again."
         end
         true
       end

data/lib/morpheus/cli/cli_registry.rb

@@ -1,13 +1,60 @@
 require 'term/ansicolor'
+require 'morpheus/logging'
 module Morpheus
   module Cli
     class CliRegistry
 
+      class BadAlias < StandardError
+      end
+
       def initialize
         @commands = {} # this is command => Class that includes ::CliCommand
         @aliases = {} # this is alias => String full input string
       end
 
+      def flush
+        @commands = {}
+        @aliases = {}
+      end
+      
+      def all
+        @commands.reject {|cmd, klass| klass.hidden_command }
+      end
+
+      def get(cmd_name)
+        @commands[cmd_name.to_sym]
+      end
+
+      def add(cmd_name, klass)
+        @commands[cmd_name.to_sym] = klass
+      end
+
+      def remove(cmd_name)
+        @commands.delete(cmd_name.to_sym)
+      end
+
+      def all_aliases
+        @aliases
+      end
+
+      def get_alias(alias_name)
+        @aliases[alias_name.to_sym]
+      end
+
+      def add_alias(alias_name, command_string)
+        #return @commands[alias_name.to_sym]
+        if self.class.has_command?(alias_name)
+          raise BadAlias.new "alias name '#{alias_name}' is invalid. That is the name of a morpheus command."
+        elsif alias_name.to_s.downcase.strip == command_string.to_s.downcase.strip
+          raise BadAlias.new "alias #{alias_name}=#{command_string} is invalid..."
+        end
+        @aliases[alias_name.to_sym] = command_string
+      end
+
+      def remove_alias(alias_name)
+        @aliases.delete(alias_name.to_sym)
+      end
+
       class << self
         include Term::ANSIColor
         
@@ -39,7 +86,7 @@ module Morpheus
           # support aliases of multiple commands, semicolon delimiter
           # todo: 
           all_commands = found_alias_command.gsub(ALIAS_SPLIT_REGEX, '__ALIAS_SPLIT_REGEX__').split('__ALIAS_SPLIT_REGEX__').collect {|it| it.to_s.strip }.select {|it| !it.empty?  }.compact
-          print "#{dark} #=> executing alias #{alias_name} as #{all_commands.join('; ')}#{reset}\n" if Morpheus::Logging.debug?
+          Morpheus::Logging::DarkPrinter.puts "executing alias #{alias_name} as #{all_commands.join('; ')}" if Morpheus::Logging.debug?
           all_commands.each do |a_command_string|
             alias_args = a_command_string.to_s.split(/\s+/) # or just ' '
             command_name = alias_args.shift
@@ -119,45 +166,6 @@ module Morpheus
           return alias_name, command_string
         end
 
-
-      end
-
-      def all
-        @commands.reject {|cmd, klass| klass.hidden_command }
-      end
-
-      def get(cmd_name)
-        @commands[cmd_name.to_sym]
-      end
-
-      def add(cmd_name, klass)
-        @commands[cmd_name.to_sym] = klass
-      end
-
-      def remove(cmd_name)
-        @commands.delete(cmd_name.to_sym)
-      end
-
-      def all_aliases
-        @aliases
-      end
-
-      def get_alias(alias_name)
-        @aliases[alias_name.to_sym]
-      end
-
-      def add_alias(alias_name, command_string)
-        #return @commands[alias_name.to_sym]
-        if self.class.has_command?(alias_name)
-          raise "alias name '#{alias_name}' is invalid. That is the name of a morpheus command."
-        elsif alias_name.to_s.downcase.strip == command_string.to_s.downcase.strip
-          raise "alias #{alias_name}=#{command_string} is invalid..."
-        end
-        @aliases[alias_name.to_sym] = command_string
-      end
-
-      def remove_alias(alias_name)
-        @aliases.delete(alias_name.to_sym)
       end
 
     end