rhc 1.6.8 → 1.7.8

data/lib/rhc/commands/sshkey.rb

@@ -4,11 +4,23 @@ module RHC::Commands
   class Sshkey < Base
     include RHC::SSHHelpers
 
-    summary 'Manage multiple keys for the registered rhcloud user.'
+    summary 'Add and remove keys for Git and SSH'
     syntax '<action>'
+    description <<-DESC
+      OpenShift uses public keys to securely access your application source
+      code and to control access to your application gears via SSH.  Your
+      account may have one or more public SSH keys associated with it, and
+      any computer with the private SSH key will be able to download code
+      from Git or SSH to the application.
+
+      Depending on your operating system, you may have to ensure that both
+      Git and the local SSH installation have access to your keys.  Running
+      the 'setup' command is any easy way to get your first key created and
+      uploaded.
+      DESC
     default_action :list
 
-    summary 'Display all the SSH keys for the user account'
+    summary 'Display all the SSH keys for your account'
     syntax ''
     def list
       keys = rest_client.sshkeys.each{ |key| paragraph{ display_key(key) } }
@@ -18,7 +30,7 @@ module RHC::Commands
       0
     end
 
-    summary 'List the SSH key with the given name'
+    summary 'Show the SSH key with the given name'
     syntax '<name>'
     argument :name, 'SSH key to display', []
     def show(name)
@@ -28,7 +40,7 @@ module RHC::Commands
       0
     end
 
-    summary 'Add SSH key to the user account'
+    summary 'Add SSH key to your account'
     syntax '<name> <path to SSH key file>'
     argument :name, 'Name for this key', []
     argument :key, 'SSH public key filepath', []
@@ -54,13 +66,15 @@ module RHC::Commands
       0
     end
 
-    summary 'Remove SSH key from the user account'
+    summary 'Remove SSH key from your account'
     syntax '<name>'
     alias_action :delete
-    argument :name, 'SSH key to remove', []
+    argument :name, 'Name of SSH key to remove'
     def remove(name)
+      say "Removing the key '#{name} ... "
       rest_client.delete_key(name)
-      results { say "SSH key '#{name}' has been removed" }
+
+      success "removed"
 
       0
     end

data/lib/rhc/commands/tail.rb

@@ -8,8 +8,8 @@ module RHC::Commands
 
     summary "Tail the logs of an application"
     syntax "<application>"
-    argument :app, "Name of application you wish to view the logs of", ["-a", "--app app"]
-    option ["-n", "--namespace namespace"], "Namespace of your application", :context => :namespace_context, :required => true
+    argument :app, "Name of application you wish to view the logs of", ["-a", "--app NAME"]
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
     option ["-o", "--opts options"], "Options to pass to the server-side (linux based) tail command (applicable to tail command only) (-f is implicit.  See the linux tail man page full list of options.) (Ex: --opts '-n 100')"
     option ["-f", "--files files"], "File glob relative to app (default <application_name>/logs/*) (optional)"
     #option ["-c", "--cartridge name"], "Tail only a specific cartridge"

data/lib/rhc/commands/threaddump.rb

@@ -1,9 +1,9 @@
 require 'rhc/commands/base'
 module RHC::Commands
   class Threaddump < Base
-    summary "Trigger a thread dump for JBoss and Ruby applications."
+    summary "Trigger a thread dump for JBoss and Ruby apps"
     syntax "<application>"
-    option ["-n", "--namespace namespace"], "Namespace of your application", :context => :namespace_context, :required => true
+    option ["-n", "--namespace NAME"], "Namespace of your application", :context => :namespace_context, :required => true
     argument :app, "Name of the application on which to execute the thread dump", ["-a", "--app name"]
     def run(app)
       rest_app = rest_client.find_application(options.namespace, app)

data/lib/rhc/context_helper.rb

@@ -12,10 +12,6 @@ module RHC
       ENV['LIBRA_SERVER'] || (!options.clean && config['libra_server']) || "openshift.redhat.com"
     end
 
-    def token_context
-      token_store.get(options.rhlogin, options.server) if options.rhlogin
-    end
-
     def app_context
       debug "Getting app context"
 

data/lib/rhc/core_ext.rb

@@ -1,7 +1,6 @@
 # From Rails core_ext/object.rb
 require 'rhc/json'
 require 'open-uri'
