rhc 0.98.16 → 1.0.4

data/lib/rhc/commands/tail.rb

@@ -0,0 +1,24 @@
+require 'rhc/commands/base'
+require 'rhc/config'
+require 'rhc-common'
+module RHC::Commands
+  class Tail < Base
+    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
+    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)"
+    alias_action :"app tail", :root_command => true, :deprecated => true
+    def run(app)
+      begin
+        rest_domain = rest_client.find_domain(options.namespace)
+        rest_app = rest_domain.find_application(app)
+        rest_app.tail(options)
+      rescue Interrupt
+        results { say "Terminating..." }
+      end
+      0
+    end
+  end
+end

data/lib/rhc/commands/threaddump.rb

@@ -0,0 +1,16 @@
+require 'rhc/commands/base'
+module RHC::Commands
+  class Threaddump < Base
+    summary "Trigger a thread dump for JBoss and Ruby applications."
+    syntax "<application>"
+    option ["-n", "--namespace namespace"], "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_domain = rest_client.find_domain(options.namespace)
+      rest_app = rest_domain.find_application(app)
+      rest_app.threaddump.messages.each { |m| say m }
+
+      0
+    end
+  end
+end

data/lib/rhc/commands.rb

@@ -1,6 +1,32 @@
 require 'commander'
 require 'rhc/helpers'
 
+## monkey patch option parsing to also parse global options all at once
+#  to avoid conflicts and side effects of similar short switches
+module Commander
+  class Command
+    def parse_options_and_call_procs *args
+      return args if args.empty?
+      opts = OptionParser.new
+      runner = Commander::Runner.instance
+      # add global options
+      runner.options.each do |option|
+        opts.on *option[:args],
+                &runner.global_option_proc(option[:switches], &option[:proc])
+
+      end
+
+      # add command options
+      @options.each do |option|
+        opts.on(*option[:args], &option[:proc])
+        opts
+      end
+
+      opts.parse! args
+    end
+  end
+end
+
 module RHC
   module Commands
     def self.load
@@ -27,12 +53,10 @@ module RHC
       command_name = Commander::Runner.instance.command_name_from_args
       command = Commander::Runner.instance.active_command
 
-      if deprecated[command_name]
-        msg = "The command 'rhc #{command_name}' is deprecated.  Please use 'rhc #{command.name}' instead."
-
-        raise DeprecatedError.new("#{msg} For porting and testing purposes you may switch this error to a warning by setting the DISABLE_DEPRECATED environment variable to 0.  It is not recommended to do so in a production environment as this command may be removed in future releases.") if RHC::Helpers.disable_deprecated?
-
-        warn "Warning: #{msg} For porting and testing purposes you may switch this warning to an error by setting the DISABLE_DEPRECATED environment variable to 1.  This command may be removed in future releases."
+      new_cmd = deprecated[command_name.to_sym]
+      if new_cmd
+        new_cmd = "rhc #{command.name}" if new_cmd == true
+        RHC::Helpers.deprecated_command new_cmd
       end
     end
 
@@ -64,6 +88,8 @@ module RHC
             o[:arg] = Commander::Runner.switch_to_sym(o[:switches].last)
           end
 
+          deprecated[name.to_sym] = opts[:deprecated] unless opts[:deprecated].nil?
+
           args_metadata = opts[:args] || []
           args_metadata.each do |arg_meta|
             arg_switches = arg_meta[:switches]
@@ -81,7 +107,7 @@ module RHC
                 # prepend the current resource
                 alias_components = name.split(" ")
                 alias_components[-1] = a[:action]
-                alias_cmd = alias_components.join(' ')
+                alias_cmd = alias_components.join(' ').to_sym
               end
 
               deprecated[alias_cmd] = true if a[:deprecated]

data/lib/rhc/config.rb

@@ -116,6 +116,10 @@ module RHC
     def opts_login=(username)
       @opts.add('default_rhlogin', username)
     end
+    
+    def opts_login
+      @opts['default_rhlogin']
+    end
 
     # password is not allowed in config files and can only be passed on comman line
     def password=(password)
@@ -170,6 +174,10 @@ module RHC
     def has_opts_config?
       !@opts_config.nil?
     end
+    
+    def has_opts?
+      !@opts.nil?
+    end
 
     def should_run_ssh_wizard?
       not File.exists? @ssh_priv_key_file_path
@@ -206,21 +214,29 @@ module RHC
     end
 
     def default_proxy
-      #
-      # Check for proxy environment
-      #
-      if @default_proxy.nil?
-        if ENV['http_proxy']
-          if ENV['http_proxy']!~/^(\w+):\/\// then
-            ENV['http_proxy']="http://" + ENV['http_proxy']
+      @default_proxy ||= (
+        proxy = ENV['http_proxy'] || ENV['HTTP_PROXY']
+        if proxy
+          if proxy !~ /^(\w+):\/\// then
+            proxy = "http://#{proxy}"
           end
-          proxy_uri=URI.parse(ENV['http_proxy'])
-          @default_proxy = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+          ENV['http_proxy'] = proxy
+          proxy_uri = URI.parse(ENV['http_proxy'])
+          Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
         else
-          @default_proxy = Net::HTTP
+          Net::HTTP
         end
-      end
-      @default_proxy
+      )
+    end
+
+    def using_proxy?
+      default_proxy.instance_variable_get(:@is_proxy_class) || false
+    end
+
+    def proxy_vars
+      Hash[[:address,:user,:pass,:port].map do |x|
+        [x,default_proxy.instance_variable_get("@proxy_#{x}")]
+      end]
     end
   end
 end

