rhc 1.2.7 → 1.3.8

data/lib/rhc/context_helper.rb

@@ -1,30 +1,43 @@
-require 'rhc/git_helper'
+require 'rhc/git_helpers'
 
 module RHC
+  #
+  # Methods in this module should not attempt to read from the options hash
+  # in a recursive manner (server_context can't read options.server).
+  #
   module ContextHelpers
     include RHC::GitHelpers
 
+    def server_context
+      ENV['LIBRA_SERVER'] || (!options.clean && config['libra_server']) || "openshift.redhat.com"
+    end
+
     def app_context
       debug "Getting app context"
 
+      name = git_config_get "rhc.app-name"
+      return name if name.present?
+
       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
+      if uuid.present?
+        # 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
-      end
 
-      debug "Couldn't find app with UUID == #{uuid}"
+        debug "Couldn't find app with UUID == #{uuid}"
+      end
       nil
     end
 
     def namespace_context
       # right now we don't have any logic since we only support one domain
       # TODO: add domain lookup based on uuid
-      domain = rest_client.domains[0]
+      domain = rest_client.domains.first
       raise RHC::DomainNotFoundException, "No domains configured for this user.  You may create one using 'rhc domain create'." if domain.nil?
 
       domain.id

data/lib/rhc/core_ext.rb

@@ -2,6 +2,7 @@
 require 'rhc/json'
 require 'open-uri'
 require 'highline'
+require 'httpclient'
 
 class Object
   def present?
@@ -11,6 +12,10 @@ class Object
     respond_to?(:empty?) ? empty? : !self
   end
 
+  def presence
+    present? ? self : nil
+  end
+
   # Avoid a conflict if to_json is already defined
   unless Object.new.respond_to? :to_json
     def to_json(options=nil)
@@ -34,6 +39,16 @@ class String
   end
 end
 
+unless HTTP::Message.method_defined? :ok?
+  #:nocov:
+  class HTTP::Message
+    def ok?
+      HTTP::Status.successful?(status)
+    end
+  end
+  #:nocov:
+end
+
 #
 # Allow http => https redirection, see 
 # http://bugs.ruby-lang.org/issues/859 to 1.8.7 for rough
@@ -49,6 +64,32 @@ module OpenURI
   end
 end
 
+class Hash
+  def stringify_keys!
+    keys.each do |key|
+      v = delete(key)
+      if v.is_a? Hash
+        v.stringify_keys!
+      elsif v.is_a? Array
+        v.each{ |value| value.stringify_keys! if value.is_a? Hash }
+      end
+      self[(key.to_s rescue key) || key] = v
+    end
+    self
+  end
+  def slice!(*args)
+    s = []
+    args.inject([]) do |a, k|
+      s << [k, delete(k)] if has_key?(k)
+    end
+    s
+  end
+  def reverse_merge!(other_hash)
+    # right wins if there is no left
+    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
@@ -122,5 +163,4 @@ class HighLine
 
     return wrapped_text.join("\n")
   end
-
 end

data/lib/rhc/exceptions.rb

@@ -1,12 +1,18 @@
 module RHC
   class Exception < StandardError
     attr_reader :code
-    def initialize(message=nil, code=nil)
+    def initialize(message=nil, code=1)
       super(message)
       @code = code
     end
   end
 
+  class ConfirmationError < Exception
+    def initialize(message="This action requires the --confirm option (or entering 'yes' at a prompt) to run.", code=1)
+      super(message, code)
+    end
+  end
+
   class DomainNotFoundException < Exception
     def initialize(message="Domain not found")
       super message, 127
@@ -37,14 +43,15 @@ module RHC
     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 GitPermissionDenied < GitException; end
+  class GitDirectoryExists < GitException; end
+
   class DeprecatedError < RuntimeError; end
 
   class KeyFileNotExistentException < Exception
@@ -97,13 +104,22 @@ module RHC
 
   class MissingScalingValueException < Exception
     def initialize(message="Must provide either a min or max value for scaling")
-      super message, 1
+      super message
     end
   end
 
   class CartridgeNotScalableException < Exception
     def initialize(message="Cartridge is not scalable")
-      super message, 1
+      super message
+    end
+  end
+
+  class ConnectionFailed < Exception
+  end
+
+  class SSHConnectionRefused < ConnectionFailed
+    def initialize(host, user)
+      super "The server #{host} refused a connection with user #{user}.  The application may be unavailable.", 1
     end
   end
 

data/lib/rhc/git_helpers.rb