-require 'highline'
 require 'httpclient'
 
 class Object
@@ -24,6 +23,23 @@ class Object
   end
 end
 
+class Array
+  # From rails
+  def split(value = nil)
+    using_block = block_given?
+
+    inject([[]]) do |results, element|
+      if (using_block && yield(element)) || (value == element)
+        results << []
+      else
+        results.last << element
+      end
+
+      results
+    end
+  end  
+end
+
 class File
   def chunk(chunk_size=1024)
     yield read(chunk_size) until eof?
@@ -37,6 +53,85 @@ class String
   def wrap(wrap_length=80, char="\n")
     scan(/.{#{wrap_length}}|.+/).join(char)
   end
+
+  def strip_heredoc
+    indent = scan(/^[ \t]*(?=\S)/).min.size || 0
+    gsub(/^[ \t]{#{indent}}/, '').
+      gsub(/(\b|\S)[^\S\n]*\n(\S)/m, '\1 \2').
+      gsub(/\n+\Z/, '').
+      gsub(/\n{3,}/, "\n\n")
+  end
+
+  ANSI_ESCAPE_SEQUENCE = /\e\[(\d{1,2}(?:;\d{1,2})*[@-~])/
+  ANSI_ESCAPE_MATCH = '\e\[\d+(?:;\d+)*[@-~]'
+  CHAR_SKIP_ANSI = "(?:(?:#{ANSI_ESCAPE_MATCH})+.?|.(?:#{ANSI_ESCAPE_MATCH})*)"
+
+  #
+  # Split the given string at limit, treating ANSI escape sequences as
+  # zero characters in length.  Will insert an ANSI reset code (\e[0m)
+  # at the end of each line containing an ANSI code, assuming that a
+  # reset was not in the wrapped segment.
+  #
+  # All newlines are preserved.
+  #
+  # Lines longer than limit without natural breaks will be forcibly 
+  # split at the exact limit boundary.
+  #
+  # Returns an Array
+  #
+  def textwrap_ansi(limit, breakword=true)
+    re = breakword ? /
+      ( 
+        # Match substrings that end in whitespace shorter than limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}} # up to limit
+        (?:\s+|$)                     # require the limit to end on whitespace
+        |
+        # Match substrings equal to the limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}} 
+      )
+      /x :
+      /
+      ( 
+        # Match substrings that end in whitespace shorter than limit
+        #{CHAR_SKIP_ANSI}{1,#{limit}}
+        (?:\s|$)                     # require the limit to end on whitespace
+        |
+        # Match all continguous whitespace strings
+        #{CHAR_SKIP_ANSI}+?
+        (?:\s|$)
+        (?:\s+|$)?
+      )
+      /x
+    escapes = []
+
+    split("\n",-1).inject([]) do |a, line|
+      if line.length < limit
+        a << line 
+      else
+        line.scan(re) do |segment, other|
+          if escapes.present? 
+            a << escapes.map{ |s| "\e[#{s}"}.join
+            a[-1] << segment.rstrip   
+          else
+            a << segment.rstrip
+          end
+
+          segment.scan(ANSI_ESCAPE_SEQUENCE).map{ |e| e.first }.each do |e|
+            case e
+            when '0m' then escapes.clear
+            else escapes << e
+            end
+          end
+          a[-1] << "\e[0m" if escapes.present?
+        end
+      end
+      a
+    end
+  end
+
+  def strip_ansi
+    gsub(ANSI_ESCAPE_SEQUENCE, '')
+  end
 end
 
 unless HTTP::Message.method_defined? :ok?
@@ -99,78 +194,3 @@ class Hash
     merge!( other_hash ){|key,left,right| left }
   end
 end
-
-# Some versions of highline get in an infinite loop when trying to wrap.
-# Fixes BZ 866530.
-class HighLine
-
-  def wrap_line(line)
-    wrapped_line = []
-    i = chars_in_line = 0
-    word = []
-
-    while i < line.length
-      # we have to give a length to the index because ruby 1.8 returns the
-      # byte code when using a single fixednum index
-      c = line[i, 1]
-      color_code = nil
-      # escape character probably means color code, let's check
-      if c == "\e"
-        color_code = line[i..i+6].match(/\e\[\d{1,2}m/)
-        if color_code
-          # first the existing word buffer then the color code
-          wrapped_line << word.join.wrap(@wrap_at) << color_code[0]
-          word.clear
-
-          i += color_code[0].length
-        end
-      end
-
-      # visible character
-      if !color_code
-        chars_in_line += 1
-        word << c
-
-        # time to wrap the line?
-        if chars_in_line == @wrap_at
-          if c == ' ' or line[i+1, 1] == ' ' or word.length == @wrap_at
-            wrapped_line << word.join
-            word.clear
-          end
-
-          wrapped_line[-1].rstrip!
-          wrapped_line << "\n"
-
-          # consume any spaces at the begining of the next line
-          word = word.join.lstrip.split(//)
-          chars_in_line = word.length
-
-          if line[i+1, 1] == ' '
-            i += 1 while line[i+1, 1] == ' '
-          end
-
-        else
-          if c == ' '
-            wrapped_line << word.join
-            word.clear
-          end
-        end
-
-        i += 1
-      end
-    end
-
-    wrapped_line << word.join
-    wrapped_line.join
-  end
-
-  def wrap(text)
-    wrapped_text = []
-    lines = text.split(/\r?\n/)
-    lines.each_with_index do |line, i|
-      wrapped_text << wrap_line(i == lines.length - 1 ? line : line.rstrip)
-    end
-
-    return wrapped_text.join("\n")
-  end
-end

data/lib/rhc/exceptions.rb

@@ -134,4 +134,10 @@ module RHC
       super message, 1
     end
   end
+
+  class ServerAPINotSupportedException < Exception
+    def initialize(min_version, current_version)
+      super "The server does not support this command (requires #{min_version}, found #{current_version})."
+    end
+  end
 end

data/lib/rhc/help_formatter.rb

@@ -5,20 +5,37 @@ module RHC
     def template(name)
       ERB.new(File.read(File.join(File.dirname(__FILE__), 'usage_templates', "#{name}.erb")), nil, '-')
     end
+    def render
+      template(:help).result RunnerHelpBindings.new(@runner).get_binding
+    end
     def render_command_syntax command
       template(:command_syntax_help).result command.get_binding
     end
     def render_options runner
-      template(:options_help).result runner.get_binding
+      template(:options_help).result RunnerHelpBindings.new(runner).get_binding
+    end
+  end
+
+  class RunnerHelpBindings < SimpleDelegator
+    include RHC::Helpers
+
+    def commands
+      __getobj__.instance_variable_get(:@commands)
+    end
+
+    def get_binding
+      binding
     end
   end
 
   class CommandHelpBindings
+    include RHC::Helpers
+
     def initialize(command, instance_commands, runner)
       @command = command
       @actions = instance_commands.collect do |command_name, command_class|
         next if command_class.summary.nil?
-        m = /^#{command.name} ([^ ]+)/.match(command_name)
+        m = /^#{command.name}[\-]([^ ]+)/.match(command_name)
         # if we have a match and it is not an alias then we can use it
         m and command_name == command_class.name ? {:name => m[1], :summary => command_class.summary || ""} : nil
       end

data/lib/rhc/helpers.rb

@@ -29,22 +29,15 @@ module RHC
     MAX_RETRIES = 7
     DEFAULT_DELAY_THROTTLE = 2.0
 
-    def disable_deprecated?
-      # 1) default for now is false
-      # 2) when releasing a 1.0 beta flip this to true
-      # 3) all deprecated aliases should be removed right before 1.0
-      disable = false
-
-      env_disable = ENV['DISABLE_DEPRECATED']
-      disable = true if env_disable == '1'
-
-      disable
-    end
-
     def decode_json(s)
       RHC::Vendor::OkJson.decode(s)
     end
 
+    def system_path(path)
+      return path.gsub(File::SEPARATOR, File::ALT_SEPARATOR) if File.const_defined?('ALT_SEPARATOR') and File::ALT_SEPARATOR.present?
+      path
+    end
+
     def date(s)
       now = Date.today
       d = datetime_rfc3339(s).to_time
@@ -100,7 +93,7 @@ module RHC
 
     global_option '-l', '--rhlogin LOGIN', "OpenShift login"
     global_option '-p', '--password PASSWORD', "OpenShift password"
-    global_option '--token TOKEN', "An authorization token for accessing your account.", :context => :token_context
+    global_option '--token TOKEN', "An authorization token for accessing your account."
 
     global_option '-d', '--debug', "Turn on debugging", :hide => true
 
@@ -124,7 +117,7 @@ module RHC
     global_option '--noprompt', "Suppress all interactive operations command", :hide => true do
       $terminal.page_at = nil
     end
-    global_option '--config FILE', "Path of a different config file", :hide => true
+    global_option '--config FILE', "Path of a different config file (default: #{system_path("~/.openshift/express.conf")})", :hide => true
     global_option '--clean', "Ignore any saved configuration options", :hide => true
     global_option '--mock', "Run in mock mode", :hide => true do
       #:nocov:
@@ -154,6 +147,10 @@ module RHC
       uri.path = '/broker/rest/api' if uri.path.blank? || uri.path == '/'
       uri
     end
+    
+    def token_for_user
+      options.token or (token_store.get(options.rhlogin, options.server) if options.rhlogin)
+    end
 
     def client_from_options(opts)
       RHC::Rest::Client.new({
@@ -183,6 +180,10 @@ module RHC
     # Output helpers
     #
 
+    def interactive?
+      $stdout.tty? and not options.noprompt
+    end
+
     def debug(msg)
       $stderr.puts "DEBUG: #{msg}" if debug?
     end
@@ -193,66 +194,23 @@ module RHC
       false
     end
 
-    def deprecated_command(correct,short = false)
-      deprecated("This command is deprecated. Please use '#{correct}' instead.",short)
+    def disable_deprecated?
+      ENV['DISABLE_DEPRECATED'] == '1'
     end
 
-    def deprecated_option(deprecated,new)
-      deprecated("The option '#{deprecated}' is deprecated. Please use '#{new}' instead")
+    def deprecated_command(correct, short=false)
+      deprecated("This command is deprecated. Please use '#{correct}' instead.", short)
     end
 
-    def deprecated(msg,short = false)
-      HighLine::use_color = false if windows? # handle deprecated commands that does not start through highline
-
-      info = " For porting and testing purposes you may switch this %s to %s by setting the DISABLE_DEPRECATED environment variable to %d.  It is not recommended to do so in a production environment as this option will be removed in a future release."
-      msg << info unless short
+    def deprecated_option(deprecated, other)
+      deprecated("The option '#{deprecated}' is deprecated. Please use '#{other}' instead")
+    end
 
+    def deprecated(msg,short = false)
       raise DeprecatedError.new(msg % ['an error','a warning',0]) if disable_deprecated?
-
       warn "Warning: #{msg}\n" % ['a warning','an error',1]
     end
 
-    @@indent = 0
-    @@last_line_open = false
-    def say(msg, *args)
-      output = if Hash[*args][:stderr]
-          $stderr
-        else
-          separate_blocks
-          $terminal.instance_variable_get(:@output)
-        end
-
-      Array(msg).each do |statement|
-        statement = statement.to_str
-        next unless statement.present?
-
-        template  = ERB.new(statement, nil, "%")
-        statement = template.result(binding)
-
-        statement = $terminal.wrap(statement) unless $terminal.instance_variable_get(:@wrap_at).nil?
-        statement = $terminal.send(:page_print, statement) unless $terminal.instance_variable_get(:@page_at).nil?
-
-        output.print(' ' * @@indent * INDENT) unless @@last_line_open
-
-        @@last_line_open = 
-          if statement[-1, 1] == " " or statement[-1, 1] == "\t"
-            output.print(statement)
-            output.flush
-          else
-            output.puts(statement)
-          end
-      end
-
-      msg
-    end
-
-    [:ask, :agree].each do |sym|
-      define_method(sym) do |*args, &block|
-        separate_blocks
-        super(*args, &block)
-      end
-    end
-
     def confirm_action(question)
       return if options.confirm
       return if !options.noprompt && paragraph{ agree("#{question} (yes|no): ") }
@@ -275,39 +233,19 @@ module RHC
       say color(msg, :red), *args
     end
 
-    def color(s, color)
-      $terminal.color(s, color)
+    # OVERRIDE: Replaces default commander behavior
+    def color(*args)
+      $terminal.color(*args)
     end
 
-    def pluralize(count, s)
-      count == 1 ? "#{count} #{s}" : "#{count} #{s}s"
+    [:pager, :indent, :paragraph, :section, :header, :table, :table_args].each do |sym|
+      define_method(sym) do |*args, &block|
+        $terminal.send(sym, *args, &block)
+      end
     end
 
-    # given an array of arrays "items", construct an array of strings that can
-    # be used to print in tabular form.
-    def table(items, opts={}, &block)
-      items = items.map &block if block_given?
-      widths = []
-      items.each do |item|
-        item.each_with_index do |s, i|
-          item[i] = s.to_s
-          widths[i] = [widths[i] || 0, item[i].length].max
-        end
-      end
-      align = opts[:align] || []
-      join = opts[:join] || ' '
-      if opts[:header]
-        opts[:header].each_with_index do |s, i|
-          widths[i] = [widths[i] || 0, s.length].max
-        end
-        sep = opts[:separator] || "="
-        ary = Array.new(opts[:header].length)
-        items.unshift ary.each_with_index {|obj, idx| ary[idx] = sep.to_s * (widths[idx] || 1)}
-        items.unshift(opts[:header])
-      end
-      items.map do |item|
-        item.each_with_index.map{ |s,i| s.send((align[i] == :right ? :rjust : :ljust), widths[i], ' ') }.join(join).rstrip
-      end
+    def pluralize(count, s)
+      count == 1 ? "#{count} #{s}" : "#{count} #{s}s"
     end
 
     # This will format table headings for a consistent look and feel
@@ -360,92 +298,6 @@ module RHC
       end
     end
 
-    #def tee(&block)
-    #  original = [$stdout, $stderr]
-    #  $stdout, $stderr = (tees = original.map{ |io| StringTee.new(io) })
-    #  yield
-    #ensure
-    #  $stdout, $stderr = original
-    #  tees.each(&:close_write).map(&:string)
-    #end
-
-    def header(str,opts = {}, &block)
-      str = underline(str)
-      str = str.map{ |s| color(s, opts[:color]) } if opts[:color]
-      say str
-      if block_given?
-        indent &block
-      end
-    end
-
-    def underline(s)
-      [s, "-"*s.length]
-    end
-
-    INDENT = 2
-    def indent(&block)
-      @@indent += 1
-      begin
-        yield
-      ensure
-        @@indent -= 1
-      end
-    end
-
-    ##
-    # section
-    #
-    # highline helper mixin which correctly formats block of say and ask
-    # output to have correct margins.  section remembers the last margin
-    # used and calculates the relitive margin from the previous section.
-    # For example:
-    #
-    # section(bottom=1) do
-    #   say "Hello"
-    # end
-    #
-    # section(top=1) do
-    #   say "World"
-    # end
-    #
-    # Will output:
-    #
-    # > Hello
-    # >
-    # > World 
-    #
-    # with only one newline between the two.  Biggest margin wins.
-    #
-    # params:
-    #  top - top margin specified in lines
-    #  bottom - bottom margin specified in line
-    #
-    @@margin = nil
-    def section(params={}, &block)
-      top = params[:top] || 0
-      bottom = params[:bottom] || 0
-
-      # the first section cannot take a newline
-      top = 0 unless @@margin
-      @@margin = [top, @@margin || 0].max
-
-      value = block.call
-
-      say "\n" if @@last_line_open
-      @@margin = [bottom, @@margin].max
-
-      value
-    end
-
-    ##
-    # paragraph
-    #
-    # highline helper which creates a section with margins of 1, 1
-    #
-    def paragraph(&block)
-      section(:top => 1, :bottom => 1, &block)
-    end
-
     ##
     # results
     #
@@ -465,11 +317,6 @@ module RHC
     def unix? ; !jruby? && !windows? end
     def mac? ; RbConfig::CONFIG['host_os'] =~ /^darwin/ end
 
-    def system_path(path)
-      return path.gsub(File::SEPARATOR, File::ALT_SEPARATOR) if File.const_defined?('ALT_SEPARATOR') and File::ALT_SEPARATOR.present?
-      path
-    end
-
     #
     # Check if host exists
     #
@@ -529,14 +376,5 @@ module RHC
 
       [status, stdout, stderr]
     end
-
-    private
-
-      def separate_blocks
-        if (@@margin ||= 0) > 0 && !@@last_line_open
-          $terminal.instance_variable_get(:@output).print "\n" * @@margin
-          @@margin = 0
-        end
-      end
   end
 end