data/lib/rhc/context_helper.rb

@@ -1,17 +1,31 @@
+require 'rhc/git_helper'
+
 module RHC
   module ContextHelpers
+    include RHC::GitHelpers
+
     def app_context
-      # We currently do not have a way of determening an app context so return nil
-      # In the future we will use the uuid embeded in the git config to query
-      # the server for the repo's app name
+      debug "Getting app context"
+
+      uuid = git_config_get "rhc.app-uuid"
+
+      # proof of concept - we shouldn't be traversing
+      # the broker should expose apis for getting the application via a uuid
+      rest_client.domains.each do |rest_domain|
+        rest_domain.applications.each do |rest_app|
+          return rest_app.name if rest_app.uuid == uuid
+        end
+      end
+
+      debug "Couldn't find app with UUID == #{uuid}"
       nil
     end
 
     def namespace_context
       # right now we don't have any logic since we only support one domain
-      # :nocov: remove nocov when cart tests go back in
+      # TODO: add domain lookup based on uuid
       domain = rest_client.domains[0]
-      raise RHC::DomainNotFoundException("No domains configured for this user.  You may create one using 'rhc domain create'.") if domain.nil?
+      raise RHC::DomainNotFoundException, "No domains configured for this user.  You may create one using 'rhc domain create'." if domain.nil?
 
       domain.id
     end

data/lib/rhc/core_ext.rb

@@ -1,6 +1,7 @@
 # From Rails core_ext/object.rb
 require 'rhc/json'
 require 'open-uri'
+require 'highline'
 
 class Object
   def present?
@@ -24,6 +25,15 @@ class File
   end
 end
 