@@ -0,0 +1,81 @@
+require 'open4'
+
+module RHC
+  module GitHelpers
+    def git_version
+      @git_version ||= `git --version 2>&1`.strip #:nocov:
+    end
+
+    def has_git?
+      @has_git ||= begin
+          @git_version = nil
+          git_version
+          $?.success?
+        rescue
+          false
+        end
+    end
+
+    def git_clone_application(app)
+      repo_dir = options.repo || app.name
+
+      debug "Pulling new repo down"
+      git_clone_repo(app.git_url, repo_dir)
+
+      debug "Configuring git repo"
+      Dir.chdir(repo_dir) do |dir|
+        git_config_set "rhc.app-uuid", app.uuid
+        git_config_set "rhc.app-name", app.name
+        git_config_set "rhc.domain-name", app.domain_id
+      end
+
+      true
+    end
+
+    # :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
+    # :nocov:
+
+    def git_clone_repo(git_url, repo_dir)
+      # quote the repo to avoid input injection risk
+      destination = (repo_dir ? " \"#{repo_dir}\"" : "")
+      cmd = "git clone #{git_url}#{destination}"
+      debug "Running #{cmd}"
+
+      status, stdout, stderr = run_with_tee(cmd)
+
+      if status != 0
+        case stderr
+        when /fatal: destination path '[^']*' already exists and is not an empty directory./
+          raise RHC::GitDirectoryExists, "The directory you are cloning into already exists."
+        when /^Permission denied \(.*?publickey.*?\).$/
+          raise RHC::GitPermissionDenied, "You don't have permission to access this repository.  Check that your SSH public keys are correct."
+        else
+          raise RHC::GitException, "Unable to clone your repository. Called Git with: #{cmd}"
+        end
+      end
+
+      success "Your application code is now in '#{repo_dir}'"
+    end
+  end
+end

data/lib/rhc/help_formatter.rb

@@ -8,6 +8,26 @@ module RHC
     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
+    end
+  end
+
+  class CommandHelpBindings
+    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)
+        # 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
+      @actions.compact!
+      @global_options = runner.options
+      @runner = runner
+    end
+    def program(*args)
+      @runner.program *args
+    end
   end
-  # TODO: class ManPageHelpFormatter
 end

data/lib/rhc/helpers.rb

@@ -1,7 +1,6 @@
 require 'commander/user_interaction'
 require 'rhc/version'
 require 'rhc/config'
-require 'rhc/commands'
 require 'rhc/output_helpers'
 require 'rbconfig'
 
@@ -47,12 +46,14 @@ module RHC
     end
 
     def date(s)
-      now = Time.now
+      now = Date.today
       d = datetime_rfc3339(s)
       if now.year == d.year
         return d.strftime('%l:%M %p').strip if now.yday == d.yday
+        d.strftime('%b %d %l:%M %p')
+      else
+        d.strftime('%b %d, %Y %l:%M %p')
       end
-      d.strftime('%b %d %l:%M %p')
     rescue ArgumentError
       "Unknown date"
     end