+class String
+  # Wrap string by the given length, and join it with the given character.
+  # The method doesn't distinguish between words, it will only work based on
+  # the length.
+  def wrap(wrap_length=80, char="\n")
+    scan(/.{#{wrap_length}}|.+/).join(char)
+  end
+end
+
 #
 # Allow http => https redirection, see 
 # http://bugs.ruby-lang.org/issues/859 to 1.8.7 for rough
@@ -38,3 +48,79 @@ module OpenURI
     (/\A(?:http|ftp)\z/i =~ uri1.scheme && /\A(?:https?|ftp)\z/i =~ uri2.scheme)
   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

@@ -19,12 +19,32 @@ module RHC
     end
   end
 
+  class CartridgeNotFoundException < Exception
+    def initialize(message="Cartridge not found")
+      super message, 154
+    end
+  end
+
+  class MultipleCartridgesException < Exception
+    def initialize(message="Multiple cartridge found")
+      super message, 155
+    end
+  end
+
   class KeyNotFoundException < Exception
     def initialize(message="SSHKey not found")
       super message, 118
     end
   end
 
+  # Makes sense to use its own exit code since this is different from a
+  # resource error
+  class GitException < Exception
+    def initialize(message="Git returned an error")
+      super message, 216
+    end
+  end
+
   class DeprecatedError < RuntimeError; end
   
   class KeyFileNotExistentException < Exception
@@ -68,4 +88,28 @@ module RHC
       super message, 1
     end
   end
+
+  class SnapshotSaveException < Exception
+    def initialize(message="Error trying to save snapshot")
+      super message, 130
+    end
+  end
+
+  class SnapshotRestoreException < Exception
+    def initialize(message="Error trying to restore snapshot")
+      super message, 130
+    end
+  end
+
+  class MissingScalingValueException < Exception
+    def initialize(message="Must provide either a min or max value for scaling")
+      super message, 1
+    end
+  end
+
+  class CartridgeNotScalableException < Exception
+    def initialize(message="Cartridge is not scalable")
+      super message, 1
+    end
+  end
 end

data/lib/rhc/git_helper.rb

@@ -0,0 +1,59 @@
+require 'open4'
+
+module RHC
+  module GitHelpers
+    # :nocov: These all call external binaries so test them in cucumber
+    def git_config_get(key)
+      config_get_cmd = "git config --get #{key}"
+      debug "Running #{config_get_cmd}"
+      uuid = %x[#{config_get_cmd}].strip
+      debug "UUID = '#{uuid}'"
+      uuid = nil if $?.exitstatus != 0 or uuid.empty?
+
+      uuid
+    end
+
+    def git_config_set(key, value)
+      unset_cmd = "git config --unset-all #{key}"
+      config_cmd = "git config --add #{key} #{value}"
+      debug "Adding #{key} = #{value} to git config"
+      commands = [unset_cmd, config_cmd]
+      commands.each do |cmd|
+        debug "Running #{cmd} 2>&1"
+        output = %x[#{cmd} 2>&1]
+        raise RHC::GitException, "Error while adding config values to git - #{output}" unless output.empty?
+      end  
+    end
+
+    def git_clone_repo(git_url, repo_dir)
+      # quote the repo to avoid input injection risk
+      repo_dir = (repo_dir ? " \"#{repo_dir}\"" : "")
+      clone_cmd = "git clone #{git_url}#{repo_dir}"
+      debug "Running #{clone_cmd}"
+
+      err = nil
+      if RHC::Helpers.windows?
+        # windows does not support Open4 so redirect stderr to stdin
+        # and print the whole output which is not as clean
+        output = %x[#{clone_cmd} 2>&1]
+        if $?.exitstatus != 0
+          err = output + " - Check to make sure you have correctly installed git and it is added to your path."
+        else
+          say output
+        end
+      else
+        paragraph do
+          Open4.popen4(clone_cmd) do |pid, stdin, stdout, stderr|
+            stdin.close
+            say stdout.read
+            err = stderr.read
+          end
+          say "done"
+        end
+      end
+
+      raise RHC::GitException, "Error in git clone - #{err}" if $?.exitstatus != 0
+    end
+    # :nocov:
+  end
+end

data/lib/rhc/helpers.rb

@@ -1,6 +1,8 @@
 require 'commander/user_interaction'
+require 'rhc/version'
 require 'rhc/config'
 require 'rhc/commands'
+require 'rhc/output_helpers'
 
 OptionParser.accept(URI) {|s,| URI.parse(s) if s}
 
@@ -18,9 +20,13 @@ module RHC
     # helpers always have Commander UI available
     include Commander::UI
     include Commander::UI::AskForClass
+    include RHC::OutputHelpers
 
     extend self
 
+    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
@@ -74,7 +80,7 @@ module RHC
     global_option '-p', '--password password', "OpenShift password"
     global_option '-d', '--debug', "Turn on debugging"
 
-    global_option '--noprompt', "Do not ask for input"
+    global_option '--noprompt', "Suppress the interactive setup wizard from running before a command"
     global_option '--config FILE', "Path of a different config file"
     def config
       raise "Operations requiring configuration must define a config accessor"
@@ -94,6 +100,29 @@ module RHC
     # Output helpers
     #
 
+    def debug(msg)
+      $stderr.puts "DEBUG: #{msg}" if debug?
+    end
+
+    def deprecated_command(correct,short = false)
+      deprecated("This command is deprecated. Please use '#{correct}' instead.",short)
+    end
+
+    def deprecated_option(deprecated,new)
+      deprecated("The option '#{deprecated}' is deprecated. Please use '#{new}' instead")
+    end
+
+    def deprecated(msg,short = false)
+      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 may be removed in future releases."
+
+      msg << info unless short
+      if RHC::Helpers.disable_deprecated?
+        raise DeprecatedError.new(msg % ['an error','a warning',0])
+      else
+        warn "Warning: #{msg}\n" % ['a warning','an error',1]
+      end
+    end
+
     def say(msg)
       super
       msg
@@ -132,12 +161,54 @@ module RHC
       end
     end
 
-    def header(s)
-      say s
-      say "=" * s.length
+    # This will format table headings for a consistent look and feel
+    #   If a heading isn't explicitly defined, it will attempt to look up the parts
+    #   If those aren't found, it will capitalize the string
+    def table_heading(value)
+      # Set the default proc to look up undefined values
+      headings = Hash.new do |hash,key|
+        items = key.to_s.split('_')
+        # Look up each piece individually
+        hash[key] = items.length > 1 ?
+          # Recusively look up the heading for the parts
+          items.map{|x| headings[x.to_sym]}.join(' ') :
+          # Capitalize if this part isn't defined
+          items.first.capitalize
+      end
+
+      # Predefined headings (or parts of headings)
+      headings.merge!({
+        :creation_time  => "Created",
+        :uuid           => "UUID",
+        :current_scale  => "Current",
+        :scales_from    => "Minimum",
+        :scales_to      => "Maximum",
+        :url            => "URL",
+        :ssh            => "SSH",
+        :gear_profile   => "Gear Size"
+      })
+
+      headings[value]
+    end
+
+    def header(s,opts = {})
+      @indent ||= 0
+      indent s
+      indent "="*s.length
+      if block_given?
+        @indent += 1
+        yield
+        @indent -= 1
+      end
     end
 
-      ##
+    INDENT = 2
+    def indent(str)
+      @indent ||= 0
+      say "%s%s" % [" " * @indent * INDENT,str]
+    end
+
+    ##
     # section
     #
     # highline helper mixin which correctly formats block of say and ask
@@ -225,5 +296,15 @@ module RHC
     def windows? ; RUBY_PLATFORM =~ /win(32|dows|ce)|djgpp|(ms|cyg|bcc)win|mingw32/i end
     def unix? ; !jruby? && !windows? end
 
+    # common SSH key display format in ERB
+    def ssh_key_display_format
+      ERB.new <<-FORMAT
+       Name: <%= key.name %>
+       Type: <%= key.type %>
+Fingerprint: <%= key.fingerprint %>
+
+      FORMAT
+    end
+
   end
 end