@@ -70,38 +71,86 @@ module RHC
       "rhc/#{RHC::VERSION::STRING} (ruby #{RUBY_VERSION}; #{RUBY_PLATFORM})#{" (API #{RHC::Rest::API_VERSION})" rescue ''}"
     end
 
-    def get(uri, opts=nil, *args)
-      opts = {'User-Agent' => user_agent}.merge(opts || {})
-      RestClient.get(uri, opts, *args)
-    end
-
     #
     # Global config
     #
+    global_option '-l', '--rhlogin LOGIN', "OpenShift login"
+    global_option '-p', '--password PASSWORD', "OpenShift password"
+    global_option '-d', '--debug', "Turn on debugging", :hide => true
 
-    global_option '-l', '--rhlogin login', "OpenShift login"
-    global_option '-p', '--password password', "OpenShift password"
-    global_option '-d', '--debug', "Turn on debugging"
+    global_option '--server NAME', String, 'An OpenShift server hostname (default: openshift.redhat.com)'
+    global_option '-k', '--insecure', "Allow insecure SSL connections.  Potential security risk.", :hide => true
 
-    global_option('--timeout seconds', Integer, 'Set the timeout in seconds for network commands') do |value|
-      abort(color("Timeout must be a positive integer",:red)) unless value > 0
-      # FIXME: Refactor so we don't have to use a global var here
-      $rest_timeout = value
+    OptionParser.accept(SSLVersion = Class.new){ |s| OpenSSL::SSL::SSLContext::METHODS.find{ |m| m.to_s.downcase == s.downcase } or raise OptionParser::InvalidOption.new(nil, "The provided SSL version '#{s}' is not valid. Supported values: #{OpenSSL::SSL::SSLContext::METHODS.map(&:to_s).map(&:downcase).join(', ')}") }
+    global_option '--ssl-version VERSION', SSLVersion, "The version of SSL to use", :hide => true do |value|
+      raise RHC::Exception, "You are using an older version of the httpclient gem which prevents the use of --ssl-version.  Please run 'gem update httpclient' to install a newer version (2.2.6 or newer)." unless HTTPClient::SSLConfig.method_defined? :ssl_version
     end
-    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"
+    global_option '--ssl-ca-file FILE', "An SSL certificate CA file (may contain multiple certs)", :hide => true do |value|
+      debug certificate_file(value)
+    end
+    global_option '--ssl-client-cert-file FILE', "An SSL x509 client certificate file", :hide => true do |value|
+      debug certificate_file(value)
+    end
+
+    global_option('--timeout SECONDS', Integer, 'The timeout for operations') do |value|
+      raise RHC::Exception, "Timeout must be a positive integer" unless value > 0
+    end
+    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 '--clean', "Ignore any saved configuration options", :hide => true
+    global_option '--mock', "Run in mock mode", :hide => true do
+      #:nocov:
+      require 'rhc/rest/mock'
+      RHC::Rest::Mock.start
+      #:nocov:
     end
 
     def openshift_server
-      config.get_value('libra_server')
+      to_host((options.server rescue nil) || ENV['LIBRA_SERVER'] || "openshift.redhat.com")
+    end
+    def openshift_online_server?
+      openshift_server =~ /openshift.redhat.com$/i
     end
     def openshift_url
       "https://#{openshift_server}"
     end
-    def openshift_rest_node
-      "#{openshift_url}/broker/rest/api"
+
+    def to_host(s)
+      s =~ %r(^http(?:s)?://) ? URI(s).host : s
+    end
+    def to_uri(s)
+      URI(s =~ %r(^http(?:s)?://) ? s : "https://#{s}")
+    end
+    def openshift_rest_endpoint
+      uri = to_uri((options.server rescue nil) || ENV['LIBRA_SERVER'] || "openshift.redhat.com")
+      uri.path = '/broker/rest/api' if uri.path.blank? || uri.path == '/'
+      uri
+    end
+
+    def client_from_options(opts)
+      RHC::Rest::Client.new({
+          :url => openshift_rest_endpoint.to_s,
+          :debug => options.debug,
+          :timeout => options.timeout,
+        }.merge!(ssl_options).merge!(opts))
+    end
+
+    def ssl_options
+      {
+        :ssl_version => options.ssl_version,
+        :client_cert => certificate_file(options.ssl_client_cert),
+        :ca_file => options.ssl_ca_file && File.expand_path(options.ssl_ca_file),
+        :verify_mode => options.insecure ? OpenSSL::SSL::VERIFY_NONE : nil,
+      }.delete_if{ |k,v| v.nil? }
+    end
+
+    def certificate_file(file)
+      file && OpenSSL::X509::Certificate.new(IO.read(File.expand_path(file)))
+    rescue => e
+      debug e
+      raise OptionParser::InvalidOption.new(nil, "The certificate '#{file}' cannot be loaded: #{e.message} (#{e.class})")
     end
 
     #
@@ -111,6 +160,9 @@ module RHC
     def debug(msg)
       $stderr.puts "DEBUG: #{msg}" if debug?
     end
+    def debug?
+      false
+    end
 
     def deprecated_command(correct,short = false)
       deprecated("This command is deprecated. Please use '#{correct}' instead.",short)
@@ -123,25 +175,61 @@ module RHC
     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 may be removed in future releases."
-
+      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
-      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
+
+      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)
-      if Hash[*args][:stderr]
-        $stderr.puts msg
-      else
-        super(msg)
+      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): ") }
+      raise RHC::ConfirmationError
+    end
+
     def success(msg, *args)
       say color(msg, :green), *args
     end
@@ -166,6 +254,14 @@ module RHC
       count == 1 ? "#{count} #{s}" : "#{count} #{s}s"
     end
 
+    ## report a result (true/false) and return result
+    ## if the result is false, msg is displayed
+    def report_result(result, msg, fatal = true)
+      result ? $terminal.instance_variable_get(:@output).print('.') : error(msg)
+      # ignore the result if non-fatal
+      fatal ? result : true
+    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)
@@ -174,7 +270,7 @@ module RHC
       items.each do |item|
         item.each_with_index do |s, i|
           item[i] = s.to_s
-          widths[i] = [widths[i] || 0, s.length].max if s.respond_to?(:length)
+          widths[i] = [widths[i] || 0, item[i].length].max
         end
       end
       align = opts[:align] || []
@@ -186,7 +282,7 @@ module RHC
         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).strip
+        item.each_with_index.map{ |s,i| s.send((align[i] == :right ? :rjust : :ljust), widths[i], ' ') }.join(join).rstrip
       end
     end
 
@@ -212,29 +308,63 @@ module RHC
         :current_scale  => "Current",
         :scales_from    => "Minimum",
         :scales_to      => "Maximum",
+        :gear_sizes     => "Allowed Gear Sizes",
+        :consumed_gears => "Gears Used",
+        :max_gears      => "Gears Allowed",
+        :gear_info      => "Gears",
+        :plan_id        => "Plan",
         :url            => "URL",
-        :ssh            => "SSH",
-        :gear_profile   => "Gear Size"
+        :ssh_string     => "SSH",
+        :connection_info => "Connection URL",
+        :gear_profile   => "Gear Size",
+        :visible_to_ssh? => 'Available',
       })
 
       headings[value]
     end
 
-    def header(s,opts = {})
-      @indent ||= 0
-      indent s
-      indent "="*s.length
+    class StringTee < StringIO
+      attr_reader :tee
+      def initialize(other)
+        @tee = other
+        super()
+      end
+      def <<(buf)
+        tee << buf
+        super
+      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 += 1
-        yield
-        @indent -= 1
+        indent &block
       end
     end
 
+    def underline(s)
+      [s, "-"*s.length]
+    end
+
     INDENT = 2
-    def indent(str)
-      @indent ||= 0
-      say "%s%s" % [" " * @indent * INDENT,str]
+    def indent(&block)
+      @@indent += 1
+      begin
+        yield
+      ensure
+        @@indent -= 1
+      end
     end
 
     ##
@@ -265,37 +395,21 @@ module RHC
     #  top - top margin specified in lines
     #  bottom - bottom margin specified in line
     #
-    @@section_bottom_last = 0
+    @@margin = nil
     def section(params={}, &block)
-      top = params[:top]
-      top = 0 if top.nil?
-      bottom = params[:bottom]
-      bottom = 0 if bottom.nil?
-
-      # add more newlines if top is greater than the last section's bottom margin
-      top_margin = @@section_bottom_last
-
-      # negitive previous bottoms indicate that an untracked newline was
-      # printed and so we do our best to negate it since we can't remove it
-      if top_margin < 0
-        top += top_margin
-        top_margin = 0
-      end
+      top = params[:top] || 0
+      bottom = params[:bottom] || 0
 
-      until top_margin >= top
-        say "\n"
-        top_margin += 1
-      end
+      # the first section cannot take a newline
+      top = 0 unless @@margin
+      @@margin = [top, @@margin || 0].max
 
-      block.call
+      value = block.call
 
-      bottom_margin = 0
-      until bottom_margin >= bottom
-        say "\n"
-        bottom_margin += 1
-      end
+      say "\n" if @@last_line_open
+      @@margin = [bottom, @@margin].max
 
-      @@section_bottom_last = bottom
+      value
     end
 
     ##
@@ -314,7 +428,7 @@ module RHC
     # to distinguish the final results of a command from other output
     #
     def results(&block)
-      paragraph do
+      section(:top => 1, :bottom => 0) do
         say "RESULT:"
         yield
       end
@@ -326,14 +440,9 @@ module RHC
     def unix? ; !jruby? && !windows? end
     def mac? ; RbConfig::CONFIG['host_os'] =~ /^darwin/ 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
+    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
 
     #
@@ -346,15 +455,41 @@ Fingerprint: <%= key.fingerprint %>
       dns.getresources(host, Resolv::DNS::Resource::IN::A).any?
       # :nocov:
     end
-    
+
     def hosts_file_contains?(host)
       # :nocov:
       resolver = Resolv::Hosts.new
-      begin
-        resolver.getaddress host
-      rescue Resolv::ResolvError
-      end
+      resolver.getaddress host
+    rescue Resolv::ResolvError
       # :nocov:
     end
+
+    # Run a command and export its output to the user.  Output is not capturable
+    # on all platforms.
+    def run_with_tee(cmd)
+      status, stdout, stderr = nil
+
+      if windows?
+        #:nocov: TODO: Test block
+        system(cmd)
+        status = $?.exitstatus
+        #:nocov:
+      else
+        stdout, stderr = [$stdout, $stderr].map{ |t| StringTee.new(t) }
+        status = Open4.spawn(cmd, 'stdout' => stdout, 'stderr' => stderr, 'quiet' => true)
+        stdout, stderr = [stdout, stderr].map(&:string)
+      end
+
+      [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